lithic 0.21.0 → 0.22.0

data/rbi/lithic/models/financial_accounts/loan_tape.rbi

@@ -120,6 +120,26 @@ module Lithic
         end
         attr_writer :payment_allocation
 
+        # Allocation of payments only, excluding credits
+        sig do
+          returns(
+            T.nilable(
+              Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation
+            )
+          )
+        end
+        attr_reader :payment_only_allocation
+
+        sig do
+          params(
+            payment_only_allocation:
+              T.nilable(
+                Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation::OrHash
+              )
+          ).void
+        end
+        attr_writer :payment_only_allocation
+
         sig { returns(Lithic::StatementTotals) }
         attr_reader :period_totals
 
@@ -188,6 +208,10 @@ module Lithic
               Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance::OrHash,
             payment_allocation:
               Lithic::FinancialAccounts::LoanTape::PaymentAllocation::OrHash,
+            payment_only_allocation:
+              T.nilable(
+                Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation::OrHash
+              ),
             period_totals: Lithic::StatementTotals::OrHash,
             previous_statement_balance:
               Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance::OrHash,
@@ -228,6 +252,8 @@ module Lithic
           interest_details:,
           minimum_payment_balance:,
           payment_allocation:,
+          # Allocation of payments only, excluding credits
+          payment_only_allocation:,
           period_totals:,
           previous_statement_balance:,
           # Balance at the start of the day
@@ -266,6 +292,10 @@ module Lithic
                 Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance,
               payment_allocation:
                 Lithic::FinancialAccounts::LoanTape::PaymentAllocation,
+              payment_only_allocation:
+                T.nilable(
+                  Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation
+                ),
               period_totals: Lithic::StatementTotals,
               previous_statement_balance:
                 Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance,
@@ -926,6 +956,95 @@ module Lithic
           end
         end
 
+        class PaymentOnlyAllocation < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(Lithic::CategoryDetails)) }
+          attr_reader :fee_details
+
+          sig do
+            params(fee_details: T.nilable(Lithic::CategoryDetails::OrHash)).void
+          end
+          attr_writer :fee_details
+
+          # Amount allocated to fees in cents
+          sig { returns(Integer) }
+          attr_accessor :fees
+
+          # Amount allocated to interest in cents
+          sig { returns(Integer) }
+          attr_accessor :interest
+
+          sig { returns(T.nilable(Lithic::CategoryDetails)) }
+          attr_reader :interest_details
+
+          sig do
+            params(
+              interest_details: T.nilable(Lithic::CategoryDetails::OrHash)
+            ).void
+          end
+          attr_writer :interest_details
+
+          # Amount allocated to principal in cents
+          sig { returns(Integer) }
+          attr_accessor :principal
+
+          sig { returns(T.nilable(Lithic::CategoryDetails)) }
+          attr_reader :principal_details
+
+          sig do
+            params(
+              principal_details: T.nilable(Lithic::CategoryDetails::OrHash)
+            ).void
+          end
+          attr_writer :principal_details
+
+          # Allocation of payments only, excluding credits
+          sig do
+            params(
+              fee_details: T.nilable(Lithic::CategoryDetails::OrHash),
+              fees: Integer,
+              interest: Integer,
+              interest_details: T.nilable(Lithic::CategoryDetails::OrHash),
+              principal: Integer,
+              principal_details: T.nilable(Lithic::CategoryDetails::OrHash)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            fee_details:,
+            # Amount allocated to fees in cents
+            fees:,
+            # Amount allocated to interest in cents
+            interest:,
+            interest_details:,
+            # Amount allocated to principal in cents
+            principal:,
+            principal_details:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                fee_details: T.nilable(Lithic::CategoryDetails),
+                fees: Integer,
+                interest: Integer,
+                interest_details: T.nilable(Lithic::CategoryDetails),
+                principal: Integer,
+                principal_details: T.nilable(Lithic::CategoryDetails)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
         class PreviousStatementBalance < Lithic::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/lithic/models/kyb.rbi

@@ -176,7 +176,8 @@ module Lithic
           end
 
         # 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.
         sig { returns(Lithic::Address) }
         attr_reader :address
 
@@ -228,7 +229,8 @@ module Lithic
         end
         def self.new(
           # 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.
           address:,
           # Individual's date of birth, as an RFC 3339 date.
           dob:,
@@ -366,7 +368,8 @@ module Lithic
           end
 
         # 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.
         sig { returns(Lithic::Address) }
         attr_reader :address
 
@@ -425,7 +428,8 @@ module Lithic
         end
         def self.new(
           # 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.
           address:,
           # Individual's date of birth, as an RFC 3339 date.
           dob:,

data/rbi/lithic/models/kyb_business_entity.rbi

@@ -103,21 +103,12 @@ module Lithic
         sig { returns(String) }
         attr_accessor :city
 
-        # 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.
         sig { returns(String) }
         attr_accessor :country
 
-        # Valid postal code. Only USA ZIP codes are currently supported, entered as a
-        # five-digit ZIP or nine-digit ZIP+4.
-        sig { returns(String) }
-        attr_accessor :postal_code
-
-        # Valid state code. Only USA state codes are currently supported, entered in
-        # uppercase ISO 3166-2 two-character format.
-        sig { returns(String) }
-        attr_accessor :state
-
         # Unit or apartment number (if applicable).
         sig { returns(T.nilable(String)) }
         attr_reader :address2
@@ -125,6 +116,31 @@ module Lithic
         sig { params(address2: String).void }
         attr_writer :address2
 
+        # 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
+        sig { returns(T.nilable(String)) }
+        attr_accessor :postal_code
+
+        # 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`
+        sig { returns(T.nilable(String)) }
+        attr_accessor :state
+
         # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
         # acceptable; APO/FPO are acceptable.
         sig do
@@ -132,9 +148,9 @@ module Lithic
             address1: String,
             city: String,
             country: String,
-            postal_code: String,
-            state: String,
-            address2: String
+            address2: String,
+            postal_code: T.nilable(String),
+            state: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -142,17 +158,33 @@ module Lithic
           address1:,
           # Name of city.
           city:,
-          # 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.
           country:,
-          # Valid postal code. Only USA ZIP codes are currently supported, entered as a
-          # five-digit ZIP or nine-digit ZIP+4.
-          postal_code:,
-          # Valid state code. Only USA state codes are currently supported, entered in
-          # uppercase ISO 3166-2 two-character format.
-          state:,
           # Unit or apartment number (if applicable).
-          address2: nil
+          address2: nil,
+          # 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
+          postal_code: nil,
+          # 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`
+          state: nil
         )
         end
 
@@ -162,9 +194,9 @@ module Lithic
               address1: String,
               city: String,
               country: String,
-              postal_code: String,
-              state: String,
-              address2: String
+              address2: String,
+              postal_code: T.nilable(String),
+              state: T.nilable(String)
             }
           )
         end

data/rbi/lithic/models/kyc.rbi

@@ -92,7 +92,8 @@ module Lithic
           end
 
         # 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.
         sig { returns(Lithic::Address) }
         attr_reader :address
 
@@ -142,7 +143,8 @@ module Lithic
         end
         def self.new(
           # 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.
           address:,
           # Individual's date of birth, as an RFC 3339 date.
           dob:,

data/rbi/lithic/models/non_pci_card.rbi

@@ -78,6 +78,12 @@ module Lithic
       sig { returns(Lithic::NonPCICard::State::TaggedSymbol) }
       attr_accessor :state
 
+      # Key-value pairs for tagging resources. Tags allow you to associate arbitrary
+      # metadata with a resource for your own purposes. A resource can have at most 50
+      # tags, with keys up to 40 characters and values up to 500 characters
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :tags
+
       # Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
       # to a digital wallet like Apple Pay or Google Pay (if the card program is digital
       # wallet-enabled). _ `PHYSICAL` - Manufactured and sent to the cardholder. We
@@ -215,6 +221,7 @@ module Lithic
           spend_limit: Integer,
           spend_limit_duration: Lithic::SpendLimitDuration::OrSymbol,
           state: Lithic::NonPCICard::State::OrSymbol,
+          tags: T::Hash[Symbol, String],
           type: Lithic::NonPCICard::Type::OrSymbol,
           auth_rule_tokens: T::Array[String],
           bulk_order_token: T.nilable(String),
@@ -280,6 +287,10 @@ module Lithic
         # In sandbox, the same daily batch fulfillment occurs, but no cards are actually
         # manufactured.
         state:,
+        # Key-value pairs for tagging resources. Tags allow you to associate arbitrary
+        # metadata with a resource for your own purposes. A resource can have at most 50
+        # tags, with keys up to 40 characters and values up to 500 characters
+        tags:,
         # Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
         # to a digital wallet like Apple Pay or Google Pay (if the card program is digital
         # wallet-enabled). _ `PHYSICAL` - Manufactured and sent to the cardholder. We
@@ -366,6 +377,7 @@ module Lithic
             spend_limit: Integer,
             spend_limit_duration: Lithic::SpendLimitDuration::TaggedSymbol,
             state: Lithic::NonPCICard::State::TaggedSymbol,
+            tags: T::Hash[Symbol, String],
             type: Lithic::NonPCICard::Type::TaggedSymbol,
             auth_rule_tokens: T::Array[String],
             bulk_order_token: T.nilable(String),