Class: AmzSpApi::VendorOrdersApiModel::OrderStatus

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

Overview

Current status of a purchase order.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
96
97
98
99
100
101
102
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
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 91

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

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

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

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

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

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

Instance Attribute Details

#item_status ⇒ Object

Returns the value of attribute item_status.



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

def item_status
  @item_status
end

#last_updated_date ⇒ Object

The date when the purchase order was last updated. Must be in ISO-8601 date/time format.



27
28
29
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 27

def last_updated_date
  @last_updated_date
end

#purchase_order_date ⇒ Object

The date the purchase order was placed. Must be in ISO-8601 date/time format.



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

def purchase_order_date
  @purchase_order_date
end

#purchase_order_number ⇒ Object

The buyer’s purchase order number for this order. Formatting Notes: 8-character alpha-numeric code.



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

def purchase_order_number
  @purchase_order_number
end

#purchase_order_status ⇒ Object

The status of the buyer’s purchase order for this order.



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

def purchase_order_status
  @purchase_order_status
end

#selling_party ⇒ Object

Returns the value of attribute selling_party.



29
30
31
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 29

def selling_party
  @selling_party
end

#ship_to_party ⇒ Object

Returns the value of attribute ship_to_party.



31
32
33
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 31

def ship_to_party
  @ship_to_party
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 58

def self.attribute_map
  {
    :'purchase_order_number' => :'purchaseOrderNumber',
    :'purchase_order_status' => :'purchaseOrderStatus',
    :'purchase_order_date' => :'purchaseOrderDate',
    :'last_updated_date' => :'lastUpdatedDate',
    :'selling_party' => :'sellingParty',
    :'ship_to_party' => :'shipToParty',
    :'item_status' => :'itemStatus'
  }
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



217
218
219
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 217

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



84
85
86
87
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 84

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 71

def self.openapi_types
  {
    :'purchase_order_number' => :'Object',
    :'purchase_order_status' => :'Object',
    :'purchase_order_date' => :'Object',
    :'last_updated_date' => :'Object',
    :'selling_party' => :'Object',
    :'ship_to_party' => :'Object',
    :'item_status' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      purchase_order_number == o.purchase_order_number &&
      purchase_order_status == o.purchase_order_status &&
      purchase_order_date == o.purchase_order_date &&
      last_updated_date == o.last_updated_date &&
      selling_party == o.selling_party &&
      ship_to_party == o.ship_to_party &&
      item_status == o.item_status
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



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
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 247

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::VendorOrdersApiModel.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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 316

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 224

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


204
205
206
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



210
211
212
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 210

def hash
  [purchase_order_number, purchase_order_status, purchase_order_date, last_updated_date, selling_party, ship_to_party, item_status].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



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
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 135

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 @purchase_order_status.nil?
    invalid_properties.push('invalid value for "purchase_order_status", purchase_order_status cannot be nil.')
  end

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

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



292
293
294
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 292

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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 298

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



286
287
288
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 286

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



166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/vendor-orders-api-model/models/order_status.rb', line 166

def valid?
  return false if @purchase_order_number.nil?
  return false if @purchase_order_status.nil?
  purchase_order_status_validator = EnumAttributeValidator.new('Object', ['OPEN', 'CLOSED'])
  return false unless purchase_order_status_validator.valid?(@purchase_order_status)
  return false if @purchase_order_date.nil?
  return false if @selling_party.nil?
  return false if @ship_to_party.nil?
  return false if @item_status.nil?
  true
end