lithic 0.5.0 → 0.6.0

data/lib/lithic/resources/account_holders/entities.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class AccountHolders
+      class Entities
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::AccountHolders::EntityCreateParams} for more details.
+        #
+        # Create a new beneficial owner or replace the control person entity on an
+        # existing KYB account holder. This endpoint is only applicable for account
+        # holders enrolled through a KYB workflow with the Persona KYB provider. A new
+        # control person can only replace the existing one. A maximum of 4 beneficial
+        # owners can be associated with an account holder.
+        #
+        # @overload create(account_holder_token, address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:, type:, request_options: {})
+        #
+        # @param account_holder_token [String] Globally unique identifier for the account holder.
+        #
+        # @param address [Lithic::Models::AccountHolders::EntityCreateParams::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
+        #
+        # @param dob [String] Individual's date of birth, as an RFC 3339 date.
+        #
+        # @param email [String] Individual's email address. If utilizing Lithic for chargeback processing, this
+        #
+        # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
+        #
+        # @param government_id [String] Government-issued identification number (required for identity verification and
+        #
+        # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
+        #
+        # @param phone_number [String] Individual's phone number, entered in E.164 format.
+        #
+        # @param type [Symbol, Lithic::Models::AccountHolders::EntityCreateParams::Type] The type of entity to create on the account holder
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::AccountHolders::EntityCreateResponse]
+        #
+        # @see Lithic::Models::AccountHolders::EntityCreateParams
+        def create(account_holder_token, params)
+          parsed, options = Lithic::AccountHolders::EntityCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["v1/account_holders/%1$s/entities", account_holder_token],
+            body: parsed,
+            model: Lithic::Models::AccountHolders::EntityCreateResponse,
+            options: options
+          )
+        end
+
+        # Deactivate a beneficial owner entity on an existing KYB account holder. Only
+        # beneficial owner entities can be deactivated.
+        #
+        # @overload delete(entity_token, account_holder_token:, request_options: {})
+        #
+        # @param entity_token [String] Globally unique identifier for the entity.
+        #
+        # @param account_holder_token [String] Globally unique identifier for the account holder.
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::AccountHolders::AccountHolderEntity]
+        #
+        # @see Lithic::Models::AccountHolders::EntityDeleteParams
+        def delete(entity_token, params)
+          parsed, options = Lithic::AccountHolders::EntityDeleteParams.dump_request(params)
+          account_holder_token =
+            parsed.delete(:account_holder_token) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["v1/account_holders/%1$s/entities/%2$s", account_holder_token, entity_token],
+            model: Lithic::AccountHolders::AccountHolderEntity,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Lithic::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/lithic/resources/account_holders.rb

@@ -3,6 +3,9 @@
 module Lithic
   module Resources
     class AccountHolders
+      # @return [Lithic::Resources::AccountHolders::Entities]
+      attr_reader :entities
+
       # Some parameter documentations has been truncated, see
       # {Lithic::Models::AccountHolderCreateParams} for more details.
       #
@@ -391,6 +394,7 @@ module Lithic
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client
+        @entities = Lithic::Resources::AccountHolders::Entities.new(client: client)
       end
     end
   end

data/lib/lithic/resources/financial_accounts/interest_tier_schedule.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class FinancialAccounts
+      class InterestTierSchedule
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::FinancialAccounts::InterestTierScheduleCreateParams} for more
+        # details.
+        #
+        # Create a new interest tier schedule entry for a supported financial account
+        #
+        # @overload create(financial_account_token, credit_product_token:, effective_date:, tier_name: nil, tier_rates: nil, request_options: {})
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account
+        #
+        # @param credit_product_token [String] Globally unique identifier for a credit product
+        #
+        # @param effective_date [Date] Date the tier should be effective in YYYY-MM-DD format
+        #
+        # @param tier_name [String] Name of a tier contained in the credit product. Mutually exclusive with tier_rat
+        #
+        # @param tier_rates [Object] Custom rates per category. Mutually exclusive with tier_name
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::FinancialAccounts::FinancialAccountsInterestTierSchedule]
+        #
+        # @see Lithic::Models::FinancialAccounts::InterestTierScheduleCreateParams
+        def create(financial_account_token, params)
+          parsed, options = Lithic::FinancialAccounts::InterestTierScheduleCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["v1/financial_accounts/%1$s/interest_tier_schedule", financial_account_token],
+            body: parsed,
+            model: Lithic::FinancialAccounts::FinancialAccountsInterestTierSchedule,
+            options: options
+          )
+        end
+
+        # Get a specific interest tier schedule by effective date
+        #
+        # @overload retrieve(effective_date, financial_account_token:, request_options: {})
+        #
+        # @param effective_date [Date] Effective date in ISO format (YYYY-MM-DD)
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::FinancialAccounts::FinancialAccountsInterestTierSchedule]
+        #
+        # @see Lithic::Models::FinancialAccounts::InterestTierScheduleRetrieveParams
+        def retrieve(effective_date, params)
+          parsed, options = Lithic::FinancialAccounts::InterestTierScheduleRetrieveParams.dump_request(params)
+          financial_account_token =
+            parsed.delete(:financial_account_token) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: [
+              "v1/financial_accounts/%1$s/interest_tier_schedule/%2$s",
+              financial_account_token,
+              effective_date
+            ],
+            model: Lithic::FinancialAccounts::FinancialAccountsInterestTierSchedule,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::FinancialAccounts::InterestTierScheduleUpdateParams} for more
+        # details.
+        #
+        # Update an existing interest tier schedule
+        #
+        # @overload update(effective_date, financial_account_token:, tier_name: nil, tier_rates: nil, request_options: {})
+        #
+        # @param effective_date [Date] Path param: Effective date in ISO format (YYYY-MM-DD)
+        #
+        # @param financial_account_token [String] Path param: Globally unique identifier for financial account
+        #
+        # @param tier_name [String] Body param: Name of a tier contained in the credit product. Mutually exclusive w
+        #
+        # @param tier_rates [Object] Body param: Custom rates per category. Mutually exclusive with tier_name
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::FinancialAccounts::FinancialAccountsInterestTierSchedule]
+        #
+        # @see Lithic::Models::FinancialAccounts::InterestTierScheduleUpdateParams
+        def update(effective_date, params)
+          parsed, options = Lithic::FinancialAccounts::InterestTierScheduleUpdateParams.dump_request(params)
+          financial_account_token =
+            parsed.delete(:financial_account_token) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: [
+              "v1/financial_accounts/%1$s/interest_tier_schedule/%2$s",
+              financial_account_token,
+              effective_date
+            ],
+            body: parsed,
+            model: Lithic::FinancialAccounts::FinancialAccountsInterestTierSchedule,
+            options: options
+          )
+        end
+
+        # List interest tier schedules for a financial account with optional date
+        # filtering.
+        #
+        # If no date parameters are provided, returns all tier schedules. If date
+        # parameters are provided, uses filtering to return matching schedules (max 100).
+        #
+        # - for_date: Returns exact match (takes precedence over other dates)
+        # - before_date: Returns schedules with effective_date <= before_date
+        # - after_date: Returns schedules with effective_date >= after_date
+        # - Both before_date and after_date: Returns schedules in range
+        #
+        # @overload list(financial_account_token, after_date: nil, before_date: nil, for_date: nil, request_options: {})
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account
+        #
+        # @param after_date [Date] Return schedules with effective_date >= after_date (ISO format YYYY-MM-DD)
+        #
+        # @param before_date [Date] Return schedules with effective_date <= before_date (ISO format YYYY-MM-DD)
+        #
+        # @param for_date [Date] Return schedule with effective_date == for_date (ISO format YYYY-MM-DD)
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialAccounts::FinancialAccountsInterestTierSchedule>]
+        #
+        # @see Lithic::Models::FinancialAccounts::InterestTierScheduleListParams
+        def list(financial_account_token, params = {})
+          parsed, options = Lithic::FinancialAccounts::InterestTierScheduleListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["v1/financial_accounts/%1$s/interest_tier_schedule", financial_account_token],
+            query: parsed,
+            page: Lithic::Internal::SinglePage,
+            model: Lithic::FinancialAccounts::FinancialAccountsInterestTierSchedule,
+            options: options
+          )
+        end
+
+        # Delete an interest tier schedule entry.
+        #
+        # Returns:
+        #
+        # - 400 Bad Request: Invalid effective_date format OR attempting to delete the
+        #   earliest tier schedule entry for a non-PENDING account
+        # - 404 Not Found: Tier schedule entry not found for the given effective_date OR
+        #   ledger account not found
+        #
+        # Note: PENDING accounts can delete the earliest tier schedule entry (account
+        # hasn't opened yet). Active/non-PENDING accounts cannot delete the earliest entry
+        # to prevent orphaning the account.
+        #
+        # If the deleted tier schedule has a past effective_date and the account is
+        # ACTIVE, the loan tape rebuild configuration will be updated to trigger rebuilds
+        # from that date.
+        #
+        # @overload delete(effective_date, financial_account_token:, request_options: {})
+        #
+        # @param effective_date [Date] Effective date in ISO format (YYYY-MM-DD)
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Lithic::Models::FinancialAccounts::InterestTierScheduleDeleteParams
+        def delete(effective_date, params)
+          parsed, options = Lithic::FinancialAccounts::InterestTierScheduleDeleteParams.dump_request(params)
+          financial_account_token =
+            parsed.delete(:financial_account_token) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: [
+              "v1/financial_accounts/%1$s/interest_tier_schedule/%2$s",
+              financial_account_token,
+              effective_date
+            ],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Lithic::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/lithic/resources/financial_accounts/loan_tape_configuration.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class FinancialAccounts
+      class LoanTapeConfiguration
+        # Get the loan tape configuration for a given financial account.
+        #
+        # @overload retrieve(financial_account_token, request_options: {})
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::FinancialAccounts::FinancialAccountsLoanTapeConfiguration]
+        #
+        # @see Lithic::Models::FinancialAccounts::LoanTapeConfigurationRetrieveParams
+        def retrieve(financial_account_token, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/financial_accounts/%1$s/loan_tape_configuration", financial_account_token],
+            model: Lithic::FinancialAccounts::FinancialAccountsLoanTapeConfiguration,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Lithic::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/lithic/resources/financial_accounts.rb

@@ -18,6 +18,12 @@ module Lithic
       # @return [Lithic::Resources::FinancialAccounts::LoanTapes]
       attr_reader :loan_tapes
 
+      # @return [Lithic::Resources::FinancialAccounts::LoanTapeConfiguration]
+      attr_reader :loan_tape_configuration
+
+      # @return [Lithic::Resources::FinancialAccounts::InterestTierSchedule]
+      attr_reader :interest_tier_schedule
+
       # Create a new financial account
       #
       # @overload create(nickname:, type:, account_token: nil, is_for_benefit_of: nil, idempotency_key: nil, request_options: {})
@@ -181,6 +187,9 @@ module Lithic
         @credit_configuration = Lithic::Resources::FinancialAccounts::CreditConfiguration.new(client: client)
         @statements = Lithic::Resources::FinancialAccounts::Statements.new(client: client)
         @loan_tapes = Lithic::Resources::FinancialAccounts::LoanTapes.new(client: client)
+        @loan_tape_configuration =
+          Lithic::Resources::FinancialAccounts::LoanTapeConfiguration.new(client: client)
+        @interest_tier_schedule = Lithic::Resources::FinancialAccounts::InterestTierSchedule.new(client: client)
       end
     end
   end

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/lithic.rb

@@ -65,6 +65,7 @@ require_relative "lithic/models/dispute"
 require_relative "lithic/models/external_bank_account"
 require_relative "lithic/models/external_payment"
 require_relative "lithic/models/financial_account"
+require_relative "lithic/models/financial_accounts/interest_tier_schedule"
 require_relative "lithic/models/funding_event"
 require_relative "lithic/models/internal_transaction"
 require_relative "lithic/models/financial_accounts/loan_tape"
@@ -91,6 +92,10 @@ require_relative "lithic/models/account_holder_list_documents_response"
 require_relative "lithic/models/account_holder_list_params"
 require_relative "lithic/models/account_holder_retrieve_document_params"
 require_relative "lithic/models/account_holder_retrieve_params"
+require_relative "lithic/models/account_holders/account_holder_entity"
+require_relative "lithic/models/account_holders/entity_create_params"
+require_relative "lithic/models/account_holders/entity_create_response"
+require_relative "lithic/models/account_holders/entity_delete_params"
 require_relative "lithic/models/account_holder_simulate_enrollment_document_review_params"
 require_relative "lithic/models/account_holder_simulate_enrollment_review_params"
 require_relative "lithic/models/account_holder_simulate_enrollment_review_response"
@@ -209,7 +214,6 @@ require_relative "lithic/models/digital_wallet_tokenization_result_webhook_event
 require_relative "lithic/models/digital_wallet_tokenization_two_factor_authentication_code_sent_webhook_event"
 require_relative "lithic/models/digital_wallet_tokenization_two_factor_authentication_code_webhook_event"
 require_relative "lithic/models/digital_wallet_tokenization_updated_webhook_event"
-require_relative "lithic/models/digital_wallet_token_metadata"
 require_relative "lithic/models/dispute_create_params"
 require_relative "lithic/models/dispute_delete_evidence_params"
 require_relative "lithic/models/dispute_delete_params"
@@ -280,13 +284,22 @@ require_relative "lithic/models/financial_account_register_account_number_params
 require_relative "lithic/models/financial_account_retrieve_params"
 require_relative "lithic/models/financial_accounts/balance_list_params"
 require_relative "lithic/models/financial_accounts/category_balances"
+require_relative "lithic/models/financial_accounts/category_tier"
 require_relative "lithic/models/financial_accounts/credit_configuration_retrieve_params"
 require_relative "lithic/models/financial_accounts/credit_configuration_update_params"
 require_relative "lithic/models/financial_accounts/financial_account_credit_config"
+require_relative "lithic/models/financial_accounts/loan_tape_configuration"
 require_relative "lithic/models/financial_accounts/statements"
 require_relative "lithic/models/financial_accounts/financial_transaction_list_params"
 require_relative "lithic/models/financial_accounts/financial_transaction_retrieve_params"
+require_relative "lithic/models/financial_accounts/interest_tier_schedule_create_params"
+require_relative "lithic/models/financial_accounts/interest_tier_schedule_delete_params"
+require_relative "lithic/models/financial_accounts/interest_tier_schedule_list_params"
+require_relative "lithic/models/financial_accounts/interest_tier_schedule_retrieve_params"
+require_relative "lithic/models/financial_accounts/interest_tier_schedule_update_params"
+require_relative "lithic/models/financial_accounts/loan_tape_configuration_retrieve_params"
 require_relative "lithic/models/financial_accounts/loan_tape_list_params"
+require_relative "lithic/models/financial_accounts/loan_tape_rebuild_configuration"
 require_relative "lithic/models/financial_accounts/loan_tape_retrieve_params"
 require_relative "lithic/models/financial_accounts/statement_list_params"
 require_relative "lithic/models/financial_accounts/statement_retrieve_params"
@@ -402,6 +415,7 @@ require_relative "lithic/models/tokenization_two_factor_authentication_code_webh
 require_relative "lithic/models/tokenization_unpause_params"
 require_relative "lithic/models/tokenization_update_digital_card_art_params"
 require_relative "lithic/models/tokenization_updated_webhook_event"
+require_relative "lithic/models/token_metadata"
 require_relative "lithic/models/transaction_expire_authorization_params"
 require_relative "lithic/models/transaction_list_params"
 require_relative "lithic/models/transaction_retrieve_params"
@@ -433,6 +447,7 @@ require_relative "lithic/models/wire_party_details"
 require_relative "lithic/models"
 require_relative "lithic/resources/account_activity"
 require_relative "lithic/resources/account_holders"
+require_relative "lithic/resources/account_holders/entities"
 require_relative "lithic/resources/accounts"
 require_relative "lithic/resources/auth_rules"
 require_relative "lithic/resources/auth_rules/v2"
@@ -461,6 +476,8 @@ require_relative "lithic/resources/financial_accounts"
 require_relative "lithic/resources/financial_accounts/balances"
 require_relative "lithic/resources/financial_accounts/credit_configuration"
 require_relative "lithic/resources/financial_accounts/financial_transactions"
+require_relative "lithic/resources/financial_accounts/interest_tier_schedule"
+require_relative "lithic/resources/financial_accounts/loan_tape_configuration"
 require_relative "lithic/resources/financial_accounts/loan_tapes"
 require_relative "lithic/resources/financial_accounts/statements"
 require_relative "lithic/resources/financial_accounts/statements/line_items"