Class: AmzSpApi::VendorDirectFulfillmentOrdersApiModel::OrderAcknowledgementItem

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

Overview

Details of an individual order being acknowledged.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderAcknowledgementItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 69

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

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

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

  if attributes.key?(:'acknowledgement_status')
    self.acknowledgement_status = attributes[:'acknowledgement_status']
  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?(:'item_acknowledgements')
    if (value = attributes[:'item_acknowledgements']).is_a?(Array)
      self.item_acknowledgements = value
    end
  end
end

Instance Attribute Details

#acknowledgement_date ⇒ Object

The date and time when the order is acknowledged, 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.



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

def acknowledgement_date
  @acknowledgement_date
end

#acknowledgement_status ⇒ Object

Returns the value of attribute acknowledgement_status.



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

def acknowledgement_status
  @acknowledgement_status
end

#item_acknowledgements ⇒ Object

Item details including acknowledged quantity.



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

def item_acknowledgements
  @item_acknowledgements
end

#purchase_order_number ⇒ Object

The purchase order number for this order. Formatting Notes: alpha-numeric code.



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

def purchase_order_number
  @purchase_order_number
end

#selling_party ⇒ Object

Returns the value of attribute selling_party.



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

def selling_party
  @selling_party
end

#ship_from_party ⇒ Object

Returns the value of attribute ship_from_party.



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

def ship_from_party
  @ship_from_party
end

#vendor_order_number ⇒ Object

The vendor’s order number for this order.



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

def vendor_order_number
  @vendor_order_number
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 36

def self.attribute_map
  {
    :'purchase_order_number' => :'purchaseOrderNumber',
    :'vendor_order_number' => :'vendorOrderNumber',
    :'acknowledgement_date' => :'acknowledgementDate',
    :'acknowledgement_status' => :'acknowledgementStatus',
    :'selling_party' => :'sellingParty',
    :'ship_from_party' => :'shipFromParty',
    :'item_acknowledgements' => :'itemAcknowledgements'
  }
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



190
191
192
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 190

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 49

def self.openapi_types
  {
    :'purchase_order_number' => :'Object',
    :'vendor_order_number' => :'Object',
    :'acknowledgement_date' => :'Object',
    :'acknowledgement_status' => :'Object',
    :'selling_party' => :'Object',
    :'ship_from_party' => :'Object',
    :'item_acknowledgements' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      purchase_order_number == o.purchase_order_number &&
      vendor_order_number == o.vendor_order_number &&
      acknowledgement_date == o.acknowledgement_date &&
      acknowledgement_status == o.acknowledgement_status &&
      selling_party == o.selling_party &&
      ship_from_party == o.ship_from_party &&
      item_acknowledgements == o.item_acknowledgements
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



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

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 289

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



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

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


177
178
179
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



183
184
185
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 183

def hash
  [purchase_order_number, vendor_order_number, acknowledgement_date, acknowledgement_status, selling_party, ship_from_party, item_acknowledgements].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



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

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

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

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

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



265
266
267
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 265

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 271

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



259
260
261
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 259

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



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_acknowledgement_item.rb', line 150

def valid?
  return false if @purchase_order_number.nil?
  return false if @vendor_order_number.nil?
  return false if @acknowledgement_date.nil?
  return false if @acknowledgement_status.nil?
  return false if @selling_party.nil?
  return false if @ship_from_party.nil?
  return false if @item_acknowledgements.nil?
  true
end