Class: AdvancedBilling::SubscriptionMRR

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/advanced_billing/models/subscription_mrr.rb

Overview

SubscriptionMRR Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(subscription_id:, mrr_amount_in_cents:, breakouts: SKIP, additional_properties: {}) ⇒ SubscriptionMRR

Returns a new instance of SubscriptionMRR.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/advanced_billing/models/subscription_mrr.rb', line 45

def initialize(subscription_id:, mrr_amount_in_cents:, breakouts: SKIP,
               additional_properties: {})
  @subscription_id = subscription_id
  @mrr_amount_in_cents = mrr_amount_in_cents
  @breakouts = breakouts unless breakouts == SKIP

  # Add additional model properties to the instance.
  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end
end

Instance Attribute Details

#breakouts ⇒ SubscriptionMRRBreakout

TODO: Write general description for this method

Returns:



22
23
24
 
# File 'lib/advanced_billing/models/subscription_mrr.rb', line 22

def breakouts
  @breakouts
end

#mrr_amount_in_cents ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/advanced_billing/models/subscription_mrr.rb', line 18

def mrr_amount_in_cents
  @mrr_amount_in_cents
end

#subscription_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/advanced_billing/models/subscription_mrr.rb', line 14

def subscription_id
  @subscription_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/advanced_billing/models/subscription_mrr.rb', line 58

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  subscription_id =
    hash.key?('subscription_id') ? hash['subscription_id'] : nil
  mrr_amount_in_cents =
    hash.key?('mrr_amount_in_cents') ? hash['mrr_amount_in_cents'] : nil
  breakouts = SubscriptionMRRBreakout.from_hash(hash['breakouts']) if hash['breakouts']

  # Clean out expected properties from Hash.
  names.each_value { |k| hash.delete(k) }

  # Create object from extracted values.
  SubscriptionMRR.new(subscription_id: subscription_id,
                      mrr_amount_in_cents: mrr_amount_in_cents,
                      breakouts: breakouts,
                      additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/advanced_billing/models/subscription_mrr.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['subscription_id'] = 'subscription_id'
  @_hash['mrr_amount_in_cents'] = 'mrr_amount_in_cents'
  @_hash['breakouts'] = 'breakouts'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



41
42
43
 
# File 'lib/advanced_billing/models/subscription_mrr.rb', line 41

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
 
# File 'lib/advanced_billing/models/subscription_mrr.rb', line 34

def self.optionals
  %w[
    breakouts
  ]
end