Class: AmznSpApi::FulfillmentOutboundApiModel::CreateFulfillmentReturnRequest

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

Overview

The createFulfillmentReturn operation creates a fulfillment return for items that were fulfilled using the createFulfillmentOrder operation. For calls to createFulfillmentReturn, you must include ReturnReasonCode values returned by a previous call to the listReturnReasonCodes operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateFulfillmentReturnRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 38

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

  return unless attributes.key?(:items)

  self.items = attributes[:items]
end

Instance Attribute Details

#items ⇒ Object

Returns the value of attribute items.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 15

def items
  @items
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 18

def self.attribute_map
  {
    'items': :items
  }
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



94
95
96
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 94

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



32
33
34
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 32

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

.openapi_types ⇒ Object

Attribute type mapping.



25
26
27
28
29
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 25

def self.openapi_types
  {
    'items': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



72
73
74
75
76
77
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 72

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

  self.class == other.class &&
    items == other.items
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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 123

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



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 192

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 101

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


81
82
83
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 81

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



87
88
89
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 87

def hash
  [items].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



55
56
57
58
59
60
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 55

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "items", items cannot be nil.') if @items.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



168
169
170
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 168

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



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 174

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



162
163
164
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 162

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



64
65
66
67
68
 
# File 'lib/fulfillment_outbound_api_model/models/create_fulfillment_return_request.rb', line 64

def valid?
  return false if @items.nil?

  true
end