Class: AmznSpApi::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

Raises:

  • (ArgumentError) 


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/inbound_shipment_header.rb', line 59

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::FulfillmentInboundApiModel::InboundShipmentHeader` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::FulfillmentInboundApiModel::InboundShipmentHeader`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.shipment_name = attributes[:shipment_name] if attributes.key?(:shipment_name)

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

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

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

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

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

  return unless attributes.key?(:intended_box_contents_source)

  self.intended_box_contents_source = attributes[:intended_box_contents_source]
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.



24
25
26
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 24

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.



21
22
23
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 21

def destination_fulfillment_center_id
  @destination_fulfillment_center_id
end

#intended_box_contents_source ⇒ Object

Returns the value of attribute intended_box_contents_source.



18
19
20
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 18

def intended_box_contents_source
  @intended_box_contents_source
end

#label_prep_preference ⇒ Object

Returns the value of attribute label_prep_preference.



18
19
20
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 18

def label_prep_preference
  @label_prep_preference
end

#ship_from_address ⇒ Object

Returns the value of attribute ship_from_address.



18
19
20
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 18

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.



16
17
18
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 16

def shipment_name
  @shipment_name
end

#shipment_status ⇒ Object

Returns the value of attribute shipment_status.



18
19
20
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 18

def shipment_status
  @shipment_status
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 27

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



145
146
147
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_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



53
54
55
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 53

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

.openapi_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 40

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

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 117

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    shipment_name == other.shipment_name &&
    ship_from_address == other.ship_from_address &&
    destination_fulfillment_center_id == other.destination_fulfillment_center_id &&
    are_cases_required == other.are_cases_required &&
    shipment_status == other.shipment_status &&
    label_prep_preference == other.label_prep_preference &&
    intended_box_contents_source == other.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



174
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
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 174

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
    AmznSpApi::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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 243

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
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


132
133
134
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 132

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



138
139
140
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 138

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 88

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

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

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

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

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

  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



219
220
221
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 219

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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 225

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



213
214
215
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 213

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



105
106
107
108
109
110
111
112
113
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_header.rb', line 105

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