lithic 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

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

data/rbi/lib/lithic/models/financial_transaction.rbi

@@ -84,16 +84,47 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier.
         token:,
+        # Status types:
+        #
+        # - `CARD` - Issuing card transaction.
+        # - `ACH` - Transaction over ACH.
+        # - `INTERNAL` - Transaction for internal adjustment.
+        # - `TRANSFER` - Internal transfer of funds between financial accounts in your
+        #   program.
         category:,
+        # Date and time when the financial transaction first occurred. UTC time zone.
         created:,
+        # 3-character alphabetic ISO 4217 code for the settling currency of the
+        # transaction.
         currency:,
+        # A string that provides a description of the financial transaction; may be useful
+        # to display to users.
         descriptor:,
+        # A list of all financial events that have modified this financial transaction.
         events:,
+        # Pending amount of the transaction in the currency's smallest unit (e.g., cents),
+        # including any acquirer fees. The value of this field will go to zero over time
+        # once the financial transaction is settled.
         pending_amount:,
+        # APPROVED transactions were successful while DECLINED transactions were declined
+        # by user, Lithic, or the network.
         result:,
+        # Amount of the transaction that has been settled in the currency's smallest unit
+        # (e.g., cents), including any acquirer fees. This may change over time.
         settled_amount:,
+        # Status types:
+        #
+        # - `DECLINED` - The transaction was declined.
+        # - `EXPIRED` - The authorization as it has passed its expiration time. Card
+        #   transaction only.
+        # - `PENDING` - The transaction is expected to settle.
+        # - `RETURNED` - The transaction has been returned.
+        # - `SETTLED` - The transaction is completed.
+        # - `VOIDED` - The transaction was voided. Card transaction only.
         status:,
+        # Date and time when the financial transaction was last updated. UTC time zone.
         updated:
       ); end
       sig do
@@ -185,8 +216,19 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(token: nil, amount: nil, created: nil, result: nil, type: nil); end
-
+        def self.new(
+          # Globally unique identifier.
+          token: nil,
+          # Amount of the financial event that has been settled in the currency's smallest
+          # unit (e.g., cents).
+          amount: nil,
+          # Date and time when the financial event occurred. UTC time zone.
+          created: nil,
+          # APPROVED financial events were successful while DECLINED financial events were
+          # declined by user, Lithic, or the network.
+          result: nil,
+          type: nil
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/kyb.rbi

@@ -102,15 +102,45 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # You must submit a list of all direct and indirect individuals with 25% or more
+        # ownership in the company. A maximum of 4 beneficial owners can be submitted. If
+        # no individual owns 25% of the company you do not need to send beneficial owner
+        # information. See
+        # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+        # (Section I) for more background on individuals that should be included.
         beneficial_owner_individuals:,
+        # Information for business for which the account is being opened and KYB is being
+        # run.
         business_entity:,
+        # An individual with significant responsibility for managing the legal entity
+        # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
+        # Officer, Managing Member, General Partner, President, Vice President, or
+        # Treasurer). This can be an executive, or someone who will have program-wide
+        # access to the cards that Lithic will provide. In some cases, this individual
+        # could also be a beneficial owner listed above. See
+        # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+        # (Section II) for more background.
         control_person:,
+        # Short description of the company's line of business (i.e., what does the company
+        # do?).
         nature_of_business:,
+        # An RFC 3339 timestamp indicating when the account holder accepted the applicable
+        # legal agreements (e.g., cardholder terms) as agreed upon during API customer's
+        # implementation with Lithic.
         tos_timestamp:,
+        # Specifies the type of KYB workflow to run.
         workflow:,
+        # Deprecated.
         beneficial_owner_entities: nil,
+        # A user provided id that can be used to link an account holder with an external
+        # system
         external_id: nil,
+        # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+        # business with a pass result.
+        #
+        # This field is required only if workflow type is `KYB_BYO`.
         kyb_passed_timestamp: nil,
+        # Company website URL.
         website_url: nil
       ); end
       sig do
@@ -185,8 +215,27 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil); end
-
+        def self.new(
+          # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          address:,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob:,
+          # Individual's email address. If utilizing Lithic for chargeback processing, this
+          # customer email address may be used to communicate dispute status and resolution.
+          email:,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name:,
+          # Government-issued identification number (required for identity verification and
+          # compliance with banking regulations). Social Security Numbers (SSN) and
+          # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+          # entered as full nine-digits, with or without hyphens
+          government_id:,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name:,
+          # Individual's phone number, entered in E.164 format.
+          phone_number: nil
+        ); end
         sig do
           override
             .returns(
@@ -257,11 +306,22 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable.
           address:,
+          # Government-issued identification number. US Federal Employer Identification
+          # Numbers (EIN) are currently supported, entered as full nine-digits, with or
+          # without hyphens.
           government_id:,
+          # Legal (formal) business name.
           legal_business_name:,
+          # One or more of the business's phone number(s), entered as a list in E.164
+          # format.
           phone_numbers:,
+          # Any name that the business operates under that is not its legal business name
+          # (if applicable).
           dba_business_name: nil,
+          # Parent company name (if applicable).
           parent_company: nil
         ); end
         sig do
@@ -340,8 +400,27 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil); end
-
+        def self.new(
+          # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          address:,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob:,
+          # Individual's email address. If utilizing Lithic for chargeback processing, this
+          # customer email address may be used to communicate dispute status and resolution.
+          email:,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name:,
+          # Government-issued identification number (required for identity verification and
+          # compliance with banking regulations). Social Security Numbers (SSN) and
+          # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+          # entered as full nine-digits, with or without hyphens
+          government_id:,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name:,
+          # Individual's phone number, entered in E.164 format.
+          phone_number: nil
+        ); end
         sig do
           override
             .returns(
@@ -424,11 +503,22 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable.
           address:,
+          # Government-issued identification number. US Federal Employer Identification
+          # Numbers (EIN) are currently supported, entered as full nine-digits, with or
+          # without hyphens.
           government_id:,
+          # Legal (formal) business name.
           legal_business_name:,
+          # One or more of the business's phone number(s), entered as a list in E.164
+          # format.
           phone_numbers:,
+          # Any name that the business operates under that is not its legal business name
+          # (if applicable).
           dba_business_name: nil,
+          # Parent company name (if applicable).
           parent_company: nil
         ); end
         sig do

data/rbi/lib/lithic/models/kyb_business_entity.rbi

@@ -53,11 +53,22 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
+        # acceptable; APO/FPO are acceptable.
         address:,
+        # Government-issued identification number. US Federal Employer Identification
+        # Numbers (EIN) are currently supported, entered as full nine-digits, with or
+        # without hyphens.
         government_id:,
+        # Legal (formal) business name.
         legal_business_name:,
+        # One or more of the business's phone number(s), entered as a list in E.164
+        # format.
         phone_numbers:,
+        # Any name that the business operates under that is not its legal business name
+        # (if applicable).
         dba_business_name: nil,
+        # Parent company name (if applicable).
         parent_company: nil
       ); end
       sig do
@@ -119,8 +130,23 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
-
+        def self.new(
+          # Valid deliverable address (no PO boxes).
+          address1:,
+          # Name of city.
+          city:,
+          # Valid country code. Only USA is currently supported, entered in uppercase ISO
+          # 3166-1 alpha-3 three-character format.
+          country:,
+          # Valid postal code. Only USA ZIP codes are currently supported, entered as a
+          # five-digit ZIP or nine-digit ZIP+4.
+          postal_code:,
+          # Valid state code. Only USA state codes are currently supported, entered in
+          # uppercase ISO 3166-2 two-character format.
+          state:,
+          # Unit or apartment number (if applicable).
+          address2: nil
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/kyc.rbi

@@ -49,8 +49,25 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(individual:, tos_timestamp:, workflow:, external_id: nil, kyc_passed_timestamp: nil); end
-
+      def self.new(
+        # Information on individual for whom the account is being opened and KYC is being
+        # run.
+        individual:,
+        # An RFC 3339 timestamp indicating when the account holder accepted the applicable
+        # legal agreements (e.g., cardholder terms) as agreed upon during API customer's
+        # implementation with Lithic.
+        tos_timestamp:,
+        # Specifies the type of KYC workflow to run.
+        workflow:,
+        # A user provided id that can be used to link an account holder with an external
+        # system
+        external_id: nil,
+        # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+        # individual with a pass result.
+        #
+        # This field is required only if workflow type is `KYC_BYO`.
+        kyc_passed_timestamp: nil
+      ); end
       sig do
         override
           .returns(
@@ -116,8 +133,27 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:); end
-
+        def self.new(
+          # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          address:,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob:,
+          # Individual's email address. If utilizing Lithic for chargeback processing, this
+          # customer email address may be used to communicate dispute status and resolution.
+          email:,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name:,
+          # Government-issued identification number (required for identity verification and
+          # compliance with banking regulations). Social Security Numbers (SSN) and
+          # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+          # entered as full nine-digits, with or without hyphens
+          government_id:,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name:,
+          # Individual's phone number, entered in E.164 format.
+          phone_number:
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/kyc_exempt.rbi

@@ -67,14 +67,27 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
+        # acceptable; APO/FPO are acceptable.
         address:,
+        # The KYC Exempt user's email
         email:,
+        # The KYC Exempt user's first name
         first_name:,
+        # Specifies the type of KYC Exempt user
         kyc_exemption_type:,
+        # The KYC Exempt user's last name
         last_name:,
+        # The KYC Exempt user's phone number, entered in E.164 format.
         phone_number:,
+        # Specifies the workflow type. This must be 'KYC_EXEMPT'
         workflow:,
+        # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
+        # users of businesses. Pass the account_token of the enrolled business associated
+        # with the AUTHORIZED_USER in this field.
         business_account_token: nil,
+        # A user provided id that can be used to link an account holder with an external
+        # system
         external_id: nil
       ); end
       sig do

data/rbi/lib/lithic/models/management_operation_list_params.rbi

@@ -89,14 +89,27 @@ 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,
         business_account_token: nil,
+        # Management operation 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,
+        # Globally unique identifier for the financial account. Accepted type dependent on
+        # the program's use case.
         financial_account_token: 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,
+        # Management operation status to be returned.
         status: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/message_attempt.rbi

@@ -51,17 +51,24 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier.
         token:,
+        # An RFC 3339 timestamp for when the event was created. UTC time zone.
+        #
+        # If no timezone is specified, UTC will be used.
         created:,
+        # Globally unique identifier.
         event_subscription_token:,
+        # Globally unique identifier.
         event_token:,
+        # The response body from the event subscription's URL.
         response:,
+        # The response status code from the event subscription's URL.
         response_status_code:,
+        # The status of the event attempt.
         status:,
         url:
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(