Class: AmznSpApi::MerchantFulfillmentApiModel::ShipmentRequestDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/merchant_fulfillment_api_model/models/shipment_request_details.rb

Overview

Shipment information required for requesting shipping service offers or for creating a shipment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShipmentRequestDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 56

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:label_customization)

  self.label_customization = attributes[:label_customization]
end

Instance Attribute Details

#amazon_order_id ⇒ Object

Returns the value of attribute amazon_order_id.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 15

def amazon_order_id
  @amazon_order_id
end

#item_list ⇒ Object

Returns the value of attribute item_list.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 15

def item_list
  @item_list
end

#label_customization ⇒ Object

Returns the value of attribute label_customization.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 15

def label_customization
  @label_customization
end

#must_arrive_by_date ⇒ Object

Returns the value of attribute must_arrive_by_date.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 15

def must_arrive_by_date
  @must_arrive_by_date
end

#package_dimensions ⇒ Object

Returns the value of attribute package_dimensions.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 15

def package_dimensions
  @package_dimensions
end

#seller_order_id ⇒ Object

Returns the value of attribute seller_order_id.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 15

def seller_order_id
  @seller_order_id
end

#ship_date ⇒ Object

Returns the value of attribute ship_date.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 15

def ship_date
  @ship_date
end

#ship_from_address ⇒ Object

Returns the value of attribute ship_from_address.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 15

def ship_from_address
  @ship_from_address
end

#shipping_service_options ⇒ Object

Returns the value of attribute shipping_service_options.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 15

def shipping_service_options
  @shipping_service_options
end

#weight ⇒ Object

Returns the value of attribute weight.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 15

def weight
  @weight
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 18

def self.attribute_map
  {
    'amazon_order_id': :AmazonOrderId,
    'seller_order_id': :SellerOrderId,
    'item_list': :ItemList,
    'ship_from_address': :ShipFromAddress,
    'package_dimensions': :PackageDimensions,
    'weight': :Weight,
    'must_arrive_by_date': :MustArriveByDate,
    'ship_date': :ShipDate,
    'shipping_service_options': :ShippingServiceOptions,
    'label_customization': :LabelCustomization
  }
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



154
155
156
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 154

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



50
51
52
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 50

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

.openapi_types ⇒ Object

Attribute type mapping.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 34

def self.openapi_types
  {
    'amazon_order_id': :Object,
    'seller_order_id': :Object,
    'item_list': :Object,
    'ship_from_address': :Object,
    'package_dimensions': :Object,
    'weight': :Object,
    'must_arrive_by_date': :Object,
    'ship_date': :Object,
    'shipping_service_options': :Object,
    'label_customization': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 123

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

  self.class == other.class &&
    amazon_order_id == other.amazon_order_id &&
    seller_order_id == other.seller_order_id &&
    item_list == other.item_list &&
    ship_from_address == other.ship_from_address &&
    package_dimensions == other.package_dimensions &&
    weight == other.weight &&
    must_arrive_by_date == other.must_arrive_by_date &&
    ship_date == other.ship_date &&
    shipping_service_options == other.shipping_service_options &&
    label_customization == other.label_customization
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



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
213
214
215
216
217
218
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 183

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 252

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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 161

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


141
142
143
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 141

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



147
148
149
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 147

def hash
  [amazon_order_id, seller_order_id, item_list, ship_from_address, package_dimensions, weight, must_arrive_by_date, ship_date, shipping_service_options, label_customization].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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 91

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

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

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

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

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

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



228
229
230
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 228

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 234

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



222
223
224
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 222

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



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/merchant_fulfillment_api_model/models/shipment_request_details.rb', line 110

def valid?
  return false if @amazon_order_id.nil?
  return false if @item_list.nil?
  return false if @ship_from_address.nil?
  return false if @package_dimensions.nil?
  return false if @weight.nil?
  return false if @shipping_service_options.nil?

  true
end