Class: AmzSpApi::FulfillmentInboundApiModel::PartneredLtlDataOutput

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb

Overview

Information returned by Amazon about a Less Than Truckload/Full Truckload (LTL/FTL) shipment by an Amazon-partnered carrier.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PartneredLtlDataOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 100

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amazon_calculated_value ⇒ Object

Returns the value of attribute amazon_calculated_value.



31
32
33
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 31

def amazon_calculated_value
  @amazon_calculated_value
end

#amazon_reference_id ⇒ Object

A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment.



40
41
42
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 40

def amazon_reference_id
  @amazon_reference_id
end

#box_count ⇒ Object

Returns the value of attribute box_count.



19
20
21
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 19

def box_count
  @box_count
end

#carrier_name ⇒ Object

The carrier for the inbound shipment.



48
49
50
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 48

def carrier_name
  @carrier_name
end

#contact ⇒ Object

Returns the value of attribute contact.



17
18
19
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 17

def contact
  @contact
end

#freight_ready_date ⇒ Object

Returns the value of attribute freight_ready_date.



23
24
25
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 23

def freight_ready_date
  @freight_ready_date
end

#is_bill_of_lading_available ⇒ Object

Indicates whether the bill of lading for the shipment is available.



43
44
45
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 43

def is_bill_of_lading_available
  @is_bill_of_lading_available
end

#pallet_list ⇒ Object

Returns the value of attribute pallet_list.



25
26
27
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 25

def pallet_list
  @pallet_list
end

#partnered_estimate ⇒ Object

Returns the value of attribute partnered_estimate.



45
46
47
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 45

def partnered_estimate
  @partnered_estimate
end

#preview_delivery_date ⇒ Object

Returns the value of attribute preview_delivery_date.



35
36
37
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 35

def preview_delivery_date
  @preview_delivery_date
end

#preview_freight_class ⇒ Object

Returns the value of attribute preview_freight_class.



37
38
39
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 37

def preview_freight_class
  @preview_freight_class
end

#preview_pickup_date ⇒ Object

Returns the value of attribute preview_pickup_date.



33
34
35
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 33

def preview_pickup_date
  @preview_pickup_date
end

#seller_declared_value ⇒ Object

Returns the value of attribute seller_declared_value.



29
30
31
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 29

def seller_declared_value
  @seller_declared_value
end

#seller_freight_class ⇒ Object

Returns the value of attribute seller_freight_class.



21
22
23
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 21

def seller_freight_class
  @seller_freight_class
end

#total_weight ⇒ Object

Returns the value of attribute total_weight.



27
28
29
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 27

def total_weight
  @total_weight
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
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 51

def self.attribute_map
  {
    :'contact' => :'Contact',
    :'box_count' => :'BoxCount',
    :'seller_freight_class' => :'SellerFreightClass',
    :'freight_ready_date' => :'FreightReadyDate',
    :'pallet_list' => :'PalletList',
    :'total_weight' => :'TotalWeight',
    :'seller_declared_value' => :'SellerDeclaredValue',
    :'amazon_calculated_value' => :'AmazonCalculatedValue',
    :'preview_pickup_date' => :'PreviewPickupDate',
    :'preview_delivery_date' => :'PreviewDeliveryDate',
    :'preview_freight_class' => :'PreviewFreightClass',
    :'amazon_reference_id' => :'AmazonReferenceId',
    :'is_bill_of_lading_available' => :'IsBillOfLadingAvailable',
    :'partnered_estimate' => :'PartneredEstimate',
    :'carrier_name' => :'CarrierName'
  }
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



279
280
281
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 279

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 72

def self.openapi_types
  {
    :'contact' => :'Object',
    :'box_count' => :'Object',
    :'seller_freight_class' => :'Object',
    :'freight_ready_date' => :'Object',
    :'pallet_list' => :'Object',
    :'total_weight' => :'Object',
    :'seller_declared_value' => :'Object',
    :'amazon_calculated_value' => :'Object',
    :'preview_pickup_date' => :'Object',
    :'preview_delivery_date' => :'Object',
    :'preview_freight_class' => :'Object',
    :'amazon_reference_id' => :'Object',
    :'is_bill_of_lading_available' => :'Object',
    :'partnered_estimate' => :'Object',
    :'carrier_name' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      contact == o.contact &&
      box_count == o.box_count &&
      seller_freight_class == o.seller_freight_class &&
      freight_ready_date == o.freight_ready_date &&
      pallet_list == o.pallet_list &&
      total_weight == o.total_weight &&
      seller_declared_value == o.seller_declared_value &&
      amazon_calculated_value == o.amazon_calculated_value &&
      preview_pickup_date == o.preview_pickup_date &&
      preview_delivery_date == o.preview_delivery_date &&
      preview_freight_class == o.preview_freight_class &&
      amazon_reference_id == o.amazon_reference_id &&
      is_bill_of_lading_available == o.is_bill_of_lading_available &&
      partnered_estimate == o.partnered_estimate &&
      carrier_name == o.carrier_name
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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 309

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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 378

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 286

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


266
267
268
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 272

def hash
  [contact, box_count, seller_freight_class, freight_ready_date, pallet_list, total_weight, seller_declared_value, amazon_calculated_value, preview_pickup_date, preview_delivery_date, preview_freight_class, amazon_reference_id, is_bill_of_lading_available, partnered_estimate, carrier_name].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



176
177
178
179
180
181
182
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
219
220
221
222
223
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 176

def list_invalid_properties
  invalid_properties = Array.new
  if @contact.nil?
    invalid_properties.push('invalid value for "contact", contact cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

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

  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



354
355
356
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 354

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 360

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



348
349
350
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 348

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/fulfillment-inbound-api-model/models/partnered_ltl_data_output.rb', line 227

def valid?
  return false if @contact.nil?
  return false if @box_count.nil?
  return false if @freight_ready_date.nil?
  return false if @pallet_list.nil?
  return false if @total_weight.nil?
  return false if @preview_pickup_date.nil?
  return false if @preview_delivery_date.nil?
  return false if @preview_freight_class.nil?
  return false if @amazon_reference_id.nil?
  return false if @is_bill_of_lading_available.nil?
  return false if @carrier_name.nil?
  true
end