Class: AmznSpApi::OrdersApiModel::OrderItemBuyerInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/orders_api_model/models/order_item_buyer_info.rb

Overview

A single order item’s buyer information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderItemBuyerInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError)


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

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

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

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

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

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

  return unless attributes.key?(:gift_wrap_level)

  self.gift_wrap_level = attributes[:gift_wrap_level]
end

Instance Attribute Details

#buyer_customized_infoObject

Returns the value of attribute buyer_customized_info.



18
19
20
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 18

def buyer_customized_info
  @buyer_customized_info
end

#gift_message_textObject

A gift message provided by the buyer.



21
22
23
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 21

def gift_message_text
  @gift_message_text
end

#gift_wrap_levelObject

The gift wrap level specified by the buyer.



24
25
26
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 24

def gift_wrap_level
  @gift_wrap_level
end

#gift_wrap_priceObject

Returns the value of attribute gift_wrap_price.



18
19
20
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 18

def gift_wrap_price
  @gift_wrap_price
end

#gift_wrap_taxObject

Returns the value of attribute gift_wrap_tax.



18
19
20
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 18

def gift_wrap_tax
  @gift_wrap_tax
end

#order_item_idObject

An Amazon-defined order item identifier.



16
17
18
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 16

def order_item_id
  @order_item_id
end

Class Method Details

.attribute_mapObject

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



27
28
29
30
31
32
33
34
35
36
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 27

def self.attribute_map
  {
    'order_item_id': :OrderItemId,
    'buyer_customized_info': :BuyerCustomizedInfo,
    'gift_wrap_price': :GiftWrapPrice,
    'gift_wrap_tax': :GiftWrapTax,
    'gift_message_text': :GiftMessageText,
    'gift_wrap_level': :GiftWrapLevel
  }
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



128
129
130
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 128

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

.openapi_nullableObject

List of attributes with nullable: true



51
52
53
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 51

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

.openapi_typesObject

Attribute type mapping.



39
40
41
42
43
44
45
46
47
48
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 39

def self.openapi_types
  {
    'order_item_id': :Object,
    'buyer_customized_info': :Object,
    'gift_wrap_price': :Object,
    'gift_wrap_tax': :Object,
    'gift_message_text': :Object,
    'gift_wrap_level': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



101
102
103
104
105
106
107
108
109
110
111
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 101

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

  self.class == other.class &&
    order_item_id == other.order_item_id &&
    buyer_customized_info == other.buyer_customized_info &&
    gift_wrap_price == other.gift_wrap_price &&
    gift_wrap_tax == other.gift_wrap_tax &&
    gift_message_text == other.gift_message_text &&
    gift_wrap_level == other.gift_wrap_level
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



157
158
159
160
161
162
163
164
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
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 157

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



226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 226

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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 135

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


115
116
117
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 115

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



121
122
123
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 121

def hash
  [order_item_id, buyer_customized_info, gift_wrap_price, gift_wrap_tax, gift_message_text, gift_wrap_level].hash
end

#list_invalid_propertiesObject

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
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 84

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



202
203
204
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 202

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 208

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



196
197
198
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 196

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



93
94
95
96
97
# File 'lib/orders_api_model/models/order_item_buyer_info.rb', line 93

def valid?
  return false if @order_item_id.nil?

  true
end