Class: AmzSpApi::FulfillmentInboundApiModel::TransportHeader

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

Overview

The shipping identifier, information about whether the shipment is by an Amazon-partnered carrier, and information about whether the shipment is Small Parcel or Less Than Truckload/Full Truckload (LTL/FTL).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransportHeader

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 56

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

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

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

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

Instance Attribute Details

#is_partnered ⇒ Object

Indicates whether a putTransportDetails request is for a partnered carrier. Possible values: * true – Request is for an Amazon-partnered carrier. * false – Request is for a non-Amazon-partnered carrier.



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

def is_partnered
  @is_partnered
end

#seller_id ⇒ Object

The Amazon seller identifier.



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

def seller_id
  @seller_id
end

#shipment_id ⇒ Object

A shipment identifier originally returned by the createInboundShipmentPlan operation.



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

def shipment_id
  @shipment_id
end

#shipment_type ⇒ Object

Returns the value of attribute shipment_type.



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

def shipment_type
  @shipment_type
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 29

def self.attribute_map
  {
    :'seller_id' => :'SellerId',
    :'shipment_id' => :'ShipmentId',
    :'is_partnered' => :'IsPartnered',
    :'shipment_type' => :'ShipmentType'
  }
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



145
146
147
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 145

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



49
50
51
52
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 49

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

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 39

def self.openapi_types
  {
    :'seller_id' => :'Object',
    :'shipment_id' => :'Object',
    :'is_partnered' => :'Object',
    :'shipment_type' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



121
122
123
124
125
126
127
128
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 121

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      seller_id == o.seller_id &&
      shipment_id == o.shipment_id &&
      is_partnered == o.is_partnered &&
      shipment_type == o.shipment_type
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



175
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
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 175

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



244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 244

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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 152

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


132
133
134
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 132

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



138
139
140
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 138

def hash
  [seller_id, shipment_id, is_partnered, shipment_type].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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 88

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

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

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

  if @shipment_type.nil?
    invalid_properties.push('invalid value for "shipment_type", shipment_type 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



220
221
222
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 220

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



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

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



214
215
216
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 214

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



111
112
113
114
115
116
117
 
# File 'lib/fulfillment-inbound-api-model/models/transport_header.rb', line 111

def valid?
  return false if @seller_id.nil?
  return false if @shipment_id.nil?
  return false if @is_partnered.nil?
  return false if @shipment_type.nil?
  true
end