lithic 0.4.0 → 0.6.0

data/rbi/lithic/models/financial_accounts/interest_tier_schedule.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class FinancialAccountsInterestTierSchedule < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::FinancialAccountsInterestTierSchedule,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Globally unique identifier for a credit product
+        sig { returns(String) }
+        attr_accessor :credit_product_token
+
+        # Date the tier should be effective in YYYY-MM-DD format
+        sig { returns(Date) }
+        attr_accessor :effective_date
+
+        # Name of a tier contained in the credit product. Mutually exclusive with
+        # tier_rates
+        sig { returns(T.nilable(String)) }
+        attr_reader :tier_name
+
+        sig { params(tier_name: String).void }
+        attr_writer :tier_name
+
+        # Custom rates per category. Mutually exclusive with tier_name
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :tier_rates
+
+        sig { params(tier_rates: T.anything).void }
+        attr_writer :tier_rates
+
+        # Entry in the Tier Schedule of an account
+        sig do
+          params(
+            credit_product_token: String,
+            effective_date: Date,
+            tier_name: String,
+            tier_rates: T.anything
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Globally unique identifier for a credit product
+          credit_product_token:,
+          # Date the tier should be effective in YYYY-MM-DD format
+          effective_date:,
+          # Name of a tier contained in the credit product. Mutually exclusive with
+          # tier_rates
+          tier_name: nil,
+          # Custom rates per category. Mutually exclusive with tier_name
+          tier_rates: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              credit_product_token: String,
+              effective_date: Date,
+              tier_name: String,
+              tier_rates: T.anything
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/interest_tier_schedule_create_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class InterestTierScheduleCreateParams < Lithic::Models::FinancialAccounts::FinancialAccountsInterestTierSchedule
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::InterestTierScheduleCreateParams,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: Lithic::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig { override.returns({ request_options: Lithic::RequestOptions }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/interest_tier_schedule_delete_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class InterestTierScheduleDeleteParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::InterestTierScheduleDeleteParams,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :financial_account_token
+
+        sig do
+          params(
+            financial_account_token: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(financial_account_token:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              financial_account_token: String,
+              request_options: Lithic::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/interest_tier_schedule_list_params.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class InterestTierScheduleListParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::InterestTierScheduleListParams,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Return schedules with effective_date >= after_date (ISO format YYYY-MM-DD)
+        sig { returns(T.nilable(Date)) }
+        attr_reader :after_date
+
+        sig { params(after_date: Date).void }
+        attr_writer :after_date
+
+        # Return schedules with effective_date <= before_date (ISO format YYYY-MM-DD)
+        sig { returns(T.nilable(Date)) }
+        attr_reader :before_date
+
+        sig { params(before_date: Date).void }
+        attr_writer :before_date
+
+        # Return schedule with effective_date == for_date (ISO format YYYY-MM-DD)
+        sig { returns(T.nilable(Date)) }
+        attr_reader :for_date
+
+        sig { params(for_date: Date).void }
+        attr_writer :for_date
+
+        sig do
+          params(
+            after_date: Date,
+            before_date: Date,
+            for_date: Date,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Return schedules with effective_date >= after_date (ISO format YYYY-MM-DD)
+          after_date: nil,
+          # Return schedules with effective_date <= before_date (ISO format YYYY-MM-DD)
+          before_date: nil,
+          # Return schedule with effective_date == for_date (ISO format YYYY-MM-DD)
+          for_date: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              after_date: Date,
+              before_date: Date,
+              for_date: Date,
+              request_options: Lithic::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/interest_tier_schedule_retrieve_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class InterestTierScheduleRetrieveParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::InterestTierScheduleRetrieveParams,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :financial_account_token
+
+        sig do
+          params(
+            financial_account_token: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(financial_account_token:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              financial_account_token: String,
+              request_options: Lithic::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/interest_tier_schedule_update_params.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class InterestTierScheduleUpdateParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::InterestTierScheduleUpdateParams,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :financial_account_token
+
+        # Name of a tier contained in the credit product. Mutually exclusive with
+        # tier_rates
+        sig { returns(T.nilable(String)) }
+        attr_reader :tier_name
+
+        sig { params(tier_name: String).void }
+        attr_writer :tier_name
+
+        # Custom rates per category. Mutually exclusive with tier_name
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :tier_rates
+
+        sig { params(tier_rates: T.anything).void }
+        attr_writer :tier_rates
+
+        sig do
+          params(
+            financial_account_token: String,
+            tier_name: String,
+            tier_rates: T.anything,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          financial_account_token:,
+          # Name of a tier contained in the credit product. Mutually exclusive with
+          # tier_rates
+          tier_name: nil,
+          # Custom rates per category. Mutually exclusive with tier_name
+          tier_rates: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              financial_account_token: String,
+              tier_name: String,
+              tier_rates: T.anything,
+              request_options: Lithic::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -525,6 +525,11 @@ module Lithic
                   :DELINQUENT,
                   Lithic::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::Substatus::TaggedSymbol
                 )
+              INTEREST_AND_FEES_PAUSED =
+                T.let(
+                  :INTEREST_AND_FEES_PAUSED,
+                  Lithic::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::Substatus::TaggedSymbol
+                )
 
               sig do
                 override.returns(

data/rbi/lithic/models/financial_accounts/loan_tape_configuration.rbi

@@ -0,0 +1,99 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class FinancialAccountsLoanTapeConfiguration < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::FinancialAccountsLoanTapeConfiguration,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :financial_account_token
+
+        sig { returns(String) }
+        attr_accessor :instance_token
+
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :credit_product_token
+
+        sig { params(credit_product_token: String).void }
+        attr_writer :credit_product_token
+
+        # Configuration for building loan tapes
+        sig do
+          returns(
+            T.nilable(Lithic::FinancialAccounts::LoanTapeRebuildConfiguration)
+          )
+        end
+        attr_reader :loan_tape_rebuild_configuration
+
+        sig do
+          params(
+            loan_tape_rebuild_configuration:
+              Lithic::FinancialAccounts::LoanTapeRebuildConfiguration::OrHash
+          ).void
+        end
+        attr_writer :loan_tape_rebuild_configuration
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :tier_schedule_changed_at
+
+        sig { params(tier_schedule_changed_at: Time).void }
+        attr_writer :tier_schedule_changed_at
+
+        # Configuration for loan tapes
+        sig do
+          params(
+            created_at: Time,
+            financial_account_token: String,
+            instance_token: String,
+            updated_at: Time,
+            credit_product_token: String,
+            loan_tape_rebuild_configuration:
+              Lithic::FinancialAccounts::LoanTapeRebuildConfiguration::OrHash,
+            tier_schedule_changed_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          created_at:,
+          financial_account_token:,
+          instance_token:,
+          updated_at:,
+          credit_product_token: nil,
+          # Configuration for building loan tapes
+          loan_tape_rebuild_configuration: nil,
+          tier_schedule_changed_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              created_at: Time,
+              financial_account_token: String,
+              instance_token: String,
+              updated_at: Time,
+              credit_product_token: String,
+              loan_tape_rebuild_configuration:
+                Lithic::FinancialAccounts::LoanTapeRebuildConfiguration,
+              tier_schedule_changed_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/loan_tape_configuration_retrieve_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class LoanTapeConfigurationRetrieveParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::LoanTapeConfigurationRetrieveParams,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: Lithic::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig { override.returns({ request_options: Lithic::RequestOptions }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/loan_tape_rebuild_configuration.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class LoanTapeRebuildConfiguration < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::FinancialAccounts::LoanTapeRebuildConfiguration,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Whether the account's loan tapes need to be rebuilt or not
+        sig { returns(T::Boolean) }
+        attr_accessor :rebuild_needed
+
+        # The date for which the account's loan tapes were last rebuilt
+        sig { returns(T.nilable(Date)) }
+        attr_reader :last_rebuild
+
+        sig { params(last_rebuild: Date).void }
+        attr_writer :last_rebuild
+
+        # Date from which to start rebuilding from if the account requires a rebuild
+        sig { returns(T.nilable(Date)) }
+        attr_reader :rebuild_from
+
+        sig { params(rebuild_from: Date).void }
+        attr_writer :rebuild_from
+
+        # Configuration for building loan tapes
+        sig do
+          params(
+            rebuild_needed: T::Boolean,
+            last_rebuild: Date,
+            rebuild_from: Date
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether the account's loan tapes need to be rebuilt or not
+          rebuild_needed:,
+          # The date for which the account's loan tapes were last rebuilt
+          last_rebuild: nil,
+          # Date from which to start rebuilding from if the account requires a rebuild
+          rebuild_from: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              rebuild_needed: T::Boolean,
+              last_rebuild: Date,
+              rebuild_from: Date
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/financial_accounts/statement.rbi

@@ -520,6 +520,11 @@ module Lithic
                   :DELINQUENT,
                   Lithic::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Substatus::TaggedSymbol
                 )
+              INTEREST_AND_FEES_PAUSED =
+                T.let(
+                  :INTEREST_AND_FEES_PAUSED,
+                  Lithic::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Substatus::TaggedSymbol
+                )
 
               sig do
                 override.returns(

data/rbi/lithic/models/kyb.rbi

@@ -81,6 +81,14 @@ module Lithic
       sig { params(kyb_passed_timestamp: String).void }
       attr_writer :kyb_passed_timestamp
 
+      # 6-digit North American Industry Classification System (NAICS) code for the
+      # business.
+      sig { returns(T.nilable(String)) }
+      attr_reader :naics_code
+
+      sig { params(naics_code: String).void }
+      attr_writer :naics_code
+
       # Company website URL.
       sig { returns(T.nilable(String)) }
       attr_reader :website_url
@@ -101,6 +109,7 @@ module Lithic
             T::Array[Lithic::KYB::BeneficialOwnerEntity::OrHash],
           external_id: String,
           kyb_passed_timestamp: String,
+          naics_code: String,
           website_url: String
         ).returns(T.attached_class)
       end
@@ -143,6 +152,9 @@ module Lithic
         #
         # This field is required only if workflow type is `KYB_BYO`.
         kyb_passed_timestamp: nil,
+        # 6-digit North American Industry Classification System (NAICS) code for the
+        # business.
+        naics_code: nil,
         # Company website URL.
         website_url: nil
       )
@@ -162,6 +174,7 @@ module Lithic
               T::Array[Lithic::KYB::BeneficialOwnerEntity],
             external_id: String,
             kyb_passed_timestamp: String,
+            naics_code: String,
             website_url: String
           }
         )

data/rbi/lithic/models/parsed_webhook_event.rbi

@@ -121,6 +121,14 @@ module Lithic
         sig { params(external_id: String).void }
         attr_writer :external_id
 
+        # 6-digit North American Industry Classification System (NAICS) code for the
+        # business. Only present if naics_code was included in the update request.
+        sig { returns(T.nilable(String)) }
+        attr_reader :naics_code
+
+        sig { params(naics_code: String).void }
+        attr_writer :naics_code
+
         # Short description of the company's line of business (i.e., what does the company
         # do?).
         sig { returns(T.nilable(String)) }
@@ -145,6 +153,7 @@ module Lithic
             event_type:
               Lithic::ParsedWebhookEvent::KYBPayload::EventType::OrSymbol,
             external_id: String,
+            naics_code: String,
             nature_of_business: String,
             website_url: String
           ).returns(T.attached_class)
@@ -159,6 +168,9 @@ module Lithic
           # A user provided id that can be used to link an account holder with an external
           # system
           external_id: nil,
+          # 6-digit North American Industry Classification System (NAICS) code for the
+          # business. Only present if naics_code was included in the update request.
+          naics_code: nil,
           # Short description of the company's line of business (i.e., what does the company
           # do?).
           nature_of_business: nil,
@@ -176,6 +188,7 @@ module Lithic
               event_type:
                 Lithic::ParsedWebhookEvent::KYBPayload::EventType::TaggedSymbol,
               external_id: String,
+              naics_code: String,
               nature_of_business: String,
               website_url: String
             }