Class: VoucherifySdk::OrderCalculatedBase

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

Overview

Order information.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderCalculatedBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#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.



35
36
37
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 35

def amount
  @amount
end

#applied_discount_amount ⇒ Object

This field shows the order-level discount applied.



53
54
55
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 53

def applied_discount_amount
  @applied_discount_amount
end

#created_at ⇒ Object

Timestamp representing the date and time when the order was created in ISO 8601 format.



26
27
28
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 26

def created_at
  @created_at
end

#customer_id ⇒ Object

Unique customer ID of the customer making the purchase.



68
69
70
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 68

def customer_id
  @customer_id
end

#discount_amount ⇒ Object

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



41
42
43
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 41

def discount_amount
  @discount_amount
end

#id ⇒ Object

Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.



20
21
22
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 20

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.



38
39
40
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 38

def initial_amount
  @initial_amount
end

#items ⇒ Object

Array of items applied to the order.



62
63
64
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 62

def items
  @items
end

#items_applied_discount_amount ⇒ Object

Sum of all product-specific discounts applied in a particular request. ‘sum(items, i => i.applied_discount_amount)`



56
57
58
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 56

def items_applied_discount_amount
  @items_applied_discount_amount
end

#items_discount_amount ⇒ Object

Sum of all product-specific discounts applied to the order.



44
45
46
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 44

def items_discount_amount
  @items_discount_amount
end

#metadata ⇒ Object

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



65
66
67
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 65

def metadata
  @metadata
end

#object ⇒ Object

The type of object represented by JSON.



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

def object
  @object
end

#redemptions ⇒ Object

Returns the value of attribute redemptions.



76
77
78
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 76

def redemptions
  @redemptions
end

#referrer_id ⇒ Object

Unique referrer ID.



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

def referrer_id
  @referrer_id
end

#source_id ⇒ Object

Unique source ID of an existing order that will be linked to the redemption of this request.



23
24
25
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 23

def source_id
  @source_id
end

#status ⇒ Object

The order status.



32
33
34
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 32

def status
  @status
end

#total_amount ⇒ Object

Order amount after undoing all the discounts through the rollback redemption.



50
51
52
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 50

def total_amount
  @total_amount
end

#total_applied_discount_amount ⇒ Object

Sum of all order-level AND all product-specific discounts applied in a particular request. ‘total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`



59
60
61
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 59

def total_applied_discount_amount
  @total_applied_discount_amount
end

#total_discount_amount ⇒ Object

Sum of all order-level AND all product-specific discounts applied to the order.



47
48
49
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 47

def total_discount_amount
  @total_discount_amount
end

#updated_at ⇒ Object

Timestamp representing the date and time when the order was last updated in ISO 8601 format.



29
30
31
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 29

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



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
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 385

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



127
128
129
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 127

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 101

def self.attribute_map
  {
    :'id' => :'id',
    :'source_id' => :'source_id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'status' => :'status',
    :'amount' => :'amount',
    :'initial_amount' => :'initial_amount',
    :'discount_amount' => :'discount_amount',
    :'items_discount_amount' => :'items_discount_amount',
    :'total_discount_amount' => :'total_discount_amount',
    :'total_amount' => :'total_amount',
    :'applied_discount_amount' => :'applied_discount_amount',
    :'items_applied_discount_amount' => :'items_applied_discount_amount',
    :'total_applied_discount_amount' => :'total_applied_discount_amount',
    :'items' => :'items',
    :'metadata' => :'metadata',
    :'customer_id' => :'customer_id',
    :'referrer_id' => :'referrer_id',
    :'object' => :'object',
    :'redemptions' => :'redemptions'
  }
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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 361

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



158
159
160
161
162
163
164
165
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 158

def self.openapi_nullable
  Set.new([
    :'source_id',
    :'updated_at',
    :'customer_id',
    :'referrer_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 132

def self.openapi_types
  {
    :'id' => :'String',
    :'source_id' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'status' => :'String',
    :'amount' => :'Integer',
    :'initial_amount' => :'Integer',
    :'discount_amount' => :'Integer',
    :'items_discount_amount' => :'Integer',
    :'total_discount_amount' => :'Integer',
    :'total_amount' => :'Integer',
    :'applied_discount_amount' => :'Integer',
    :'items_applied_discount_amount' => :'Integer',
    :'total_applied_discount_amount' => :'Integer',
    :'items' => :'Array<OrderItemCalculated>',
    :'metadata' => :'Object',
    :'customer_id' => :'String',
    :'referrer_id' => :'String',
    :'object' => :'String',
    :'redemptions' => :'Hash<String, OrderRedemptions>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 321

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      source_id == o.source_id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      status == o.status &&
      amount == o.amount &&
      initial_amount == o.initial_amount &&
      discount_amount == o.discount_amount &&
      items_discount_amount == o.items_discount_amount &&
      total_discount_amount == o.total_discount_amount &&
      total_amount == o.total_amount &&
      applied_discount_amount == o.applied_discount_amount &&
      items_applied_discount_amount == o.items_applied_discount_amount &&
      total_applied_discount_amount == o.total_applied_discount_amount &&
      items == o.items &&
      metadata == o.metadata &&
      customer_id == o.customer_id &&
      referrer_id == o.referrer_id &&
      object == o.object &&
      redemptions == o.redemptions
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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 456

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


348
349
350
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 348

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



354
355
356
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 354

def hash
  [id, source_id, created_at, updated_at, status, amount, initial_amount, discount_amount, items_discount_amount, total_discount_amount, total_amount, applied_discount_amount, items_applied_discount_amount, total_applied_discount_amount, items, metadata, customer_id, referrer_id, object, redemptions].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



277
278
279
280
281
282
283
284
285
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 277

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @object.nil?
    invalid_properties.push('invalid value for "object", object 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



432
433
434
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 432

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



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

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



426
427
428
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 426

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



289
290
291
292
293
294
295
296
297
 
# File 'lib/VoucherifySdk/models/order_calculated_base.rb', line 289

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["CREATED", "PAID", "CANCELED", "FULFILLED"])
  return false unless status_validator.valid?(@status)
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["order"])
  return false unless object_validator.valid?(@object)
  true
end