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



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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/talon_one/models/cart_item.rb', line 141

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

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

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

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

  if attributes.key?(:'product')
    self.product = attributes[:'product']
  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?(:'additional_costs')
    if (value = attributes[:'additional_costs']).is_a?(Hash)
      self.additional_costs = value
    end
  end

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

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

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

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

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

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

Instance Attribute Details

#additional_costs ⇒ Object

Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](docs.talon.one/docs/product/account/dev-tools/managing-additional-costs).



59
60
61
 
# File 'lib/talon_one/models/cart_item.rb', line 59

def additional_costs
  @additional_costs
end

#adjustment_effective_from ⇒ Object

The date and time from which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field.



71
72
73
 
# File 'lib/talon_one/models/cart_item.rb', line 71

def adjustment_effective_from
  @adjustment_effective_from
end

#adjustment_effective_until ⇒ Object

The date and time until which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field.



74
75
76
 
# File 'lib/talon_one/models/cart_item.rb', line 74

def adjustment_effective_until
  @adjustment_effective_until
end

#adjustment_reference_id ⇒ Object

The reference ID of the selected price adjustment for this cart item. Only returned if the selected price resulted from a price adjustment.



68
69
70
 
# File 'lib/talon_one/models/cart_item.rb', line 68

def adjustment_reference_id
  @adjustment_reference_id
end

#attributes ⇒ Object

Use this property to set a value for the attributes of your choice. [Attributes](docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. Note: Any previously defined attributes that you do not include in the array will be removed.



56
57
58
 
# File 'lib/talon_one/models/cart_item.rb', line 56

def attributes
  @attributes
end

#catalog_item_id ⇒ Object

The catalog item ID.



62
63
64
 
# File 'lib/talon_one/models/cart_item.rb', line 62

def catalog_item_id
  @catalog_item_id
end

#category ⇒ Object

Type, group or model of the item.



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

def category
  @category
end

#height ⇒ Object

Height of item in mm.



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

def height
  @height
end

#length ⇒ Object

Length of item in mm.



50
51
52
 
# File 'lib/talon_one/models/cart_item.rb', line 50

def length
  @length
end

#name ⇒ Object

Name of item.



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

def name
  @name
end

#position ⇒ Object

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



53
54
55
 
# File 'lib/talon_one/models/cart_item.rb', line 53

def position
  @position
end

#price ⇒ Object

Price of the item in the currency defined by your Application. This field is required if this item is not part of a [catalog](docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). If it is part of a catalog, setting a price here overrides the price from the catalog.



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

def price
  @price
end

#prices ⇒ Object

A map of keys and values representing the price types and related price adjustment details for this cart item. The keys correspond to the ‘priceType` names.



77
78
79
 
# File 'lib/talon_one/models/cart_item.rb', line 77

def prices
  @prices
end

#product ⇒ Object

Returns the value of attribute product.



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

def product
  @product
end

#quantity ⇒ Object

Number of units of this item. Due to [cart item flattening](docs.talon.one/docs/product/rules/understanding-cart-item-flattening), if you provide a quantity greater than 1, the item will be split in as many items as the provided quantity. This will impact the number of per-item effects triggered from your campaigns.



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

def quantity
  @quantity
end

#remaining_quantity ⇒ Object

Remaining quantity of the item, calculated internally based on returns of this item.



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

def remaining_quantity
  @remaining_quantity
end

#returned_quantity ⇒ Object

Number of returned items, calculated internally based on returns of this item.



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

def returned_quantity
  @returned_quantity
end

#selected_price_type ⇒ Object

The selected price type for this cart item (e.g. the price for members only).



65
66
67
 
# File 'lib/talon_one/models/cart_item.rb', line 65

def selected_price_type
  @selected_price_type
end

#sku ⇒ Object

Stock keeping unit of item.



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

def sku
  @sku
end

#weight ⇒ Object

Weight of item in grams.



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

def weight
  @weight
end

#width ⇒ Object

Width of item in mm.



47
48
49
 
# File 'lib/talon_one/models/cart_item.rb', line 47

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/talon_one/models/cart_item.rb', line 80

def self.attribute_map
  {
    :'name' => :'name',
    :'sku' => :'sku',
    :'quantity' => :'quantity',
    :'returned_quantity' => :'returnedQuantity',
    :'remaining_quantity' => :'remainingQuantity',
    :'price' => :'price',
    :'category' => :'category',
    :'product' => :'product',
    :'weight' => :'weight',
    :'height' => :'height',
    :'width' => :'width',
    :'length' => :'length',
    :'position' => :'position',
    :'attributes' => :'attributes',
    :'additional_costs' => :'additionalCosts',
    :'catalog_item_id' => :'catalogItemID',
    :'selected_price_type' => :'selectedPriceType',
    :'adjustment_reference_id' => :'adjustmentReferenceId',
    :'adjustment_effective_from' => :'adjustmentEffectiveFrom',
    :'adjustment_effective_until' => :'adjustmentEffectiveUntil',
    :'prices' => :'prices'
  }
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



347
348
349
 
# File 'lib/talon_one/models/cart_item.rb', line 347

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



134
135
136
137
 
# File 'lib/talon_one/models/cart_item.rb', line 134

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'name' => :'String',
    :'sku' => :'String',
    :'quantity' => :'Integer',
    :'returned_quantity' => :'Integer',
    :'remaining_quantity' => :'Integer',
    :'price' => :'Float',
    :'category' => :'String',
    :'product' => :'Product',
    :'weight' => :'Float',
    :'height' => :'Float',
    :'width' => :'Float',
    :'length' => :'Float',
    :'position' => :'Float',
    :'attributes' => :'Object',
    :'additional_costs' => :'Hash<String, AdditionalCost>',
    :'catalog_item_id' => :'Integer',
    :'selected_price_type' => :'String',
    :'adjustment_reference_id' => :'String',
    :'adjustment_effective_from' => :'DateTime',
    :'adjustment_effective_until' => :'DateTime',
    :'prices' => :'Hash<String, PriceDetail>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      sku == o.sku &&
      quantity == o.quantity &&
      returned_quantity == o.returned_quantity &&
      remaining_quantity == o.remaining_quantity &&
      price == o.price &&
      category == o.category &&
      product == o.product &&
      weight == o.weight &&
      height == o.height &&
      width == o.width &&
      length == o.length &&
      position == o.position &&
      attributes == o.attributes &&
      additional_costs == o.additional_costs &&
      catalog_item_id == o.catalog_item_id &&
      selected_price_type == o.selected_price_type &&
      adjustment_reference_id == o.adjustment_reference_id &&
      adjustment_effective_from == o.adjustment_effective_from &&
      adjustment_effective_until == o.adjustment_effective_until &&
      prices == o.prices
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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/talon_one/models/cart_item.rb', line 375

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



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/talon_one/models/cart_item.rb', line 444

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



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

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


334
335
336
 
# File 'lib/talon_one/models/cart_item.rb', line 334

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



340
341
342
 
# File 'lib/talon_one/models/cart_item.rb', line 340

def hash
  [name, sku, quantity, returned_quantity, remaining_quantity, price, category, product, weight, height, width, length, position, attributes, additional_costs, catalog_item_id, selected_price_type, adjustment_reference_id, adjustment_effective_from, adjustment_effective_until, prices].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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

  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



420
421
422
 
# File 'lib/talon_one/models/cart_item.rb', line 420

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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/talon_one/models/cart_item.rb', line 426

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



414
415
416
 
# File 'lib/talon_one/models/cart_item.rb', line 414

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



268
269
270
271
272
273
274
 
# File 'lib/talon_one/models/cart_item.rb', line 268

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