lithic 0.19.0 → 0.21.0

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 (191) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +61 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/client.rb +4 -0
  5. data/lib/lithic/models/account_activity_list_params.rb +1 -0
  6. data/lib/lithic/models/account_activity_list_response.rb +1 -0
  7. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +1 -0
  8. data/lib/lithic/models/auth_rules/ach_payment_update_action.rb +1 -0
  9. data/lib/lithic/models/auth_rules/auth_rule.rb +5 -0
  10. data/lib/lithic/models/auth_rules/card_transaction_update_action.rb +1 -0
  11. data/lib/lithic/models/auth_rules/report_stats.rb +1 -0
  12. data/lib/lithic/models/auth_rules/v2_create_params.rb +15 -0
  13. data/lib/lithic/models/auth_rules/v2_list_results_response.rb +3 -0
  14. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +24 -1
  15. data/lib/lithic/models/blockchain_recipient.rb +148 -0
  16. data/lib/lithic/models/blockchain_recipient_create_params.rb +74 -0
  17. data/lib/lithic/models/blockchain_recipient_retrieve_params.rb +20 -0
  18. data/lib/lithic/models/card.rb +2 -2
  19. data/lib/lithic/models/card_pin_updated_webhook_event.rb +87 -0
  20. data/lib/lithic/models/card_provision_params.rb +10 -8
  21. data/lib/lithic/models/card_reassign_account_params.rb +29 -0
  22. data/lib/lithic/models/dispute_v2.rb +178 -130
  23. data/lib/lithic/models/disputes_v2_list_params.rb +10 -1
  24. data/lib/lithic/models/event.rb +5 -0
  25. data/lib/lithic/models/event_list_params.rb +3 -0
  26. data/lib/lithic/models/event_subscription.rb +3 -0
  27. data/lib/lithic/models/events/subscription_create_params.rb +3 -0
  28. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +1 -0
  29. data/lib/lithic/models/events/subscription_update_params.rb +3 -0
  30. data/lib/lithic/models/external_payment.rb +6 -0
  31. data/lib/lithic/models/external_payment_create_params.rb +1 -0
  32. data/lib/lithic/models/external_payment_list_params.rb +1 -0
  33. data/lib/lithic/models/financial_account.rb +14 -1
  34. data/lib/lithic/models/financial_accounts/installment_plan.rb +311 -0
  35. data/lib/lithic/models/financial_accounts/installment_plan_list_params.rb +75 -0
  36. data/lib/lithic/models/financial_accounts/installment_plan_retrieve_params.rb +32 -0
  37. data/lib/lithic/models/financial_accounts/open_to_buy.rb +36 -0
  38. data/lib/lithic/models/financial_accounts/open_to_buy_retrieve_params.rb +22 -0
  39. data/lib/lithic/models/financial_accounts/open_to_buy_summary.rb +46 -0
  40. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +13 -0
  41. data/lib/lithic/models/financial_accounts/transaction_category_balances.rb +34 -0
  42. data/lib/lithic/models/financial_event.rb +12 -0
  43. data/lib/lithic/models/management_operation_create_params.rb +4 -0
  44. data/lib/lithic/models/management_operation_transaction.rb +4 -0
  45. data/lib/lithic/models/parsed_webhook_event.rb +3 -1
  46. data/lib/lithic/models/payment.rb +68 -9
  47. data/lib/lithic/models/payment_create_stablecoin_params.rb +99 -0
  48. data/lib/lithic/models/payment_create_stablecoin_response.rb +19 -0
  49. data/lib/lithic/models/payment_list_params.rb +1 -0
  50. data/lib/lithic/models/payment_retry_params.rb +28 -1
  51. data/lib/lithic/models/payment_simulate_action_params.rb +1 -0
  52. data/lib/lithic/models/three_ds_authentication.rb +126 -1
  53. data/lib/lithic/models/tokenization_simulate_params.rb +2 -2
  54. data/lib/lithic/models/transaction.rb +2 -0
  55. data/lib/lithic/models/transaction_monitoring/case_entity.rb +13 -4
  56. data/lib/lithic/models/transaction_monitoring/case_list_params.rb +4 -2
  57. data/lib/lithic/models.rb +12 -0
  58. data/lib/lithic/resources/blockchain_recipients.rb +80 -0
  59. data/lib/lithic/resources/cards.rb +33 -4
  60. data/lib/lithic/resources/disputes_v2.rb +3 -1
  61. data/lib/lithic/resources/financial_accounts/installment_plans.rb +82 -0
  62. data/lib/lithic/resources/financial_accounts/open_to_buy.rb +48 -0
  63. data/lib/lithic/resources/financial_accounts.rb +8 -0
  64. data/lib/lithic/resources/payments.rb +71 -3
  65. data/lib/lithic/resources/tokenizations.rb +1 -1
  66. data/lib/lithic/resources/transaction_monitoring/cases.rb +1 -1
  67. data/lib/lithic/version.rb +1 -1
  68. data/lib/lithic.rb +17 -0
  69. data/rbi/lithic/client.rbi +3 -0
  70. data/rbi/lithic/models/account_activity_list_params.rbi +5 -0
  71. data/rbi/lithic/models/account_activity_list_response.rbi +5 -0
  72. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +5 -0
  73. data/rbi/lithic/models/auth_rules/ach_payment_update_action.rbi +5 -0
  74. data/rbi/lithic/models/auth_rules/auth_rule.rbi +7 -0
  75. data/rbi/lithic/models/auth_rules/card_transaction_update_action.rbi +5 -0
  76. data/rbi/lithic/models/auth_rules/report_stats.rbi +5 -0
  77. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +33 -0
  78. data/rbi/lithic/models/auth_rules/v2_list_results_response.rbi +15 -0
  79. data/rbi/lithic/models/auth_rules/velocity_limit_params.rbi +30 -0
  80. data/rbi/lithic/models/blockchain_recipient.rbi +209 -0
  81. data/rbi/lithic/models/blockchain_recipient_create_params.rbi +102 -0
  82. data/rbi/lithic/models/blockchain_recipient_retrieve_params.rbi +41 -0
  83. data/rbi/lithic/models/card.rbi +2 -2
  84. data/rbi/lithic/models/card_pin_updated_webhook_event.rbi +166 -0
  85. data/rbi/lithic/models/card_provision_params.rbi +16 -12
  86. data/rbi/lithic/models/card_reassign_account_params.rbi +49 -0
  87. data/rbi/lithic/models/dispute_v2.rbi +285 -181
  88. data/rbi/lithic/models/disputes_v2_list_params.rbi +13 -0
  89. data/rbi/lithic/models/event.rbi +8 -0
  90. data/rbi/lithic/models/event_list_params.rbi +7 -0
  91. data/rbi/lithic/models/event_subscription.rbi +7 -0
  92. data/rbi/lithic/models/events/subscription_create_params.rbi +7 -0
  93. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +5 -0
  94. data/rbi/lithic/models/events/subscription_update_params.rbi +7 -0
  95. data/rbi/lithic/models/external_payment.rbi +30 -0
  96. data/rbi/lithic/models/external_payment_create_params.rbi +5 -0
  97. data/rbi/lithic/models/external_payment_list_params.rbi +5 -0
  98. data/rbi/lithic/models/financial_account.rbi +12 -0
  99. data/rbi/lithic/models/financial_accounts/installment_plan.rbi +528 -0
  100. data/rbi/lithic/models/financial_accounts/installment_plan_list_params.rbi +155 -0
  101. data/rbi/lithic/models/financial_accounts/installment_plan_retrieve_params.rbi +56 -0
  102. data/rbi/lithic/models/financial_accounts/open_to_buy.rbi +64 -0
  103. data/rbi/lithic/models/financial_accounts/open_to_buy_retrieve_params.rbi +43 -0
  104. data/rbi/lithic/models/financial_accounts/open_to_buy_summary.rbi +73 -0
  105. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +65 -0
  106. data/rbi/lithic/models/financial_accounts/transaction_category_balances.rbi +81 -0
  107. data/rbi/lithic/models/financial_event.rbi +47 -0
  108. data/rbi/lithic/models/management_operation_create_params.rbi +20 -0
  109. data/rbi/lithic/models/management_operation_transaction.rbi +20 -0
  110. data/rbi/lithic/models/parsed_webhook_event.rbi +1 -0
  111. data/rbi/lithic/models/payment.rbi +108 -10
  112. data/rbi/lithic/models/payment_create_stablecoin_params.rbi +162 -0
  113. data/rbi/lithic/models/payment_create_stablecoin_response.rbi +34 -0
  114. data/rbi/lithic/models/payment_list_params.rbi +2 -0
  115. data/rbi/lithic/models/payment_retry_params.rbi +47 -2
  116. data/rbi/lithic/models/payment_simulate_action_params.rbi +5 -0
  117. data/rbi/lithic/models/three_ds_authentication.rbi +292 -0
  118. data/rbi/lithic/models/tokenization_simulate_params.rbi +2 -2
  119. data/rbi/lithic/models/transaction.rbi +10 -0
  120. data/rbi/lithic/models/transaction_monitoring/case_entity.rbi +27 -5
  121. data/rbi/lithic/models/transaction_monitoring/case_list_params.rbi +6 -2
  122. data/rbi/lithic/models.rbi +14 -0
  123. data/rbi/lithic/resources/blockchain_recipients.rbi +65 -0
  124. data/rbi/lithic/resources/cards.rbi +31 -8
  125. data/rbi/lithic/resources/disputes_v2.rbi +4 -0
  126. data/rbi/lithic/resources/financial_accounts/installment_plans.rbi +66 -0
  127. data/rbi/lithic/resources/financial_accounts/open_to_buy.rbi +40 -0
  128. data/rbi/lithic/resources/financial_accounts.rbi +6 -0
  129. data/rbi/lithic/resources/payments.rbi +68 -2
  130. data/rbi/lithic/resources/tokenizations.rbi +1 -1
  131. data/rbi/lithic/resources/transaction_monitoring/cases.rbi +3 -1
  132. data/rbi/lithic/resources/webhooks.rbi +1 -0
  133. data/sig/lithic/client.rbs +2 -0
  134. data/sig/lithic/models/account_activity_list_params.rbs +2 -0
  135. data/sig/lithic/models/account_activity_list_response.rbs +2 -0
  136. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +2 -0
  137. data/sig/lithic/models/auth_rules/ach_payment_update_action.rbs +2 -1
  138. data/sig/lithic/models/auth_rules/auth_rule.rbs +2 -0
  139. data/sig/lithic/models/auth_rules/card_transaction_update_action.rbs +2 -1
  140. data/sig/lithic/models/auth_rules/report_stats.rbs +2 -0
  141. data/sig/lithic/models/auth_rules/v2_create_params.rbs +6 -0
  142. data/sig/lithic/models/auth_rules/v2_list_results_response.rbs +6 -2
  143. data/sig/lithic/models/auth_rules/velocity_limit_params.rbs +10 -0
  144. data/sig/lithic/models/blockchain_recipient.rbs +106 -0
  145. data/sig/lithic/models/blockchain_recipient_create_params.rbs +60 -0
  146. data/sig/lithic/models/blockchain_recipient_retrieve_params.rbs +24 -0
  147. data/sig/lithic/models/card_pin_updated_webhook_event.rbs +60 -0
  148. data/sig/lithic/models/card_reassign_account_params.rbs +28 -0
  149. data/sig/lithic/models/dispute_v2.rbs +145 -101
  150. data/sig/lithic/models/disputes_v2_list_params.rbs +7 -0
  151. data/sig/lithic/models/event.rbs +2 -0
  152. data/sig/lithic/models/event_list_params.rbs +2 -0
  153. data/sig/lithic/models/event_subscription.rbs +2 -0
  154. data/sig/lithic/models/events/subscription_create_params.rbs +2 -0
  155. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +2 -0
  156. data/sig/lithic/models/events/subscription_update_params.rbs +2 -0
  157. data/sig/lithic/models/external_payment.rbs +12 -0
  158. data/sig/lithic/models/external_payment_create_params.rbs +2 -0
  159. data/sig/lithic/models/external_payment_list_params.rbs +2 -0
  160. data/sig/lithic/models/financial_account.rbs +5 -0
  161. data/sig/lithic/models/financial_accounts/installment_plan.rbs +227 -0
  162. data/sig/lithic/models/financial_accounts/installment_plan_list_params.rbs +69 -0
  163. data/sig/lithic/models/financial_accounts/installment_plan_retrieve_params.rbs +30 -0
  164. data/sig/lithic/models/financial_accounts/open_to_buy.rbs +27 -0
  165. data/sig/lithic/models/financial_accounts/open_to_buy_retrieve_params.rbs +26 -0
  166. data/sig/lithic/models/financial_accounts/open_to_buy_summary.rbs +32 -0
  167. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +26 -0
  168. data/sig/lithic/models/financial_accounts/transaction_category_balances.rbs +32 -0
  169. data/sig/lithic/models/financial_event.rbs +24 -0
  170. data/sig/lithic/models/management_operation_create_params.rbs +8 -0
  171. data/sig/lithic/models/management_operation_transaction.rbs +8 -0
  172. data/sig/lithic/models/parsed_webhook_event.rbs +1 -0
  173. data/sig/lithic/models/payment.rbs +33 -1
  174. data/sig/lithic/models/payment_create_stablecoin_params.rbs +84 -0
  175. data/sig/lithic/models/payment_create_stablecoin_response.rbs +15 -0
  176. data/sig/lithic/models/payment_list_params.rbs +2 -1
  177. data/sig/lithic/models/payment_retry_params.rbs +24 -1
  178. data/sig/lithic/models/payment_simulate_action_params.rbs +2 -0
  179. data/sig/lithic/models/three_ds_authentication.rbs +77 -0
  180. data/sig/lithic/models/transaction.rbs +4 -0
  181. data/sig/lithic/models/transaction_monitoring/case_entity.rbs +7 -5
  182. data/sig/lithic/models.rbs +12 -0
  183. data/sig/lithic/resources/blockchain_recipients.rbs +23 -0
  184. data/sig/lithic/resources/cards.rbs +6 -0
  185. data/sig/lithic/resources/disputes_v2.rbs +1 -0
  186. data/sig/lithic/resources/financial_accounts/installment_plans.rbs +24 -0
  187. data/sig/lithic/resources/financial_accounts/open_to_buy.rbs +14 -0
  188. data/sig/lithic/resources/financial_accounts.rbs +4 -0
  189. data/sig/lithic/resources/payments.rbs +12 -0
  190. data/sig/lithic/resources/webhooks.rbs +1 -0
  191. metadata +53 -2
@@ -47,6 +47,8 @@ module Lithic
47
47
  # - card.converted: Occurs when a card is converted from virtual to physical
48
48
  # cards.
49
49
  # - card.created: Occurs when a new card is created.
50
+ # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
51
+ # blocked due to excessive incorrect PIN attempts.
50
52
  # - card.reissued: Occurs when a card is reissued.
51
53
  # - card.renewed: Occurs when a card is renewed.
52
54
  # - card.shipped: Occurs when a card is shipped.
@@ -198,6 +200,8 @@ module Lithic
198
200
  # - card.converted: Occurs when a card is converted from virtual to physical
199
201
  # cards.
200
202
  # - card.created: Occurs when a new card is created.
203
+ # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
204
+ # blocked due to excessive incorrect PIN attempts.
201
205
  # - card.reissued: Occurs when a card is reissued.
202
206
  # - card.renewed: Occurs when a card is renewed.
203
207
  # - card.shipped: Occurs when a card is shipped.
@@ -318,6 +322,7 @@ module Lithic
318
322
  CARD_TRANSACTION_UPDATED = :"card_transaction.updated"
319
323
  CARD_CONVERTED = :"card.converted"
320
324
  CARD_CREATED = :"card.created"
325
+ CARD_PIN_UPDATED = :"card.pin_updated"
321
326
  CARD_REISSUED = :"card.reissued"
322
327
  CARD_RENEWED = :"card.renewed"
323
328
  CARD_SHIPPED = :"card.shipped"
@@ -101,6 +101,8 @@ module Lithic
101
101
  # - card.converted: Occurs when a card is converted from virtual to physical
102
102
  # cards.
103
103
  # - card.created: Occurs when a new card is created.
104
+ # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
105
+ # blocked due to excessive incorrect PIN attempts.
104
106
  # - card.reissued: Occurs when a card is reissued.
105
107
  # - card.renewed: Occurs when a card is renewed.
106
108
  # - card.shipped: Occurs when a card is shipped.
@@ -219,6 +221,7 @@ module Lithic
219
221
  CARD_TRANSACTION_UPDATED = :"card_transaction.updated"
220
222
  CARD_CONVERTED = :"card.converted"
221
223
  CARD_CREATED = :"card.created"
224
+ CARD_PIN_UPDATED = :"card.pin_updated"
222
225
  CARD_REISSUED = :"card.reissued"
223
226
  CARD_RENEWED = :"card.renewed"
224
227
  CARD_SHIPPED = :"card.shipped"
@@ -74,6 +74,8 @@ module Lithic
74
74
  # - card.converted: Occurs when a card is converted from virtual to physical
75
75
  # cards.
76
76
  # - card.created: Occurs when a new card is created.
77
+ # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
78
+ # blocked due to excessive incorrect PIN attempts.
77
79
  # - card.reissued: Occurs when a card is reissued.
78
80
  # - card.renewed: Occurs when a card is renewed.
79
81
  # - card.shipped: Occurs when a card is shipped.
@@ -192,6 +194,7 @@ module Lithic
192
194
  CARD_TRANSACTION_UPDATED = :"card_transaction.updated"
193
195
  CARD_CONVERTED = :"card.converted"
194
196
  CARD_CREATED = :"card.created"
197
+ CARD_PIN_UPDATED = :"card.pin_updated"
195
198
  CARD_REISSUED = :"card.reissued"
196
199
  CARD_RENEWED = :"card.renewed"
197
200
  CARD_SHIPPED = :"card.shipped"
@@ -76,6 +76,8 @@ module Lithic
76
76
  # - card.converted: Occurs when a card is converted from virtual to physical
77
77
  # cards.
78
78
  # - card.created: Occurs when a new card is created.
79
+ # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
80
+ # blocked due to excessive incorrect PIN attempts.
79
81
  # - card.reissued: Occurs when a card is reissued.
80
82
  # - card.renewed: Occurs when a card is renewed.
81
83
  # - card.shipped: Occurs when a card is shipped.
@@ -194,6 +196,7 @@ module Lithic
194
196
  CARD_TRANSACTION_UPDATED = :"card_transaction.updated"
195
197
  CARD_CONVERTED = :"card.converted"
196
198
  CARD_CREATED = :"card.created"
199
+ CARD_PIN_UPDATED = :"card.pin_updated"
197
200
  CARD_REISSUED = :"card.reissued"
198
201
  CARD_RENEWED = :"card.renewed"
199
202
  CARD_SHIPPED = :"card.shipped"
@@ -45,6 +45,7 @@ module Lithic
45
45
  CARD_TRANSACTION_UPDATED = :"card_transaction.updated"
46
46
  CARD_CONVERTED = :"card.converted"
47
47
  CARD_CREATED = :"card.created"
48
+ CARD_PIN_UPDATED = :"card.pin_updated"
48
49
  CARD_REISSUED = :"card.reissued"
49
50
  CARD_RENEWED = :"card.renewed"
50
51
  CARD_SHIPPED = :"card.shipped"
@@ -83,6 +83,8 @@ module Lithic
83
83
  # - card.converted: Occurs when a card is converted from virtual to physical
84
84
  # cards.
85
85
  # - card.created: Occurs when a new card is created.
86
+ # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
87
+ # blocked due to excessive incorrect PIN attempts.
86
88
  # - card.reissued: Occurs when a card is reissued.
87
89
  # - card.renewed: Occurs when a card is renewed.
88
90
  # - card.shipped: Occurs when a card is shipped.
@@ -201,6 +203,7 @@ module Lithic
201
203
  CARD_TRANSACTION_UPDATED = :"card_transaction.updated"
202
204
  CARD_CONVERTED = :"card.converted"
203
205
  CARD_CREATED = :"card.created"
206
+ CARD_PIN_UPDATED = :"card.pin_updated"
204
207
  CARD_REISSUED = :"card.reissued"
205
208
  CARD_RENEWED = :"card.renewed"
206
209
  CARD_SHIPPED = :"card.shipped"
@@ -134,6 +134,7 @@ module Lithic
134
134
  EXTERNAL_CHECK = :EXTERNAL_CHECK
135
135
  EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
136
136
  EXTERNAL_RTP = :EXTERNAL_RTP
137
+ EXTERNAL_STABLECOIN = :EXTERNAL_STABLECOIN
137
138
  EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
138
139
 
139
140
  # @!method self.values
@@ -247,6 +248,11 @@ module Lithic
247
248
  EXTERNAL_RTP_SETTLED = :EXTERNAL_RTP_SETTLED
248
249
  EXTERNAL_RTP_REVERSED = :EXTERNAL_RTP_REVERSED
249
250
  EXTERNAL_RTP_RELEASED = :EXTERNAL_RTP_RELEASED
251
+ EXTERNAL_STABLECOIN_INITIATED = :EXTERNAL_STABLECOIN_INITIATED
252
+ EXTERNAL_STABLECOIN_CANCELED = :EXTERNAL_STABLECOIN_CANCELED
253
+ EXTERNAL_STABLECOIN_SETTLED = :EXTERNAL_STABLECOIN_SETTLED
254
+ EXTERNAL_STABLECOIN_REVERSED = :EXTERNAL_STABLECOIN_REVERSED
255
+ EXTERNAL_STABLECOIN_RELEASED = :EXTERNAL_STABLECOIN_RELEASED
250
256
 
251
257
  # @!method self.values
252
258
  # @return [Array<Symbol>]
@@ -86,6 +86,7 @@ module Lithic
86
86
  EXTERNAL_CHECK = :EXTERNAL_CHECK
87
87
  EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
88
88
  EXTERNAL_RTP = :EXTERNAL_RTP
89
+ EXTERNAL_STABLECOIN = :EXTERNAL_STABLECOIN
89
90
  EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
90
91
 
91
92
  # @!method self.values
@@ -106,6 +106,7 @@ module Lithic
106
106
  EXTERNAL_CHECK = :EXTERNAL_CHECK
107
107
  EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
108
108
  EXTERNAL_RTP = :EXTERNAL_RTP
109
+ EXTERNAL_STABLECOIN = :EXTERNAL_STABLECOIN
109
110
  EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
110
111
 
111
112
  # @!method self.values
@@ -69,12 +69,23 @@ module Lithic
69
69
  # @return [String, nil]
70
70
  optional :account_number, String, nil?: true
71
71
 
72
+ # @!attribute blockchain_addresses
73
+ # Provisioned blockchain deposit addresses for this financial account, keyed by
74
+ # the full name of the blockchain network that each address belongs to (e.g.
75
+ # `ETHEREUM`)
76
+ #
77
+ # @return [Hash{Symbol=>String}, nil]
78
+ optional :blockchain_addresses, Lithic::Internal::Type::HashOf[String], nil?: true
79
+
72
80
  # @!attribute routing_number
73
81
  #
74
82
  # @return [String, nil]
75
83
  optional :routing_number, String, nil?: true
76
84
 
77
- # @!method initialize(token:, account_token:, created:, credit_configuration:, is_for_benefit_of:, nickname:, status:, substatus:, type:, updated:, user_defined_status:, account_number: nil, routing_number: nil)
85
+ # @!method initialize(token:, account_token:, created:, credit_configuration:, is_for_benefit_of:, nickname:, status:, substatus:, type:, updated:, user_defined_status:, account_number: nil, blockchain_addresses: nil, routing_number: nil)
86
+ # Some parameter documentations has been truncated, see
87
+ # {Lithic::Models::FinancialAccount} for more details.
88
+ #
78
89
  # @param token [String] Globally unique identifier for the account
79
90
  #
80
91
  # @param account_token [String, nil]
@@ -99,6 +110,8 @@ module Lithic
99
110
  #
100
111
  # @param account_number [String, nil]
101
112
  #
113
+ # @param blockchain_addresses [Hash{Symbol=>String}, nil] Provisioned blockchain deposit addresses for this financial account, keyed by th
114
+ #
102
115
  # @param routing_number [String, nil]
103
116
 
104
117
  # @see Lithic::Models::FinancialAccount#credit_configuration
@@ -0,0 +1,311 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ module FinancialAccounts
6
+ # @see Lithic::Resources::FinancialAccounts::InstallmentPlans#retrieve
7
+ class InstallmentPlan < Lithic::Internal::Type::BaseModel
8
+ # @!attribute token
9
+ # Globally unique identifier for an installment plan
10
+ #
11
+ # @return [String]
12
+ required :token, String
13
+
14
+ # @!attribute closed_at
15
+ # Date the plan was paid off or cancelled, or null while it is still open
16
+ #
17
+ # @return [Date, nil]
18
+ required :closed_at, Date, nil?: true
19
+
20
+ # @!attribute created
21
+ # Timestamp of when the installment plan was created
22
+ #
23
+ # @return [Time]
24
+ required :created, Time
25
+
26
+ # @!attribute fee_amount
27
+ # Enrollment fee charged when the plan was created in cents
28
+ #
29
+ # @return [Integer]
30
+ required :fee_amount, Integer
31
+
32
+ # @!attribute financial_account_token
33
+ # Globally unique identifier for a financial account
34
+ #
35
+ # @return [String]
36
+ required :financial_account_token, String
37
+
38
+ # @!attribute installment_plan_total
39
+ # Total owed on the plan in cents, the principal amount plus the enrollment fee
40
+ #
41
+ # @return [Integer]
42
+ required :installment_plan_total, Integer
43
+
44
+ # @!attribute installments
45
+ # Installments that make up the plan, oldest first
46
+ #
47
+ # @return [Array<Lithic::Models::FinancialAccounts::InstallmentPlan::Installment>]
48
+ required :installments,
49
+ -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::InstallmentPlan::Installment] }
50
+
51
+ # @!attribute installments_outstanding
52
+ # Number of installments that still carry a balance
53
+ #
54
+ # @return [Integer]
55
+ required :installments_outstanding, Integer
56
+
57
+ # @!attribute installments_paid
58
+ # Number of installments that have been paid off
59
+ #
60
+ # @return [Integer]
61
+ required :installments_paid, Integer
62
+
63
+ # @!attribute num_installments
64
+ # Number of installments the plan is broken into
65
+ #
66
+ # @return [Integer]
67
+ required :num_installments, Integer
68
+
69
+ # @!attribute principal_amount
70
+ # Balance the plan was opened on in cents, excluding the enrollment fee
71
+ #
72
+ # @return [Integer]
73
+ required :principal_amount, Integer
74
+
75
+ # @!attribute source_amounts
76
+ # Balance the plan was opened on, broken out by category, or null if it was not
77
+ # recorded
78
+ #
79
+ # @return [Lithic::Models::FinancialAccounts::TransactionCategoryBalances, nil]
80
+ required :source_amounts, -> { Lithic::FinancialAccounts::TransactionCategoryBalances }, nil?: true
81
+
82
+ # @!attribute source_id
83
+ # Identifier of the record the plan was opened from, such as the closing statement
84
+ # for an unpaid balance
85
+ #
86
+ # @return [String]
87
+ required :source_id, String
88
+
89
+ # @!attribute source_type
90
+ #
91
+ # @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlan::SourceType]
92
+ required :source_type, enum: -> { Lithic::FinancialAccounts::InstallmentPlan::SourceType }
93
+
94
+ # @!attribute start_date
95
+ # Date the plan was created
96
+ #
97
+ # @return [Date]
98
+ required :start_date, Date
99
+
100
+ # @!attribute state
101
+ # State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan
102
+ # tapes are being rebuilt, during which its payment totals are being recomputed
103
+ # and should not be treated as final
104
+ #
105
+ # @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlan::State]
106
+ required :state, enum: -> { Lithic::FinancialAccounts::InstallmentPlan::State }
107
+
108
+ # @!attribute total_paid
109
+ # Amount paid towards the plan to date in cents
110
+ #
111
+ # @return [Integer]
112
+ required :total_paid, Integer
113
+
114
+ # @!attribute updated
115
+ # Timestamp of when the installment plan was updated
116
+ #
117
+ # @return [Time]
118
+ required :updated, Time
119
+
120
+ # @!method initialize(token:, closed_at:, created:, fee_amount:, financial_account_token:, installment_plan_total:, installments:, installments_outstanding:, installments_paid:, num_installments:, principal_amount:, source_amounts:, source_id:, source_type:, start_date:, state:, total_paid:, updated:)
121
+ # Some parameter documentations has been truncated, see
122
+ # {Lithic::Models::FinancialAccounts::InstallmentPlan} for more details.
123
+ #
124
+ # @param token [String] Globally unique identifier for an installment plan
125
+ #
126
+ # @param closed_at [Date, nil] Date the plan was paid off or cancelled, or null while it is still open
127
+ #
128
+ # @param created [Time] Timestamp of when the installment plan was created
129
+ #
130
+ # @param fee_amount [Integer] Enrollment fee charged when the plan was created in cents
131
+ #
132
+ # @param financial_account_token [String] Globally unique identifier for a financial account
133
+ #
134
+ # @param installment_plan_total [Integer] Total owed on the plan in cents, the principal amount plus the enrollment fee
135
+ #
136
+ # @param installments [Array<Lithic::Models::FinancialAccounts::InstallmentPlan::Installment>] Installments that make up the plan, oldest first
137
+ #
138
+ # @param installments_outstanding [Integer] Number of installments that still carry a balance
139
+ #
140
+ # @param installments_paid [Integer] Number of installments that have been paid off
141
+ #
142
+ # @param num_installments [Integer] Number of installments the plan is broken into
143
+ #
144
+ # @param principal_amount [Integer] Balance the plan was opened on in cents, excluding the enrollment fee
145
+ #
146
+ # @param source_amounts [Lithic::Models::FinancialAccounts::TransactionCategoryBalances, nil] Balance the plan was opened on, broken out by category, or null if it was not re
147
+ #
148
+ # @param source_id [String] Identifier of the record the plan was opened from, such as the closing statement
149
+ #
150
+ # @param source_type [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlan::SourceType]
151
+ #
152
+ # @param start_date [Date] Date the plan was created
153
+ #
154
+ # @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlan::State] State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan tape
155
+ #
156
+ # @param total_paid [Integer] Amount paid towards the plan to date in cents
157
+ #
158
+ # @param updated [Time] Timestamp of when the installment plan was updated
159
+
160
+ class Installment < Lithic::Internal::Type::BaseModel
161
+ # @!attribute amount_due
162
+ # Amount the installment was opened for in cents
163
+ #
164
+ # @return [Integer]
165
+ required :amount_due, Integer
166
+
167
+ # @!attribute amount_due_details
168
+ #
169
+ # @return [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
170
+ required :amount_due_details, -> { Lithic::FinancialAccounts::TransactionCategoryBalances }
171
+
172
+ # @!attribute amount_outstanding
173
+ # Amount still owed on the installment in cents
174
+ #
175
+ # @return [Integer]
176
+ required :amount_outstanding, Integer
177
+
178
+ # @!attribute amount_outstanding_details
179
+ #
180
+ # @return [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
181
+ required :amount_outstanding_details, -> { Lithic::FinancialAccounts::TransactionCategoryBalances }
182
+
183
+ # @!attribute amount_paid
184
+ # Amount paid towards the installment in cents
185
+ #
186
+ # @return [Integer]
187
+ required :amount_paid, Integer
188
+
189
+ # @!attribute amount_paid_details
190
+ #
191
+ # @return [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
192
+ required :amount_paid_details, -> { Lithic::FinancialAccounts::TransactionCategoryBalances }
193
+
194
+ # @!attribute date_assessed
195
+ # Date the installment was actually assessed onto the account, or null if it has
196
+ # not been assessed yet
197
+ #
198
+ # @return [Date, nil]
199
+ required :date_assessed, Date, nil?: true
200
+
201
+ # @!attribute due_date
202
+ # Date the installment is scheduled to be assessed onto the account
203
+ #
204
+ # @return [Date]
205
+ required :due_date, Date
206
+
207
+ # @!attribute installment_num
208
+ # Position of this installment within the plan, starting at 0
209
+ #
210
+ # @return [Integer]
211
+ required :installment_num, Integer
212
+
213
+ # @!attribute payment_due_date
214
+ # Date the installment must be paid by before it is considered past due
215
+ #
216
+ # @return [Date]
217
+ required :payment_due_date, Date
218
+
219
+ # @!attribute payments
220
+ # Payments applied to this installment, oldest first
221
+ #
222
+ # @return [Array<Lithic::Models::FinancialAccounts::InstallmentPlan::Installment::Payment>]
223
+ required :payments,
224
+ -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::InstallmentPlan::Installment::Payment] }
225
+
226
+ # @!method initialize(amount_due:, amount_due_details:, amount_outstanding:, amount_outstanding_details:, amount_paid:, amount_paid_details:, date_assessed:, due_date:, installment_num:, payment_due_date:, payments:)
227
+ # Some parameter documentations has been truncated, see
228
+ # {Lithic::Models::FinancialAccounts::InstallmentPlan::Installment} for more
229
+ # details.
230
+ #
231
+ # @param amount_due [Integer] Amount the installment was opened for in cents
232
+ #
233
+ # @param amount_due_details [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
234
+ #
235
+ # @param amount_outstanding [Integer] Amount still owed on the installment in cents
236
+ #
237
+ # @param amount_outstanding_details [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
238
+ #
239
+ # @param amount_paid [Integer] Amount paid towards the installment in cents
240
+ #
241
+ # @param amount_paid_details [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
242
+ #
243
+ # @param date_assessed [Date, nil] Date the installment was actually assessed onto the account, or null if it has n
244
+ #
245
+ # @param due_date [Date] Date the installment is scheduled to be assessed onto the account
246
+ #
247
+ # @param installment_num [Integer] Position of this installment within the plan, starting at 0
248
+ #
249
+ # @param payment_due_date [Date] Date the installment must be paid by before it is considered past due
250
+ #
251
+ # @param payments [Array<Lithic::Models::FinancialAccounts::InstallmentPlan::Installment::Payment>] Payments applied to this installment, oldest first
252
+
253
+ class Payment < Lithic::Internal::Type::BaseModel
254
+ # @!attribute amount
255
+ # Amount applied to the installment in cents
256
+ #
257
+ # @return [Integer]
258
+ required :amount, Integer
259
+
260
+ # @!attribute amount_details
261
+ #
262
+ # @return [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
263
+ required :amount_details, -> { Lithic::FinancialAccounts::TransactionCategoryBalances }
264
+
265
+ # @!attribute date
266
+ # Date the payment was applied to the installment
267
+ #
268
+ # @return [Date]
269
+ required :date, Date
270
+
271
+ # @!method initialize(amount:, amount_details:, date:)
272
+ # @param amount [Integer] Amount applied to the installment in cents
273
+ #
274
+ # @param amount_details [Lithic::Models::FinancialAccounts::TransactionCategoryBalances]
275
+ #
276
+ # @param date [Date] Date the payment was applied to the installment
277
+ end
278
+ end
279
+
280
+ # @see Lithic::Models::FinancialAccounts::InstallmentPlan#source_type
281
+ module SourceType
282
+ extend Lithic::Internal::Type::Enum
283
+
284
+ UNPAID_BALANCE = :UNPAID_BALANCE
285
+ TRANSACTION = :TRANSACTION
286
+
287
+ # @!method self.values
288
+ # @return [Array<Symbol>]
289
+ end
290
+
291
+ # State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan
292
+ # tapes are being rebuilt, during which its payment totals are being recomputed
293
+ # and should not be treated as final
294
+ #
295
+ # @see Lithic::Models::FinancialAccounts::InstallmentPlan#state
296
+ module State
297
+ extend Lithic::Internal::Type::Enum
298
+
299
+ PENDING = :PENDING
300
+ ACTIVE = :ACTIVE
301
+ REBUILD_IN_PROGRESS = :REBUILD_IN_PROGRESS
302
+ FULLY_PAID = :FULLY_PAID
303
+ CANCELLED = :CANCELLED
304
+
305
+ # @!method self.values
306
+ # @return [Array<Symbol>]
307
+ end
308
+ end
309
+ end
310
+ end
311
+ end
@@ -0,0 +1,75 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ module FinancialAccounts
6
+ # @see Lithic::Resources::FinancialAccounts::InstallmentPlans#list
7
+ class InstallmentPlanListParams < Lithic::Internal::Type::BaseModel
8
+ extend Lithic::Internal::Type::RequestParameters::Converter
9
+ include Lithic::Internal::Type::RequestParameters
10
+
11
+ # @!attribute financial_account_token
12
+ # Globally unique identifier for financial account.
13
+ #
14
+ # @return [String]
15
+ required :financial_account_token, String
16
+
17
+ # @!attribute ending_before
18
+ # A cursor representing an item's token before which a page of results should end.
19
+ # Used to retrieve the previous page of results before this item.
20
+ #
21
+ # @return [String, nil]
22
+ optional :ending_before, String
23
+
24
+ # @!attribute page_size
25
+ # Page size (for pagination).
26
+ #
27
+ # @return [Integer, nil]
28
+ optional :page_size, Integer
29
+
30
+ # @!attribute starting_after
31
+ # A cursor representing an item's token after which a page of results should
32
+ # begin. Used to retrieve the next page of results after this item.
33
+ #
34
+ # @return [String, nil]
35
+ optional :starting_after, String
36
+
37
+ # @!attribute state
38
+ # Only installment plans in this state will be included.
39
+ #
40
+ # @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlanListParams::State, nil]
41
+ optional :state, enum: -> { Lithic::FinancialAccounts::InstallmentPlanListParams::State }, nil?: true
42
+
43
+ # @!method initialize(financial_account_token:, ending_before: nil, page_size: nil, starting_after: nil, state: nil, request_options: {})
44
+ # Some parameter documentations has been truncated, see
45
+ # {Lithic::Models::FinancialAccounts::InstallmentPlanListParams} for more details.
46
+ #
47
+ # @param financial_account_token [String] Globally unique identifier for financial account.
48
+ #
49
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
50
+ #
51
+ # @param page_size [Integer] Page size (for pagination).
52
+ #
53
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
54
+ #
55
+ # @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlanListParams::State, nil] Only installment plans in this state will be included.
56
+ #
57
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
58
+
59
+ # Only installment plans in this state will be included.
60
+ module State
61
+ extend Lithic::Internal::Type::Enum
62
+
63
+ PENDING = :PENDING
64
+ ACTIVE = :ACTIVE
65
+ REBUILD_IN_PROGRESS = :REBUILD_IN_PROGRESS
66
+ FULLY_PAID = :FULLY_PAID
67
+ CANCELLED = :CANCELLED
68
+
69
+ # @!method self.values
70
+ # @return [Array<Symbol>]
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,32 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ module FinancialAccounts
6
+ # @see Lithic::Resources::FinancialAccounts::InstallmentPlans#retrieve
7
+ class InstallmentPlanRetrieveParams < Lithic::Internal::Type::BaseModel
8
+ extend Lithic::Internal::Type::RequestParameters::Converter
9
+ include Lithic::Internal::Type::RequestParameters
10
+
11
+ # @!attribute financial_account_token
12
+ # Globally unique identifier for financial account.
13
+ #
14
+ # @return [String]
15
+ required :financial_account_token, String
16
+
17
+ # @!attribute installment_plan_token
18
+ # Globally unique identifier for installment plan.
19
+ #
20
+ # @return [String]
21
+ required :installment_plan_token, String
22
+
23
+ # @!method initialize(financial_account_token:, installment_plan_token:, request_options: {})
24
+ # @param financial_account_token [String] Globally unique identifier for financial account.
25
+ #
26
+ # @param installment_plan_token [String] Globally unique identifier for installment plan.
27
+ #
28
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ module FinancialAccounts
6
+ # @see Lithic::Resources::FinancialAccounts::OpenToBuy#retrieve
7
+ class FinancialAccountsOpenToBuy < Lithic::Internal::Type::BaseModel
8
+ # @!attribute open_to_buy
9
+ # Funds available for card spend backed by this Security Account, in the
10
+ # currency's smallest unit (e.g., cents for USD). Equal to the sum of the amounts
11
+ # in `summary`, and reaches zero once outstanding spend has consumed all available
12
+ # funding
13
+ #
14
+ # @return [Integer]
15
+ required :open_to_buy, Integer
16
+
17
+ # @!attribute summary
18
+ # Balances that open to buy is derived from
19
+ #
20
+ # @return [Lithic::Models::FinancialAccounts::OpenToBuySummary]
21
+ required :summary, -> { Lithic::FinancialAccounts::OpenToBuySummary }
22
+
23
+ # @!method initialize(open_to_buy:, summary:)
24
+ # Some parameter documentations has been truncated, see
25
+ # {Lithic::Models::FinancialAccounts::FinancialAccountsOpenToBuy} for more
26
+ # details.
27
+ #
28
+ # Open to Buy
29
+ #
30
+ # @param open_to_buy [Integer] Funds available for card spend backed by this Security Account, in the currency'
31
+ #
32
+ # @param summary [Lithic::Models::FinancialAccounts::OpenToBuySummary] Balances that open to buy is derived from
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ module FinancialAccounts
6
+ # @see Lithic::Resources::FinancialAccounts::OpenToBuy#retrieve
7
+ class OpenToBuyRetrieveParams < Lithic::Internal::Type::BaseModel
8
+ extend Lithic::Internal::Type::RequestParameters::Converter
9
+ include Lithic::Internal::Type::RequestParameters
10
+
11
+ # @!attribute financial_account_token
12
+ #
13
+ # @return [String]
14
+ required :financial_account_token, String
15
+
16
+ # @!method initialize(financial_account_token:, request_options: {})
17
+ # @param financial_account_token [String]
18
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end