Class: AmznSpApi::FulfillmentInboundApiModel::PartneredSmallParcelPackageOutput

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb

Overview

Dimension, weight, and shipping information for the package.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PartneredSmallParcelPackageOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 49

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

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

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

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

  return unless attributes.key?(:package_status)

  self.package_status = attributes[:package_status]
end

Instance Attribute Details

#carrier_name ⇒ Object

The carrier specified with a previous call to putTransportDetails.



18
19
20
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 18

def carrier_name
  @carrier_name
end

#dimensions ⇒ Object

Returns the value of attribute dimensions.



15
16
17
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 15

def dimensions
  @dimensions
end

#package_status ⇒ Object

Returns the value of attribute package_status.



15
16
17
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 15

def package_status
  @package_status
end

#tracking_id ⇒ Object

Returns the value of attribute tracking_id.



15
16
17
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 15

def tracking_id
  @tracking_id
end

#weight ⇒ Object

Returns the value of attribute weight.



15
16
17
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 15

def weight
  @weight
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
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 21

def self.attribute_map
  {
    'dimensions': :Dimensions,
    'weight': :Weight,
    'carrier_name': :CarrierName,
    'tracking_id': :TrackingId,
    'package_status': :PackageStatus
  }
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



129
130
131
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 129

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



43
44
45
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 43

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

.openapi_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
40
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 32

def self.openapi_types
  {
    'dimensions': :Object,
    'weight': :Object,
    'carrier_name': :Object,
    'tracking_id': :Object,
    'package_status': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



103
104
105
106
107
108
109
110
111
112
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 103

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

  self.class == other.class &&
    dimensions == other.dimensions &&
    weight == other.weight &&
    carrier_name == other.carrier_name &&
    tracking_id == other.tracking_id &&
    package_status == other.package_status
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



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
189
190
191
192
193
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 158

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



227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 227

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 136

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


116
117
118
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 116

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



122
123
124
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 122

def hash
  [dimensions, weight, carrier_name, tracking_id, package_status].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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 74

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

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

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

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

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



203
204
205
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 203

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



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 209

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



197
198
199
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 197

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



91
92
93
94
95
96
97
98
99
 
# File 'lib/fulfillment_inbound_api_model/models/partnered_small_parcel_package_output.rb', line 91

def valid?
  return false if @dimensions.nil?
  return false if @weight.nil?
  return false if @carrier_name.nil?
  return false if @tracking_id.nil?
  return false if @package_status.nil?

  true
end