lithic 0.2.0 → 0.3.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 (91) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +38 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/client.rb +5 -10
  5. data/lib/lithic/internal/transport/pooled_net_requester.rb +12 -10
  6. data/lib/lithic/internal/util.rb +7 -2
  7. data/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb +5 -0
  8. data/lib/lithic/models/book_transfer_retry_params.rb +26 -0
  9. data/lib/lithic/models/{asa_request_webhook_event.rb → card_authorization_approval_request_webhook_event.rb} +151 -129
  10. data/lib/lithic/models/external_payment_create_params.rb +15 -1
  11. data/lib/lithic/models/financial_account.rb +33 -25
  12. data/lib/lithic/models/financial_account_update_status_params.rb +9 -1
  13. data/lib/lithic/models/financial_accounts/loan_tape.rb +52 -3
  14. data/lib/lithic/models/management_operation_create_params.rb +6 -1
  15. data/lib/lithic/models/parsed_webhook_event.rb +3 -4
  16. data/lib/lithic/models/payment.rb +10 -1
  17. data/lib/lithic/models/three_ds_authentication_approval_request_webhook_event.rb +17 -0
  18. data/lib/lithic/models/transaction.rb +2 -0
  19. data/lib/lithic/models/transfer_limit_list_params.rb +22 -0
  20. data/lib/lithic/models/transfer_limits_response.rb +274 -0
  21. data/lib/lithic/models.rb +12 -6
  22. data/lib/lithic/resources/book_transfers.rb +27 -0
  23. data/lib/lithic/resources/cards.rb +1 -5
  24. data/lib/lithic/resources/external_payments.rb +13 -1
  25. data/lib/lithic/resources/financial_accounts.rb +3 -1
  26. data/lib/lithic/resources/management_operations.rb +4 -1
  27. data/lib/lithic/resources/transfer_limits.rb +37 -0
  28. data/lib/lithic/resources/webhooks.rb +3 -2
  29. data/lib/lithic/version.rb +1 -1
  30. data/lib/lithic.rb +6 -7
  31. data/rbi/lithic/client.rbi +3 -3
  32. data/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi +11 -0
  33. data/rbi/lithic/models/book_transfer_retry_params.rbi +42 -0
  34. data/rbi/lithic/models/{asa_request_webhook_event.rbi → card_authorization_approval_request_webhook_event.rbi} +394 -256
  35. data/rbi/lithic/models/external_payment_create_params.rbi +4 -0
  36. data/rbi/lithic/models/financial_account.rbi +62 -54
  37. data/rbi/lithic/models/financial_account_update_status_params.rbi +11 -0
  38. data/rbi/lithic/models/financial_accounts/loan_tape.rbi +93 -4
  39. data/rbi/lithic/models/management_operation_create_params.rbi +4 -0
  40. data/rbi/lithic/models/parsed_webhook_event.rbi +2 -2
  41. data/rbi/lithic/models/payment.rbi +13 -3
  42. data/rbi/lithic/models/three_ds_authentication_approval_request_webhook_event.rbi +27 -0
  43. data/rbi/lithic/models/transaction.rbi +10 -0
  44. data/rbi/lithic/models/transfer_limit_list_params.rbi +43 -0
  45. data/rbi/lithic/models/transfer_limits_response.rbi +604 -0
  46. data/rbi/lithic/models.rbi +12 -6
  47. data/rbi/lithic/resources/book_transfers.rbi +18 -0
  48. data/rbi/lithic/resources/cards.rbi +1 -4
  49. data/rbi/lithic/resources/external_payments.rbi +2 -0
  50. data/rbi/lithic/resources/financial_accounts.rbi +3 -0
  51. data/rbi/lithic/resources/management_operations.rbi +2 -0
  52. data/rbi/lithic/resources/transfer_limits.rbi +28 -0
  53. data/rbi/lithic/resources/webhooks.rbi +2 -124
  54. data/sig/lithic/client.rbs +2 -2
  55. data/sig/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbs +2 -0
  56. data/sig/lithic/models/book_transfer_retry_params.rbs +23 -0
  57. data/sig/lithic/models/{asa_request_webhook_event.rbs → card_authorization_approval_request_webhook_event.rbs} +161 -156
  58. data/sig/lithic/models/financial_account.rbs +32 -27
  59. data/sig/lithic/models/financial_account_update_status_params.rbs +8 -1
  60. data/sig/lithic/models/financial_accounts/loan_tape.rbs +46 -4
  61. data/sig/lithic/models/parsed_webhook_event.rbs +2 -2
  62. data/sig/lithic/models/payment.rbs +10 -3
  63. data/sig/lithic/models/three_ds_authentication_approval_request_webhook_event.rbs +22 -0
  64. data/sig/lithic/models/transaction.rbs +4 -0
  65. data/sig/lithic/models/transfer_limit_list_params.rbs +22 -0
  66. data/sig/lithic/models/transfer_limits_response.rbs +232 -0
  67. data/sig/lithic/models.rbs +10 -6
  68. data/sig/lithic/resources/book_transfers.rbs +6 -0
  69. data/sig/lithic/resources/cards.rbs +0 -2
  70. data/sig/lithic/resources/financial_accounts.rbs +1 -0
  71. data/sig/lithic/resources/transfer_limits.rbs +12 -0
  72. data/sig/lithic/resources/webhooks.rbs +2 -116
  73. metadata +20 -23
  74. data/lib/lithic/models/aggregate_balance.rb +0 -113
  75. data/lib/lithic/models/aggregate_balance_list_params.rb +0 -35
  76. data/lib/lithic/models/cards/aggregate_balance_list_params.rb +0 -32
  77. data/lib/lithic/models/cards/aggregate_balance_list_response.rb +0 -92
  78. data/lib/lithic/resources/aggregate_balances.rb +0 -38
  79. data/lib/lithic/resources/cards/aggregate_balances.rb +0 -41
  80. data/rbi/lithic/models/aggregate_balance.rbi +0 -164
  81. data/rbi/lithic/models/aggregate_balance_list_params.rbi +0 -104
  82. data/rbi/lithic/models/cards/aggregate_balance_list_params.rbi +0 -62
  83. data/rbi/lithic/models/cards/aggregate_balance_list_response.rbi +0 -115
  84. data/rbi/lithic/resources/aggregate_balances.rbi +0 -28
  85. data/rbi/lithic/resources/cards/aggregate_balances.rbi +0 -35
  86. data/sig/lithic/models/aggregate_balance.rbs +0 -78
  87. data/sig/lithic/models/aggregate_balance_list_params.rbs +0 -43
  88. data/sig/lithic/models/cards/aggregate_balance_list_params.rbs +0 -34
  89. data/sig/lithic/models/cards/aggregate_balance_list_response.rbs +0 -62
  90. data/sig/lithic/resources/aggregate_balances.rbs +0 -12
  91. data/sig/lithic/resources/cards/aggregate_balances.rbs +0 -15
@@ -33,6 +33,8 @@ module Lithic
33
33
  required :payment_type, enum: -> { Lithic::ExternalPaymentCreateParams::PaymentType }
34
34
 
35
35
  # @!attribute token
36
+ # Customer-provided token that will serve as an idempotency token. This token will
37
+ # become the transaction token.
36
38
  #
37
39
  # @return [String, nil]
38
40
  optional :token, String
@@ -53,15 +55,27 @@ module Lithic
53
55
  optional :user_defined_id, String
54
56
 
55
57
  # @!method initialize(amount:, category:, effective_date:, financial_account_token:, payment_type:, token: nil, memo: nil, progress_to: nil, user_defined_id: nil, request_options: {})
58
+ # Some parameter documentations has been truncated, see
59
+ # {Lithic::Models::ExternalPaymentCreateParams} for more details.
60
+ #
56
61
  # @param amount [Integer]
62
+ #
57
63
  # @param category [Symbol, Lithic::Models::ExternalPaymentCreateParams::Category]
64
+ #
58
65
  # @param effective_date [Date]
66
+ #
59
67
  # @param financial_account_token [String]
68
+ #
60
69
  # @param payment_type [Symbol, Lithic::Models::ExternalPaymentCreateParams::PaymentType]
61
- # @param token [String]
70
+ #
71
+ # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
72
+ #
62
73
  # @param memo [String]
74
+ #
63
75
  # @param progress_to [Symbol, Lithic::Models::ExternalPaymentCreateParams::ProgressTo]
76
+ #
64
77
  # @param user_defined_id [String]
78
+ #
65
79
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
66
80
 
67
81
  module Category
@@ -42,6 +42,12 @@ module Lithic
42
42
  # @return [Symbol, Lithic::Models::FinancialAccount::Status]
43
43
  required :status, enum: -> { Lithic::FinancialAccount::Status }
44
44
 
45
+ # @!attribute substatus
46
+ # Substatus for the financial account
47
+ #
48
+ # @return [Symbol, Lithic::Models::FinancialAccount::Substatus, nil]
49
+ required :substatus, enum: -> { Lithic::FinancialAccount::Substatus }, nil?: true
50
+
45
51
  # @!attribute type
46
52
  #
47
53
  # @return [Symbol, Lithic::Models::FinancialAccount::Type]
@@ -52,6 +58,12 @@ module Lithic
52
58
  # @return [Time]
53
59
  required :updated, Time
54
60
 
61
+ # @!attribute user_defined_status
62
+ # User-defined status for the financial account
63
+ #
64
+ # @return [String, nil]
65
+ required :user_defined_status, String, nil?: true
66
+
55
67
  # @!attribute account_number
56
68
  #
57
69
  # @return [String, nil]
@@ -62,13 +74,7 @@ module Lithic
62
74
  # @return [String, nil]
63
75
  optional :routing_number, String, nil?: true
64
76
 
65
- # @!attribute substatus
66
- # Substatus for the financial account
67
- #
68
- # @return [Symbol, Lithic::Models::FinancialAccount::Substatus, nil]
69
- optional :substatus, enum: -> { Lithic::FinancialAccount::Substatus }, nil?: true
70
-
71
- # @!method initialize(token:, account_token:, created:, credit_configuration:, is_for_benefit_of:, nickname:, status:, type:, updated:, account_number: nil, routing_number: nil, substatus: nil)
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)
72
78
  # @param token [String] Globally unique identifier for the account
73
79
  #
74
80
  # @param account_token [String, nil]
@@ -83,15 +89,17 @@ module Lithic
83
89
  #
84
90
  # @param status [Symbol, Lithic::Models::FinancialAccount::Status] Status of the financial account
85
91
  #
92
+ # @param substatus [Symbol, Lithic::Models::FinancialAccount::Substatus, nil] Substatus for the financial account
93
+ #
86
94
  # @param type [Symbol, Lithic::Models::FinancialAccount::Type]
87
95
  #
88
96
  # @param updated [Time]
89
97
  #
98
+ # @param user_defined_status [String, nil] User-defined status for the financial account
99
+ #
90
100
  # @param account_number [String, nil]
91
101
  #
92
102
  # @param routing_number [String, nil]
93
- #
94
- # @param substatus [Symbol, Lithic::Models::FinancialAccount::Substatus, nil] Substatus for the financial account
95
103
 
96
104
  # @see Lithic::Models::FinancialAccount#credit_configuration
97
105
  class CreditConfiguration < Lithic::Internal::Type::BaseModel
@@ -163,6 +171,22 @@ module Lithic
163
171
  # @return [Array<Symbol>]
164
172
  end
165
173
 
174
+ # Substatus for the financial account
175
+ #
176
+ # @see Lithic::Models::FinancialAccount#substatus
177
+ module Substatus
178
+ extend Lithic::Internal::Type::Enum
179
+
180
+ CHARGED_OFF_DELINQUENT = :CHARGED_OFF_DELINQUENT
181
+ CHARGED_OFF_FRAUD = :CHARGED_OFF_FRAUD
182
+ END_USER_REQUEST = :END_USER_REQUEST
183
+ BANK_REQUEST = :BANK_REQUEST
184
+ DELINQUENT = :DELINQUENT
185
+
186
+ # @!method self.values
187
+ # @return [Array<Symbol>]
188
+ end
189
+
166
190
  # @see Lithic::Models::FinancialAccount#type
167
191
  module Type
168
192
  extend Lithic::Internal::Type::Enum
@@ -181,22 +205,6 @@ module Lithic
181
205
  # @!method self.values
182
206
  # @return [Array<Symbol>]
183
207
  end
184
-
185
- # Substatus for the financial account
186
- #
187
- # @see Lithic::Models::FinancialAccount#substatus
188
- module Substatus
189
- extend Lithic::Internal::Type::Enum
190
-
191
- CHARGED_OFF_DELINQUENT = :CHARGED_OFF_DELINQUENT
192
- CHARGED_OFF_FRAUD = :CHARGED_OFF_FRAUD
193
- END_USER_REQUEST = :END_USER_REQUEST
194
- BANK_REQUEST = :BANK_REQUEST
195
- DELINQUENT = :DELINQUENT
196
-
197
- # @!method self.values
198
- # @return [Array<Symbol>]
199
- end
200
208
  end
201
209
  end
202
210
  end
@@ -19,11 +19,19 @@ module Lithic
19
19
  # @return [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Substatus, nil]
20
20
  required :substatus, enum: -> { Lithic::FinancialAccountUpdateStatusParams::Substatus }, nil?: true
21
21
 
22
- # @!method initialize(status:, substatus:, request_options: {})
22
+ # @!attribute user_defined_status
23
+ # User-defined status for the financial account
24
+ #
25
+ # @return [String, nil]
26
+ optional :user_defined_status, String
27
+
28
+ # @!method initialize(status:, substatus:, user_defined_status: nil, request_options: {})
23
29
  # @param status [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Status] Status of the financial account
24
30
  #
25
31
  # @param substatus [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Substatus, nil] Substatus for the financial account
26
32
  #
33
+ # @param user_defined_status [String] User-defined status for the financial account
34
+ #
27
35
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
28
36
 
29
37
  # Status of the financial account
@@ -90,8 +90,8 @@ module Lithic
90
90
 
91
91
  # @!attribute payment_allocation
92
92
  #
93
- # @return [Lithic::Models::FinancialAccounts::CategoryBalances]
94
- required :payment_allocation, -> { Lithic::FinancialAccounts::CategoryBalances }
93
+ # @return [Lithic::Models::FinancialAccounts::LoanTape::PaymentAllocation]
94
+ required :payment_allocation, -> { Lithic::FinancialAccounts::LoanTape::PaymentAllocation }
95
95
 
96
96
  # @!attribute period_totals
97
97
  #
@@ -164,7 +164,7 @@ module Lithic
164
164
  #
165
165
  # @param minimum_payment_balance [Lithic::Models::FinancialAccounts::LoanTape::MinimumPaymentBalance]
166
166
  #
167
- # @param payment_allocation [Lithic::Models::FinancialAccounts::CategoryBalances]
167
+ # @param payment_allocation [Lithic::Models::FinancialAccounts::LoanTape::PaymentAllocation]
168
168
  #
169
169
  # @param period_totals [Lithic::Models::StatementTotals]
170
170
  #
@@ -436,6 +436,55 @@ module Lithic
436
436
  # @param remaining [Integer]
437
437
  end
438
438
 
439
+ # @see Lithic::Models::FinancialAccounts::LoanTape#payment_allocation
440
+ class PaymentAllocation < Lithic::Internal::Type::BaseModel
441
+ # @!attribute fee_details
442
+ #
443
+ # @return [Lithic::Models::CategoryDetails, nil]
444
+ required :fee_details, -> { Lithic::CategoryDetails }, nil?: true
445
+
446
+ # @!attribute fees
447
+ # Amount allocated to fees in cents
448
+ #
449
+ # @return [Integer]
450
+ required :fees, Integer
451
+
452
+ # @!attribute interest
453
+ # Amount allocated to interest in cents
454
+ #
455
+ # @return [Integer]
456
+ required :interest, Integer
457
+
458
+ # @!attribute interest_details
459
+ #
460
+ # @return [Lithic::Models::CategoryDetails, nil]
461
+ required :interest_details, -> { Lithic::CategoryDetails }, nil?: true
462
+
463
+ # @!attribute principal
464
+ # Amount allocated to principal in cents
465
+ #
466
+ # @return [Integer]
467
+ required :principal, Integer
468
+
469
+ # @!attribute principal_details
470
+ #
471
+ # @return [Lithic::Models::CategoryDetails, nil]
472
+ required :principal_details, -> { Lithic::CategoryDetails }, nil?: true
473
+
474
+ # @!method initialize(fee_details:, fees:, interest:, interest_details:, principal:, principal_details:)
475
+ # @param fee_details [Lithic::Models::CategoryDetails, nil]
476
+ #
477
+ # @param fees [Integer] Amount allocated to fees in cents
478
+ #
479
+ # @param interest [Integer] Amount allocated to interest in cents
480
+ #
481
+ # @param interest_details [Lithic::Models::CategoryDetails, nil]
482
+ #
483
+ # @param principal [Integer] Amount allocated to principal in cents
484
+ #
485
+ # @param principal_details [Lithic::Models::CategoryDetails, nil]
486
+ end
487
+
439
488
  # @see Lithic::Models::FinancialAccounts::LoanTape#previous_statement_balance
440
489
  class PreviousStatementBalance < Lithic::Internal::Type::BaseModel
441
490
  # @!attribute amount
@@ -38,6 +38,8 @@ module Lithic
38
38
  required :financial_account_token, String
39
39
 
40
40
  # @!attribute token
41
+ # Customer-provided token that will serve as an idempotency token. This token will
42
+ # become the transaction token.
41
43
  #
42
44
  # @return [String, nil]
43
45
  optional :token, String
@@ -64,6 +66,9 @@ module Lithic
64
66
  optional :user_defined_id, String
65
67
 
66
68
  # @!method initialize(amount:, category:, direction:, effective_date:, event_type:, financial_account_token:, token: nil, memo: nil, on_closed_account: nil, subtype: nil, user_defined_id: nil, request_options: {})
69
+ # Some parameter documentations has been truncated, see
70
+ # {Lithic::Models::ManagementOperationCreateParams} for more details.
71
+ #
67
72
  # @param amount [Integer]
68
73
  #
69
74
  # @param category [Symbol, Lithic::Models::ManagementOperationCreateParams::Category]
@@ -76,7 +81,7 @@ module Lithic
76
81
  #
77
82
  # @param financial_account_token [String]
78
83
  #
79
- # @param token [String]
84
+ # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
80
85
  #
81
86
  # @param memo [String]
82
87
  #
@@ -21,8 +21,7 @@ module Lithic
21
21
 
22
22
  variant -> { Lithic::AccountHolderDocumentUpdatedWebhookEvent }
23
23
 
24
- # The Auth Stream Access request payload that was sent to the ASA responder.
25
- variant -> { Lithic::AsaRequestWebhookEvent }
24
+ variant -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent }
26
25
 
27
26
  # A webhook for tokenization decisioning sent to the customer's responder endpoint
28
27
  variant -> { Lithic::TokenizationDecisioningRequestWebhookEvent }
@@ -128,7 +127,7 @@ module Lithic
128
127
  variant -> { Lithic::TokenizationUpdatedWebhookEvent }
129
128
 
130
129
  # Represents a 3DS authentication
131
- variant -> { Lithic::ThreeDSAuthentication }
130
+ variant -> { Lithic::ThreeDSAuthenticationApprovalRequestWebhookEvent }
132
131
 
133
132
  # The Dispute object tracks the progression of a dispute throughout its lifecycle.
134
133
  variant -> { Lithic::DisputeTransactionCreatedWebhookEvent }
@@ -812,7 +811,7 @@ module Lithic
812
811
  end
813
812
 
814
813
  # @!method self.variants
815
- # @return [Array(Lithic::Models::AccountHolderCreatedWebhookEvent, Lithic::Models::ParsedWebhookEvent::KYBPayload, Lithic::Models::ParsedWebhookEvent::KYCPayload, Lithic::Models::ParsedWebhookEvent::LegacyPayload, Lithic::Models::AccountHolderVerificationWebhookEvent, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent, Lithic::Models::AsaRequestWebhookEvent, Lithic::Models::TokenizationDecisioningRequestWebhookEvent, Lithic::Models::AuthRulesBacktestReportCreatedWebhookEvent, Lithic::Models::BalanceUpdatedWebhookEvent, Lithic::Models::BookTransferTransactionCreatedWebhookEvent, Lithic::Models::BookTransferTransactionUpdatedWebhookEvent, Lithic::Models::CardCreatedWebhookEvent, Lithic::Models::CardConvertedWebhookEvent, Lithic::Models::CardRenewedWebhookEvent, Lithic::Models::CardReissuedWebhookEvent, Lithic::Models::CardShippedWebhookEvent, Lithic::Models::CardTransactionUpdatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataCreatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataUpdatedWebhookEvent, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent, Lithic::Models::DigitalWalletTokenizationResultWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::DigitalWalletTokenizationUpdatedWebhookEvent, Lithic::Models::DisputeUpdatedWebhookEvent, Lithic::Models::DisputeEvidenceUploadFailedWebhookEvent, Lithic::Models::ExternalBankAccountCreatedWebhookEvent, Lithic::Models::ExternalBankAccountUpdatedWebhookEvent, Lithic::Models::ExternalPaymentCreatedWebhookEvent, Lithic::Models::ExternalPaymentUpdatedWebhookEvent, Lithic::Models::FinancialAccountCreatedWebhookEvent, Lithic::Models::FinancialAccountUpdatedWebhookEvent, Lithic::Models::FundingEventCreatedWebhookEvent, Lithic::Models::LoanTapeCreatedWebhookEvent, Lithic::Models::LoanTapeUpdatedWebhookEvent, Lithic::Models::ManagementOperationCreatedWebhookEvent, Lithic::Models::ManagementOperationUpdatedWebhookEvent, Lithic::Models::InternalTransactionCreatedWebhookEvent, Lithic::Models::InternalTransactionUpdatedWebhookEvent, Lithic::Models::NetworkTotalCreatedWebhookEvent, Lithic::Models::NetworkTotalUpdatedWebhookEvent, Lithic::Models::PaymentTransactionCreatedWebhookEvent, Lithic::Models::PaymentTransactionUpdatedWebhookEvent, Lithic::Models::SettlementReportUpdatedWebhookEvent, Lithic::Models::StatementsCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationChallengeWebhookEvent, Lithic::Models::TokenizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationResultWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::TokenizationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthentication, Lithic::Models::DisputeTransactionCreatedWebhookEvent, Lithic::Models::DisputeTransactionUpdatedWebhookEvent)]
814
+ # @return [Array(Lithic::Models::AccountHolderCreatedWebhookEvent, Lithic::Models::ParsedWebhookEvent::KYBPayload, Lithic::Models::ParsedWebhookEvent::KYCPayload, Lithic::Models::ParsedWebhookEvent::LegacyPayload, Lithic::Models::AccountHolderVerificationWebhookEvent, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationDecisioningRequestWebhookEvent, Lithic::Models::AuthRulesBacktestReportCreatedWebhookEvent, Lithic::Models::BalanceUpdatedWebhookEvent, Lithic::Models::BookTransferTransactionCreatedWebhookEvent, Lithic::Models::BookTransferTransactionUpdatedWebhookEvent, Lithic::Models::CardCreatedWebhookEvent, Lithic::Models::CardConvertedWebhookEvent, Lithic::Models::CardRenewedWebhookEvent, Lithic::Models::CardReissuedWebhookEvent, Lithic::Models::CardShippedWebhookEvent, Lithic::Models::CardTransactionUpdatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataCreatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataUpdatedWebhookEvent, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent, Lithic::Models::DigitalWalletTokenizationResultWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::DigitalWalletTokenizationUpdatedWebhookEvent, Lithic::Models::DisputeUpdatedWebhookEvent, Lithic::Models::DisputeEvidenceUploadFailedWebhookEvent, Lithic::Models::ExternalBankAccountCreatedWebhookEvent, Lithic::Models::ExternalBankAccountUpdatedWebhookEvent, Lithic::Models::ExternalPaymentCreatedWebhookEvent, Lithic::Models::ExternalPaymentUpdatedWebhookEvent, Lithic::Models::FinancialAccountCreatedWebhookEvent, Lithic::Models::FinancialAccountUpdatedWebhookEvent, Lithic::Models::FundingEventCreatedWebhookEvent, Lithic::Models::LoanTapeCreatedWebhookEvent, Lithic::Models::LoanTapeUpdatedWebhookEvent, Lithic::Models::ManagementOperationCreatedWebhookEvent, Lithic::Models::ManagementOperationUpdatedWebhookEvent, Lithic::Models::InternalTransactionCreatedWebhookEvent, Lithic::Models::InternalTransactionUpdatedWebhookEvent, Lithic::Models::NetworkTotalCreatedWebhookEvent, Lithic::Models::NetworkTotalUpdatedWebhookEvent, Lithic::Models::PaymentTransactionCreatedWebhookEvent, Lithic::Models::PaymentTransactionUpdatedWebhookEvent, Lithic::Models::SettlementReportUpdatedWebhookEvent, Lithic::Models::StatementsCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationChallengeWebhookEvent, Lithic::Models::TokenizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationResultWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::TokenizationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationApprovalRequestWebhookEvent, Lithic::Models::DisputeTransactionCreatedWebhookEvent, Lithic::Models::DisputeTransactionUpdatedWebhookEvent)]
816
815
  end
817
816
  end
818
817
  end
@@ -289,7 +289,13 @@ module Lithic
289
289
  optional :detailed_results,
290
290
  -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Payment::Event::DetailedResult] }
291
291
 
292
- # @!method initialize(token:, amount:, created:, result:, type:, detailed_results: nil)
292
+ # @!attribute external_id
293
+ # Payment event external ID, for example, ACH trace number.
294
+ #
295
+ # @return [String, nil]
296
+ optional :external_id, String, nil?: true
297
+
298
+ # @!method initialize(token:, amount:, created:, result:, type:, detailed_results: nil, external_id: nil)
293
299
  # Some parameter documentations has been truncated, see
294
300
  # {Lithic::Models::Payment::Event} for more details.
295
301
  #
@@ -306,6 +312,8 @@ module Lithic
306
312
  # @param type [Symbol, Lithic::Models::Payment::Event::Type] Event types:
307
313
  #
308
314
  # @param detailed_results [Array<Symbol, Lithic::Models::Payment::Event::DetailedResult>] More detailed reasons for the event
315
+ #
316
+ # @param external_id [String, nil] Payment event external ID, for example, ACH trace number.
309
317
 
310
318
  # APPROVED financial events were successful while DECLINED financial events were
311
319
  # declined by user, Lithic, or the network.
@@ -642,6 +650,7 @@ module Lithic
642
650
  WIRE_INBOUND_ADMIN = :WIRE_INBOUND_ADMIN
643
651
  WIRE_OUTBOUND_PAYMENT = :WIRE_OUTBOUND_PAYMENT
644
652
  WIRE_OUTBOUND_ADMIN = :WIRE_OUTBOUND_ADMIN
653
+ WIRE_DRAWDOWN_REQUEST = :WIRE_DRAWDOWN_REQUEST
645
654
 
646
655
  # @!method self.values
647
656
  # @return [Array<Symbol>]
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ class ThreeDSAuthenticationApprovalRequestWebhookEvent < Lithic::Models::ThreeDSAuthentication
6
+ # @!attribute event_type
7
+ #
8
+ # @return [Symbol, :"three_ds_authentication.approval_request"]
9
+ required :event_type, const: :"three_ds_authentication.approval_request"
10
+
11
+ # @!method initialize(event_type: :"three_ds_authentication.approval_request")
12
+ # Represents a 3DS authentication
13
+ #
14
+ # @param event_type [Symbol, :"three_ds_authentication.approval_request"]
15
+ end
16
+ end
17
+ end
@@ -929,6 +929,7 @@ module Lithic
929
929
  AUTH_RULE_ALLOWED_MCC = :AUTH_RULE_ALLOWED_MCC
930
930
  AUTH_RULE_BLOCKED_COUNTRY = :AUTH_RULE_BLOCKED_COUNTRY
931
931
  AUTH_RULE_BLOCKED_MCC = :AUTH_RULE_BLOCKED_MCC
932
+ AUTH_RULE = :AUTH_RULE
932
933
  CARD_CLOSED = :CARD_CLOSED
933
934
  CARD_CRYPTOGRAM_VALIDATION_FAILURE = :CARD_CRYPTOGRAM_VALIDATION_FAILURE
934
935
  CARD_EXPIRED = :CARD_EXPIRED
@@ -1258,6 +1259,7 @@ module Lithic
1258
1259
  AUTH_RULE_ALLOWED_MCC = :AUTH_RULE_ALLOWED_MCC
1259
1260
  AUTH_RULE_BLOCKED_COUNTRY = :AUTH_RULE_BLOCKED_COUNTRY
1260
1261
  AUTH_RULE_BLOCKED_MCC = :AUTH_RULE_BLOCKED_MCC
1262
+ AUTH_RULE = :AUTH_RULE
1261
1263
  CARD_CLOSED = :CARD_CLOSED
1262
1264
  CARD_CRYPTOGRAM_VALIDATION_FAILURE = :CARD_CRYPTOGRAM_VALIDATION_FAILURE
1263
1265
  CARD_EXPIRED = :CARD_EXPIRED
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ # @see Lithic::Resources::TransferLimits#list
6
+ class TransferLimitListParams < Lithic::Internal::Type::BaseModel
7
+ extend Lithic::Internal::Type::RequestParameters::Converter
8
+ include Lithic::Internal::Type::RequestParameters
9
+
10
+ # @!attribute date
11
+ # Date for which to retrieve transfer limits (ISO 8601 format)
12
+ #
13
+ # @return [Date, nil]
14
+ optional :date, Date
15
+
16
+ # @!method initialize(date: nil, request_options: {})
17
+ # @param date [Date] Date for which to retrieve transfer limits (ISO 8601 format)
18
+ #
19
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,274 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ class TransferLimitsResponse < Lithic::Internal::Type::BaseModel
6
+ # @!attribute data
7
+ # List of transfer limits
8
+ #
9
+ # @return [Array<Lithic::Models::TransferLimitsResponse::Data>]
10
+ required :data, -> { Lithic::Internal::Type::ArrayOf[Lithic::TransferLimitsResponse::Data] }
11
+
12
+ # @!attribute has_more
13
+ # Whether there are more transfer limits
14
+ #
15
+ # @return [Boolean]
16
+ required :has_more, Lithic::Internal::Type::Boolean
17
+
18
+ # @!method initialize(data:, has_more:)
19
+ # @param data [Array<Lithic::Models::TransferLimitsResponse::Data>] List of transfer limits
20
+ #
21
+ # @param has_more [Boolean] Whether there are more transfer limits
22
+
23
+ class Data < Lithic::Internal::Type::BaseModel
24
+ # @!attribute company_id
25
+ # Company ID
26
+ #
27
+ # @return [String]
28
+ required :company_id, String
29
+
30
+ # @!attribute daily_limit
31
+ # Daily limits with progress
32
+ #
33
+ # @return [Lithic::Models::TransferLimitsResponse::Data::DailyLimit]
34
+ required :daily_limit, -> { Lithic::TransferLimitsResponse::Data::DailyLimit }
35
+
36
+ # @!attribute date
37
+ # The date for the limit view (ISO format)
38
+ #
39
+ # @return [Date]
40
+ required :date, Date
41
+
42
+ # @!attribute is_fbo
43
+ # Whether the company is a FBO; based on the company ID prefix
44
+ #
45
+ # @return [Boolean]
46
+ required :is_fbo, Lithic::Internal::Type::Boolean
47
+
48
+ # @!attribute monthly_limit
49
+ # Monthly limits with progress
50
+ #
51
+ # @return [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit]
52
+ required :monthly_limit, -> { Lithic::TransferLimitsResponse::Data::MonthlyLimit }
53
+
54
+ # @!attribute program_limit_per_transaction
55
+ # Program transaction limits
56
+ #
57
+ # @return [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction]
58
+ required :program_limit_per_transaction,
59
+ -> { Lithic::TransferLimitsResponse::Data::ProgramLimitPerTransaction }
60
+
61
+ # @!method initialize(company_id:, daily_limit:, date:, is_fbo:, monthly_limit:, program_limit_per_transaction:)
62
+ # @param company_id [String] Company ID
63
+ #
64
+ # @param daily_limit [Lithic::Models::TransferLimitsResponse::Data::DailyLimit] Daily limits with progress
65
+ #
66
+ # @param date [Date] The date for the limit view (ISO format)
67
+ #
68
+ # @param is_fbo [Boolean] Whether the company is a FBO; based on the company ID prefix
69
+ #
70
+ # @param monthly_limit [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit] Monthly limits with progress
71
+ #
72
+ # @param program_limit_per_transaction [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction] Program transaction limits
73
+
74
+ # @see Lithic::Models::TransferLimitsResponse::Data#daily_limit
75
+ class DailyLimit < Lithic::Internal::Type::BaseModel
76
+ # @!attribute credit
77
+ # Credit limits
78
+ #
79
+ # @return [Lithic::Models::TransferLimitsResponse::Data::DailyLimit::Credit]
80
+ required :credit, -> { Lithic::TransferLimitsResponse::Data::DailyLimit::Credit }
81
+
82
+ # @!attribute debit
83
+ # Debit limits
84
+ #
85
+ # @return [Lithic::Models::TransferLimitsResponse::Data::DailyLimit::Debit]
86
+ required :debit, -> { Lithic::TransferLimitsResponse::Data::DailyLimit::Debit }
87
+
88
+ # @!method initialize(credit:, debit:)
89
+ # Daily limits with progress
90
+ #
91
+ # @param credit [Lithic::Models::TransferLimitsResponse::Data::DailyLimit::Credit] Credit limits
92
+ #
93
+ # @param debit [Lithic::Models::TransferLimitsResponse::Data::DailyLimit::Debit] Debit limits
94
+
95
+ # @see Lithic::Models::TransferLimitsResponse::Data::DailyLimit#credit
96
+ class Credit < Lithic::Internal::Type::BaseModel
97
+ # @!attribute limit
98
+ # The limit amount
99
+ #
100
+ # @return [Integer]
101
+ required :limit, Integer
102
+
103
+ # @!attribute amount_originated
104
+ # Amount originated towards limit
105
+ #
106
+ # @return [Integer, nil]
107
+ optional :amount_originated, Integer
108
+
109
+ # @!method initialize(limit:, amount_originated: nil)
110
+ # Credit limits
111
+ #
112
+ # @param limit [Integer] The limit amount
113
+ #
114
+ # @param amount_originated [Integer] Amount originated towards limit
115
+ end
116
+
117
+ # @see Lithic::Models::TransferLimitsResponse::Data::DailyLimit#debit
118
+ class Debit < Lithic::Internal::Type::BaseModel
119
+ # @!attribute limit
120
+ # The limit amount
121
+ #
122
+ # @return [Integer]
123
+ required :limit, Integer
124
+
125
+ # @!attribute amount_originated
126
+ # Amount originated towards limit
127
+ #
128
+ # @return [Integer, nil]
129
+ optional :amount_originated, Integer
130
+
131
+ # @!method initialize(limit:, amount_originated: nil)
132
+ # Debit limits
133
+ #
134
+ # @param limit [Integer] The limit amount
135
+ #
136
+ # @param amount_originated [Integer] Amount originated towards limit
137
+ end
138
+ end
139
+
140
+ # @see Lithic::Models::TransferLimitsResponse::Data#monthly_limit
141
+ class MonthlyLimit < Lithic::Internal::Type::BaseModel
142
+ # @!attribute credit
143
+ # Credit limits
144
+ #
145
+ # @return [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit::Credit]
146
+ required :credit, -> { Lithic::TransferLimitsResponse::Data::MonthlyLimit::Credit }
147
+
148
+ # @!attribute debit
149
+ # Debit limits
150
+ #
151
+ # @return [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit::Debit]
152
+ required :debit, -> { Lithic::TransferLimitsResponse::Data::MonthlyLimit::Debit }
153
+
154
+ # @!method initialize(credit:, debit:)
155
+ # Monthly limits with progress
156
+ #
157
+ # @param credit [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit::Credit] Credit limits
158
+ #
159
+ # @param debit [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit::Debit] Debit limits
160
+
161
+ # @see Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit#credit
162
+ class Credit < Lithic::Internal::Type::BaseModel
163
+ # @!attribute limit
164
+ # The limit amount
165
+ #
166
+ # @return [Integer]
167
+ required :limit, Integer
168
+
169
+ # @!attribute amount_originated
170
+ # Amount originated towards limit
171
+ #
172
+ # @return [Integer, nil]
173
+ optional :amount_originated, Integer
174
+
175
+ # @!method initialize(limit:, amount_originated: nil)
176
+ # Credit limits
177
+ #
178
+ # @param limit [Integer] The limit amount
179
+ #
180
+ # @param amount_originated [Integer] Amount originated towards limit
181
+ end
182
+
183
+ # @see Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit#debit
184
+ class Debit < Lithic::Internal::Type::BaseModel
185
+ # @!attribute limit
186
+ # The limit amount
187
+ #
188
+ # @return [Integer]
189
+ required :limit, Integer
190
+
191
+ # @!attribute amount_originated
192
+ # Amount originated towards limit
193
+ #
194
+ # @return [Integer, nil]
195
+ optional :amount_originated, Integer
196
+
197
+ # @!method initialize(limit:, amount_originated: nil)
198
+ # Debit limits
199
+ #
200
+ # @param limit [Integer] The limit amount
201
+ #
202
+ # @param amount_originated [Integer] Amount originated towards limit
203
+ end
204
+ end
205
+
206
+ # @see Lithic::Models::TransferLimitsResponse::Data#program_limit_per_transaction
207
+ class ProgramLimitPerTransaction < Lithic::Internal::Type::BaseModel
208
+ # @!attribute credit
209
+ # Credit limits
210
+ #
211
+ # @return [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Credit]
212
+ required :credit, -> { Lithic::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Credit }
213
+
214
+ # @!attribute debit
215
+ # Debit limits
216
+ #
217
+ # @return [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Debit]
218
+ required :debit, -> { Lithic::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Debit }
219
+
220
+ # @!method initialize(credit:, debit:)
221
+ # Program transaction limits
222
+ #
223
+ # @param credit [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Credit] Credit limits
224
+ #
225
+ # @param debit [Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction::Debit] Debit limits
226
+
227
+ # @see Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction#credit
228
+ class Credit < Lithic::Internal::Type::BaseModel
229
+ # @!attribute limit
230
+ # The limit amount
231
+ #
232
+ # @return [Integer]
233
+ required :limit, Integer
234
+
235
+ # @!attribute amount_originated
236
+ # Amount originated towards limit
237
+ #
238
+ # @return [Integer, nil]
239
+ optional :amount_originated, Integer
240
+
241
+ # @!method initialize(limit:, amount_originated: nil)
242
+ # Credit limits
243
+ #
244
+ # @param limit [Integer] The limit amount
245
+ #
246
+ # @param amount_originated [Integer] Amount originated towards limit
247
+ end
248
+
249
+ # @see Lithic::Models::TransferLimitsResponse::Data::ProgramLimitPerTransaction#debit
250
+ class Debit < Lithic::Internal::Type::BaseModel
251
+ # @!attribute limit
252
+ # The limit amount
253
+ #
254
+ # @return [Integer]
255
+ required :limit, Integer
256
+
257
+ # @!attribute amount_originated
258
+ # Amount originated towards limit
259
+ #
260
+ # @return [Integer, nil]
261
+ optional :amount_originated, Integer
262
+
263
+ # @!method initialize(limit:, amount_originated: nil)
264
+ # Debit limits
265
+ #
266
+ # @param limit [Integer] The limit amount
267
+ #
268
+ # @param amount_originated [Integer] Amount originated towards limit
269
+ end
270
+ end
271
+ end
272
+ end
273
+ end
274
+ end