Class: Bfwd::CreateSubscriptionChargeAmendment

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/create_subscription_charge_amendment.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSubscriptionChargeAmendment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 159

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'deleted')
    self.deleted = attributes[:'deleted']
  else
    self.deleted = false
  end

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#actioned_time ⇒ Object

{ "description" : "The time the amendment completed.", "verbs“: }



46
47
48
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 46

def actioned_time
  @actioned_time
end

#actioning_time ⇒ Object

{ "description" : "When the amendment will run", "verbs“: }



43
44
45
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 43

def actioning_time
  @actioning_time
end

#amendment_type ⇒ Object

{ "description" : "Type of amendment", "verbs“: }



40
41
42
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 40

def amendment_type
  @amendment_type
end

#amount ⇒ Object

{ "description" : "Monetary value to charge in the same currency as the subscription.", "verbs“: }



61
62
63
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 61

def amount
  @amount
end

#changed_by ⇒ Object

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }



22
23
24
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 22

def changed_by
  @changed_by
end

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



19
20
21
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 19

def created
  @created
end

#deleted ⇒ Object

{ "description" : "Is the amendment deleted.", "verbs“: }



52
53
54
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 52

def deleted
  @deleted
end

#description ⇒ Object

{ "description" : ".", "verbs“: }



58
59
60
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 58

def description
  @description
end

#discount ⇒ Object

{ "description" : "", "verbs":[] }



64
65
66
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 64

def discount
  @discount
end

#id ⇒ Object

{ "description" : "", "verbs“: }



31
32
33
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 31

def id
  @id
end

#invoicing_type ⇒ Object

{ "description" : "<span class=\"label label-default\">Immediate</span> invoicing will result in an invoice being issued immediately for the charge. <span class=\"label label-default\">Aggregated</span> invoicing will generate a charge to be added to the next issued invoice, for example at the current billing period end.", "default" : "Aggregated", "verbs“: }



67
68
69
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 67

def invoicing_type
  @invoicing_type
end

#organization_id ⇒ Object

{ "description" : "", "verbs“: }



34
35
36
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 34

def organization_id
  @organization_id
end

#pricing_component_id ⇒ Object

{ "description" : "", "verbs":[] }



79
80
81
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 79

def pricing_component_id
  @pricing_component_id
end

#pricing_component_value_change ⇒ Object

{ "description" : "", "verbs":[] }



76
77
78
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 76

def pricing_component_value_change
  @pricing_component_value_change
end

#state ⇒ Object

Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending



49
50
51
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 49

def state
  @state
end

#subscription_charge ⇒ Object

{ "description" : "", "verbs“: }



73
74
75
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 73

def subscription_charge
  @subscription_charge
end

#subscription_charge_id ⇒ Object

{ "description" : "", "verbs“: }



55
56
57
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 55

def subscription_charge_id
  @subscription_charge_id
end

#subscription_id ⇒ Object

{ "description" : "", "verbs“: }



37
38
39
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 37

def subscription_id
  @subscription_id
end

#tax_status ⇒ Object

{ "description" : "Whether the amount specified is <span class=\"label label-default\">inclusive</span> or <span class=\"label label-default\">exclusive</span> of tax", "default" : "inclusive", "verbs“: }



70
71
72
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 70

def tax_status
  @tax_status
end

#type ⇒ Object

{ "description" : "", "default" : "", "verbs“: }



28
29
30
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 28

def type
  @type
end

#updated ⇒ Object

{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }



25
26
27
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 25

def updated
  @updated
end

Class Method Details

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 104

def self.attribute_map
  {
    :'created' => :'created',
    :'changed_by' => :'changedBy',
    :'updated' => :'updated',
    :'type' => :'@type',
    :'id' => :'id',
    :'organization_id' => :'organizationID',
    :'subscription_id' => :'subscriptionID',
    :'amendment_type' => :'amendmentType',
    :'actioning_time' => :'actioningTime',
    :'actioned_time' => :'actionedTime',
    :'state' => :'state',
    :'deleted' => :'deleted',
    :'subscription_charge_id' => :'subscriptionChargeID',
    :'description' => :'description',
    :'amount' => :'amount',
    :'discount' => :'discount',
    :'invoicing_type' => :'invoicingType',
    :'tax_status' => :'taxStatus',
    :'subscription_charge' => :'subscriptionCharge',
    :'pricing_component_value_change' => :'pricingComponentValueChange',
    :'pricing_component_id' => :'pricingComponentID'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 131

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'changed_by' => :'String',
    :'updated' => :'DateTime',
    :'type' => :'String',
    :'id' => :'String',
    :'organization_id' => :'String',
    :'subscription_id' => :'String',
    :'amendment_type' => :'String',
    :'actioning_time' => :'DateTime',
    :'actioned_time' => :'DateTime',
    :'state' => :'String',
    :'deleted' => :'BOOLEAN',
    :'subscription_charge_id' => :'String',
    :'description' => :'String',
    :'amount' => :'Float',
    :'discount' => :'Float',
    :'invoicing_type' => :'String',
    :'tax_status' => :'String',
    :'subscription_charge' => :'SubscriptionCharge',
    :'pricing_component_value_change' => :'InsertableBillingEntity',
    :'pricing_component_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 368

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      changed_by == o.changed_by &&
      updated == o.updated &&
      type == o.type &&
      id == o.id &&
      organization_id == o.organization_id &&
      subscription_id == o.subscription_id &&
      amendment_type == o.amendment_type &&
      actioning_time == o.actioning_time &&
      actioned_time == o.actioned_time &&
      state == o.state &&
      deleted == o.deleted &&
      subscription_charge_id == o.subscription_charge_id &&
      description == o.description &&
      amount == o.amount &&
      discount == o.discount &&
      invoicing_type == o.invoicing_type &&
      tax_status == o.tax_status &&
      subscription_charge == o.subscription_charge &&
      pricing_component_value_change == o.pricing_component_value_change &&
      pricing_component_id == o.pricing_component_id
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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 430

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



496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 496

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



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 409

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


396
397
398
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 396

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



402
403
404
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 402

def hash
  [created, changed_by, updated, type, id, organization_id, subscription_id, amendment_type, actioning_time, actioned_time, state, deleted, subscription_charge_id, description, amount, discount, invoicing_type, tax_status, subscription_charge, pricing_component_value_change, pricing_component_id].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



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/bf_ruby2/models/create_subscription_charge_amendment.rb', line 255

def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push("invalid value for 'type', type cannot be nil.")
  end

  if @subscription_id.nil?
    invalid_properties.push("invalid value for 'subscription_id', subscription_id cannot be nil.")
  end

  if @amendment_type.nil?
    invalid_properties.push("invalid value for 'amendment_type', amendment_type cannot be nil.")
  end

  if @state.nil?
    invalid_properties.push("invalid value for 'state', state cannot be nil.")
  end

  if @deleted.nil?
    invalid_properties.push("invalid value for 'deleted', deleted cannot be nil.")
  end

  if @amount.nil?
    invalid_properties.push("invalid value for 'amount', amount cannot be nil.")
  end

  if @invoicing_type.nil?
    invalid_properties.push("invalid value for 'invoicing_type', invoicing_type cannot be nil.")
  end

  if @tax_status.nil?
    invalid_properties.push("invalid value for 'tax_status', tax_status cannot be nil.")
  end

  return 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



476
477
478
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 476

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



482
483
484
485
486
487
488
489
490
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 482

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



470
471
472
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 470

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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/bf_ruby2/models/create_subscription_charge_amendment.rb', line 294

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"])
  return false unless type_validator.valid?(@type)
  return false if @subscription_id.nil?
  return false if @amendment_type.nil?
  amendment_type_validator = EnumAttributeValidator.new('String', ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"])
  return false unless amendment_type_validator.valid?(@amendment_type)
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["Pending", "Succeeded", "Failed", "Discarded"])
  return false unless state_validator.valid?(@state)
  return false if @deleted.nil?
  return false if @amount.nil?
  return false if @invoicing_type.nil?
  invoicing_type_validator = EnumAttributeValidator.new('String', ["Immediate", "Aggregated"])
  return false unless invoicing_type_validator.valid?(@invoicing_type)
  return false if @tax_status.nil?
  tax_status_validator = EnumAttributeValidator.new('String', ["inclusive", "exclusive"])
  return false unless tax_status_validator.valid?(@tax_status)
  return true
end