Class: Pingram::BillingPostResponseBody

Inherits:
ApiModelBase show all
Defined in:
lib/pingram/models/billing_post_response_body.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ BillingPostResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 130

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::BillingPostResponseBody` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::BillingPostResponseBody`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  else
    self. = nil
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'account_type')
    self. = attributes[:'account_type']
  else
    self. = nil
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  else
    self.created_at = nil
  end

  if attributes.key?(:'creator')
    self.creator = attributes[:'creator']
  end

  if attributes.key?(:'stripe_customer_id')
    self.stripe_customer_id = attributes[:'stripe_customer_id']
  end

  if attributes.key?(:'stripe_subscription_id')
    self.stripe_subscription_id = attributes[:'stripe_subscription_id']
  end

  if attributes.key?(:'subscription_status')
    self.subscription_status = attributes[:'subscription_status']
  end

  if attributes.key?(:'anniversary_date')
    self.anniversary_date = attributes[:'anniversary_date']
  end

  if attributes.key?(:'pending_downgrade_effective_date')
    self.pending_downgrade_effective_date = attributes[:'pending_downgrade_effective_date']
  end

  if attributes.key?(:'pending_downgrade_account_type')
    self. = attributes[:'pending_downgrade_account_type']
  end

  if attributes.key?(:'pending_downgrade_usage_limit')
    self.pending_downgrade_usage_limit = attributes[:'pending_downgrade_usage_limit']
  end

  if attributes.key?(:'session_id')
    self.session_id = attributes[:'session_id']
  end

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  end
end

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



18
19
20
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 18

def 
  @account_id
end

#account_type ⇒ Object

Returns the value of attribute account_type.



22
23
24
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 22

def 
  @account_type
end

#anniversary_date ⇒ Object

ISO date (YYYY-MM-DD) when the billing cycle resets. Used for anniversary-based billing.



35
36
37
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 35

def anniversary_date
  @anniversary_date
end

#created_at ⇒ Object

Returns the value of attribute created_at.



24
25
26
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 24

def created_at
  @created_at
end

#creator ⇒ Object

Returns the value of attribute creator.



26
27
28
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 26

def creator
  @creator
end

#name ⇒ Object

Returns the value of attribute name.



20
21
22
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 20

def name
  @name
end

#pending_downgrade_account_type ⇒ Object

The account type to switch to when downgrade takes effect



41
42
43
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 41

def 
  
end

#pending_downgrade_effective_date ⇒ Object

ISO date (YYYY-MM-DD) when the pending downgrade takes effect



38
39
40
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 38

def pending_downgrade_effective_date
  @pending_downgrade_effective_date
end

#pending_downgrade_usage_limit ⇒ Object

Returns the value of attribute pending_downgrade_usage_limit.



43
44
45
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 43

def pending_downgrade_usage_limit
  @pending_downgrade_usage_limit
end

#session_id ⇒ Object

Returns the value of attribute session_id.



45
46
47
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 45

def session_id
  @session_id
end

#stripe_customer_id ⇒ Object

Returns the value of attribute stripe_customer_id.



28
29
30
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 28

def stripe_customer_id
  @stripe_customer_id
end

#stripe_subscription_id ⇒ Object

Returns the value of attribute stripe_subscription_id.



30
31
32
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 30

def stripe_subscription_id
  @stripe_subscription_id
end

#subscription_status ⇒ Object

Returns the value of attribute subscription_status.



32
33
34
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 32

def subscription_status
  @subscription_status
end

#url ⇒ Object

Returns the value of attribute url.



47
48
49
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 47

def url
  @url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



92
93
94
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 92

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 97

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 72

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'name' => :'name',
    :'account_type' => :'accountType',
    :'created_at' => :'createdAt',
    :'creator' => :'creator',
    :'stripe_customer_id' => :'stripeCustomerId',
    :'stripe_subscription_id' => :'stripeSubscriptionId',
    :'subscription_status' => :'subscriptionStatus',
    :'anniversary_date' => :'anniversaryDate',
    :'pending_downgrade_effective_date' => :'pendingDowngradeEffectiveDate',
    :'pending_downgrade_account_type' => :'pendingDowngradeAccountType',
    :'pending_downgrade_usage_limit' => :'pendingDowngradeUsageLimit',
    :'session_id' => :'sessionId',
    :'url' => :'url'
  }
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 329

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
126
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 122

def self.openapi_nullable
  Set.new([
    :'subscription_status',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 102

def self.openapi_types
  {
    :'account_id' => :'String',
    :'name' => :'String',
    :'account_type' => :'String',
    :'created_at' => :'String',
    :'creator' => :'String',
    :'stripe_customer_id' => :'String',
    :'stripe_subscription_id' => :'String',
    :'subscription_status' => :'String',
    :'anniversary_date' => :'String',
    :'pending_downgrade_effective_date' => :'String',
    :'pending_downgrade_account_type' => :'String',
    :'pending_downgrade_usage_limit' => :'BillingPostResponseBodyPendingDowngradeUsageLimit',
    :'session_id' => :'String',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      name == o.name &&
       == o. &&
      created_at == o.created_at &&
      creator == o.creator &&
      stripe_customer_id == o.stripe_customer_id &&
      stripe_subscription_id == o.stripe_subscription_id &&
      subscription_status == o.subscription_status &&
      anniversary_date == o.anniversary_date &&
      pending_downgrade_effective_date == o.pending_downgrade_effective_date &&
       == o. &&
      pending_downgrade_usage_limit == o.pending_downgrade_usage_limit &&
      session_id == o.session_id &&
      url == o.url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


316
317
318
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 316

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



322
323
324
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 322

def hash
  [, name, , created_at, creator, stripe_customer_id, stripe_subscription_id, subscription_status, anniversary_date, pending_downgrade_effective_date, , pending_downgrade_usage_limit, session_id, url].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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 209

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 351

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/pingram/models/billing_post_response_body.rb', line 229

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  return false if @account_type.nil?
   = EnumAttributeValidator.new('String', ["free", "paid"])
  return false unless .valid?(@account_type)
  return false if @created_at.nil?
  subscription_status_validator = EnumAttributeValidator.new('String', ["active", "canceled", "past_due", "paused"])
  return false unless subscription_status_validator.valid?(@subscription_status)
   = EnumAttributeValidator.new('String', ["free"])
  return false unless .valid?()
  true
end