Class: AmznSpApi::FinancesApiModel::RetrochargeEvent

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

Overview

A retrocharge or retrocharge reversal.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RetrochargeEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/finances_api_model/models/retrocharge_event.rb', line 59

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

  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.base_tax = attributes[:base_tax] if attributes.key?(:base_tax)

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

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

  return unless attributes.key?(:retrocharge_tax_withheld_list)

  self.retrocharge_tax_withheld_list = attributes[:retrocharge_tax_withheld_list]
end

Instance Attribute Details

#amazon_order_id ⇒ Object

An Amazon-defined identifier for an order.



19
20
21
 
# File 'lib/finances_api_model/models/retrocharge_event.rb', line 19

def amazon_order_id
  @amazon_order_id
end

#base_tax ⇒ Object

Returns the value of attribute base_tax.



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

def base_tax
  @base_tax
end

#marketplace_name ⇒ Object

The name of the marketplace where the retrocharge event occurred.



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

def marketplace_name
  @marketplace_name
end

#posted_date ⇒ Object

Returns the value of attribute posted_date.



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

def posted_date
  @posted_date
end

#retrocharge_event_type ⇒ Object

The type of event. Possible values: * Retrocharge * RetrochargeReversal



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

def retrocharge_event_type
  @retrocharge_event_type
end

#retrocharge_tax_withheld_list ⇒ Object

Returns the value of attribute retrocharge_tax_withheld_list.



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

def retrocharge_tax_withheld_list
  @retrocharge_tax_withheld_list
end

#shipping_tax ⇒ Object

Returns the value of attribute shipping_tax.



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

def shipping_tax
  @shipping_tax
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
 
# File 'lib/finances_api_model/models/retrocharge_event.rb', line 27

def self.attribute_map
  {
    'retrocharge_event_type': :RetrochargeEventType,
    'amazon_order_id': :AmazonOrderId,
    'posted_date': :PostedDate,
    'base_tax': :BaseTax,
    'shipping_tax': :ShippingTax,
    'marketplace_name': :MarketplaceName,
    'retrocharge_tax_withheld_list': :RetrochargeTaxWithheldList
  }
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/finances_api_model/models/retrocharge_event.rb', line 128

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



53
54
55
 
# File 'lib/finances_api_model/models/retrocharge_event.rb', line 53

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    'retrocharge_event_type': :Object,
    'amazon_order_id': :Object,
    'posted_date': :Object,
    'base_tax': :Object,
    'shipping_tax': :Object,
    'marketplace_name': :Object,
    'retrocharge_tax_withheld_list': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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

  self.class == other.class &&
    retrocharge_event_type == other.retrocharge_event_type &&
    amazon_order_id == other.amazon_order_id &&
    posted_date == other.posted_date &&
    base_tax == other.base_tax &&
    shipping_tax == other.shipping_tax &&
    marketplace_name == other.marketplace_name &&
    retrocharge_tax_withheld_list == other.retrocharge_tax_withheld_list
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/finances_api_model/models/retrocharge_event.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::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



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/finances_api_model/models/retrocharge_event.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/finances_api_model/models/retrocharge_event.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/finances_api_model/models/retrocharge_event.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



121
122
123
 
# File 'lib/finances_api_model/models/retrocharge_event.rb', line 121

def hash
  [retrocharge_event_type, amazon_order_id, posted_date, base_tax, shipping_tax, marketplace_name, retrocharge_tax_withheld_list].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



88
89
90
 
# File 'lib/finances_api_model/models/retrocharge_event.rb', line 88

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



202
203
204
 
# File 'lib/finances_api_model/models/retrocharge_event.rb', line 202

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



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/finances_api_model/models/retrocharge_event.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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



196
197
198
 
# File 'lib/finances_api_model/models/retrocharge_event.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



94
95
96
 
# File 'lib/finances_api_model/models/retrocharge_event.rb', line 94

def valid?
  true
end