Class: AmzSpApi::VendorDirectFulfillmentOrdersApiModel::OrderDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb

Overview

Details of an order.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



103
104
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
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
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 103

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bill_to_party ⇒ Object

Returns the value of attribute bill_to_party.



36
37
38
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 36

def bill_to_party
  @bill_to_party
end

#customer_order_number ⇒ Object

The customer order number.



18
19
20
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 18

def customer_order_number
  @customer_order_number
end

#items ⇒ Object

A list of items in this purchase order.



39
40
41
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 39

def items
  @items
end

#order_date ⇒ Object

The date the order was placed. This field is expected to be in ISO-8601 date/time format, for example:2018-07-16T23:00:00Z/ 2018-07-16T23:00:00-05:00 /2018-07-16T23:00:00-08:00. If no time zone is specified, UTC should be assumed.



21
22
23
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 21

def order_date
  @order_date
end

#order_status ⇒ Object

Current status of the order.



24
25
26
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 24

def order_status
  @order_status
end

#selling_party ⇒ Object

Returns the value of attribute selling_party.



30
31
32
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 30

def selling_party
  @selling_party
end

#ship_from_party ⇒ Object

Returns the value of attribute ship_from_party.



32
33
34
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 32

def ship_from_party
  @ship_from_party
end

#ship_to_party ⇒ Object

Returns the value of attribute ship_to_party.



34
35
36
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 34

def ship_to_party
  @ship_to_party
end

#shipment_details ⇒ Object

Returns the value of attribute shipment_details.



26
27
28
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 26

def shipment_details
  @shipment_details
end

#tax_total ⇒ Object

Returns the value of attribute tax_total.



28
29
30
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 28

def tax_total
  @tax_total
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 64

def self.attribute_map
  {
    :'customer_order_number' => :'customerOrderNumber',
    :'order_date' => :'orderDate',
    :'order_status' => :'orderStatus',
    :'shipment_details' => :'shipmentDetails',
    :'tax_total' => :'taxTotal',
    :'selling_party' => :'sellingParty',
    :'ship_from_party' => :'shipFromParty',
    :'ship_to_party' => :'shipToParty',
    :'bill_to_party' => :'billToParty',
    :'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



256
257
258
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 256

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 80

def self.openapi_types
  {
    :'customer_order_number' => :'Object',
    :'order_date' => :'Object',
    :'order_status' => :'Object',
    :'shipment_details' => :'Object',
    :'tax_total' => :'Object',
    :'selling_party' => :'Object',
    :'ship_from_party' => :'Object',
    :'ship_to_party' => :'Object',
    :'bill_to_party' => :'Object',
    :'items' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 226

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customer_order_number == o.customer_order_number &&
      order_date == o.order_date &&
      order_status == o.order_status &&
      shipment_details == o.shipment_details &&
      tax_total == o.tax_total &&
      selling_party == o.selling_party &&
      ship_from_party == o.ship_from_party &&
      ship_to_party == o.ship_to_party &&
      bill_to_party == o.bill_to_party &&
      items == o.items
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



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
318
319
320
321
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 286

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
    AmzSpApi::VendorDirectFulfillmentOrdersApiModel.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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 355

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 263

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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


243
244
245
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.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/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 249

def hash
  [customer_order_number, order_date, order_status, shipment_details, tax_total, selling_party, ship_from_party, ship_to_party, bill_to_party, 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



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
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 161

def list_invalid_properties
  invalid_properties = Array.new
  if @customer_order_number.nil?
    invalid_properties.push('invalid value for "customer_order_number", customer_order_number cannot be nil.')
  end

  if @order_date.nil?
    invalid_properties.push('invalid value for "order_date", order_date cannot be nil.')
  end

  if @shipment_details.nil?
    invalid_properties.push('invalid value for "shipment_details", shipment_details cannot be nil.')
  end

  if @selling_party.nil?
    invalid_properties.push('invalid value for "selling_party", selling_party cannot be nil.')
  end

  if @ship_from_party.nil?
    invalid_properties.push('invalid value for "ship_from_party", ship_from_party cannot be nil.')
  end

  if @ship_to_party.nil?
    invalid_properties.push('invalid value for "ship_to_party", ship_to_party cannot be nil.')
  end

  if @bill_to_party.nil?
    invalid_properties.push('invalid value for "bill_to_party", bill_to_party cannot be nil.')
  end

  if @items.nil?
    invalid_properties.push('invalid value for "items", items 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



331
332
333
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 331

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 337

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



325
326
327
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 325

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



200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_details.rb', line 200

def valid?
  return false if @customer_order_number.nil?
  return false if @order_date.nil?
  order_status_validator = EnumAttributeValidator.new('Object', ['NEW', 'SHIPPED', 'ACCEPTED', 'CANCELLED'])
  return false unless order_status_validator.valid?(@order_status)
  return false if @shipment_details.nil?
  return false if @selling_party.nil?
  return false if @ship_from_party.nil?
  return false if @ship_to_party.nil?
  return false if @bill_to_party.nil?
  return false if @items.nil?
  true
end