lithic 0.21.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e9f6ed3184bfb671fac6deab7e1e5a01108b92a3f4adc97e15bd4539c5d69d1
-  data.tar.gz: d9f0cd5fa590316ed27b0de33185eff8342f2fa4e885720f6648d4f871d8ef5b
+  metadata.gz: fc989448bb022cd114bd44f64d856040cd80e588493094ac55a3b4faf0f6725a
+  data.tar.gz: b19f6c24a37b3cac6488a79621650569e5e333459d58d3239305efc8d6bab478
 SHA512:
-  metadata.gz: 9958c2f72d732e9b67960ffc80a089edf988feaaed6347d6946c4efa56aae6898d549507dfa3921b5399d2d099a0fa3bc204b8c4967a4ebf11b4e6494cdb56b1
-  data.tar.gz: ea002ba56ac10e779df7971feea5b3b6b752b3172feaf69e22abf4248df595b4574e17af419b6f690156b1c0f3663cf81b4a3f43da79eb24b3ef2de02eac4fc1
+  metadata.gz: 9d39e27a7a340b7325c097ac528486a731ab4c8fec6f270420a00ec8306436aaaec067775316299c31b2880b95020065ca8dbcfa86ccae76670532e96e027965
+  data.tar.gz: 3766f674fec04a8def4f4809c2b0c8c8eaaef02f0842832ecb2600b940447ae77dd25ebbbc85f6583b31f516cbce7217860bf7900f7a2739ef7173d02cb78d73

data/CHANGELOG.md

@@ -1,5 +1,55 @@
 # Changelog
 
+## [0.23.0](https://github.com/lithic-com/lithic-ruby/compare/v0.22.0...v0.23.0) (2026-10-29)
+
+
+### Features
+
+* **api:** add ALLPOINT to card transaction and authorization network enums ([dc34ff5](https://github.com/lithic-com/lithic-ruby/commit/dc34ff5ae508f99a2be5d558a03ee0ce01f4b236))
+* **api:** add financial_entity_id to transfer limits response items ([a3f8e8c](https://github.com/lithic-com/lithic-ruby/commit/a3f8e8cb9f37901f002b5e9cdba316448a6ffba4))
+* **api:** add INSTANCE_TO_INSTANCE to book transfer type and financial event type enums ([f42ede6](https://github.com/lithic-com/lithic-ruby/commit/f42ede6cb9d21a8ded2b6059a005a52cf9b4a3d7))
+* **api:** add intra-bank transaction category and intra_bank financial event types ([ff8d771](https://github.com/lithic-com/lithic-ruby/commit/ff8d771b0437ad74fc4d833d2530eb2d189cbdbf))
+* **api:** add ip_ranges.retrieve to get static IPs for Lithic ASA responder ([db702d5](https://github.com/lithic-com/lithic-ruby/commit/db702d5f5d03970433452019e2579da830105f9c))
+* **api:** add page_size to financial transaction lists and date filters to funding events list ([4a79194](https://github.com/lithic-com/lithic-ruby/commit/4a79194c8742592a85aa46aa75ff707d0b0e11b5))
+* **api:** add reference_id field to claims for matching with the dashboard ([186b254](https://github.com/lithic-com/lithic-ruby/commit/186b254774bdcaa30dcb18e40a0dbb1ce49a2110))
+* **api:** add unit_amount and total_amount to enhanced commercial data line items, deprecate amount ([e3f5c25](https://github.com/lithic-com/lithic-ruby/commit/e3f5c251fed13893fdc6a17bde583722249c3363))
+
+
+### Bug Fixes
+
+* **api:** correct status enum types on hold and card transaction models ([620c67d](https://github.com/lithic-com/lithic-ruby/commit/620c67d66247dfbf1fa87e0a9c19f4bf44d794ae))
+* **api:** financial account balance last transaction tokens are nullable (breaks java/kotlin types) ([f136d98](https://github.com/lithic-com/lithic-ruby/commit/f136d9805d1651f1052bf75c19d5f52155152978))
+* **api:** make tier_name, tier_rates, and penalty_rates nullable on account tier schedules ([7284947](https://github.com/lithic-com/lithic-ruby/commit/7284947097f697cfd1ac4234df867453a5a39230))
+
+
+### Chores
+
+* **ci:** raising minimum Ruby version to 3.4 ([#158](https://github.com/lithic-com/lithic-ruby/issues/158)) ([e55b6d6](https://github.com/lithic-com/lithic-ruby/commit/e55b6d6f2604db10d99965d4526494656bdeceb1))
+
+
+### Documentation
+
+* **api:** clarify credit product can only be assigned once to pending financial accounts ([563339a](https://github.com/lithic-com/lithic-ruby/commit/563339af8ae0313a68287e57290c3a01d1136a81))
+
+## [0.22.0](https://github.com/lithic-com/lithic-ruby/compare/v0.21.0...v0.22.0) (2026-10-13)
+
+
+### ⚠ BREAKING CHANGES
+
+* **api:** the CONDITIONAL_BLOCK rule type and the ConditionalBlockParameters model are removed. All rules are now CONDITIONAL_ACTION.
+
+### Features
+
+* **api:** accept billing_currency and settlement_currency on transaction simulation endpoints ([428ae58](https://github.com/lithic-com/lithic-ruby/commit/428ae5843e4ad441e828dcb7f73b889f8756d887))
+* **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))
+* **api:** add installment plan statement endpoints to financial accounts ([e94582e](https://github.com/lithic-com/lithic-ruby/commit/e94582ea1ea6e30db808bd62b2952dac9b3fd3ad))
+* **api:** add payment-only allocation breakdown to the loan tape ([625d033](https://github.com/lithic-com/lithic-ruby/commit/625d033aaec889eef435909baa44f3efabc17e50))
+* **api:** add tags to card create and update parameters and card responses ([31f4225](https://github.com/lithic-com/lithic-ruby/commit/31f42251508fff2120b90678891414285e34c5ab))
+* **api:** add tags to the card object in auth stream access requests ([5c9677a](https://github.com/lithic-com/lithic-ruby/commit/5c9677ade53fe5d0248a1cd6e5c109033388fb07))
+* **api:** expose the full conditional attribute set for authorization rules ([2ab59fc](https://github.com/lithic-com/lithic-ruby/commit/2ab59fc2d2113eba31919f86dd5cbff5e72d09bf))
+* **api:** remove CONDITIONAL_BLOCK from authorization rules ([7a4a3d3](https://github.com/lithic-com/lithic-ruby/commit/7a4a3d3ddf06d7f2139e38bde4c8f68e0f9e827e))
+* **api:** support international addresses and address2 for KYB_DELEGATED and KYC_EXEMPT workflows ([cd0721a](https://github.com/lithic-com/lithic-ruby/commit/cd0721a5e04383773baa69cb06f07d83ec037ef8))
+
 ## 0.21.0 (2026-09-18)
 
 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

@@ -2,15 +2,6 @@
 
 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.
 
-## MCP Server
-
-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.
-
-[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=lithic-mcp&config=eyJuYW1lIjoibGl0aGljLW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL2xpdGhpYy5zdGxtY3AuY29tIiwiaGVhZGVycyI6eyJ4LWxpdGhpYy1hcGkta2V5IjoiTXkgTGl0aGljIEFQSSBLZXkifX0)
-[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](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)
-
-> Note: You may need to set environment variables in your MCP client.
-
 ## Documentation
 
 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
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "lithic", "~> 0.21.0"
+gem "lithic", "~> 0.23.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/lithic/client.rb

@@ -80,6 +80,9 @@ module Lithic
     # @return [Lithic::Resources::ResponderEndpoints]
     attr_reader :responder_endpoints
 
+    # @return [Lithic::Resources::IPRanges]
+    attr_reader :ip_ranges
+
     # @return [Lithic::Resources::ExternalBankAccounts]
     attr_reader :external_bank_accounts
 
@@ -242,6 +245,7 @@ module Lithic
       @financial_accounts = Lithic::Resources::FinancialAccounts.new(client: self)
       @transactions = Lithic::Resources::Transactions.new(client: self)
       @responder_endpoints = Lithic::Resources::ResponderEndpoints.new(client: self)
+      @ip_ranges = Lithic::Resources::IPRanges.new(client: self)
       @external_bank_accounts = Lithic::Resources::ExternalBankAccounts.new(client: self)
       @blockchain_recipients = Lithic::Resources::BlockchainRecipients.new(client: self)
       @payments = Lithic::Resources::Payments.new(client: self)

data/lib/lithic/internal/type/union.rb

@@ -6,14 +6,28 @@ module Lithic
       # @api private
       #
       # @example
-      #   # `case_transaction` is a `Lithic::TransactionMonitoring::CaseTransaction`
-      #   case case_transaction
-      #   when Lithic::TransactionMonitoring::CaseTransaction::CardCaseTransaction
-      #     puts(case_transaction.token)
-      #   when Lithic::TransactionMonitoring::CaseTransaction::PaymentCaseTransaction
-      #     puts(case_transaction.added_at)
+      #   # `auth_rule_entity` is a `Lithic::AuthRules::AuthRuleEntity`
+      #   case auth_rule_entity
+      #   when Lithic::AuthRules::AuthRuleEntity::Program
+      #     puts(auth_rule_entity.type)
+      #   when Lithic::AuthRules::AuthRuleEntity::Card
+      #     puts(auth_rule_entity.token)
+      #   when Lithic::AuthRules::AuthRuleEntity::Account
+      #     puts(auth_rule_entity.token)
       #   else
-      #     puts(case_transaction)
+      #     puts(auth_rule_entity)
+      #   end
+      #
+      # @example
+      #   case auth_rule_entity
+      #   in {type: :PROGRAM}
+      #     # ...
+      #   in {type: :CARD, token: token}
+      #     puts(token)
+      #   in {type: :ACCOUNT, token: token}
+      #     puts(token)
+      #   else
+      #     puts(auth_rule_entity)
       #   end
       module Union
         include Lithic::Internal::Type::Converter

data/lib/lithic/models/account_activity_list_params.rb

@@ -112,6 +112,7 @@ module Lithic
         ACH = :ACH
         WIRE = :WIRE
         STABLECOIN = :STABLECOIN
+        INTRA_BANK = :INTRA_BANK
         BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
         FEE = :FEE
         REWARD = :REWARD

data/lib/lithic/models/account_activity_list_response.rb

@@ -151,6 +151,7 @@ module Lithic
           ACH = :ACH
           WIRE = :WIRE
           STABLECOIN = :STABLECOIN
+          INTRA_BANK = :INTRA_BANK
           BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
           FEE = :FEE
           REWARD = :REWARD
@@ -228,45 +229,22 @@ module Lithic
         #   @return [Symbol, :CARD]
         required :family, const: :CARD
 
-        # @!attribute status
-        #   The status of the transaction
-        #
-        #   @return [Symbol, Lithic::Models::AccountActivityListResponse::Card::Status]
-        required :status, enum: -> { Lithic::Models::AccountActivityListResponse::Card::Status }
-
         # @!attribute updated
         #   ISO 8601 timestamp of when the transaction was last updated
         #
         #   @return [Time]
         required :updated, Time
 
-        # @!method initialize(token:, created:, status:, updated:, family: :CARD)
+        # @!method initialize(token:, created:, updated:, family: :CARD)
         #   Card transaction with ledger base properties
         #
         #   @param token [String] Unique identifier for the transaction
         #
         #   @param created [Time] ISO 8601 timestamp of when the transaction was created
         #
-        #   @param status [Symbol, Lithic::Models::AccountActivityListResponse::Card::Status] The status of the transaction
-        #
         #   @param updated [Time] ISO 8601 timestamp of when the transaction was last updated
         #
         #   @param family [Symbol, :CARD] CARD - Card Transaction
-
-        # The status of the transaction
-        module Status
-          extend Lithic::Internal::Type::Enum
-
-          PENDING = :PENDING
-          SETTLED = :SETTLED
-          DECLINED = :DECLINED
-          REVERSED = :REVERSED
-          CANCELED = :CANCELED
-          RETURNED = :RETURNED
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
       end
 
       # @!method self.variants

data/lib/lithic/models/account_activity_retrieve_transaction_response.rb

@@ -154,6 +154,7 @@ module Lithic
           ACH = :ACH
           WIRE = :WIRE
           STABLECOIN = :STABLECOIN
+          INTRA_BANK = :INTRA_BANK
           BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
           FEE = :FEE
           REWARD = :REWARD
@@ -231,45 +232,22 @@ module Lithic
         #   @return [Symbol, :CARD]
         required :family, const: :CARD
 
-        # @!attribute status
-        #   The status of the transaction
-        #
-        #   @return [Symbol, Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status]
-        required :status, enum: -> { Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status }
-
         # @!attribute updated
         #   ISO 8601 timestamp of when the transaction was last updated
         #
         #   @return [Time]
         required :updated, Time
 
-        # @!method initialize(token:, created:, status:, updated:, family: :CARD)
+        # @!method initialize(token:, created:, updated:, family: :CARD)
         #   Card transaction with ledger base properties
         #
         #   @param token [String] Unique identifier for the transaction
         #
         #   @param created [Time] ISO 8601 timestamp of when the transaction was created
         #
-        #   @param status [Symbol, Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status] The status of the transaction
-        #
         #   @param updated [Time] ISO 8601 timestamp of when the transaction was last updated
         #
         #   @param family [Symbol, :CARD] CARD - Card Transaction
-
-        # The status of the transaction
-        module Status
-          extend Lithic::Internal::Type::Enum
-
-          PENDING = :PENDING
-          SETTLED = :SETTLED
-          DECLINED = :DECLINED
-          REVERSED = :REVERSED
-          CANCELED = :CANCELED
-          RETURNED = :RETURNED
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
       end
 
       # @!method self.variants

data/lib/lithic/models/account_holder_create_params.rb

@@ -202,7 +202,8 @@ module Lithic
 
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::Address, nil]
             optional :address, -> { Lithic::Address }
@@ -274,7 +275,8 @@ module Lithic
 
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::Address, nil]
             optional :address, -> { Lithic::Address }

data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb

@@ -216,7 +216,8 @@ module Lithic
       class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
         # @!attribute address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-        #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+        #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+        #   and KYC workflows.
         #
         #   @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual::Address, nil]
         optional :address,
@@ -285,51 +286,68 @@ module Lithic
           required :city, String
 
           # @!attribute country
-          #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #   3166-1 alpha-3 three-character format.
+          #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+          #   format. Supported countries depend on the onboarding workflow used for the
+          #   account holder.
           #
           #   @return [String]
           required :country, String
 
-          # @!attribute postal_code
-          #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-          #   five-digit ZIP or nine-digit ZIP+4.
+          # @!attribute address2
+          #   Unit or apartment number (if applicable).
           #
-          #   @return [String]
-          required :postal_code, String
+          #   @return [String, nil]
+          optional :address2, String
 
-          # @!attribute state
-          #   Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          # @!attribute postal_code
+          #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+          #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+          #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+          #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+          #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+          #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          optional :postal_code, String, nil?: true
 
-          # @!attribute address2
-          #   Unit or apartment number (if applicable).
+          # @!attribute state
+          #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+          #   code for the country without the country prefix. For example, `CA` for
+          #   California. Optional unless the address is in one of the following countries,
+          #   where it is required:
+          #
+          #   - `USA`
+          #   - `CAN`
+          #   - `AUS`
+          #   - `CHN`
+          #   - `KOR`
+          #   - `MEX`
+          #   - `MYS`
+          #   - `NZL`
           #
           #   @return [String, nil]
-          optional :address2, String
+          optional :state, String, nil?: true
 
-          # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+          # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::BeneficialOwnerIndividual::Address}
           #   for more details.
           #
           #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          #   and KYC workflows.
           #
           #   @param address1 [String] Valid deliverable address (no PO boxes).
           #
           #   @param city [String] Name of city.
           #
-          #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+          #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
           #
-          #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+          #   @param address2 [String] Unit or apartment number (if applicable).
           #
-          #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+          #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
           #
-          #   @param address2 [String] Unit or apartment number (if applicable).
+          #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
         end
       end
 
@@ -337,7 +355,8 @@ module Lithic
       class ControlPerson < Lithic::Internal::Type::BaseModel
         # @!attribute address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-        #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+        #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+        #   and KYC workflows.
         #
         #   @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson::Address, nil]
         optional :address,
@@ -418,51 +437,68 @@ module Lithic
           required :city, String
 
           # @!attribute country
-          #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #   3166-1 alpha-3 three-character format.
+          #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+          #   format. Supported countries depend on the onboarding workflow used for the
+          #   account holder.
           #
           #   @return [String]
           required :country, String
 
-          # @!attribute postal_code
-          #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-          #   five-digit ZIP or nine-digit ZIP+4.
+          # @!attribute address2
+          #   Unit or apartment number (if applicable).
           #
-          #   @return [String]
-          required :postal_code, String
+          #   @return [String, nil]
+          optional :address2, String
 
-          # @!attribute state
-          #   Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          # @!attribute postal_code
+          #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+          #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+          #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+          #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+          #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+          #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          optional :postal_code, String, nil?: true
 
-          # @!attribute address2
-          #   Unit or apartment number (if applicable).
+          # @!attribute state
+          #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+          #   code for the country without the country prefix. For example, `CA` for
+          #   California. Optional unless the address is in one of the following countries,
+          #   where it is required:
+          #
+          #   - `USA`
+          #   - `CAN`
+          #   - `AUS`
+          #   - `CHN`
+          #   - `KOR`
+          #   - `MEX`
+          #   - `MYS`
+          #   - `NZL`
           #
           #   @return [String, nil]
-          optional :address2, String
+          optional :state, String, nil?: true
 
-          # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+          # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ControlPerson::Address}
           #   for more details.
           #
           #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          #   and KYC workflows.
           #
           #   @param address1 [String] Valid deliverable address (no PO boxes).
           #
           #   @param city [String] Name of city.
           #
-          #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+          #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
           #
-          #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+          #   @param address2 [String] Unit or apartment number (if applicable).
           #
-          #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+          #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
           #
-          #   @param address2 [String] Unit or apartment number (if applicable).
+          #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
         end
       end
 
@@ -484,7 +520,8 @@ module Lithic
       class Individual < Lithic::Internal::Type::BaseModel
         # @!attribute address
         #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-        #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+        #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+        #   and KYC workflows.
         #
         #   @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual::Address, nil]
         optional :address,
@@ -556,51 +593,68 @@ module Lithic
           required :city, String
 
           # @!attribute country
-          #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-          #   3166-1 alpha-3 three-character format.
+          #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+          #   format. Supported countries depend on the onboarding workflow used for the
+          #   account holder.
           #
           #   @return [String]
           required :country, String
 
-          # @!attribute postal_code
-          #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-          #   five-digit ZIP or nine-digit ZIP+4.
+          # @!attribute address2
+          #   Unit or apartment number (if applicable).
           #
-          #   @return [String]
-          required :postal_code, String
+          #   @return [String, nil]
+          optional :address2, String
 
-          # @!attribute state
-          #   Valid state code. Only USA state codes are currently supported, entered in
-          #   uppercase ISO 3166-2 two-character format.
+          # @!attribute postal_code
+          #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+          #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+          #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+          #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+          #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+          #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
           #
-          #   @return [String]
-          required :state, String
+          #   @return [String, nil]
+          optional :postal_code, String, nil?: true
 
-          # @!attribute address2
-          #   Unit or apartment number (if applicable).
+          # @!attribute state
+          #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+          #   code for the country without the country prefix. For example, `CA` for
+          #   California. Optional unless the address is in one of the following countries,
+          #   where it is required:
+          #
+          #   - `USA`
+          #   - `CAN`
+          #   - `AUS`
+          #   - `CHN`
+          #   - `KOR`
+          #   - `MEX`
+          #   - `MYS`
+          #   - `NZL`
           #
           #   @return [String, nil]
-          optional :address2, String
+          optional :state, String, nil?: true
 
-          # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+          # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Individual::Address}
           #   for more details.
           #
           #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-          #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+          #   and KYC workflows.
           #
           #   @param address1 [String] Valid deliverable address (no PO boxes).
           #
           #   @param city [String] Name of city.
           #
-          #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+          #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
           #
-          #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+          #   @param address2 [String] Unit or apartment number (if applicable).
           #
-          #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+          #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
           #
-          #   @param address2 [String] Unit or apartment number (if applicable).
+          #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
         end
       end
 

data/lib/lithic/models/account_holder_update_params.rb

@@ -129,7 +129,8 @@ module Lithic
 
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::AddressUpdate, nil]
             optional :address, -> { Lithic::AddressUpdate }
@@ -282,7 +283,8 @@ module Lithic
 
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::AddressUpdate, nil]
             optional :address, -> { Lithic::AddressUpdate }
@@ -397,7 +399,8 @@ module Lithic
 
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::AddressUpdate, nil]
             optional :address, -> { Lithic::AddressUpdate }