lithic 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.18

data/rbi/lib/lithic/models/financial_account.rbi

@@ -69,17 +69,21 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier for the account
         token:,
         account_token:,
         created:,
         credit_configuration:,
+        # Whether financial account is for the benefit of another entity
         is_for_benefit_of:,
         nickname:,
+        # Status of the financial account
         status:,
         type:,
         updated:,
         account_number: nil,
         routing_number: nil,
+        # Substatus for the financial account
         substatus: nil
       ); end
       sig do
@@ -146,12 +150,16 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Reason for the financial account being marked as Charged Off
           charged_off_reason:,
           credit_limit:,
+          # Globally unique identifier for the credit product
           credit_product_token:,
           external_bank_account_token:,
+          # State of the financial account
           financial_account_state:,
           is_spend_blocked:,
+          # Tier assigned to the financial account
           tier:
         ); end
         sig do

data/rbi/lib/lithic/models/financial_account_list_params.rbi

@@ -36,8 +36,15 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(account_token: nil, business_account_token: nil, type: nil, request_options: {}); end
-
+      def self.new(
+        # List financial accounts for a given account_token or business_account_token
+        account_token: nil,
+        # List financial accounts for a given business_account_token
+        business_account_token: nil,
+        # List financial accounts of a given type
+        type: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/financial_account_update_status_params.rbi

@@ -22,8 +22,13 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(status:, substatus:, request_options: {}); end
-
+      def self.new(
+        # Status of the financial account
+        status:,
+        # Substatus for the financial account
+        substatus:,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/financial_accounts/balance_list_params.rbi

@@ -31,8 +31,15 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(balance_date: nil, last_transaction_event_token: nil, request_options: {}); end
-
+        def self.new(
+          # UTC date of the balance to retrieve. Defaults to latest available balance
+          balance_date: nil,
+          # Balance after a given financial event occured. For example, passing the
+          # event_token of a $5 CARD_CLEARING financial event will return a balance
+          # decreased by $5
+          last_transaction_event_token: nil,
+          request_options: {}
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/financial_accounts/balance_list_response.rbi

@@ -65,15 +65,29 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Globally unique identifier for the financial account that holds this balance.
           token:,
+          # Funds available for spend in the currency's smallest unit (e.g., cents for USD)
           available_amount:,
+          # Date and time for when the balance was first created.
           created:,
+          # 3-character alphabetic ISO 4217 code for the local currency of the balance.
           currency:,
+          # Globally unique identifier for the last financial transaction event that
+          # impacted this balance.
           last_transaction_event_token:,
+          # Globally unique identifier for the last financial transaction that impacted this
+          # balance.
           last_transaction_token:,
+          # Funds not available for spend due to card authorizations or pending ACH release.
+          # Shown in the currency's smallest unit (e.g., cents for USD).
           pending_amount:,
+          # The sum of available and pending balance in the currency's smallest unit (e.g.,
+          # cents for USD).
           total_amount:,
+          # Type of financial account.
           type:,
+          # Date and time for when the balance was last updated.
           updated:
         ); end
         sig do

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

@@ -45,8 +45,10 @@ module Lithic
         end
         def self.new(
           credit_limit: nil,
+          # Globally unique identifier for the credit product
           credit_product_token: nil,
           external_bank_account_token: nil,
+          # Tier to assign to a financial account
           tier: nil,
           request_options: {}
         ); end

data/rbi/lib/lithic/models/financial_accounts/financial_account_credit_config.rbi

@@ -55,13 +55,18 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Globally unique identifier for the account
           account_token:,
+          # Reason for the financial account being marked as Charged Off
           charged_off_reason:,
           credit_limit:,
+          # Globally unique identifier for the credit product
           credit_product_token:,
           external_bank_account_token:,
+          # State of the financial account
           financial_account_state:,
           is_spend_blocked:,
+          # Tier assigned to the financial account
           tier:
         ); end
         sig do

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

@@ -77,12 +77,23 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Date string in RFC 3339 format. Only entries created after the specified time
+          # will be included. UTC time zone.
           begin_: nil,
+          # Financial Transaction category to be returned.
           category: nil,
+          # Date string in RFC 3339 format. Only entries created before the specified time
+          # will be included. UTC time zone.
           end_: nil,
+          # 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,
+          # Financial Transaction result to be returned.
           result: nil,
+          # 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.
           starting_after: nil,
+          # Financial Transaction status to be returned.
           status: nil,
           request_options: {}
         ); end

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

@@ -188,27 +188,44 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Globally unique identifier for a loan tape
           token:,
           account_standing:,
+          # Amount of credit available to spend in cents
           available_credit:,
           balances:,
+          # Timestamp of when the loan tape was created
           created:,
+          # For prepay accounts, this is the minimum prepay balance that must be maintained.
+          # For charge card accounts, this is the maximum credit balance extended by a
+          # lender
           credit_limit:,
+          # Globally unique identifier for a credit product
           credit_product_token:,
+          # Date of transactions that this loan tape covers
           date:,
           day_totals:,
+          # Balance at the end of the day
           ending_balance:,
+          # Excess credits in the form of provisional credits, payments, or purchase
+          # refunds. If positive, the account is in net credit state with no outstanding
+          # balances. An overpayment could land an account in this state
           excess_credits:,
+          # Globally unique identifier for a financial account
           financial_account_token:,
           interest_details:,
           minimum_payment_balance:,
           payment_allocation:,
           period_totals:,
           previous_statement_balance:,
+          # Balance at the start of the day
           starting_balance:,
+          # Timestamp of when the loan tape was updated
           updated:,
+          # Version number of the loan tape. This starts at 1
           version:,
           ytd_totals:,
+          # Interest tier to which this account belongs to
           tier: nil
         ); end
         sig do
@@ -302,12 +319,19 @@ module Lithic
               .returns(T.attached_class)
           end
           def self.new(
+            # Number of consecutive full payments made
             consecutive_full_payments_made:,
+            # Number of consecutive minimum payments made
             consecutive_minimum_payments_made:,
+            # Number of consecutive minimum payments missed
             consecutive_minimum_payments_missed:,
+            # Number of days past due
             days_past_due:,
+            # Information about the financial account state
             financial_account_state:,
+            # Whether the account currently has grace or not
             has_grace:,
+            # Current overall period number
             period_number:,
             period_state:
           ); end
@@ -357,8 +381,12 @@ module Lithic
               )
                 .returns(T.attached_class)
             end
-            def self.new(status:, substatus: nil); end
-
+            def self.new(
+              # Status of the financial account
+              status:,
+              # Substatus for the financial account
+              substatus: nil
+            ); end
             sig do
               override
                 .returns(
@@ -539,8 +567,19 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(due:, next_statement_due:, past_due:, past_statements_due:); end
-
+          def self.new(
+            # Amount due for the prior billing cycle. Any amounts not fully paid off on this
+            # due date will be considered past due the next day
+            due:,
+            # Amount due for the current billing cycle. Any amounts not paid off by early
+            # payments or credits will be considered due at the end of the current billing
+            # period
+            next_statement_due:,
+            # Amount not paid off on previous due dates
+            past_due:,
+            # Amount due for the past billing cycles.
+            past_statements_due:
+          ); end
           sig do
             override
               .returns(
@@ -672,9 +711,23 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(balance_transfers:, cash_advances:, credits:, fees:, interest:, payments:, purchases:)
-          end
-
+          def self.new(
+            # Opening balance transferred from previous account in cents
+            balance_transfers:,
+            # ATM and cashback transactions in cents
+            cash_advances:,
+            # Volume of credit management operation transactions less any balance transfers in
+            # cents
+            credits:,
+            # Volume of debit management operation transactions less any interest in cents
+            fees:,
+            # Interest accrued in cents
+            interest:,
+            # Any funds transfers which affective the balance in cents
+            payments:,
+            # Net card transaction volume less any cash advances in cents
+            purchases:
+          ); end
           sig do
             override
               .returns(
@@ -967,9 +1020,23 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(balance_transfers:, cash_advances:, credits:, fees:, interest:, payments:, purchases:)
-          end
-
+          def self.new(
+            # Opening balance transferred from previous account in cents
+            balance_transfers:,
+            # ATM and cashback transactions in cents
+            cash_advances:,
+            # Volume of credit management operation transactions less any balance transfers in
+            # cents
+            credits:,
+            # Volume of debit management operation transactions less any interest in cents
+            fees:,
+            # Interest accrued in cents
+            interest:,
+            # Any funds transfers which affective the balance in cents
+            payments:,
+            # Net card transaction volume less any cash advances in cents
+            purchases:
+          ); end
           sig do
             override
               .returns(
@@ -1043,9 +1110,23 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(balance_transfers:, cash_advances:, credits:, fees:, interest:, payments:, purchases:)
-          end
-
+          def self.new(
+            # Opening balance transferred from previous account in cents
+            balance_transfers:,
+            # ATM and cashback transactions in cents
+            cash_advances:,
+            # Volume of credit management operation transactions less any balance transfers in
+            # cents
+            credits:,
+            # Volume of debit management operation transactions less any interest in cents
+            fees:,
+            # Interest accrued in cents
+            interest:,
+            # Any funds transfers which affective the balance in cents
+            payments:,
+            # Net card transaction volume less any cash advances in cents
+            purchases:
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/financial_accounts/loan_tape_list_params.rbi

@@ -58,15 +58,22 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Date string in RFC 3339 format. Only entries created after the specified date
+          # will be included.
           begin_: nil,
+          # Date string in RFC 3339 format. Only entries created before the specified date
+          # will be included.
           end_: nil,
+          # 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,
+          # 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.
           starting_after: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rbi

@@ -18,8 +18,11 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(financial_account_token:, request_options: {}); end
-
+        def self.new(
+          # Globally unique identifier for financial account.
+          financial_account_token:,
+          request_options: {}
+        ); end
         sig { override.returns({financial_account_token: String, request_options: Lithic::RequestOptions}) }
         def to_hash; end
       end

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

@@ -156,26 +156,42 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Globally unique identifier for a statement
           token:,
           account_standing:,
           amount_due:,
+          # Amount of credit available to spend in cents
           available_credit:,
+          # Timestamp of when the statement was created
           created:,
+          # This is the maximum credit balance extended by the lender in cents
           credit_limit:,
+          # Globally unique identifier for a credit product
           credit_product_token:,
+          # Number of days in the billing cycle
           days_in_billing_cycle:,
+          # Balance at the end of the billing period. For charge cards, this should be the
+          # same at the statement amount due in cents
           ending_balance:,
+          # Globally unique identifier for a financial account
           financial_account_token:,
+          # Date when the payment is due
           payment_due_date:,
           period_totals:,
+          # Balance at the start of the billing period
           starting_balance:,
+          # Date when the billing period ended
           statement_end_date:,
+          # Date when the billing period began
           statement_start_date:,
           statement_type:,
+          # Timestamp of when the statement was updated
           updated:,
           ytd_totals:,
           interest_details: nil,
+          # Date when the next payment is due
           next_payment_due_date: nil,
+          # Date when the next billing period will end
           next_statement_end_date: nil
         ); end
         sig do
@@ -268,12 +284,19 @@ module Lithic
               .returns(T.attached_class)
           end
           def self.new(
+            # Number of consecutive full payments made
             consecutive_full_payments_made:,
+            # Number of consecutive minimum payments made
             consecutive_minimum_payments_made:,
+            # Number of consecutive minimum payments missed
             consecutive_minimum_payments_missed:,
+            # Number of days past due
             days_past_due:,
+            # Information about the financial account state
             financial_account_state:,
+            # Whether the account currently has grace or not
             has_grace:,
+            # Current overall period number
             period_number:,
             period_state:
           ); end
@@ -323,8 +346,12 @@ module Lithic
               )
                 .returns(T.attached_class)
             end
-            def self.new(status:, substatus: nil); end
-
+            def self.new(
+              # Status of the financial account
+              status:,
+              # Substatus for the financial account
+              substatus: nil
+            ); end
             sig do
               override
                 .returns(
@@ -463,8 +490,15 @@ module Lithic
           attr_accessor :past_due
 
           sig { params(amount: Integer, past_due: Integer).returns(T.attached_class) }
-          def self.new(amount:, past_due:); end
-
+          def self.new(
+            # Payment due at the end of the billing period in cents. Negative amount indicates
+            # something is owed. If the amount owed is positive there was a net credit. If
+            # auto-collections are enabled this is the amount that will be requested on the
+            # payment due date
+            amount:,
+            # Amount past due for statement in cents
+            past_due:
+          ); end
           sig { override.returns({amount: Integer, past_due: Integer}) }
           def to_hash; end
         end
@@ -511,9 +545,23 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(balance_transfers:, cash_advances:, credits:, fees:, interest:, payments:, purchases:)
-          end
-
+          def self.new(
+            # Opening balance transferred from previous account in cents
+            balance_transfers:,
+            # ATM and cashback transactions in cents
+            cash_advances:,
+            # Volume of credit management operation transactions less any balance transfers in
+            # cents
+            credits:,
+            # Volume of debit management operation transactions less any interest in cents
+            fees:,
+            # Interest accrued in cents
+            interest:,
+            # Any funds transfers which affective the balance in cents
+            payments:,
+            # Net card transaction volume less any cash advances in cents
+            purchases:
+          ); end
           sig do
             override
               .returns(
@@ -589,9 +637,23 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(balance_transfers:, cash_advances:, credits:, fees:, interest:, payments:, purchases:)
-          end
-
+          def self.new(
+            # Opening balance transferred from previous account in cents
+            balance_transfers:,
+            # ATM and cashback transactions in cents
+            cash_advances:,
+            # Volume of credit management operation transactions less any balance transfers in
+            # cents
+            credits:,
+            # Volume of debit management operation transactions less any interest in cents
+            fees:,
+            # Interest accrued in cents
+            interest:,
+            # Any funds transfers which affective the balance in cents
+            payments:,
+            # Net card transaction volume less any cash advances in cents
+            purchases:
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/financial_accounts/statement_list_params.rbi

@@ -66,11 +66,21 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Date string in RFC 3339 format. Only entries created after the specified date
+          # will be included.
           begin_: nil,
+          # Date string in RFC 3339 format. Only entries created before the specified date
+          # will be included.
           end_: nil,
+          # 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,
+          # Whether to include the initial statement. It is not included by default.
           include_initial_statements: nil,
+          # Page size (for pagination).
           page_size: nil,
+          # 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.
           starting_after: nil,
           request_options: {}
         ); end

data/rbi/lib/lithic/models/financial_accounts/statement_retrieve_params.rbi

@@ -18,8 +18,11 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(financial_account_token:, request_options: {}); end
-
+        def self.new(
+          # Globally unique identifier for financial account.
+          financial_account_token:,
+          request_options: {}
+        ); end
         sig { override.returns({financial_account_token: String, request_options: Lithic::RequestOptions}) }
         def to_hash; end
       end

data/rbi/lib/lithic/models/financial_accounts/statements/line_item_list_params.rbi

@@ -46,14 +46,18 @@ module Lithic
               .returns(T.attached_class)
           end
           def self.new(
+            # Globally unique identifier for financial account.
             financial_account_token:,
+            # 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,
+            # 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.
             starting_after: nil,
             request_options: {}
-          )
-          end
-
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/financial_accounts/statements/statement_line_items.rbi

@@ -102,16 +102,26 @@ module Lithic
                 .returns(T.attached_class)
             end
             def self.new(
+              # Globally unique identifier for a Statement Line Item
               token:,
+              # Transaction amount in cents
               amount:,
               category:,
+              # Timestamp of when the line item was generated
               created:,
+              # 3-character alphabetic ISO 4217 code for the settling currency of the
+              # transaction
               currency:,
+              # Date that the transaction effected the account balance
               effective_date:,
               event_type:,
+              # Globally unique identifier for a financial account
               financial_account_token:,
+              # Globally unique identifier for a financial transaction event
               financial_transaction_event_token:,
+              # Globally unique identifier for a financial transaction
               financial_transaction_token:,
+              # Globally unique identifier for a card
               card_token: nil,
               descriptor: nil
             ); end