Class: WhiteLabelMachineName::SubscriptionProductVersion

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionProductVersion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 142

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

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

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

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

  if attributes.has_key?(:'linkedSpaceId')
    self.linked_space_id = attributes[:'linkedSpaceId']
  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?(:'obsoletedOn')
    self.obsoleted_on = attributes[:'obsoletedOn']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#activated_on ⇒ Object

Returns the value of attribute activated_on.



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

def activated_on
  @activated_on
end

#billing_cycle ⇒ Object

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



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

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.



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

def comment
  @comment
end

#created_on ⇒ Object

Returns the value of attribute created_on.



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

def created_on
  @created_on
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.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.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.



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

def id
  @id
end

#increment_number ⇒ Object

The increment number represents the version number incremented whenever a new version is activated.



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

def increment_number
  @increment_number
end

#linked_space_id ⇒ Object

The linked space id holds the ID of the space to which the entity belongs to.



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

def linked_space_id
  @linked_space_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.



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

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.



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

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.



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

def number_of_notice_periods
  @number_of_notice_periods
end

#obsoleted_on ⇒ Object

Returns the value of attribute obsoleted_on.



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

def obsoleted_on
  @obsoleted_on
end

#planned_purge_date ⇒ Object

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.



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

def planned_purge_date
  @planned_purge_date
end

#product ⇒ Object

Each product version is linked to a product.



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

def product
  @product
end

#reference ⇒ Object

The product version reference helps to identify the version. The reference is generated out of the product reference.



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

def reference
  @reference
end

#retiring_finished_on ⇒ Object

Returns the value of attribute retiring_finished_on.



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

def retiring_finished_on
  @retiring_finished_on
end

#retiring_started_on ⇒ Object

Returns the value of attribute retiring_started_on.



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

def retiring_started_on
  @retiring_started_on
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#tax_calculation ⇒ Object

Strategy that is used for tax calculation in fees.



81
82
83
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 81

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.



84
85
86
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 84

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 87

def self.attribute_map
  {
    :'activated_on' => :'activatedOn',
    :'billing_cycle' => :'billingCycle',
    :'comment' => :'comment',
    :'created_on' => :'createdOn',
    :'default_currency' => :'defaultCurrency',
    :'enabled_currencies' => :'enabledCurrencies',
    :'id' => :'id',
    :'increment_number' => :'incrementNumber',
    :'linked_space_id' => :'linkedSpaceId',
    :'minimal_number_of_periods' => :'minimalNumberOfPeriods',
    :'name' => :'name',
    :'number_of_notice_periods' => :'numberOfNoticePeriods',
    :'obsoleted_on' => :'obsoletedOn',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'product' => :'product',
    :'reference' => :'reference',
    :'retiring_finished_on' => :'retiringFinishedOn',
    :'retiring_started_on' => :'retiringStartedOn',
    :'state' => :'state',
    :'tax_calculation' => :'taxCalculation',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 114

def self.swagger_types
  {
    :'activated_on' => :'DateTime',
    :'billing_cycle' => :'String',
    :'comment' => :'String',
    :'created_on' => :'DateTime',
    :'default_currency' => :'String',
    :'enabled_currencies' => :'Array<String>',
    :'id' => :'Integer',
    :'increment_number' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'minimal_number_of_periods' => :'Integer',
    :'name' => :'DatabaseTranslatedString',
    :'number_of_notice_periods' => :'Integer',
    :'obsoleted_on' => :'DateTime',
    :'planned_purge_date' => :'DateTime',
    :'product' => :'SubscriptionProduct',
    :'reference' => :'String',
    :'retiring_finished_on' => :'DateTime',
    :'retiring_started_on' => :'DateTime',
    :'state' => :'SubscriptionProductVersionState',
    :'tax_calculation' => :'TaxCalculation',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activated_on == o.activated_on &&
      billing_cycle == o.billing_cycle &&
      comment == o.comment &&
      created_on == o.created_on &&
      default_currency == o.default_currency &&
      enabled_currencies == o.enabled_currencies &&
      id == o.id &&
      increment_number == o.increment_number &&
      linked_space_id == o.linked_space_id &&
      minimal_number_of_periods == o.minimal_number_of_periods &&
      name == o.name &&
      number_of_notice_periods == o.number_of_notice_periods &&
      obsoleted_on == o.obsoleted_on &&
      planned_purge_date == o.planned_purge_date &&
      product == o.product &&
      reference == o.reference &&
      retiring_finished_on == o.retiring_finished_on &&
      retiring_started_on == o.retiring_started_on &&
      state == o.state &&
      tax_calculation == o.tax_calculation &&
      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



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
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 327

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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 393

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 306

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


293
294
295
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



299
300
301
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 299

def hash
  [activated_on, billing_cycle, comment, created_on, default_currency, enabled_currencies, id, increment_number, linked_space_id, minimal_number_of_periods, name, number_of_notice_periods, obsoleted_on, planned_purge_date, product, reference, retiring_finished_on, retiring_started_on, state, tax_calculation, 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



237
238
239
240
241
242
243
244
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 237

def list_invalid_properties
  invalid_properties = Array.new
  if !@reference.nil? && @reference.to_s.length > 125
    invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 125.')
  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



373
374
375
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 373

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



379
380
381
382
383
384
385
386
387
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 379

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



367
368
369
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 367

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



248
249
250
251
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_version.rb', line 248

def valid?
  return false if !@reference.nil? && @reference.to_s.length > 125
  true
end