Class: AmzSpApi::VendorDirectFulfillmentOrdersApiModel::ShipmentDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb

Overview

Shipment details required for the shipment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShipmentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 71

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::VendorDirectFulfillmentOrdersApiModel::ShipmentDetails` 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::VendorDirectFulfillmentOrdersApiModel::ShipmentDetails`. 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?(:'is_priority_shipment')
    self.is_priority_shipment = attributes[:'is_priority_shipment']
  end

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

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

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

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

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

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

Instance Attribute Details

#is_gift ⇒ Object

When true, the order contain a gift. Include the gift message and gift wrap information.



27
28
29
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 27

def is_gift
  @is_gift
end

#is_priority_shipment ⇒ Object

When true, this is a priority shipment.



18
19
20
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 18

def is_priority_shipment
  @is_priority_shipment
end

#is_pslip_required ⇒ Object

When true, a packing slip is required to be sent to the customer.



24
25
26
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 24

def is_pslip_required
  @is_pslip_required
end

#is_scheduled_delivery_shipment ⇒ Object

When true, this order is part of a scheduled delivery program.



21
22
23
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 21

def is_scheduled_delivery_shipment
  @is_scheduled_delivery_shipment
end

#message_to_customer ⇒ Object

Message to customer for order status.



35
36
37
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 35

def message_to_customer
  @message_to_customer
end

#ship_method ⇒ Object

Ship method to be used for shipping the order. Amazon defines ship method codes indicating the shipping carrier and shipment service level. To see the full list of ship methods in use, including both the code and the friendly name, search the ‘Help’ section on Vendor Central for ‘ship methods’.



30
31
32
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 30

def ship_method
  @ship_method
end

#shipment_dates ⇒ Object

Returns the value of attribute shipment_dates.



32
33
34
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 32

def shipment_dates
  @shipment_dates
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 38

def self.attribute_map
  {
    :'is_priority_shipment' => :'isPriorityShipment',
    :'is_scheduled_delivery_shipment' => :'isScheduledDeliveryShipment',
    :'is_pslip_required' => :'isPslipRequired',
    :'is_gift' => :'isGift',
    :'ship_method' => :'shipMethod',
    :'shipment_dates' => :'shipmentDates',
    :'message_to_customer' => :'messageToCustomer'
  }
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



180
181
182
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 180

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
67
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 51

def self.openapi_types
  {
    :'is_priority_shipment' => :'Object',
    :'is_scheduled_delivery_shipment' => :'Object',
    :'is_pslip_required' => :'Object',
    :'is_gift' => :'Object',
    :'ship_method' => :'Object',
    :'shipment_dates' => :'Object',
    :'message_to_customer' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      is_priority_shipment == o.is_priority_shipment &&
      is_scheduled_delivery_shipment == o.is_scheduled_delivery_shipment &&
      is_pslip_required == o.is_pslip_required &&
      is_gift == o.is_gift &&
      ship_method == o.ship_method &&
      shipment_dates == o.shipment_dates &&
      message_to_customer == o.message_to_customer
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



210
211
212
213
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
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 210

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 279

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 187

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


167
168
169
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 167

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



173
174
175
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 173

def hash
  [is_priority_shipment, is_scheduled_delivery_shipment, is_pslip_required, is_gift, ship_method, shipment_dates, message_to_customer].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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 115

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

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

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

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

  if @message_to_customer.nil?
    invalid_properties.push('invalid value for "message_to_customer", message_to_customer 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



255
256
257
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 255

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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 261

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



249
250
251
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 249

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



142
143
144
145
146
147
148
149
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/shipment_details.rb', line 142

def valid?
  return false if @is_priority_shipment.nil?
  return false if @is_pslip_required.nil?
  return false if @ship_method.nil?
  return false if @shipment_dates.nil?
  return false if @message_to_customer.nil?
  true
end