Class: AmznSpApi::FulfillmentOutboundApiModel::ReturnAuthorization

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_outbound_api_model/models/return_authorization.rb

Overview

Return authorization information for items accepted for return.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReturnAuthorization

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 58

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

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

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

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

  return unless attributes.key?(:rma_page_url)

  self.rma_page_url = attributes[:rma_page_url]
end

Instance Attribute Details

#amazon_rma_id ⇒ Object

The return merchandise authorization (RMA) that Amazon needs to process the return.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 24

def amazon_rma_id
  @amazon_rma_id
end

#fulfillment_center_id ⇒ Object

An identifier for the Amazon fulfillment center that the return items should be sent to.



19
20
21
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 19

def fulfillment_center_id
  @fulfillment_center_id
end

#return_authorization_id ⇒ Object

An identifier for the return authorization. This identifier associates return items with the return authorization used to return them.



16
17
18
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 16

def return_authorization_id
  @return_authorization_id
end

#return_to_address ⇒ Object

Returns the value of attribute return_to_address.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 21

def return_to_address
  @return_to_address
end

#rma_page_url ⇒ Object

A URL for a web page that contains the return authorization barcode and the mailing label. This does not include pre-paid shipping.



27
28
29
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 27

def rma_page_url
  @rma_page_url
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 30

def self.attribute_map
  {
    'return_authorization_id': :returnAuthorizationId,
    'fulfillment_center_id': :fulfillmentCenterId,
    'return_to_address': :returnToAddress,
    'amazon_rma_id': :amazonRmaId,
    'rma_page_url': :rmaPageURL
  }
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



138
139
140
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 138

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



52
53
54
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 52

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

.openapi_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 41

def self.openapi_types
  {
    'return_authorization_id': :Object,
    'fulfillment_center_id': :Object,
    'return_to_address': :Object,
    'amazon_rma_id': :Object,
    'rma_page_url': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 112

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

  self.class == other.class &&
    return_authorization_id == other.return_authorization_id &&
    fulfillment_center_id == other.fulfillment_center_id &&
    return_to_address == other.return_to_address &&
    amazon_rma_id == other.amazon_rma_id &&
    rma_page_url == other.rma_page_url
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



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
194
195
196
197
198
199
200
201
202
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 167

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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 236

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 145

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


125
126
127
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 125

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



131
132
133
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 131

def hash
  [return_authorization_id, fulfillment_center_id, return_to_address, amazon_rma_id, rma_page_url].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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 83

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

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

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

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

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



212
213
214
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 212

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



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 218

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



206
207
208
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 206

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



100
101
102
103
104
105
106
107
108
 
# File 'lib/fulfillment_outbound_api_model/models/return_authorization.rb', line 100

def valid?
  return false if @return_authorization_id.nil?
  return false if @fulfillment_center_id.nil?
  return false if @return_to_address.nil?
  return false if @amazon_rma_id.nil?
  return false if @rma_page_url.nil?

  true
end