Class: AmzSpApi::VendorShipmentsApiModel::TransportationDetails

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransportationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

Instance Attribute Details

#bill_of_lading_number ⇒ Object

Bill Of Lading (BOL) number is the unique number assigned by the vendor. The BOL present in the Shipment Confirmation message ideally matches the paper BOL provided with the shipment, but that is no must. Instead of BOL, an alternative reference number (like Delivery Note Number) for the shipment can also be sent in this field.



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

def bill_of_lading_number
  @bill_of_lading_number
end

#carrier_scac ⇒ Object

Code that identifies the carrier for the shipment. The Standard Carrier Alpha Code (SCAC) is a unique two to four letter code used to identify a carrier. Carrier SCAC codes are assigned and maintained by the NMFTA (National Motor Freight Association). This field is mandatory for US, CA, MX shipment confirmations.



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

def carrier_scac
  @carrier_scac
end

#carrier_shipment_reference_number ⇒ Object

The field also known as PRO number is a unique number assigned by the carrier. It is used to identify and track the shipment that goes out for delivery. This field is mandatory for UA, CA, MX shipment confirmations.



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

def carrier_shipment_reference_number
  @carrier_shipment_reference_number
end

#transportation_mode ⇒ Object

The mode of transportation for this shipment.



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

def transportation_mode
  @transportation_mode
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 51

def self.attribute_map
  {
    :'carrier_scac' => :'carrierScac',
    :'carrier_shipment_reference_number' => :'carrierShipmentReferenceNumber',
    :'transportation_mode' => :'transportationMode',
    :'bill_of_lading_number' => :'billOfLadingNumber'
  }
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



159
160
161
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 159

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 61

def self.openapi_types
  {
    :'carrier_scac' => :'Object',
    :'carrier_shipment_reference_number' => :'Object',
    :'transportation_mode' => :'Object',
    :'bill_of_lading_number' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



135
136
137
138
139
140
141
142
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 135

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      carrier_scac == o.carrier_scac &&
      carrier_shipment_reference_number == o.carrier_shipment_reference_number &&
      transportation_mode == o.transportation_mode &&
      bill_of_lading_number == o.bill_of_lading_number
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



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
219
220
221
222
223
224
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 189

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



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

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 166

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


146
147
148
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 146

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



152
153
154
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 152

def hash
  [carrier_scac, carrier_shipment_reference_number, transportation_mode, bill_of_lading_number].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



110
111
112
113
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 110

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



234
235
236
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 234

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



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 240

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



228
229
230
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 228

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



117
118
119
120
121
 
# File 'lib/vendor-shipments-api-model/models/transportation_details.rb', line 117

def valid?
  transportation_mode_validator = EnumAttributeValidator.new('Object', ['Road', 'Air', 'Ocean'])
  return false unless transportation_mode_validator.valid?(@transportation_mode)
  true
end