lithic 0.1.0.pre.alpha.38 → 0.1.0.pre.alpha.40

data/lib/lithic/models/transaction.rb

@@ -372,20 +372,25 @@ module Lithic
       # @see Lithic::Models::Transaction#cardholder_authentication
       class CardholderAuthentication < Lithic::Internal::Type::BaseModel
         # @!attribute three_ds_version
+        #   @deprecated
+        #
         #   The 3DS version used for the authentication
         #
         #   @return [String, nil]
         required :three_ds_version, String, api_name: :"3ds_version", nil?: true
 
         # @!attribute acquirer_exemption
-        #   Whether an acquirer exemption applied to the transaction.
+        #   @deprecated
+        #
+        #   Whether an acquirer exemption applied to the transaction. Not currently
+        #   populated and will be removed in the future.
         #
         #   @return [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AcquirerExemption]
         required :acquirer_exemption,
                  enum: -> { Lithic::Transaction::CardholderAuthentication::AcquirerExemption }
 
         # @!attribute authentication_result
-        #   Indicates what the outcome of the 3DS authentication process is.
+        #   Indicates the outcome of the 3DS authentication process.
         #
         #   @return [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AuthenticationResult]
         required :authentication_result,
@@ -401,12 +406,10 @@ module Lithic
         #   Indicates whether chargeback liability shift applies to the transaction.
         #   Possible enum values:
         #
-        #       * `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D Secure flow, chargeback liability shift applies.
-        #
-        #       * `ACQUIRER_EXEMPTION`: The acquirer utilised an exemption to bypass Strong Customer Authentication (`transStatus = N`, or `transStatus = I`). Liability remains with the acquirer and in this case the `acquirer_exemption` field is expected to be not `NONE`.
-        #
-        #       * `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the merchant is liable.
-        #
+        #   - `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D
+        #     Secure flow, chargeback liability shift applies.
+        #   - `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the
+        #     merchant is liable.
         #   - `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated
         #     cryptography, possibly recurring. Chargeback liability shift to the issuer
         #     applies.
@@ -424,6 +427,8 @@ module Lithic
         required :three_ds_authentication_token, String, nil?: true
 
         # @!attribute verification_attempted
+        #   @deprecated
+        #
         #   Indicates whether a 3DS challenge flow was used, and if so, what the
         #   verification method was. (deprecated, use `authentication_result`)
         #
@@ -432,6 +437,8 @@ module Lithic
                  enum: -> { Lithic::Transaction::CardholderAuthentication::VerificationAttempted }
 
         # @!attribute verification_result
+        #   @deprecated
+        #
         #   Indicates whether a transaction is considered 3DS authenticated. (deprecated,
         #   use `authentication_result`)
         #
@@ -452,9 +459,9 @@ module Lithic
         #
         #   @param three_ds_version [String, nil] The 3DS version used for the authentication
         #
-        #   @param acquirer_exemption [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AcquirerExemption] Whether an acquirer exemption applied to the transaction.
+        #   @param acquirer_exemption [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AcquirerExemption] Whether an acquirer exemption applied to the transaction. Not currently populate
         #
-        #   @param authentication_result [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AuthenticationResult] Indicates what the outcome of the 3DS authentication process is.
+        #   @param authentication_result [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AuthenticationResult] Indicates the outcome of the 3DS authentication process.
         #
         #   @param decision_made_by [Symbol, Lithic::Models::Transaction::CardholderAuthentication::DecisionMadeBy] Indicates which party made the 3DS authentication decision.
         #
@@ -468,7 +475,10 @@ module Lithic
         #
         #   @param authentication_method [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AuthenticationMethod] Indicates the method used to authenticate the cardholder.
 
-        # Whether an acquirer exemption applied to the transaction.
+        # @deprecated
+        #
+        # Whether an acquirer exemption applied to the transaction. Not currently
+        # populated and will be removed in the future.
         #
         # @see Lithic::Models::Transaction::CardholderAuthentication#acquirer_exemption
         module AcquirerExemption
@@ -487,7 +497,7 @@ module Lithic
           #   @return [Array<Symbol>]
         end
 
-        # Indicates what the outcome of the 3DS authentication process is.
+        # Indicates the outcome of the 3DS authentication process.
         #
         # @see Lithic::Models::Transaction::CardholderAuthentication#authentication_result
         module AuthenticationResult
@@ -522,12 +532,10 @@ module Lithic
         # Indicates whether chargeback liability shift applies to the transaction.
         # Possible enum values:
         #
-        #     * `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D Secure flow, chargeback liability shift applies.
-        #
-        #     * `ACQUIRER_EXEMPTION`: The acquirer utilised an exemption to bypass Strong Customer Authentication (`transStatus = N`, or `transStatus = I`). Liability remains with the acquirer and in this case the `acquirer_exemption` field is expected to be not `NONE`.
-        #
-        #     * `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the merchant is liable.
-        #
+        # - `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D
+        #   Secure flow, chargeback liability shift applies.
+        # - `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the
+        #   merchant is liable.
         # - `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated
         #   cryptography, possibly recurring. Chargeback liability shift to the issuer
         #   applies.
@@ -537,14 +545,15 @@ module Lithic
           extend Lithic::Internal::Type::Enum
 
           LIABILITY_SHIFT_3DS_AUTHENTICATED = :"3DS_AUTHENTICATED"
-          ACQUIRER_EXEMPTION = :ACQUIRER_EXEMPTION
-          NONE = :NONE
           TOKEN_AUTHENTICATED = :TOKEN_AUTHENTICATED
+          NONE = :NONE
 
           # @!method self.values
           #   @return [Array<Symbol>]
         end
 
+        # @deprecated
+        #
         # Indicates whether a 3DS challenge flow was used, and if so, what the
         # verification method was. (deprecated, use `authentication_result`)
         #
@@ -559,6 +568,8 @@ module Lithic
           #   @return [Array<Symbol>]
         end
 
+        # @deprecated
+        #
         # Indicates whether a transaction is considered 3DS authenticated. (deprecated,
         # use `authentication_result`)
         #

data/lib/lithic/models.rb

@@ -224,6 +224,10 @@ module Lithic
 
   ExternalPaymentSettleParams = Lithic::Models::ExternalPaymentSettleParams
 
+  ExternalResource = Lithic::Models::ExternalResource
+
+  ExternalResourceType = Lithic::Models::ExternalResourceType
+
   FinancialAccount = Lithic::Models::FinancialAccount
 
   FinancialAccountCreateParams = Lithic::Models::FinancialAccountCreateParams
@@ -272,6 +276,12 @@ module Lithic
 
   MessageAttempt = Lithic::Models::MessageAttempt
 
+  NetworkProgram = Lithic::Models::NetworkProgram
+
+  NetworkProgramListParams = Lithic::Models::NetworkProgramListParams
+
+  NetworkProgramRetrieveParams = Lithic::Models::NetworkProgramRetrieveParams
+
   NonPCICard = Lithic::Models::NonPCICard
 
   OwnerType = Lithic::Models::OwnerType

data/lib/lithic/resources/accounts.rb

@@ -30,10 +30,12 @@ module Lithic
       # accounts that are part of the program managed by this API key. Accounts that are
       # in the `PAUSED` state will not be able to transact or create new cards.
       #
-      # @overload update(account_token, daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, verification_address: nil, request_options: {})
+      # @overload update(account_token, comment: nil, daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, substatus: nil, verification_address: nil, request_options: {})
       #
       # @param account_token [String] Globally unique identifier for account.
       #
+      # @param comment [String] Additional context or information related to the account.
+      #
       # @param daily_spend_limit [Integer] Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a $1
       #
       # @param lifetime_spend_limit [Integer] Amount (in cents) for the account's lifetime spend limit (e.g. 100000 would be a
@@ -42,6 +44,8 @@ module Lithic
       #
       # @param state [Symbol, Lithic::Models::AccountUpdateParams::State] Account states.
       #
+      # @param substatus [Symbol, Lithic::Models::AccountUpdateParams::Substatus] Account state substatus values:
+      #
       # @param verification_address [Lithic::Models::AccountUpdateParams::VerificationAddress] Address used during Address Verification Service (AVS) checks during transaction
       #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/lithic/resources/cards.rb

@@ -18,7 +18,7 @@ module Lithic
       # Create a new virtual or physical card. Parameters `shipping_address` and
       # `product_id` only apply to physical cards.
       #
-      # @overload create(type:, account_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_for: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
+      # @overload create(type:, account_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_comment: nil, replacement_for: nil, replacement_substatus: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
       #
       # @param type [Symbol, Lithic::Models::CardCreateParams::Type] Card types:
       #
@@ -42,8 +42,12 @@ module Lithic
       #
       # @param replacement_account_token [String] Restricted field limited to select use cases. Lithic will reach out directly if
       #
+      # @param replacement_comment [String] Additional context or information related to the card that this card will replac
+      #
       # @param replacement_for [String] Globally unique identifier for the card that this card will replace. If the card
       #
+      # @param replacement_substatus [Symbol, Lithic::Models::CardCreateParams::ReplacementSubstatus] Card state substatus values for the card that this card will replace:
+      #
       # @param shipping_address [Lithic::Models::ShippingAddress]
       #
       # @param shipping_method [Symbol, Lithic::Models::CardCreateParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL.
@@ -92,14 +96,18 @@ module Lithic
       # _Note: setting a card to a `CLOSED` state is a final action that cannot be
       # undone._
       #
-      # @overload update(card_token, digital_card_art_token: nil, memo: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
+      # @overload update(card_token, comment: nil, digital_card_art_token: nil, memo: nil, network_program_token: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, substatus: nil, request_options: {})
       #
       # @param card_token [String]
       #
+      # @param comment [String] Additional context or information related to the card.
+      #
       # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet afte
       #
       # @param memo [String] Friendly name to identify the card.
       #
+      # @param network_program_token [String] Globally unique identifier for the card's network program. Currently applicable
+      #
       # @param pin [String] Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and `V
       #
       # @param pin_status [Symbol, Lithic::Models::CardUpdateParams::PinStatus] Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
@@ -110,6 +118,8 @@ module Lithic
       #
       # @param state [Symbol, Lithic::Models::CardUpdateParams::State] Card state values:
       #
+      # @param substatus [Symbol, Lithic::Models::CardUpdateParams::Substatus] Card state substatus values:
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Card]

data/lib/lithic/resources/management_operations.rb

@@ -5,18 +5,30 @@ module Lithic
     class ManagementOperations
       # Create management operation
       #
-      # @overload create(amount:, category:, direction:, effective_date:, event_type:, financial_account_token:, token: nil, memo: nil, subtype: nil, user_defined_id: nil, request_options: {})
+      # @overload create(amount:, category:, direction:, effective_date:, event_type:, financial_account_token:, token: nil, memo: nil, on_closed_account: nil, subtype: nil, user_defined_id: nil, request_options: {})
       #
       # @param amount [Integer]
+      #
       # @param category [Symbol, Lithic::Models::ManagementOperationCreateParams::Category]
+      #
       # @param direction [Symbol, Lithic::Models::ManagementOperationCreateParams::Direction]
+      #
       # @param effective_date [Date]
+      #
       # @param event_type [Symbol, Lithic::Models::ManagementOperationCreateParams::EventType]
+      #
       # @param financial_account_token [String]
+      #
       # @param token [String]
+      #
       # @param memo [String]
+      #
+      # @param on_closed_account [Symbol, Lithic::Models::ManagementOperationCreateParams::OnClosedAccount] What to do if the financial account is closed when posting an operation
+      #
       # @param subtype [String]
+      #
       # @param user_defined_id [String]
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ManagementOperationTransaction]

data/lib/lithic/resources/network_programs.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class NetworkPrograms
+      # Get network program.
+      #
+      # @overload retrieve(network_program_token, request_options: {})
+      #
+      # @param network_program_token [String] Globally unique identifier for the network program.
+      #
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Models::NetworkProgram]
+      #
+      # @see Lithic::Models::NetworkProgramRetrieveParams
+      def retrieve(network_program_token, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/network_programs/%1$s", network_program_token],
+          model: Lithic::NetworkProgram,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::NetworkProgramListParams} for more details.
+      #
+      # List network programs.
+      #
+      # @overload list(begin_: nil, end_: nil, page_size: nil, request_options: {})
+      #
+      # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      #
+      # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Internal::SinglePage<Lithic::Models::NetworkProgram>]
+      #
+      # @see Lithic::Models::NetworkProgramListParams
+      def list(params = {})
+        parsed, options = Lithic::NetworkProgramListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v1/network_programs",
+          query: parsed.transform_keys(begin_: "begin", end_: "end"),
+          page: Lithic::Internal::SinglePage,
+          model: Lithic::NetworkProgram,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Lithic::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.1.0.pre.alpha.38"
+  VERSION = "0.1.0.pre.alpha.40"
 end

data/lib/lithic.rb

@@ -213,6 +213,8 @@ require_relative "lithic/models/external_payment_release_params"
 require_relative "lithic/models/external_payment_retrieve_params"
 require_relative "lithic/models/external_payment_reverse_params"
 require_relative "lithic/models/external_payment_settle_params"
+require_relative "lithic/models/external_resource"
+require_relative "lithic/models/external_resource_type"
 require_relative "lithic/models/financial_account"
 require_relative "lithic/models/financial_account_create_params"
 require_relative "lithic/models/financial_account_list_params"
@@ -258,6 +260,9 @@ require_relative "lithic/models/management_operation_retrieve_params"
 require_relative "lithic/models/management_operation_reverse_params"
 require_relative "lithic/models/management_operation_transaction"
 require_relative "lithic/models/message_attempt"
+require_relative "lithic/models/network_program"
+require_relative "lithic/models/network_program_list_params"
+require_relative "lithic/models/network_program_retrieve_params"
 require_relative "lithic/models/owner_type"
 require_relative "lithic/models/payment_create_params"
 require_relative "lithic/models/payment_create_response"
@@ -379,6 +384,7 @@ require_relative "lithic/resources/fraud"
 require_relative "lithic/resources/fraud/transactions"
 require_relative "lithic/resources/funding_events"
 require_relative "lithic/resources/management_operations"
+require_relative "lithic/resources/network_programs"
 require_relative "lithic/resources/payments"
 require_relative "lithic/resources/reports"
 require_relative "lithic/resources/reports/settlement"

data/rbi/lithic/client.rbi

@@ -103,6 +103,9 @@ module Lithic
     sig { returns(Lithic::Resources::Fraud) }
     attr_reader :fraud
 
+    sig { returns(Lithic::Resources::NetworkPrograms) }
+    attr_reader :network_programs
+
     # Status of api
     sig do
       params(request_options: Lithic::RequestOptions::OrHash).returns(

data/rbi/lithic/models/account.rbi

@@ -66,6 +66,46 @@ module Lithic
       sig { params(cardholder_currency: String).void }
       attr_writer :cardholder_currency
 
+      # Additional context or information related to the account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :comment
+
+      sig { params(comment: String).void }
+      attr_writer :comment
+
+      # Account state substatus values:
+      #
+      # - `FRAUD_IDENTIFIED` - The account has been recognized as being created or used
+      #   with stolen or fabricated identity information, encompassing both true
+      #   identity theft and synthetic identities.
+      # - `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as
+      #   unauthorized access or fraudulent transactions, necessitating further
+      #   investigation.
+      # - `RISK_VIOLATION` - The account has been involved in deliberate misuse by the
+      #   legitimate account holder. Examples include disputing valid transactions
+      #   without cause, falsely claiming non-receipt of goods, or engaging in
+      #   intentional bust-out schemes to exploit account services.
+      # - `END_USER_REQUEST` - The account holder has voluntarily requested the closure
+      #   of the account for personal reasons. This encompasses situations such as
+      #   bankruptcy, other financial considerations, or the account holder's death.
+      # - `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to
+      #   business strategy, risk management, inactivity, product changes, regulatory
+      #   concerns, or violations of terms and conditions.
+      # - `NOT_ACTIVE` - The account has not had any transactions or payment activity
+      #   within a specified period. This status applies to accounts that are paused or
+      #   closed due to inactivity.
+      # - `INTERNAL_REVIEW` - The account is temporarily paused pending further internal
+      #   review. In future implementations, this status may prevent clients from
+      #   activating the account via APIs until the review is completed.
+      # - `OTHER` - The reason for the account's current status does not fall into any
+      #   of the above categories. A comment should be provided to specify the
+      #   particular reason.
+      sig { returns(T.nilable(Lithic::Account::Substatus::TaggedSymbol)) }
+      attr_reader :substatus
+
+      sig { params(substatus: Lithic::Account::Substatus::OrSymbol).void }
+      attr_writer :substatus
+
       sig { returns(T.nilable(Lithic::Account::VerificationAddress)) }
       attr_reader :verification_address
 
@@ -85,6 +125,8 @@ module Lithic
           account_holder: Lithic::Account::AccountHolder::OrHash,
           auth_rule_tokens: T::Array[String],
           cardholder_currency: String,
+          comment: String,
+          substatus: Lithic::Account::Substatus::OrSymbol,
           verification_address: Lithic::Account::VerificationAddress::OrHash
         ).returns(T.attached_class)
       end
@@ -121,6 +163,36 @@ module Lithic
         auth_rule_tokens: nil,
         # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
         cardholder_currency: nil,
+        # Additional context or information related to the account.
+        comment: nil,
+        # Account state substatus values:
+        #
+        # - `FRAUD_IDENTIFIED` - The account has been recognized as being created or used
+        #   with stolen or fabricated identity information, encompassing both true
+        #   identity theft and synthetic identities.
+        # - `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as
+        #   unauthorized access or fraudulent transactions, necessitating further
+        #   investigation.
+        # - `RISK_VIOLATION` - The account has been involved in deliberate misuse by the
+        #   legitimate account holder. Examples include disputing valid transactions
+        #   without cause, falsely claiming non-receipt of goods, or engaging in
+        #   intentional bust-out schemes to exploit account services.
+        # - `END_USER_REQUEST` - The account holder has voluntarily requested the closure
+        #   of the account for personal reasons. This encompasses situations such as
+        #   bankruptcy, other financial considerations, or the account holder's death.
+        # - `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to
+        #   business strategy, risk management, inactivity, product changes, regulatory
+        #   concerns, or violations of terms and conditions.
+        # - `NOT_ACTIVE` - The account has not had any transactions or payment activity
+        #   within a specified period. This status applies to accounts that are paused or
+        #   closed due to inactivity.
+        # - `INTERNAL_REVIEW` - The account is temporarily paused pending further internal
+        #   review. In future implementations, this status may prevent clients from
+        #   activating the account via APIs until the review is completed.
+        # - `OTHER` - The reason for the account's current status does not fall into any
+        #   of the above categories. A comment should be provided to specify the
+        #   particular reason.
+        substatus: nil,
         verification_address: nil
       )
       end
@@ -135,6 +207,8 @@ module Lithic
             account_holder: Lithic::Account::AccountHolder,
             auth_rule_tokens: T::Array[String],
             cardholder_currency: String,
+            comment: String,
+            substatus: Lithic::Account::Substatus::TaggedSymbol,
             verification_address: Lithic::Account::VerificationAddress
           }
         )
@@ -275,6 +349,63 @@ module Lithic
         end
       end
 
+      # Account state substatus values:
+      #
+      # - `FRAUD_IDENTIFIED` - The account has been recognized as being created or used
+      #   with stolen or fabricated identity information, encompassing both true
+      #   identity theft and synthetic identities.
+      # - `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as
+      #   unauthorized access or fraudulent transactions, necessitating further
+      #   investigation.
+      # - `RISK_VIOLATION` - The account has been involved in deliberate misuse by the
+      #   legitimate account holder. Examples include disputing valid transactions
+      #   without cause, falsely claiming non-receipt of goods, or engaging in
+      #   intentional bust-out schemes to exploit account services.
+      # - `END_USER_REQUEST` - The account holder has voluntarily requested the closure
+      #   of the account for personal reasons. This encompasses situations such as
+      #   bankruptcy, other financial considerations, or the account holder's death.
+      # - `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to
+      #   business strategy, risk management, inactivity, product changes, regulatory
+      #   concerns, or violations of terms and conditions.
+      # - `NOT_ACTIVE` - The account has not had any transactions or payment activity
+      #   within a specified period. This status applies to accounts that are paused or
+      #   closed due to inactivity.
+      # - `INTERNAL_REVIEW` - The account is temporarily paused pending further internal
+      #   review. In future implementations, this status may prevent clients from
+      #   activating the account via APIs until the review is completed.
+      # - `OTHER` - The reason for the account's current status does not fall into any
+      #   of the above categories. A comment should be provided to specify the
+      #   particular reason.
+      module Substatus
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Lithic::Account::Substatus) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FRAUD_IDENTIFIED =
+          T.let(:FRAUD_IDENTIFIED, Lithic::Account::Substatus::TaggedSymbol)
+        SUSPICIOUS_ACTIVITY =
+          T.let(:SUSPICIOUS_ACTIVITY, Lithic::Account::Substatus::TaggedSymbol)
+        RISK_VIOLATION =
+          T.let(:RISK_VIOLATION, Lithic::Account::Substatus::TaggedSymbol)
+        END_USER_REQUEST =
+          T.let(:END_USER_REQUEST, Lithic::Account::Substatus::TaggedSymbol)
+        ISSUER_REQUEST =
+          T.let(:ISSUER_REQUEST, Lithic::Account::Substatus::TaggedSymbol)
+        NOT_ACTIVE =
+          T.let(:NOT_ACTIVE, Lithic::Account::Substatus::TaggedSymbol)
+        INTERNAL_REVIEW =
+          T.let(:INTERNAL_REVIEW, Lithic::Account::Substatus::TaggedSymbol)
+        OTHER = T.let(:OTHER, Lithic::Account::Substatus::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Lithic::Account::Substatus::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
       class VerificationAddress < Lithic::Internal::Type::BaseModel
         OrHash =
           T.type_alias do