Class: VoucherifySdk::OrdersCreateRequestBody

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

Overview

Request body schema for POST ‘/orders`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrdersCreateRequestBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



131
132
133
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
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
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 131

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

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

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

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

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

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

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

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



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

def amount
  @amount
end

#customer ⇒ Object

Returns the value of attribute customer.



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

def customer
  @customer
end

#customer_id ⇒ Object

Unique customer ID of the customer making the purchase.



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

def customer_id
  @customer_id
end

#discount_amount ⇒ Object

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



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

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/orders_create_request_body.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.



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

def initial_amount
  @initial_amount
end

#items ⇒ Object

Array of items applied to the order.



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

def items
  @items
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.



51
52
53
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 51

def metadata
  @metadata
end

#referrer ⇒ Object

Returns the value of attribute referrer.



45
46
47
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 45

def referrer
  @referrer
end

#referrer_id ⇒ Object

Unique referrer ID.



48
49
50
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 48

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/orders_create_request_body.rb', line 23

def source_id
  @source_id
end

#status ⇒ Object

The order status.



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

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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 280

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



94
95
96
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'source_id' => :'source_id',
    :'status' => :'status',
    :'amount' => :'amount',
    :'discount_amount' => :'discount_amount',
    :'initial_amount' => :'initial_amount',
    :'items' => :'items',
    :'customer' => :'customer',
    :'customer_id' => :'customer_id',
    :'referrer' => :'referrer',
    :'referrer_id' => :'referrer_id',
    :'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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 256

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



123
124
125
126
127
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 123

def self.openapi_all_of
  [
  :'Order'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 99

def self.openapi_types
  {
    :'id' => :'String',
    :'source_id' => :'String',
    :'status' => :'String',
    :'amount' => :'Integer',
    :'discount_amount' => :'Integer',
    :'initial_amount' => :'Integer',
    :'items' => :'Array<OrderItem>',
    :'customer' => :'Customer',
    :'customer_id' => :'String',
    :'referrer' => :'Referrer',
    :'referrer_id' => :'String',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 224

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 &&
      discount_amount == o.discount_amount &&
      initial_amount == o.initial_amount &&
      items == o.items &&
      customer == o.customer &&
      customer_id == o.customer_id &&
      referrer == o.referrer &&
      referrer_id == o.referrer_id &&
      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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 351

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


243
244
245
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 249

def hash
  [id, source_id, status, amount, discount_amount, initial_amount, items, customer, customer_id, referrer, referrer_id, 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



197
198
199
200
201
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 197

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



327
328
329
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 327

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 333

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



321
322
323
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 321

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



205
206
207
208
209
210
 
# File 'lib/VoucherifySdk/models/orders_create_request_body.rb', line 205

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)
  true
end