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

data/rbi/lib/lithic/models/aggregate_balance.rbi

@@ -64,15 +64,29 @@ 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:,
+        # Type of financial account
         financial_account_type:,
+        # Globally unique identifier for the financial account that had its balance
+        # updated most recently
         last_financial_account_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/aggregate_balance_list_params.rbi

@@ -23,8 +23,11 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(financial_account_type: nil, request_options: {}); end
-
+      def self.new(
+        # Get the aggregate balance for a given Financial Account type.
+        financial_account_type: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/auth_rules/auth_rule.rbi

@@ -82,14 +82,29 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Globally unique identifier.
           token:,
+          # Indicates whether the Auth Rule is ACTIVE or INACTIVE
           state:,
+          # Array of account_token(s) identifying the accounts that the Auth Rule applies
+          # to. Note that only this field or `card_tokens` can be provided for a given Auth
+          # Rule.
           account_tokens: nil,
+          # Countries in which the Auth Rule permits transactions. Note that Lithic
+          # maintains a list of countries in which all transactions are blocked; "allowing"
+          # those countries in an Auth Rule does not override the Lithic-wide restrictions.
           allowed_countries: nil,
+          # Merchant category codes for which the Auth Rule permits transactions.
           allowed_mcc: nil,
+          # Countries in which the Auth Rule automatically declines transactions.
           blocked_countries: nil,
+          # Merchant category codes for which the Auth Rule automatically declines
+          # transactions.
           blocked_mcc: nil,
+          # Array of card_token(s) identifying the cards that the Auth Rule applies to. Note
+          # that only this field or `account_tokens` can be provided for a given Auth Rule.
           card_tokens: nil,
+          # Boolean indicating whether the Auth Rule is applied at the program level.
           program_level: nil
         ); end
         sig do

data/rbi/lib/lithic/models/auth_rules/auth_rule_condition.rbi

@@ -79,8 +79,60 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(attribute: nil, operation: nil, value: nil); end
-
+        def self.new(
+          # The attribute to target.
+          #
+          # The following attributes may be targeted:
+          #
+          # - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
+          #   business by the types of goods or services it provides.
+          # - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
+          #   ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
+          #   Netherlands Antilles.
+          # - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
+          #   the transaction.
+          # - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
+          #   (merchant).
+          # - `DESCRIPTOR`: Short description of card acceptor.
+          # - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
+          #   applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
+          #   `TOKEN_AUTHENTICATED`.
+          # - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
+          #   (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
+          #   `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
+          #   `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
+          #   `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
+          # - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
+          #   fee field in the settlement/cardholder billing currency. This is the amount
+          #   the issuer should authorize against unless the issuer is paying the acquirer
+          #   fee on behalf of the cardholder.
+          # - `RISK_SCORE`: Network-provided score assessing risk level associated with a
+          #   given authorization. Scores are on a range of 0-999, with 0 representing the
+          #   lowest risk and 999 representing the highest risk. For Visa transactions,
+          #   where the raw score has a range of 0-99, Lithic will normalize the score by
+          #   multiplying the raw score by 10x.
+          # - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
+          #   trailing 15 minutes before the authorization.
+          # - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
+          #   trailing hour up and until the authorization.
+          # - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
+          #   trailing 24 hours up and until the authorization.
+          # - `CARD_STATE`: The current state of the card associated with the transaction.
+          #   Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
+          #   `PENDING_FULFILLMENT`.
+          # - `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction.
+          #   Valid values are `TRUE`, `FALSE`.
+          # - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
+          #   `OK`, `BLOCKED`.
+          # - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
+          #   source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
+          #   `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
+          attribute: nil,
+          # The operation to apply to the attribute
+          operation: nil,
+          # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
+          value: nil
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/auth_rules/v2/backtest_create_params.rbi

@@ -33,8 +33,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(end_: nil, start: nil, request_options: {}); end
-
+          def self.new(
+            # The end time of the backtest.
+            end_: nil,
+            # The start time of the backtest.
+            start: nil,
+            request_options: {}
+          ); end
           sig { override.returns({end_: Time, start: Time, request_options: Lithic::RequestOptions}) }
           def to_hash; end
         end

data/rbi/lib/lithic/models/auth_rules/v2/backtest_create_response.rbi

@@ -13,8 +13,10 @@ module Lithic
           attr_writer :backtest_token
 
           sig { params(backtest_token: String).returns(T.attached_class) }
-          def self.new(backtest_token: nil); end
-
+          def self.new(
+            # Auth Rule Backtest Token
+            backtest_token: nil
+          ); end
           sig { override.returns({backtest_token: String}) }
           def to_hash; end
         end

data/rbi/lib/lithic/models/auth_rules/v2/backtest_results.rbi

@@ -37,8 +37,12 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(backtest_token:, results:, simulation_parameters:); end
-
+          def self.new(
+            # Auth Rule Backtest Token
+            backtest_token:,
+            results:,
+            simulation_parameters:
+          ); end
           sig do
             override
               .returns(
@@ -164,8 +168,21 @@ module Lithic
                 )
                   .returns(T.attached_class)
               end
-              def self.new(approved: nil, declined: nil, examples: nil, version: nil); end
-
+              def self.new(
+                # The total number of historical transactions approved by this rule during the
+                # backtest period, or the number of transactions that would have been approved if
+                # the rule was evaluated in shadow mode.
+                approved: nil,
+                # The total number of historical transactions declined by this rule during the
+                # backtest period, or the number of transactions that would have been declined if
+                # the rule was evaluated in shadow mode.
+                declined: nil,
+                # Example authorization request events that would have been approved or declined.
+                examples: nil,
+                # The version of the rule, this is incremented whenever the rule's parameters
+                # change.
+                version: nil
+              ); end
               sig do
                 override
                   .returns(
@@ -204,8 +221,14 @@ module Lithic
                 sig do
                   params(approved: T::Boolean, event_token: String, timestamp: Time).returns(T.attached_class)
                 end
-                def self.new(approved: nil, event_token: nil, timestamp: nil); end
-
+                def self.new(
+                  # Whether the rule would have approved the authorization request.
+                  approved: nil,
+                  # The authorization request event token.
+                  event_token: nil,
+                  # The timestamp of the authorization request event.
+                  timestamp: nil
+                ); end
                 sig { override.returns({approved: T::Boolean, event_token: String, timestamp: Time}) }
                 def to_hash; end
               end
@@ -273,8 +296,21 @@ module Lithic
                 )
                   .returns(T.attached_class)
               end
-              def self.new(approved: nil, declined: nil, examples: nil, version: nil); end
-
+              def self.new(
+                # The total number of historical transactions approved by this rule during the
+                # backtest period, or the number of transactions that would have been approved if
+                # the rule was evaluated in shadow mode.
+                approved: nil,
+                # The total number of historical transactions declined by this rule during the
+                # backtest period, or the number of transactions that would have been declined if
+                # the rule was evaluated in shadow mode.
+                declined: nil,
+                # Example authorization request events that would have been approved or declined.
+                examples: nil,
+                # The version of the rule, this is incremented whenever the rule's parameters
+                # change.
+                version: nil
+              ); end
               sig do
                 override
                   .returns(
@@ -313,8 +349,14 @@ module Lithic
                 sig do
                   params(approved: T::Boolean, event_token: String, timestamp: Time).returns(T.attached_class)
                 end
-                def self.new(approved: nil, event_token: nil, timestamp: nil); end
-
+                def self.new(
+                  # Whether the rule would have approved the authorization request.
+                  approved: nil,
+                  # The authorization request event token.
+                  event_token: nil,
+                  # The timestamp of the authorization request event.
+                  timestamp: nil
+                ); end
                 sig { override.returns({approved: T::Boolean, event_token: String, timestamp: Time}) }
                 def to_hash; end
               end
@@ -344,8 +386,14 @@ module Lithic
             attr_writer :start
 
             sig { params(auth_rule_token: String, end_: Time, start: Time).returns(T.attached_class) }
-            def self.new(auth_rule_token: nil, end_: nil, start: nil); end
-
+            def self.new(
+              # Auth Rule Token
+              auth_rule_token: nil,
+              # The end time of the simulation.
+              end_: nil,
+              # The start time of the simulation.
+              start: nil
+            ); end
             sig { override.returns({auth_rule_token: String, end_: Time, start: Time}) }
             def to_hash; end
           end

data/rbi/lib/lithic/models/auth_rules/v2_apply_params.rbi

@@ -37,14 +37,16 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Account tokens to which the Auth Rule applies.
           account_tokens:,
+          # Card tokens to which the Auth Rule applies.
           card_tokens:,
+          # Whether the Auth Rule applies to all authorizations on the card program.
           program_level:,
+          # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/auth_rules/v2_apply_response.rbi

@@ -77,15 +77,23 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Auth Rule Token
           token:,
+          # Account tokens to which the Auth Rule applies.
           account_tokens:,
+          # Card tokens to which the Auth Rule applies.
           card_tokens:,
           current_version:,
           draft_version:,
+          # Auth Rule Name
           name:,
+          # Whether the Auth Rule applies to all authorizations on the card program.
           program_level:,
+          # The state of the Auth Rule
           state:,
+          # The type of Auth Rule
           type:,
+          # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil
         ); end
         sig do
@@ -135,8 +143,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(
@@ -193,8 +206,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/auth_rules/v2_create_params.rbi

@@ -80,12 +80,19 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Account tokens to which the Auth Rule applies.
           account_tokens:,
+          # Card tokens to which the Auth Rule applies.
           card_tokens:,
+          # Whether the Auth Rule applies to all authorizations on the card program.
           program_level:,
+          # Auth Rule Name
           name: nil,
+          # Parameters for the Auth Rule
           parameters: nil,
+          # The type of Auth Rule
           type: nil,
+          # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil,
           request_options: {}
         ); end

data/rbi/lib/lithic/models/auth_rules/v2_create_response.rbi

@@ -77,15 +77,23 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Auth Rule Token
           token:,
+          # Account tokens to which the Auth Rule applies.
           account_tokens:,
+          # Card tokens to which the Auth Rule applies.
           card_tokens:,
           current_version:,
           draft_version:,
+          # Auth Rule Name
           name:,
+          # Whether the Auth Rule applies to all authorizations on the card program.
           program_level:,
+          # The state of the Auth Rule
           state:,
+          # The type of Auth Rule
           type:,
+          # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil
         ); end
         sig do
@@ -135,8 +143,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(
@@ -193,8 +206,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/auth_rules/v2_draft_params.rbi

@@ -33,8 +33,11 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(parameters: nil, request_options: {}); end
-
+        def self.new(
+          # Parameters for the Auth Rule
+          parameters: nil,
+          request_options: {}
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/auth_rules/v2_draft_response.rbi

@@ -77,15 +77,23 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Auth Rule Token
           token:,
+          # Account tokens to which the Auth Rule applies.
           account_tokens:,
+          # Card tokens to which the Auth Rule applies.
           card_tokens:,
           current_version:,
           draft_version:,
+          # Auth Rule Name
           name:,
+          # Whether the Auth Rule applies to all authorizations on the card program.
           program_level:,
+          # The state of the Auth Rule
           state:,
+          # The type of Auth Rule
           type:,
+          # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil
         ); end
         sig do
@@ -135,8 +143,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(
@@ -193,8 +206,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/auth_rules/v2_list_params.rbi

@@ -56,10 +56,17 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Only return Authorization Rules that are bound to the provided account token.
           account_token: nil,
+          # Only return Authorization Rules that are bound to the provided card token.
           card_token: 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

data/rbi/lib/lithic/models/auth_rules/v2_list_response.rbi

@@ -77,15 +77,23 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Auth Rule Token
           token:,
+          # Account tokens to which the Auth Rule applies.
           account_tokens:,
+          # Card tokens to which the Auth Rule applies.
           card_tokens:,
           current_version:,
           draft_version:,
+          # Auth Rule Name
           name:,
+          # Whether the Auth Rule applies to all authorizations on the card program.
           program_level:,
+          # The state of the Auth Rule
           state:,
+          # The type of Auth Rule
           type:,
+          # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil
         ); end
         sig do
@@ -135,8 +143,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(
@@ -193,8 +206,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/auth_rules/v2_promote_response.rbi

@@ -77,15 +77,23 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Auth Rule Token
           token:,
+          # Account tokens to which the Auth Rule applies.
           account_tokens:,
+          # Card tokens to which the Auth Rule applies.
           card_tokens:,
           current_version:,
           draft_version:,
+          # Auth Rule Name
           name:,
+          # Whether the Auth Rule applies to all authorizations on the card program.
           program_level:,
+          # The state of the Auth Rule
           state:,
+          # The type of Auth Rule
           type:,
+          # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil
         ); end
         sig do
@@ -135,8 +143,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(
@@ -193,8 +206,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(