Class: AdvancedBilling::ListSubscriptionGroupsItem

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

Overview

ListSubscriptionGroupsItem Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(uid: SKIP, scheme: SKIP, customer_id: SKIP, payment_profile_id: SKIP, subscription_ids: SKIP, primary_subscription_id: SKIP, next_assessment_at: SKIP, state: SKIP, cancel_at_end_of_period: SKIP, account_balances: SKIP, group_type: SKIP, additional_properties: {}) ⇒ ListSubscriptionGroupsItem

Returns a new instance of ListSubscriptionGroupsItem.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 96

def initialize(uid: SKIP, scheme: SKIP, customer_id: SKIP,
               payment_profile_id: SKIP, subscription_ids: SKIP,
               primary_subscription_id: SKIP, next_assessment_at: SKIP,
               state: SKIP, cancel_at_end_of_period: SKIP,
               account_balances: SKIP, group_type: SKIP,
               additional_properties: {})
  @uid = uid unless uid == SKIP
  @scheme = scheme unless scheme == SKIP
  @customer_id = customer_id unless customer_id == SKIP
  @payment_profile_id = payment_profile_id unless payment_profile_id == SKIP
  @subscription_ids = subscription_ids unless subscription_ids == SKIP
  @primary_subscription_id = primary_subscription_id unless primary_subscription_id == SKIP
  @next_assessment_at = next_assessment_at unless next_assessment_at == SKIP
  @state = state unless state == SKIP
  @cancel_at_end_of_period = cancel_at_end_of_period unless cancel_at_end_of_period == SKIP
  @account_balances =  unless  == SKIP
  @group_type = group_type unless group_type == SKIP

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

Instance Attribute Details

#account_balances ⇒ SubscriptionGroupBalances

TODO: Write general description for this method

Returns:



51
52
53
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 51

def 
  @account_balances
end

#cancel_at_end_of_period ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


47
48
49
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 47

def cancel_at_end_of_period
  @cancel_at_end_of_period
end

#customer_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


23
24
25
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 23

def customer_id
  @customer_id
end

#group_type ⇒ GroupType

TODO: Write general description for this method

Returns:



55
56
57
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 55

def group_type
  @group_type
end

#next_assessment_at ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


39
40
41
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 39

def next_assessment_at
  @next_assessment_at
end

#payment_profile_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 27

def payment_profile_id
  @payment_profile_id
end

#primary_subscription_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 35

def primary_subscription_id
  @primary_subscription_id
end

#scheme ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


19
20
21
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 19

def scheme
  @scheme
end

#state ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


43
44
45
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 43

def state
  @state
end

#subscription_ids ⇒ Array[Integer]

TODO: Write general description for this method

Returns:

  • (Array[Integer]) 


31
32
33
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 31

def subscription_ids
  @subscription_ids
end

#uid ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


15
16
17
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 15

def uid
  @uid
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



121
122
123
124
125
126
127
128
129
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
162
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 121

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  uid = hash.key?('uid') ? hash['uid'] : SKIP
  scheme = hash.key?('scheme') ? hash['scheme'] : SKIP
  customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
  payment_profile_id =
    hash.key?('payment_profile_id') ? hash['payment_profile_id'] : SKIP
  subscription_ids =
    hash.key?('subscription_ids') ? hash['subscription_ids'] : SKIP
  primary_subscription_id =
    hash.key?('primary_subscription_id') ? hash['primary_subscription_id'] : SKIP
  next_assessment_at = if hash.key?('next_assessment_at')
                         (DateTimeHelper.from_rfc3339(hash['next_assessment_at']) if hash['next_assessment_at'])
                       else
                         SKIP
                       end
  state = hash.key?('state') ? hash['state'] : SKIP
  cancel_at_end_of_period =
    hash.key?('cancel_at_end_of_period') ? hash['cancel_at_end_of_period'] : SKIP
   = SubscriptionGroupBalances.from_hash(hash['account_balances']) if
    hash['account_balances']
  group_type = hash.key?('group_type') ? hash['group_type'] : SKIP

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

  # Create object from extracted values.
  ListSubscriptionGroupsItem.new(uid: uid,
                                 scheme: scheme,
                                 customer_id: customer_id,
                                 payment_profile_id: payment_profile_id,
                                 subscription_ids: subscription_ids,
                                 primary_subscription_id: primary_subscription_id,
                                 next_assessment_at: next_assessment_at,
                                 state: state,
                                 cancel_at_end_of_period: cancel_at_end_of_period,
                                 account_balances: ,
                                 group_type: group_type,
                                 additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['uid'] = 'uid'
  @_hash['scheme'] = 'scheme'
  @_hash['customer_id'] = 'customer_id'
  @_hash['payment_profile_id'] = 'payment_profile_id'
  @_hash['subscription_ids'] = 'subscription_ids'
  @_hash['primary_subscription_id'] = 'primary_subscription_id'
  @_hash['next_assessment_at'] = 'next_assessment_at'
  @_hash['state'] = 'state'
  @_hash['cancel_at_end_of_period'] = 'cancel_at_end_of_period'
  @_hash['account_balances'] = 'account_balances'
  @_hash['group_type'] = 'group_type'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



92
93
94
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 92

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 75

def self.optionals
  %w[
    uid
    scheme
    customer_id
    payment_profile_id
    subscription_ids
    primary_subscription_id
    next_assessment_at
    state
    cancel_at_end_of_period
    account_balances
    group_type
  ]
end

Instance Method Details

#to_custom_next_assessment_at ⇒ Object 



164
165
166
 
# File 'lib/advanced_billing/models/list_subscription_groups_item.rb', line 164

def to_custom_next_assessment_at
  DateTimeHelper.to_rfc3339(next_assessment_at)
end