Class: AmznSpApi::OrdersApiModel::OrderBuyerInfo

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

Overview

Buyer information for an order.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderBuyerInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 63

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

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

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

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

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

  return unless attributes.key?(:purchase_order_number)

  self.purchase_order_number = attributes[:purchase_order_number]
end

Instance Attribute Details

#amazon_order_id ⇒ Object

An Amazon-defined order identifier, in 3-7-7 format.



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

def amazon_order_id
  @amazon_order_id
end

#buyer_county ⇒ Object

The county of the buyer.



25
26
27
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 25

def buyer_county
  @buyer_county
end

#buyer_email ⇒ Object

The anonymized email address of the buyer.



19
20
21
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 19

def buyer_email
  @buyer_email
end

#buyer_name ⇒ Object

The buyer name or the recipient name.



22
23
24
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 22

def buyer_name
  @buyer_name
end

#buyer_tax_info ⇒ Object

Returns the value of attribute buyer_tax_info.



27
28
29
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 27

def buyer_tax_info
  @buyer_tax_info
end

#purchase_order_number ⇒ Object

The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout.



30
31
32
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 30

def purchase_order_number
  @purchase_order_number
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 33

def self.attribute_map
  {
    'amazon_order_id': :AmazonOrderId,
    'buyer_email': :BuyerEmail,
    'buyer_name': :BuyerName,
    'buyer_county': :BuyerCounty,
    'buyer_tax_info': :BuyerTaxInfo,
    'purchase_order_number': :PurchaseOrderNumber
  }
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



134
135
136
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 134

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 45

def self.openapi_types
  {
    'amazon_order_id': :Object,
    'buyer_email': :Object,
    'buyer_name': :Object,
    'buyer_county': :Object,
    'buyer_tax_info': :Object,
    'purchase_order_number': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 107

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

  self.class == other.class &&
    amazon_order_id == other.amazon_order_id &&
    buyer_email == other.buyer_email &&
    buyer_name == other.buyer_name &&
    buyer_county == other.buyer_county &&
    buyer_tax_info == other.buyer_tax_info &&
    purchase_order_number == other.purchase_order_number
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



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
193
194
195
196
197
198
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 163

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



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 232

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 141

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


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

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



127
128
129
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 127

def hash
  [amazon_order_id, buyer_email, buyer_name, buyer_county, buyer_tax_info, purchase_order_number].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



90
91
92
93
94
95
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 90

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



208
209
210
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 208

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



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/orders_api_model/models/order_buyer_info.rb', line 214

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



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

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

def valid?
  return false if @amazon_order_id.nil?

  true
end