Class: AmznSpApi::FinancesApiModel::AffordabilityExpenseEvent

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

Overview

An expense related to an affordability promotion.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AffordabilityExpenseEvent

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
87
88
89
90
91
92
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 63

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

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

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

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

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

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

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

  return unless attributes.key?(:total_expense)

  self.total_expense = attributes[:total_expense]
end

Instance Attribute Details

#amazon_order_id ⇒ Object

An Amazon-defined identifier for an order.



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

def amazon_order_id
  @amazon_order_id
end

#base_expense ⇒ Object

Returns the value of attribute base_expense.



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

def base_expense
  @base_expense
end

#marketplace_id ⇒ Object

An encrypted, Amazon-defined marketplace identifier.



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

def marketplace_id
  @marketplace_id
end

#posted_date ⇒ Object

Returns the value of attribute posted_date.



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

def posted_date
  @posted_date
end

#tax_type_cgst ⇒ Object

Returns the value of attribute tax_type_cgst.



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

def tax_type_cgst
  @tax_type_cgst
end

#tax_type_igst ⇒ Object

Returns the value of attribute tax_type_igst.



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

def tax_type_igst
  @tax_type_igst
end

#tax_type_sgst ⇒ Object

Returns the value of attribute tax_type_sgst.



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

def tax_type_sgst
  @tax_type_sgst
end

#total_expense ⇒ Object

Returns the value of attribute total_expense.



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

def total_expense
  @total_expense
end

#transaction_type ⇒ Object

Indicates the type of transaction. Possible values: * Charge - For an affordability promotion expense. * Refund - For an affordability promotion expense reversal.



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

def transaction_type
  @transaction_type
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 27

def self.attribute_map
  {
    'amazon_order_id': :AmazonOrderId,
    'posted_date': :PostedDate,
    'marketplace_id': :MarketplaceId,
    'transaction_type': :TransactionType,
    'base_expense': :BaseExpense,
    'tax_type_cgst': :TaxTypeCGST,
    'tax_type_sgst': :TaxTypeSGST,
    'tax_type_igst': :TaxTypeIGST,
    'total_expense': :TotalExpense
  }
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



149
150
151
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 149

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/finances_api_model/models/affordability_expense_event.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 42

def self.openapi_types
  {
    'amazon_order_id': :Object,
    'posted_date': :Object,
    'marketplace_id': :Object,
    'transaction_type': :Object,
    'base_expense': :Object,
    'tax_type_cgst': :Object,
    'tax_type_sgst': :Object,
    'tax_type_igst': :Object,
    'total_expense': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 119

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

  self.class == other.class &&
    amazon_order_id == other.amazon_order_id &&
    posted_date == other.posted_date &&
    marketplace_id == other.marketplace_id &&
    transaction_type == other.transaction_type &&
    base_expense == other.base_expense &&
    tax_type_cgst == other.tax_type_cgst &&
    tax_type_sgst == other.tax_type_sgst &&
    tax_type_igst == other.tax_type_igst &&
    total_expense == other.total_expense
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



178
179
180
181
182
183
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
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 178

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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 247

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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 156

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


136
137
138
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 136

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [amazon_order_id, posted_date, marketplace_id, transaction_type, base_expense, tax_type_cgst, tax_type_sgst, tax_type_igst, total_expense].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



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 96

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

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

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



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

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



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 229

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



217
218
219
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 217

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



109
110
111
112
113
114
115
 
# File 'lib/finances_api_model/models/affordability_expense_event.rb', line 109

def valid?
  return false if @tax_type_cgst.nil?
  return false if @tax_type_sgst.nil?
  return false if @tax_type_igst.nil?

  true
end