Class: AmzSpApi::FulfillmentOutboundApiModel::ReturnItem

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment-outbound-api-model/models/return_item.rb

Overview

An item that Amazon accepted for return.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReturnItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
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
138
139
140
141
142
143
144
145
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 89

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amazon_return_reason_code ⇒ Object

The return reason code that the Amazon fulfillment center assigned to the return item.



33
34
35
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 33

def amazon_return_reason_code
  @amazon_return_reason_code
end

#amazon_shipment_id ⇒ Object

The identifier for the shipment that is associated with the return item.



24
25
26
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 24

def amazon_shipment_id
  @amazon_shipment_id
end

#fulfillment_center_id ⇒ Object

The identifier for the Amazon fulfillment center that processed the return item.



45
46
47
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 45

def fulfillment_center_id
  @fulfillment_center_id
end

#return_authorization_id ⇒ Object

Identifies the return authorization used to return this item. See ReturnAuthorization.



40
41
42
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 40

def return_authorization_id
  @return_authorization_id
end

#return_comment ⇒ Object

An optional comment about the return item.



30
31
32
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 30

def return_comment
  @return_comment
end

#return_received_condition ⇒ Object

Returns the value of attribute return_received_condition.



42
43
44
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 42

def return_received_condition
  @return_received_condition
end

#seller_fulfillment_order_item_id ⇒ Object

The identifier assigned to the item by the seller when the fulfillment order was created.



21
22
23
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 21

def seller_fulfillment_order_item_id
  @seller_fulfillment_order_item_id
end

#seller_return_item_id ⇒ Object

An identifier assigned by the seller to the return item.



18
19
20
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 18

def seller_return_item_id
  @seller_return_item_id
end

#seller_return_reason_code ⇒ Object

The return reason code assigned to the return item by the seller.



27
28
29
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 27

def seller_return_reason_code
  @seller_return_reason_code
end

#status ⇒ Object

Returns the value of attribute status.



35
36
37
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 35

def status
  @status
end

#status_changed_date ⇒ Object

Returns the value of attribute status_changed_date.



37
38
39
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 37

def status_changed_date
  @status_changed_date
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 48

def self.attribute_map
  {
    :'seller_return_item_id' => :'sellerReturnItemId',
    :'seller_fulfillment_order_item_id' => :'sellerFulfillmentOrderItemId',
    :'amazon_shipment_id' => :'amazonShipmentId',
    :'seller_return_reason_code' => :'sellerReturnReasonCode',
    :'return_comment' => :'returnComment',
    :'amazon_return_reason_code' => :'amazonReturnReasonCode',
    :'status' => :'status',
    :'status_changed_date' => :'statusChangedDate',
    :'return_authorization_id' => :'returnAuthorizationId',
    :'return_received_condition' => :'returnReceivedCondition',
    :'fulfillment_center_id' => :'fulfillmentCenterId'
  }
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



223
224
225
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 223

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 65

def self.openapi_types
  {
    :'seller_return_item_id' => :'Object',
    :'seller_fulfillment_order_item_id' => :'Object',
    :'amazon_shipment_id' => :'Object',
    :'seller_return_reason_code' => :'Object',
    :'return_comment' => :'Object',
    :'amazon_return_reason_code' => :'Object',
    :'status' => :'Object',
    :'status_changed_date' => :'Object',
    :'return_authorization_id' => :'Object',
    :'return_received_condition' => :'Object',
    :'fulfillment_center_id' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 192

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      seller_return_item_id == o.seller_return_item_id &&
      seller_fulfillment_order_item_id == o.seller_fulfillment_order_item_id &&
      amazon_shipment_id == o.amazon_shipment_id &&
      seller_return_reason_code == o.seller_return_reason_code &&
      return_comment == o.return_comment &&
      amazon_return_reason_code == o.amazon_return_reason_code &&
      status == o.status &&
      status_changed_date == o.status_changed_date &&
      return_authorization_id == o.return_authorization_id &&
      return_received_condition == o.return_received_condition &&
      fulfillment_center_id == o.fulfillment_center_id
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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 253

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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 322

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 230

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


210
211
212
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



216
217
218
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 216

def hash
  [seller_return_item_id, seller_fulfillment_order_item_id, amazon_shipment_id, seller_return_reason_code, return_comment, amazon_return_reason_code, status, status_changed_date, return_authorization_id, return_received_condition, fulfillment_center_id].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



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
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 149

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

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

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

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

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

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



298
299
300
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 298

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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 304

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



292
293
294
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 292

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



180
181
182
183
184
185
186
187
188
 
# File 'lib/fulfillment-outbound-api-model/models/return_item.rb', line 180

def valid?
  return false if @seller_return_item_id.nil?
  return false if @seller_fulfillment_order_item_id.nil?
  return false if @amazon_shipment_id.nil?
  return false if @seller_return_reason_code.nil?
  return false if @status.nil?
  return false if @status_changed_date.nil?
  true
end