Class: AmzSpApi::ShippingApiModel::PurchaseShipmentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/shipping-api-model/models/purchase_shipment_request.rb

Overview

The payload schema for the purchaseShipment operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PurchaseShipmentRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
101
102
103
104
105
106
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 66

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

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

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

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

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

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

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

Instance Attribute Details

#client_reference_id ⇒ Object

Returns the value of attribute client_reference_id.



17
18
19
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 17

def client_reference_id
  @client_reference_id
end

#containers ⇒ Object

Returns the value of attribute containers.



28
29
30
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 28

def containers
  @containers
end

#label_specification ⇒ Object

Returns the value of attribute label_specification.



30
31
32
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 30

def label_specification
  @label_specification
end

#service_type ⇒ Object

Returns the value of attribute service_type.



26
27
28
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 26

def service_type
  @service_type
end

#ship_date ⇒ Object

The start date and time. This defaults to the current date and time.



24
25
26
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 24

def ship_date
  @ship_date
end

#ship_from ⇒ Object

Returns the value of attribute ship_from.



21
22
23
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 21

def ship_from
  @ship_from
end

#ship_to ⇒ Object

Returns the value of attribute ship_to.



19
20
21
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 19

def ship_to
  @ship_to
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 33

def self.attribute_map
  {
    :'client_reference_id' => :'clientReferenceId',
    :'ship_to' => :'shipTo',
    :'ship_from' => :'shipFrom',
    :'ship_date' => :'shipDate',
    :'service_type' => :'serviceType',
    :'containers' => :'containers',
    :'label_specification' => :'labelSpecification'
  }
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/shipping-api-model/models/purchase_shipment_request.rb', line 180

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



59
60
61
62
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 59

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 46

def self.openapi_types
  {
    :'client_reference_id' => :'Object',
    :'ship_to' => :'Object',
    :'ship_from' => :'Object',
    :'ship_date' => :'Object',
    :'service_type' => :'Object',
    :'containers' => :'Object',
    :'label_specification' => :'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/shipping-api-model/models/purchase_shipment_request.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_reference_id == o.client_reference_id &&
      ship_to == o.ship_to &&
      ship_from == o.ship_from &&
      ship_date == o.ship_date &&
      service_type == o.service_type &&
      containers == o.containers &&
      label_specification == o.label_specification
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/shipping-api-model/models/purchase_shipment_request.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::ShippingApiModel.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/shipping-api-model/models/purchase_shipment_request.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/shipping-api-model/models/purchase_shipment_request.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/shipping-api-model/models/purchase_shipment_request.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/shipping-api-model/models/purchase_shipment_request.rb', line 173

def hash
  [client_reference_id, ship_to, ship_from, ship_date, service_type, containers, label_specification].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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 110

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

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

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

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

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

  if @label_specification.nil?
    invalid_properties.push('invalid value for "label_specification", label_specification 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/shipping-api-model/models/purchase_shipment_request.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/shipping-api-model/models/purchase_shipment_request.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/shipping-api-model/models/purchase_shipment_request.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



141
142
143
144
145
146
147
148
149
 
# File 'lib/shipping-api-model/models/purchase_shipment_request.rb', line 141

def valid?
  return false if @client_reference_id.nil?
  return false if @ship_to.nil?
  return false if @ship_from.nil?
  return false if @service_type.nil?
  return false if @containers.nil?
  return false if @label_specification.nil?
  true
end