Class: AmzSpApi::FulfillmentOutboundApiModel::CreateFulfillmentOrderRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb

Overview

The request body schema for the createFulfillmentOrder operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateFulfillmentOrderRequest

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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 103

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cod_settings ⇒ Object

Returns the value of attribute cod_settings.



41
42
43
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 41

def cod_settings
  @cod_settings
end

#delivery_window ⇒ Object

Returns the value of attribute delivery_window.



33
34
35
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 33

def delivery_window
  @delivery_window
end

#destination_address ⇒ Object

Returns the value of attribute destination_address.



35
36
37
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 35

def destination_address
  @destination_address
end

#displayable_order_comment ⇒ Object

Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.



29
30
31
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 29

def displayable_order_comment
  @displayable_order_comment
end

#displayable_order_date ⇒ Object

Returns the value of attribute displayable_order_date.



26
27
28
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 26

def displayable_order_date
  @displayable_order_date
end

#displayable_order_id ⇒ Object

A fulfillment order identifier that the seller creates. This value displays as the order identifier in recipient-facing materials such as the outbound shipment packing slip. The value of DisplayableOrderId should match the order identifier that the seller provides to the recipient. The seller can use the SellerFulfillmentOrderId for this value or they can specify an alternate value if they want the recipient to reference an alternate order identifier. The value must be an alpha-numeric or ISO 8859-1 compliant string from one to 40 characters in length. Cannot contain two spaces in a row. Leading and trailing white space is removed.



24
25
26
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 24

def displayable_order_id
  @displayable_order_id
end

#feature_constraints ⇒ Object

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



49
50
51
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 49

def feature_constraints
  @feature_constraints
end

#fulfillment_action ⇒ Object

Returns the value of attribute fulfillment_action.



37
38
39
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 37

def fulfillment_action
  @fulfillment_action
end

#fulfillment_policy ⇒ Object

Returns the value of attribute fulfillment_policy.



39
40
41
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 39

def fulfillment_policy
  @fulfillment_policy
end

#items ⇒ Object

Returns the value of attribute items.



51
52
53
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 51

def items
  @items
end

#marketplace_id ⇒ Object

The marketplace the fulfillment order is placed against.



18
19
20
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 18

def marketplace_id
  @marketplace_id
end

#notification_emails ⇒ Object

Returns the value of attribute notification_emails.



46
47
48
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 46

def notification_emails
  @notification_emails
end

#seller_fulfillment_order_id ⇒ Object

A fulfillment order identifier that the seller creates to track their fulfillment order. The SellerFulfillmentOrderId must be unique for each fulfillment order that a seller creates. If the seller’s system already creates unique order identifiers, then these might be good values for them to use.



21
22
23
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 21

def seller_fulfillment_order_id
  @seller_fulfillment_order_id
end

#ship_from_country_code ⇒ Object

The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format.



44
45
46
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 44

def ship_from_country_code
  @ship_from_country_code
end

#shipping_speed_category ⇒ Object

Returns the value of attribute shipping_speed_category.



31
32
33
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 31

def shipping_speed_category
  @shipping_speed_category
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 54

def self.attribute_map
  {
    :'marketplace_id' => :'marketplaceId',
    :'seller_fulfillment_order_id' => :'sellerFulfillmentOrderId',
    :'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',
    :'ship_from_country_code' => :'shipFromCountryCode',
    :'notification_emails' => :'notificationEmails',
    :'feature_constraints' => :'featureConstraints',
    :'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



264
265
266
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 264

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/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 75

def self.openapi_types
  {
    :'marketplace_id' => :'Object',
    :'seller_fulfillment_order_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',
    :'ship_from_country_code' => :'Object',
    :'notification_emails' => :'Object',
    :'feature_constraints' => :'Object',
    :'items' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      marketplace_id == o.marketplace_id &&
      seller_fulfillment_order_id == o.seller_fulfillment_order_id &&
      displayable_order_id == o.displayable_order_id &&
      displayable_order_date == o.displayable_order_date &&
      displayable_order_comment == o.displayable_order_comment &&
      shipping_speed_category == o.shipping_speed_category &&
      delivery_window == o.delivery_window &&
      destination_address == o.destination_address &&
      fulfillment_action == o.fulfillment_action &&
      fulfillment_policy == o.fulfillment_policy &&
      cod_settings == o.cod_settings &&
      ship_from_country_code == o.ship_from_country_code &&
      notification_emails == o.notification_emails &&
      feature_constraints == o.feature_constraints &&
      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



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
322
323
324
325
326
327
328
329
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 294

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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 363

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 271

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


251
252
253
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 257

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 181

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

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

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

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

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

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



339
340
341
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 345

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



333
334
335
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 333

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



216
217
218
219
220
221
222
223
224
225
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_request.rb', line 216

def valid?
  return false if @seller_fulfillment_order_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 @items.nil?
  true
end