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



62
63
64
65
66
67
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
100
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 62

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::FulfillmentOutboundApiModel::FulfillmentPreviewShipment` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `AmzSpApi::FulfillmentOutboundApiModel::FulfillmentPreviewShipment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'earliest_ship_date')
    self.earliest_ship_date = attributes[:'earliest_ship_date']
  end

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

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

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

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

  if attributes.key?(:'fulfillment_preview_items')
    self.fulfillment_preview_items = attributes[:'fulfillment_preview_items']
  end
end

Instance Attribute Details

#earliest_arrival_date ⇒ Object

Returns the value of attribute earliest_arrival_date.



21
22
23
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 21

def earliest_arrival_date
  @earliest_arrival_date
end

#earliest_ship_date ⇒ Object

Returns the value of attribute earliest_ship_date.



17
18
19
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 17

def earliest_ship_date
  @earliest_ship_date
end

#fulfillment_preview_items ⇒ Object

Returns the value of attribute fulfillment_preview_items.



28
29
30
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 28

def fulfillment_preview_items
  @fulfillment_preview_items
end

#latest_arrival_date ⇒ Object

Returns the value of attribute latest_arrival_date.



23
24
25
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 23

def latest_arrival_date
  @latest_arrival_date
end

#latest_ship_date ⇒ Object

Returns the value of attribute latest_ship_date.



19
20
21
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 19

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.



26
27
28
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 26

def shipping_notes
  @shipping_notes
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 31

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



148
149
150
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 148

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



55
56
57
58
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 55

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

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 43

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

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



122
123
124
125
126
127
128
129
130
131
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 122

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      earliest_ship_date == o.earliest_ship_date &&
      latest_ship_date == o.latest_ship_date &&
      earliest_arrival_date == o.earliest_arrival_date &&
      latest_arrival_date == o.latest_arrival_date &&
      shipping_notes == o.shipping_notes &&
      fulfillment_preview_items == o.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



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
210
211
212
213
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 178

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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 247

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 155

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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


135
136
137
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 135

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



141
142
143
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 141

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



104
105
106
107
108
109
110
111
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 104

def list_invalid_properties
  invalid_properties = Array.new
  if @fulfillment_preview_items.nil?
    invalid_properties.push('invalid value for "fulfillment_preview_items", fulfillment_preview_items cannot be nil.')
  end

  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



223
224
225
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 223

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



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 229

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



217
218
219
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 217

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



115
116
117
118
 
# File 'lib/fulfillment-outbound-api-model/models/fulfillment_preview_shipment.rb', line 115

def valid?
  return false if @fulfillment_preview_items.nil?
  true
end