Class: UltracartClient::ItemOptionValue

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/item_option_value.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemOptionValue

Initializes the object



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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 136

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_dimension_application ⇒ Object

Additional dimensions application



19
20
21
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 19

def additional_dimension_application
  @additional_dimension_application
end

#additional_items ⇒ Object

Additional items to add to the order if this value is selected



22
23
24
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 22

def additional_items
  @additional_items
end

#cost_change ⇒ Object

Cost change



25
26
27
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 25

def cost_change
  @cost_change
end

#default_value ⇒ Object

True if default value



28
29
30
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 28

def default_value
  @default_value
end

#digital_items ⇒ Object

Digital items to allow the customer to download if this option value is selected



31
32
33
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 31

def digital_items
  @digital_items
end

#height ⇒ Object

Returns the value of attribute height.



33
34
35
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 33

def height
  @height
end

#length ⇒ Object

Returns the value of attribute length.



35
36
37
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 35

def length
  @length
end

#merchant_item_multimedia_oid ⇒ Object

Multimedia object identifier associated with this option value



38
39
40
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 38

def merchant_item_multimedia_oid
  @merchant_item_multimedia_oid
end

#option_value_oid ⇒ Object

Option value object identifier



41
42
43
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 41

def option_value_oid
  @option_value_oid
end

#percent_cost_change ⇒ Object

Percentage cost change



44
45
46
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 44

def percent_cost_change
  @percent_cost_change
end

#translated_text_instance_oid ⇒ Object

Translated text instance id



47
48
49
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 47

def translated_text_instance_oid
  @translated_text_instance_oid
end

#value ⇒ Object

Value



50
51
52
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 50

def value
  @value
end

#weight_change ⇒ Object

Returns the value of attribute weight_change.



52
53
54
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 52

def weight_change
  @weight_change
end

#weight_change_percent ⇒ Object

Percentage weight change



55
56
57
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 55

def weight_change_percent
  @weight_change_percent
end

#width ⇒ Object

Returns the value of attribute width.



57
58
59
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 57

def width
  @width
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



103
104
105
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 82

def self.attribute_map
  {
    :'additional_dimension_application' => :'additional_dimension_application',
    :'additional_items' => :'additional_items',
    :'cost_change' => :'cost_change',
    :'default_value' => :'default_value',
    :'digital_items' => :'digital_items',
    :'height' => :'height',
    :'length' => :'length',
    :'merchant_item_multimedia_oid' => :'merchant_item_multimedia_oid',
    :'option_value_oid' => :'option_value_oid',
    :'percent_cost_change' => :'percent_cost_change',
    :'translated_text_instance_oid' => :'translated_text_instance_oid',
    :'value' => :'value',
    :'weight_change' => :'weight_change',
    :'weight_change_percent' => :'weight_change_percent',
    :'width' => :'width'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



291
292
293
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 291

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



129
130
131
132
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 129

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

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 108

def self.openapi_types
  {
    :'additional_dimension_application' => :'String',
    :'additional_items' => :'Array<ItemOptionValueAdditionalItem>',
    :'cost_change' => :'Float',
    :'default_value' => :'Boolean',
    :'digital_items' => :'Array<ItemOptionValueDigitalItem>',
    :'height' => :'Distance',
    :'length' => :'Distance',
    :'merchant_item_multimedia_oid' => :'Integer',
    :'option_value_oid' => :'Integer',
    :'percent_cost_change' => :'Float',
    :'translated_text_instance_oid' => :'Integer',
    :'value' => :'String',
    :'weight_change' => :'Weight',
    :'weight_change_percent' => :'Float',
    :'width' => :'Distance'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 256

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_dimension_application == o.additional_dimension_application &&
      additional_items == o.additional_items &&
      cost_change == o.cost_change &&
      default_value == o.default_value &&
      digital_items == o.digital_items &&
      height == o.height &&
      length == o.length &&
      merchant_item_multimedia_oid == o.merchant_item_multimedia_oid &&
      option_value_oid == o.option_value_oid &&
      percent_cost_change == o.percent_cost_change &&
      translated_text_instance_oid == o.translated_text_instance_oid &&
      value == o.value &&
      weight_change == o.weight_change &&
      weight_change_percent == o.weight_change_percent &&
      width == o.width
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



322
323
324
325
326
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
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 322

def _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 = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/ultracart_api/models/item_option_value.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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 298

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


278
279
280
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



284
285
286
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 284

def hash
  [additional_dimension_application, additional_items, cost_change, default_value, digital_items, height, length, merchant_item_multimedia_oid, option_value_oid, percent_cost_change, translated_text_instance_oid, value, weight_change, weight_change_percent, width].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



216
217
218
219
220
221
222
223
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 216

def list_invalid_properties
  invalid_properties = Array.new
  if !@value.nil? && @value.to_s.length > 1024
    invalid_properties.push('invalid value for "value", the character length must be smaller than or equal to 1024.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



369
370
371
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 369

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 375

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



363
364
365
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 363

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



227
228
229
230
231
232
 
# File 'lib/ultracart_api/models/item_option_value.rb', line 227

def valid?
  additional_dimension_application_validator = EnumAttributeValidator.new('String', ["none", "set item to", "add item"])
  return false unless additional_dimension_application_validator.valid?(@additional_dimension_application)
  return false if !@value.nil? && @value.to_s.length > 1024
  true
end