Class: TalonOne::CartItem

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/cart_item.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CartItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
96
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
 
# File 'lib/talon_one/models/cart_item.rb', line 91

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::CartItem` 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 `TalonOne::CartItem`. 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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#adjustment ⇒ Object

Returns the value of attribute adjustment.



45
46
47
 
# File 'lib/talon_one/models/cart_item.rb', line 45

def adjustment
  @adjustment
end

#attributes ⇒ Object

Arbitrary properties associated with this item



43
44
45
 
# File 'lib/talon_one/models/cart_item.rb', line 43

def attributes
  @attributes
end

#category ⇒ Object

Returns the value of attribute category.



25
26
27
 
# File 'lib/talon_one/models/cart_item.rb', line 25

def category
  @category
end

#height ⇒ Object

Height of item in mm



31
32
33
 
# File 'lib/talon_one/models/cart_item.rb', line 31

def height
  @height
end

#length ⇒ Object

Length of item in mm



37
38
39
 
# File 'lib/talon_one/models/cart_item.rb', line 37

def length
  @length
end

#name ⇒ Object

Returns the value of attribute name.



17
18
19
 
# File 'lib/talon_one/models/cart_item.rb', line 17

def name
  @name
end

#position ⇒ Object

Position of the Cart Item in the Cart (calculated internally)



40
41
42
 
# File 'lib/talon_one/models/cart_item.rb', line 40

def position
  @position
end

#price ⇒ Object

Returns the value of attribute price.



23
24
25
 
# File 'lib/talon_one/models/cart_item.rb', line 23

def price
  @price
end

#quantity ⇒ Object

Returns the value of attribute quantity.



21
22
23
 
# File 'lib/talon_one/models/cart_item.rb', line 21

def quantity
  @quantity
end

#sku ⇒ Object

Returns the value of attribute sku.



19
20
21
 
# File 'lib/talon_one/models/cart_item.rb', line 19

def sku
  @sku
end

#weight ⇒ Object

Weight of item in mm



28
29
30
 
# File 'lib/talon_one/models/cart_item.rb', line 28

def weight
  @weight
end

#width ⇒ Object

Width of item in mm



34
35
36
 
# File 'lib/talon_one/models/cart_item.rb', line 34

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/talon_one/models/cart_item.rb', line 48

def self.attribute_map
  {
    :'name' => :'name',
    :'sku' => :'sku',
    :'quantity' => :'quantity',
    :'price' => :'price',
    :'category' => :'category',
    :'weight' => :'weight',
    :'height' => :'height',
    :'width' => :'width',
    :'length' => :'length',
    :'position' => :'position',
    :'attributes' => :'attributes',
    :'adjustment' => :'adjustment'
  }
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



277
278
279
 
# File 'lib/talon_one/models/cart_item.rb', line 277

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



84
85
86
87
 
# File 'lib/talon_one/models/cart_item.rb', line 84

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/talon_one/models/cart_item.rb', line 66

def self.openapi_types
  {
    :'name' => :'String',
    :'sku' => :'String',
    :'quantity' => :'Integer',
    :'price' => :'Float',
    :'category' => :'String',
    :'weight' => :'Float',
    :'height' => :'Float',
    :'width' => :'Float',
    :'length' => :'Float',
    :'position' => :'Float',
    :'attributes' => :'Object',
    :'adjustment' => :'CartItemAdjustment'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/talon_one/models/cart_item.rb', line 245

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      sku == o.sku &&
      quantity == o.quantity &&
      price == o.price &&
      category == o.category &&
      weight == o.weight &&
      height == o.height &&
      width == o.width &&
      length == o.length &&
      position == o.position &&
      attributes == o.attributes &&
      adjustment == o.adjustment
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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/talon_one/models/cart_item.rb', line 305

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
    TalonOne.const_get(type).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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/talon_one/models/cart_item.rb', line 374

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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/talon_one/models/cart_item.rb', line 284

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


264
265
266
 
# File 'lib/talon_one/models/cart_item.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



270
271
272
 
# File 'lib/talon_one/models/cart_item.rb', line 270

def hash
  [name, sku, quantity, price, category, weight, height, width, length, position, attributes, adjustment].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



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
 
# File 'lib/talon_one/models/cart_item.rb', line 155

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

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  if @sku.nil?
    invalid_properties.push('invalid value for "sku", sku cannot be nil.')
  end

  if @sku.to_s.length < 1
    invalid_properties.push('invalid value for "sku", the character length must be great than or equal to 1.')
  end

  if @quantity.nil?
    invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
  end

  if @quantity < 1
    invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.')
  end

  if @price.nil?
    invalid_properties.push('invalid value for "price", price 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



350
351
352
 
# File 'lib/talon_one/models/cart_item.rb', line 350

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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/talon_one/models/cart_item.rb', line 356

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



344
345
346
 
# File 'lib/talon_one/models/cart_item.rb', line 344

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



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/talon_one/models/cart_item.rb', line 190

def valid?
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @sku.nil?
  return false if @sku.to_s.length < 1
  return false if @quantity.nil?
  return false if @quantity < 1
  return false if @price.nil?
  true
end