Class: AmznSpApi::FulfillmentOutboundApiModel::FulfillmentShipment

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb

Overview

Delivery and item information for a shipment in a fulfillment order.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FulfillmentShipment

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 85

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

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

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

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

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

  if attributes.key?(:shipping_notes) && (value = attributes[:shipping_notes]).is_a?(Array)
    self.shipping_notes = value
  end

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

  return unless attributes.key?(:fulfillment_shipment_package)

  self.fulfillment_shipment_package = attributes[:fulfillment_shipment_package]
end

Instance Attribute Details

#amazon_shipment_id ⇒ Object

A shipment identifier assigned by Amazon.



16
17
18
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 16

def amazon_shipment_id
  @amazon_shipment_id
end

#estimated_arrival_date ⇒ Object

Returns the value of attribute estimated_arrival_date.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 24

def estimated_arrival_date
  @estimated_arrival_date
end

#fulfillment_center_id ⇒ Object

An identifier for the fulfillment center that the shipment will be sent from.



19
20
21
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 19

def fulfillment_center_id
  @fulfillment_center_id
end

#fulfillment_shipment_item ⇒ Object

Returns the value of attribute fulfillment_shipment_item.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 24

def fulfillment_shipment_item
  @fulfillment_shipment_item
end

#fulfillment_shipment_package ⇒ Object

Returns the value of attribute fulfillment_shipment_package.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 24

def fulfillment_shipment_package
  @fulfillment_shipment_package
end

#fulfillment_shipment_status ⇒ Object

The current status of the shipment.



22
23
24
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 22

def fulfillment_shipment_status
  @fulfillment_shipment_status
end

#shipping_date ⇒ Object

Returns the value of attribute shipping_date.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 24

def shipping_date
  @shipping_date
end

#shipping_notes ⇒ Object

Provides additional insight into shipment timeline. Primairly used to communicate that actual delivery dates aren’t available.



27
28
29
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 27

def shipping_notes
  @shipping_notes
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 51

def self.attribute_map
  {
    'amazon_shipment_id': :amazonShipmentId,
    'fulfillment_center_id': :fulfillmentCenterId,
    'fulfillment_shipment_status': :fulfillmentShipmentStatus,
    'shipping_date': :shippingDate,
    'estimated_arrival_date': :estimatedArrivalDate,
    'shipping_notes': :shippingNotes,
    'fulfillment_shipment_item': :fulfillmentShipmentItem,
    'fulfillment_shipment_package': :fulfillmentShipmentPackage
  }
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



185
186
187
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 185

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 79

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 65

def self.openapi_types
  {
    'amazon_shipment_id': :Object,
    'fulfillment_center_id': :Object,
    'fulfillment_shipment_status': :Object,
    'shipping_date': :Object,
    'estimated_arrival_date': :Object,
    'shipping_notes': :Object,
    'fulfillment_shipment_item': :Object,
    'fulfillment_shipment_package': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 156

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

  self.class == other.class &&
    amazon_shipment_id == other.amazon_shipment_id &&
    fulfillment_center_id == other.fulfillment_center_id &&
    fulfillment_shipment_status == other.fulfillment_shipment_status &&
    shipping_date == other.shipping_date &&
    estimated_arrival_date == other.estimated_arrival_date &&
    shipping_notes == other.shipping_notes &&
    fulfillment_shipment_item == other.fulfillment_shipment_item &&
    fulfillment_shipment_package == other.fulfillment_shipment_package
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



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
243
244
245
246
247
248
249
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 214

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::FulfillmentOutboundApiModel.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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 283

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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 192

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


172
173
174
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 172

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



178
179
180
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 178

def hash
  [amazon_shipment_id, fulfillment_center_id, fulfillment_shipment_status, shipping_date, estimated_arrival_date, shipping_notes, fulfillment_shipment_item, fulfillment_shipment_package].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



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 118

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

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

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

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



259
260
261
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 259

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 265

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



253
254
255
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 253

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



133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment.rb', line 133

def valid?
  return false if @amazon_shipment_id.nil?
  return false if @fulfillment_center_id.nil?
  return false if @fulfillment_shipment_status.nil?

  fulfillment_shipment_status_validator = EnumAttributeValidator.new('Object', %w[PENDING SHIPPED CANCELLED_BY_FULFILLER CANCELLED_BY_SELLER])
  return false unless fulfillment_shipment_status_validator.valid?(@fulfillment_shipment_status)
  return false if @fulfillment_shipment_item.nil?

  true
end