Class: AmznSpApi::FulfillmentOutboundApiModel::CreateReturnItem

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_outbound_api_model/models/create_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 = {}) ⇒ CreateReturnItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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

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

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

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

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

  return unless attributes.key?(:return_comment)

  self.return_comment = attributes[:return_comment]
end

Instance Attribute Details

#amazon_shipment_id ⇒ Object

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



22
23
24
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 22

def amazon_shipment_id
  @amazon_shipment_id
end

#return_comment ⇒ Object

An optional comment about the return item.



28
29
30
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 28

def return_comment
  @return_comment
end

#return_reason_code ⇒ Object

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



25
26
27
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 25

def return_reason_code
  @return_reason_code
end

#seller_fulfillment_order_item_id ⇒ Object

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



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

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.



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

def seller_return_item_id
  @seller_return_item_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    'seller_return_item_id': :sellerReturnItemId,
    'seller_fulfillment_order_item_id': :sellerFulfillmentOrderItemId,
    'amazon_shipment_id': :amazonShipmentId,
    'return_reason_code': :returnReasonCode,
    'return_comment': :returnComment
  }
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
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 136

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



53
54
55
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 53

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    'seller_return_item_id': :Object,
    'seller_fulfillment_order_item_id': :Object,
    'amazon_shipment_id': :Object,
    'return_reason_code': :Object,
    'return_comment': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 110

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

  self.class == other.class &&
    seller_return_item_id == other.seller_return_item_id &&
    seller_fulfillment_order_item_id == other.seller_fulfillment_order_item_id &&
    amazon_shipment_id == other.amazon_shipment_id &&
    return_reason_code == other.return_reason_code &&
    return_comment == other.return_comment
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



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

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 234

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



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

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


123
124
125
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 123

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



129
130
131
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 129

def hash
  [seller_return_item_id, seller_fulfillment_order_item_id, amazon_shipment_id, return_reason_code, return_comment].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



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

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

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

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

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



210
211
212
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 210

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



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 216

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



204
205
206
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 204

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



99
100
101
102
103
104
105
106
 
# File 'lib/fulfillment_outbound_api_model/models/create_return_item.rb', line 99

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 @return_reason_code.nil?

  true
end