Class: VoucherifySdk::OrderCalculated

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/order_calculated.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 = {}) ⇒ OrderCalculated

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 193

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

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'order'
  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?(:'customer_id')
    self.customer_id = attributes[:'customer_id']
  end

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

This is the sum of the order items’ amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).



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

def amount
  @amount
end

#applied_discount_amount ⇒ Object

This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).



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

def applied_discount_amount
  @applied_discount_amount
end

#created_at ⇒ Object

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.



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

def created_at
  @created_at
end

#customer ⇒ Object

Returns the value of attribute customer.



73
74
75
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 73

def customer
  @customer
end

#customer_id ⇒ Object

Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.



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

def customer_id
  @customer_id
end

#discount_amount ⇒ Object

Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).



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

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.rb', line 20

def id
  @id
end

#initial_amount ⇒ Object

This is the sum of the order items’ amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).



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

def initial_amount
  @initial_amount
end

#items ⇒ Object

Array of items applied to the order. It can include up 500 items.



80
81
82
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 80

def items
  @items
end

#items_applied_discount_amount ⇒ Object

Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). ‘sum(items, i => i.applied_discount_amount)`



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

def items_applied_discount_amount
  @items_applied_discount_amount
end

#items_discount_amount ⇒ Object

Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).



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

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. It can be used to define business validation rules or discount formulas.



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

def metadata
  @metadata
end

#object ⇒ Object

The type of the object represented by JSON.



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

def object
  @object
end

#redemptions ⇒ Object

Returns the value of attribute redemptions.



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

def redemptions
  @redemptions
end

#referrer ⇒ Object

Returns the value of attribute referrer.



75
76
77
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 75

def referrer
  @referrer
end

#referrer_id ⇒ Object

Unique referrer ID.



71
72
73
 
# File 'lib/VoucherifySdk/models/order_calculated.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.rb', line 23

def source_id
  @source_id
end

#status ⇒ Object

The order status.



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

def status
  @status
end

#total_amount ⇒ Object

Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).



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

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. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). ‘total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`



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

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. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).



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

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.



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

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



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
411
412
413
414
415
416
417
418
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 381

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



133
134
135
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 133

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'source_id' => :'source_id',
    :'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',
    :'metadata' => :'metadata',
    :'object' => :'object',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'customer_id' => :'customer_id',
    :'referrer_id' => :'referrer_id',
    :'customer' => :'customer',
    :'referrer' => :'referrer',
    :'redemptions' => :'redemptions',
    :'items' => :'items'
  }
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



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 357

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 166

def self.openapi_nullable
  Set.new([
    :'id',
    :'source_id',
    :'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',
    :'metadata',
    :'object',
    :'created_at',
    :'updated_at',
    :'customer_id',
    :'referrer_id',
    :'redemptions',
    :'items'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'source_id' => :'String',
    :'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',
    :'metadata' => :'Object',
    :'object' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'customer_id' => :'String',
    :'referrer_id' => :'String',
    :'customer' => :'CustomerId',
    :'referrer' => :'ReferrerId',
    :'redemptions' => :'Hash<String, OrderRedemptionsEntry>',
    :'items' => :'Array<OrderCalculatedItem>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      source_id == o.source_id &&
      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 &&
      metadata == o.metadata &&
      object == o.object &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      customer_id == o.customer_id &&
      referrer_id == o.referrer_id &&
      customer == o.customer &&
      referrer == o.referrer &&
      redemptions == o.redemptions &&
      items == o.items
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



452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 452

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


344
345
346
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 344

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



350
351
352
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 350

def hash
  [id, source_id, 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, metadata, object, created_at, updated_at, customer_id, referrer_id, customer, referrer, redemptions, items].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



296
297
298
299
300
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 296

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



428
429
430
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 428

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



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 434

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



422
423
424
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 422

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



304
305
306
307
308
309
310
311
 
# File 'lib/VoucherifySdk/models/order_calculated.rb', line 304

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)
  object_validator = EnumAttributeValidator.new('String', ["order"])
  return false unless object_validator.valid?(@object)
  true
end