Class: AmzSpApi::VendorShipmentsApiModel::ImportDetails

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

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



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

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

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

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

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

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

Instance Attribute Details

#billable_weight ⇒ Object

Returns the value of attribute billable_weight.



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

def billable_weight
  @billable_weight
end

#estimated_ship_by_date ⇒ Object

Date on which the shipment is expected to be shipped. This value should not be in the past and not more than 60 days out in the future.



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

def estimated_ship_by_date
  @estimated_ship_by_date
end

#import_containers ⇒ Object

Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if shipment has multiple containers.



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

def import_containers
  @import_containers
end

#method_of_payment ⇒ Object

This is used for import purchase orders only. If the recipient requests, this field will contain the shipment method of payment.



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

def method_of_payment
  @method_of_payment
end

#route ⇒ Object

Returns the value of attribute route.



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

def route
  @route
end

#seal_number ⇒ Object

The container’s seal number.



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

def seal_number
  @seal_number
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
64
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 55

def self.attribute_map
  {
    :'method_of_payment' => :'methodOfPayment',
    :'seal_number' => :'sealNumber',
    :'route' => :'route',
    :'import_containers' => :'importContainers',
    :'billable_weight' => :'billableWeight',
    :'estimated_ship_by_date' => :'estimatedShipByDate'
  }
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



177
178
179
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 177

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 79

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'method_of_payment' => :'Object',
    :'seal_number' => :'Object',
    :'route' => :'Object',
    :'import_containers' => :'Object',
    :'billable_weight' => :'Object',
    :'estimated_ship_by_date' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      method_of_payment == o.method_of_payment &&
      seal_number == o.seal_number &&
      route == o.route &&
      import_containers == o.import_containers &&
      billable_weight == o.billable_weight &&
      estimated_ship_by_date == o.estimated_ship_by_date
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



207
208
209
210
211
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
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 207

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 276

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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 184

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


164
165
166
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [method_of_payment, seal_number, route, import_containers, billable_weight, estimated_ship_by_date].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



126
127
128
129
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 126

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



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

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 258

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



246
247
248
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 246

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



133
134
135
136
137
 
# File 'lib/vendor-shipments-api-model/models/import_details.rb', line 133

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)
  true
end