lithic 0.1.0.pre.alpha.6 → 0.1.0.pre.alpha.8

data/rbi/lib/lithic/resources/auth_rules/v2/backtests.rbi

@@ -6,30 +6,30 @@ module Lithic
       class V2
         class Backtests
           # Initiates a request to asynchronously generate a backtest for an authorization
-          #   rule. During backtesting, both the active version (if one exists) and the draft
-          #   version of the Authorization Rule are evaluated by replaying historical
-          #   transaction data against the rule's conditions. This process allows customers to
-          #   simulate and understand the effects of proposed rule changes before deployment.
-          #   The generated backtest report provides detailed results showing whether the
-          #   draft version of the Auth Rule would have approved or declined historical
-          #   transactions which were processed during the backtest period. These reports help
-          #   evaluate how changes to rule configurations might affect overall transaction
-          #   approval rates.
+          # rule. During backtesting, both the active version (if one exists) and the draft
+          # version of the Authorization Rule are evaluated by replaying historical
+          # transaction data against the rule's conditions. This process allows customers to
+          # simulate and understand the effects of proposed rule changes before deployment.
+          # The generated backtest report provides detailed results showing whether the
+          # draft version of the Auth Rule would have approved or declined historical
+          # transactions which were processed during the backtest period. These reports help
+          # evaluate how changes to rule configurations might affect overall transaction
+          # approval rates.
           #
-          #   The generated backtest report will be delivered asynchronously through a webhook
-          #   with `event_type` = `auth_rules.backtest_report.created`. See the docs on
-          #   setting up [webhook subscriptions](https://docs.lithic.com/docs/events-api). It
-          #   is also possible to request backtest reports on-demand through the
-          #   `/v2/auth_rules/{auth_rule_token}/backtests/{auth_rule_backtest_token}`
-          #   endpoint.
+          # The generated backtest report will be delivered asynchronously through a webhook
+          # with `event_type` = `auth_rules.backtest_report.created`. See the docs on
+          # setting up [webhook subscriptions](https://docs.lithic.com/docs/events-api). It
+          # is also possible to request backtest reports on-demand through the
+          # `/v2/auth_rules/{auth_rule_token}/backtests/{auth_rule_backtest_token}`
+          # endpoint.
           #
-          #   Lithic currently supports backtesting for `CONDITIONAL_BLOCK` rules. Backtesting
-          #   for `VELOCITY_LIMIT` rules is generally not supported. In specific cases (i.e.
-          #   where Lithic has pre-calculated the requested velocity metrics for historical
-          #   transactions), a backtest may be feasible. However, such cases are uncommon and
-          #   customers should not anticipate support for velocity backtests under most
-          #   configurations. If a historical transaction does not feature the required inputs
-          #   to evaluate the rule, then it will not be included in the final backtest report.
+          # Lithic currently supports backtesting for `CONDITIONAL_BLOCK` rules. Backtesting
+          # for `VELOCITY_LIMIT` rules is generally not supported. In specific cases (i.e.
+          # where Lithic has pre-calculated the requested velocity metrics for historical
+          # transactions), a backtest may be feasible. However, such cases are uncommon and
+          # customers should not anticipate support for velocity backtests under most
+          # configurations. If a historical transaction does not feature the required inputs
+          # to evaluate the rule, then it will not be included in the final backtest report.
           sig do
             params(
               auth_rule_token: String,
@@ -47,27 +47,25 @@ module Lithic
             # The start time of the backtest.
             start: nil,
             request_options: {}
-          )
-          end
-
+          ); end
           # Returns the backtest results of an authorization rule (if available).
           #
-          #   Backtesting is an asynchronous process that requires time to complete. If a
-          #   customer retrieves the backtest results using this endpoint before the report is
-          #   fully generated, the response will return null for `results.current_version` and
-          #   `results.draft_version`. Customers are advised to wait for the backtest creation
-          #   process to complete (as indicated by the webhook event
-          #   auth_rules.backtest_report.created) before retrieving results from this
-          #   endpoint.
+          # Backtesting is an asynchronous process that requires time to complete. If a
+          # customer retrieves the backtest results using this endpoint before the report is
+          # fully generated, the response will return null for `results.current_version` and
+          # `results.draft_version`. Customers are advised to wait for the backtest creation
+          # process to complete (as indicated by the webhook event
+          # auth_rules.backtest_report.created) before retrieving results from this
+          # endpoint.
           #
-          #   Backtesting is an asynchronous process, while the backtest is being processed,
-          #   results will not be available which will cause `results.current_version` and
-          #   `results.draft_version` objects to contain `null`. The entries in `results` will
-          #   also always represent the configuration of the rule at the time requests are
-          #   made to this endpoint. For example, the results for `current_version` in the
-          #   served backtest report will be consistent with which version of the rule is
-          #   currently activated in the Auth Stream, regardless of which version of the rule
-          #   was active in the Auth Stream at the time a backtest is requested.
+          # Backtesting is an asynchronous process, while the backtest is being processed,
+          # results will not be available which will cause `results.current_version` and
+          # `results.draft_version` objects to contain `null`. The entries in `results` will
+          # also always represent the configuration of the rule at the time requests are
+          # made to this endpoint. For example, the results for `current_version` in the
+          # served backtest report will be consistent with which version of the rule is
+          # currently activated in the Auth Stream, regardless of which version of the rule
+          # was active in the Auth Stream at the time a backtest is requested.
           sig do
             params(
               auth_rule_backtest_token: String,
@@ -82,13 +80,10 @@ module Lithic
             # Globally unique identifier for the Auth Rule.
             auth_rule_token:,
             request_options: {}
-          )
-          end
-
+          ); end
           # @api private
           sig { params(client: Lithic::Client).returns(T.attached_class) }
-          def self.new(client:)
-          end
+          def self.new(client:); end
         end
       end
     end

data/rbi/lib/lithic/resources/auth_rules/v2.rbi

@@ -41,9 +41,7 @@ module Lithic
           # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         # Fetches a V2 authorization rule by its token
         sig do
           params(
@@ -56,14 +54,12 @@ module Lithic
           # Globally unique identifier for the Auth Rule.
           auth_rule_token,
           request_options: {}
-        )
-        end
-
+        ); end
         # Updates a V2 authorization rule's properties
         #
-        #   If `account_tokens`, `card_tokens`, `program_level`, or `excluded_card_tokens`
-        #   is provided, this will replace existing associations with the provided list of
-        #   entities.
+        # If `account_tokens`, `card_tokens`, `program_level`, or `excluded_card_tokens`
+        # is provided, this will replace existing associations with the provided list of
+        # entities.
         sig do
           params(
             auth_rule_token: String,
@@ -86,9 +82,9 @@ module Lithic
           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.
+          # 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,
@@ -97,9 +93,7 @@ module Lithic
           # Whether the Auth Rule applies to all authorizations on the card program.
           program_level: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         # Lists V2 authorization rules
         sig do
           params(
@@ -118,17 +112,15 @@ module Lithic
           # 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.
+          # 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.
+          # begin. Used to retrieve the next page of results after this item.
           starting_after: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         # Deletes a V2 authorization rule
         sig do
           params(
@@ -141,13 +133,11 @@ module Lithic
           # Globally unique identifier for the Auth Rule.
           auth_rule_token,
           request_options: {}
-        )
-        end
-
+        ); end
         # Associates a V2 authorization rule with a card program, the provided account(s)
-        #   or card(s).
+        # or card(s).
         #
-        #   Prefer using the `PATCH` method for this operation.
+        # Prefer using the `PATCH` method for this operation.
         sig do
           params(
             auth_rule_token: String,
@@ -171,13 +161,11 @@ module Lithic
           # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         # Creates a new draft version of a rule that will be ran in shadow mode.
         #
-        #   This can also be utilized to reset the draft parameters, causing a draft version
-        #   to no longer be ran in shadow mode.
+        # This can also be utilized to reset the draft parameters, causing a draft version
+        # to no longer be ran in shadow mode.
         sig do
           params(
             auth_rule_token: String,
@@ -198,11 +186,9 @@ module Lithic
           # Parameters for the Auth Rule
           parameters: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         # Promotes the draft version of an authorization rule to the currently active
-        #   version such that it is enforced in the authorization stream.
+        # version such that it is enforced in the authorization stream.
         sig do
           params(
             auth_rule_token: String,
@@ -214,60 +200,58 @@ module Lithic
           # Globally unique identifier for the Auth Rule.
           auth_rule_token,
           request_options: {}
-        )
-        end
-
+        ); end
         # Requests a performance report of an authorization rule to be asynchronously
-        #   generated. Reports can only be run on rules in draft or active mode and will
-        #   included approved and declined statistics as well as examples. The generated
-        #   report will be delivered asynchronously through a webhook with `event_type` =
-        #   `auth_rules.performance_report.created`. See the docs on setting up
-        #   [webhook subscriptions](https://docs.lithic.com/docs/events-api).
+        # generated. Reports can only be run on rules in draft or active mode and will
+        # included approved and declined statistics as well as examples. The generated
+        # report will be delivered asynchronously through a webhook with `event_type` =
+        # `auth_rules.performance_report.created`. See the docs on setting up
+        # [webhook subscriptions](https://docs.lithic.com/docs/events-api).
         #
-        #   Reports are generated based on data collected by Lithic's authorization
-        #   processing system in the trailing week. The performance of the auth rule will be
-        #   assessed on the configuration of the auth rule at the time the report is
-        #   requested. This implies that if a performance report is requested, right after
-        #   updating an auth rule, depending on the number of authorizations processed for a
-        #   card program, it may be the case that no data is available for the report.
-        #   Therefore Lithic recommends to decouple making updates to an Auth Rule, and
-        #   requesting performance reports.
+        # Reports are generated based on data collected by Lithic's authorization
+        # processing system in the trailing week. The performance of the auth rule will be
+        # assessed on the configuration of the auth rule at the time the report is
+        # requested. This implies that if a performance report is requested, right after
+        # updating an auth rule, depending on the number of authorizations processed for a
+        # card program, it may be the case that no data is available for the report.
+        # Therefore Lithic recommends to decouple making updates to an Auth Rule, and
+        # requesting performance reports.
         #
-        #   To make this concrete, consider the following example:
+        # To make this concrete, consider the following example:
         #
-        #   1. At time `t`, a new Auth Rule is created, and applies to all authorizations on
-        #      a card program. The Auth Rule has not yet been promoted, causing the draft
-        #      version of the rule to be applied in shadow mode.
-        #   2. At time `t + 1 hour` a performance report is requested for the Auth Rule.
-        #      This performance report will _only_ contain data for the Auth Rule being
-        #      executed in the window between `t` and `t + 1 hour`. This is because Lithic's
-        #      transaction processing system will only start capturing data for the Auth
-        #      Rule at the time it is created.
-        #   3. At time `t + 2 hours` the draft version of the Auth Rule is promoted to the
-        #      active version of the Auth Rule by calling the
-        #      `/v2/auth_rules/{auth_rule_token}/promote` endpoint. If a performance report
-        #      is requested at this moment it will still only contain data for this version
-        #      of the rule, but the window of available data will now span from `t` to
-        #      `t + 2 hours`.
-        #   4. At time `t + 3 hours` a new version of the rule is drafted by calling the
-        #      `/v2/auth_rules/{auth_rule_token}/draft` endpoint. If a performance report is
-        #      requested right at this moment, it will only contain data for authorizations
-        #      to which both the active version and the draft version is applied. Lithic
-        #      does this to ensure that performance reports represent a fair comparison
-        #      between rules. Because there may be no authorizations in this window, and
-        #      because there may be some lag before data is available in a performance
-        #      report, the requested performance report could contain no to little data.
-        #   5. At time `t + 4 hours` another performance report is requested: this time the
-        #      performance report will contain data from the window between `t + 3 hours`
-        #      and `t + 4 hours`, for any authorizations to which both the current version
-        #      of the authorization rule (in enforcing mode) and the draft version of the
-        #      authorization rule (in shadow mode) applied.
+        # 1. At time `t`, a new Auth Rule is created, and applies to all authorizations on
+        #    a card program. The Auth Rule has not yet been promoted, causing the draft
+        #    version of the rule to be applied in shadow mode.
+        # 2. At time `t + 1 hour` a performance report is requested for the Auth Rule.
+        #    This performance report will _only_ contain data for the Auth Rule being
+        #    executed in the window between `t` and `t + 1 hour`. This is because Lithic's
+        #    transaction processing system will only start capturing data for the Auth
+        #    Rule at the time it is created.
+        # 3. At time `t + 2 hours` the draft version of the Auth Rule is promoted to the
+        #    active version of the Auth Rule by calling the
+        #    `/v2/auth_rules/{auth_rule_token}/promote` endpoint. If a performance report
+        #    is requested at this moment it will still only contain data for this version
+        #    of the rule, but the window of available data will now span from `t` to
+        #    `t + 2 hours`.
+        # 4. At time `t + 3 hours` a new version of the rule is drafted by calling the
+        #    `/v2/auth_rules/{auth_rule_token}/draft` endpoint. If a performance report is
+        #    requested right at this moment, it will only contain data for authorizations
+        #    to which both the active version and the draft version is applied. Lithic
+        #    does this to ensure that performance reports represent a fair comparison
+        #    between rules. Because there may be no authorizations in this window, and
+        #    because there may be some lag before data is available in a performance
+        #    report, the requested performance report could contain no to little data.
+        # 5. At time `t + 4 hours` another performance report is requested: this time the
+        #    performance report will contain data from the window between `t + 3 hours`
+        #    and `t + 4 hours`, for any authorizations to which both the current version
+        #    of the authorization rule (in enforcing mode) and the draft version of the
+        #    authorization rule (in shadow mode) applied.
         #
-        #   Note that generating a report may take up to 15 minutes and that delivery is not
-        #   guaranteed. Customers are required to have created an event subscription to
-        #   receive the webhook. Additionally, there is a delay of approximately 15 minutes
-        #   between when Lithic's transaction processing systems have processed the
-        #   transaction, and when a transaction will be included in the report.
+        # Note that generating a report may take up to 15 minutes and that delivery is not
+        # guaranteed. Customers are required to have created an event subscription to
+        # receive the webhook. Additionally, there is a delay of approximately 15 minutes
+        # between when Lithic's transaction processing systems have processed the
+        # transaction, and when a transaction will be included in the report.
         sig do
           params(
             auth_rule_token: String,
@@ -279,13 +263,10 @@ module Lithic
           # Globally unique identifier for the Auth Rule.
           auth_rule_token,
           request_options: {}
-        )
-        end
-
+        ); end
         # @api private
         sig { params(client: Lithic::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
+        def self.new(client:); end
       end
     end
   end

data/rbi/lib/lithic/resources/auth_rules.rbi

@@ -8,8 +8,7 @@ module Lithic
 
       # @api private
       sig { params(client: Lithic::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
+      def self.new(client:); end
     end
   end
 end

data/rbi/lib/lithic/resources/auth_stream_enrollment.rbi

@@ -4,32 +4,29 @@ module Lithic
   module Resources
     class AuthStreamEnrollment
       # Retrieve the ASA HMAC secret key. If one does not exist for your program yet,
-      #   calling this endpoint will create one for you. The headers (which you can use to
-      #   verify webhooks) will begin appearing shortly after calling this endpoint for
-      #   the first time. See
-      #   [this page](https://docs.lithic.com/docs/auth-stream-access-asa#asa-webhook-verification)
-      #   for more detail about verifying ASA webhooks.
+      # calling this endpoint will create one for you. The headers (which you can use to
+      # verify webhooks) will begin appearing shortly after calling this endpoint for
+      # the first time. See
+      # [this page](https://docs.lithic.com/docs/auth-stream-access-asa#asa-webhook-verification)
+      # for more detail about verifying ASA webhooks.
       sig do
         params(request_options: T.nilable(T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash)))
           .returns(Lithic::Models::AuthStreamSecret)
       end
-      def retrieve_secret(request_options: {})
-      end
+      def retrieve_secret(request_options: {}); end
 
       # Generate a new ASA HMAC secret key. The old ASA HMAC secret key will be
-      #   deactivated 24 hours after a successful request to this endpoint. Make a
-      #   [`GET /auth_stream/secret`](https://docs.lithic.com/reference/getauthstreamsecret)
-      #   request to retrieve the new secret key.
+      # deactivated 24 hours after a successful request to this endpoint. Make a
+      # [`GET /auth_stream/secret`](https://docs.lithic.com/reference/getauthstreamsecret)
+      # request to retrieve the new secret key.
       sig do
         params(request_options: T.nilable(T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))).void
       end
-      def rotate_secret(request_options: {})
-      end
+      def rotate_secret(request_options: {}); end
 
       # @api private
       sig { params(client: Lithic::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
+      def self.new(client:); end
     end
   end
 end

data/rbi/lib/lithic/resources/balances.rbi

@@ -18,20 +18,17 @@ module Lithic
         # List balances for all financial accounts of a given account_token.
         account_token: nil,
         # UTC date and time of the balances to retrieve. Defaults to latest available
-        #   balances
+        # balances
         balance_date: nil,
         # List balances for all financial accounts of a given business_account_token.
         business_account_token: nil,
         # List balances for a given Financial Account type.
         financial_account_type: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # @api private
       sig { params(client: Lithic::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
+      def self.new(client:); end
     end
   end
 end

data/rbi/lib/lithic/resources/book_transfers.rbi

@@ -4,7 +4,7 @@ module Lithic
   module Resources
     class BookTransfers
       # Book transfer funds between two financial accounts or between a financial
-      #   account and card
+      # account and card
       sig do
         params(
           amount: Integer,
@@ -21,29 +21,27 @@ module Lithic
       end
       def create(
         # Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
-        #   This should always be a positive value.
+        # This should always be a positive value.
         amount:,
         # Category of the book transfer
         category:,
         # Globally unique identifier for the financial account or card that will send the
-        #   funds. Accepted type dependent on the program's use case.
+        # funds. Accepted type dependent on the program's use case.
         from_financial_account_token:,
         # The program specific subtype code for the specified category/type.
         subtype:,
         # Globally unique identifier for the financial account or card that will receive
-        #   the funds. Accepted type dependent on the program's use case.
+        # the funds. Accepted type dependent on the program's use case.
         to_financial_account_token:,
         # Type of book_transfer
         type:,
         # Customer-provided token that will serve as an idempotency token. This token will
-        #   become the transaction token.
+        # become the transaction token.
         token: nil,
         # Optional descriptor for the transfer.
         memo: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # Get book transfer by token
       sig do
         params(
@@ -56,9 +54,7 @@ module Lithic
         # Id of the book transfer to retrieve
         book_transfer_token,
         request_options: {}
-      )
-      end
-
+      ); end
       # List book transfers
       sig do
         params(
@@ -80,33 +76,31 @@ module Lithic
       def list(
         account_token: nil,
         # Date string in RFC 3339 format. Only entries created after the specified time
-        #   will be included. UTC time zone.
+        # will be included. UTC time zone.
         begin_: nil,
         business_account_token: nil,
         # Book Transfer 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.
+        # 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.
+        # Used to retrieve the previous page of results before this item.
         ending_before: nil,
         # Globally unique identifier for the financial account or card that will send the
-        #   funds. Accepted type dependent on the program's use case.
+        # funds. Accepted type dependent on the program's use case.
         financial_account_token: nil,
         # Page size (for pagination).
         page_size: nil,
         # Book transfer 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.
+        # begin. Used to retrieve the next page of results after this item.
         starting_after: nil,
         # Book transfer status to be returned.
         status: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # Reverse a book transfer
       sig do
         params(
@@ -122,13 +116,10 @@ module Lithic
         # Optional descriptor for the reversal.
         memo: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # @api private
       sig { params(client: Lithic::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
+      def self.new(client:); end
     end
   end
 end

data/rbi/lib/lithic/resources/card_programs.rbi

@@ -15,9 +15,7 @@ module Lithic
         # Globally unique identifier for the card program.
         card_program_token,
         request_options: {}
-      )
-      end
-
+      ); end
       # List card programs.
       sig do
         params(
@@ -30,21 +28,18 @@ module Lithic
       end
       def list(
         # 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.
+        # 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.
+        # begin. Used to retrieve the next page of results after this item.
         starting_after: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # @api private
       sig { params(client: Lithic::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
+      def self.new(client:); end
     end
   end
 end

data/rbi/lib/lithic/resources/cards/aggregate_balances.rbi

@@ -19,13 +19,10 @@ module Lithic
           # Business to retrieve aggregate balances for.
           business_account_token: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         # @api private
         sig { params(client: Lithic::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
+        def self.new(client:); end
       end
     end
   end

data/rbi/lib/lithic/resources/cards/balances.rbi

@@ -19,17 +19,14 @@ module Lithic
           # 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
+          # event_token of a $5 CARD_CLEARING financial event will return a balance
+          # decreased by $5
           last_transaction_event_token: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         # @api private
         sig { params(client: Lithic::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
+        def self.new(client:); end
       end
     end
   end