lithic 0.5.0 → 0.7.0

data/rbi/lithic/models/account_holders/entity_create_response.rbi

@@ -0,0 +1,292 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module AccountHolders
+      class EntityCreateResponse < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::Models::AccountHolders::EntityCreateResponse,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Globally unique identifier for the entity
+        sig { returns(String) }
+        attr_accessor :token
+
+        # Globally unique identifier for the account holder
+        sig { returns(String) }
+        attr_accessor :account_holder_token
+
+        # Timestamp of when the entity was created
+        sig { returns(Time) }
+        attr_accessor :created
+
+        # A list of documents required for the entity to be approved
+        sig { returns(T::Array[Lithic::RequiredDocument]) }
+        attr_accessor :required_documents
+
+        # Entity verification status
+        sig do
+          returns(
+            Lithic::Models::AccountHolders::EntityCreateResponse::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # Reason for the evaluation status
+        sig do
+          returns(
+            T::Array[
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            ]
+          )
+        end
+        attr_accessor :status_reasons
+
+        # Response body for creating a new beneficial owner or replacing the control
+        # person entity on an existing KYB account holder.
+        sig do
+          params(
+            token: String,
+            account_holder_token: String,
+            created: Time,
+            required_documents: T::Array[Lithic::RequiredDocument::OrHash],
+            status:
+              Lithic::Models::AccountHolders::EntityCreateResponse::Status::OrSymbol,
+            status_reasons:
+              T::Array[
+                Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::OrSymbol
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Globally unique identifier for the entity
+          token:,
+          # Globally unique identifier for the account holder
+          account_holder_token:,
+          # Timestamp of when the entity was created
+          created:,
+          # A list of documents required for the entity to be approved
+          required_documents:,
+          # Entity verification status
+          status:,
+          # Reason for the evaluation status
+          status_reasons:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              token: String,
+              account_holder_token: String,
+              created: Time,
+              required_documents: T::Array[Lithic::RequiredDocument],
+              status:
+                Lithic::Models::AccountHolders::EntityCreateResponse::Status::TaggedSymbol,
+              status_reasons:
+                T::Array[
+                  Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Entity verification status
+        module Status
+          extend Lithic::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Lithic::Models::AccountHolders::EntityCreateResponse::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACCEPTED =
+            T.let(
+              :ACCEPTED,
+              Lithic::Models::AccountHolders::EntityCreateResponse::Status::TaggedSymbol
+            )
+          INACTIVE =
+            T.let(
+              :INACTIVE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::Status::TaggedSymbol
+            )
+          PENDING_REVIEW =
+            T.let(
+              :PENDING_REVIEW,
+              Lithic::Models::AccountHolders::EntityCreateResponse::Status::TaggedSymbol
+            )
+          REJECTED =
+            T.let(
+              :REJECTED,
+              Lithic::Models::AccountHolders::EntityCreateResponse::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Lithic::Models::AccountHolders::EntityCreateResponse::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Status Reasons for KYC/KYB enrollment states
+        module StatusReason
+          extend Lithic::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ADDRESS_VERIFICATION_FAILURE =
+            T.let(
+              :ADDRESS_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          AGE_THRESHOLD_FAILURE =
+            T.let(
+              :AGE_THRESHOLD_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          COMPLETE_VERIFICATION_FAILURE =
+            T.let(
+              :COMPLETE_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          DOB_VERIFICATION_FAILURE =
+            T.let(
+              :DOB_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          ID_VERIFICATION_FAILURE =
+            T.let(
+              :ID_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          MAX_DOCUMENT_ATTEMPTS =
+            T.let(
+              :MAX_DOCUMENT_ATTEMPTS,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          MAX_RESUBMISSION_ATTEMPTS =
+            T.let(
+              :MAX_RESUBMISSION_ATTEMPTS,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          NAME_VERIFICATION_FAILURE =
+            T.let(
+              :NAME_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          OTHER_VERIFICATION_FAILURE =
+            T.let(
+              :OTHER_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          RISK_THRESHOLD_FAILURE =
+            T.let(
+              :RISK_THRESHOLD_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          WATCHLIST_ALERT_FAILURE =
+            T.let(
+              :WATCHLIST_ALERT_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE =
+            T.let(
+              :PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE =
+            T.let(
+              :PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE =
+            T.let(
+              :PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED =
+            T.let(
+              :PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE =
+            T.let(
+              :PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED =
+            T.let(
+              :PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE =
+            T.let(
+              :PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE =
+            T.let(
+              :PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE =
+            T.let(
+              :PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE =
+            T.let(
+              :CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          CONTROL_PERSON_ID_VERIFICATION_FAILURE =
+            T.let(
+              :CONTROL_PERSON_ID_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          CONTROL_PERSON_DOB_VERIFICATION_FAILURE =
+            T.let(
+              :CONTROL_PERSON_DOB_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+          CONTROL_PERSON_NAME_VERIFICATION_FAILURE =
+            T.let(
+              :CONTROL_PERSON_NAME_VERIFICATION_FAILURE,
+              Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/account_holders/entity_delete_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module AccountHolders
+      class EntityDeleteParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::AccountHolders::EntityDeleteParams,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :account_holder_token
+
+        sig { returns(String) }
+        attr_accessor :entity_token
+
+        sig do
+          params(
+            account_holder_token: String,
+            entity_token: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(account_holder_token:, entity_token:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              account_holder_token: String,
+              entity_token: String,
+              request_options: Lithic::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/account_retrieve_params.rbi

@@ -11,15 +11,23 @@ module Lithic
           T.any(Lithic::AccountRetrieveParams, Lithic::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :account_token
+
       sig do
-        params(request_options: Lithic::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          account_token: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(account_token:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Lithic::RequestOptions }) }
+      sig do
+        override.returns(
+          { account_token: String, request_options: Lithic::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/lithic/models/account_retrieve_spend_limits_params.rbi

@@ -14,15 +14,23 @@ module Lithic
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :account_token
+
       sig do
-        params(request_options: Lithic::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          account_token: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(account_token:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Lithic::RequestOptions }) }
+      sig do
+        override.returns(
+          { account_token: String, request_options: Lithic::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/lithic/models/account_update_params.rbi

@@ -11,6 +11,9 @@ module Lithic
           T.any(Lithic::AccountUpdateParams, Lithic::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :account_token
+
       # Additional context or information related to the account.
       sig { returns(T.nilable(String)) }
       attr_reader :comment
@@ -110,6 +113,7 @@ module Lithic
 
       sig do
         params(
+          account_token: String,
           comment: String,
           daily_spend_limit: Integer,
           lifetime_spend_limit: Integer,
@@ -122,6 +126,7 @@ module Lithic
         ).returns(T.attached_class)
       end
       def self.new(
+        account_token:,
         # Additional context or information related to the account.
         comment: nil,
         # Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a
@@ -180,6 +185,7 @@ module Lithic
       sig do
         override.returns(
           {
+            account_token: String,
             comment: String,
             daily_spend_limit: Integer,
             lifetime_spend_limit: Integer,

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

@@ -75,7 +75,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,
@@ -136,7 +137,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,
@@ -372,7 +374,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,

data/rbi/lithic/models/auth_rules/{rule_stats.rbi → backtest_stats.rbi}

@@ -3,14 +3,14 @@
 module Lithic
   module Models
     module AuthRules
-      class RuleStats < Lithic::Internal::Type::BaseModel
+      class BacktestStats < Lithic::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
-            T.any(Lithic::AuthRules::RuleStats, Lithic::Internal::AnyHash)
+            T.any(Lithic::AuthRules::BacktestStats, Lithic::Internal::AnyHash)
           end
 
         # The total number of historical transactions approved by this rule during the
-        # relevant period, or the number of transactions that would have been approved if
+        # backtest period, or the number of transactions that would have been approved if
         # the rule was evaluated in shadow mode.
         sig { returns(T.nilable(Integer)) }
         attr_reader :approved
@@ -19,7 +19,7 @@ module Lithic
         attr_writer :approved
 
         # The total number of historical transactions challenged by this rule during the
-        # relevant period, or the number of transactions that would have been challenged
+        # backtest period, or the number of transactions that would have been challenged
         # if the rule was evaluated in shadow mode. Currently applicable only for 3DS Auth
         # Rules.
         sig { returns(T.nilable(Integer)) }
@@ -29,7 +29,7 @@ module Lithic
         attr_writer :challenged
 
         # The total number of historical transactions declined by this rule during the
-        # relevant period, or the number of transactions that would have been declined if
+        # backtest period, or the number of transactions that would have been declined if
         # the rule was evaluated in shadow mode.
         sig { returns(T.nilable(Integer)) }
         attr_reader :declined
@@ -39,13 +39,16 @@ module Lithic
 
         # Example events and their outcomes.
         sig do
-          returns(T.nilable(T::Array[Lithic::AuthRules::RuleStats::Example]))
+          returns(
+            T.nilable(T::Array[Lithic::AuthRules::BacktestStats::Example])
+          )
         end
         attr_reader :examples
 
         sig do
           params(
-            examples: T::Array[Lithic::AuthRules::RuleStats::Example::OrHash]
+            examples:
+              T::Array[Lithic::AuthRules::BacktestStats::Example::OrHash]
           ).void
         end
         attr_writer :examples
@@ -63,22 +66,23 @@ module Lithic
             approved: Integer,
             challenged: Integer,
             declined: Integer,
-            examples: T::Array[Lithic::AuthRules::RuleStats::Example::OrHash],
+            examples:
+              T::Array[Lithic::AuthRules::BacktestStats::Example::OrHash],
             version: Integer
           ).returns(T.attached_class)
         end
         def self.new(
           # The total number of historical transactions approved by this rule during the
-          # relevant period, or the number of transactions that would have been approved if
+          # 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 challenged by this rule during the
-          # relevant period, or the number of transactions that would have been challenged
+          # backtest period, or the number of transactions that would have been challenged
           # if the rule was evaluated in shadow mode. Currently applicable only for 3DS Auth
           # Rules.
           challenged: nil,
           # The total number of historical transactions declined by this rule during the
-          # relevant period, or the number of transactions that would have been declined if
+          # backtest period, or the number of transactions that would have been declined if
           # the rule was evaluated in shadow mode.
           declined: nil,
           # Example events and their outcomes.
@@ -95,7 +99,7 @@ module Lithic
               approved: Integer,
               challenged: Integer,
               declined: Integer,
-              examples: T::Array[Lithic::AuthRules::RuleStats::Example],
+              examples: T::Array[Lithic::AuthRules::BacktestStats::Example],
               version: Integer
             }
           )
@@ -107,23 +111,16 @@ module Lithic
           OrHash =
             T.type_alias do
               T.any(
-                Lithic::AuthRules::RuleStats::Example,
+                Lithic::AuthRules::BacktestStats::Example,
                 Lithic::Internal::AnyHash
               )
             end
 
-          # Whether the rule would have approved the request.
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_reader :approved
-
-          sig { params(approved: T::Boolean).void }
-          attr_writer :approved
-
           # The decision made by the rule for this event.
           sig do
             returns(
               T.nilable(
-                Lithic::AuthRules::RuleStats::Example::Decision::TaggedSymbol
+                Lithic::AuthRules::BacktestStats::Example::Decision::TaggedSymbol
               )
             )
           end
@@ -132,7 +129,7 @@ module Lithic
           sig do
             params(
               decision:
-                Lithic::AuthRules::RuleStats::Example::Decision::OrSymbol
+                Lithic::AuthRules::BacktestStats::Example::Decision::OrSymbol
             ).void
           end
           attr_writer :decision
@@ -153,16 +150,13 @@ module Lithic
 
           sig do
             params(
-              approved: T::Boolean,
               decision:
-                Lithic::AuthRules::RuleStats::Example::Decision::OrSymbol,
+                Lithic::AuthRules::BacktestStats::Example::Decision::OrSymbol,
               event_token: String,
               timestamp: Time
             ).returns(T.attached_class)
           end
           def self.new(
-            # Whether the rule would have approved the request.
-            approved: nil,
             # The decision made by the rule for this event.
             decision: nil,
             # The event token.
@@ -175,9 +169,8 @@ module Lithic
           sig do
             override.returns(
               {
-                approved: T::Boolean,
                 decision:
-                  Lithic::AuthRules::RuleStats::Example::Decision::TaggedSymbol,
+                  Lithic::AuthRules::BacktestStats::Example::Decision::TaggedSymbol,
                 event_token: String,
                 timestamp: Time
               }
@@ -192,30 +185,33 @@ module Lithic
 
             TaggedSymbol =
               T.type_alias do
-                T.all(Symbol, Lithic::AuthRules::RuleStats::Example::Decision)
+                T.all(
+                  Symbol,
+                  Lithic::AuthRules::BacktestStats::Example::Decision
+                )
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             APPROVED =
               T.let(
                 :APPROVED,
-                Lithic::AuthRules::RuleStats::Example::Decision::TaggedSymbol
+                Lithic::AuthRules::BacktestStats::Example::Decision::TaggedSymbol
               )
             DECLINED =
               T.let(
                 :DECLINED,
-                Lithic::AuthRules::RuleStats::Example::Decision::TaggedSymbol
+                Lithic::AuthRules::BacktestStats::Example::Decision::TaggedSymbol
               )
             CHALLENGED =
               T.let(
                 :CHALLENGED,
-                Lithic::AuthRules::RuleStats::Example::Decision::TaggedSymbol
+                Lithic::AuthRules::BacktestStats::Example::Decision::TaggedSymbol
               )
 
             sig do
               override.returns(
                 T::Array[
-                  Lithic::AuthRules::RuleStats::Example::Decision::TaggedSymbol
+                  Lithic::AuthRules::BacktestStats::Example::Decision::TaggedSymbol
                 ]
               )
             end