Class: AmznSpApi::FulfillmentOutboundApiModel::UpdateFulfillmentOrderRequest

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

Overview

The request body schema for the updateFulfillmentOrder operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateFulfillmentOrderRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
112
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 75

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::FulfillmentOutboundApiModel::UpdateFulfillmentOrderRequest` 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::UpdateFulfillmentOrderRequest`. 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.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.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.ship_from_country_code = attributes[:ship_from_country_code] if attributes.key?(:ship_from_country_code)

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

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

  return unless attributes.key?(:items)

  self.items = attributes[:items]
end

Instance Attribute Details

#destination_address ⇒ Object

Returns the value of attribute destination_address.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 21

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.



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

def displayable_order_comment
  @displayable_order_comment
end

#displayable_order_date ⇒ Object

Returns the value of attribute displayable_order_date.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 21

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.



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

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/update_fulfillment_order_request.rb', line 30

def feature_constraints
  @feature_constraints
end

#fulfillment_action ⇒ Object

Returns the value of attribute fulfillment_action.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 21

def fulfillment_action
  @fulfillment_action
end

#fulfillment_policy ⇒ Object

Returns the value of attribute fulfillment_policy.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 21

def fulfillment_policy
  @fulfillment_policy
end

#items ⇒ Object

Returns the value of attribute items.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 21

def items
  @items
end

#marketplace_id ⇒ Object

The marketplace the fulfillment order is placed against.



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

def marketplace_id
  @marketplace_id
end

#notification_emails ⇒ Object

Returns the value of attribute notification_emails.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 21

def notification_emails
  @notification_emails
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.



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

def ship_from_country_code
  @ship_from_country_code
end

#shipping_speed_category ⇒ Object

Returns the value of attribute shipping_speed_category.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 21

def shipping_speed_category
  @shipping_speed_category
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
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 33

def self.attribute_map
  {
    'marketplace_id': :marketplaceId,
    'displayable_order_id': :displayableOrderId,
    'displayable_order_date': :displayableOrderDate,
    'displayable_order_comment': :displayableOrderComment,
    'shipping_speed_category': :shippingSpeedCategory,
    'destination_address': :destinationAddress,
    'fulfillment_action': :fulfillmentAction,
    'fulfillment_policy': :fulfillmentPolicy,
    '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



161
162
163
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 161

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 69

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 51

def self.openapi_types
  {
    'marketplace_id': :Object,
    'displayable_order_id': :Object,
    'displayable_order_date': :Object,
    'displayable_order_comment': :Object,
    'shipping_speed_category': :Object,
    'destination_address': :Object,
    'fulfillment_action': :Object,
    'fulfillment_policy': :Object,
    'ship_from_country_code': :Object,
    'notification_emails': :Object,
    'feature_constraints': :Object,
    'items': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 128

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

  self.class == other.class &&
    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 &&
    destination_address == other.destination_address &&
    fulfillment_action == other.fulfillment_action &&
    fulfillment_policy == other.fulfillment_policy &&
    ship_from_country_code == other.ship_from_country_code &&
    notification_emails == other.notification_emails &&
    feature_constraints == other.feature_constraints &&
    items == other.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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 190

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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 259

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 168

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


148
149
150
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 148

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



154
155
156
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 154

def hash
  [marketplace_id, displayable_order_id, displayable_order_date, displayable_order_comment, shipping_speed_category, destination_address, fulfillment_action, fulfillment_policy, 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



116
117
118
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 116

def list_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



235
236
237
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 235

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 241

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



229
230
231
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 229

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



122
123
124
 
# File 'lib/fulfillment_outbound_api_model/models/update_fulfillment_order_request.rb', line 122

def valid?
  true
end