lithic 0.21.0 → 0.22.0

data/lib/lithic/models/financial_accounts/installment_plans/statement_list_params.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      module InstallmentPlans
+        # @see Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements#list
+        class StatementListParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          # @!attribute financial_account_token
+          #   Globally unique identifier for financial account.
+          #
+          #   @return [String]
+          required :financial_account_token, String
+
+          # @!attribute installment_plan_token
+          #   Globally unique identifier for installment plan.
+          #
+          #   @return [String]
+          required :installment_plan_token, String
+
+          # @!attribute begin_
+          #   Date string in RFC 3339 format. Only entries created after the specified date
+          #   will be included.
+          #
+          #   @return [Date, nil]
+          optional :begin_, Date
+
+          # @!attribute end_
+          #   Date string in RFC 3339 format. Only entries created before the specified date
+          #   will be included.
+          #
+          #   @return [Date, nil]
+          optional :end_, Date
+
+          # @!attribute ending_before
+          #   A cursor representing an item's token before which a page of results should end.
+          #   Used to retrieve the previous page of results before this item.
+          #
+          #   @return [String, nil]
+          optional :ending_before, String
+
+          # @!attribute page_size
+          #   Page size (for pagination).
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
+          # @!attribute starting_after
+          #   A cursor representing an item's token after which a page of results should
+          #   begin. Used to retrieve the next page of results after this item.
+          #
+          #   @return [String, nil]
+          optional :starting_after, String
+
+          # @!attribute state
+          #   Only snapshots in which the plan was in this state will be included.
+          #
+          #   @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams::State, nil]
+          optional :state,
+                   enum: -> { Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State },
+                   nil?: true
+
+          # @!method initialize(financial_account_token:, installment_plan_token:, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, state: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams} for
+          #   more details.
+          #
+          #   @param financial_account_token [String] Globally unique identifier for financial account.
+          #
+          #   @param installment_plan_token [String] Globally unique identifier for installment plan.
+          #
+          #   @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
+          #
+          #   @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
+          #
+          #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+          #
+          #   @param page_size [Integer] Page size (for pagination).
+          #
+          #   @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+          #
+          #   @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams::State, nil] Only snapshots in which the plan was in this state will be included.
+          #
+          #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+
+          # Only snapshots in which the plan was in this state will be included.
+          module State
+            extend Lithic::Internal::Type::Enum
+
+            PENDING = :PENDING
+            ACTIVE = :ACTIVE
+            REBUILD_IN_PROGRESS = :REBUILD_IN_PROGRESS
+            FULLY_PAID = :FULLY_PAID
+            CANCELLED = :CANCELLED
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      module InstallmentPlans
+        # @see Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements#retrieve
+        class StatementRetrieveParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          # @!attribute financial_account_token
+          #   Globally unique identifier for financial account.
+          #
+          #   @return [String]
+          required :financial_account_token, String
+
+          # @!attribute installment_plan_token
+          #   Globally unique identifier for installment plan.
+          #
+          #   @return [String]
+          required :installment_plan_token, String
+
+          # @!attribute statement_token
+          #   Globally unique identifier for statement.
+          #
+          #   @return [String]
+          required :statement_token, String
+
+          # @!method initialize(financial_account_token:, installment_plan_token:, statement_token:, request_options: {})
+          #   @param financial_account_token [String] Globally unique identifier for financial account.
+          #
+          #   @param installment_plan_token [String] Globally unique identifier for installment plan.
+          #
+          #   @param statement_token [String] Globally unique identifier for statement.
+          #
+          #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/financial_accounts/loan_tape.rb

@@ -93,6 +93,14 @@ module Lithic
         #   @return [Lithic::Models::FinancialAccounts::LoanTape::PaymentAllocation]
         required :payment_allocation, -> { Lithic::FinancialAccounts::LoanTape::PaymentAllocation }
 
+        # @!attribute payment_only_allocation
+        #   Allocation of payments only, excluding credits
+        #
+        #   @return [Lithic::Models::FinancialAccounts::LoanTape::PaymentOnlyAllocation, nil]
+        required :payment_only_allocation,
+                 -> { Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation },
+                 nil?: true
+
         # @!attribute period_totals
         #
         #   @return [Lithic::Models::StatementTotals]
@@ -138,7 +146,7 @@ module Lithic
         #   @return [String, nil]
         optional :tier, String, nil?: true
 
-        # @!method initialize(token:, account_standing:, available_credit:, balances:, created:, credit_limit:, credit_product_token:, date:, day_totals:, ending_balance:, excess_credits:, financial_account_token:, interest_details:, minimum_payment_balance:, payment_allocation:, period_totals:, previous_statement_balance:, starting_balance:, updated:, version:, ytd_totals:, day_of_period: nil, tier: nil)
+        # @!method initialize(token:, account_standing:, available_credit:, balances:, created:, credit_limit:, credit_product_token:, date:, day_totals:, ending_balance:, excess_credits:, financial_account_token:, interest_details:, minimum_payment_balance:, payment_allocation:, payment_only_allocation:, period_totals:, previous_statement_balance:, starting_balance:, updated:, version:, ytd_totals:, day_of_period: nil, tier: nil)
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::FinancialAccounts::LoanTape} for more details.
         #
@@ -172,6 +180,8 @@ module Lithic
         #
         #   @param payment_allocation [Lithic::Models::FinancialAccounts::LoanTape::PaymentAllocation]
         #
+        #   @param payment_only_allocation [Lithic::Models::FinancialAccounts::LoanTape::PaymentOnlyAllocation, nil] Allocation of payments only, excluding credits
+        #
         #   @param period_totals [Lithic::Models::StatementTotals]
         #
         #   @param previous_statement_balance [Lithic::Models::FinancialAccounts::LoanTape::PreviousStatementBalance]
@@ -494,6 +504,57 @@ module Lithic
           #   @param principal_details [Lithic::Models::CategoryDetails, nil]
         end
 
+        # @see Lithic::Models::FinancialAccounts::LoanTape#payment_only_allocation
+        class PaymentOnlyAllocation < Lithic::Internal::Type::BaseModel
+          # @!attribute fee_details
+          #
+          #   @return [Lithic::Models::CategoryDetails, nil]
+          required :fee_details, -> { Lithic::CategoryDetails }, nil?: true
+
+          # @!attribute fees
+          #   Amount allocated to fees in cents
+          #
+          #   @return [Integer]
+          required :fees, Integer
+
+          # @!attribute interest
+          #   Amount allocated to interest in cents
+          #
+          #   @return [Integer]
+          required :interest, Integer
+
+          # @!attribute interest_details
+          #
+          #   @return [Lithic::Models::CategoryDetails, nil]
+          required :interest_details, -> { Lithic::CategoryDetails }, nil?: true
+
+          # @!attribute principal
+          #   Amount allocated to principal in cents
+          #
+          #   @return [Integer]
+          required :principal, Integer
+
+          # @!attribute principal_details
+          #
+          #   @return [Lithic::Models::CategoryDetails, nil]
+          required :principal_details, -> { Lithic::CategoryDetails }, nil?: true
+
+          # @!method initialize(fee_details:, fees:, interest:, interest_details:, principal:, principal_details:)
+          #   Allocation of payments only, excluding credits
+          #
+          #   @param fee_details [Lithic::Models::CategoryDetails, nil]
+          #
+          #   @param fees [Integer] Amount allocated to fees in cents
+          #
+          #   @param interest [Integer] Amount allocated to interest in cents
+          #
+          #   @param interest_details [Lithic::Models::CategoryDetails, nil]
+          #
+          #   @param principal [Integer] Amount allocated to principal in cents
+          #
+          #   @param principal_details [Lithic::Models::CategoryDetails, nil]
+        end
+
         # @see Lithic::Models::FinancialAccounts::LoanTape#previous_statement_balance
         class PreviousStatementBalance < Lithic::Internal::Type::BaseModel
           # @!attribute amount

data/lib/lithic/models/kyb.rb

@@ -113,7 +113,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::Address]
         required :address, -> { Lithic::Address }
@@ -246,7 +247,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::Address]
         required :address, -> { Lithic::Address }

data/lib/lithic/models/kyb_business_entity.rb

@@ -75,33 +75,49 @@ 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 address2
+        #   Unit or apartment number (if applicable).
+        #
+        #   @return [String, nil]
+        optional :address2, 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.
+        #   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 :postal_code, String
+        #   @return [String, nil]
+        optional :postal_code, String, nil?: true
 
         # @!attribute state
-        #   Valid state code. Only USA state codes are currently supported, entered in
-        #   uppercase ISO 3166-2 two-character format.
+        #   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:
         #
-        #   @return [String]
-        required :state, String
-
-        # @!attribute address2
-        #   Unit or apartment number (if applicable).
+        #   - `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::KYBBusinessEntity::Address} for more details.
         #
@@ -112,13 +128,13 @@ module Lithic
         #
         #   @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
   end

data/lib/lithic/models/kyc.rb

@@ -58,7 +58,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::Address]
         required :address, -> { Lithic::Address }

data/lib/lithic/models/non_pci_card.rb

@@ -91,6 +91,14 @@ module Lithic
       #   @return [Symbol, Lithic::Models::NonPCICard::State]
       required :state, enum: -> { Lithic::NonPCICard::State }
 
+      # @!attribute tags
+      #   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
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :tags, Lithic::Internal::Type::HashOf[String]
+
       # @!attribute type
       #   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
@@ -223,7 +231,7 @@ module Lithic
       #   @return [Symbol, Lithic::Models::NonPCICard::Substatus, nil]
       optional :substatus, enum: -> { Lithic::NonPCICard::Substatus }, nil?: true
 
-      # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, bulk_order_token: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
+      # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, tags:, type:, auth_rule_tokens: nil, bulk_order_token: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::NonPCICard} for more details.
       #
@@ -250,6 +258,8 @@ module Lithic
       #   @param state [Symbol, Lithic::Models::NonPCICard::State] Card state values: \* `CLOSED` - Card will no longer approve authorizations.
       #   Clos
       #
+      #   @param tags [Hash{Symbol=>String}] Key-value pairs for tagging resources. Tags allow you to associate arbitrary met
+      #
       #   @param type [Symbol, Lithic::Models::NonPCICard::Type] Card types: \* `VIRTUAL` - Card will authorize at any merchant and can be added
       #   t
       #