Class: SamplifyAPIClient::LineItemReportData

Inherits:
Object
  • Object
show all
Defined in:
lib/samplify_api_client/models/line_item_report_data.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LineItemReportData

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# 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

Instance Attribute Details

#actual_median_loi ⇒ Object

Calculated median length of interview from actual panelists



18
19
20
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 18

def actual_median_loi
  @actual_median_loi
end

#attempts ⇒ Object

Total number of panelists that entered the project



21
22
23
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 21

def attempts
  @attempts
end

#completes ⇒ Object

Total number of panelists that completed the project



24
25
26
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 24

def completes
  @completes
end

#conversion ⇒ Object

Ratio of completes over attempts. (ranges from 0-1)



27
28
29
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 27

def conversion
  @conversion
end

#country_iso_code ⇒ Object

ISO country code



30
31
32
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 30

def country_iso_code
  @country_iso_code
end

#currency ⇒ Object

Currency ISO code



33
34
35
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 33

def currency
  @currency
end

#estimated_cost ⇒ Object

Total estimated cost



36
37
38
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 36

def estimated_cost
  @estimated_cost
end

#ext_line_item_id ⇒ Object

A unique identifier for your Line Item



39
40
41
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 39

def ext_line_item_id
  @ext_line_item_id
end

#incurred_cost ⇒ Object

Total incurred cost



42
43
44
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 42

def incurred_cost
  @incurred_cost
end

#language_iso_code ⇒ Object

ISO language code



45
46
47
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 45

def language_iso_code
  @language_iso_code
end

#last_accepted_incidence_rate ⇒ Object

Last accepted incidence rate



48
49
50
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 48

def last_accepted_incidence_rate
  @last_accepted_incidence_rate
end

#last_accepted_loi ⇒ Object

Last accepted length of interview



51
52
53
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 51

def last_accepted_loi
  @last_accepted_loi
end

#overquotas ⇒ Object

Total number of panelists that triggered an overquota for the project



54
55
56
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 54

def overquotas
  @overquotas
end

#remaining_completes ⇒ Object

Total remaining completes for the project



57
58
59
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 57

def remaining_completes
  @remaining_completes
end

#screenouts ⇒ Object

Total number of panelists that got screened out of the project



60
61
62
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 60

def screenouts
  @screenouts
end

#state ⇒ Object

The current state of the project: PROVISIONED, LAUNCHED, PAUSED, CLOSED



63
64
65
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 63

def state
  @state
end

#state_reason ⇒ Object

The current state reason of the project



66
67
68
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 66

def state_reason
  @state_reason
end

#title ⇒ Object

LineItem title



69
70
71
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 69

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# 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

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# 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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



464
465
466
467
468
469
470
471
472
473
474
475
476
 
# 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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


364
365
366
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 364

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



370
371
372
 
# 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

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# 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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



444
445
446
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 444

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



450
451
452
453
454
455
456
457
458
 
# 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



438
439
440
 
# File 'lib/samplify_api_client/models/line_item_report_data.rb', line 438

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# 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