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

data/rbi/lib/lithic/models/events/subscription_list_attempts_params.rbi

@@ -65,10 +65,19 @@ 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,
+          # 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,
+          # 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,
           status: nil,
           request_options: {}

data/rbi/lib/lithic/models/events/subscription_list_params.rbi

@@ -39,8 +39,17 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(ending_before: nil, page_size: nil, starting_after: nil, request_options: {}); end
-
+        def self.new(
+          # 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
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/events/subscription_recover_params.rbi

@@ -31,8 +31,15 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(begin_: nil, end_: nil, request_options: {}); 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,
+          # Date string in RFC 3339 format. Only entries created before the specified time
+          # will be included. UTC time zone.
+          end_: nil,
+          request_options: {}
+        ); end
         sig { override.returns({begin_: Time, end_: Time, request_options: Lithic::RequestOptions}) }
         def to_hash; end
       end

data/rbi/lib/lithic/models/events/subscription_replay_missing_params.rbi

@@ -31,8 +31,15 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(begin_: nil, end_: nil, request_options: {}); 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,
+          # Date string in RFC 3339 format. Only entries created before the specified time
+          # will be included. UTC time zone.
+          end_: nil,
+          request_options: {}
+        ); end
         sig { override.returns({begin_: Time, end_: Time, request_options: Lithic::RequestOptions}) }
         def to_hash; end
       end

data/rbi/lib/lithic/models/events/subscription_retrieve_secret_response.rbi

@@ -12,8 +12,10 @@ module Lithic
         attr_writer :secret
 
         sig { params(secret: String).returns(T.attached_class) }
-        def self.new(secret: nil); end
-
+        def self.new(
+          # The secret for the event subscription.
+          secret: nil
+        ); end
         sig { override.returns({secret: String}) }
         def to_hash; end
       end

data/rbi/lib/lithic/models/events/subscription_send_simulated_example_params.rbi

@@ -24,8 +24,11 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(event_type: nil, request_options: {}); end
-
+        def self.new(
+          # Event type to send example message for.
+          event_type: nil,
+          request_options: {}
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/events/subscription_update_params.rbi

@@ -43,8 +43,18 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(url:, description: nil, disabled: nil, event_types: nil, request_options: {}); end
-
+        def self.new(
+          # URL to which event webhooks will be sent. URL must be a valid HTTPS address.
+          url:,
+          # Event subscription description.
+          description: nil,
+          # Whether the event subscription is active (false) or inactive (true).
+          disabled: nil,
+          # Indicates types of events that will be sent to this subscription. If left blank,
+          # all types will be sent.
+          event_types: nil,
+          request_options: {}
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/external_bank_account_create_params.rbi

@@ -129,22 +129,42 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Account Number
         account_number:,
+        # The country that the bank account is located in using ISO 3166-1. We will only
+        # accept USA bank accounts e.g., USA
         country:,
+        # currency of the external account 3-character alphabetic ISO 4217 code
         currency:,
+        # The financial account token of the operating account to fund the micro deposits
         financial_account_token:,
+        # Legal Name of the business or individual who owns the external account. This
+        # will appear in statements
         owner:,
+        # Owner Type
         owner_type:,
+        # Routing Number
         routing_number:,
+        # Account Type
         type:,
+        # Verification Method
         verification_method:,
         processor_token:,
+        # Indicates which Lithic account the external account is associated with. For
+        # external accounts that are associated with the program, account_token field
+        # returned will be null
         account_token: nil,
+        # Address
         address: nil,
+        # Optional field that helps identify bank accounts in receipts
         company_id: nil,
+        # Date of Birth of the Individual that owns the external bank account
         dob: nil,
+        # Doing Business As
         doing_business_as: nil,
+        # The nickname for this External Bank Account
         name: nil,
+        # User Defined ID
         user_defined_id: nil,
         verification_enforcement: nil,
         request_options: {}

data/rbi/lib/lithic/models/external_bank_account_create_response.rbi

@@ -157,27 +157,60 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # A globally unique identifier for this record of an external bank account
+        # association. If a program links an external bank account to more than one
+        # end-user or to both the program and the end-user, then Lithic will return each
+        # record of the association
         token:,
+        # The country that the bank account is located in using ISO 3166-1. We will only
+        # accept USA bank accounts e.g., USA
         country:,
+        # An ISO 8601 string representing when this funding source was added to the Lithic
+        # account.
         created:,
+        # currency of the external account 3-character alphabetic ISO 4217 code
         currency:,
+        # The last 4 digits of the bank account. Derived by Lithic from the account number
+        # passed
         last_four:,
+        # Legal Name of the business or individual who owns the external account. This
+        # will appear in statements
         owner:,
+        # Owner Type
         owner_type:,
+        # Routing Number
         routing_number:,
+        # Account State
         state:,
+        # Account Type
         type:,
+        # The number of attempts at verification
         verification_attempts:,
+        # Verification Method
         verification_method:,
+        # Verification State
         verification_state:,
+        # Indicates which Lithic account the external account is associated with. For
+        # external accounts that are associated with the program, account_token field
+        # returned will be null
         account_token: nil,
+        # Address
         address: nil,
+        # Optional field that helps identify bank accounts in receipts
         company_id: nil,
+        # Date of Birth of the Individual that owns the external bank account
         dob: nil,
+        # Doing Business As
         doing_business_as: nil,
+        # The financial account token of the operating account to fund the micro deposits
         financial_account_token: nil,
+        # The nickname for this External Bank Account
         name: nil,
+        # User Defined ID
         user_defined_id: nil,
+        # Optional free text description of the reason for the failed verification. For
+        # ACH micro-deposits returned, this field will display the reason return code sent
+        # by the ACH network
         verification_failed_reason: nil
       ); end
       sig do

data/rbi/lib/lithic/models/external_bank_account_list_params.rbi

@@ -89,9 +89,14 @@ module Lithic
         account_token: nil,
         account_types: nil,
         countries: 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,
         owner_types: 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,
         states: nil,
         verification_states: nil,

data/rbi/lib/lithic/models/external_bank_account_list_response.rbi

@@ -157,27 +157,60 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # A globally unique identifier for this record of an external bank account
+        # association. If a program links an external bank account to more than one
+        # end-user or to both the program and the end-user, then Lithic will return each
+        # record of the association
         token:,
+        # The country that the bank account is located in using ISO 3166-1. We will only
+        # accept USA bank accounts e.g., USA
         country:,
+        # An ISO 8601 string representing when this funding source was added to the Lithic
+        # account.
         created:,
+        # currency of the external account 3-character alphabetic ISO 4217 code
         currency:,
+        # The last 4 digits of the bank account. Derived by Lithic from the account number
+        # passed
         last_four:,
+        # Legal Name of the business or individual who owns the external account. This
+        # will appear in statements
         owner:,
+        # Owner Type
         owner_type:,
+        # Routing Number
         routing_number:,
+        # Account State
         state:,
+        # Account Type
         type:,
+        # The number of attempts at verification
         verification_attempts:,
+        # Verification Method
         verification_method:,
+        # Verification State
         verification_state:,
+        # Indicates which Lithic account the external account is associated with. For
+        # external accounts that are associated with the program, account_token field
+        # returned will be null
         account_token: nil,
+        # Address
         address: nil,
+        # Optional field that helps identify bank accounts in receipts
         company_id: nil,
+        # Date of Birth of the Individual that owns the external bank account
         dob: nil,
+        # Doing Business As
         doing_business_as: nil,
+        # The financial account token of the operating account to fund the micro deposits
         financial_account_token: nil,
+        # The nickname for this External Bank Account
         name: nil,
+        # User Defined ID
         user_defined_id: nil,
+        # Optional free text description of the reason for the failed verification. For
+        # ACH micro-deposits returned, this field will display the reason return code sent
+        # by the ACH network
         verification_failed_reason: nil
       ); end
       sig do

data/rbi/lib/lithic/models/external_bank_account_retrieve_response.rbi

@@ -157,27 +157,60 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # A globally unique identifier for this record of an external bank account
+        # association. If a program links an external bank account to more than one
+        # end-user or to both the program and the end-user, then Lithic will return each
+        # record of the association
         token:,
+        # The country that the bank account is located in using ISO 3166-1. We will only
+        # accept USA bank accounts e.g., USA
         country:,
+        # An ISO 8601 string representing when this funding source was added to the Lithic
+        # account.
         created:,
+        # currency of the external account 3-character alphabetic ISO 4217 code
         currency:,
+        # The last 4 digits of the bank account. Derived by Lithic from the account number
+        # passed
         last_four:,
+        # Legal Name of the business or individual who owns the external account. This
+        # will appear in statements
         owner:,
+        # Owner Type
         owner_type:,
+        # Routing Number
         routing_number:,
+        # Account State
         state:,
+        # Account Type
         type:,
+        # The number of attempts at verification
         verification_attempts:,
+        # Verification Method
         verification_method:,
+        # Verification State
         verification_state:,
+        # Indicates which Lithic account the external account is associated with. For
+        # external accounts that are associated with the program, account_token field
+        # returned will be null
         account_token: nil,
+        # Address
         address: nil,
+        # Optional field that helps identify bank accounts in receipts
         company_id: nil,
+        # Date of Birth of the Individual that owns the external bank account
         dob: nil,
+        # Doing Business As
         doing_business_as: nil,
+        # The financial account token of the operating account to fund the micro deposits
         financial_account_token: nil,
+        # The nickname for this External Bank Account
         name: nil,
+        # User Defined ID
         user_defined_id: nil,
+        # Optional free text description of the reason for the failed verification. For
+        # ACH micro-deposits returned, this field will display the reason return code sent
+        # by the ACH network
         verification_failed_reason: nil
       ); end
       sig do

data/rbi/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rbi

@@ -157,27 +157,60 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # A globally unique identifier for this record of an external bank account
+        # association. If a program links an external bank account to more than one
+        # end-user or to both the program and the end-user, then Lithic will return each
+        # record of the association
         token:,
+        # The country that the bank account is located in using ISO 3166-1. We will only
+        # accept USA bank accounts e.g., USA
         country:,
+        # An ISO 8601 string representing when this funding source was added to the Lithic
+        # account.
         created:,
+        # currency of the external account 3-character alphabetic ISO 4217 code
         currency:,
+        # The last 4 digits of the bank account. Derived by Lithic from the account number
+        # passed
         last_four:,
+        # Legal Name of the business or individual who owns the external account. This
+        # will appear in statements
         owner:,
+        # Owner Type
         owner_type:,
+        # Routing Number
         routing_number:,
+        # Account State
         state:,
+        # Account Type
         type:,
+        # The number of attempts at verification
         verification_attempts:,
+        # Verification Method
         verification_method:,
+        # Verification State
         verification_state:,
+        # Indicates which Lithic account the external account is associated with. For
+        # external accounts that are associated with the program, account_token field
+        # returned will be null
         account_token: nil,
+        # Address
         address: nil,
+        # Optional field that helps identify bank accounts in receipts
         company_id: nil,
+        # Date of Birth of the Individual that owns the external bank account
         dob: nil,
+        # Doing Business As
         doing_business_as: nil,
+        # The financial account token of the operating account to fund the micro deposits
         financial_account_token: nil,
+        # The nickname for this External Bank Account
         name: nil,
+        # User Defined ID
         user_defined_id: nil,
+        # Optional free text description of the reason for the failed verification. For
+        # ACH micro-deposits returned, this field will display the reason return code sent
+        # by the ACH network
         verification_failed_reason: nil
       ); end
       sig do

data/rbi/lib/lithic/models/external_bank_account_retry_prenote_response.rbi

@@ -157,27 +157,60 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # A globally unique identifier for this record of an external bank account
+        # association. If a program links an external bank account to more than one
+        # end-user or to both the program and the end-user, then Lithic will return each
+        # record of the association
         token:,
+        # The country that the bank account is located in using ISO 3166-1. We will only
+        # accept USA bank accounts e.g., USA
         country:,
+        # An ISO 8601 string representing when this funding source was added to the Lithic
+        # account.
         created:,
+        # currency of the external account 3-character alphabetic ISO 4217 code
         currency:,
+        # The last 4 digits of the bank account. Derived by Lithic from the account number
+        # passed
         last_four:,
+        # Legal Name of the business or individual who owns the external account. This
+        # will appear in statements
         owner:,
+        # Owner Type
         owner_type:,
+        # Routing Number
         routing_number:,
+        # Account State
         state:,
+        # Account Type
         type:,
+        # The number of attempts at verification
         verification_attempts:,
+        # Verification Method
         verification_method:,
+        # Verification State
         verification_state:,
+        # Indicates which Lithic account the external account is associated with. For
+        # external accounts that are associated with the program, account_token field
+        # returned will be null
         account_token: nil,
+        # Address
         address: nil,
+        # Optional field that helps identify bank accounts in receipts
         company_id: nil,
+        # Date of Birth of the Individual that owns the external bank account
         dob: nil,
+        # Doing Business As
         doing_business_as: nil,
+        # The financial account token of the operating account to fund the micro deposits
         financial_account_token: nil,
+        # The nickname for this External Bank Account
         name: nil,
+        # User Defined ID
         user_defined_id: nil,
+        # Optional free text description of the reason for the failed verification. For
+        # ACH micro-deposits returned, this field will display the reason return code sent
+        # by the ACH network
         verification_failed_reason: nil
       ); end
       sig do

data/rbi/lib/lithic/models/external_bank_account_update_params.rbi

@@ -85,14 +85,23 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Address
         address: nil,
+        # Optional field that helps identify bank accounts in receipts
         company_id: nil,
+        # Date of Birth of the Individual that owns the external bank account
         dob: nil,
+        # Doing Business As
         doing_business_as: nil,
+        # The nickname for this External Bank Account
         name: nil,
+        # Legal Name of the business or individual who owns the external account. This
+        # will appear in statements
         owner: nil,
+        # Owner Type
         owner_type: nil,
         type: nil,
+        # User Defined ID
         user_defined_id: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/external_bank_account_update_response.rbi

@@ -157,27 +157,60 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # A globally unique identifier for this record of an external bank account
+        # association. If a program links an external bank account to more than one
+        # end-user or to both the program and the end-user, then Lithic will return each
+        # record of the association
         token:,
+        # The country that the bank account is located in using ISO 3166-1. We will only
+        # accept USA bank accounts e.g., USA
         country:,
+        # An ISO 8601 string representing when this funding source was added to the Lithic
+        # account.
         created:,
+        # currency of the external account 3-character alphabetic ISO 4217 code
         currency:,
+        # The last 4 digits of the bank account. Derived by Lithic from the account number
+        # passed
         last_four:,
+        # Legal Name of the business or individual who owns the external account. This
+        # will appear in statements
         owner:,
+        # Owner Type
         owner_type:,
+        # Routing Number
         routing_number:,
+        # Account State
         state:,
+        # Account Type
         type:,
+        # The number of attempts at verification
         verification_attempts:,
+        # Verification Method
         verification_method:,
+        # Verification State
         verification_state:,
+        # Indicates which Lithic account the external account is associated with. For
+        # external accounts that are associated with the program, account_token field
+        # returned will be null
         account_token: nil,
+        # Address
         address: nil,
+        # Optional field that helps identify bank accounts in receipts
         company_id: nil,
+        # Date of Birth of the Individual that owns the external bank account
         dob: nil,
+        # Doing Business As
         doing_business_as: nil,
+        # The financial account token of the operating account to fund the micro deposits
         financial_account_token: nil,
+        # The nickname for this External Bank Account
         name: nil,
+        # User Defined ID
         user_defined_id: nil,
+        # Optional free text description of the reason for the failed verification. For
+        # ACH micro-deposits returned, this field will display the reason return code sent
+        # by the ACH network
         verification_failed_reason: nil
       ); end
       sig do

data/rbi/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi

@@ -162,27 +162,60 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # A globally unique identifier for this record of an external bank account
+          # association. If a program links an external bank account to more than one
+          # end-user or to both the program and the end-user, then Lithic will return each
+          # record of the association
           token:,
+          # The country that the bank account is located in using ISO 3166-1. We will only
+          # accept USA bank accounts e.g., USA
           country:,
+          # An ISO 8601 string representing when this funding source was added to the Lithic
+          # account.
           created:,
+          # currency of the external account 3-character alphabetic ISO 4217 code
           currency:,
+          # The last 4 digits of the bank account. Derived by Lithic from the account number
+          # passed
           last_four:,
+          # Legal Name of the business or individual who owns the external account. This
+          # will appear in statements
           owner:,
+          # Owner Type
           owner_type:,
+          # Routing Number
           routing_number:,
+          # Account State
           state:,
+          # Account Type
           type:,
+          # The number of attempts at verification
           verification_attempts:,
+          # Verification Method
           verification_method:,
+          # Verification State
           verification_state:,
+          # Indicates which Lithic account the external account is associated with. For
+          # external accounts that are associated with the program, account_token field
+          # returned will be null
           account_token: nil,
+          # Address
           address: nil,
+          # Optional field that helps identify bank accounts in receipts
           company_id: nil,
+          # Date of Birth of the Individual that owns the external bank account
           dob: nil,
+          # Doing Business As
           doing_business_as: nil,
+          # The financial account token of the operating account to fund the micro deposits
           financial_account_token: nil,
+          # The nickname for this External Bank Account
           name: nil,
+          # User Defined ID
           user_defined_id: nil,
+          # Optional free text description of the reason for the failed verification. For
+          # ACH micro-deposits returned, this field will display the reason return code sent
+          # by the ACH network
           verification_failed_reason: nil
         ); end
         sig do

data/rbi/lib/lithic/models/external_payment_list_params.rbi

@@ -97,15 +97,29 @@ 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,
+        # External Payment 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 or card that will send the
+        # funds. Accepted type dependent on the program's use case.
         financial_account_token: nil,
+        # Page size (for pagination).
         page_size: nil,
+        # External Payment 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,
+        # Book transfer status to be returned.
         status: nil,
         request_options: {}
       ); end