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

data/rbi/lib/lithic/models/cards/aggregate_balance_list_response.rbi

@@ -60,14 +60,27 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # 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 card that had its balance updated most
+          # recently
           last_card_token:,
+          # Globally unique identifier for the last transaction event that impacted this
+          # balance
           last_transaction_event_token:,
+          # Globally unique identifier for the last 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:,
+          # Date and time for when the balance was last updated.
           updated:
         ); end
         sig do

data/rbi/lib/lithic/models/cards/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/cards/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/cards/financial_transaction_list_params.rbi

@@ -74,12 +74,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/carrier.rbi

@@ -11,8 +11,10 @@ module Lithic
       attr_writer :qr_code_url
 
       sig { params(qr_code_url: String).returns(T.attached_class) }
-      def self.new(qr_code_url: nil); end
-
+      def self.new(
+        # QR code url to display on the card carrier
+        qr_code_url: nil
+      ); end
       sig { override.returns({qr_code_url: String}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/credit_products/prime_rate_create_params.rbi

@@ -23,8 +23,13 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(effective_date:, rate:, request_options: {}); end
-
+        def self.new(
+          # Date the rate goes into effect
+          effective_date:,
+          # The rate in decimal format
+          rate:,
+          request_options: {}
+        ); end
         sig do
           override.returns({effective_date: Date, rate: String, request_options: Lithic::RequestOptions})
         end

data/rbi/lib/lithic/models/credit_products/prime_rate_retrieve_params.rbi

@@ -29,8 +29,13 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(ending_before: nil, starting_after: nil, request_options: {}); end
-
+        def self.new(
+          # The effective date that the prime rates ends before
+          ending_before: nil,
+          # The effective date that the prime rate starts after
+          starting_after: nil,
+          request_options: {}
+        ); end
         sig do
           override.returns(
             {

data/rbi/lib/lithic/models/credit_products/prime_rate_retrieve_response.rbi

@@ -19,8 +19,12 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(data:, has_more:); end
-
+        def self.new(
+          # List of prime rates
+          data:,
+          # Whether there are more prime rates
+          has_more:
+        ); end
         sig do
           override
             .returns(
@@ -39,8 +43,12 @@ module Lithic
           attr_accessor :rate
 
           sig { params(effective_date: Date, rate: String).returns(T.attached_class) }
-          def self.new(effective_date:, rate:); end
-
+          def self.new(
+            # Date the rate goes into effect
+            effective_date:,
+            # The rate in decimal format
+            rate:
+          ); end
           sig { override.returns({effective_date: Date, rate: String}) }
           def to_hash; end
         end

data/rbi/lib/lithic/models/digital_card_art.rbi

@@ -47,16 +47,21 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier for the card art.
         token:,
+        # Globally unique identifier for the card program.
         card_program_token:,
+        # Timestamp of when card art was created.
         created:,
+        # Description of the card art.
         description:,
+        # Whether the card art is enabled.
         is_enabled:,
+        # Card network.
         network:,
+        # Whether the card art is the default card art to be added upon tokenization.
         is_card_program_default: nil
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/digital_card_art_list_params.rbi

@@ -38,8 +38,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/dispute.rbi

@@ -148,23 +148,89 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier.
         token:,
+        # Amount under dispute. May be different from the original transaction amount.
         amount:,
+        # Date dispute entered arbitration.
         arbitration_date:,
+        # Timestamp of when first Dispute was reported.
         created:,
+        # Date that the dispute was filed by the customer making the dispute.
         customer_filed_date:,
+        # End customer description of the reason for the dispute.
         customer_note:,
+        # Unique identifiers for the dispute from the network.
         network_claim_ids:,
+        # Date that the dispute was submitted to the network.
         network_filed_date:,
+        # Network reason code used to file the dispute.
         network_reason_code:,
+        # Date dispute entered pre-arbitration.
         prearbitration_date:,
+        # Unique identifier for the dispute from the network. If there are multiple, this
+        # will be the first claim id set by the network
         primary_claim_id:,
+        # Dispute reason:
+        #
+        # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense.
+        # - `CANCELLED`: Transaction was cancelled by the customer.
+        # - `DUPLICATED`: The transaction was a duplicate.
+        # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present.
+        # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present.
+        # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable
+        #   merchant activity.
+        # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as
+        #   described.
+        # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received.
+        # - `INCORRECT_AMOUNT`: The transaction amount was incorrect.
+        # - `MISSING_AUTH`: The transaction was missing authorization.
+        # - `OTHER`: Other reason.
+        # - `PROCESSING_ERROR`: Processing error.
+        # - `REFUND_NOT_PROCESSED`: The refund was not processed.
+        # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not
+        #   cancelled.
         reason:,
+        # Date the representment was received.
         representment_date:,
+        # Date that the dispute was resolved.
         resolution_date:,
+        # Note by Dispute team on the case resolution.
         resolution_note:,
+        # Reason for the dispute resolution:
+        #
+        # - `CASE_LOST`: This case was lost at final arbitration.
+        # - `NETWORK_REJECTED`: Network rejected.
+        # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS.
+        # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold.
+        # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless.
+        # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid.
+        # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks.
+        # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other.
+        # - `PAST_FILING_DATE`: Past filing date.
+        # - `PREARBITRATION_REJECTED`: Prearbitration rejected.
+        # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other.
+        # - `REFUNDED`: Refunded.
+        # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback.
+        # - `WITHDRAWN`: Withdrawn.
+        # - `WON_ARBITRATION`: Won arbitration.
+        # - `WON_FIRST_CHARGEBACK`: Won first chargeback.
+        # - `WON_PREARBITRATION`: Won prearbitration.
         resolution_reason:,
+        # Status types:
+        #
+        # - `NEW` - New dispute case is opened.
+        # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more
+        #   information.
+        # - `SUBMITTED` - Dispute is submitted to the card network.
+        # - `REPRESENTMENT` - Case has entered second presentment.
+        # - `PREARBITRATION` - Case has entered prearbitration.
+        # - `ARBITRATION` - Case has entered arbitration.
+        # - `CASE_WON` - Case was won and credit will be issued.
+        # - `CASE_CLOSED` - Case was lost or withdrawn.
         status:,
+        # The transaction that is being disputed. A transaction can only be disputed once
+        # but may have multiple dispute cases.
         transaction_token:
       ); end
       sig do

data/rbi/lib/lithic/models/dispute_create_params.rbi

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

data/rbi/lib/lithic/models/dispute_evidence.rbi

@@ -61,16 +61,28 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier.
         token:,
+        # Timestamp of when dispute evidence was created.
         created:,
+        # Dispute token evidence is attached to.
         dispute_token:,
+        # Upload status types:
+        #
+        # - `DELETED` - Evidence was deleted.
+        # - `ERROR` - Evidence upload failed.
+        # - `PENDING` - Evidence is pending upload.
+        # - `REJECTED` - Evidence was rejected.
+        # - `UPLOADED` - Evidence was uploaded.
         upload_status:,
+        # URL to download evidence. Only shown when `upload_status` is `UPLOADED`.
         download_url: nil,
+        # File name of evidence. Recommended to give the dispute evidence a human-readable
+        # identifier.
         filename: nil,
+        # URL to upload evidence. Only shown when `upload_status` is `PENDING`.
         upload_url: nil
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/dispute_initiate_evidence_upload_params.rbi

@@ -17,8 +17,11 @@ module Lithic
         params(filename: String, request_options: T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
           .returns(T.attached_class)
       end
-      def self.new(filename: nil, request_options: {}); end
-
+      def self.new(
+        # Filename of the evidence.
+        filename: nil,
+        request_options: {}
+      ); end
       sig { override.returns({filename: String, request_options: Lithic::RequestOptions}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/dispute_list_evidences_params.rbi

@@ -57,15 +57,22 @@ 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,
         request_options: {}
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

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(