lithic 0.21.0 → 0.23.0

data/rbi/lithic/models/claim_created_webhook_event.rbi

@@ -52,6 +52,13 @@ module Lithic
       sig { returns(Lithic::ClaimCreatedWebhookEvent::Reason::TaggedSymbol) }
       attr_accessor :reason
 
+      # Identifier for the claim as displayed in the Lithic dashboard. Populated
+      # depending on your program's setup, null otherwise. Use it to match claims
+      # received through the API and webhooks to the dashboard. This is not the claim
+      # `token`, which is the identifier to use in API requests
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reference_id
+
       # Current lifecycle status of the claim
       sig { returns(Lithic::ClaimCreatedWebhookEvent::Status::TaggedSymbol) }
       attr_accessor :status
@@ -80,6 +87,7 @@ module Lithic
               Lithic::ClaimCreatedWebhookEvent::OutstandingRequirement::OrSymbol
             ],
           reason: Lithic::ClaimCreatedWebhookEvent::Reason::OrSymbol,
+          reference_id: T.nilable(String),
           status: Lithic::ClaimCreatedWebhookEvent::Status::OrSymbol,
           submitted: T.nilable(Time),
           updated: Time,
@@ -103,6 +111,11 @@ module Lithic
         outstanding_requirements:,
         # Dispute reason code provided when creating the claim
         reason:,
+        # Identifier for the claim as displayed in the Lithic dashboard. Populated
+        # depending on your program's setup, null otherwise. Use it to match claims
+        # received through the API and webhooks to the dashboard. This is not the claim
+        # `token`, which is the identifier to use in API requests
+        reference_id:,
         # Current lifecycle status of the claim
         status:,
         # When the claim was submitted. Null until the claim reaches `SUBMITTED` status
@@ -130,6 +143,7 @@ module Lithic
                 Lithic::ClaimCreatedWebhookEvent::OutstandingRequirement::TaggedSymbol
               ],
             reason: Lithic::ClaimCreatedWebhookEvent::Reason::TaggedSymbol,
+            reference_id: T.nilable(String),
             status: Lithic::ClaimCreatedWebhookEvent::Status::TaggedSymbol,
             submitted: T.nilable(Time),
             updated: Time

data/rbi/lithic/models/claim_updated_webhook_event.rbi

@@ -52,6 +52,13 @@ module Lithic
       sig { returns(Lithic::ClaimUpdatedWebhookEvent::Reason::TaggedSymbol) }
       attr_accessor :reason
 
+      # Identifier for the claim as displayed in the Lithic dashboard. Populated
+      # depending on your program's setup, null otherwise. Use it to match claims
+      # received through the API and webhooks to the dashboard. This is not the claim
+      # `token`, which is the identifier to use in API requests
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reference_id
+
       # Current lifecycle status of the claim
       sig { returns(Lithic::ClaimUpdatedWebhookEvent::Status::TaggedSymbol) }
       attr_accessor :status
@@ -80,6 +87,7 @@ module Lithic
               Lithic::ClaimUpdatedWebhookEvent::OutstandingRequirement::OrSymbol
             ],
           reason: Lithic::ClaimUpdatedWebhookEvent::Reason::OrSymbol,
+          reference_id: T.nilable(String),
           status: Lithic::ClaimUpdatedWebhookEvent::Status::OrSymbol,
           submitted: T.nilable(Time),
           updated: Time,
@@ -103,6 +111,11 @@ module Lithic
         outstanding_requirements:,
         # Dispute reason code provided when creating the claim
         reason:,
+        # Identifier for the claim as displayed in the Lithic dashboard. Populated
+        # depending on your program's setup, null otherwise. Use it to match claims
+        # received through the API and webhooks to the dashboard. This is not the claim
+        # `token`, which is the identifier to use in API requests
+        reference_id:,
         # Current lifecycle status of the claim
         status:,
         # When the claim was submitted. Null until the claim reaches `SUBMITTED` status
@@ -130,6 +143,7 @@ module Lithic
                 Lithic::ClaimUpdatedWebhookEvent::OutstandingRequirement::TaggedSymbol
               ],
             reason: Lithic::ClaimUpdatedWebhookEvent::Reason::TaggedSymbol,
+            reference_id: T.nilable(String),
             status: Lithic::ClaimUpdatedWebhookEvent::Status::TaggedSymbol,
             submitted: T.nilable(Time),
             updated: Time

data/rbi/lithic/models/financial_account_balance.rbi

@@ -26,12 +26,12 @@ module Lithic
 
       # Globally unique identifier for the last financial transaction event that
       # impacted this balance.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :last_transaction_event_token
 
       # Globally unique identifier for the last financial transaction that impacted this
       # balance.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :last_transaction_token
 
       # Funds not available for spend due to card authorizations or pending ACH release.
@@ -59,8 +59,8 @@ module Lithic
           available_amount: Integer,
           created: Time,
           currency: String,
-          last_transaction_event_token: String,
-          last_transaction_token: String,
+          last_transaction_event_token: T.nilable(String),
+          last_transaction_token: T.nilable(String),
           pending_amount: Integer,
           total_amount: Integer,
           type: Lithic::FinancialAccountBalance::Type::OrSymbol,
@@ -102,8 +102,8 @@ module Lithic
             available_amount: Integer,
             created: Time,
             currency: String,
-            last_transaction_event_token: String,
-            last_transaction_token: String,
+            last_transaction_event_token: T.nilable(String),
+            last_transaction_token: T.nilable(String),
             pending_amount: Integer,
             total_amount: Integer,
             type: Lithic::FinancialAccountBalance::Type::TaggedSymbol,

data/rbi/lithic/models/financial_accounts/credit_configuration_update_params.rbi

@@ -41,7 +41,10 @@ module Lithic
         sig { params(credit_limit: Integer).void }
         attr_writer :credit_limit
 
-        # Globally unique identifier for the credit product
+        # Globally unique identifier for the credit product. This can only be set while
+        # the financial account is in the `PENDING` state. Because assigning a credit
+        # product transitions the account to `OPEN`, a credit product can be attached only
+        # once; updating it on an account in any other state returns a `403`
         sig { returns(T.nilable(String)) }
         attr_reader :credit_product_token
 
@@ -77,7 +80,10 @@ module Lithic
           financial_account_token:,
           auto_collection_configuration: nil,
           credit_limit: nil,
-          # Globally unique identifier for the credit product
+          # Globally unique identifier for the credit product. This can only be set while
+          # the financial account is in the `PENDING` state. Because assigning a credit
+          # product transitions the account to `OPEN`, a credit product can be attached only
+          # once; updating it on an account in any other state returns a `403`
           credit_product_token: nil,
           external_bank_account_token: nil,
           # Tier to assign to a financial account

data/rbi/lithic/models/financial_accounts/financial_transaction_list_params.rbi

@@ -60,6 +60,13 @@ module Lithic
         sig { params(ending_before: String).void }
         attr_writer :ending_before
 
+        # Page size (for pagination).
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
         # Financial Transaction result to be returned.
         sig do
           returns(
@@ -112,6 +119,7 @@ module Lithic
               Lithic::FinancialAccounts::FinancialTransactionListParams::Category::OrSymbol,
             end_: Time,
             ending_before: String,
+            page_size: Integer,
             result:
               Lithic::FinancialAccounts::FinancialTransactionListParams::Result::OrSymbol,
             starting_after: String,
@@ -133,6 +141,8 @@ module Lithic
           # 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.
           ending_before: nil,
+          # Page size (for pagination).
+          page_size: nil,
           # Financial Transaction result to be returned.
           result: nil,
           # A cursor representing an item's token after which a page of results should
@@ -153,6 +163,7 @@ module Lithic
                 Lithic::FinancialAccounts::FinancialTransactionListParams::Category::OrSymbol,
               end_: Time,
               ending_before: String,
+              page_size: Integer,
               result:
                 Lithic::FinancialAccounts::FinancialTransactionListParams::Result::OrSymbol,
               starting_after: String,

data/rbi/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rbi

@@ -0,0 +1,452 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      InstallmentPlanStatement = InstallmentPlans::InstallmentPlanStatement
+
+      module InstallmentPlans
+        class InstallmentPlanStatement < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # Globally unique identifier for this snapshot, which is the token of the
+          # statement it is attached to. A plan is snapshotted at most once per statement,
+          # so the statement identifies the snapshot within the plan. Pass it as a
+          # pagination cursor
+          sig { returns(String) }
+          attr_accessor :token
+
+          # Enrollment fee charged when the plan was created in cents
+          sig { returns(Integer) }
+          attr_accessor :fee_amount
+
+          # Globally unique identifier for the installment plan this snapshot is of
+          sig { returns(String) }
+          attr_accessor :installment_plan_token
+
+          # Total owed on the plan in cents, the principal amount plus the enrollment fee
+          sig { returns(Integer) }
+          attr_accessor :installment_plan_total
+
+          # Installments that make up the plan, oldest first
+          sig do
+            returns(
+              T::Array[
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment
+              ]
+            )
+          end
+          attr_accessor :installments
+
+          # Number of installments that still carried a balance as of this statement
+          sig { returns(Integer) }
+          attr_accessor :installments_outstanding
+
+          # Number of installments that had been paid off as of this statement
+          sig { returns(Integer) }
+          attr_accessor :installments_paid
+
+          # Number of installments the plan is broken into
+          sig { returns(Integer) }
+          attr_accessor :num_installments
+
+          # Balance the plan was opened on in cents, excluding the enrollment fee
+          sig { returns(Integer) }
+          attr_accessor :principal_amount
+
+          sig do
+            returns(
+              Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType::TaggedSymbol
+            )
+          end
+          attr_accessor :source_type
+
+          # Date the plan was created
+          sig { returns(Date) }
+          attr_accessor :start_date
+
+          # State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan
+          # tapes are being rebuilt, during which its payment totals are being recomputed
+          # and should not be treated as final
+          sig do
+            returns(
+              Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State::TaggedSymbol
+            )
+          end
+          attr_accessor :state
+
+          # Amount paid towards the plan as of this statement in cents
+          sig { returns(Integer) }
+          attr_accessor :total_paid
+
+          # An immutable snapshot of an installment plan as of the statement it is attached
+          # to. Lithic cuts one per open plan when a statement is generated and never
+          # reissues it
+          sig do
+            params(
+              token: String,
+              fee_amount: Integer,
+              installment_plan_token: String,
+              installment_plan_total: Integer,
+              installments:
+                T::Array[
+                  Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::OrHash
+                ],
+              installments_outstanding: Integer,
+              installments_paid: Integer,
+              num_installments: Integer,
+              principal_amount: Integer,
+              source_type:
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType::OrSymbol,
+              start_date: Date,
+              state:
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State::OrSymbol,
+              total_paid: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Globally unique identifier for this snapshot, which is the token of the
+            # statement it is attached to. A plan is snapshotted at most once per statement,
+            # so the statement identifies the snapshot within the plan. Pass it as a
+            # pagination cursor
+            token:,
+            # Enrollment fee charged when the plan was created in cents
+            fee_amount:,
+            # Globally unique identifier for the installment plan this snapshot is of
+            installment_plan_token:,
+            # Total owed on the plan in cents, the principal amount plus the enrollment fee
+            installment_plan_total:,
+            # Installments that make up the plan, oldest first
+            installments:,
+            # Number of installments that still carried a balance as of this statement
+            installments_outstanding:,
+            # Number of installments that had been paid off as of this statement
+            installments_paid:,
+            # Number of installments the plan is broken into
+            num_installments:,
+            # Balance the plan was opened on in cents, excluding the enrollment fee
+            principal_amount:,
+            source_type:,
+            # Date the plan was created
+            start_date:,
+            # State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan
+            # tapes are being rebuilt, during which its payment totals are being recomputed
+            # and should not be treated as final
+            state:,
+            # Amount paid towards the plan as of this statement in cents
+            total_paid:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                token: String,
+                fee_amount: Integer,
+                installment_plan_token: String,
+                installment_plan_total: Integer,
+                installments:
+                  T::Array[
+                    Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment
+                  ],
+                installments_outstanding: Integer,
+                installments_paid: Integer,
+                num_installments: Integer,
+                principal_amount: Integer,
+                source_type:
+                  Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType::TaggedSymbol,
+                start_date: Date,
+                state:
+                  Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State::TaggedSymbol,
+                total_paid: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Installment < Lithic::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment,
+                  Lithic::Internal::AnyHash
+                )
+              end
+
+            # Amount the installment was opened for in cents
+            sig { returns(Integer) }
+            attr_accessor :amount_due
+
+            sig { returns(Lithic::FinancialAccounts::CategoryBalances) }
+            attr_reader :amount_due_details
+
+            sig do
+              params(
+                amount_due_details:
+                  Lithic::FinancialAccounts::CategoryBalances::OrHash
+              ).void
+            end
+            attr_writer :amount_due_details
+
+            # Amount still owed on the installment in cents
+            sig { returns(Integer) }
+            attr_accessor :amount_outstanding
+
+            sig { returns(Lithic::FinancialAccounts::CategoryBalances) }
+            attr_reader :amount_outstanding_details
+
+            sig do
+              params(
+                amount_outstanding_details:
+                  Lithic::FinancialAccounts::CategoryBalances::OrHash
+              ).void
+            end
+            attr_writer :amount_outstanding_details
+
+            # Amount paid towards the installment in cents
+            sig { returns(Integer) }
+            attr_accessor :amount_paid
+
+            sig { returns(Lithic::FinancialAccounts::CategoryBalances) }
+            attr_reader :amount_paid_details
+
+            sig do
+              params(
+                amount_paid_details:
+                  Lithic::FinancialAccounts::CategoryBalances::OrHash
+              ).void
+            end
+            attr_writer :amount_paid_details
+
+            # Date the installment was actually assessed onto the account, or null if it had
+            # not been assessed as of this statement
+            sig { returns(T.nilable(Date)) }
+            attr_accessor :date_assessed
+
+            # Date the installment is scheduled to be assessed onto the account
+            sig { returns(Date) }
+            attr_accessor :due_date
+
+            # Position of this installment within the plan, starting at 0
+            sig { returns(Integer) }
+            attr_accessor :installment_num
+
+            # Date the installment must be paid by before it is considered past due
+            sig { returns(Date) }
+            attr_accessor :payment_due_date
+
+            # Payments applied to this installment, oldest first
+            sig do
+              returns(
+                T::Array[
+                  Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment
+                ]
+              )
+            end
+            attr_accessor :payments
+
+            # One installment of a plan as of the statement. Amounts are totalled across
+            # transaction categories rather than broken out by them, which the installment
+            # plan endpoint does
+            sig do
+              params(
+                amount_due: Integer,
+                amount_due_details:
+                  Lithic::FinancialAccounts::CategoryBalances::OrHash,
+                amount_outstanding: Integer,
+                amount_outstanding_details:
+                  Lithic::FinancialAccounts::CategoryBalances::OrHash,
+                amount_paid: Integer,
+                amount_paid_details:
+                  Lithic::FinancialAccounts::CategoryBalances::OrHash,
+                date_assessed: T.nilable(Date),
+                due_date: Date,
+                installment_num: Integer,
+                payment_due_date: Date,
+                payments:
+                  T::Array[
+                    Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment::OrHash
+                  ]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Amount the installment was opened for in cents
+              amount_due:,
+              amount_due_details:,
+              # Amount still owed on the installment in cents
+              amount_outstanding:,
+              amount_outstanding_details:,
+              # Amount paid towards the installment in cents
+              amount_paid:,
+              amount_paid_details:,
+              # Date the installment was actually assessed onto the account, or null if it had
+              # not been assessed as of this statement
+              date_assessed:,
+              # Date the installment is scheduled to be assessed onto the account
+              due_date:,
+              # Position of this installment within the plan, starting at 0
+              installment_num:,
+              # Date the installment must be paid by before it is considered past due
+              payment_due_date:,
+              # Payments applied to this installment, oldest first
+              payments:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  amount_due: Integer,
+                  amount_due_details:
+                    Lithic::FinancialAccounts::CategoryBalances,
+                  amount_outstanding: Integer,
+                  amount_outstanding_details:
+                    Lithic::FinancialAccounts::CategoryBalances,
+                  amount_paid: Integer,
+                  amount_paid_details:
+                    Lithic::FinancialAccounts::CategoryBalances,
+                  date_assessed: T.nilable(Date),
+                  due_date: Date,
+                  installment_num: Integer,
+                  payment_due_date: Date,
+                  payments:
+                    T::Array[
+                      Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment
+                    ]
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Payment < Lithic::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment,
+                    Lithic::Internal::AnyHash
+                  )
+                end
+
+              # Amount applied to the installment in cents
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # Date the payment was applied to the installment
+              sig { returns(Date) }
+              attr_accessor :date
+
+              sig do
+                params(amount: Integer, date: Date).returns(T.attached_class)
+              end
+              def self.new(
+                # Amount applied to the installment in cents
+                amount:,
+                # Date the payment was applied to the installment
+                date:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, date: Date }) }
+              def to_hash
+              end
+            end
+          end
+
+          module SourceType
+            extend Lithic::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            UNPAID_BALANCE =
+              T.let(
+                :UNPAID_BALANCE,
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType::TaggedSymbol
+              )
+            TRANSACTION =
+              T.let(
+                :TRANSACTION,
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan
+          # tapes are being rebuilt, during which its payment totals are being recomputed
+          # and should not be treated as final
+          module State
+            extend Lithic::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PENDING =
+              T.let(
+                :PENDING,
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State::TaggedSymbol
+              )
+            ACTIVE =
+              T.let(
+                :ACTIVE,
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State::TaggedSymbol
+              )
+            REBUILD_IN_PROGRESS =
+              T.let(
+                :REBUILD_IN_PROGRESS,
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State::TaggedSymbol
+              )
+            FULLY_PAID =
+              T.let(
+                :FULLY_PAID,
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State::TaggedSymbol
+              )
+            CANCELLED =
+              T.let(
+                :CANCELLED,
+                Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end