Class: AmznSpApi::FulfillmentInboundApiModel::InboundShipmentInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb

Overview

Information about the seller’s inbound shipments. Returned by the listInboundShipments operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InboundShipmentInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::FulfillmentInboundApiModel::InboundShipmentInfo` 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::InboundShipmentInfo`. 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_id = attributes[:shipment_id] if attributes.key?(:shipment_id)

  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.shipment_status = attributes[:shipment_status] if attributes.key?(:shipment_status)

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

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

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

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

  return unless attributes.key?(:estimated_box_contents_fee)

  self.estimated_box_contents_fee = attributes[:estimated_box_contents_fee]
end

Instance Attribute Details

#are_cases_required ⇒ Object

Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed.



27
28
29
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 27

def are_cases_required
  @are_cases_required
end

#box_contents_source ⇒ Object

Returns the value of attribute box_contents_source.



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

def box_contents_source
  @box_contents_source
end

#confirmed_need_by_date ⇒ Object

Returns the value of attribute confirmed_need_by_date.



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

def confirmed_need_by_date
  @confirmed_need_by_date
end

#destination_fulfillment_center_id ⇒ Object

An Amazon fulfillment center identifier created by Amazon.



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

def destination_fulfillment_center_id
  @destination_fulfillment_center_id
end

#estimated_box_contents_fee ⇒ Object

Returns the value of attribute estimated_box_contents_fee.



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

def estimated_box_contents_fee
  @estimated_box_contents_fee
end

#label_prep_type ⇒ Object

Returns the value of attribute label_prep_type.



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

def label_prep_type
  @label_prep_type
end

#ship_from_address ⇒ Object

Returns the value of attribute ship_from_address.



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

def ship_from_address
  @ship_from_address
end

#shipment_id ⇒ Object

The shipment identifier submitted in the request.



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

def shipment_id
  @shipment_id
end

#shipment_name ⇒ Object

The name for the inbound shipment.



19
20
21
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 19

def shipment_name
  @shipment_name
end

#shipment_status ⇒ Object

Returns the value of attribute shipment_status.



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

def shipment_status
  @shipment_status
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 30

def self.attribute_map
  {
    'shipment_id': :ShipmentId,
    'shipment_name': :ShipmentName,
    'ship_from_address': :ShipFromAddress,
    'destination_fulfillment_center_id': :DestinationFulfillmentCenterId,
    'shipment_status': :ShipmentStatus,
    'label_prep_type': :LabelPrepType,
    'are_cases_required': :AreCasesRequired,
    'confirmed_need_by_date': :ConfirmedNeedByDate,
    'box_contents_source': :BoxContentsSource,
    'estimated_box_contents_fee': :EstimatedBoxContentsFee
  }
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



154
155
156
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 154

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 46

def self.openapi_types
  {
    'shipment_id': :Object,
    'shipment_name': :Object,
    'ship_from_address': :Object,
    'destination_fulfillment_center_id': :Object,
    'shipment_status': :Object,
    'label_prep_type': :Object,
    'are_cases_required': :Object,
    'confirmed_need_by_date': :Object,
    'box_contents_source': :Object,
    'estimated_box_contents_fee': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 123

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

  self.class == other.class &&
    shipment_id == other.shipment_id &&
    shipment_name == other.shipment_name &&
    ship_from_address == other.ship_from_address &&
    destination_fulfillment_center_id == other.destination_fulfillment_center_id &&
    shipment_status == other.shipment_status &&
    label_prep_type == other.label_prep_type &&
    are_cases_required == other.are_cases_required &&
    confirmed_need_by_date == other.confirmed_need_by_date &&
    box_contents_source == other.box_contents_source &&
    estimated_box_contents_fee == other.estimated_box_contents_fee
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



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

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 252

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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 161

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


141
142
143
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 141

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



147
148
149
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 147

def hash
  [shipment_id, shipment_name, ship_from_address, destination_fulfillment_center_id, shipment_status, label_prep_type, are_cases_required, confirmed_need_by_date, box_contents_source, estimated_box_contents_fee].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



103
104
105
106
107
108
109
110
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 103

def list_invalid_properties
  invalid_properties = []
  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 "are_cases_required", are_cases_required cannot be nil.') if @are_cases_required.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



228
229
230
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 228

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 234

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



222
223
224
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 222

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



114
115
116
117
118
119
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_info.rb', line 114

def valid?
  return false if @ship_from_address.nil?
  return false if @are_cases_required.nil?

  true
end