Class: Bfwd::ProductRatePlanMigrationAmendment

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProductRatePlanMigrationAmendment

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
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.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?(:'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?(:'productRatePlanID')
    self.product_rate_plan_id = attributes[:'productRatePlanID']
  end

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

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

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

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

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

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

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

end

Instance Attribute Details

#actioned_time ⇒ Object

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



57
58
59
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 57

def actioned_time
  @actioned_time
end

#actioning_time ⇒ Object

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



54
55
56
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 54

def actioning_time
  @actioning_time
end

#amendment_type ⇒ Object

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



51
52
53
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 51

def amendment_type
  @amendment_type
end

#changed_by ⇒ Object

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



33
34
35
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 33

def changed_by
  @changed_by
end

#created ⇒ Object

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



30
31
32
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 30

def created
  @created
end

#deleted ⇒ Object

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



63
64
65
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 63

def deleted
  @deleted
end

#id ⇒ Object

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



42
43
44
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 42

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 migration charges. <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" : "Immediate", "verbs“: }



69
70
71
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 69

def invoicing_type
  @invoicing_type
end

#mappings ⇒ Object

{ "description" : "Mapping of new rate-plans pricing-components to values", "verbs“: }



72
73
74
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 72

def mappings
  @mappings
end

#next_subscription_description ⇒ Object

{ "description" : "User definable description for the migrated subscription.", "verbs“: }



84
85
86
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 84

def next_subscription_description
  @next_subscription_description
end

#next_subscription_id ⇒ Object

{ "description" : "ID of the next subscription.", "verbs“: }



78
79
80
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 78

def next_subscription_id
  @next_subscription_id
end

#next_subscription_name ⇒ Object

{ "description" : "User definable friendly name for the migrated subscription.", "verbs“: }



81
82
83
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 81

def next_subscription_name
  @next_subscription_name
end

#organization_id ⇒ Object

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



45
46
47
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 45

def organization_id
  @organization_id
end

#previous_subscription_id ⇒ Object

{ "description" : "ID of the previous subscription.", "verbs“: }



75
76
77
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 75

def previous_subscription_id
  @previous_subscription_id
end

#pricing_behaviour ⇒ Object

{ "description" : "Pricing behaviour defines how migration charges are calculated. <span class=\"label label-default\">DifferenceProRated</span> calculates the difference between in-advance charges of the existing and new rate-plan, then pro-rates based on time remaining. <span class=\"label label-default\">None</span> sets the migration charge as zero cost. <span class=\"label label-default\">Full</span> sets the costs as the total of the new rate-plans in-advance charges. <span class=\"label label-default\">Difference</span> is the same calculation as <span class=\"label label-default\">DifferenceProRated</span> but no pro-ration is applied. <span class=\"label label-default\">ProRated</span> differs depending on two cases; when moving to a rate-plan of the same duration it pro-rates the in-advance charges of the new rate-plan. If the duration is different, a credit-note will be issued any remaining time on the existing plans billing period.", "default" : "DifferenceProRated", "verbs“: }



87
88
89
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 87

def pricing_behaviour
  @pricing_behaviour
end

#product_rate_plan_id ⇒ Object

{ "description" : "Identifier of the rate-plan the subscription to migrate to", "verbs“: }



66
67
68
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 66

def product_rate_plan_id
  @product_rate_plan_id
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



60
61
62
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 60

def state
  @state
end

#subscription_id ⇒ Object

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



48
49
50
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 48

def subscription_id
  @subscription_id
end

#type ⇒ Object

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



39
40
41
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 39

def type
  @type
end

#updated ⇒ Object

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



36
37
38
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 36

def updated
  @updated
end

Class Method Details

.attribute_map ⇒ Object

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 112

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',
    :'product_rate_plan_id' => :'productRatePlanID',
    :'invoicing_type' => :'invoicingType',
    :'mappings' => :'mappings',
    :'previous_subscription_id' => :'previousSubscriptionID',
    :'next_subscription_id' => :'nextSubscriptionID',
    :'next_subscription_name' => :'nextSubscriptionName',
    :'next_subscription_description' => :'nextSubscriptionDescription',
    :'pricing_behaviour' => :'pricingBehaviour'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    :'product_rate_plan_id' => :'String',
    :'invoicing_type' => :'String',
    :'mappings' => :'Array<PricingComponentValueMigrationAmendmentMapping>',
    :'previous_subscription_id' => :'String',
    :'next_subscription_id' => :'String',
    :'next_subscription_name' => :'String',
    :'next_subscription_description' => :'String',
    :'pricing_behaviour' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 340

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 &&
      product_rate_plan_id == o.product_rate_plan_id &&
      invoicing_type == o.invoicing_type &&
      mappings == o.mappings &&
      previous_subscription_id == o.previous_subscription_id &&
      next_subscription_id == o.next_subscription_id &&
      next_subscription_name == o.next_subscription_name &&
      next_subscription_description == o.next_subscription_description &&
      pricing_behaviour == o.pricing_behaviour
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



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
435
436
437
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 401

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 =~ /^(true|t|yes|y|1)$/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



467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 467

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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 380

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/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


367
368
369
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 367

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



373
374
375
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 373

def hash
  [created, changed_by, updated, type, id, organization_id, subscription_id, amendment_type, actioning_time, actioned_time, state, deleted, product_rate_plan_id, invoicing_type, mappings, previous_subscription_id, next_subscription_id, next_subscription_name, next_subscription_description, pricing_behaviour].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



259
260
261
262
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 259

def list_invalid_properties
  invalid_properties = Array.new
  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



447
448
449
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 447

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



453
454
455
456
457
458
459
460
461
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 453

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



441
442
443
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 441

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb', line 266

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 @product_rate_plan_id.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 @pricing_behaviour.nil?
  pricing_behaviour_validator = EnumAttributeValidator.new('String', ["None", "Full", "Difference", "DifferenceProRated", "ProRated"])
  return false unless pricing_behaviour_validator.valid?(@pricing_behaviour)
  return true
end