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

data/rbi/lib/lithic/models/dispute_list_params.rbi

@@ -73,12 +73,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,
+        # 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,
+        # List disputes of a specific status.
         status: nil,
+        # Transaction tokens to filter by.
         transaction_tokens: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/dispute_update_params.rbi

@@ -45,14 +45,16 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Amount to dispute
         amount: nil,
+        # Date the customer filed the dispute
         customer_filed_date: nil,
+        # Customer description of dispute
         customer_note: nil,
+        # Reason for dispute
         reason: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/document.rbi

@@ -35,9 +35,18 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(token:, account_holder_token:, document_type:, entity_token:, required_document_uploads:)
-      end
-
+      def self.new(
+        # Globally unique identifier for the document.
+        token:,
+        # Globally unique identifier for the account holder.
+        account_holder_token:,
+        # Type of documentation to be submitted for verification of an account holder
+        document_type:,
+        # Globally unique identifier for an entity.
+        entity_token:,
+        # Represents a single image of the document to upload.
+        required_document_uploads:
+      ); end
       sig do
         override
           .returns(
@@ -149,14 +158,29 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Globally unique identifier for the document upload.
           token:,
+          # A list of status reasons associated with a KYB account holder that have been
+          # satisfied by the document upload
           accepted_entity_status_reasons:,
+          # When the document upload was created
           created:,
+          # Type of image to upload.
           image_type:,
+          # A list of status reasons associated with a KYB account holder that have not been
+          # satisfied by the document upload
           rejected_entity_status_reasons:,
+          # Status of an account holder's document upload.
           status:,
+          # Reasons for document image upload status.
           status_reasons:,
+          # When the document upload was last updated
           updated:,
+          # URL to upload document image to.
+          #
+          # Note that the upload URLs expire after 7 days. If an upload URL expires, you can
+          # refresh the URLs by retrieving the document upload from
+          # `GET /account_holders/{account_holder_token}/documents`.
           upload_url:
         ); end
         sig do

data/rbi/lib/lithic/models/event.rbi

@@ -58,8 +58,45 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(token:, created:, event_type:, payload:); 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:,
+        # Event types:
+        #
+        # - `account_holder.created` - Notification that a new account holder has been
+        #   created and was not rejected.
+        # - `account_holder.updated` - Notification that an account holder was updated.
+        # - `account_holder.verification` - Notification than an account holder's identity
+        #   verification is complete.
+        # - `card.created` - Notification that a card has been created.
+        # - `card.renewed` - Notification that a card has been renewed.
+        # - `card.reissued` - Notification that a card has been reissued.
+        # - `card.shipped` - Physical card shipment notification. See
+        #   https://docs.lithic.com/docs/cards#physical-card-shipped-webhook.
+        # - `card.converted` - Notification that a virtual card has been converted to a
+        #   physical card.
+        # - `card_transaction.updated` - Transaction Lifecycle webhook. See
+        #   https://docs.lithic.com/docs/transaction-webhooks.
+        # - `dispute.updated` - A dispute has been updated.
+        # - `digital_wallet.tokenization_approval_request` - Card network's request to
+        #   Lithic to activate a digital wallet token.
+        # - `digital_wallet.tokenization_result` - Notification of the end result of a
+        #   tokenization, whether successful or failed.
+        # - `digital_wallet.tokenization_two_factor_authentication_code` - A code to be
+        #   passed to an end user to complete digital wallet authentication. See
+        #   https://docs.lithic.com/docs/tokenization-control#digital-wallet-tokenization-auth-code.
+        # - `digital_wallet.tokenization_two_factor_authentication_code_sent` -
+        #   Notification that a two factor authentication code for activating a digital
+        #   wallet has been sent to the end user.
+        # - `digital_wallet.tokenization_updated` - Notification that a digital wallet
+        #   tokenization's status has changed.
+        event_type:,
+        payload:
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/event_list_attempts_params.rbi

@@ -64,10 +64,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/event_list_params.rbi

@@ -73,12 +73,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,
+        # 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,
+        # Event types to filter events by.
         event_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,
+        # Whether to include the event payload content in the response.
         with_content: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/event_subscription.rbi

@@ -32,8 +32,16 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(token:, description:, disabled:, url:, event_types: nil); end
-
+      def self.new(
+        # Globally unique identifier.
+        token:,
+        # A description of the subscription.
+        description:,
+        # Whether the subscription is disabled.
+        disabled:,
+        url:,
+        event_types: nil
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/events/subscription_create_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/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