Class: AmzSpApi::VendorOrdersApiModel::ImportDetails

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

Overview

Import details for an import order.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImportDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

Instance Attribute Details

#import_containers ⇒ Object

Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: $NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE. The list of values for the container type is: 40’(40-foot container), 40’HC (40-foot high-capacity container), 45’, 45’HC, 30’, 30’HC, 20’, 20’HC.



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

def import_containers
  @import_containers
end

#international_commercial_terms ⇒ Object

Incoterms (International Commercial Terms) are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices. This is for import purchase orders only.



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

def international_commercial_terms
  @international_commercial_terms
end

#method_of_payment ⇒ Object

If the recipient requests, contains the shipment method of payment. This is for import PO’s only.



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

def method_of_payment
  @method_of_payment
end

#port_of_delivery ⇒ Object

The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the internationalCommercialTerms is FOB.



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

def port_of_delivery
  @port_of_delivery
end

#shipping_instructions ⇒ Object

Special instructions regarding the shipment. This field is for import purchase orders.



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

def shipping_instructions
  @shipping_instructions
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 55

def self.attribute_map
  {
    :'method_of_payment' => :'methodOfPayment',
    :'international_commercial_terms' => :'internationalCommercialTerms',
    :'port_of_delivery' => :'portOfDelivery',
    :'import_containers' => :'importContainers',
    :'shipping_instructions' => :'shippingInstructions'
  }
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



182
183
184
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 182

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 66

def self.openapi_types
  {
    :'method_of_payment' => :'Object',
    :'international_commercial_terms' => :'Object',
    :'port_of_delivery' => :'Object',
    :'import_containers' => :'Object',
    :'shipping_instructions' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
164
165
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      method_of_payment == o.method_of_payment &&
      international_commercial_terms == o.international_commercial_terms &&
      port_of_delivery == o.port_of_delivery &&
      import_containers == o.import_containers &&
      shipping_instructions == o.shipping_instructions
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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 212

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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 281

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 189

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


169
170
171
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 169

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



175
176
177
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 175

def hash
  [method_of_payment, international_commercial_terms, port_of_delivery, import_containers, shipping_instructions].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



120
121
122
123
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  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



257
258
259
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 257

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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 263

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



251
252
253
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 251

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



127
128
129
130
131
132
133
 
# File 'lib/vendor-orders-api-model/models/import_details.rb', line 127

def valid?
  method_of_payment_validator = EnumAttributeValidator.new('Object', ['PaidByBuyer', 'CollectOnDelivery', 'DefinedByBuyerAndSeller', 'FOBPortOfCall', 'PrepaidBySeller', 'PaidBySeller'])
  return false unless method_of_payment_validator.valid?(@method_of_payment)
  international_commercial_terms_validator = EnumAttributeValidator.new('Object', ['ExWorks', 'FreeCarrier', 'FreeOnBoard', 'FreeAlongSideShip', 'CarriagePaidTo', 'CostAndFreight', 'CarriageAndInsurancePaidTo', 'CostInsuranceAndFreight', 'DeliveredAtTerminal', 'DeliveredAtPlace', 'DeliverDutyPaid'])
  return false unless international_commercial_terms_validator.valid?(@international_commercial_terms)
  true
end