Class: WhiteLabelMachineName::SubscriptionProductComponent

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionProductComponent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_component.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#component_change_weight ⇒ Object

If a product component changes from one with a lower product component tier (e.g. 1) to one with a higher product component tier (e.g. 3), it is considered an upgrade and a one-time fee could be applied.



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

def component_change_weight
  @component_change_weight
end

#component_group ⇒ Object

Returns the value of attribute component_group.



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

def component_group
  @component_group
end

#default_component ⇒ Object

When a component is marked as a ‘default’ component it is used as the default component in its group and will be preselected in the product configuration.



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

def default_component
  @default_component
end

#description ⇒ Object

The component description may contain a longer description which gives the subscriber a better understanding of what the component contains.



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

def description
  @description
end

#id ⇒ Object

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



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

def id
  @id
end

#linked_space_id ⇒ Object

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



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

def linked_space_id
  @linked_space_id
end

#maximal_quantity ⇒ Object

The maximum quantity defines the maximum value which must be entered for the quantity.



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

def maximal_quantity
  @maximal_quantity
end

#minimal_quantity ⇒ Object

The minimal quantity defines the minimum value which must be entered for the quantity.



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

def minimal_quantity
  @minimal_quantity
end

#name ⇒ Object

The component name is shown to the subscriber. It should describe in few words what the component does contain.



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

def name
  @name
end

#quantity_step ⇒ Object

The quantity step defines at which interval the quantity can be increased.



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

def quantity_step
  @quantity_step
end

#reference ⇒ Object

The component reference is used to identify the component by external systems and it marks components to represent the same component within different product versions.



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

def reference
  @reference
end

#sort_order ⇒ Object

The sort order controls in which order the component is listed. The sort order is used to order the components in ascending order.



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

def sort_order
  @sort_order
end

#tax_class ⇒ Object

The tax class of the component determines the taxes which are applicable on all fees linked with the component.



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

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.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_component.rb', line 66

def self.attribute_map
  {
    :'component_change_weight' => :'componentChangeWeight',
    :'component_group' => :'componentGroup',
    :'default_component' => :'defaultComponent',
    :'description' => :'description',
    :'id' => :'id',
    :'linked_space_id' => :'linkedSpaceId',
    :'maximal_quantity' => :'maximalQuantity',
    :'minimal_quantity' => :'minimalQuantity',
    :'name' => :'name',
    :'quantity_step' => :'quantityStep',
    :'reference' => :'reference',
    :'sort_order' => :'sortOrder',
    :'tax_class' => :'taxClass',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_component.rb', line 86

def self.swagger_types
  {
    :'component_change_weight' => :'Integer',
    :'component_group' => :'SubscriptionProductComponentGroup',
    :'default_component' => :'BOOLEAN',
    :'description' => :'DatabaseTranslatedString',
    :'id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'maximal_quantity' => :'Float',
    :'minimal_quantity' => :'Float',
    :'name' => :'DatabaseTranslatedString',
    :'quantity_step' => :'Float',
    :'reference' => :'SubscriptionProductComponentReference',
    :'sort_order' => :'Integer',
    :'tax_class' => :'TaxClass',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_component.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      component_change_weight == o.component_change_weight &&
      component_group == o.component_group &&
      default_component == o.default_component &&
      description == o.description &&
      id == o.id &&
      linked_space_id == o.linked_space_id &&
      maximal_quantity == o.maximal_quantity &&
      minimal_quantity == o.minimal_quantity &&
      name == o.name &&
      quantity_step == o.quantity_step &&
      reference == o.reference &&
      sort_order == o.sort_order &&
      tax_class == o.tax_class &&
      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



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
269
270
271
272
273
274
275
276
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_component.rb', line 240

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



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

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



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

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


206
207
208
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_component.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



212
213
214
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_component.rb', line 212

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



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

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



286
287
288
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_component.rb', line 286

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



292
293
294
295
296
297
298
299
300
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_component.rb', line 292

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



280
281
282
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_component.rb', line 280

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



179
180
181
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_product_component.rb', line 179

def valid?
  true
end