Class: WhiteLabelMachineName::SubscriptionProductVersionPending

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

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 97

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing_cycle ⇒ Object

The billing cycle determines the rhythm with which the subscriber is billed. The charging may have different rhythm.



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

def billing_cycle
  @billing_cycle
end

#comment ⇒ Object

The comment allows to provide a internal comment for the version. It helps to document why a product was changed. The comment is not disclosed to the subscriber.



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

def comment
  @comment
end

#default_currency ⇒ Object

The default currency has to be used in all fees.



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

def default_currency
  @default_currency
end

#enabled_currencies ⇒ Object

The currencies which are enabled can be selected to define component fees. Currencies which are not enabled cannot be used to define fees.



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

def enabled_currencies
  @enabled_currencies
end

#id ⇒ Object

The ID is the primary key of the entity. The ID identifies the entity uniquely.



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

def id
  @id
end

#minimal_number_of_periods ⇒ Object

The minimal number of periods determines how long the subscription has to run before the subscription can be terminated.



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

def minimal_number_of_periods
  @minimal_number_of_periods
end

#name ⇒ Object

The product version name is the name of the product which is shown to the user for the version. When the visible product name should be changed for a particular product a new version has to be created which contains the new name of the product.



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

def name
  @name
end

#number_of_notice_periods ⇒ Object

The number of notice periods determines the number of periods which need to be paid between the request to terminate the subscription and the final period.



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

def number_of_notice_periods
  @number_of_notice_periods
end

#product ⇒ Object

Each product version is linked to a product.



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

def product
  @product
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#tax_calculation ⇒ Object

Strategy that is used for tax calculation in fees.



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

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.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 60

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 179

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 232

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 = WhiteLabelMachineName.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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 298

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 211

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


198
199
200
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

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



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 156

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

  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



278
279
280
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 278

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



284
285
286
287
288
289
290
291
292
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 284

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



272
273
274
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 272

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



171
172
173
174
175
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version_pending.rb', line 171

def valid?
  return false if @id.nil?
  return false if @version.nil?
  true
end