Class: AmznSpApi::FulfillmentOutboundApiModel::FulfillmentPreviewShipment

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FulfillmentPreviewShipment

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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

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

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

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

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

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

  return unless attributes.key?(:fulfillment_preview_items)

  self.fulfillment_preview_items = attributes[:fulfillment_preview_items]
end

Instance Attribute Details

#earliest_arrival_date ⇒ Object

Returns the value of attribute earliest_arrival_date.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 15

def earliest_arrival_date
  @earliest_arrival_date
end

#earliest_ship_date ⇒ Object

Returns the value of attribute earliest_ship_date.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 15

def earliest_ship_date
  @earliest_ship_date
end

#fulfillment_preview_items ⇒ Object

Returns the value of attribute fulfillment_preview_items.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 15

def fulfillment_preview_items
  @fulfillment_preview_items
end

#latest_arrival_date ⇒ Object

Returns the value of attribute latest_arrival_date.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 15

def latest_arrival_date
  @latest_arrival_date
end

#latest_ship_date ⇒ Object

Returns the value of attribute latest_ship_date.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 15

def latest_ship_date
  @latest_ship_date
end

#shipping_notes ⇒ Object

Provides additional insight into the shipment timeline when exact delivery dates are not able to be precomputed.



18
19
20
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 18

def shipping_notes
  @shipping_notes
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 21

def self.attribute_map
  {
    'earliest_ship_date': :earliestShipDate,
    'latest_ship_date': :latestShipDate,
    'earliest_arrival_date': :earliestArrivalDate,
    'latest_arrival_date': :latestArrivalDate,
    'shipping_notes': :shippingNotes,
    'fulfillment_preview_items': :fulfillmentPreviewItems
  }
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



124
125
126
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 124

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



45
46
47
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 45

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

.openapi_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 33

def self.openapi_types
  {
    'earliest_ship_date': :Object,
    'latest_ship_date': :Object,
    'earliest_arrival_date': :Object,
    'latest_arrival_date': :Object,
    'shipping_notes': :Object,
    'fulfillment_preview_items': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 97

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

  self.class == other.class &&
    earliest_ship_date == other.earliest_ship_date &&
    latest_ship_date == other.latest_ship_date &&
    earliest_arrival_date == other.earliest_arrival_date &&
    latest_arrival_date == other.latest_arrival_date &&
    shipping_notes == other.shipping_notes &&
    fulfillment_preview_items == other.fulfillment_preview_items
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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 153

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



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 222

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 131

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


111
112
113
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



117
118
119
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 117

def hash
  [earliest_ship_date, latest_ship_date, earliest_arrival_date, latest_arrival_date, shipping_notes, fulfillment_preview_items].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



80
81
82
83
84
85
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 80

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



198
199
200
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 198

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



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 204

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



192
193
194
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 192

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



89
90
91
92
93
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview_shipment.rb', line 89

def valid?
  return false if @fulfillment_preview_items.nil?

  true
end