Class: SubskribeSandboxClient::OrderLineItemJson

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/models/order_line_item_json.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderLineItemJson

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
221
222
223
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
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 165

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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'isDryRunItem')
    self.is_dry_run_item = attributes[:'isDryRunItem']
  end

  if attributes.has_key?(:'action')
    self.action = attributes[:'action']
  end

  if attributes.has_key?(:'planId')
    self.plan_id = attributes[:'planId']
  end

  if attributes.has_key?(:'subscriptionChargeId')
    self.subscription_charge_id = attributes[:'subscriptionChargeId']
  end

  if attributes.has_key?(:'currencyConversionRateId')
    self.currency_conversion_rate_id = attributes[:'currencyConversionRateId']
  end

  if attributes.has_key?(:'subscriptionChargeGroupId')
    self.subscription_charge_group_id = attributes[:'subscriptionChargeGroupId']
  end

  if attributes.has_key?(:'chargeId')
    self.charge_id = attributes[:'chargeId']
  end

  if attributes.has_key?(:'quantity')
    self.quantity = attributes[:'quantity']
  end

  if attributes.has_key?(:'isRamp')
    self.is_ramp = attributes[:'isRamp']
  end

  if attributes.has_key?(:'listUnitPrice')
    self.list_unit_price = attributes[:'listUnitPrice']
  end

  if attributes.has_key?(:'sellUnitPrice')
    self.sell_unit_price = attributes[:'sellUnitPrice']
  end

  if attributes.has_key?(:'discountAmount')
    self.discount_amount = attributes[:'discountAmount']
  end

  if attributes.has_key?(:'discounts')
    if (value = attributes[:'discounts']).is_a?(Array)
      self.discounts = value
    end
  end

  if attributes.has_key?(:'predefinedDiscounts')
    if (value = attributes[:'predefinedDiscounts']).is_a?(Array)
      self.predefined_discounts = value
    end
  end

  if attributes.has_key?(:'attributeReferences')
    if (value = attributes[:'attributeReferences']).is_a?(Array)
      self.attribute_references = value
    end
  end

  if attributes.has_key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.has_key?(:'listAmount')
    self.list_amount = attributes[:'listAmount']
  end

  if attributes.has_key?(:'annualizedAmount')
    self.annualized_amount = attributes[:'annualizedAmount']
  end

  if attributes.has_key?(:'listPriceOverrideRatio')
    self.list_price_override_ratio = attributes[:'listPriceOverrideRatio']
  end

  if attributes.has_key?(:'listUnitPriceBeforeOverride')
    self.list_unit_price_before_override = attributes[:'listUnitPriceBeforeOverride']
  end

  if attributes.has_key?(:'listAmountBeforeOverride')
    self.list_amount_before_override = attributes[:'listAmountBeforeOverride']
  end

  if attributes.has_key?(:'taxEstimate')
    self.tax_estimate = attributes[:'taxEstimate']
  end

  if attributes.has_key?(:'effectiveDate')
    self.effective_date = attributes[:'effectiveDate']
  end

  if attributes.has_key?(:'endDate')
    self.end_date = attributes[:'endDate']
  end

  if attributes.has_key?(:'customFields')
    if (value = attributes[:'customFields']).is_a?(Array)
      self.custom_fields = value
    end
  end

  if attributes.has_key?(:'arrOverride')
    self.arr_override = attributes[:'arrOverride']
  end

  if attributes.has_key?(:'dryRunItem')
    self.dry_run_item = attributes[:'dryRunItem']
  end
end

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



21
22
23
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 21

def action
  @action
end

#amount ⇒ Object

Returns the value of attribute amount.



49
50
51
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 49

def amount
  @amount
end

#annualized_amount ⇒ Object

Returns the value of attribute annualized_amount.



53
54
55
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 53

def annualized_amount
  @annualized_amount
end

#arr_override ⇒ Object

Returns the value of attribute arr_override.



69
70
71
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 69

def arr_override
  @arr_override
end

#attribute_references ⇒ Object

Returns the value of attribute attribute_references.



47
48
49
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 47

def attribute_references
  @attribute_references
end

#charge_id ⇒ Object

Returns the value of attribute charge_id.



31
32
33
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 31

def charge_id
  @charge_id
end

#currency_conversion_rate_id ⇒ Object

Returns the value of attribute currency_conversion_rate_id.



27
28
29
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 27

def currency_conversion_rate_id
  @currency_conversion_rate_id
end

#custom_fields ⇒ Object

Returns the value of attribute custom_fields.



67
68
69
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 67

def custom_fields
  @custom_fields
end

#discount_amount ⇒ Object

Returns the value of attribute discount_amount.



41
42
43
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 41

def discount_amount
  @discount_amount
end

#discounts ⇒ Object

Returns the value of attribute discounts.



43
44
45
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 43

def discounts
  @discounts
end

#dry_run_item ⇒ Object

Returns the value of attribute dry_run_item.



71
72
73
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 71

def dry_run_item
  @dry_run_item
end

#effective_date ⇒ Object

Returns the value of attribute effective_date.



63
64
65
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 63

def effective_date
  @effective_date
end

#end_date ⇒ Object

Returns the value of attribute end_date.



65
66
67
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 65

def end_date
  @end_date
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 17

def id
  @id
end

#is_dry_run_item ⇒ Object

Returns the value of attribute is_dry_run_item.



19
20
21
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 19

def is_dry_run_item
  @is_dry_run_item
end

#is_ramp ⇒ Object

Returns the value of attribute is_ramp.



35
36
37
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 35

def is_ramp
  @is_ramp
end

#list_amount ⇒ Object

Returns the value of attribute list_amount.



51
52
53
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 51

def list_amount
  @list_amount
end

#list_amount_before_override ⇒ Object

Returns the value of attribute list_amount_before_override.



59
60
61
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 59

def list_amount_before_override
  @list_amount_before_override
end

#list_price_override_ratio ⇒ Object

Returns the value of attribute list_price_override_ratio.



55
56
57
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 55

def list_price_override_ratio
  @list_price_override_ratio
end

#list_unit_price ⇒ Object

Returns the value of attribute list_unit_price.



37
38
39
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 37

def list_unit_price
  @list_unit_price
end

#list_unit_price_before_override ⇒ Object

Returns the value of attribute list_unit_price_before_override.



57
58
59
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 57

def list_unit_price_before_override
  @list_unit_price_before_override
end

#plan_id ⇒ Object

Returns the value of attribute plan_id.



23
24
25
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 23

def plan_id
  @plan_id
end

#predefined_discounts ⇒ Object

Returns the value of attribute predefined_discounts.



45
46
47
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 45

def predefined_discounts
  @predefined_discounts
end

#quantity ⇒ Object

Returns the value of attribute quantity.



33
34
35
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 33

def quantity
  @quantity
end

#sell_unit_price ⇒ Object

Returns the value of attribute sell_unit_price.



39
40
41
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 39

def sell_unit_price
  @sell_unit_price
end

#subscription_charge_group_id ⇒ Object

Returns the value of attribute subscription_charge_group_id.



29
30
31
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 29

def subscription_charge_group_id
  @subscription_charge_group_id
end

#subscription_charge_id ⇒ Object

Returns the value of attribute subscription_charge_id.



25
26
27
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 25

def subscription_charge_id
  @subscription_charge_id
end

#tax_estimate ⇒ Object

Returns the value of attribute tax_estimate.



61
62
63
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 61

def tax_estimate
  @tax_estimate
end

Class Method Details

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 96

def self.attribute_map
  {
    :'id' => :'id',
    :'is_dry_run_item' => :'isDryRunItem',
    :'action' => :'action',
    :'plan_id' => :'planId',
    :'subscription_charge_id' => :'subscriptionChargeId',
    :'currency_conversion_rate_id' => :'currencyConversionRateId',
    :'subscription_charge_group_id' => :'subscriptionChargeGroupId',
    :'charge_id' => :'chargeId',
    :'quantity' => :'quantity',
    :'is_ramp' => :'isRamp',
    :'list_unit_price' => :'listUnitPrice',
    :'sell_unit_price' => :'sellUnitPrice',
    :'discount_amount' => :'discountAmount',
    :'discounts' => :'discounts',
    :'predefined_discounts' => :'predefinedDiscounts',
    :'attribute_references' => :'attributeReferences',
    :'amount' => :'amount',
    :'list_amount' => :'listAmount',
    :'annualized_amount' => :'annualizedAmount',
    :'list_price_override_ratio' => :'listPriceOverrideRatio',
    :'list_unit_price_before_override' => :'listUnitPriceBeforeOverride',
    :'list_amount_before_override' => :'listAmountBeforeOverride',
    :'tax_estimate' => :'taxEstimate',
    :'effective_date' => :'effectiveDate',
    :'end_date' => :'endDate',
    :'custom_fields' => :'customFields',
    :'arr_override' => :'arrOverride',
    :'dry_run_item' => :'dryRunItem'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 130

def self.swagger_types
  {
    :'id' => :'String',
    :'is_dry_run_item' => :'BOOLEAN',
    :'action' => :'String',
    :'plan_id' => :'String',
    :'subscription_charge_id' => :'String',
    :'currency_conversion_rate_id' => :'String',
    :'subscription_charge_group_id' => :'String',
    :'charge_id' => :'String',
    :'quantity' => :'Integer',
    :'is_ramp' => :'BOOLEAN',
    :'list_unit_price' => :'Float',
    :'sell_unit_price' => :'Float',
    :'discount_amount' => :'Float',
    :'discounts' => :'Array<DiscountDetailJson>',
    :'predefined_discounts' => :'Array<TenantDiscountLineItemJson>',
    :'attribute_references' => :'Array<AttributeReference>',
    :'amount' => :'Float',
    :'list_amount' => :'Float',
    :'annualized_amount' => :'Float',
    :'list_price_override_ratio' => :'Float',
    :'list_unit_price_before_override' => :'Float',
    :'list_amount_before_override' => :'Float',
    :'tax_estimate' => :'Float',
    :'effective_date' => :'Integer',
    :'end_date' => :'Integer',
    :'custom_fields' => :'Array<CustomFieldEntry>',
    :'arr_override' => :'Float',
    :'dry_run_item' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 324

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      is_dry_run_item == o.is_dry_run_item &&
      action == o.action &&
      plan_id == o.plan_id &&
      subscription_charge_id == o.subscription_charge_id &&
      currency_conversion_rate_id == o.currency_conversion_rate_id &&
      subscription_charge_group_id == o.subscription_charge_group_id &&
      charge_id == o.charge_id &&
      quantity == o.quantity &&
      is_ramp == o.is_ramp &&
      list_unit_price == o.list_unit_price &&
      sell_unit_price == o.sell_unit_price &&
      discount_amount == o.discount_amount &&
      discounts == o.discounts &&
      predefined_discounts == o.predefined_discounts &&
      attribute_references == o.attribute_references &&
      amount == o.amount &&
      list_amount == o.list_amount &&
      annualized_amount == o.annualized_amount &&
      list_price_override_ratio == o.list_price_override_ratio &&
      list_unit_price_before_override == o.list_unit_price_before_override &&
      list_amount_before_override == o.list_amount_before_override &&
      tax_estimate == o.tax_estimate &&
      effective_date == o.effective_date &&
      end_date == o.end_date &&
      custom_fields == o.custom_fields &&
      arr_override == o.arr_override &&
      dry_run_item == o.dry_run_item
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



393
394
395
396
397
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
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 393

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 = SubskribeSandboxClient.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



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 459

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



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 372

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 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


359
360
361
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 359

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



365
366
367
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 365

def hash
  [id, is_dry_run_item, action, plan_id, subscription_charge_id, currency_conversion_rate_id, subscription_charge_group_id, charge_id, quantity, is_ramp, list_unit_price, sell_unit_price, discount_amount, discounts, predefined_discounts, attribute_references, amount, list_amount, annualized_amount, list_price_override_ratio, list_unit_price_before_override, list_amount_before_override, tax_estimate, effective_date, end_date, custom_fields, arr_override, dry_run_item].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



294
295
296
297
298
299
300
301
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 294

def list_invalid_properties
  invalid_properties = Array.new
  if @charge_id.nil?
    invalid_properties.push('invalid value for "charge_id", charge_id 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



439
440
441
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 439

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



445
446
447
448
449
450
451
452
453
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 445

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



433
434
435
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 433

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



305
306
307
308
309
310
 
# File 'lib/subskribe_sandbox/models/order_line_item_json.rb', line 305

def valid?
  action_validator = EnumAttributeValidator.new('String', ['ADD', 'UPDATE', 'REMOVE', 'RENEWAL', 'NONE', 'MISSING_RENEWAL', 'RESTRUCTURE'])
  return false unless action_validator.valid?(@action)
  return false if @charge_id.nil?
  true
end