lithic 0.1.0.pre.alpha.55 → 0.1.0.pre.alpha.56

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (196) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/client.rb +4 -0
  5. data/lib/lithic/models/account_activity_list_response.rb +60 -148
  6. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +60 -151
  7. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +8 -51
  8. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +8 -51
  9. data/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb +260 -0
  10. data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +8 -53
  11. data/lib/lithic/models/auth_rules/conditional_operation.rb +26 -0
  12. data/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb +254 -0
  13. data/lib/lithic/models/auth_rules/conditional_value.rb +27 -0
  14. data/lib/lithic/models/auth_rules/v2_create_params.rb +14 -5
  15. data/lib/lithic/models/auth_rules/v2_create_response.rb +21 -8
  16. data/lib/lithic/models/auth_rules/v2_draft_params.rb +7 -3
  17. data/lib/lithic/models/auth_rules/v2_draft_response.rb +21 -8
  18. data/lib/lithic/models/auth_rules/v2_list_params.rb +3 -0
  19. data/lib/lithic/models/auth_rules/v2_list_response.rb +21 -8
  20. data/lib/lithic/models/auth_rules/v2_promote_response.rb +21 -8
  21. data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +21 -8
  22. data/lib/lithic/models/auth_rules/v2_update_response.rb +21 -8
  23. data/lib/lithic/models/book_transfer_response.rb +1 -0
  24. data/lib/lithic/models/category_details.rb +27 -0
  25. data/lib/lithic/models/dispute.rb +242 -510
  26. data/lib/lithic/models/dispute_v2.rb +555 -0
  27. data/lib/lithic/models/disputes_v2_list_params.rb +84 -0
  28. data/lib/lithic/models/disputes_v2_retrieve_params.rb +14 -0
  29. data/lib/lithic/models/external_bank_account_address.rb +2 -2
  30. data/lib/lithic/models/external_bank_account_create_response.rb +18 -18
  31. data/lib/lithic/models/external_bank_account_list_response.rb +18 -18
  32. data/lib/lithic/models/external_bank_account_retrieve_response.rb +18 -18
  33. data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +18 -18
  34. data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +18 -18
  35. data/lib/lithic/models/external_bank_account_unpause_params.rb +14 -0
  36. data/lib/lithic/models/external_bank_account_unpause_response.rb +242 -0
  37. data/lib/lithic/models/external_bank_account_update_response.rb +18 -18
  38. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +18 -18
  39. data/lib/lithic/models/external_payment.rb +3 -2
  40. data/lib/lithic/models/external_payment_list_params.rb +1 -0
  41. data/lib/lithic/models/financial_account.rb +4 -3
  42. data/lib/lithic/models/financial_accounts/category_balances.rb +29 -0
  43. data/lib/lithic/models/financial_accounts/loan_tape.rb +35 -520
  44. data/lib/lithic/models/financial_accounts/statement.rb +73 -275
  45. data/lib/lithic/models/financial_event.rb +148 -0
  46. data/lib/lithic/models/financial_transaction.rb +3 -146
  47. data/lib/lithic/models/management_operation_list_params.rb +1 -0
  48. data/lib/lithic/models/management_operation_transaction.rb +5 -4
  49. data/lib/lithic/models/merchant.rb +70 -0
  50. data/lib/lithic/models/payment.rb +7 -5
  51. data/lib/lithic/models/payment_return_params.rb +62 -0
  52. data/lib/lithic/models/statement_totals.rb +100 -0
  53. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +9 -9
  54. data/lib/lithic/models/transaction.rb +3 -69
  55. data/lib/lithic/models/transactions/events/enhanced_data.rb +49 -40
  56. data/lib/lithic/models/transfer.rb +3 -146
  57. data/lib/lithic/models.rb +18 -0
  58. data/lib/lithic/resources/auth_rules/v2.rb +2 -2
  59. data/lib/lithic/resources/disputes.rb +10 -10
  60. data/lib/lithic/resources/disputes_v2.rb +74 -0
  61. data/lib/lithic/resources/external_bank_accounts.rb +19 -0
  62. data/lib/lithic/resources/payments.rb +48 -0
  63. data/lib/lithic/version.rb +1 -1
  64. data/lib/lithic.rb +16 -5
  65. data/rbi/lithic/client.rbi +3 -0
  66. data/rbi/lithic/models/account_activity_list_response.rbi +121 -544
  67. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +121 -544
  68. data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +13 -139
  69. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +13 -153
  70. data/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi +789 -0
  71. data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +13 -153
  72. data/rbi/lithic/models/auth_rules/conditional_operation.rbi +74 -0
  73. data/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi +674 -0
  74. data/rbi/lithic/models/auth_rules/conditional_value.rbi +28 -0
  75. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +33 -7
  76. data/rbi/lithic/models/auth_rules/v2_create_response.rbi +33 -7
  77. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +12 -4
  78. data/rbi/lithic/models/auth_rules/v2_draft_response.rbi +33 -7
  79. data/rbi/lithic/models/auth_rules/v2_list_params.rbi +15 -0
  80. data/rbi/lithic/models/auth_rules/v2_list_response.rbi +33 -7
  81. data/rbi/lithic/models/auth_rules/v2_promote_response.rbi +33 -7
  82. data/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi +33 -7
  83. data/rbi/lithic/models/auth_rules/v2_update_response.rbi +33 -7
  84. data/rbi/lithic/models/book_transfer_response.rbi +2 -0
  85. data/rbi/lithic/models/category_details.rbi +43 -0
  86. data/rbi/lithic/models/dispute.rbi +395 -942
  87. data/rbi/lithic/models/dispute_v2.rbi +965 -0
  88. data/rbi/lithic/models/disputes_v2_list_params.rbi +129 -0
  89. data/rbi/lithic/models/disputes_v2_retrieve_params.rbi +27 -0
  90. data/rbi/lithic/models/external_bank_account_address.rbi +3 -6
  91. data/rbi/lithic/models/external_bank_account_create_response.rbi +31 -51
  92. data/rbi/lithic/models/external_bank_account_list_response.rbi +31 -51
  93. data/rbi/lithic/models/external_bank_account_retrieve_response.rbi +31 -51
  94. data/rbi/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +31 -51
  95. data/rbi/lithic/models/external_bank_account_retry_prenote_response.rbi +31 -51
  96. data/rbi/lithic/models/external_bank_account_unpause_params.rbi +30 -0
  97. data/rbi/lithic/models/external_bank_account_unpause_response.rbi +375 -0
  98. data/rbi/lithic/models/external_bank_account_update_response.rbi +31 -51
  99. data/rbi/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +31 -51
  100. data/rbi/lithic/models/external_payment.rbi +5 -6
  101. data/rbi/lithic/models/external_payment_list_params.rbi +5 -0
  102. data/rbi/lithic/models/financial_account.rbi +12 -4
  103. data/rbi/lithic/models/financial_accounts/category_balances.rbi +42 -0
  104. data/rbi/lithic/models/financial_accounts/loan_tape.rbi +47 -802
  105. data/rbi/lithic/models/financial_accounts/statement.rbi +118 -430
  106. data/rbi/lithic/models/financial_event.rbi +409 -0
  107. data/rbi/lithic/models/financial_transaction.rbi +3 -509
  108. data/rbi/lithic/models/management_operation_list_params.rbi +5 -0
  109. data/rbi/lithic/models/management_operation_transaction.rbi +11 -12
  110. data/rbi/lithic/models/merchant.rbi +89 -0
  111. data/rbi/lithic/models/payment.rbi +16 -7
  112. data/rbi/lithic/models/payment_return_params.rbi +85 -0
  113. data/rbi/lithic/models/statement_totals.rbi +128 -0
  114. data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +12 -12
  115. data/rbi/lithic/models/transaction.rbi +4 -90
  116. data/rbi/lithic/models/transactions/events/enhanced_data.rbi +74 -133
  117. data/rbi/lithic/models/transfer.rbi +4 -436
  118. data/rbi/lithic/models.rbi +19 -0
  119. data/rbi/lithic/resources/auth_rules/v2.rbi +8 -3
  120. data/rbi/lithic/resources/disputes.rbi +5 -7
  121. data/rbi/lithic/resources/disputes_v2.rbi +64 -0
  122. data/rbi/lithic/resources/external_bank_accounts.rbi +10 -0
  123. data/rbi/lithic/resources/payments.rbi +46 -0
  124. data/sig/lithic/client.rbs +2 -0
  125. data/sig/lithic/models/account_activity_list_response.rbs +67 -221
  126. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +67 -221
  127. data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +10 -61
  128. data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +10 -61
  129. data/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs +293 -0
  130. data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +10 -61
  131. data/sig/lithic/models/auth_rules/conditional_operation.rbs +34 -0
  132. data/sig/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbs +237 -0
  133. data/sig/lithic/models/auth_rules/conditional_value.rbs +15 -0
  134. data/sig/lithic/models/auth_rules/v2_create_params.rbs +11 -1
  135. data/sig/lithic/models/auth_rules/v2_create_response.rbs +13 -1
  136. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +2 -0
  137. data/sig/lithic/models/auth_rules/v2_draft_response.rbs +13 -1
  138. data/sig/lithic/models/auth_rules/v2_list_params.rbs +9 -1
  139. data/sig/lithic/models/auth_rules/v2_list_response.rbs +13 -1
  140. data/sig/lithic/models/auth_rules/v2_promote_response.rbs +13 -1
  141. data/sig/lithic/models/auth_rules/v2_retrieve_response.rbs +13 -1
  142. data/sig/lithic/models/auth_rules/v2_update_response.rbs +13 -1
  143. data/sig/lithic/models/book_transfer_response.rbs +3 -1
  144. data/sig/lithic/models/category_details.rbs +26 -0
  145. data/sig/lithic/models/dispute.rbs +157 -417
  146. data/sig/lithic/models/dispute_v2.rbs +438 -0
  147. data/sig/lithic/models/disputes_v2_list_params.rbs +77 -0
  148. data/sig/lithic/models/disputes_v2_retrieve_params.rbs +15 -0
  149. data/sig/lithic/models/external_bank_account_address.rbs +4 -6
  150. data/sig/lithic/models/external_bank_account_create_response.rbs +36 -56
  151. data/sig/lithic/models/external_bank_account_list_response.rbs +36 -56
  152. data/sig/lithic/models/external_bank_account_retrieve_response.rbs +36 -56
  153. data/sig/lithic/models/external_bank_account_retry_micro_deposits_response.rbs +36 -56
  154. data/sig/lithic/models/external_bank_account_retry_prenote_response.rbs +36 -56
  155. data/sig/lithic/models/external_bank_account_unpause_params.rbs +15 -0
  156. data/sig/lithic/models/external_bank_account_unpause_response.rbs +162 -0
  157. data/sig/lithic/models/external_bank_account_update_response.rbs +36 -56
  158. data/sig/lithic/models/external_bank_accounts/micro_deposit_create_response.rbs +36 -56
  159. data/sig/lithic/models/external_payment.rbs +7 -7
  160. data/sig/lithic/models/external_payment_list_params.rbs +3 -1
  161. data/sig/lithic/models/financial_account.rbs +4 -4
  162. data/sig/lithic/models/financial_accounts/category_balances.rbs +24 -0
  163. data/sig/lithic/models/financial_accounts/loan_tape.rbs +48 -464
  164. data/sig/lithic/models/financial_accounts/statement.rbs +59 -244
  165. data/sig/lithic/models/financial_event.rbs +216 -0
  166. data/sig/lithic/models/financial_transaction.rbs +4 -217
  167. data/sig/lithic/models/management_operation_list_params.rbs +3 -1
  168. data/sig/lithic/models/management_operation_transaction.rbs +11 -13
  169. data/sig/lithic/models/merchant.rbs +50 -0
  170. data/sig/lithic/models/payment.rbs +9 -5
  171. data/sig/lithic/models/payment_return_params.rbs +46 -0
  172. data/sig/lithic/models/statement_totals.rbs +76 -0
  173. data/sig/lithic/models/transaction.rbs +4 -51
  174. data/sig/lithic/models/transactions/events/enhanced_data.rbs +78 -124
  175. data/sig/lithic/models/transfer.rbs +6 -219
  176. data/sig/lithic/models.rbs +18 -0
  177. data/sig/lithic/resources/disputes.rbs +5 -5
  178. data/sig/lithic/resources/disputes_v2.rbs +24 -0
  179. data/sig/lithic/resources/external_bank_accounts.rbs +5 -0
  180. data/sig/lithic/resources/payments.rbs +10 -0
  181. metadata +50 -17
  182. data/lib/lithic/models/dispute_create_response.rb +0 -326
  183. data/lib/lithic/models/dispute_delete_response.rb +0 -326
  184. data/lib/lithic/models/dispute_list_response.rb +0 -326
  185. data/lib/lithic/models/dispute_retrieve_response.rb +0 -326
  186. data/lib/lithic/models/dispute_update_response.rb +0 -326
  187. data/rbi/lithic/models/dispute_create_response.rbi +0 -599
  188. data/rbi/lithic/models/dispute_delete_response.rbi +0 -599
  189. data/rbi/lithic/models/dispute_list_response.rbi +0 -582
  190. data/rbi/lithic/models/dispute_retrieve_response.rbi +0 -601
  191. data/rbi/lithic/models/dispute_update_response.rbi +0 -599
  192. data/sig/lithic/models/dispute_create_response.rbs +0 -210
  193. data/sig/lithic/models/dispute_delete_response.rbs +0 -210
  194. data/sig/lithic/models/dispute_list_response.rbs +0 -210
  195. data/sig/lithic/models/dispute_retrieve_response.rbs +0 -210
  196. data/sig/lithic/models/dispute_update_response.rbs +0 -210
@@ -72,8 +72,8 @@ module Lithic
72
72
 
73
73
  # @!attribute period_totals
74
74
  #
75
- # @return [Lithic::Models::FinancialAccounts::Statement::PeriodTotals]
76
- required :period_totals, -> { Lithic::FinancialAccounts::Statement::PeriodTotals }
75
+ # @return [Lithic::Models::StatementTotals]
76
+ required :period_totals, -> { Lithic::StatementTotals }
77
77
 
78
78
  # @!attribute starting_balance
79
79
  # Balance at the start of the billing period
@@ -106,8 +106,8 @@ module Lithic
106
106
 
107
107
  # @!attribute ytd_totals
108
108
  #
109
- # @return [Lithic::Models::FinancialAccounts::Statement::YtdTotals]
110
- required :ytd_totals, -> { Lithic::FinancialAccounts::Statement::YtdTotals }
109
+ # @return [Lithic::Models::StatementTotals]
110
+ required :ytd_totals, -> { Lithic::StatementTotals }
111
111
 
112
112
  # @!attribute interest_details
113
113
  #
@@ -126,7 +126,13 @@ module Lithic
126
126
  # @return [Date, nil]
127
127
  optional :next_statement_end_date, Date
128
128
 
129
- # @!method initialize(token:, account_standing:, amount_due:, available_credit:, created:, credit_limit:, credit_product_token:, days_in_billing_cycle:, ending_balance:, financial_account_token:, payment_due_date:, period_totals:, starting_balance:, statement_end_date:, statement_start_date:, statement_type:, updated:, ytd_totals:, interest_details: nil, next_payment_due_date: nil, next_statement_end_date: nil)
129
+ # @!attribute payoff_details
130
+ # Details on number and size of payments to pay off balance
131
+ #
132
+ # @return [Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil]
133
+ optional :payoff_details, -> { Lithic::FinancialAccounts::Statement::PayoffDetails }, nil?: true
134
+
135
+ # @!method initialize(token:, account_standing:, amount_due:, available_credit:, created:, credit_limit:, credit_product_token:, days_in_billing_cycle:, ending_balance:, financial_account_token:, payment_due_date:, period_totals:, starting_balance:, statement_end_date:, statement_start_date:, statement_type:, updated:, ytd_totals:, interest_details: nil, next_payment_due_date: nil, next_statement_end_date: nil, payoff_details: nil)
130
136
  # Some parameter documentations has been truncated, see
131
137
  # {Lithic::Models::FinancialAccounts::Statement} for more details.
132
138
  #
@@ -152,7 +158,7 @@ module Lithic
152
158
  #
153
159
  # @param payment_due_date [Date, nil] Date when the payment is due
154
160
  #
155
- # @param period_totals [Lithic::Models::FinancialAccounts::Statement::PeriodTotals]
161
+ # @param period_totals [Lithic::Models::StatementTotals]
156
162
  #
157
163
  # @param starting_balance [Integer] Balance at the start of the billing period
158
164
  #
@@ -164,13 +170,15 @@ module Lithic
164
170
  #
165
171
  # @param updated [Time] Timestamp of when the statement was updated
166
172
  #
167
- # @param ytd_totals [Lithic::Models::FinancialAccounts::Statement::YtdTotals]
173
+ # @param ytd_totals [Lithic::Models::StatementTotals]
168
174
  #
169
175
  # @param interest_details [Lithic::Models::FinancialAccounts::Statement::InterestDetails, nil]
170
176
  #
171
177
  # @param next_payment_due_date [Date] Date when the next payment is due
172
178
  #
173
179
  # @param next_statement_end_date [Date] Date when the next billing period will end
180
+ #
181
+ # @param payoff_details [Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil] Details on number and size of payments to pay off balance
174
182
 
175
183
  # @see Lithic::Models::FinancialAccounts::Statement#account_standing
176
184
  class AccountStanding < Lithic::Internal::Type::BaseModel
@@ -336,102 +344,6 @@ module Lithic
336
344
  # @param past_due [Integer] Amount past due for statement in cents
337
345
  end
338
346
 
339
- # @see Lithic::Models::FinancialAccounts::Statement#period_totals
340
- class PeriodTotals < Lithic::Internal::Type::BaseModel
341
- # @!attribute balance_transfers
342
- # Opening balance transferred from previous account in cents
343
- #
344
- # @return [Integer]
345
- required :balance_transfers, Integer
346
-
347
- # @!attribute cash_advances
348
- # ATM and cashback transactions in cents
349
- #
350
- # @return [Integer]
351
- required :cash_advances, Integer
352
-
353
- # @!attribute credits
354
- # Volume of credit management operation transactions less any balance transfers in
355
- # cents
356
- #
357
- # @return [Integer]
358
- required :credits, Integer
359
-
360
- # @!attribute debits
361
- # Volume of debit management operation transactions less any interest in cents
362
- #
363
- # @return [Integer]
364
- required :debits, Integer
365
-
366
- # @!attribute fees
367
- # Volume of debit management operation transactions less any interest in cents
368
- #
369
- # @return [Integer]
370
- required :fees, Integer
371
-
372
- # @!attribute interest
373
- # Interest accrued in cents
374
- #
375
- # @return [Integer]
376
- required :interest, Integer
377
-
378
- # @!attribute payments
379
- # Any funds transfers which affective the balance in cents
380
- #
381
- # @return [Integer]
382
- required :payments, Integer
383
-
384
- # @!attribute purchases
385
- # Net card transaction volume less any cash advances in cents
386
- #
387
- # @return [Integer]
388
- required :purchases, Integer
389
-
390
- # @!attribute credit_details
391
- # Breakdown of credits
392
- #
393
- # @return [Object, nil]
394
- optional :credit_details, Lithic::Internal::Type::Unknown
395
-
396
- # @!attribute debit_details
397
- # Breakdown of debits
398
- #
399
- # @return [Object, nil]
400
- optional :debit_details, Lithic::Internal::Type::Unknown
401
-
402
- # @!attribute payment_details
403
- # Breakdown of payments
404
- #
405
- # @return [Object, nil]
406
- optional :payment_details, Lithic::Internal::Type::Unknown
407
-
408
- # @!method initialize(balance_transfers:, cash_advances:, credits:, debits:, fees:, interest:, payments:, purchases:, credit_details: nil, debit_details: nil, payment_details: nil)
409
- # Some parameter documentations has been truncated, see
410
- # {Lithic::Models::FinancialAccounts::Statement::PeriodTotals} for more details.
411
- #
412
- # @param balance_transfers [Integer] Opening balance transferred from previous account in cents
413
- #
414
- # @param cash_advances [Integer] ATM and cashback transactions in cents
415
- #
416
- # @param credits [Integer] Volume of credit management operation transactions less any balance transfers in
417
- #
418
- # @param debits [Integer] Volume of debit management operation transactions less any interest in cents
419
- #
420
- # @param fees [Integer] Volume of debit management operation transactions less any interest in cents
421
- #
422
- # @param interest [Integer] Interest accrued in cents
423
- #
424
- # @param payments [Integer] Any funds transfers which affective the balance in cents
425
- #
426
- # @param purchases [Integer] Net card transaction volume less any cash advances in cents
427
- #
428
- # @param credit_details [Object] Breakdown of credits
429
- #
430
- # @param debit_details [Object] Breakdown of debits
431
- #
432
- # @param payment_details [Object] Breakdown of payments
433
- end
434
-
435
347
  # @see Lithic::Models::FinancialAccounts::Statement#statement_type
436
348
  module StatementType
437
349
  extend Lithic::Internal::Type::Enum
@@ -444,102 +356,6 @@ module Lithic
444
356
  # @return [Array<Symbol>]
445
357
  end
446
358
 
447
- # @see Lithic::Models::FinancialAccounts::Statement#ytd_totals
448
- class YtdTotals < Lithic::Internal::Type::BaseModel
449
- # @!attribute balance_transfers
450
- # Opening balance transferred from previous account in cents
451
- #
452
- # @return [Integer]
453
- required :balance_transfers, Integer
454
-
455
- # @!attribute cash_advances
456
- # ATM and cashback transactions in cents
457
- #
458
- # @return [Integer]
459
- required :cash_advances, Integer
460
-
461
- # @!attribute credits
462
- # Volume of credit management operation transactions less any balance transfers in
463
- # cents
464
- #
465
- # @return [Integer]
466
- required :credits, Integer
467
-
468
- # @!attribute debits
469
- # Volume of debit management operation transactions less any interest in cents
470
- #
471
- # @return [Integer]
472
- required :debits, Integer
473
-
474
- # @!attribute fees
475
- # Volume of debit management operation transactions less any interest in cents
476
- #
477
- # @return [Integer]
478
- required :fees, Integer
479
-
480
- # @!attribute interest
481
- # Interest accrued in cents
482
- #
483
- # @return [Integer]
484
- required :interest, Integer
485
-
486
- # @!attribute payments
487
- # Any funds transfers which affective the balance in cents
488
- #
489
- # @return [Integer]
490
- required :payments, Integer
491
-
492
- # @!attribute purchases
493
- # Net card transaction volume less any cash advances in cents
494
- #
495
- # @return [Integer]
496
- required :purchases, Integer
497
-
498
- # @!attribute credit_details
499
- # Breakdown of credits
500
- #
501
- # @return [Object, nil]
502
- optional :credit_details, Lithic::Internal::Type::Unknown
503
-
504
- # @!attribute debit_details
505
- # Breakdown of debits
506
- #
507
- # @return [Object, nil]
508
- optional :debit_details, Lithic::Internal::Type::Unknown
509
-
510
- # @!attribute payment_details
511
- # Breakdown of payments
512
- #
513
- # @return [Object, nil]
514
- optional :payment_details, Lithic::Internal::Type::Unknown
515
-
516
- # @!method initialize(balance_transfers:, cash_advances:, credits:, debits:, fees:, interest:, payments:, purchases:, credit_details: nil, debit_details: nil, payment_details: nil)
517
- # Some parameter documentations has been truncated, see
518
- # {Lithic::Models::FinancialAccounts::Statement::YtdTotals} for more details.
519
- #
520
- # @param balance_transfers [Integer] Opening balance transferred from previous account in cents
521
- #
522
- # @param cash_advances [Integer] ATM and cashback transactions in cents
523
- #
524
- # @param credits [Integer] Volume of credit management operation transactions less any balance transfers in
525
- #
526
- # @param debits [Integer] Volume of debit management operation transactions less any interest in cents
527
- #
528
- # @param fees [Integer] Volume of debit management operation transactions less any interest in cents
529
- #
530
- # @param interest [Integer] Interest accrued in cents
531
- #
532
- # @param payments [Integer] Any funds transfers which affective the balance in cents
533
- #
534
- # @param purchases [Integer] Net card transaction volume less any cash advances in cents
535
- #
536
- # @param credit_details [Object] Breakdown of credits
537
- #
538
- # @param debit_details [Object] Breakdown of debits
539
- #
540
- # @param payment_details [Object] Breakdown of payments
541
- end
542
-
543
359
  # @see Lithic::Models::FinancialAccounts::Statement#interest_details
544
360
  class InterestDetails < Lithic::Internal::Type::BaseModel
545
361
  # @!attribute actual_interest_charged
@@ -549,14 +365,13 @@ module Lithic
549
365
 
550
366
  # @!attribute daily_balance_amounts
551
367
  #
552
- # @return [Lithic::Models::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts]
553
- required :daily_balance_amounts,
554
- -> { Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts }
368
+ # @return [Lithic::Models::CategoryDetails]
369
+ required :daily_balance_amounts, -> { Lithic::CategoryDetails }
555
370
 
556
371
  # @!attribute effective_apr
557
372
  #
558
- # @return [Lithic::Models::FinancialAccounts::Statement::InterestDetails::EffectiveApr]
559
- required :effective_apr, -> { Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr }
373
+ # @return [Lithic::Models::CategoryDetails]
374
+ required :effective_apr, -> { Lithic::CategoryDetails }
560
375
 
561
376
  # @!attribute interest_calculation_method
562
377
  #
@@ -566,9 +381,8 @@ module Lithic
566
381
 
567
382
  # @!attribute interest_for_period
568
383
  #
569
- # @return [Lithic::Models::FinancialAccounts::Statement::InterestDetails::InterestForPeriod]
570
- required :interest_for_period,
571
- -> { Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod }
384
+ # @return [Lithic::Models::CategoryDetails]
385
+ required :interest_for_period, -> { Lithic::CategoryDetails }
572
386
 
573
387
  # @!attribute prime_rate
574
388
  #
@@ -582,59 +396,13 @@ module Lithic
582
396
 
583
397
  # @!method initialize(actual_interest_charged:, daily_balance_amounts:, effective_apr:, interest_calculation_method:, interest_for_period:, prime_rate:, minimum_interest_charged: nil)
584
398
  # @param actual_interest_charged [Integer, nil]
585
- # @param daily_balance_amounts [Lithic::Models::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts]
586
- # @param effective_apr [Lithic::Models::FinancialAccounts::Statement::InterestDetails::EffectiveApr]
399
+ # @param daily_balance_amounts [Lithic::Models::CategoryDetails]
400
+ # @param effective_apr [Lithic::Models::CategoryDetails]
587
401
  # @param interest_calculation_method [Symbol, Lithic::Models::FinancialAccounts::Statement::InterestDetails::InterestCalculationMethod]
588
- # @param interest_for_period [Lithic::Models::FinancialAccounts::Statement::InterestDetails::InterestForPeriod]
402
+ # @param interest_for_period [Lithic::Models::CategoryDetails]
589
403
  # @param prime_rate [String, nil]
590
404
  # @param minimum_interest_charged [Integer, nil]
591
405
 
592
- # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#daily_balance_amounts
593
- class DailyBalanceAmounts < Lithic::Internal::Type::BaseModel
594
- # @!attribute balance_transfers
595
- #
596
- # @return [String]
597
- required :balance_transfers, String
598
-
599
- # @!attribute cash_advances
600
- #
601
- # @return [String]
602
- required :cash_advances, String
603
-
604
- # @!attribute purchases
605
- #
606
- # @return [String]
607
- required :purchases, String
608
-
609
- # @!method initialize(balance_transfers:, cash_advances:, purchases:)
610
- # @param balance_transfers [String]
611
- # @param cash_advances [String]
612
- # @param purchases [String]
613
- end
614
-
615
- # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#effective_apr
616
- class EffectiveApr < Lithic::Internal::Type::BaseModel
617
- # @!attribute balance_transfers
618
- #
619
- # @return [String]
620
- required :balance_transfers, String
621
-
622
- # @!attribute cash_advances
623
- #
624
- # @return [String]
625
- required :cash_advances, String
626
-
627
- # @!attribute purchases
628
- #
629
- # @return [String]
630
- required :purchases, String
631
-
632
- # @!method initialize(balance_transfers:, cash_advances:, purchases:)
633
- # @param balance_transfers [String]
634
- # @param cash_advances [String]
635
- # @param purchases [String]
636
- end
637
-
638
406
  # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#interest_calculation_method
639
407
  module InterestCalculationMethod
640
408
  extend Lithic::Internal::Type::Enum
@@ -645,29 +413,59 @@ module Lithic
645
413
  # @!method self.values
646
414
  # @return [Array<Symbol>]
647
415
  end
416
+ end
648
417
 
649
- # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#interest_for_period
650
- class InterestForPeriod < Lithic::Internal::Type::BaseModel
651
- # @!attribute balance_transfers
652
- #
653
- # @return [String]
654
- required :balance_transfers, String
418
+ # @see Lithic::Models::FinancialAccounts::Statement#payoff_details
419
+ class PayoffDetails < Lithic::Internal::Type::BaseModel
420
+ # @!attribute minimum_payment_months
421
+ # The number of months it would take to pay off the balance in full by only paying
422
+ # the minimum payment. "NA" will signal negative or zero amortization
423
+ #
424
+ # @return [String]
425
+ required :minimum_payment_months, String
655
426
 
656
- # @!attribute cash_advances
657
- #
658
- # @return [String]
659
- required :cash_advances, String
427
+ # @!attribute minimum_payment_total
428
+ # The sum of all interest and principal paid, in cents, when only paying minimum
429
+ # monthly payment. "NA" will signal negative or zero amortization
430
+ #
431
+ # @return [String]
432
+ required :minimum_payment_total, String
660
433
 
661
- # @!attribute purchases
662
- #
663
- # @return [String]
664
- required :purchases, String
434
+ # @!attribute payoff_period_length_months
435
+ # Number of months to full pay off
436
+ #
437
+ # @return [Integer]
438
+ required :payoff_period_length_months, Integer
665
439
 
666
- # @!method initialize(balance_transfers:, cash_advances:, purchases:)
667
- # @param balance_transfers [String]
668
- # @param cash_advances [String]
669
- # @param purchases [String]
670
- end
440
+ # @!attribute payoff_period_monthly_payment_amount
441
+ # The amount needed to be paid, in cents, each month in order to pay off current
442
+ # balance in the payoff period
443
+ #
444
+ # @return [Integer]
445
+ required :payoff_period_monthly_payment_amount, Integer
446
+
447
+ # @!attribute payoff_period_payment_total
448
+ # The sum of all interest and principal paid, in cents, when paying off in the
449
+ # payoff period
450
+ #
451
+ # @return [Integer]
452
+ required :payoff_period_payment_total, Integer
453
+
454
+ # @!method initialize(minimum_payment_months:, minimum_payment_total:, payoff_period_length_months:, payoff_period_monthly_payment_amount:, payoff_period_payment_total:)
455
+ # Some parameter documentations has been truncated, see
456
+ # {Lithic::Models::FinancialAccounts::Statement::PayoffDetails} for more details.
457
+ #
458
+ # Details on number and size of payments to pay off balance
459
+ #
460
+ # @param minimum_payment_months [String] The number of months it would take to pay off the balance in full by only paying
461
+ #
462
+ # @param minimum_payment_total [String] The sum of all interest and principal paid, in cents, when only paying minimum m
463
+ #
464
+ # @param payoff_period_length_months [Integer] Number of months to full pay off
465
+ #
466
+ # @param payoff_period_monthly_payment_amount [Integer] The amount needed to be paid, in cents, each month in order to pay off current b
467
+ #
468
+ # @param payoff_period_payment_total [Integer] The sum of all interest and principal paid, in cents, when paying off in the pay
671
469
  end
672
470
  end
673
471
  end
@@ -0,0 +1,148 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ class FinancialEvent < Lithic::Internal::Type::BaseModel
6
+ # @!attribute token
7
+ # Globally unique identifier.
8
+ #
9
+ # @return [String, nil]
10
+ optional :token, String
11
+
12
+ # @!attribute amount
13
+ # Amount of the financial event that has been settled in the currency's smallest
14
+ # unit (e.g., cents).
15
+ #
16
+ # @return [Integer, nil]
17
+ optional :amount, Integer
18
+
19
+ # @!attribute created
20
+ # Date and time when the financial event occurred. UTC time zone.
21
+ #
22
+ # @return [Time, nil]
23
+ optional :created, Time
24
+
25
+ # @!attribute result
26
+ # APPROVED financial events were successful while DECLINED financial events were
27
+ # declined by user, Lithic, or the network.
28
+ #
29
+ # @return [Symbol, Lithic::Models::FinancialEvent::Result, nil]
30
+ optional :result, enum: -> { Lithic::FinancialEvent::Result }
31
+
32
+ # @!attribute type
33
+ #
34
+ # @return [Symbol, Lithic::Models::FinancialEvent::Type, nil]
35
+ optional :type, enum: -> { Lithic::FinancialEvent::Type }
36
+
37
+ # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil)
38
+ # Some parameter documentations has been truncated, see
39
+ # {Lithic::Models::FinancialEvent} for more details.
40
+ #
41
+ # Financial Event
42
+ #
43
+ # @param token [String] Globally unique identifier.
44
+ #
45
+ # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
46
+ #
47
+ # @param created [Time] Date and time when the financial event occurred. UTC time zone.
48
+ #
49
+ # @param result [Symbol, Lithic::Models::FinancialEvent::Result] APPROVED financial events were successful while DECLINED financial events were d
50
+ #
51
+ # @param type [Symbol, Lithic::Models::FinancialEvent::Type]
52
+
53
+ # APPROVED financial events were successful while DECLINED financial events were
54
+ # declined by user, Lithic, or the network.
55
+ #
56
+ # @see Lithic::Models::FinancialEvent#result
57
+ module Result
58
+ extend Lithic::Internal::Type::Enum
59
+
60
+ APPROVED = :APPROVED
61
+ DECLINED = :DECLINED
62
+
63
+ # @!method self.values
64
+ # @return [Array<Symbol>]
65
+ end
66
+
67
+ # @see Lithic::Models::FinancialEvent#type
68
+ module Type
69
+ extend Lithic::Internal::Type::Enum
70
+
71
+ ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED
72
+ ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED
73
+ ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED
74
+ ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED
75
+ ACH_ORIGINATION_REJECTED = :ACH_ORIGINATION_REJECTED
76
+ ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED
77
+ ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED
78
+ ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED
79
+ ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED
80
+ ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED
81
+ ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
82
+ ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
83
+ ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED
84
+ ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED
85
+ AUTHORIZATION = :AUTHORIZATION
86
+ AUTHORIZATION_ADVICE = :AUTHORIZATION_ADVICE
87
+ AUTHORIZATION_EXPIRY = :AUTHORIZATION_EXPIRY
88
+ AUTHORIZATION_REVERSAL = :AUTHORIZATION_REVERSAL
89
+ BALANCE_INQUIRY = :BALANCE_INQUIRY
90
+ BILLING_ERROR = :BILLING_ERROR
91
+ BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL
92
+ CARD_TO_CARD = :CARD_TO_CARD
93
+ CASH_BACK = :CASH_BACK
94
+ CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL
95
+ CLEARING = :CLEARING
96
+ COLLECTION = :COLLECTION
97
+ CORRECTION_CREDIT = :CORRECTION_CREDIT
98
+ CORRECTION_DEBIT = :CORRECTION_DEBIT
99
+ CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION
100
+ CREDIT_AUTHORIZATION_ADVICE = :CREDIT_AUTHORIZATION_ADVICE
101
+ CURRENCY_CONVERSION = :CURRENCY_CONVERSION
102
+ CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL
103
+ DISPUTE_WON = :DISPUTE_WON
104
+ EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED
105
+ EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED
106
+ EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED
107
+ EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED
108
+ EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED
109
+ EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED
110
+ EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED
111
+ EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED
112
+ EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED
113
+ EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED
114
+ EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED
115
+ EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED
116
+ EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED
117
+ EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED
118
+ EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED
119
+ EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED
120
+ EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED
121
+ EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED
122
+ EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED
123
+ EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED
124
+ FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION
125
+ FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION
126
+ INTEREST = :INTEREST
127
+ INTEREST_REVERSAL = :INTEREST_REVERSAL
128
+ INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
129
+ LATE_PAYMENT = :LATE_PAYMENT
130
+ LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
131
+ LOSS_WRITE_OFF = :LOSS_WRITE_OFF
132
+ PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT
133
+ PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL
134
+ SERVICE = :SERVICE
135
+ RETURN = :RETURN
136
+ RETURN_REVERSAL = :RETURN_REVERSAL
137
+ TRANSFER = :TRANSFER
138
+ TRANSFER_INSUFFICIENT_FUNDS = :TRANSFER_INSUFFICIENT_FUNDS
139
+ RETURNED_PAYMENT = :RETURNED_PAYMENT
140
+ RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL
141
+ LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT
142
+
143
+ # @!method self.values
144
+ # @return [Array<Symbol>]
145
+ end
146
+ end
147
+ end
148
+ end