lithic 0.21.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 +19 -0
- data/README.md +1 -10
- data/lib/lithic/internal/type/union.rb +21 -7
- 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 +55 -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/v2_create_params.rb +203 -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_update_entities_params.rb +39 -0
- data/lib/lithic/models/auth_rules/v2_update_params.rb +133 -12
- data/lib/lithic/models/card_authorization.rb +11 -1
- data/lib/lithic/models/card_create_params.rb +11 -1
- data/lib/lithic/models/card_update_params.rb +12 -1
- 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/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/non_pci_card.rb +11 -1
- data/lib/lithic/models/parsed_webhook_event.rb +120 -66
- data/lib/lithic/models/payment.rb +2 -1
- data/lib/lithic/models/transaction.rb +2 -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/resources/auth_rules/v2/backtests.rb +8 -8
- data/lib/lithic/resources/auth_rules/v2.rb +44 -8
- data/lib/lithic/resources/cards.rb +6 -2
- data/lib/lithic/resources/financial_accounts/installment_plans/statements.rb +107 -0
- data/lib/lithic/resources/financial_accounts/installment_plans.rb +4 -0
- 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 +8 -1
- 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 +53 -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/v2_create_params.rbi +325 -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_update_entities_params.rbi +68 -0
- data/rbi/lithic/models/auth_rules/v2_update_params.rbi +198 -5
- data/rbi/lithic/models/card_authorization.rbi +12 -0
- data/rbi/lithic/models/card_create_params.rbi +15 -0
- data/rbi/lithic/models/card_update_params.rbi +17 -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/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/non_pci_card.rbi +12 -0
- data/rbi/lithic/models/parsed_webhook_event.rbi +195 -90
- data/rbi/lithic/models/payment.rbi +4 -2
- data/rbi/lithic/models/transaction.rbi +4 -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/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/cards.rbi +11 -0
- data/rbi/lithic/resources/financial_accounts/installment_plans/statements.rbi +86 -0
- data/rbi/lithic/resources/financial_accounts/installment_plans.rbi +7 -0
- data/rbi/lithic/resources/transactions.rbi +31 -2
- 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 +8 -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/v2_create_params.rbs +86 -16
- data/sig/lithic/models/auth_rules/v2_draft_params.rbs +1 -2
- 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/card_authorization.rbs +5 -0
- data/sig/lithic/models/card_create_params.rbs +7 -0
- data/sig/lithic/models/card_update_params.rbs +8 -1
- 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/kyb_business_entity.rbs +13 -13
- data/sig/lithic/models/non_pci_card.rbs +5 -0
- data/sig/lithic/models/parsed_webhook_event.rbs +39 -39
- 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/resources/auth_rules/v2.rbs +7 -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 +2 -0
- data/sig/lithic/resources/transactions.rbs +5 -0
- metadata +26 -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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1d5394fbf93d5fe79485f48eeee1e627eca7c52a58f140b47c7d060fe16dd59b
|
|
4
|
+
data.tar.gz: a970af229514a369b29f77419d940d3ba75d3981b914fbcbac192f877b26062d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: fa85dffbcc1a77f79a0b259a7d8c25b1cdbec7a02f7116b93687a197986c986d08eff4811c465ed5856f01bdc336aeeccdf18c352fbdb2a2bc0ed7492e8359ed
|
|
7
|
+
data.tar.gz: 5e3bed3eb70b84aa9496b568729b72cf27fcf56cd798135026b6580737973fe6e0e8c07cc106f6dc531b12bee7c3b5eb2e8b7bfb9cef1b213bb5c6c5d3de8701
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,24 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.22.0](https://github.com/lithic-com/lithic-ruby/compare/v0.21.0...v0.22.0) (2026-10-13)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### ⚠ BREAKING CHANGES
|
|
7
|
+
|
|
8
|
+
* **api:** the CONDITIONAL_BLOCK rule type and the ConditionalBlockParameters model are removed. All rules are now CONDITIONAL_ACTION.
|
|
9
|
+
|
|
10
|
+
### Features
|
|
11
|
+
|
|
12
|
+
* **api:** accept billing_currency and settlement_currency on transaction simulation endpoints ([428ae58](https://github.com/lithic-com/lithic-ruby/commit/428ae5843e4ad441e828dcb7f73b889f8756d887))
|
|
13
|
+
* **api:** add entities to auth rules and an endpoint to update a rule's entities incrementally ([462b161](https://github.com/lithic-com/lithic-ruby/commit/462b161da24cb01374ae438d5217208ccc652a79))
|
|
14
|
+
* **api:** add installment plan statement endpoints to financial accounts ([e94582e](https://github.com/lithic-com/lithic-ruby/commit/e94582ea1ea6e30db808bd62b2952dac9b3fd3ad))
|
|
15
|
+
* **api:** add payment-only allocation breakdown to the loan tape ([625d033](https://github.com/lithic-com/lithic-ruby/commit/625d033aaec889eef435909baa44f3efabc17e50))
|
|
16
|
+
* **api:** add tags to card create and update parameters and card responses ([31f4225](https://github.com/lithic-com/lithic-ruby/commit/31f42251508fff2120b90678891414285e34c5ab))
|
|
17
|
+
* **api:** add tags to the card object in auth stream access requests ([5c9677a](https://github.com/lithic-com/lithic-ruby/commit/5c9677ade53fe5d0248a1cd6e5c109033388fb07))
|
|
18
|
+
* **api:** expose the full conditional attribute set for authorization rules ([2ab59fc](https://github.com/lithic-com/lithic-ruby/commit/2ab59fc2d2113eba31919f86dd5cbff5e72d09bf))
|
|
19
|
+
* **api:** remove CONDITIONAL_BLOCK from authorization rules ([7a4a3d3](https://github.com/lithic-com/lithic-ruby/commit/7a4a3d3ddf06d7f2139e38bde4c8f68e0f9e827e))
|
|
20
|
+
* **api:** support international addresses and address2 for KYB_DELEGATED and KYC_EXEMPT workflows ([cd0721a](https://github.com/lithic-com/lithic-ruby/commit/cd0721a5e04383773baa69cb06f07d83ec037ef8))
|
|
21
|
+
|
|
3
22
|
## 0.21.0 (2026-09-18)
|
|
4
23
|
|
|
5
24
|
Full Changelog: [v0.20.0...v0.21.0](https://github.com/lithic-com/lithic-ruby/compare/v0.20.0...v0.21.0)
|
data/README.md
CHANGED
|
@@ -2,15 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
The Lithic Ruby library provides convenient access to the Lithic REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/lithic-com/lithic-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
|
|
4
4
|
|
|
5
|
-
## MCP Server
|
|
6
|
-
|
|
7
|
-
Use the Lithic MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
|
|
8
|
-
|
|
9
|
-
[](https://cursor.com/en-US/install-mcp?name=lithic-mcp&config=eyJuYW1lIjoibGl0aGljLW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL2xpdGhpYy5zdGxtY3AuY29tIiwiaGVhZGVycyI6eyJ4LWxpdGhpYy1hcGkta2V5IjoiTXkgTGl0aGljIEFQSSBLZXkifX0)
|
|
10
|
-
[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22lithic-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Flithic.stlmcp.com%22%2C%22headers%22%3A%7B%22x-lithic-api-key%22%3A%22My%20Lithic%20API%20Key%22%7D%7D)
|
|
11
|
-
|
|
12
|
-
> Note: You may need to set environment variables in your MCP client.
|
|
13
|
-
|
|
14
5
|
## Documentation
|
|
15
6
|
|
|
16
7
|
Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/lithic).
|
|
@@ -24,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
24
15
|
<!-- x-release-please-start-version -->
|
|
25
16
|
|
|
26
17
|
```ruby
|
|
27
|
-
gem "lithic", "~> 0.
|
|
18
|
+
gem "lithic", "~> 0.22.0"
|
|
28
19
|
```
|
|
29
20
|
|
|
30
21
|
<!-- x-release-please-end -->
|
|
@@ -6,14 +6,28 @@ module Lithic
|
|
|
6
6
|
# @api private
|
|
7
7
|
#
|
|
8
8
|
# @example
|
|
9
|
-
# # `
|
|
10
|
-
# case
|
|
11
|
-
# when Lithic::
|
|
12
|
-
# puts(
|
|
13
|
-
# when Lithic::
|
|
14
|
-
# puts(
|
|
9
|
+
# # `auth_rule_entity` is a `Lithic::AuthRules::AuthRuleEntity`
|
|
10
|
+
# case auth_rule_entity
|
|
11
|
+
# when Lithic::AuthRules::AuthRuleEntity::Program
|
|
12
|
+
# puts(auth_rule_entity.type)
|
|
13
|
+
# when Lithic::AuthRules::AuthRuleEntity::Card
|
|
14
|
+
# puts(auth_rule_entity.token)
|
|
15
|
+
# when Lithic::AuthRules::AuthRuleEntity::Account
|
|
16
|
+
# puts(auth_rule_entity.token)
|
|
15
17
|
# else
|
|
16
|
-
# puts(
|
|
18
|
+
# puts(auth_rule_entity)
|
|
19
|
+
# end
|
|
20
|
+
#
|
|
21
|
+
# @example
|
|
22
|
+
# case auth_rule_entity
|
|
23
|
+
# in {type: :PROGRAM}
|
|
24
|
+
# # ...
|
|
25
|
+
# in {type: :CARD, token: token}
|
|
26
|
+
# puts(token)
|
|
27
|
+
# in {type: :ACCOUNT, token: token}
|
|
28
|
+
# puts(token)
|
|
29
|
+
# else
|
|
30
|
+
# puts(auth_rule_entity)
|
|
17
31
|
# end
|
|
18
32
|
module Union
|
|
19
33
|
include Lithic::Internal::Type::Converter
|
|
@@ -202,7 +202,8 @@ module Lithic
|
|
|
202
202
|
|
|
203
203
|
# @!attribute address
|
|
204
204
|
# Individual's current address - PO boxes, UPS drops, and FedEx drops are not
|
|
205
|
-
# acceptable; APO/FPO are acceptable. Only USA addresses are
|
|
205
|
+
# acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
|
|
206
|
+
# and KYC workflows.
|
|
206
207
|
#
|
|
207
208
|
# @return [Lithic::Models::Address, nil]
|
|
208
209
|
optional :address, -> { Lithic::Address }
|
|
@@ -274,7 +275,8 @@ module Lithic
|
|
|
274
275
|
|
|
275
276
|
# @!attribute address
|
|
276
277
|
# Individual's current address - PO boxes, UPS drops, and FedEx drops are not
|
|
277
|
-
# acceptable; APO/FPO are acceptable. Only USA addresses are
|
|
278
|
+
# acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
|
|
279
|
+
# and KYC workflows.
|
|
278
280
|
#
|
|
279
281
|
# @return [Lithic::Models::Address, nil]
|
|
280
282
|
optional :address, -> { Lithic::Address }
|
|
@@ -216,7 +216,8 @@ module Lithic
|
|
|
216
216
|
class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
|
|
217
217
|
# @!attribute address
|
|
218
218
|
# Individual's current address - PO boxes, UPS drops, and FedEx drops are not
|
|
219
|
-
# acceptable; APO/FPO are acceptable. Only USA addresses are
|
|
219
|
+
# acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
|
|
220
|
+
# and KYC workflows.
|
|
220
221
|
#
|
|
221
222
|
# @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual::Address, nil]
|
|
222
223
|
optional :address,
|
|
@@ -285,51 +286,68 @@ module Lithic
|
|
|
285
286
|
required :city, String
|
|
286
287
|
|
|
287
288
|
# @!attribute country
|
|
288
|
-
# Valid country code
|
|
289
|
-
#
|
|
289
|
+
# Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
|
|
290
|
+
# format. Supported countries depend on the onboarding workflow used for the
|
|
291
|
+
# account holder.
|
|
290
292
|
#
|
|
291
293
|
# @return [String]
|
|
292
294
|
required :country, String
|
|
293
295
|
|
|
294
|
-
# @!attribute
|
|
295
|
-
#
|
|
296
|
-
# five-digit ZIP or nine-digit ZIP+4.
|
|
296
|
+
# @!attribute address2
|
|
297
|
+
# Unit or apartment number (if applicable).
|
|
297
298
|
#
|
|
298
|
-
# @return [String]
|
|
299
|
-
|
|
299
|
+
# @return [String, nil]
|
|
300
|
+
optional :address2, String
|
|
300
301
|
|
|
301
|
-
# @!attribute
|
|
302
|
-
# Valid
|
|
303
|
-
#
|
|
302
|
+
# @!attribute postal_code
|
|
303
|
+
# Valid postal code. For USA addresses, enter either a five-digit postal code or a
|
|
304
|
+
# nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
|
|
305
|
+
# countries except the following, which do not use postal codes: ABW, AGO, ARE,
|
|
306
|
+
# ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
|
|
307
|
+
# ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
|
|
308
|
+
# SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
|
|
304
309
|
#
|
|
305
|
-
# @return [String]
|
|
306
|
-
|
|
310
|
+
# @return [String, nil]
|
|
311
|
+
optional :postal_code, String, nil?: true
|
|
307
312
|
|
|
308
|
-
# @!attribute
|
|
309
|
-
#
|
|
313
|
+
# @!attribute state
|
|
314
|
+
# Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
|
|
315
|
+
# code for the country without the country prefix. For example, `CA` for
|
|
316
|
+
# California. Optional unless the address is in one of the following countries,
|
|
317
|
+
# where it is required:
|
|
318
|
+
#
|
|
319
|
+
# - `USA`
|
|
320
|
+
# - `CAN`
|
|
321
|
+
# - `AUS`
|
|
322
|
+
# - `CHN`
|
|
323
|
+
# - `KOR`
|
|
324
|
+
# - `MEX`
|
|
325
|
+
# - `MYS`
|
|
326
|
+
# - `NZL`
|
|
310
327
|
#
|
|
311
328
|
# @return [String, nil]
|
|
312
|
-
optional :
|
|
329
|
+
optional :state, String, nil?: true
|
|
313
330
|
|
|
314
|
-
# @!method initialize(address1:, city:, country:, postal_code
|
|
331
|
+
# @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
|
|
315
332
|
# Some parameter documentations has been truncated, see
|
|
316
333
|
# {Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual::Address}
|
|
317
334
|
# for more details.
|
|
318
335
|
#
|
|
319
336
|
# Individual's current address - PO boxes, UPS drops, and FedEx drops are not
|
|
320
|
-
# acceptable; APO/FPO are acceptable. Only USA addresses are
|
|
337
|
+
# acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
|
|
338
|
+
# and KYC workflows.
|
|
321
339
|
#
|
|
322
340
|
# @param address1 [String] Valid deliverable address (no PO boxes).
|
|
323
341
|
#
|
|
324
342
|
# @param city [String] Name of city.
|
|
325
343
|
#
|
|
326
|
-
# @param country [String] Valid country code
|
|
344
|
+
# @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
|
|
327
345
|
#
|
|
328
|
-
# @param
|
|
346
|
+
# @param address2 [String] Unit or apartment number (if applicable).
|
|
329
347
|
#
|
|
330
|
-
# @param
|
|
348
|
+
# @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
|
|
331
349
|
#
|
|
332
|
-
# @param
|
|
350
|
+
# @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
|
|
333
351
|
end
|
|
334
352
|
end
|
|
335
353
|
|
|
@@ -337,7 +355,8 @@ module Lithic
|
|
|
337
355
|
class ControlPerson < Lithic::Internal::Type::BaseModel
|
|
338
356
|
# @!attribute address
|
|
339
357
|
# Individual's current address - PO boxes, UPS drops, and FedEx drops are not
|
|
340
|
-
# acceptable; APO/FPO are acceptable. Only USA addresses are
|
|
358
|
+
# acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
|
|
359
|
+
# and KYC workflows.
|
|
341
360
|
#
|
|
342
361
|
# @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson::Address, nil]
|
|
343
362
|
optional :address,
|
|
@@ -418,51 +437,68 @@ module Lithic
|
|
|
418
437
|
required :city, String
|
|
419
438
|
|
|
420
439
|
# @!attribute country
|
|
421
|
-
# Valid country code
|
|
422
|
-
#
|
|
440
|
+
# Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
|
|
441
|
+
# format. Supported countries depend on the onboarding workflow used for the
|
|
442
|
+
# account holder.
|
|
423
443
|
#
|
|
424
444
|
# @return [String]
|
|
425
445
|
required :country, String
|
|
426
446
|
|
|
427
|
-
# @!attribute
|
|
428
|
-
#
|
|
429
|
-
# five-digit ZIP or nine-digit ZIP+4.
|
|
447
|
+
# @!attribute address2
|
|
448
|
+
# Unit or apartment number (if applicable).
|
|
430
449
|
#
|
|
431
|
-
# @return [String]
|
|
432
|
-
|
|
450
|
+
# @return [String, nil]
|
|
451
|
+
optional :address2, String
|
|
433
452
|
|
|
434
|
-
# @!attribute
|
|
435
|
-
# Valid
|
|
436
|
-
#
|
|
453
|
+
# @!attribute postal_code
|
|
454
|
+
# Valid postal code. For USA addresses, enter either a five-digit postal code or a
|
|
455
|
+
# nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
|
|
456
|
+
# countries except the following, which do not use postal codes: ABW, AGO, ARE,
|
|
457
|
+
# ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
|
|
458
|
+
# ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
|
|
459
|
+
# SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
|
|
437
460
|
#
|
|
438
|
-
# @return [String]
|
|
439
|
-
|
|
461
|
+
# @return [String, nil]
|
|
462
|
+
optional :postal_code, String, nil?: true
|
|
440
463
|
|
|
441
|
-
# @!attribute
|
|
442
|
-
#
|
|
464
|
+
# @!attribute state
|
|
465
|
+
# Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
|
|
466
|
+
# code for the country without the country prefix. For example, `CA` for
|
|
467
|
+
# California. Optional unless the address is in one of the following countries,
|
|
468
|
+
# where it is required:
|
|
469
|
+
#
|
|
470
|
+
# - `USA`
|
|
471
|
+
# - `CAN`
|
|
472
|
+
# - `AUS`
|
|
473
|
+
# - `CHN`
|
|
474
|
+
# - `KOR`
|
|
475
|
+
# - `MEX`
|
|
476
|
+
# - `MYS`
|
|
477
|
+
# - `NZL`
|
|
443
478
|
#
|
|
444
479
|
# @return [String, nil]
|
|
445
|
-
optional :
|
|
480
|
+
optional :state, String, nil?: true
|
|
446
481
|
|
|
447
|
-
# @!method initialize(address1:, city:, country:, postal_code
|
|
482
|
+
# @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
|
|
448
483
|
# Some parameter documentations has been truncated, see
|
|
449
484
|
# {Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson::Address}
|
|
450
485
|
# for more details.
|
|
451
486
|
#
|
|
452
487
|
# Individual's current address - PO boxes, UPS drops, and FedEx drops are not
|
|
453
|
-
# acceptable; APO/FPO are acceptable. Only USA addresses are
|
|
488
|
+
# acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
|
|
489
|
+
# and KYC workflows.
|
|
454
490
|
#
|
|
455
491
|
# @param address1 [String] Valid deliverable address (no PO boxes).
|
|
456
492
|
#
|
|
457
493
|
# @param city [String] Name of city.
|
|
458
494
|
#
|
|
459
|
-
# @param country [String] Valid country code
|
|
495
|
+
# @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
|
|
460
496
|
#
|
|
461
|
-
# @param
|
|
497
|
+
# @param address2 [String] Unit or apartment number (if applicable).
|
|
462
498
|
#
|
|
463
|
-
# @param
|
|
499
|
+
# @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
|
|
464
500
|
#
|
|
465
|
-
# @param
|
|
501
|
+
# @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
|
|
466
502
|
end
|
|
467
503
|
end
|
|
468
504
|
|
|
@@ -484,7 +520,8 @@ module Lithic
|
|
|
484
520
|
class Individual < Lithic::Internal::Type::BaseModel
|
|
485
521
|
# @!attribute address
|
|
486
522
|
# Individual's current address - PO boxes, UPS drops, and FedEx drops are not
|
|
487
|
-
# acceptable; APO/FPO are acceptable. Only USA addresses are
|
|
523
|
+
# acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
|
|
524
|
+
# and KYC workflows.
|
|
488
525
|
#
|
|
489
526
|
# @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual::Address, nil]
|
|
490
527
|
optional :address,
|
|
@@ -556,51 +593,68 @@ module Lithic
|
|
|
556
593
|
required :city, String
|
|
557
594
|
|
|
558
595
|
# @!attribute country
|
|
559
|
-
# Valid country code
|
|
560
|
-
#
|
|
596
|
+
# Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
|
|
597
|
+
# format. Supported countries depend on the onboarding workflow used for the
|
|
598
|
+
# account holder.
|
|
561
599
|
#
|
|
562
600
|
# @return [String]
|
|
563
601
|
required :country, String
|
|
564
602
|
|
|
565
|
-
# @!attribute
|
|
566
|
-
#
|
|
567
|
-
# five-digit ZIP or nine-digit ZIP+4.
|
|
603
|
+
# @!attribute address2
|
|
604
|
+
# Unit or apartment number (if applicable).
|
|
568
605
|
#
|
|
569
|
-
# @return [String]
|
|
570
|
-
|
|
606
|
+
# @return [String, nil]
|
|
607
|
+
optional :address2, String
|
|
571
608
|
|
|
572
|
-
# @!attribute
|
|
573
|
-
# Valid
|
|
574
|
-
#
|
|
609
|
+
# @!attribute postal_code
|
|
610
|
+
# Valid postal code. For USA addresses, enter either a five-digit postal code or a
|
|
611
|
+
# nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
|
|
612
|
+
# countries except the following, which do not use postal codes: ABW, AGO, ARE,
|
|
613
|
+
# ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
|
|
614
|
+
# ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
|
|
615
|
+
# SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
|
|
575
616
|
#
|
|
576
|
-
# @return [String]
|
|
577
|
-
|
|
617
|
+
# @return [String, nil]
|
|
618
|
+
optional :postal_code, String, nil?: true
|
|
578
619
|
|
|
579
|
-
# @!attribute
|
|
580
|
-
#
|
|
620
|
+
# @!attribute state
|
|
621
|
+
# Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
|
|
622
|
+
# code for the country without the country prefix. For example, `CA` for
|
|
623
|
+
# California. Optional unless the address is in one of the following countries,
|
|
624
|
+
# where it is required:
|
|
625
|
+
#
|
|
626
|
+
# - `USA`
|
|
627
|
+
# - `CAN`
|
|
628
|
+
# - `AUS`
|
|
629
|
+
# - `CHN`
|
|
630
|
+
# - `KOR`
|
|
631
|
+
# - `MEX`
|
|
632
|
+
# - `MYS`
|
|
633
|
+
# - `NZL`
|
|
581
634
|
#
|
|
582
635
|
# @return [String, nil]
|
|
583
|
-
optional :
|
|
636
|
+
optional :state, String, nil?: true
|
|
584
637
|
|
|
585
|
-
# @!method initialize(address1:, city:, country:, postal_code
|
|
638
|
+
# @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
|
|
586
639
|
# Some parameter documentations has been truncated, see
|
|
587
640
|
# {Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual::Address}
|
|
588
641
|
# for more details.
|
|
589
642
|
#
|
|
590
643
|
# Individual's current address - PO boxes, UPS drops, and FedEx drops are not
|
|
591
|
-
# acceptable; APO/FPO are acceptable. Only USA addresses are
|
|
644
|
+
# acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
|
|
645
|
+
# and KYC workflows.
|
|
592
646
|
#
|
|
593
647
|
# @param address1 [String] Valid deliverable address (no PO boxes).
|
|
594
648
|
#
|
|
595
649
|
# @param city [String] Name of city.
|
|
596
650
|
#
|
|
597
|
-
# @param country [String] Valid country code
|
|
651
|
+
# @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
|
|
598
652
|
#
|
|
599
|
-
# @param
|
|
653
|
+
# @param address2 [String] Unit or apartment number (if applicable).
|
|
600
654
|
#
|
|
601
|
-
# @param
|
|
655
|
+
# @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
|
|
602
656
|
#
|
|
603
|
-
# @param
|
|
657
|
+
# @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
|
|
604
658
|
end
|
|
605
659
|
end
|
|
606
660
|
|
|
@@ -129,7 +129,8 @@ module Lithic
|
|
|
129
129
|
|
|
130
130
|
# @!attribute address
|
|
131
131
|
# Individual's current address - PO boxes, UPS drops, and FedEx drops are not
|
|
132
|
-
# acceptable; APO/FPO are acceptable. Only USA addresses are
|
|
132
|
+
# acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
|
|
133
|
+
# and KYC workflows.
|
|
133
134
|
#
|
|
134
135
|
# @return [Lithic::Models::AddressUpdate, nil]
|
|
135
136
|
optional :address, -> { Lithic::AddressUpdate }
|
|
@@ -282,7 +283,8 @@ module Lithic
|
|
|
282
283
|
|
|
283
284
|
# @!attribute address
|
|
284
285
|
# Individual's current address - PO boxes, UPS drops, and FedEx drops are not
|
|
285
|
-
# acceptable; APO/FPO are acceptable. Only USA addresses are
|
|
286
|
+
# acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
|
|
287
|
+
# and KYC workflows.
|
|
286
288
|
#
|
|
287
289
|
# @return [Lithic::Models::AddressUpdate, nil]
|
|
288
290
|
optional :address, -> { Lithic::AddressUpdate }
|
|
@@ -397,7 +399,8 @@ module Lithic
|
|
|
397
399
|
|
|
398
400
|
# @!attribute address
|
|
399
401
|
# Individual's current address - PO boxes, UPS drops, and FedEx drops are not
|
|
400
|
-
# acceptable; APO/FPO are acceptable. Only USA addresses are
|
|
402
|
+
# acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
|
|
403
|
+
# and KYC workflows.
|
|
401
404
|
#
|
|
402
405
|
# @return [Lithic::Models::AddressUpdate, nil]
|
|
403
406
|
optional :address, -> { Lithic::AddressUpdate }
|