Class: VRPayment::SubscriptionVersion

Inherits:
Object
  • Object
show all
Defined in:
lib/vrpayment-ruby-sdk/models/subscription_version.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionVersion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 132

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?(:'activatedOn')
    self.activated_on = attributes[:'activatedOn']
  end

  if attributes.has_key?(:'billingCurrency')
    self.billing_currency = attributes[:'billingCurrency']
  end

  if attributes.has_key?(:'billingCycleModel')
    self.billing_cycle_model = attributes[:'billingCycleModel']
  end

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

  if attributes.has_key?(:'createdOn')
    self.created_on = attributes[:'createdOn']
  end

  if attributes.has_key?(:'expectedLastPeriodEnd')
    self.expected_last_period_end = attributes[:'expectedLastPeriodEnd']
  end

  if attributes.has_key?(:'failedOn')
    self.failed_on = attributes[:'failedOn']
  end

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

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

  if attributes.has_key?(:'linkedSpaceId')
    self.linked_space_id = attributes[:'linkedSpaceId']
  end

  if attributes.has_key?(:'plannedPurgeDate')
    self.planned_purge_date = attributes[:'plannedPurgeDate']
  end

  if attributes.has_key?(:'plannedTerminationDate')
    self.planned_termination_date = attributes[:'plannedTerminationDate']
  end

  if attributes.has_key?(:'productVersion')
    self.product_version = attributes[:'productVersion']
  end

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

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

  if attributes.has_key?(:'terminatedOn')
    self.terminated_on = attributes[:'terminatedOn']
  end

  if attributes.has_key?(:'terminatingOn')
    self.terminating_on = attributes[:'terminatingOn']
  end

  if attributes.has_key?(:'terminationIssuedOn')
    self.termination_issued_on = attributes[:'terminationIssuedOn']
  end

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

Instance Attribute Details

#activated_on ⇒ Object

The date and time when the subscription version was activated.



24
25
26
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 24

def activated_on
  @activated_on
end

#billing_currency ⇒ Object

The three-letter code (ISO 4217 format) of the currency used to invoice the customer. Must be one of the currencies supported by the product.



27
28
29
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 27

def billing_currency
  @billing_currency
end

#billing_cycle_model ⇒ Object

Returns the value of attribute billing_cycle_model.



30
31
32
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 30

def billing_cycle_model
  @billing_cycle_model
end

#component_configurations ⇒ Object

The configurations of the subscription’s components.



33
34
35
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 33

def component_configurations
  @component_configurations
end

#created_on ⇒ Object

The date and time when the subscription version was created.



36
37
38
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 36

def created_on
  @created_on
end

#expected_last_period_end ⇒ Object

The date and time when the last period is expected to end.



39
40
41
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 39

def expected_last_period_end
  @expected_last_period_end
end

#failed_on ⇒ Object

The date and time when the subscription version failed.



42
43
44
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 42

def failed_on
  @failed_on
end

#id ⇒ Object

A unique identifier for the object.



45
46
47
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 45

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



48
49
50
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 48

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



51
52
53
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 51

def linked_space_id
  @linked_space_id
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



54
55
56
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 54

def planned_purge_date
  @planned_purge_date
end

#planned_termination_date ⇒ Object

The date and time when the termination of the subscription version is planned.



57
58
59
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 57

def planned_termination_date
  @planned_termination_date
end

#product_version ⇒ Object

The product version that is subscribed to.



60
61
62
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 60

def product_version
  @product_version
end

#state ⇒ Object

The object’s current state.



63
64
65
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 63

def state
  @state
end

#subscription ⇒ Object

The subscription that this version belongs to.



66
67
68
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 66

def subscription
  @subscription
end

#terminated_on ⇒ Object

The date and time when the subscription version was terminated.



69
70
71
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 69

def terminated_on
  @terminated_on
end

#terminating_on ⇒ Object

The date and time when the termination of the subscription version started.



72
73
74
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 72

def terminating_on
  @terminating_on
end

#termination_issued_on ⇒ Object

The date and time when the termination of the subscription version was issued.



75
76
77
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 75

def termination_issued_on
  @termination_issued_on
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



78
79
80
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 78

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 81

def self.attribute_map
  {
    :'activated_on' => :'activatedOn',
    :'billing_currency' => :'billingCurrency',
    :'billing_cycle_model' => :'billingCycleModel',
    :'component_configurations' => :'componentConfigurations',
    :'created_on' => :'createdOn',
    :'expected_last_period_end' => :'expectedLastPeriodEnd',
    :'failed_on' => :'failedOn',
    :'id' => :'id',
    :'language' => :'language',
    :'linked_space_id' => :'linkedSpaceId',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'planned_termination_date' => :'plannedTerminationDate',
    :'product_version' => :'productVersion',
    :'state' => :'state',
    :'subscription' => :'subscription',
    :'terminated_on' => :'terminatedOn',
    :'terminating_on' => :'terminatingOn',
    :'termination_issued_on' => :'terminationIssuedOn',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 106

def self.swagger_types
  {
    :'activated_on' => :'DateTime',
    :'billing_currency' => :'String',
    :'billing_cycle_model' => :'BillingCycleModel',
    :'component_configurations' => :'Array<SubscriptionComponentConfiguration>',
    :'created_on' => :'DateTime',
    :'expected_last_period_end' => :'DateTime',
    :'failed_on' => :'DateTime',
    :'id' => :'Integer',
    :'language' => :'String',
    :'linked_space_id' => :'Integer',
    :'planned_purge_date' => :'DateTime',
    :'planned_termination_date' => :'DateTime',
    :'product_version' => :'SubscriptionProductVersion',
    :'state' => :'SubscriptionVersionState',
    :'subscription' => :'Subscription',
    :'terminated_on' => :'DateTime',
    :'terminating_on' => :'DateTime',
    :'termination_issued_on' => :'DateTime',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activated_on == o.activated_on &&
      billing_currency == o.billing_currency &&
      billing_cycle_model == o.billing_cycle_model &&
      component_configurations == o.component_configurations &&
      created_on == o.created_on &&
      expected_last_period_end == o.expected_last_period_end &&
      failed_on == o.failed_on &&
      id == o.id &&
      language == o.language &&
      linked_space_id == o.linked_space_id &&
      planned_purge_date == o.planned_purge_date &&
      planned_termination_date == o.planned_termination_date &&
      product_version == o.product_version &&
      state == o.state &&
      subscription == o.subscription &&
      terminated_on == o.terminated_on &&
      terminating_on == o.terminating_on &&
      termination_issued_on == o.termination_issued_on &&
      version == o.version
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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 292

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 =~ /\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
    temp_model = VRPayment.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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 358

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 271

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


258
259
260
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 258

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



264
265
266
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 264

def hash
  [activated_on, billing_currency, billing_cycle_model, component_configurations, created_on, expected_last_period_end, failed_on, id, language, linked_space_id, planned_purge_date, planned_termination_date, product_version, state, subscription, terminated_on, terminating_on, termination_issued_on, version].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



219
220
221
222
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 219

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



338
339
340
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 338

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



344
345
346
347
348
349
350
351
352
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 344

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



332
333
334
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 332

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



226
227
228
 
# File 'lib/vrpayment-ruby-sdk/models/subscription_version.rb', line 226

def valid?
  true
end