Class: AmznSpApi::FinancesApiModel::RentalTransactionEvent

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

Overview

An event related to a rental transaction.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RentalTransactionEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
93
94
95
96
97
98
99
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 68

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

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

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

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

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

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

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

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

  return unless attributes.key?(:rental_tax_withheld_list)

  self.rental_tax_withheld_list = attributes[:rental_tax_withheld_list]
end

Instance Attribute Details

#amazon_order_id ⇒ Object

An Amazon-defined identifier for an order.



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

def amazon_order_id
  @amazon_order_id
end

#extension_length ⇒ Object

The number of days that the buyer extended an already rented item. This value is only returned for RentalCustomerPayment-Extension and RentalCustomerRefund-Extension events.



22
23
24
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 22

def extension_length
  @extension_length
end

#marketplace_name ⇒ Object

The name of the marketplace.



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

def marketplace_name
  @marketplace_name
end

#posted_date ⇒ Object

Returns the value of attribute posted_date.



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

def posted_date
  @posted_date
end

#rental_charge_list ⇒ Object

Returns the value of attribute rental_charge_list.



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

def rental_charge_list
  @rental_charge_list
end

#rental_event_type ⇒ Object

The type of rental event. Possible values: * RentalCustomerPayment-Buyout - Transaction type that represents when the customer wants to buy out a rented item. * RentalCustomerPayment-Extension - Transaction type that represents when the customer wants to extend the rental period. * RentalCustomerRefund-Buyout - Transaction type that represents when the customer requests a refund for the buyout of the rented item. * RentalCustomerRefund-Extension - Transaction type that represents when the customer requests a refund over the extension on the rented item. * RentalHandlingFee - Transaction type that represents the fee that Amazon charges sellers who rent through Amazon. * RentalChargeFailureReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a failed charge. * RentalLostItemReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a lost item.



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

def rental_event_type
  @rental_event_type
end

#rental_fee_list ⇒ Object

Returns the value of attribute rental_fee_list.



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

def rental_fee_list
  @rental_fee_list
end

#rental_initial_value ⇒ Object

Returns the value of attribute rental_initial_value.



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

def rental_initial_value
  @rental_initial_value
end

#rental_reimbursement ⇒ Object

Returns the value of attribute rental_reimbursement.



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

def rental_reimbursement
  @rental_reimbursement
end

#rental_tax_withheld_list ⇒ Object

Returns the value of attribute rental_tax_withheld_list.



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

def rental_tax_withheld_list
  @rental_tax_withheld_list
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 30

def self.attribute_map
  {
    'amazon_order_id': :AmazonOrderId,
    'rental_event_type': :RentalEventType,
    'extension_length': :ExtensionLength,
    'posted_date': :PostedDate,
    'rental_charge_list': :RentalChargeList,
    'rental_fee_list': :RentalFeeList,
    'marketplace_name': :MarketplaceName,
    'rental_initial_value': :RentalInitialValue,
    'rental_reimbursement': :RentalReimbursement,
    'rental_tax_withheld_list': :RentalTaxWithheldList
  }
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



146
147
148
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 146

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 46

def self.openapi_types
  {
    'amazon_order_id': :Object,
    'rental_event_type': :Object,
    'extension_length': :Object,
    'posted_date': :Object,
    'rental_charge_list': :Object,
    'rental_fee_list': :Object,
    'marketplace_name': :Object,
    'rental_initial_value': :Object,
    'rental_reimbursement': :Object,
    'rental_tax_withheld_list': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 115

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

  self.class == other.class &&
    amazon_order_id == other.amazon_order_id &&
    rental_event_type == other.rental_event_type &&
    extension_length == other.extension_length &&
    posted_date == other.posted_date &&
    rental_charge_list == other.rental_charge_list &&
    rental_fee_list == other.rental_fee_list &&
    marketplace_name == other.marketplace_name &&
    rental_initial_value == other.rental_initial_value &&
    rental_reimbursement == other.rental_reimbursement &&
    rental_tax_withheld_list == other.rental_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



175
176
177
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
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 175

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



244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 244

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 153

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


133
134
135
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 133

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



139
140
141
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 139

def hash
  [amazon_order_id, rental_event_type, extension_length, posted_date, rental_charge_list, rental_fee_list, marketplace_name, rental_initial_value, rental_reimbursement, rental_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



103
104
105
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 103

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



220
221
222
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 220

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



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

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



214
215
216
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 214

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
 
# File 'lib/finances_api_model/models/rental_transaction_event.rb', line 109

def valid?
  true
end