Class: VoucherifySdk::OrderCalculatedItem

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/order_calculated_item.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderCalculatedItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
277
278
279
280
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 189

def initialize(attributes = {})
  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The total amount of the order item (price * quantity).



43
44
45
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 43

def amount
  @amount
end

#applied_discount_amount ⇒ Object

This field shows the order-level discount applied.



49
50
51
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 49

def applied_discount_amount
  @applied_discount_amount
end

#applied_discount_quantity ⇒ Object

Number of the discounted items applied in the transaction.



52
53
54
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 52

def applied_discount_quantity
  @applied_discount_quantity
end

#applied_quantity ⇒ Object

Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.



55
56
57
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 55

def applied_quantity
  @applied_quantity
end

#applied_quantity_amount ⇒ Object

Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.



58
59
60
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 58

def applied_quantity_amount
  @applied_quantity_amount
end

#discount_amount ⇒ Object

Sum of all order-item-level discounts applied to the order.



46
47
48
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 46

def discount_amount
  @discount_amount
end

#discount_quantity ⇒ Object

Number of dicounted items.



37
38
39
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 37

def discount_quantity
  @discount_quantity
end

#id ⇒ Object

Unique identifier of the order line item.



19
20
21
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 19

def id
  @id
end

#initial_amount ⇒ Object

A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items’ amounts.



61
62
63
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 61

def initial_amount
  @initial_amount
end

#initial_quantity ⇒ Object

A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items’ quantity.



40
41
42
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 40

def initial_quantity
  @initial_quantity
end

#metadata ⇒ Object

A set of custom key/value pairs that you can attach to an SKU. It can be useful for storing additional information about the SKU in a structured format.



77
78
79
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 77

def metadata
  @metadata
end

#object ⇒ Object

The type of the object represented by JSON.



74
75
76
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 74

def object
  @object
end

#price ⇒ Object

Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example ‘10000 cents` for `$100.00`.



64
65
66
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 64

def price
  @price
end

#product ⇒ Object

Returns the value of attribute product.



69
70
71
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 69

def product
  @product
end

#product_id ⇒ Object

Unique identifier of the product. It is assigned by Voucherify.



25
26
27
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 25

def product_id
  @product_id
end

#quantity ⇒ Object

The quantity of the particular item in the cart.



34
35
36
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 34

def quantity
  @quantity
end

#related_object ⇒ Object

Used along with the source_id property, can be set to either sku or product.



28
29
30
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 28

def related_object
  @related_object
end

#sku ⇒ Object

Returns the value of attribute sku.



71
72
73
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 71

def sku
  @sku
end

#sku_id ⇒ Object

Unique identifier of the SKU. It is assigned by Voucherify.



22
23
24
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 22

def sku_id
  @sku_id
end

#source_id ⇒ Object

The merchant’s product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service.



31
32
33
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 31

def source_id
  @source_id
end

#subtotal_amount ⇒ Object

Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the ‘amount`. `subtotal_amount`=`amount`-`applied_discount_amount`



67
68
69
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 67

def subtotal_amount
  @subtotal_amount
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



368
369
370
371
372
373
374
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
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 368

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 = VoucherifySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



129
130
131
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 129

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 102

def self.attribute_map
  {
    :'id' => :'id',
    :'sku_id' => :'sku_id',
    :'product_id' => :'product_id',
    :'related_object' => :'related_object',
    :'source_id' => :'source_id',
    :'quantity' => :'quantity',
    :'discount_quantity' => :'discount_quantity',
    :'initial_quantity' => :'initial_quantity',
    :'amount' => :'amount',
    :'discount_amount' => :'discount_amount',
    :'applied_discount_amount' => :'applied_discount_amount',
    :'applied_discount_quantity' => :'applied_discount_quantity',
    :'applied_quantity' => :'applied_quantity',
    :'applied_quantity_amount' => :'applied_quantity_amount',
    :'initial_amount' => :'initial_amount',
    :'price' => :'price',
    :'subtotal_amount' => :'subtotal_amount',
    :'product' => :'product',
    :'sku' => :'sku',
    :'object' => :'object',
    :'metadata' => :'metadata'
  }
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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 344

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



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/VoucherifySdk/models/order_calculated_item.rb', line 161

def self.openapi_nullable
  Set.new([
    :'id',
    :'sku_id',
    :'product_id',
    :'related_object',
    :'source_id',
    :'quantity',
    :'discount_quantity',
    :'initial_quantity',
    :'amount',
    :'discount_amount',
    :'applied_discount_amount',
    :'applied_discount_quantity',
    :'applied_quantity',
    :'applied_quantity_amount',
    :'initial_amount',
    :'price',
    :'subtotal_amount',
    :'product',
    :'sku',
    :'object',
    :'metadata'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 134

def self.openapi_types
  {
    :'id' => :'String',
    :'sku_id' => :'String',
    :'product_id' => :'String',
    :'related_object' => :'String',
    :'source_id' => :'String',
    :'quantity' => :'Integer',
    :'discount_quantity' => :'Integer',
    :'initial_quantity' => :'Integer',
    :'amount' => :'Integer',
    :'discount_amount' => :'Integer',
    :'applied_discount_amount' => :'Integer',
    :'applied_discount_quantity' => :'Integer',
    :'applied_quantity' => :'Integer',
    :'applied_quantity_amount' => :'Integer',
    :'initial_amount' => :'Integer',
    :'price' => :'Integer',
    :'subtotal_amount' => :'Integer',
    :'product' => :'OrderCalculatedItemProduct',
    :'sku' => :'OrderCalculatedItemSku',
    :'object' => :'String',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 303

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      sku_id == o.sku_id &&
      product_id == o.product_id &&
      related_object == o.related_object &&
      source_id == o.source_id &&
      quantity == o.quantity &&
      discount_quantity == o.discount_quantity &&
      initial_quantity == o.initial_quantity &&
      amount == o.amount &&
      discount_amount == o.discount_amount &&
      applied_discount_amount == o.applied_discount_amount &&
      applied_discount_quantity == o.applied_discount_quantity &&
      applied_quantity == o.applied_quantity &&
      applied_quantity_amount == o.applied_quantity_amount &&
      initial_amount == o.initial_amount &&
      price == o.price &&
      subtotal_amount == o.subtotal_amount &&
      product == o.product &&
      sku == o.sku &&
      object == o.object &&
      metadata == o.metadata
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



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 439

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


331
332
333
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 331

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



337
338
339
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 337

def hash
  [id, sku_id, product_id, related_object, source_id, quantity, discount_quantity, initial_quantity, amount, discount_amount, applied_discount_amount, applied_discount_quantity, applied_quantity, applied_quantity_amount, initial_amount, price, subtotal_amount, product, sku, object, metadata].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



284
285
286
287
288
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 284

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



415
416
417
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 415

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



421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 421

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



409
410
411
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 409

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



292
293
294
295
296
297
298
299
 
# File 'lib/VoucherifySdk/models/order_calculated_item.rb', line 292

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  related_object_validator = EnumAttributeValidator.new('String', ["product", "sku"])
  return false unless related_object_validator.valid?(@related_object)
  object_validator = EnumAttributeValidator.new('String', ["order_item"])
  return false unless object_validator.valid?(@object)
  true
end