Class: WalleeRubySdk::SubscriptionProductVersionPending

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionProductVersionPending

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
183
184
185
186
187
188
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 126

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `WalleeRubySdk::SubscriptionProductVersionPending` 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|
    unless self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `WalleeRubySdk::SubscriptionProductVersionPending`. 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?(:'enabled_currencies')
    if (value = attributes[:'enabled_currencies']).is_a?(Array)
      self.enabled_currencies = value
    end
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing_cycle ⇒ Object

The recurring period of time, typically monthly or annually, for which a subscriber is charged.



35
36
37
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 35

def billing_cycle
  @billing_cycle
end

#comment ⇒ Object

A comment that describes the product version and why it was created. It is not disclosed to the subscriber.



47
48
49
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 47

def comment
  @comment
end

#default_currency ⇒ Object

The three-letter code (ISO 4217 format) of the product version’s default currency.



38
39
40
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 38

def default_currency
  @default_currency
end

#enabled_currencies ⇒ Object

The three-letter codes (ISO 4217 format) of the currencies that the product version supports.



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

def enabled_currencies
  @enabled_currencies
end

#minimal_number_of_periods ⇒ Object

The minimum number of periods the subscription will run before it can be terminated.



44
45
46
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 44

def minimal_number_of_periods
  @minimal_number_of_periods
end

#name ⇒ Object

The localized name of the product that is displayed to the customer.



41
42
43
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 41

def name
  @name
end

#number_of_notice_periods ⇒ Object

The number of periods the subscription will keep running after its termination was requested.



52
53
54
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 52

def number_of_notice_periods
  @number_of_notice_periods
end

#product ⇒ Object

The product that the version belongs to.



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

def product
  @product
end

#state ⇒ Object

Returns the value of attribute state.



49
50
51
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 49

def state
  @state
end

#tax_calculation ⇒ Object

Returns the value of attribute tax_calculation.



32
33
34
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 32

def tax_calculation
  @tax_calculation
end

#version ⇒ Object

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.



55
56
57
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 55

def version
  @version
end

Class Method Details

._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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 275

def self._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 = WalleeRubySdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 80

def self.attribute_map
  {
    :'enabled_currencies' => :'enabledCurrencies',
    :'product' => :'product',
    :'tax_calculation' => :'taxCalculation',
    :'billing_cycle' => :'billingCycle',
    :'default_currency' => :'defaultCurrency',
    :'name' => :'name',
    :'minimal_number_of_periods' => :'minimalNumberOfPeriods',
    :'comment' => :'comment',
    :'state' => :'state',
    :'number_of_notice_periods' => :'numberOfNoticePeriods',
    :'version' => :'version'
  }
end

.build_from_hash(attributes) ⇒ Object

Returns the model itself

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 251

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



119
120
121
122
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 119

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 102

def self.openapi_types
  {
    :'enabled_currencies' => :'Array<String>',
    :'product' => :'Integer',
    :'tax_calculation' => :'TaxCalculation',
    :'billing_cycle' => :'String',
    :'default_currency' => :'String',
    :'name' => :'Hash<String, String>',
    :'minimal_number_of_periods' => :'Integer',
    :'comment' => :'String',
    :'state' => :'SubscriptionProductVersionState',
    :'number_of_notice_periods' => :'Integer',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enabled_currencies == o.enabled_currencies &&
      product == o.product &&
      tax_calculation == o.tax_calculation &&
      billing_cycle == o.billing_cycle &&
      default_currency == o.default_currency &&
      name == o.name &&
      minimal_number_of_periods == o.minimal_number_of_periods &&
      comment == o.comment &&
      state == o.state &&
      number_of_notice_periods == o.number_of_notice_periods &&
      version == o.version
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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 346

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


240
241
242
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 240

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



246
247
248
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 246

def hash
  [enabled_currencies, product, tax_calculation, billing_cycle, default_currency, name, minimal_number_of_periods, comment, state, number_of_notice_periods, 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



192
193
194
195
196
197
198
199
200
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 192

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @version.nil?
    invalid_properties.push('invalid value for "version", version 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



322
323
324
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 322

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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 328

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



316
317
318
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 316

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



204
205
206
207
208
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_version_pending.rb', line 204

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @version.nil?
  true
end