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

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(

data/rbi/lib/lithic/models/auth_rules/v2_retrieve_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_update_params.rbi

@@ -63,11 +63,21 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Account tokens to which the Auth Rule applies.
           account_tokens: nil,
+          # Auth Rule Name
           name: nil,
+          # The desired state of the Auth Rule.
+          #
+          # Note that only deactivating an Auth Rule through this endpoint is supported at
+          # this time. If you need to (re-)activate an Auth Rule the /promote endpoint
+          # should be used to promote a draft to the currently active version.
           state: nil,
+          # Card tokens to which the Auth Rule applies.
           card_tokens: nil,
+          # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil,
+          # Whether the Auth Rule applies to all authorizations on the card program.
           program_level: nil,
           request_options: {}
         ); end

data/rbi/lib/lithic/models/auth_rules/v2_update_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/velocity_limit_params.rbi

@@ -45,8 +45,23 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(filters:, period:, scope:, limit_amount: nil, limit_count: nil); end
-
+        def self.new(
+          filters:,
+          # The size of the trailing window to calculate Spend Velocity over in seconds. The
+          # minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
+          period:,
+          scope:,
+          # The maximum amount of spend velocity allowed in the period in minor units (the
+          # smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
+          # limit will be declined.
+          limit_amount: nil,
+          # The number of spend velocity impacting transactions may not exceed this limit in
+          # the period. Transactions exceeding this limit will be declined. A spend velocity
+          # impacting transaction is a transaction that has been authorized, and optionally
+          # settled, or a force post (a transaction that settled without prior
+          # authorization).
+          limit_count: nil
+        ); end
         sig do
           override
             .returns(
@@ -93,9 +108,22 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(exclude_countries: nil, exclude_mccs: nil, include_countries: nil, include_mccs: nil)
-          end
-
+          def self.new(
+            # ISO-3166-1 alpha-3 Country Codes to exclude from the velocity calculation.
+            # Transactions matching any of the provided will be excluded from the calculated
+            # velocity.
+            exclude_countries: nil,
+            # Merchant Category Codes to exclude from the velocity calculation. Transactions
+            # matching this MCC will be excluded from the calculated velocity.
+            exclude_mccs: nil,
+            # ISO-3166-1 alpha-3 Country Codes to include in the velocity calculation.
+            # Transactions not matching any of the provided will not be included in the
+            # calculated velocity.
+            include_countries: nil,
+            # Merchant Category Codes to include in the velocity calculation. Transactions not
+            # matching this MCC will not be included in the calculated velocity.
+            include_mccs: nil
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/auth_stream_secret.rbi

@@ -11,8 +11,10 @@ module Lithic
       attr_writer :secret
 
       sig { params(secret: String).returns(T.attached_class) }
-      def self.new(secret: nil); end
-
+      def self.new(
+        # The shared HMAC ASA secret
+        secret: nil
+      ); end
       sig { override.returns({secret: String}) }
       def to_hash; end
     end