Class: OryClient::Subscription

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/models/subscription.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Subscription

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/ory-client/models/subscription.rb', line 122

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



18
19
20
 
# File 'lib/ory-client/models/subscription.rb', line 18

def created_at
  @created_at
end

#current_interval ⇒ Object

The currently active interval of the subscription monthly Monthly yearly Yearly



21
22
23
 
# File 'lib/ory-client/models/subscription.rb', line 21

def current_interval
  @current_interval
end

#current_plan ⇒ Object

The currently active plan of the subscription



24
25
26
 
# File 'lib/ory-client/models/subscription.rb', line 24

def current_plan
  @current_plan
end

#customer_id ⇒ Object

The ID of the stripe customer



27
28
29
 
# File 'lib/ory-client/models/subscription.rb', line 27

def customer_id
  @customer_id
end

#id ⇒ Object

The ID of the subscription



30
31
32
 
# File 'lib/ory-client/models/subscription.rb', line 30

def id
  @id
end

#interval_changes_to ⇒ Object

Returns the value of attribute interval_changes_to.



32
33
34
 
# File 'lib/ory-client/models/subscription.rb', line 32

def interval_changes_to
  @interval_changes_to
end

#ongoing_stripe_checkout_id ⇒ Object

Returns the value of attribute ongoing_stripe_checkout_id.



34
35
36
 
# File 'lib/ory-client/models/subscription.rb', line 34

def ongoing_stripe_checkout_id
  @ongoing_stripe_checkout_id
end

#payed_until ⇒ Object

Until when the subscription is payed



37
38
39
 
# File 'lib/ory-client/models/subscription.rb', line 37

def payed_until
  @payed_until
end

#plan_changes_at ⇒ Object

Returns the value of attribute plan_changes_at.



39
40
41
 
# File 'lib/ory-client/models/subscription.rb', line 39

def plan_changes_at
  @plan_changes_at
end

#plan_changes_to ⇒ Object

Returns the value of attribute plan_changes_to.



41
42
43
 
# File 'lib/ory-client/models/subscription.rb', line 41

def plan_changes_to
  @plan_changes_to
end

#status ⇒ Object

For ‘collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated. A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. If subscription `collection_method=charge_automatically` it becomes `past_due` when payment to renew it fails and `canceled` or `unpaid` (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts. If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.



44
45
46
 
# File 'lib/ory-client/models/subscription.rb', line 44

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



46
47
48
 
# File 'lib/ory-client/models/subscription.rb', line 46

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/ory-client/models/subscription.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/ory-client/models/subscription.rb', line 71

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'current_interval' => :'current_interval',
    :'current_plan' => :'current_plan',
    :'customer_id' => :'customer_id',
    :'id' => :'id',
    :'interval_changes_to' => :'interval_changes_to',
    :'ongoing_stripe_checkout_id' => :'ongoing_stripe_checkout_id',
    :'payed_until' => :'payed_until',
    :'plan_changes_at' => :'plan_changes_at',
    :'plan_changes_to' => :'plan_changes_to',
    :'status' => :'status',
    :'updated_at' => :'updated_at'
  }
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



283
284
285
 
# File 'lib/ory-client/models/subscription.rb', line 283

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
116
117
118
 
# File 'lib/ory-client/models/subscription.rb', line 112

def self.openapi_nullable
  Set.new([
    :'interval_changes_to',
    :'ongoing_stripe_checkout_id',
    :'plan_changes_to',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/ory-client/models/subscription.rb', line 94

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'current_interval' => :'String',
    :'current_plan' => :'String',
    :'customer_id' => :'String',
    :'id' => :'String',
    :'interval_changes_to' => :'String',
    :'ongoing_stripe_checkout_id' => :'String',
    :'payed_until' => :'Time',
    :'plan_changes_at' => :'Time',
    :'plan_changes_to' => :'String',
    :'status' => :'String',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/ory-client/models/subscription.rb', line 251

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      current_interval == o.current_interval &&
      current_plan == o.current_plan &&
      customer_id == o.customer_id &&
      id == o.id &&
      interval_changes_to == o.interval_changes_to &&
      ongoing_stripe_checkout_id == o.ongoing_stripe_checkout_id &&
      payed_until == o.payed_until &&
      plan_changes_at == o.plan_changes_at &&
      plan_changes_to == o.plan_changes_to &&
      status == o.status &&
      updated_at == o.updated_at
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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/ory-client/models/subscription.rb', line 314

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = OryClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/ory-client/models/subscription.rb', line 385

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/ory-client/models/subscription.rb', line 290

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


270
271
272
 
# File 'lib/ory-client/models/subscription.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



276
277
278
 
# File 'lib/ory-client/models/subscription.rb', line 276

def hash
  [created_at, current_interval, current_plan, customer_id, id, interval_changes_to, ongoing_stripe_checkout_id, payed_until, plan_changes_at, plan_changes_to, status, updated_at].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



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
 
# File 'lib/ory-client/models/subscription.rb', line 186

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

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

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

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

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

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

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

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

  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



361
362
363
 
# File 'lib/ory-client/models/subscription.rb', line 361

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/ory-client/models/subscription.rb', line 367

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



355
356
357
 
# File 'lib/ory-client/models/subscription.rb', line 355

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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/ory-client/models/subscription.rb', line 225

def valid?
  return false if @created_at.nil?
  return false if @current_interval.nil?
  current_interval_validator = EnumAttributeValidator.new('String', ["monthly", "yearly"])
  return false unless current_interval_validator.valid?(@current_interval)
  return false if @current_plan.nil?
  return false if @customer_id.nil?
  return false if @id.nil?
  return false if @payed_until.nil?
  return false if @status.nil?
  return false if @updated_at.nil?
  true
end