Class: AmzSpApi::FulfillmentInboundApiModel::InboundShipmentHeader

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

Overview

Inbound shipment information used to create and update inbound shipments.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InboundShipmentHeader

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
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
107
108
 
# File 'lib/fulfillment-inbound-api-model/models/inbound_shipment_header.rb', line 68

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

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

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

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

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

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

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

Instance Attribute Details

#are_cases_required ⇒ Object

Indicates whether or not an inbound shipment contains case-packed boxes. Note: A shipment must contain either all case-packed boxes or all individually packed boxes. Possible values: true - All boxes in the shipment must be case packed. false - All boxes in the shipment must be individually packed. Note: If AreCasesRequired = true for an inbound shipment, then the value of QuantityInCase must be greater than zero for every item in the shipment. Otherwise the service returns an error.



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

def are_cases_required
  @are_cases_required
end

#destination_fulfillment_center_id ⇒ Object

The identifier for the fulfillment center to which the shipment will be shipped. Get this value from the InboundShipmentPlan object in the response returned by the createInboundShipmentPlan operation.



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

def destination_fulfillment_center_id
  @destination_fulfillment_center_id
end

#intended_box_contents_source ⇒ Object

Returns the value of attribute intended_box_contents_source.



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

def intended_box_contents_source
  @intended_box_contents_source
end

#label_prep_preference ⇒ Object

Returns the value of attribute label_prep_preference.



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

def label_prep_preference
  @label_prep_preference
end

#ship_from_address ⇒ Object

Returns the value of attribute ship_from_address.



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

def ship_from_address
  @ship_from_address
end

#shipment_name ⇒ Object

The name for the shipment. Use a naming convention that helps distinguish between shipments over time, such as the date the shipment was created.



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

def shipment_name
  @shipment_name
end

#shipment_status ⇒ Object

Returns the value of attribute shipment_status.



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

def shipment_status
  @shipment_status
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/fulfillment-inbound-api-model/models/inbound_shipment_header.rb', line 35

def self.attribute_map
  {
    :'shipment_name' => :'ShipmentName',
    :'ship_from_address' => :'ShipFromAddress',
    :'destination_fulfillment_center_id' => :'DestinationFulfillmentCenterId',
    :'are_cases_required' => :'AreCasesRequired',
    :'shipment_status' => :'ShipmentStatus',
    :'label_prep_preference' => :'LabelPrepPreference',
    :'intended_box_contents_source' => :'IntendedBoxContentsSource'
  }
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/fulfillment-inbound-api-model/models/inbound_shipment_header.rb', line 177

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
 
# File 'lib/fulfillment-inbound-api-model/models/inbound_shipment_header.rb', line 61

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/fulfillment-inbound-api-model/models/inbound_shipment_header.rb', line 48

def self.openapi_types
  {
    :'shipment_name' => :'Object',
    :'ship_from_address' => :'Object',
    :'destination_fulfillment_center_id' => :'Object',
    :'are_cases_required' => :'Object',
    :'shipment_status' => :'Object',
    :'label_prep_preference' => :'Object',
    :'intended_box_contents_source' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/fulfillment-inbound-api-model/models/inbound_shipment_header.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      shipment_name == o.shipment_name &&
      ship_from_address == o.ship_from_address &&
      destination_fulfillment_center_id == o.destination_fulfillment_center_id &&
      are_cases_required == o.are_cases_required &&
      shipment_status == o.shipment_status &&
      label_prep_preference == o.label_prep_preference &&
      intended_box_contents_source == o.intended_box_contents_source
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/fulfillment-inbound-api-model/models/inbound_shipment_header.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::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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/fulfillment-inbound-api-model/models/inbound_shipment_header.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/fulfillment-inbound-api-model/models/inbound_shipment_header.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/fulfillment-inbound-api-model/models/inbound_shipment_header.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/fulfillment-inbound-api-model/models/inbound_shipment_header.rb', line 170

def hash
  [shipment_name, ship_from_address, destination_fulfillment_center_id, are_cases_required, shipment_status, label_prep_preference, intended_box_contents_source].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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/fulfillment-inbound-api-model/models/inbound_shipment_header.rb', line 112

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

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

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

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

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



252
253
254
 
# File 'lib/fulfillment-inbound-api-model/models/inbound_shipment_header.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/fulfillment-inbound-api-model/models/inbound_shipment_header.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/fulfillment-inbound-api-model/models/inbound_shipment_header.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



139
140
141
142
143
144
145
146
 
# File 'lib/fulfillment-inbound-api-model/models/inbound_shipment_header.rb', line 139

def valid?
  return false if @shipment_name.nil?
  return false if @ship_from_address.nil?
  return false if @destination_fulfillment_center_id.nil?
  return false if @shipment_status.nil?
  return false if @label_prep_preference.nil?
  true
end