Class: AmznSpApi::FulfillmentOutboundApiModel::FulfillmentOrder

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_outbound_api_model/models/fulfillment_order.rb

Overview

General information about a fulfillment order, including its status.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FulfillmentOrder

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 83

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::FulfillmentOutboundApiModel::FulfillmentOrder` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::FulfillmentOutboundApiModel::FulfillmentOrder`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.seller_fulfillment_order_id = attributes[:seller_fulfillment_order_id] if attributes.key?(:seller_fulfillment_order_id)

  self.marketplace_id = attributes[:marketplace_id] if attributes.key?(:marketplace_id)

  self.displayable_order_id = attributes[:displayable_order_id] if attributes.key?(:displayable_order_id)

  self.displayable_order_date = attributes[:displayable_order_date] if attributes.key?(:displayable_order_date)

  self.displayable_order_comment = attributes[:displayable_order_comment] if attributes.key?(:displayable_order_comment)

  self.shipping_speed_category = attributes[:shipping_speed_category] if attributes.key?(:shipping_speed_category)

  self.delivery_window = attributes[:delivery_window] if attributes.key?(:delivery_window)

  self.destination_address = attributes[:destination_address] if attributes.key?(:destination_address)

  self.fulfillment_action = attributes[:fulfillment_action] if attributes.key?(:fulfillment_action)

  self.fulfillment_policy = attributes[:fulfillment_policy] if attributes.key?(:fulfillment_policy)

  self.cod_settings = attributes[:cod_settings] if attributes.key?(:cod_settings)

  self.received_date = attributes[:received_date] if attributes.key?(:received_date)

  self.fulfillment_order_status = attributes[:fulfillment_order_status] if attributes.key?(:fulfillment_order_status)

  self.status_updated_date = attributes[:status_updated_date] if attributes.key?(:status_updated_date)

  self.notification_emails = attributes[:notification_emails] if attributes.key?(:notification_emails)

  return unless attributes.key?(:feature_constraints)
  return unless (value = attributes[:feature_constraints]).is_a?(Array)

  self.feature_constraints = value
end

Instance Attribute Details

#cod_settings ⇒ Object

Returns the value of attribute cod_settings.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 24

def cod_settings
  @cod_settings
end

#delivery_window ⇒ Object

Returns the value of attribute delivery_window.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 24

def delivery_window
  @delivery_window
end

#destination_address ⇒ Object

Returns the value of attribute destination_address.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 24

def destination_address
  @destination_address
end

#displayable_order_comment ⇒ Object

A text block submitted with the createFulfillmentOrder operation. Displays in recipient-facing materials such as the packing slip.



27
28
29
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 27

def displayable_order_comment
  @displayable_order_comment
end

#displayable_order_date ⇒ Object

Returns the value of attribute displayable_order_date.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 24

def displayable_order_date
  @displayable_order_date
end

#displayable_order_id ⇒ Object

A fulfillment order identifier submitted with the createFulfillmentOrder operation. Displays as the order identifier in recipient-facing materials such as the packing slip.



22
23
24
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 22

def displayable_order_id
  @displayable_order_id
end

#feature_constraints ⇒ Object

A list of features and their fulfillment policies to apply to the order.



30
31
32
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 30

def feature_constraints
  @feature_constraints
end

#fulfillment_action ⇒ Object

Returns the value of attribute fulfillment_action.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 24

def fulfillment_action
  @fulfillment_action
end

#fulfillment_order_status ⇒ Object

Returns the value of attribute fulfillment_order_status.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 24

def fulfillment_order_status
  @fulfillment_order_status
end

#fulfillment_policy ⇒ Object

Returns the value of attribute fulfillment_policy.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 24

def fulfillment_policy
  @fulfillment_policy
end

#marketplace_id ⇒ Object

The identifier for the marketplace the fulfillment order is placed against.



19
20
21
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 19

def marketplace_id
  @marketplace_id
end

#notification_emails ⇒ Object

Returns the value of attribute notification_emails.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 24

def notification_emails
  @notification_emails
end

#received_date ⇒ Object

Returns the value of attribute received_date.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 24

def received_date
  @received_date
end

#seller_fulfillment_order_id ⇒ Object

The fulfillment order identifier submitted with the createFulfillmentOrder operation.



16
17
18
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 16

def seller_fulfillment_order_id
  @seller_fulfillment_order_id
end

#shipping_speed_category ⇒ Object

Returns the value of attribute shipping_speed_category.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 24

def shipping_speed_category
  @shipping_speed_category
end

#status_updated_date ⇒ Object

Returns the value of attribute status_updated_date.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 24

def status_updated_date
  @status_updated_date
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 33

def self.attribute_map
  {
    'seller_fulfillment_order_id': :sellerFulfillmentOrderId,
    'marketplace_id': :marketplaceId,
    'displayable_order_id': :displayableOrderId,
    'displayable_order_date': :displayableOrderDate,
    'displayable_order_comment': :displayableOrderComment,
    'shipping_speed_category': :shippingSpeedCategory,
    'delivery_window': :deliveryWindow,
    'destination_address': :destinationAddress,
    'fulfillment_action': :fulfillmentAction,
    'fulfillment_policy': :fulfillmentPolicy,
    'cod_settings': :codSettings,
    'received_date': :receivedDate,
    'fulfillment_order_status': :fulfillmentOrderStatus,
    'status_updated_date': :statusUpdatedDate,
    'notification_emails': :notificationEmails,
    'feature_constraints': :featureConstraints
  }
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



212
213
214
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 212

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 55

def self.openapi_types
  {
    'seller_fulfillment_order_id': :Object,
    'marketplace_id': :Object,
    'displayable_order_id': :Object,
    'displayable_order_date': :Object,
    'displayable_order_comment': :Object,
    'shipping_speed_category': :Object,
    'delivery_window': :Object,
    'destination_address': :Object,
    'fulfillment_action': :Object,
    'fulfillment_policy': :Object,
    'cod_settings': :Object,
    'received_date': :Object,
    'fulfillment_order_status': :Object,
    'status_updated_date': :Object,
    'notification_emails': :Object,
    'feature_constraints': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 175

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    seller_fulfillment_order_id == other.seller_fulfillment_order_id &&
    marketplace_id == other.marketplace_id &&
    displayable_order_id == other.displayable_order_id &&
    displayable_order_date == other.displayable_order_date &&
    displayable_order_comment == other.displayable_order_comment &&
    shipping_speed_category == other.shipping_speed_category &&
    delivery_window == other.delivery_window &&
    destination_address == other.destination_address &&
    fulfillment_action == other.fulfillment_action &&
    fulfillment_policy == other.fulfillment_policy &&
    cod_settings == other.cod_settings &&
    received_date == other.received_date &&
    fulfillment_order_status == other.fulfillment_order_status &&
    status_updated_date == other.status_updated_date &&
    notification_emails == other.notification_emails &&
    feature_constraints == other.feature_constraints
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



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
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 241

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
    AmznSpApi::FulfillmentOutboundApiModel.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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 310

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 219

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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


199
200
201
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 199

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 205

def hash
  [seller_fulfillment_order_id, marketplace_id, displayable_order_id, displayable_order_date, displayable_order_comment, shipping_speed_category, delivery_window, destination_address, fulfillment_action, fulfillment_policy, cod_settings, received_date, fulfillment_order_status, status_updated_date, notification_emails, feature_constraints].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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 131

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "seller_fulfillment_order_id", seller_fulfillment_order_id cannot be nil.') if @seller_fulfillment_order_id.nil?

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

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

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

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

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

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

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

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

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

  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



286
287
288
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 286

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 292

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



280
281
282
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 280

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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order.rb', line 158

def valid?
  return false if @seller_fulfillment_order_id.nil?
  return false if @marketplace_id.nil?
  return false if @displayable_order_id.nil?
  return false if @displayable_order_date.nil?
  return false if @displayable_order_comment.nil?
  return false if @shipping_speed_category.nil?
  return false if @destination_address.nil?
  return false if @received_date.nil?
  return false if @fulfillment_order_status.nil?
  return false if @status_updated_date.nil?

  true
end