class SamplifyAPIClient::LineItemReportData
Attributes
Calculated median length of interview from actual panelists
Total number of panelists that entered the project
Total number of panelists that completed the project
Ratio of completes over attempts. (ranges from 0-1)
ISO country code
Currency ISO code
Total estimated cost
A unique identifier for your Line Item
Total incurred cost
ISO language code
Last accepted incidence rate
Last accepted length of interview
Total number of panelists that triggered an overquota for the project
Total remaining completes for the project
Total number of panelists that got screened out of the project
The current state of the project: PROVISIONED, LAUNCHED, PAUSED, CLOSED
The current state reason of the project
LineItem title
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/samplify_api_client/models/line_item_report_data.rb, line 94 def self.attribute_map { :'actual_median_loi' => :'actualMedianLOI', :'attempts' => :'attempts', :'completes' => :'completes', :'conversion' => :'conversion', :'country_iso_code' => :'countryISOCode', :'currency' => :'currency', :'estimated_cost' => :'estimatedCost', :'ext_line_item_id' => :'extLineItemId', :'incurred_cost' => :'incurredCost', :'language_iso_code' => :'languageISOCode', :'last_accepted_incidence_rate' => :'lastAcceptedIncidenceRate', :'last_accepted_loi' => :'lastAcceptedLOI', :'overquotas' => :'overquotas', :'remaining_completes' => :'remainingCompletes', :'screenouts' => :'screenouts', :'state' => :'state', :'state_reason' => :'stateReason', :'title' => :'title' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/samplify_api_client/models/line_item_report_data.rb, line 143 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'actualMedianLOI') self.actual_median_loi = attributes[:'actualMedianLOI'] end if attributes.has_key?(:'attempts') self.attempts = attributes[:'attempts'] end if attributes.has_key?(:'completes') self.completes = attributes[:'completes'] end if attributes.has_key?(:'conversion') self.conversion = attributes[:'conversion'] end if attributes.has_key?(:'countryISOCode') self.country_iso_code = attributes[:'countryISOCode'] end if attributes.has_key?(:'currency') self.currency = attributes[:'currency'] end if attributes.has_key?(:'estimatedCost') self.estimated_cost = attributes[:'estimatedCost'] end if attributes.has_key?(:'extLineItemId') self.ext_line_item_id = attributes[:'extLineItemId'] end if attributes.has_key?(:'incurredCost') self.incurred_cost = attributes[:'incurredCost'] end if attributes.has_key?(:'languageISOCode') self.language_iso_code = attributes[:'languageISOCode'] end if attributes.has_key?(:'lastAcceptedIncidenceRate') self.last_accepted_incidence_rate = attributes[:'lastAcceptedIncidenceRate'] end if attributes.has_key?(:'lastAcceptedLOI') self.last_accepted_loi = attributes[:'lastAcceptedLOI'] end if attributes.has_key?(:'overquotas') self.overquotas = attributes[:'overquotas'] end if attributes.has_key?(:'remainingCompletes') self.remaining_completes = attributes[:'remainingCompletes'] end if attributes.has_key?(:'screenouts') self.screenouts = attributes[:'screenouts'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'stateReason') self.state_reason = attributes[:'stateReason'] end if attributes.has_key?(:'title') self.title = attributes[:'title'] end end
Attribute type mapping.
# File lib/samplify_api_client/models/line_item_report_data.rb, line 118 def self.swagger_types { :'actual_median_loi' => :'Integer', :'attempts' => :'Integer', :'completes' => :'Integer', :'conversion' => :'Float', :'country_iso_code' => :'String', :'currency' => :'String', :'estimated_cost' => :'Float', :'ext_line_item_id' => :'String', :'incurred_cost' => :'Float', :'language_iso_code' => :'String', :'last_accepted_incidence_rate' => :'Float', :'last_accepted_loi' => :'Integer', :'overquotas' => :'Integer', :'remaining_completes' => :'Integer', :'screenouts' => :'Integer', :'state' => :'String', :'state_reason' => :'String', :'title' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/samplify_api_client/models/line_item_report_data.rb, line 339 def ==(o) return true if self.equal?(o) self.class == o.class && actual_median_loi == o.actual_median_loi && attempts == o.attempts && completes == o.completes && conversion == o.conversion && country_iso_code == o.country_iso_code && currency == o.currency && estimated_cost == o.estimated_cost && ext_line_item_id == o.ext_line_item_id && incurred_cost == o.incurred_cost && language_iso_code == o.language_iso_code && last_accepted_incidence_rate == o.last_accepted_incidence_rate && last_accepted_loi == o.last_accepted_loi && overquotas == o.overquotas && remaining_completes == o.remaining_completes && screenouts == o.screenouts && state == o.state && state_reason == o.state_reason && title == o.title end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/samplify_api_client/models/line_item_report_data.rb, line 398 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = SamplifyAPIClient.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/samplify_api_client/models/line_item_report_data.rb, line 464 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/samplify_api_client/models/line_item_report_data.rb, line 377 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/samplify_api_client/models/line_item_report_data.rb, line 364 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/samplify_api_client/models/line_item_report_data.rb, line 370 def hash [actual_median_loi, attempts, completes, conversion, country_iso_code, currency, estimated_cost, ext_line_item_id, incurred_cost, language_iso_code, last_accepted_incidence_rate, last_accepted_loi, overquotas, remaining_completes, screenouts, state, state_reason, title].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/samplify_api_client/models/line_item_report_data.rb, line 224 def list_invalid_properties invalid_properties = Array.new if @actual_median_loi.nil? invalid_properties.push('invalid value for "actual_median_loi", actual_median_loi cannot be nil.') end if @attempts.nil? invalid_properties.push('invalid value for "attempts", attempts cannot be nil.') end if @completes.nil? invalid_properties.push('invalid value for "completes", completes cannot be nil.') end if @conversion.nil? invalid_properties.push('invalid value for "conversion", conversion cannot be nil.') end if @country_iso_code.nil? invalid_properties.push('invalid value for "country_iso_code", country_iso_code cannot be nil.') end if @currency.nil? invalid_properties.push('invalid value for "currency", currency cannot be nil.') end if @estimated_cost.nil? invalid_properties.push('invalid value for "estimated_cost", estimated_cost cannot be nil.') end if @ext_line_item_id.nil? invalid_properties.push('invalid value for "ext_line_item_id", ext_line_item_id cannot be nil.') end if @incurred_cost.nil? invalid_properties.push('invalid value for "incurred_cost", incurred_cost cannot be nil.') end if @language_iso_code.nil? invalid_properties.push('invalid value for "language_iso_code", language_iso_code cannot be nil.') end if @last_accepted_incidence_rate.nil? invalid_properties.push('invalid value for "last_accepted_incidence_rate", last_accepted_incidence_rate cannot be nil.') end if @last_accepted_loi.nil? invalid_properties.push('invalid value for "last_accepted_loi", last_accepted_loi cannot be nil.') end if @overquotas.nil? invalid_properties.push('invalid value for "overquotas", overquotas cannot be nil.') end if @remaining_completes.nil? invalid_properties.push('invalid value for "remaining_completes", remaining_completes cannot be nil.') end if @screenouts.nil? invalid_properties.push('invalid value for "screenouts", screenouts cannot be nil.') end if @state.nil? invalid_properties.push('invalid value for "state", state cannot be nil.') end if @state_reason.nil? invalid_properties.push('invalid value for "state_reason", state_reason cannot be nil.') end if @title.nil? invalid_properties.push('invalid value for "title", title cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/samplify_api_client/models/line_item_report_data.rb, line 329 def state=(state) validator = EnumAttributeValidator.new('String', ['PROVISIONED', 'LAUNCHED', 'PAUSED', 'CLOSED']) unless validator.valid?(state) fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.' end @state = state end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/samplify_api_client/models/line_item_report_data.rb, line 450 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/samplify_api_client/models/line_item_report_data.rb, line 438 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/samplify_api_client/models/line_item_report_data.rb, line 303 def valid? return false if @actual_median_loi.nil? return false if @attempts.nil? return false if @completes.nil? return false if @conversion.nil? return false if @country_iso_code.nil? return false if @currency.nil? return false if @estimated_cost.nil? return false if @ext_line_item_id.nil? return false if @incurred_cost.nil? return false if @language_iso_code.nil? return false if @last_accepted_incidence_rate.nil? return false if @last_accepted_loi.nil? return false if @overquotas.nil? return false if @remaining_completes.nil? return false if @screenouts.nil? return false if @state.nil? state_validator = EnumAttributeValidator.new('String', ['PROVISIONED', 'LAUNCHED', 'PAUSED', 'CLOSED']) return false unless state_validator.valid?(@state) return false if @state_reason.nil? return false if @title.nil? true end