Class: PostfinancecheckoutRubySdk::SubscriptionProductComponentUpdate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionProductComponentUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 118

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#component_change_weight ⇒ Object

If switching from a component with a lower tier to a component with a higher one, this is considered an upgrade and a fee may be applied.



50
51
52
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 50

def component_change_weight
  @component_change_weight
end

#component_group ⇒ Object

The group that the component belongs to.



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

def component_group
  @component_group
end

#default_component ⇒ Object

Whether this is the default component in its group and preselected.



59
60
61
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 59

def default_component
  @default_component
end

#description ⇒ Object

The localized description of the component that is displayed to the customer.



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

def description
  @description
end

#maximal_quantity ⇒ Object

A maximum of the defined quantity can be selected for this component.



56
57
58
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 56

def maximal_quantity
  @maximal_quantity
end

#minimal_quantity ⇒ Object

A minimum of the defined quantity must be selected for this component.



62
63
64
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 62

def minimal_quantity
  @minimal_quantity
end

#name ⇒ Object

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



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

def name
  @name
end

#quantity_step ⇒ Object

The quantity step determines the interval in which the quantity can be increased.



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

def quantity_step
  @quantity_step
end

#reference ⇒ Object

The reference is used to link components across different product versions.



29
30
31
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 29

def reference
  @reference
end

#sort_order ⇒ Object

When listing components, they can be sorted by this number.



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

def sort_order
  @sort_order
end

#tax_class ⇒ Object

The tax class to be applied to fees.



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

def tax_class
  @tax_class
end

#version ⇒ Object

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



53
54
55
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 53

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/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.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 = PostfinancecheckoutRubySdk.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



83
84
85
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 83

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 88

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 65

def self.attribute_map
  {
    :'reference' => :'reference',
    :'tax_class' => :'taxClass',
    :'quantity_step' => :'quantityStep',
    :'sort_order' => :'sortOrder',
    :'component_group' => :'componentGroup',
    :'name' => :'name',
    :'description' => :'description',
    :'component_change_weight' => :'componentChangeWeight',
    :'version' => :'version',
    :'maximal_quantity' => :'maximalQuantity',
    :'default_component' => :'defaultComponent',
    :'minimal_quantity' => :'minimalQuantity'
  }
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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.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



111
112
113
114
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 111

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

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 93

def self.openapi_types
  {
    :'reference' => :'Integer',
    :'tax_class' => :'Integer',
    :'quantity_step' => :'Float',
    :'sort_order' => :'Integer',
    :'component_group' => :'Integer',
    :'name' => :'Hash<String, String>',
    :'description' => :'Hash<String, String>',
    :'component_change_weight' => :'Integer',
    :'version' => :'Integer',
    :'maximal_quantity' => :'Float',
    :'default_component' => :'Boolean',
    :'minimal_quantity' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reference == o.reference &&
      tax_class == o.tax_class &&
      quantity_step == o.quantity_step &&
      sort_order == o.sort_order &&
      component_group == o.component_group &&
      name == o.name &&
      description == o.description &&
      component_change_weight == o.component_change_weight &&
      version == o.version &&
      maximal_quantity == o.maximal_quantity &&
      default_component == o.default_component &&
      minimal_quantity == o.minimal_quantity
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/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.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


238
239
240
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 244

def hash
  [reference, tax_class, quantity_step, sort_order, component_group, name, description, component_change_weight, version, maximal_quantity, default_component, minimal_quantity].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



189
190
191
192
193
194
195
196
197
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 189

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/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.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/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.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/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.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



201
202
203
204
205
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_component_update.rb', line 201

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