lithic 0.1.0.pre.alpha.30 → 0.1.0.pre.alpha.32

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

@@ -7,7 +7,7 @@ module Lithic
         sig { returns(Lithic::Resources::AuthRules::V2::Backtests) }
         attr_reader :backtests
 
-        # Creates a new V2 authorization rule in draft mode
+        # Creates a new V2 Auth rule in draft mode
         sig do
           params(
             account_tokens: T::Array[String],
@@ -18,7 +18,8 @@ module Lithic
               T.any(
                 Lithic::AuthRules::ConditionalBlockParameters::OrHash,
                 Lithic::AuthRules::VelocityLimitParams::OrHash,
-                Lithic::AuthRules::V2CreateParams::Parameters::MerchantLockParameters::OrHash
+                Lithic::AuthRules::V2CreateParams::Parameters::MerchantLockParameters::OrHash,
+                Lithic::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters::OrHash
               ),
             type: Lithic::AuthRules::V2CreateParams::Type::OrSymbol,
             excluded_card_tokens: T::Array[String],
@@ -36,7 +37,13 @@ module Lithic
           name: nil,
           # Parameters for the Auth Rule
           parameters: nil,
-          # The type of Auth Rule
+          # The type of Auth Rule. Effectively determines the event stream during which it
+          # will be evaluated.
+          #
+          # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
+          # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
+          # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
+          # - `CONDITIONAL_3DS_ACTION`: THREE_DS_AUTHENTICATION event stream.
           type: nil,
           # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil,
@@ -44,7 +51,7 @@ module Lithic
         )
         end
 
-        # Fetches a V2 authorization rule by its token
+        # Fetches a V2 Auth rule by its token
         sig do
           params(
             auth_rule_token: String,
@@ -58,7 +65,7 @@ module Lithic
         )
         end
 
-        # Updates a V2 authorization rule's properties
+        # Updates a V2 Auth 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
@@ -98,12 +105,14 @@ module Lithic
         )
         end
 
-        # Lists V2 authorization rules
+        # Lists V2 Auth rules
         sig do
           params(
             account_token: String,
             card_token: String,
             ending_before: String,
+            event_stream:
+              Lithic::AuthRules::V2ListParams::EventStream::OrSymbol,
             page_size: Integer,
             scope: Lithic::AuthRules::V2ListParams::Scope::OrSymbol,
             starting_after: String,
@@ -115,16 +124,18 @@ module Lithic
           )
         end
         def list(
-          # Only return Authorization Rules that are bound to the provided account token.
+          # Only return Auth Rules that are bound to the provided account token.
           account_token: nil,
-          # Only return Authorization Rules that are bound to the provided card token.
+          # Only return Auth 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,
+          # Only return Auth rules that are executed during the provided event stream.
+          event_stream: nil,
           # Page size (for pagination).
           page_size: nil,
-          # Only return Authorization Rules that are bound to the provided scope;
+          # Only return Auth Rules that are bound to the provided scope.
           scope: 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.
@@ -133,7 +144,7 @@ module Lithic
         )
         end
 
-        # Deletes a V2 authorization rule
+        # Deletes a V2 Auth rule
         sig do
           params(
             auth_rule_token: String,
@@ -147,8 +158,8 @@ module Lithic
         )
         end
 
-        # Associates a V2 authorization rule with a card program, the provided account(s)
-        # or card(s).
+        # Associates a V2 Auth rule with a card program, the provided account(s) or
+        # card(s).
         #
         # Prefer using the `PATCH` method for this operation.
         sig do
@@ -188,7 +199,8 @@ module Lithic
                 T.any(
                   Lithic::AuthRules::ConditionalBlockParameters::OrHash,
                   Lithic::AuthRules::VelocityLimitParams::OrHash,
-                  Lithic::AuthRules::V2DraftParams::Parameters::MerchantLockParameters::OrHash
+                  Lithic::AuthRules::V2DraftParams::Parameters::MerchantLockParameters::OrHash,
+                  Lithic::AuthRules::V2DraftParams::Parameters::Conditional3DSActionParameters::OrHash
                 )
               ),
             request_options: Lithic::RequestOptions::OrHash
@@ -203,8 +215,8 @@ module Lithic
         )
         end
 
-        # Promotes the draft version of an authorization rule to the currently active
-        # version such that it is enforced in the authorization stream.
+        # Promotes the draft version of an Auth rule to the currently active version such
+        # that it is enforced in the respective stream.
         sig do
           params(
             auth_rule_token: String,
@@ -218,26 +230,25 @@ module Lithic
         )
         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` =
+        # Requests a performance report of an Auth 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).
         #
-        # 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 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 events 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:
         #
-        # 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
+        # 1. At time `t`, a new Auth Rule is created, and applies to all auth events 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
@@ -252,17 +263,17 @@ module Lithic
         #    `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.
+        #    requested right at this moment, it will only contain data for events 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 events 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.
+        #    and `t + 4 hours`, for any events to which both the current version of the
+        #    Auth rule (in enforcing mode) and the draft version of the Auth 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

data/rbi/lithic/resources/financial_accounts.rbi

@@ -88,6 +88,22 @@ module Lithic
       )
       end
 
+      # Register account number
+      sig do
+        params(
+          financial_account_token: String,
+          account_number: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).void
+      end
+      def register_account_number(
+        # Globally unique identifier for financial account.
+        financial_account_token,
+        account_number:,
+        request_options: {}
+      )
+      end
+
       # Update financial account status
       sig do
         params(

data/rbi/lithic/resources/three_ds/authentication.rbi

@@ -21,7 +21,9 @@ module Lithic
         # Simulates a 3DS authentication request from the payment network as if it came
         # from an ACS. If you're configured for 3DS Customer Decisioning, simulating
         # authentications requires your customer decisioning endpoint to be set up
-        # properly (respond with a valid JSON).
+        # properly (respond with a valid JSON). If the authentication decision is to
+        # challenge, ensure that the account holder associated with the card transaction
+        # has a valid phone number configured to receive the OTP code via SMS.
         sig do
           params(
             merchant:

data/sig/lithic/models/account_update_params.rbs

@@ -56,13 +56,14 @@ module Lithic
         request_options: Lithic::RequestOptions
       }
 
-      type state = :ACTIVE | :PAUSED
+      type state = :ACTIVE | :PAUSED | :CLOSED
 
       module State
         extend Lithic::Internal::Type::Enum
 
         ACTIVE: :ACTIVE
         PAUSED: :PAUSED
+        CLOSED: :CLOSED
 
         def self?.values: -> ::Array[Lithic::Models::AccountUpdateParams::state]
       end

data/sig/lithic/models/auth_rules/v2/backtest_results.rbs

@@ -52,6 +52,7 @@ module Lithic
             type current_version =
               {
                 approved: Integer,
+                challenged: Integer,
                 declined: Integer,
                 examples: ::Array[Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example],
                 version: Integer
@@ -62,6 +63,10 @@ module Lithic
 
               def approved=: (Integer) -> Integer
 
+              attr_reader challenged: Integer?
+
+              def challenged=: (Integer) -> Integer
+
               attr_reader declined: Integer?
 
               def declined=: (Integer) -> Integer
@@ -78,6 +83,7 @@ module Lithic
 
               def initialize: (
                 ?approved: Integer,
+                ?challenged: Integer,
                 ?declined: Integer,
                 ?examples: ::Array[Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example],
                 ?version: Integer
@@ -85,19 +91,31 @@ module Lithic
 
               def to_hash: -> {
                 approved: Integer,
+                challenged: Integer,
                 declined: Integer,
                 examples: ::Array[Lithic::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example],
                 version: Integer
               }
 
               type example =
-                { approved: bool, event_token: String, timestamp: Time }
+                {
+                  approved: bool,
+                  decision: Lithic::Models::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::decision,
+                  event_token: String,
+                  timestamp: Time
+                }
 
               class Example < Lithic::Internal::Type::BaseModel
                 attr_reader approved: bool?
 
                 def approved=: (bool) -> bool
 
+                attr_reader decision: Lithic::Models::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::decision?
+
+                def decision=: (
+                  Lithic::Models::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::decision
+                ) -> Lithic::Models::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::decision
+
                 attr_reader event_token: String?
 
                 def event_token=: (String) -> String
@@ -108,21 +126,36 @@ module Lithic
 
                 def initialize: (
                   ?approved: bool,
+                  ?decision: Lithic::Models::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::decision,
                   ?event_token: String,
                   ?timestamp: Time
                 ) -> void
 
                 def to_hash: -> {
                   approved: bool,
+                  decision: Lithic::Models::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::decision,
                   event_token: String,
                   timestamp: Time
                 }
+
+                type decision = :APPROVED | :DECLINED | :CHALLENGED
+
+                module Decision
+                  extend Lithic::Internal::Type::Enum
+
+                  APPROVED: :APPROVED
+                  DECLINED: :DECLINED
+                  CHALLENGED: :CHALLENGED
+
+                  def self?.values: -> ::Array[Lithic::Models::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example::decision]
+                end
               end
             end
 
             type draft_version =
               {
                 approved: Integer,
+                challenged: Integer,
                 declined: Integer,
                 examples: ::Array[Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example],
                 version: Integer
@@ -133,6 +166,10 @@ module Lithic
 
               def approved=: (Integer) -> Integer
 
+              attr_reader challenged: Integer?
+
+              def challenged=: (Integer) -> Integer
+
               attr_reader declined: Integer?
 
               def declined=: (Integer) -> Integer
@@ -149,6 +186,7 @@ module Lithic
 
               def initialize: (
                 ?approved: Integer,
+                ?challenged: Integer,
                 ?declined: Integer,
                 ?examples: ::Array[Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example],
                 ?version: Integer
@@ -156,19 +194,31 @@ module Lithic
 
               def to_hash: -> {
                 approved: Integer,
+                challenged: Integer,
                 declined: Integer,
                 examples: ::Array[Lithic::AuthRules::V2::BacktestResults::Results::DraftVersion::Example],
                 version: Integer
               }
 
               type example =
-                { approved: bool, event_token: String, timestamp: Time }
+                {
+                  approved: bool,
+                  decision: Lithic::Models::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::decision,
+                  event_token: String,
+                  timestamp: Time
+                }
 
               class Example < Lithic::Internal::Type::BaseModel
                 attr_reader approved: bool?
 
                 def approved=: (bool) -> bool
 
+                attr_reader decision: Lithic::Models::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::decision?
+
+                def decision=: (
+                  Lithic::Models::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::decision
+                ) -> Lithic::Models::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::decision
+
                 attr_reader event_token: String?
 
                 def event_token=: (String) -> String
@@ -179,15 +229,29 @@ module Lithic
 
                 def initialize: (
                   ?approved: bool,
+                  ?decision: Lithic::Models::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::decision,
                   ?event_token: String,
                   ?timestamp: Time
                 ) -> void
 
                 def to_hash: -> {
                   approved: bool,
+                  decision: Lithic::Models::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::decision,
                   event_token: String,
                   timestamp: Time
                 }
+
+                type decision = :APPROVED | :DECLINED | :CHALLENGED
+
+                module Decision
+                  extend Lithic::Internal::Type::Enum
+
+                  APPROVED: :APPROVED
+                  DECLINED: :DECLINED
+                  CHALLENGED: :CHALLENGED
+
+                  def self?.values: -> ::Array[Lithic::Models::AuthRules::V2::BacktestResults::Results::DraftVersion::Example::decision]
+                end
               end
             end
           end