Class: AmznSpApi::FinancesApiModel::PayWithAmazonEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/finances_api_model/models/pay_with_amazon_event.rb

Overview

An event related to the seller’s Pay with Amazon account.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayWithAmazonEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 77

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:store_name)

  self.store_name = attributes[:store_name]
end

Instance Attribute Details

#amount_description ⇒ Object

A short description of this payment event.



30
31
32
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 30

def amount_description
  @amount_description
end

#business_object_type ⇒ Object

The type of business object.



21
22
23
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 21

def business_object_type
  @business_object_type
end

#charge ⇒ Object

Returns the value of attribute charge.



18
19
20
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 18

def charge
  @charge
end

#fee_list ⇒ Object

Returns the value of attribute fee_list.



18
19
20
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 18

def fee_list
  @fee_list
end

#fulfillment_channel ⇒ Object

The fulfillment channel. Possible values: * AFN - Amazon Fulfillment Network (Fulfillment by Amazon) * MFN - Merchant Fulfillment Network (self-fulfilled)



33
34
35
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 33

def fulfillment_channel
  @fulfillment_channel
end

#payment_amount_type ⇒ Object

The type of payment. Possible values: * Sales



27
28
29
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 27

def payment_amount_type
  @payment_amount_type
end

#sales_channel ⇒ Object

The sales channel for the transaction.



24
25
26
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 24

def sales_channel
  @sales_channel
end

#seller_order_id ⇒ Object

An order identifier that is specified by the seller.



16
17
18
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 16

def seller_order_id
  @seller_order_id
end

#store_name ⇒ Object

The store name where the event occurred.



36
37
38
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 36

def store_name
  @store_name
end

#transaction_posted_date ⇒ Object

Returns the value of attribute transaction_posted_date.



18
19
20
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 18

def transaction_posted_date
  @transaction_posted_date
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 39

def self.attribute_map
  {
    'seller_order_id': :SellerOrderId,
    'transaction_posted_date': :TransactionPostedDate,
    'business_object_type': :BusinessObjectType,
    'sales_channel': :SalesChannel,
    'charge': :Charge,
    'fee_list': :FeeList,
    'payment_amount_type': :PaymentAmountType,
    'amount_description': :AmountDescription,
    'fulfillment_channel': :FulfillmentChannel,
    'store_name': :StoreName
  }
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



155
156
157
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 155

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 55

def self.openapi_types
  {
    'seller_order_id': :Object,
    'transaction_posted_date': :Object,
    'business_object_type': :Object,
    'sales_channel': :Object,
    'charge': :Object,
    'fee_list': :Object,
    'payment_amount_type': :Object,
    'amount_description': :Object,
    'fulfillment_channel': :Object,
    'store_name': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 124

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

  self.class == other.class &&
    seller_order_id == other.seller_order_id &&
    transaction_posted_date == other.transaction_posted_date &&
    business_object_type == other.business_object_type &&
    sales_channel == other.sales_channel &&
    charge == other.charge &&
    fee_list == other.fee_list &&
    payment_amount_type == other.payment_amount_type &&
    amount_description == other.amount_description &&
    fulfillment_channel == other.fulfillment_channel &&
    store_name == other.store_name
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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 184

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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 253

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 162

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


142
143
144
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 142

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



148
149
150
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 148

def hash
  [seller_order_id, transaction_posted_date, business_object_type, sales_channel, charge, fee_list, payment_amount_type, amount_description, fulfillment_channel, store_name].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



112
113
114
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 112

def list_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



229
230
231
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 229

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



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 235

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



223
224
225
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 223

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



118
119
120
 
# File 'lib/finances_api_model/models/pay_with_amazon_event.rb', line 118

def valid?
  true
end