lithic 0.20.0 → 0.22.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +44 -0
- data/README.md +1 -10
- data/lib/lithic/internal/type/union.rb +21 -7
- data/lib/lithic/models/account_activity_list_params.rb +1 -0
- data/lib/lithic/models/account_activity_list_response.rb +1 -0
- data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +1 -0
- data/lib/lithic/models/account_holder_create_params.rb +4 -2
- data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +120 -66
- data/lib/lithic/models/account_holder_update_params.rb +6 -3
- data/lib/lithic/models/account_holder_update_response.rb +156 -86
- data/lib/lithic/models/account_holder_updated_webhook_event.rb +120 -66
- data/lib/lithic/models/account_holders/account_holder_entity.rb +35 -19
- data/lib/lithic/models/account_holders/entity_create_params.rb +39 -21
- data/lib/lithic/models/address.rb +33 -19
- data/lib/lithic/models/address_update.rb +27 -11
- data/lib/lithic/models/auth_rules/auth_rule.rb +60 -27
- data/lib/lithic/models/auth_rules/auth_rule_condition.rb +189 -6
- data/lib/lithic/models/auth_rules/auth_rule_entities.rb +47 -0
- data/lib/lithic/models/auth_rules/auth_rule_entities_response.rb +31 -0
- data/lib/lithic/models/auth_rules/auth_rule_entity.rb +150 -0
- data/lib/lithic/models/auth_rules/auth_rule_version.rb +3 -6
- data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +33 -6
- data/lib/lithic/models/auth_rules/conditional_attribute.rb +101 -5
- data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +3 -439
- data/lib/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rb +7 -0
- data/lib/lithic/models/auth_rules/merchant_lock_parameters.rb +11 -1
- data/lib/lithic/models/auth_rules/report_stats.rb +1 -0
- data/lib/lithic/models/auth_rules/v2_create_params.rb +218 -45
- data/lib/lithic/models/auth_rules/v2_draft_params.rb +3 -6
- data/lib/lithic/models/auth_rules/v2_list_params.rb +5 -3
- data/lib/lithic/models/auth_rules/v2_list_results_response.rb +1 -0
- data/lib/lithic/models/auth_rules/v2_update_entities_params.rb +39 -0
- data/lib/lithic/models/auth_rules/v2_update_params.rb +133 -12
- data/lib/lithic/models/blockchain_recipient_retrieve_params.rb +20 -0
- data/lib/lithic/models/card_authorization.rb +11 -1
- data/lib/lithic/models/card_create_params.rb +11 -1
- data/lib/lithic/models/card_pin_updated_webhook_event.rb +87 -0
- data/lib/lithic/models/card_update_params.rb +12 -1
- data/lib/lithic/models/event.rb +5 -0
- data/lib/lithic/models/event_list_params.rb +3 -0
- data/lib/lithic/models/event_subscription.rb +3 -0
- data/lib/lithic/models/events/subscription_create_params.rb +3 -0
- data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +1 -0
- data/lib/lithic/models/events/subscription_update_params.rb +3 -0
- data/lib/lithic/models/external_payment.rb +6 -0
- data/lib/lithic/models/external_payment_create_params.rb +1 -0
- data/lib/lithic/models/external_payment_list_params.rb +1 -0
- data/lib/lithic/models/financial_accounts/installment_plan.rb +311 -0
- data/lib/lithic/models/financial_accounts/installment_plan_list_params.rb +75 -0
- data/lib/lithic/models/financial_accounts/installment_plan_retrieve_params.rb +32 -0
- data/lib/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rb +279 -0
- data/lib/lithic/models/financial_accounts/installment_plans/statement_list_params.rb +106 -0
- data/lib/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rb +42 -0
- data/lib/lithic/models/financial_accounts/loan_tape.rb +62 -1
- data/lib/lithic/models/financial_accounts/open_to_buy.rb +36 -0
- data/lib/lithic/models/financial_accounts/open_to_buy_retrieve_params.rb +22 -0
- data/lib/lithic/models/financial_accounts/open_to_buy_summary.rb +46 -0
- data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +10 -0
- data/lib/lithic/models/financial_accounts/transaction_category_balances.rb +34 -0
- data/lib/lithic/models/financial_event.rb +9 -0
- data/lib/lithic/models/kyb.rb +4 -2
- data/lib/lithic/models/kyb_business_entity.rb +35 -19
- data/lib/lithic/models/kyc.rb +2 -1
- data/lib/lithic/models/management_operation_create_params.rb +4 -0
- data/lib/lithic/models/management_operation_transaction.rb +4 -0
- data/lib/lithic/models/non_pci_card.rb +11 -1
- data/lib/lithic/models/parsed_webhook_event.rb +123 -67
- data/lib/lithic/models/payment.rb +3 -1
- data/lib/lithic/models/payment_create_stablecoin_params.rb +99 -0
- data/lib/lithic/models/payment_create_stablecoin_response.rb +19 -0
- data/lib/lithic/models/payment_list_params.rb +1 -0
- data/lib/lithic/models/payment_retry_params.rb +28 -1
- data/lib/lithic/models/payment_simulate_action_params.rb +1 -0
- data/lib/lithic/models/three_ds_authentication.rb +126 -1
- data/lib/lithic/models/transaction.rb +4 -1
- data/lib/lithic/models/transaction_simulate_authorization_params.rb +28 -4
- data/lib/lithic/models/transaction_simulate_credit_authorization_advice_params.rb +11 -1
- data/lib/lithic/models/transaction_simulate_return_params.rb +24 -1
- data/lib/lithic/models.rb +6 -0
- data/lib/lithic/resources/auth_rules/v2/backtests.rb +8 -8
- data/lib/lithic/resources/auth_rules/v2.rb +44 -8
- data/lib/lithic/resources/blockchain_recipients.rb +23 -0
- data/lib/lithic/resources/cards.rb +10 -4
- data/lib/lithic/resources/financial_accounts/installment_plans/statements.rb +107 -0
- data/lib/lithic/resources/financial_accounts/installment_plans.rb +86 -0
- data/lib/lithic/resources/financial_accounts/open_to_buy.rb +48 -0
- data/lib/lithic/resources/financial_accounts.rb +8 -0
- data/lib/lithic/resources/payments.rb +71 -3
- data/lib/lithic/resources/transactions.rb +17 -4
- data/lib/lithic/resources/webhooks.rb +18 -0
- data/lib/lithic/version.rb +1 -1
- data/lib/lithic.rb +21 -1
- data/rbi/lithic/models/account_activity_list_params.rbi +5 -0
- data/rbi/lithic/models/account_activity_list_response.rbi +5 -0
- data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +5 -0
- data/rbi/lithic/models/account_holder_create_params.rbi +8 -4
- data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +195 -90
- data/rbi/lithic/models/account_holder_update_params.rbi +12 -6
- data/rbi/lithic/models/account_holder_update_response.rbi +254 -117
- data/rbi/lithic/models/account_holder_updated_webhook_event.rbi +195 -90
- data/rbi/lithic/models/account_holders/account_holder_entity.rbi +59 -27
- data/rbi/lithic/models/account_holders/entity_create_params.rbi +65 -30
- data/rbi/lithic/models/address.rbi +57 -29
- data/rbi/lithic/models/address_update.rbi +50 -24
- data/rbi/lithic/models/auth_rules/auth_rule.rbi +60 -19
- data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +442 -13
- data/rbi/lithic/models/auth_rules/auth_rule_entities.rbi +163 -0
- data/rbi/lithic/models/auth_rules/auth_rule_entities_response.rbi +72 -0
- data/rbi/lithic/models/auth_rules/auth_rule_entity.rbi +199 -0
- data/rbi/lithic/models/auth_rules/auth_rule_version.rbi +0 -2
- data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +67 -9
- data/rbi/lithic/models/auth_rules/conditional_attribute.rbi +193 -5
- data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +3 -939
- data/rbi/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbi +14 -0
- data/rbi/lithic/models/auth_rules/merchant_lock_parameters.rbi +14 -3
- data/rbi/lithic/models/auth_rules/report_stats.rbi +5 -0
- data/rbi/lithic/models/auth_rules/v2_create_params.rbi +358 -50
- data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +0 -4
- data/rbi/lithic/models/auth_rules/v2_list_params.rbi +6 -3
- data/rbi/lithic/models/auth_rules/v2_list_results_response.rbi +5 -0
- data/rbi/lithic/models/auth_rules/v2_update_entities_params.rbi +68 -0
- data/rbi/lithic/models/auth_rules/v2_update_params.rbi +198 -5
- data/rbi/lithic/models/blockchain_recipient_retrieve_params.rbi +41 -0
- data/rbi/lithic/models/card_authorization.rbi +12 -0
- data/rbi/lithic/models/card_create_params.rbi +15 -0
- data/rbi/lithic/models/card_pin_updated_webhook_event.rbi +166 -0
- data/rbi/lithic/models/card_update_params.rbi +17 -0
- data/rbi/lithic/models/event.rbi +8 -0
- data/rbi/lithic/models/event_list_params.rbi +7 -0
- data/rbi/lithic/models/event_subscription.rbi +7 -0
- data/rbi/lithic/models/events/subscription_create_params.rbi +7 -0
- data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +5 -0
- data/rbi/lithic/models/events/subscription_update_params.rbi +7 -0
- data/rbi/lithic/models/external_payment.rbi +30 -0
- data/rbi/lithic/models/external_payment_create_params.rbi +5 -0
- data/rbi/lithic/models/external_payment_list_params.rbi +5 -0
- data/rbi/lithic/models/financial_accounts/installment_plan.rbi +528 -0
- data/rbi/lithic/models/financial_accounts/installment_plan_list_params.rbi +155 -0
- data/rbi/lithic/models/financial_accounts/installment_plan_retrieve_params.rbi +56 -0
- data/rbi/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rbi +452 -0
- data/rbi/lithic/models/financial_accounts/installment_plans/statement_list_params.rbi +191 -0
- data/rbi/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rbi +66 -0
- data/rbi/lithic/models/financial_accounts/loan_tape.rbi +119 -0
- data/rbi/lithic/models/financial_accounts/open_to_buy.rbi +64 -0
- data/rbi/lithic/models/financial_accounts/open_to_buy_retrieve_params.rbi +43 -0
- data/rbi/lithic/models/financial_accounts/open_to_buy_summary.rbi +73 -0
- data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +50 -0
- data/rbi/lithic/models/financial_accounts/transaction_category_balances.rbi +81 -0
- data/rbi/lithic/models/financial_event.rbi +35 -0
- data/rbi/lithic/models/kyb.rbi +8 -4
- data/rbi/lithic/models/kyb_business_entity.rbi +59 -27
- data/rbi/lithic/models/kyc.rbi +4 -2
- data/rbi/lithic/models/management_operation_create_params.rbi +20 -0
- data/rbi/lithic/models/management_operation_transaction.rbi +20 -0
- data/rbi/lithic/models/non_pci_card.rbi +12 -0
- data/rbi/lithic/models/parsed_webhook_event.rbi +196 -90
- data/rbi/lithic/models/payment.rbi +6 -2
- data/rbi/lithic/models/payment_create_stablecoin_params.rbi +162 -0
- data/rbi/lithic/models/payment_create_stablecoin_response.rbi +34 -0
- data/rbi/lithic/models/payment_list_params.rbi +2 -0
- data/rbi/lithic/models/payment_retry_params.rbi +47 -2
- data/rbi/lithic/models/payment_simulate_action_params.rbi +5 -0
- data/rbi/lithic/models/three_ds_authentication.rbi +292 -0
- data/rbi/lithic/models/transaction.rbi +14 -2
- data/rbi/lithic/models/transaction_simulate_authorization_params.rbi +42 -4
- data/rbi/lithic/models/transaction_simulate_credit_authorization_advice_params.rbi +15 -0
- data/rbi/lithic/models/transaction_simulate_return_params.rbi +30 -0
- data/rbi/lithic/models.rbi +7 -0
- data/rbi/lithic/resources/account_holders/entities.rbi +2 -1
- data/rbi/lithic/resources/auth_rules/v2/backtests.rbi +8 -8
- data/rbi/lithic/resources/auth_rules/v2.rbi +43 -8
- data/rbi/lithic/resources/blockchain_recipients.rbi +14 -0
- data/rbi/lithic/resources/cards.rbi +15 -2
- data/rbi/lithic/resources/financial_accounts/installment_plans/statements.rbi +86 -0
- data/rbi/lithic/resources/financial_accounts/installment_plans.rbi +73 -0
- data/rbi/lithic/resources/financial_accounts/open_to_buy.rbi +40 -0
- data/rbi/lithic/resources/financial_accounts.rbi +6 -0
- data/rbi/lithic/resources/payments.rbi +68 -2
- data/rbi/lithic/resources/transactions.rbi +31 -2
- data/rbi/lithic/resources/webhooks.rbi +1 -0
- data/sig/lithic/models/account_activity_list_params.rbs +2 -0
- data/sig/lithic/models/account_activity_list_response.rbs +2 -0
- data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +2 -0
- data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +39 -39
- data/sig/lithic/models/account_holder_update_response.rbs +52 -52
- data/sig/lithic/models/account_holder_updated_webhook_event.rbs +39 -39
- data/sig/lithic/models/account_holders/account_holder_entity.rbs +13 -13
- data/sig/lithic/models/account_holders/entity_create_params.rbs +13 -13
- data/sig/lithic/models/address.rbs +13 -13
- data/sig/lithic/models/address_update.rbs +8 -12
- data/sig/lithic/models/auth_rules/auth_rule.rbs +10 -7
- data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +89 -3
- data/sig/lithic/models/auth_rules/auth_rule_entities.rbs +37 -0
- data/sig/lithic/models/auth_rules/auth_rule_entities_response.rbs +29 -0
- data/sig/lithic/models/auth_rules/auth_rule_entity.rbs +80 -0
- data/sig/lithic/models/auth_rules/auth_rule_version.rbs +1 -2
- data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +10 -0
- data/sig/lithic/models/auth_rules/conditional_attribute.rbs +46 -0
- data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +4 -204
- data/sig/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbs +2 -0
- data/sig/lithic/models/auth_rules/merchant_lock_parameters.rbs +10 -3
- data/sig/lithic/models/auth_rules/report_stats.rbs +2 -0
- data/sig/lithic/models/auth_rules/v2_create_params.rbs +92 -16
- data/sig/lithic/models/auth_rules/v2_draft_params.rbs +1 -2
- data/sig/lithic/models/auth_rules/v2_list_results_response.rbs +2 -0
- data/sig/lithic/models/auth_rules/v2_update_entities_params.rbs +46 -0
- data/sig/lithic/models/auth_rules/v2_update_params.rbs +47 -1
- data/sig/lithic/models/blockchain_recipient_retrieve_params.rbs +24 -0
- data/sig/lithic/models/card_authorization.rbs +5 -0
- data/sig/lithic/models/card_create_params.rbs +7 -0
- data/sig/lithic/models/card_pin_updated_webhook_event.rbs +60 -0
- data/sig/lithic/models/card_update_params.rbs +8 -1
- data/sig/lithic/models/event.rbs +2 -0
- data/sig/lithic/models/event_list_params.rbs +2 -0
- data/sig/lithic/models/event_subscription.rbs +2 -0
- data/sig/lithic/models/events/subscription_create_params.rbs +2 -0
- data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +2 -0
- data/sig/lithic/models/events/subscription_update_params.rbs +2 -0
- data/sig/lithic/models/external_payment.rbs +12 -0
- data/sig/lithic/models/external_payment_create_params.rbs +2 -0
- data/sig/lithic/models/external_payment_list_params.rbs +2 -0
- data/sig/lithic/models/financial_accounts/installment_plan.rbs +227 -0
- data/sig/lithic/models/financial_accounts/installment_plan_list_params.rbs +69 -0
- data/sig/lithic/models/financial_accounts/installment_plan_retrieve_params.rbs +30 -0
- data/sig/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rbs +191 -0
- data/sig/lithic/models/financial_accounts/installment_plans/statement_list_params.rbs +90 -0
- data/sig/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rbs +40 -0
- data/sig/lithic/models/financial_accounts/loan_tape.rbs +47 -0
- data/sig/lithic/models/financial_accounts/open_to_buy.rbs +27 -0
- data/sig/lithic/models/financial_accounts/open_to_buy_retrieve_params.rbs +26 -0
- data/sig/lithic/models/financial_accounts/open_to_buy_summary.rbs +32 -0
- data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +20 -0
- data/sig/lithic/models/financial_accounts/transaction_category_balances.rbs +32 -0
- data/sig/lithic/models/financial_event.rbs +18 -0
- data/sig/lithic/models/kyb_business_entity.rbs +13 -13
- data/sig/lithic/models/management_operation_create_params.rbs +8 -0
- data/sig/lithic/models/management_operation_transaction.rbs +8 -0
- data/sig/lithic/models/non_pci_card.rbs +5 -0
- data/sig/lithic/models/parsed_webhook_event.rbs +40 -39
- data/sig/lithic/models/payment.rbs +2 -0
- data/sig/lithic/models/payment_create_stablecoin_params.rbs +84 -0
- data/sig/lithic/models/payment_create_stablecoin_response.rbs +15 -0
- data/sig/lithic/models/payment_list_params.rbs +2 -1
- data/sig/lithic/models/payment_retry_params.rbs +24 -1
- data/sig/lithic/models/payment_simulate_action_params.rbs +2 -0
- data/sig/lithic/models/three_ds_authentication.rbs +77 -0
- data/sig/lithic/models/transaction.rbs +4 -0
- data/sig/lithic/models/transaction_simulate_authorization_params.rbs +14 -0
- data/sig/lithic/models/transaction_simulate_credit_authorization_advice_params.rbs +7 -0
- data/sig/lithic/models/transaction_simulate_return_params.rbs +19 -1
- data/sig/lithic/models.rbs +6 -0
- data/sig/lithic/resources/auth_rules/v2.rbs +7 -0
- data/sig/lithic/resources/blockchain_recipients.rbs +5 -0
- data/sig/lithic/resources/cards.rbs +2 -0
- data/sig/lithic/resources/financial_accounts/installment_plans/statements.rbs +30 -0
- data/sig/lithic/resources/financial_accounts/installment_plans.rbs +26 -0
- data/sig/lithic/resources/financial_accounts/open_to_buy.rbs +14 -0
- data/sig/lithic/resources/financial_accounts.rbs +4 -0
- data/sig/lithic/resources/payments.rbs +12 -0
- data/sig/lithic/resources/transactions.rbs +5 -0
- data/sig/lithic/resources/webhooks.rbs +1 -0
- metadata +65 -5
- data/lib/lithic/models/auth_rules/conditional_block_parameters.rb +0 -20
- data/rbi/lithic/models/auth_rules/conditional_block_parameters.rbi +0 -37
- data/sig/lithic/models/auth_rules/conditional_block_parameters.rbs +0 -20
|
@@ -0,0 +1,279 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Lithic
|
|
4
|
+
module Models
|
|
5
|
+
module FinancialAccounts
|
|
6
|
+
module InstallmentPlans
|
|
7
|
+
# @see Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements#retrieve
|
|
8
|
+
class InstallmentPlanStatement < Lithic::Internal::Type::BaseModel
|
|
9
|
+
# @!attribute token
|
|
10
|
+
# Globally unique identifier for this snapshot, which is the token of the
|
|
11
|
+
# statement it is attached to. A plan is snapshotted at most once per statement,
|
|
12
|
+
# so the statement identifies the snapshot within the plan. Pass it as a
|
|
13
|
+
# pagination cursor
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :token, String
|
|
17
|
+
|
|
18
|
+
# @!attribute fee_amount
|
|
19
|
+
# Enrollment fee charged when the plan was created in cents
|
|
20
|
+
#
|
|
21
|
+
# @return [Integer]
|
|
22
|
+
required :fee_amount, Integer
|
|
23
|
+
|
|
24
|
+
# @!attribute installment_plan_token
|
|
25
|
+
# Globally unique identifier for the installment plan this snapshot is of
|
|
26
|
+
#
|
|
27
|
+
# @return [String]
|
|
28
|
+
required :installment_plan_token, String
|
|
29
|
+
|
|
30
|
+
# @!attribute installment_plan_total
|
|
31
|
+
# Total owed on the plan in cents, the principal amount plus the enrollment fee
|
|
32
|
+
#
|
|
33
|
+
# @return [Integer]
|
|
34
|
+
required :installment_plan_total, Integer
|
|
35
|
+
|
|
36
|
+
# @!attribute installments
|
|
37
|
+
# Installments that make up the plan, oldest first
|
|
38
|
+
#
|
|
39
|
+
# @return [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment>]
|
|
40
|
+
required :installments,
|
|
41
|
+
-> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment] }
|
|
42
|
+
|
|
43
|
+
# @!attribute installments_outstanding
|
|
44
|
+
# Number of installments that still carried a balance as of this statement
|
|
45
|
+
#
|
|
46
|
+
# @return [Integer]
|
|
47
|
+
required :installments_outstanding, Integer
|
|
48
|
+
|
|
49
|
+
# @!attribute installments_paid
|
|
50
|
+
# Number of installments that had been paid off as of this statement
|
|
51
|
+
#
|
|
52
|
+
# @return [Integer]
|
|
53
|
+
required :installments_paid, Integer
|
|
54
|
+
|
|
55
|
+
# @!attribute num_installments
|
|
56
|
+
# Number of installments the plan is broken into
|
|
57
|
+
#
|
|
58
|
+
# @return [Integer]
|
|
59
|
+
required :num_installments, Integer
|
|
60
|
+
|
|
61
|
+
# @!attribute principal_amount
|
|
62
|
+
# Balance the plan was opened on in cents, excluding the enrollment fee
|
|
63
|
+
#
|
|
64
|
+
# @return [Integer]
|
|
65
|
+
required :principal_amount, Integer
|
|
66
|
+
|
|
67
|
+
# @!attribute source_type
|
|
68
|
+
#
|
|
69
|
+
# @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType]
|
|
70
|
+
required :source_type,
|
|
71
|
+
enum: -> { Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType }
|
|
72
|
+
|
|
73
|
+
# @!attribute start_date
|
|
74
|
+
# Date the plan was created
|
|
75
|
+
#
|
|
76
|
+
# @return [Date]
|
|
77
|
+
required :start_date, Date
|
|
78
|
+
|
|
79
|
+
# @!attribute state
|
|
80
|
+
# State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan
|
|
81
|
+
# tapes are being rebuilt, during which its payment totals are being recomputed
|
|
82
|
+
# and should not be treated as final
|
|
83
|
+
#
|
|
84
|
+
# @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State]
|
|
85
|
+
required :state, enum: -> { Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State }
|
|
86
|
+
|
|
87
|
+
# @!attribute total_paid
|
|
88
|
+
# Amount paid towards the plan as of this statement in cents
|
|
89
|
+
#
|
|
90
|
+
# @return [Integer]
|
|
91
|
+
required :total_paid, Integer
|
|
92
|
+
|
|
93
|
+
# @!method initialize(token:, fee_amount:, installment_plan_token:, installment_plan_total:, installments:, installments_outstanding:, installments_paid:, num_installments:, principal_amount:, source_type:, start_date:, state:, total_paid:)
|
|
94
|
+
# Some parameter documentations has been truncated, see
|
|
95
|
+
# {Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement}
|
|
96
|
+
# for more details.
|
|
97
|
+
#
|
|
98
|
+
# An immutable snapshot of an installment plan as of the statement it is attached
|
|
99
|
+
# to. Lithic cuts one per open plan when a statement is generated and never
|
|
100
|
+
# reissues it
|
|
101
|
+
#
|
|
102
|
+
# @param token [String] Globally unique identifier for this snapshot, which is the token of the statemen
|
|
103
|
+
#
|
|
104
|
+
# @param fee_amount [Integer] Enrollment fee charged when the plan was created in cents
|
|
105
|
+
#
|
|
106
|
+
# @param installment_plan_token [String] Globally unique identifier for the installment plan this snapshot is of
|
|
107
|
+
#
|
|
108
|
+
# @param installment_plan_total [Integer] Total owed on the plan in cents, the principal amount plus the enrollment fee
|
|
109
|
+
#
|
|
110
|
+
# @param installments [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment>] Installments that make up the plan, oldest first
|
|
111
|
+
#
|
|
112
|
+
# @param installments_outstanding [Integer] Number of installments that still carried a balance as of this statement
|
|
113
|
+
#
|
|
114
|
+
# @param installments_paid [Integer] Number of installments that had been paid off as of this statement
|
|
115
|
+
#
|
|
116
|
+
# @param num_installments [Integer] Number of installments the plan is broken into
|
|
117
|
+
#
|
|
118
|
+
# @param principal_amount [Integer] Balance the plan was opened on in cents, excluding the enrollment fee
|
|
119
|
+
#
|
|
120
|
+
# @param source_type [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType]
|
|
121
|
+
#
|
|
122
|
+
# @param start_date [Date] Date the plan was created
|
|
123
|
+
#
|
|
124
|
+
# @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State] State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan tape
|
|
125
|
+
#
|
|
126
|
+
# @param total_paid [Integer] Amount paid towards the plan as of this statement in cents
|
|
127
|
+
|
|
128
|
+
class Installment < Lithic::Internal::Type::BaseModel
|
|
129
|
+
# @!attribute amount_due
|
|
130
|
+
# Amount the installment was opened for in cents
|
|
131
|
+
#
|
|
132
|
+
# @return [Integer]
|
|
133
|
+
required :amount_due, Integer
|
|
134
|
+
|
|
135
|
+
# @!attribute amount_due_details
|
|
136
|
+
#
|
|
137
|
+
# @return [Lithic::Models::FinancialAccounts::CategoryBalances]
|
|
138
|
+
required :amount_due_details, -> { Lithic::FinancialAccounts::CategoryBalances }
|
|
139
|
+
|
|
140
|
+
# @!attribute amount_outstanding
|
|
141
|
+
# Amount still owed on the installment in cents
|
|
142
|
+
#
|
|
143
|
+
# @return [Integer]
|
|
144
|
+
required :amount_outstanding, Integer
|
|
145
|
+
|
|
146
|
+
# @!attribute amount_outstanding_details
|
|
147
|
+
#
|
|
148
|
+
# @return [Lithic::Models::FinancialAccounts::CategoryBalances]
|
|
149
|
+
required :amount_outstanding_details, -> { Lithic::FinancialAccounts::CategoryBalances }
|
|
150
|
+
|
|
151
|
+
# @!attribute amount_paid
|
|
152
|
+
# Amount paid towards the installment in cents
|
|
153
|
+
#
|
|
154
|
+
# @return [Integer]
|
|
155
|
+
required :amount_paid, Integer
|
|
156
|
+
|
|
157
|
+
# @!attribute amount_paid_details
|
|
158
|
+
#
|
|
159
|
+
# @return [Lithic::Models::FinancialAccounts::CategoryBalances]
|
|
160
|
+
required :amount_paid_details, -> { Lithic::FinancialAccounts::CategoryBalances }
|
|
161
|
+
|
|
162
|
+
# @!attribute date_assessed
|
|
163
|
+
# Date the installment was actually assessed onto the account, or null if it had
|
|
164
|
+
# not been assessed as of this statement
|
|
165
|
+
#
|
|
166
|
+
# @return [Date, nil]
|
|
167
|
+
required :date_assessed, Date, nil?: true
|
|
168
|
+
|
|
169
|
+
# @!attribute due_date
|
|
170
|
+
# Date the installment is scheduled to be assessed onto the account
|
|
171
|
+
#
|
|
172
|
+
# @return [Date]
|
|
173
|
+
required :due_date, Date
|
|
174
|
+
|
|
175
|
+
# @!attribute installment_num
|
|
176
|
+
# Position of this installment within the plan, starting at 0
|
|
177
|
+
#
|
|
178
|
+
# @return [Integer]
|
|
179
|
+
required :installment_num, Integer
|
|
180
|
+
|
|
181
|
+
# @!attribute payment_due_date
|
|
182
|
+
# Date the installment must be paid by before it is considered past due
|
|
183
|
+
#
|
|
184
|
+
# @return [Date]
|
|
185
|
+
required :payment_due_date, Date
|
|
186
|
+
|
|
187
|
+
# @!attribute payments
|
|
188
|
+
# Payments applied to this installment, oldest first
|
|
189
|
+
#
|
|
190
|
+
# @return [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment>]
|
|
191
|
+
required :payments,
|
|
192
|
+
-> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment] }
|
|
193
|
+
|
|
194
|
+
# @!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:)
|
|
195
|
+
# Some parameter documentations has been truncated, see
|
|
196
|
+
# {Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment}
|
|
197
|
+
# for more details.
|
|
198
|
+
#
|
|
199
|
+
# One installment of a plan as of the statement. Amounts are totalled across
|
|
200
|
+
# transaction categories rather than broken out by them, which the installment
|
|
201
|
+
# plan endpoint does
|
|
202
|
+
#
|
|
203
|
+
# @param amount_due [Integer] Amount the installment was opened for in cents
|
|
204
|
+
#
|
|
205
|
+
# @param amount_due_details [Lithic::Models::FinancialAccounts::CategoryBalances]
|
|
206
|
+
#
|
|
207
|
+
# @param amount_outstanding [Integer] Amount still owed on the installment in cents
|
|
208
|
+
#
|
|
209
|
+
# @param amount_outstanding_details [Lithic::Models::FinancialAccounts::CategoryBalances]
|
|
210
|
+
#
|
|
211
|
+
# @param amount_paid [Integer] Amount paid towards the installment in cents
|
|
212
|
+
#
|
|
213
|
+
# @param amount_paid_details [Lithic::Models::FinancialAccounts::CategoryBalances]
|
|
214
|
+
#
|
|
215
|
+
# @param date_assessed [Date, nil] Date the installment was actually assessed onto the account, or null if it had n
|
|
216
|
+
#
|
|
217
|
+
# @param due_date [Date] Date the installment is scheduled to be assessed onto the account
|
|
218
|
+
#
|
|
219
|
+
# @param installment_num [Integer] Position of this installment within the plan, starting at 0
|
|
220
|
+
#
|
|
221
|
+
# @param payment_due_date [Date] Date the installment must be paid by before it is considered past due
|
|
222
|
+
#
|
|
223
|
+
# @param payments [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment>] Payments applied to this installment, oldest first
|
|
224
|
+
|
|
225
|
+
class Payment < Lithic::Internal::Type::BaseModel
|
|
226
|
+
# @!attribute amount
|
|
227
|
+
# Amount applied to the installment in cents
|
|
228
|
+
#
|
|
229
|
+
# @return [Integer]
|
|
230
|
+
required :amount, Integer
|
|
231
|
+
|
|
232
|
+
# @!attribute date
|
|
233
|
+
# Date the payment was applied to the installment
|
|
234
|
+
#
|
|
235
|
+
# @return [Date]
|
|
236
|
+
required :date, Date
|
|
237
|
+
|
|
238
|
+
# @!method initialize(amount:, date:)
|
|
239
|
+
# @param amount [Integer] Amount applied to the installment in cents
|
|
240
|
+
#
|
|
241
|
+
# @param date [Date] Date the payment was applied to the installment
|
|
242
|
+
end
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
# @see Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement#source_type
|
|
246
|
+
module SourceType
|
|
247
|
+
extend Lithic::Internal::Type::Enum
|
|
248
|
+
|
|
249
|
+
UNPAID_BALANCE = :UNPAID_BALANCE
|
|
250
|
+
TRANSACTION = :TRANSACTION
|
|
251
|
+
|
|
252
|
+
# @!method self.values
|
|
253
|
+
# @return [Array<Symbol>]
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
# State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan
|
|
257
|
+
# tapes are being rebuilt, during which its payment totals are being recomputed
|
|
258
|
+
# and should not be treated as final
|
|
259
|
+
#
|
|
260
|
+
# @see Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement#state
|
|
261
|
+
module State
|
|
262
|
+
extend Lithic::Internal::Type::Enum
|
|
263
|
+
|
|
264
|
+
PENDING = :PENDING
|
|
265
|
+
ACTIVE = :ACTIVE
|
|
266
|
+
REBUILD_IN_PROGRESS = :REBUILD_IN_PROGRESS
|
|
267
|
+
FULLY_PAID = :FULLY_PAID
|
|
268
|
+
CANCELLED = :CANCELLED
|
|
269
|
+
|
|
270
|
+
# @!method self.values
|
|
271
|
+
# @return [Array<Symbol>]
|
|
272
|
+
end
|
|
273
|
+
end
|
|
274
|
+
end
|
|
275
|
+
|
|
276
|
+
InstallmentPlanStatement = InstallmentPlans::InstallmentPlanStatement
|
|
277
|
+
end
|
|
278
|
+
end
|
|
279
|
+
end
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Lithic
|
|
4
|
+
module Models
|
|
5
|
+
module FinancialAccounts
|
|
6
|
+
module InstallmentPlans
|
|
7
|
+
# @see Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements#list
|
|
8
|
+
class StatementListParams < Lithic::Internal::Type::BaseModel
|
|
9
|
+
extend Lithic::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include Lithic::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
# @!attribute financial_account_token
|
|
13
|
+
# Globally unique identifier for financial account.
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :financial_account_token, String
|
|
17
|
+
|
|
18
|
+
# @!attribute installment_plan_token
|
|
19
|
+
# Globally unique identifier for installment plan.
|
|
20
|
+
#
|
|
21
|
+
# @return [String]
|
|
22
|
+
required :installment_plan_token, String
|
|
23
|
+
|
|
24
|
+
# @!attribute begin_
|
|
25
|
+
# Date string in RFC 3339 format. Only entries created after the specified date
|
|
26
|
+
# will be included.
|
|
27
|
+
#
|
|
28
|
+
# @return [Date, nil]
|
|
29
|
+
optional :begin_, Date
|
|
30
|
+
|
|
31
|
+
# @!attribute end_
|
|
32
|
+
# Date string in RFC 3339 format. Only entries created before the specified date
|
|
33
|
+
# will be included.
|
|
34
|
+
#
|
|
35
|
+
# @return [Date, nil]
|
|
36
|
+
optional :end_, Date
|
|
37
|
+
|
|
38
|
+
# @!attribute ending_before
|
|
39
|
+
# A cursor representing an item's token before which a page of results should end.
|
|
40
|
+
# Used to retrieve the previous page of results before this item.
|
|
41
|
+
#
|
|
42
|
+
# @return [String, nil]
|
|
43
|
+
optional :ending_before, String
|
|
44
|
+
|
|
45
|
+
# @!attribute page_size
|
|
46
|
+
# Page size (for pagination).
|
|
47
|
+
#
|
|
48
|
+
# @return [Integer, nil]
|
|
49
|
+
optional :page_size, Integer
|
|
50
|
+
|
|
51
|
+
# @!attribute starting_after
|
|
52
|
+
# A cursor representing an item's token after which a page of results should
|
|
53
|
+
# begin. Used to retrieve the next page of results after this item.
|
|
54
|
+
#
|
|
55
|
+
# @return [String, nil]
|
|
56
|
+
optional :starting_after, String
|
|
57
|
+
|
|
58
|
+
# @!attribute state
|
|
59
|
+
# Only snapshots in which the plan was in this state will be included.
|
|
60
|
+
#
|
|
61
|
+
# @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams::State, nil]
|
|
62
|
+
optional :state,
|
|
63
|
+
enum: -> { Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State },
|
|
64
|
+
nil?: true
|
|
65
|
+
|
|
66
|
+
# @!method initialize(financial_account_token:, installment_plan_token:, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, state: nil, request_options: {})
|
|
67
|
+
# Some parameter documentations has been truncated, see
|
|
68
|
+
# {Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams} for
|
|
69
|
+
# more details.
|
|
70
|
+
#
|
|
71
|
+
# @param financial_account_token [String] Globally unique identifier for financial account.
|
|
72
|
+
#
|
|
73
|
+
# @param installment_plan_token [String] Globally unique identifier for installment plan.
|
|
74
|
+
#
|
|
75
|
+
# @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
|
|
76
|
+
#
|
|
77
|
+
# @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
|
|
78
|
+
#
|
|
79
|
+
# @param ending_before [String] A cursor representing an item's token before which a page of results should end.
|
|
80
|
+
#
|
|
81
|
+
# @param page_size [Integer] Page size (for pagination).
|
|
82
|
+
#
|
|
83
|
+
# @param starting_after [String] A cursor representing an item's token after which a page of results should begin
|
|
84
|
+
#
|
|
85
|
+
# @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams::State, nil] Only snapshots in which the plan was in this state will be included.
|
|
86
|
+
#
|
|
87
|
+
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
|
|
88
|
+
|
|
89
|
+
# Only snapshots in which the plan was in this state will be included.
|
|
90
|
+
module State
|
|
91
|
+
extend Lithic::Internal::Type::Enum
|
|
92
|
+
|
|
93
|
+
PENDING = :PENDING
|
|
94
|
+
ACTIVE = :ACTIVE
|
|
95
|
+
REBUILD_IN_PROGRESS = :REBUILD_IN_PROGRESS
|
|
96
|
+
FULLY_PAID = :FULLY_PAID
|
|
97
|
+
CANCELLED = :CANCELLED
|
|
98
|
+
|
|
99
|
+
# @!method self.values
|
|
100
|
+
# @return [Array<Symbol>]
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
end
|
|
106
|
+
end
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Lithic
|
|
4
|
+
module Models
|
|
5
|
+
module FinancialAccounts
|
|
6
|
+
module InstallmentPlans
|
|
7
|
+
# @see Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements#retrieve
|
|
8
|
+
class StatementRetrieveParams < Lithic::Internal::Type::BaseModel
|
|
9
|
+
extend Lithic::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include Lithic::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
# @!attribute financial_account_token
|
|
13
|
+
# Globally unique identifier for financial account.
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :financial_account_token, String
|
|
17
|
+
|
|
18
|
+
# @!attribute installment_plan_token
|
|
19
|
+
# Globally unique identifier for installment plan.
|
|
20
|
+
#
|
|
21
|
+
# @return [String]
|
|
22
|
+
required :installment_plan_token, String
|
|
23
|
+
|
|
24
|
+
# @!attribute statement_token
|
|
25
|
+
# Globally unique identifier for statement.
|
|
26
|
+
#
|
|
27
|
+
# @return [String]
|
|
28
|
+
required :statement_token, String
|
|
29
|
+
|
|
30
|
+
# @!method initialize(financial_account_token:, installment_plan_token:, statement_token:, request_options: {})
|
|
31
|
+
# @param financial_account_token [String] Globally unique identifier for financial account.
|
|
32
|
+
#
|
|
33
|
+
# @param installment_plan_token [String] Globally unique identifier for installment plan.
|
|
34
|
+
#
|
|
35
|
+
# @param statement_token [String] Globally unique identifier for statement.
|
|
36
|
+
#
|
|
37
|
+
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
@@ -93,6 +93,14 @@ module Lithic
|
|
|
93
93
|
# @return [Lithic::Models::FinancialAccounts::LoanTape::PaymentAllocation]
|
|
94
94
|
required :payment_allocation, -> { Lithic::FinancialAccounts::LoanTape::PaymentAllocation }
|
|
95
95
|
|
|
96
|
+
# @!attribute payment_only_allocation
|
|
97
|
+
# Allocation of payments only, excluding credits
|
|
98
|
+
#
|
|
99
|
+
# @return [Lithic::Models::FinancialAccounts::LoanTape::PaymentOnlyAllocation, nil]
|
|
100
|
+
required :payment_only_allocation,
|
|
101
|
+
-> { Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation },
|
|
102
|
+
nil?: true
|
|
103
|
+
|
|
96
104
|
# @!attribute period_totals
|
|
97
105
|
#
|
|
98
106
|
# @return [Lithic::Models::StatementTotals]
|
|
@@ -138,7 +146,7 @@ module Lithic
|
|
|
138
146
|
# @return [String, nil]
|
|
139
147
|
optional :tier, String, nil?: true
|
|
140
148
|
|
|
141
|
-
# @!method initialize(token:, account_standing:, available_credit:, balances:, created:, credit_limit:, credit_product_token:, date:, day_totals:, ending_balance:, excess_credits:, financial_account_token:, interest_details:, minimum_payment_balance:, payment_allocation:, period_totals:, previous_statement_balance:, starting_balance:, updated:, version:, ytd_totals:, day_of_period: nil, tier: nil)
|
|
149
|
+
# @!method initialize(token:, account_standing:, available_credit:, balances:, created:, credit_limit:, credit_product_token:, date:, day_totals:, ending_balance:, excess_credits:, financial_account_token:, interest_details:, minimum_payment_balance:, payment_allocation:, payment_only_allocation:, period_totals:, previous_statement_balance:, starting_balance:, updated:, version:, ytd_totals:, day_of_period: nil, tier: nil)
|
|
142
150
|
# Some parameter documentations has been truncated, see
|
|
143
151
|
# {Lithic::Models::FinancialAccounts::LoanTape} for more details.
|
|
144
152
|
#
|
|
@@ -172,6 +180,8 @@ module Lithic
|
|
|
172
180
|
#
|
|
173
181
|
# @param payment_allocation [Lithic::Models::FinancialAccounts::LoanTape::PaymentAllocation]
|
|
174
182
|
#
|
|
183
|
+
# @param payment_only_allocation [Lithic::Models::FinancialAccounts::LoanTape::PaymentOnlyAllocation, nil] Allocation of payments only, excluding credits
|
|
184
|
+
#
|
|
175
185
|
# @param period_totals [Lithic::Models::StatementTotals]
|
|
176
186
|
#
|
|
177
187
|
# @param previous_statement_balance [Lithic::Models::FinancialAccounts::LoanTape::PreviousStatementBalance]
|
|
@@ -494,6 +504,57 @@ module Lithic
|
|
|
494
504
|
# @param principal_details [Lithic::Models::CategoryDetails, nil]
|
|
495
505
|
end
|
|
496
506
|
|
|
507
|
+
# @see Lithic::Models::FinancialAccounts::LoanTape#payment_only_allocation
|
|
508
|
+
class PaymentOnlyAllocation < Lithic::Internal::Type::BaseModel
|
|
509
|
+
# @!attribute fee_details
|
|
510
|
+
#
|
|
511
|
+
# @return [Lithic::Models::CategoryDetails, nil]
|
|
512
|
+
required :fee_details, -> { Lithic::CategoryDetails }, nil?: true
|
|
513
|
+
|
|
514
|
+
# @!attribute fees
|
|
515
|
+
# Amount allocated to fees in cents
|
|
516
|
+
#
|
|
517
|
+
# @return [Integer]
|
|
518
|
+
required :fees, Integer
|
|
519
|
+
|
|
520
|
+
# @!attribute interest
|
|
521
|
+
# Amount allocated to interest in cents
|
|
522
|
+
#
|
|
523
|
+
# @return [Integer]
|
|
524
|
+
required :interest, Integer
|
|
525
|
+
|
|
526
|
+
# @!attribute interest_details
|
|
527
|
+
#
|
|
528
|
+
# @return [Lithic::Models::CategoryDetails, nil]
|
|
529
|
+
required :interest_details, -> { Lithic::CategoryDetails }, nil?: true
|
|
530
|
+
|
|
531
|
+
# @!attribute principal
|
|
532
|
+
# Amount allocated to principal in cents
|
|
533
|
+
#
|
|
534
|
+
# @return [Integer]
|
|
535
|
+
required :principal, Integer
|
|
536
|
+
|
|
537
|
+
# @!attribute principal_details
|
|
538
|
+
#
|
|
539
|
+
# @return [Lithic::Models::CategoryDetails, nil]
|
|
540
|
+
required :principal_details, -> { Lithic::CategoryDetails }, nil?: true
|
|
541
|
+
|
|
542
|
+
# @!method initialize(fee_details:, fees:, interest:, interest_details:, principal:, principal_details:)
|
|
543
|
+
# Allocation of payments only, excluding credits
|
|
544
|
+
#
|
|
545
|
+
# @param fee_details [Lithic::Models::CategoryDetails, nil]
|
|
546
|
+
#
|
|
547
|
+
# @param fees [Integer] Amount allocated to fees in cents
|
|
548
|
+
#
|
|
549
|
+
# @param interest [Integer] Amount allocated to interest in cents
|
|
550
|
+
#
|
|
551
|
+
# @param interest_details [Lithic::Models::CategoryDetails, nil]
|
|
552
|
+
#
|
|
553
|
+
# @param principal [Integer] Amount allocated to principal in cents
|
|
554
|
+
#
|
|
555
|
+
# @param principal_details [Lithic::Models::CategoryDetails, nil]
|
|
556
|
+
end
|
|
557
|
+
|
|
497
558
|
# @see Lithic::Models::FinancialAccounts::LoanTape#previous_statement_balance
|
|
498
559
|
class PreviousStatementBalance < Lithic::Internal::Type::BaseModel
|
|
499
560
|
# @!attribute amount
|
|
@@ -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
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Lithic
|
|
4
|
+
module Models
|
|
5
|
+
module FinancialAccounts
|
|
6
|
+
class OpenToBuySummary < Lithic::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute security
|
|
8
|
+
# Available balance of the Security Account backing card spend, in the currency's
|
|
9
|
+
# smallest unit (e.g., cents for USD)
|
|
10
|
+
#
|
|
11
|
+
# @return [Integer]
|
|
12
|
+
required :security, Integer
|
|
13
|
+
|
|
14
|
+
# @!attribute settled_funds
|
|
15
|
+
# Funding that has moved out of the Security Account to cover card spend Lithic
|
|
16
|
+
# has already paid out to the networks, in the currency's smallest unit (e.g.,
|
|
17
|
+
# cents for USD). Open to buy counts it alongside `security`, and it clears once
|
|
18
|
+
# collected from your business clients. Only Commercial Charge tracks this
|
|
19
|
+
# separately, so this is `null` for every other program setup
|
|
20
|
+
#
|
|
21
|
+
# @return [Integer, nil]
|
|
22
|
+
required :settled_funds, Integer, nil?: true
|
|
23
|
+
|
|
24
|
+
# @!attribute total_outstanding_spend
|
|
25
|
+
# Customer card spend that has not yet been collected, in the currency's smallest
|
|
26
|
+
# unit (e.g., cents for USD). Reported as a negative amount, because it reduces
|
|
27
|
+
# open to buy
|
|
28
|
+
#
|
|
29
|
+
# @return [Integer]
|
|
30
|
+
required :total_outstanding_spend, Integer
|
|
31
|
+
|
|
32
|
+
# @!method initialize(security:, settled_funds:, total_outstanding_spend:)
|
|
33
|
+
# Some parameter documentations has been truncated, see
|
|
34
|
+
# {Lithic::Models::FinancialAccounts::OpenToBuySummary} for more details.
|
|
35
|
+
#
|
|
36
|
+
# Open to Buy Summary
|
|
37
|
+
#
|
|
38
|
+
# @param security [Integer] Available balance of the Security Account backing card spend, in the currency's
|
|
39
|
+
#
|
|
40
|
+
# @param settled_funds [Integer, nil] Funding that has moved out of the Security Account to cover card spend Lithic ha
|
|
41
|
+
#
|
|
42
|
+
# @param total_outstanding_spend [Integer] Customer card spend that has not yet been collected, in the currency's
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
@@ -162,6 +162,7 @@ module Lithic
|
|
|
162
162
|
EXTERNAL_CHECK = :EXTERNAL_CHECK
|
|
163
163
|
EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
|
|
164
164
|
EXTERNAL_RTP = :EXTERNAL_RTP
|
|
165
|
+
EXTERNAL_STABLECOIN = :EXTERNAL_STABLECOIN
|
|
165
166
|
EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
|
|
166
167
|
EXTERNAL_WIRE = :EXTERNAL_WIRE
|
|
167
168
|
MANAGEMENT_ADJUSTMENT = :MANAGEMENT_ADJUSTMENT
|
|
@@ -234,6 +235,11 @@ module Lithic
|
|
|
234
235
|
EXTERNAL_RTP_RELEASED = :EXTERNAL_RTP_RELEASED
|
|
235
236
|
EXTERNAL_RTP_REVERSED = :EXTERNAL_RTP_REVERSED
|
|
236
237
|
EXTERNAL_RTP_SETTLED = :EXTERNAL_RTP_SETTLED
|
|
238
|
+
EXTERNAL_STABLECOIN_CANCELED = :EXTERNAL_STABLECOIN_CANCELED
|
|
239
|
+
EXTERNAL_STABLECOIN_INITIATED = :EXTERNAL_STABLECOIN_INITIATED
|
|
240
|
+
EXTERNAL_STABLECOIN_RELEASED = :EXTERNAL_STABLECOIN_RELEASED
|
|
241
|
+
EXTERNAL_STABLECOIN_REVERSED = :EXTERNAL_STABLECOIN_REVERSED
|
|
242
|
+
EXTERNAL_STABLECOIN_SETTLED = :EXTERNAL_STABLECOIN_SETTLED
|
|
237
243
|
EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED
|
|
238
244
|
EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED
|
|
239
245
|
EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED
|
|
@@ -244,8 +250,12 @@ module Lithic
|
|
|
244
250
|
EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED
|
|
245
251
|
EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED
|
|
246
252
|
EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED
|
|
253
|
+
FEE = :FEE
|
|
254
|
+
FEE_REVERSAL = :FEE_REVERSAL
|
|
247
255
|
FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION
|
|
248
256
|
FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION
|
|
257
|
+
INSTALLMENT_FEE = :INSTALLMENT_FEE
|
|
258
|
+
INSTALLMENT_FEE_REVERSAL = :INSTALLMENT_FEE_REVERSAL
|
|
249
259
|
INTEREST = :INTEREST
|
|
250
260
|
INTEREST_REVERSAL = :INTEREST_REVERSAL
|
|
251
261
|
INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
|