lithic 0.4.0 → 0.6.0

data/rbi/lithic/models/{digital_wallet_token_metadata.rbi → token_metadata.rbi}

@@ -2,20 +2,18 @@
 
 module Lithic
   module Models
-    class DigitalWalletTokenMetadata < Lithic::Internal::Type::BaseModel
+    class TokenMetadata < Lithic::Internal::Type::BaseModel
       OrHash =
-        T.type_alias do
-          T.any(Lithic::DigitalWalletTokenMetadata, Lithic::Internal::AnyHash)
-        end
+        T.type_alias { T.any(Lithic::TokenMetadata, Lithic::Internal::AnyHash) }
 
       # Contains the information of the account responsible for the payment.
-      sig { returns(Lithic::DigitalWalletTokenMetadata::PaymentAccountInfo) }
+      sig { returns(Lithic::TokenMetadata::PaymentAccountInfo) }
       attr_reader :payment_account_info
 
       sig do
         params(
           payment_account_info:
-            Lithic::DigitalWalletTokenMetadata::PaymentAccountInfo::OrHash
+            Lithic::TokenMetadata::PaymentAccountInfo::OrHash
         ).void
       end
       attr_writer :payment_account_info
@@ -39,9 +37,7 @@ module Lithic
       # Human-readable name of the wallet that the token_requestor_id maps to.
       sig do
         returns(
-          T.nilable(
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
-          )
+          T.nilable(Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol)
         )
       end
       attr_reader :token_requestor_name
@@ -49,7 +45,7 @@ module Lithic
       sig do
         params(
           token_requestor_name:
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::OrSymbol
+            Lithic::TokenMetadata::TokenRequestorName::OrSymbol
         ).void
       end
       attr_writer :token_requestor_name
@@ -58,12 +54,12 @@ module Lithic
       sig do
         params(
           payment_account_info:
-            Lithic::DigitalWalletTokenMetadata::PaymentAccountInfo::OrHash,
+            Lithic::TokenMetadata::PaymentAccountInfo::OrHash,
           status: String,
           payment_app_instance_id: T.nilable(String),
           token_requestor_id: String,
           token_requestor_name:
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::OrSymbol
+            Lithic::TokenMetadata::TokenRequestorName::OrSymbol
         ).returns(T.attached_class)
       end
       def self.new(
@@ -84,13 +80,12 @@ module Lithic
       sig do
         override.returns(
           {
-            payment_account_info:
-              Lithic::DigitalWalletTokenMetadata::PaymentAccountInfo,
+            payment_account_info: Lithic::TokenMetadata::PaymentAccountInfo,
             status: String,
             payment_app_instance_id: T.nilable(String),
             token_requestor_id: String,
             token_requestor_name:
-              Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+              Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           }
         )
       end
@@ -101,7 +96,7 @@ module Lithic
         OrHash =
           T.type_alias do
             T.any(
-              Lithic::DigitalWalletTokenMetadata::PaymentAccountInfo,
+              Lithic::TokenMetadata::PaymentAccountInfo,
               Lithic::Internal::AnyHash
             )
           end
@@ -109,16 +104,14 @@ module Lithic
         # Additional information that can be used to identify the account holder, such as
         # name, address, etc
         sig do
-          returns(
-            Lithic::DigitalWalletTokenMetadata::PaymentAccountInfo::AccountHolderData
-          )
+          returns(Lithic::TokenMetadata::PaymentAccountInfo::AccountHolderData)
         end
         attr_reader :account_holder_data
 
         sig do
           params(
             account_holder_data:
-              Lithic::DigitalWalletTokenMetadata::PaymentAccountInfo::AccountHolderData::OrHash
+              Lithic::TokenMetadata::PaymentAccountInfo::AccountHolderData::OrHash
           ).void
         end
         attr_writer :account_holder_data
@@ -140,7 +133,7 @@ module Lithic
         sig do
           params(
             account_holder_data:
-              Lithic::DigitalWalletTokenMetadata::PaymentAccountInfo::AccountHolderData::OrHash,
+              Lithic::TokenMetadata::PaymentAccountInfo::AccountHolderData::OrHash,
             pan_unique_reference: T.nilable(String),
             payment_account_reference: T.nilable(String),
             token_unique_reference: T.nilable(String)
@@ -164,7 +157,7 @@ module Lithic
           override.returns(
             {
               account_holder_data:
-                Lithic::DigitalWalletTokenMetadata::PaymentAccountInfo::AccountHolderData,
+                Lithic::TokenMetadata::PaymentAccountInfo::AccountHolderData,
               pan_unique_reference: T.nilable(String),
               payment_account_reference: T.nilable(String),
               token_unique_reference: T.nilable(String)
@@ -178,7 +171,7 @@ module Lithic
           OrHash =
             T.type_alias do
               T.any(
-                Lithic::DigitalWalletTokenMetadata::PaymentAccountInfo::AccountHolderData,
+                Lithic::TokenMetadata::PaymentAccountInfo::AccountHolderData,
                 Lithic::Internal::AnyHash
               )
             end
@@ -212,74 +205,74 @@ module Lithic
 
         TaggedSymbol =
           T.type_alias do
-            T.all(
-              Symbol,
-              Lithic::DigitalWalletTokenMetadata::TokenRequestorName
-            )
+            T.all(Symbol, Lithic::TokenMetadata::TokenRequestorName)
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         AMAZON_ONE =
           T.let(
             :AMAZON_ONE,
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           )
         ANDROID_PAY =
           T.let(
             :ANDROID_PAY,
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           )
         APPLE_PAY =
           T.let(
             :APPLE_PAY,
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           )
         FACEBOOK =
           T.let(
             :FACEBOOK,
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           )
         FITBIT_PAY =
           T.let(
             :FITBIT_PAY,
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           )
         GARMIN_PAY =
           T.let(
             :GARMIN_PAY,
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
+          )
+        GOOGLE_PAY =
+          T.let(
+            :GOOGLE_PAY,
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           )
         MICROSOFT_PAY =
           T.let(
             :MICROSOFT_PAY,
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           )
         NETFLIX =
           T.let(
             :NETFLIX,
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           )
         SAMSUNG_PAY =
           T.let(
             :SAMSUNG_PAY,
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           )
         UNKNOWN =
           T.let(
             :UNKNOWN,
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           )
         VISA_CHECKOUT =
           T.let(
             :VISA_CHECKOUT,
-            Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
+            Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol
           )
 
         sig do
           override.returns(
-            T::Array[
-              Lithic::DigitalWalletTokenMetadata::TokenRequestorName::TaggedSymbol
-            ]
+            T::Array[Lithic::TokenMetadata::TokenRequestorName::TaggedSymbol]
           )
         end
         def self.values

data/rbi/lithic/models/tokenization_approval_request_webhook_event.rbi

@@ -60,6 +60,13 @@ module Lithic
       end
       attr_accessor :issuer_decision
 
+      # Contains the metadata for the digital wallet being tokenized.
+      sig { returns(Lithic::TokenMetadata) }
+      attr_reader :token_metadata
+
+      sig { params(token_metadata: Lithic::TokenMetadata::OrHash).void }
+      attr_writer :token_metadata
+
       # The channel through which the tokenization was made.
       sig do
         returns(
@@ -88,18 +95,6 @@ module Lithic
       sig { params(device: Lithic::Device::OrHash).void }
       attr_writer :device
 
-      # Contains the metadata for the digital wallet being tokenized.
-      sig { returns(T.nilable(Lithic::DigitalWalletTokenMetadata)) }
-      attr_reader :digital_wallet_token_metadata
-
-      sig do
-        params(
-          digital_wallet_token_metadata:
-            Lithic::DigitalWalletTokenMetadata::OrHash
-        ).void
-      end
-      attr_writer :digital_wallet_token_metadata
-
       # Results from rules that were evaluated for this tokenization
       sig { returns(T.nilable(T::Array[Lithic::TokenizationRuleResult])) }
       attr_reader :rule_results
@@ -174,13 +169,12 @@ module Lithic
             Lithic::TokenizationApprovalRequestWebhookEvent::EventType::OrSymbol,
           issuer_decision:
             Lithic::TokenizationApprovalRequestWebhookEvent::IssuerDecision::OrSymbol,
+          token_metadata: Lithic::TokenMetadata::OrHash,
           tokenization_channel:
             Lithic::TokenizationApprovalRequestWebhookEvent::TokenizationChannel::OrSymbol,
           tokenization_token: String,
           wallet_decisioning_info: Lithic::WalletDecisioningInfo::OrHash,
           device: Lithic::Device::OrHash,
-          digital_wallet_token_metadata:
-            Lithic::DigitalWalletTokenMetadata::OrHash,
           rule_results: T::Array[Lithic::TokenizationRuleResult::OrHash],
           tokenization_decline_reasons:
             T::Array[Lithic::TokenizationDeclineReason::OrSymbol],
@@ -204,14 +198,14 @@ module Lithic
         # Whether Lithic decisioned on the token, and if so, what the decision was.
         # APPROVED/VERIFICATION_REQUIRED/DENIED.
         issuer_decision:,
+        # Contains the metadata for the digital wallet being tokenized.
+        token_metadata:,
         # The channel through which the tokenization was made.
         tokenization_channel:,
         # Unique identifier for the digital wallet token attempt
         tokenization_token:,
         wallet_decisioning_info:,
         device: nil,
-        # Contains the metadata for the digital wallet being tokenized.
-        digital_wallet_token_metadata: nil,
         # Results from rules that were evaluated for this tokenization
         rule_results: nil,
         # List of reasons why the tokenization was declined
@@ -237,12 +231,12 @@ module Lithic
               Lithic::TokenizationApprovalRequestWebhookEvent::EventType::TaggedSymbol,
             issuer_decision:
               Lithic::TokenizationApprovalRequestWebhookEvent::IssuerDecision::TaggedSymbol,
+            token_metadata: Lithic::TokenMetadata,
             tokenization_channel:
               Lithic::TokenizationApprovalRequestWebhookEvent::TokenizationChannel::TaggedSymbol,
             tokenization_token: String,
             wallet_decisioning_info: Lithic::WalletDecisioningInfo,
             device: Lithic::Device,
-            digital_wallet_token_metadata: Lithic::DigitalWalletTokenMetadata,
             rule_results: T::Array[Lithic::TokenizationRuleResult],
             tokenization_decline_reasons:
               T::Array[Lithic::TokenizationDeclineReason::TaggedSymbol],

data/rbi/lithic/models/tokenization_decisioning_request_webhook_event.rbi

@@ -23,6 +23,17 @@ module Lithic
       sig { returns(Time) }
       attr_accessor :created
 
+      # Contains the metadata for the digital wallet being tokenized.
+      sig { returns(Lithic::TokenMetadata) }
+      attr_reader :digital_wallet_token_metadata
+
+      sig do
+        params(
+          digital_wallet_token_metadata: Lithic::TokenMetadata::OrHash
+        ).void
+      end
+      attr_writer :digital_wallet_token_metadata
+
       # The name of this event
       sig do
         returns(
@@ -68,18 +79,6 @@ module Lithic
       sig { params(device: Lithic::Device::OrHash).void }
       attr_writer :device
 
-      # Contains the metadata for the digital wallet being tokenized.
-      sig { returns(T.nilable(Lithic::DigitalWalletTokenMetadata)) }
-      attr_reader :digital_wallet_token_metadata
-
-      sig do
-        params(
-          digital_wallet_token_metadata:
-            Lithic::DigitalWalletTokenMetadata::OrHash
-        ).void
-      end
-      attr_writer :digital_wallet_token_metadata
-
       # The source of the tokenization.
       sig do
         returns(
@@ -104,6 +103,7 @@ module Lithic
           account_token: String,
           card_token: String,
           created: Time,
+          digital_wallet_token_metadata: Lithic::TokenMetadata::OrHash,
           event_type:
             Lithic::TokenizationDecisioningRequestWebhookEvent::EventType::OrSymbol,
           issuer_decision:
@@ -113,8 +113,6 @@ module Lithic
           tokenization_token: String,
           wallet_decisioning_info: Lithic::WalletDecisioningInfo::OrHash,
           device: Lithic::Device::OrHash,
-          digital_wallet_token_metadata:
-            Lithic::DigitalWalletTokenMetadata::OrHash,
           tokenization_source:
             Lithic::TokenizationDecisioningRequestWebhookEvent::TokenizationSource::OrSymbol
         ).returns(T.attached_class)
@@ -126,6 +124,8 @@ module Lithic
         card_token:,
         # Indicate when the request was received from Mastercard or Visa
         created:,
+        # Contains the metadata for the digital wallet being tokenized.
+        digital_wallet_token_metadata:,
         # The name of this event
         event_type:,
         # Whether Lithic decisioned on the token, and if so, what the decision was.
@@ -137,8 +137,6 @@ module Lithic
         tokenization_token:,
         wallet_decisioning_info:,
         device: nil,
-        # Contains the metadata for the digital wallet being tokenized.
-        digital_wallet_token_metadata: nil,
         # The source of the tokenization.
         tokenization_source: nil
       )
@@ -150,6 +148,7 @@ module Lithic
             account_token: String,
             card_token: String,
             created: Time,
+            digital_wallet_token_metadata: Lithic::TokenMetadata,
             event_type:
               Lithic::TokenizationDecisioningRequestWebhookEvent::EventType::TaggedSymbol,
             issuer_decision:
@@ -159,7 +158,6 @@ module Lithic
             tokenization_token: String,
             wallet_decisioning_info: Lithic::WalletDecisioningInfo,
             device: Lithic::Device,
-            digital_wallet_token_metadata: Lithic::DigitalWalletTokenMetadata,
             tokenization_source:
               Lithic::TokenizationDecisioningRequestWebhookEvent::TokenizationSource::TaggedSymbol
           }

data/rbi/lithic/models.rbi

@@ -30,6 +30,8 @@ module Lithic
 
   AccountHolderRetrieveParams = Lithic::Models::AccountHolderRetrieveParams
 
+  AccountHolders = Lithic::Models::AccountHolders
+
   AccountHolderSimulateEnrollmentDocumentReviewParams =
     Lithic::Models::AccountHolderSimulateEnrollmentDocumentReviewParams
 
@@ -206,8 +208,6 @@ module Lithic
   DigitalWalletTokenizationUpdatedWebhookEvent =
     Lithic::Models::DigitalWalletTokenizationUpdatedWebhookEvent
 
-  DigitalWalletTokenMetadata = Lithic::Models::DigitalWalletTokenMetadata
-
   Dispute = Lithic::Models::Dispute
 
   DisputeCreateParams = Lithic::Models::DisputeCreateParams
@@ -561,6 +561,8 @@ module Lithic
   TokenizationUpdatedWebhookEvent =
     Lithic::Models::TokenizationUpdatedWebhookEvent
 
+  TokenMetadata = Lithic::Models::TokenMetadata
+
   Transaction = Lithic::Models::Transaction
 
   TransactionExpireAuthorizationParams =

data/rbi/lithic/resources/account_holders/entities.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class AccountHolders
+      class Entities
+        # Create a new beneficial owner or replace the control person entity on an
+        # existing KYB account holder. This endpoint is only applicable for account
+        # holders enrolled through a KYB workflow with the Persona KYB provider. A new
+        # control person can only replace the existing one. A maximum of 4 beneficial
+        # owners can be associated with an account holder.
+        sig do
+          params(
+            account_holder_token: String,
+            address:
+              Lithic::AccountHolders::EntityCreateParams::Address::OrHash,
+            dob: String,
+            email: String,
+            first_name: String,
+            government_id: String,
+            last_name: String,
+            phone_number: String,
+            type: Lithic::AccountHolders::EntityCreateParams::Type::OrSymbol,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(Lithic::Models::AccountHolders::EntityCreateResponse)
+        end
+        def create(
+          # Globally unique identifier for the account holder.
+          account_holder_token,
+          # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+          address:,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob:,
+          # Individual's email address. If utilizing Lithic for chargeback processing, this
+          # customer email address may be used to communicate dispute status and resolution.
+          email:,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name:,
+          # Government-issued identification number (required for identity verification and
+          # compliance with banking regulations). Social Security Numbers (SSN) and
+          # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+          # entered as full nine-digits, with or without hyphens
+          government_id:,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name:,
+          # Individual's phone number, entered in E.164 format.
+          phone_number:,
+          # The type of entity to create on the account holder
+          type:,
+          request_options: {}
+        )
+        end
+
+        # Deactivate a beneficial owner entity on an existing KYB account holder. Only
+        # beneficial owner entities can be deactivated.
+        sig do
+          params(
+            entity_token: String,
+            account_holder_token: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(Lithic::AccountHolders::AccountHolderEntity)
+        end
+        def delete(
+          # Globally unique identifier for the entity.
+          entity_token,
+          # Globally unique identifier for the account holder.
+          account_holder_token:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Lithic::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/resources/account_holders.rbi

@@ -3,6 +3,9 @@
 module Lithic
   module Resources
     class AccountHolders
+      sig { returns(Lithic::Resources::AccountHolders::Entities) }
+      attr_reader :entities
+
       # Create an account holder and initiate the appropriate onboarding workflow.
       # Account holders and accounts have a 1:1 relationship. When an account holder is
       # successfully created an associated account is also created. All calls to this
@@ -38,6 +41,7 @@ module Lithic
             ],
           external_id: String,
           kyb_passed_timestamp: String,
+          naics_code: String,
           website_url: String,
           kyc_passed_timestamp: String,
           business_account_token: String,
@@ -98,6 +102,9 @@ module Lithic
         #
         # This field is required only if workflow type is `KYB_BYO`.
         kyb_passed_timestamp: nil,
+        # 6-digit North American Industry Classification System (NAICS) code for the
+        # business.
+        naics_code: nil,
         # Company website URL.
         website_url: nil,
         # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
@@ -154,6 +161,7 @@ module Lithic
           control_person:
             Lithic::AccountHolderUpdateParams::ControlPerson::OrHash,
           external_id: String,
+          naics_code: String,
           nature_of_business: String,
           website_url: String,
           individual: Lithic::AccountHolderUpdateParams::Individual::OrHash,
@@ -194,6 +202,9 @@ module Lithic
         # A user provided id that can be used to link an account holder with an external
         # system
         external_id: nil,
+        # 6-digit North American Industry Classification System (NAICS) code for the
+        # business.
+        naics_code: nil,
         # Short description of the company's line of business (i.e., what does the company
         # do?).
         nature_of_business: nil,

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

@@ -39,7 +39,8 @@ module Lithic
           # several event streams, the effective one is defined by the separate
           # `event_stream` field.
           #
-          # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
+          # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
+          #   AUTHORIZATION event stream.
           # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
           # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
           # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -198,6 +199,48 @@ module Lithic
         )
         end
 
+        # Lists Auth Rule evaluation results.
+        #
+        # **Limitations:**
+        #
+        # - Results are available for the past 3 months only
+        # - At least one filter (`event_token` or `auth_rule_token`) must be provided
+        # - When filtering by `event_token`, pagination is not supported
+        sig do
+          params(
+            auth_rule_token: String,
+            ending_before: String,
+            event_token: String,
+            has_actions: T::Boolean,
+            page_size: Integer,
+            starting_after: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(
+            Lithic::Internal::CursorPage[
+              Lithic::Models::AuthRules::V2ListResultsResponse::Variants
+            ]
+          )
+        end
+        def list_results(
+          # Filter by Auth Rule token
+          auth_rule_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,
+          # Filter by event token
+          event_token: nil,
+          # Filter by whether the rule evaluation produced any actions. When not provided,
+          # all results are returned.
+          has_actions: 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
+
         # Promotes the draft version of an Auth rule to the currently active version such
         # that it is enforced in the respective stream.
         sig do

data/rbi/lithic/resources/book_transfers.rbi

@@ -15,6 +15,7 @@ module Lithic
           type: Lithic::BookTransferCreateParams::Type::OrSymbol,
           token: String,
           external_id: String,
+          hold_token: String,
           memo: String,
           on_closed_account:
             Lithic::BookTransferCreateParams::OnClosedAccount::OrSymbol,
@@ -41,6 +42,8 @@ module Lithic
         token: nil,
         # External ID defined by the customer
         external_id: nil,
+        # Token of an existing hold to settle when this transfer is initiated
+        hold_token: nil,
         # Optional descriptor for the transfer.
         memo: nil,
         # What to do if the financial account is closed when posting an operation