Class: AmznSpApi::FulfillmentInboundApiModel::InboundShipmentPlan

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

Overview

Inbound shipment information used to create an inbound shipment. Returned by the createInboundShipmentPlan operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InboundShipmentPlan

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 54

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

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

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

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

  return unless attributes.key?(:estimated_box_contents_fee)

  self.estimated_box_contents_fee = attributes[:estimated_box_contents_fee]
end

Instance Attribute Details

#destination_fulfillment_center_id ⇒ Object

An Amazon fulfillment center identifier created by Amazon.



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

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_plan.rb', line 21

def estimated_box_contents_fee
  @estimated_box_contents_fee
end

#items ⇒ Object

Returns the value of attribute items.



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

def items
  @items
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_plan.rb', line 21

def label_prep_type
  @label_prep_type
end

#ship_to_address ⇒ Object

Returns the value of attribute ship_to_address.



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

def ship_to_address
  @ship_to_address
end

#shipment_id ⇒ Object

A shipment identifier originally returned by the createInboundShipmentPlan operation.



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

def shipment_id
  @shipment_id
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 24

def self.attribute_map
  {
    'shipment_id': :ShipmentId,
    'destination_fulfillment_center_id': :DestinationFulfillmentCenterId,
    'ship_to_address': :ShipToAddress,
    'label_prep_type': :LabelPrepType,
    'items': :Items,
    '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



137
138
139
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 137

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



48
49
50
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 48

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

.openapi_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 36

def self.openapi_types
  {
    'shipment_id': :Object,
    'destination_fulfillment_center_id': :Object,
    'ship_to_address': :Object,
    'label_prep_type': :Object,
    'items': :Object,
    'estimated_box_contents_fee': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 110

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

  self.class == other.class &&
    shipment_id == other.shipment_id &&
    destination_fulfillment_center_id == other.destination_fulfillment_center_id &&
    ship_to_address == other.ship_to_address &&
    label_prep_type == other.label_prep_type &&
    items == other.items &&
    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



166
167
168
169
170
171
172
173
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
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 166

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



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

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 144

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


124
125
126
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



130
131
132
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 130

def hash
  [shipment_id, destination_fulfillment_center_id, ship_to_address, label_prep_type, items, 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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 81

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "shipment_id", shipment_id cannot be nil.') if @shipment_id.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 "ship_to_address", ship_to_address cannot be nil.') if @ship_to_address.nil?

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

  invalid_properties.push('invalid value for "items", items cannot be nil.') if @items.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



211
212
213
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 211

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



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 217

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



205
206
207
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 205

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



98
99
100
101
102
103
104
105
106
 
# File 'lib/fulfillment_inbound_api_model/models/inbound_shipment_plan.rb', line 98

def valid?
  return false if @shipment_id.nil?
  return false if @destination_fulfillment_center_id.nil?
  return false if @ship_to_address.nil?
  return false if @label_prep_type.nil?
  return false if @items.nil?

  true
end