Class: AmznSpApi::ShippingApiModel::PurchaseLabelsResult

Inherits:
Object
  • Object
show all
Defined in:
lib/shipping_api_model/models/purchase_labels_result.rb

Overview

The payload schema for the purchaseLabels operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PurchaseLabelsResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 44

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

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

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

  return unless attributes.key?(:label_results)

  self.label_results = attributes[:label_results]
end

Instance Attribute Details

#accepted_rate ⇒ Object

Returns the value of attribute accepted_rate.



15
16
17
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 15

def accepted_rate
  @accepted_rate
end

#client_reference_id ⇒ Object

Returns the value of attribute client_reference_id.



15
16
17
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 15

def client_reference_id
  @client_reference_id
end

#label_results ⇒ Object

Returns the value of attribute label_results.



15
16
17
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 15

def label_results
  @label_results
end

#shipment_id ⇒ Object

Returns the value of attribute shipment_id.



15
16
17
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 15

def shipment_id
  @shipment_id
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
25
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 18

def self.attribute_map
  {
    'shipment_id': :shipmentId,
    'client_reference_id': :clientReferenceId,
    'accepted_rate': :acceptedRate,
    'label_results': :labelResults
  }
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



115
116
117
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 115

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



38
39
40
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 38

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

.openapi_types ⇒ Object

Attribute type mapping.



28
29
30
31
32
33
34
35
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 28

def self.openapi_types
  {
    'shipment_id': :Object,
    'client_reference_id': :Object,
    'accepted_rate': :Object,
    'label_results': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



90
91
92
93
94
95
96
97
98
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 90

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

  self.class == other.class &&
    shipment_id == other.shipment_id &&
    client_reference_id == other.client_reference_id &&
    accepted_rate == other.accepted_rate &&
    label_results == other.label_results
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



144
145
146
147
148
149
150
151
152
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
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 144

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



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 213

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 122

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


102
103
104
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 102

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



108
109
110
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 108

def hash
  [shipment_id, client_reference_id, accepted_rate, label_results].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



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 67

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

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

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



189
190
191
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 189

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



195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 195

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



183
184
185
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 183

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



80
81
82
83
84
85
86
 
# File 'lib/shipping_api_model/models/purchase_labels_result.rb', line 80

def valid?
  return false if @shipment_id.nil?
  return false if @accepted_rate.nil?
  return false if @label_results.nil?

  true
end