lithic 0.1.0.pre.alpha.39 → 0.1.0.pre.alpha.40

data/rbi/lithic/resources/accounts.rbi

@@ -23,10 +23,12 @@ module Lithic
       sig do
         params(
           account_token: String,
+          comment: String,
           daily_spend_limit: Integer,
           lifetime_spend_limit: Integer,
           monthly_spend_limit: Integer,
           state: Lithic::AccountUpdateParams::State::OrSymbol,
+          substatus: Lithic::AccountUpdateParams::Substatus::OrSymbol,
           verification_address:
             Lithic::AccountUpdateParams::VerificationAddress::OrHash,
           request_options: Lithic::RequestOptions::OrHash
@@ -35,6 +37,8 @@ module Lithic
       def update(
         # Globally unique identifier for account.
         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
         # $1,000 limit). By default the daily spend limit is set to $1,250.
         daily_spend_limit: nil,
@@ -51,6 +55,34 @@ module Lithic
         monthly_spend_limit: nil,
         # Account states.
         state: 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,
         # Address used during Address Verification Service (AVS) checks during
         # transactions if enabled via Auth Rules. This field is deprecated as AVS checks
         # are no longer supported by Auth Rules. The field will be removed from the schema

data/rbi/lithic/resources/cards.rbi

@@ -27,7 +27,10 @@ module Lithic
           pin: String,
           product_id: String,
           replacement_account_token: String,
+          replacement_comment: String,
           replacement_for: String,
+          replacement_substatus:
+            Lithic::CardCreateParams::ReplacementSubstatus::OrSymbol,
           shipping_address: Lithic::ShippingAddress::OrHash,
           shipping_method: Lithic::CardCreateParams::ShippingMethod::OrSymbol,
           spend_limit: Integer,
@@ -94,10 +97,41 @@ module Lithic
         # If `replacement_for` is specified and this field is omitted, the replacement
         # card's account will be inferred from the card being replaced.
         replacement_account_token: nil,
+        # Additional context or information related to the card that this card will
+        # replace.
+        replacement_comment: nil,
         # Globally unique identifier for the card that this card will replace. If the card
         # type is `PHYSICAL` it will be replaced by a `PHYSICAL` card. If the card type is
         # `VIRTUAL` it will be replaced by a `VIRTUAL` card.
         replacement_for: nil,
+        # Card state substatus values for the card that this card will replace:
+        #
+        # - `LOST` - The physical card is no longer in the cardholder's possession due to
+        #   being lost or never received by the cardholder.
+        # - `COMPROMISED` - Card information has been exposed, potentially leading to
+        #   unauthorized access. This may involve physical card theft, cloning, or online
+        #   data breaches.
+        # - `DAMAGED` - The physical card is not functioning properly, such as having chip
+        #   failures or a demagnetized magnetic stripe.
+        # - `END_USER_REQUEST` - The cardholder requested the closure of the card for
+        #   reasons unrelated to fraud or damage, such as switching to a different product
+        #   or closing the account.
+        # - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
+        #   or damage, such as account inactivity, product or policy changes, or
+        #   technology upgrades.
+        # - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
+        #   period, applicable to statuses like `PAUSED` or `CLOSED`.
+        # - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
+        #   activities that require review. This can involve prompting the cardholder to
+        #   confirm legitimate use or report confirmed fraud.
+        # - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
+        #   review.
+        # - `EXPIRED` - The card has expired and has been closed without being reissued.
+        # - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
+        #   returned.
+        # - `OTHER` - The reason for the status does not fall into any of the above
+        #   categories. A comment should be provided to specify the reason.
+        replacement_substatus: nil,
         shipping_address: nil,
         # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of
         # options besides `STANDARD` require additional permissions.
@@ -162,18 +196,23 @@ module Lithic
       sig do
         params(
           card_token: String,
+          comment: String,
           digital_card_art_token: String,
           memo: String,
+          network_program_token: String,
           pin: String,
           pin_status: Lithic::CardUpdateParams::PinStatus::OrSymbol,
           spend_limit: Integer,
           spend_limit_duration: Lithic::SpendLimitDuration::OrSymbol,
           state: Lithic::CardUpdateParams::State::OrSymbol,
+          substatus: Lithic::CardUpdateParams::Substatus::OrSymbol,
           request_options: Lithic::RequestOptions::OrHash
         ).returns(Lithic::Card)
       end
       def update(
         card_token,
+        # Additional context or information related to the card.
+        comment: nil,
         # Specifies the digital card art to be displayed in the user’s digital wallet
         # after tokenization. This artwork must be approved by Mastercard and configured
         # by Lithic to use. See
@@ -181,6 +220,9 @@ module Lithic
         digital_card_art_token: nil,
         # Friendly name to identify the card.
         memo: nil,
+        # Globally unique identifier for the card's network program. Currently applicable
+        # to Visa cards participating in Account Level Management only.
+        network_program_token: nil,
         # Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and
         # `VIRTUAL`. Changing PIN also resets PIN status to `OK`. See
         # [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
@@ -216,6 +258,34 @@ module Lithic
         # - `PAUSED` - Card will decline authorizations, but can be resumed at a later
         #   time.
         state: nil,
+        # Card state substatus values:
+        #
+        # - `LOST` - The physical card is no longer in the cardholder's possession due to
+        #   being lost or never received by the cardholder.
+        # - `COMPROMISED` - Card information has been exposed, potentially leading to
+        #   unauthorized access. This may involve physical card theft, cloning, or online
+        #   data breaches.
+        # - `DAMAGED` - The physical card is not functioning properly, such as having chip
+        #   failures or a demagnetized magnetic stripe.
+        # - `END_USER_REQUEST` - The cardholder requested the closure of the card for
+        #   reasons unrelated to fraud or damage, such as switching to a different product
+        #   or closing the account.
+        # - `ISSUER_REQUEST` - The issuer closed the card for reasons unrelated to fraud
+        #   or damage, such as account inactivity, product or policy changes, or
+        #   technology upgrades.
+        # - `NOT_ACTIVE` - The card hasn’t had any transaction activity for a specified
+        #   period, applicable to statuses like `PAUSED` or `CLOSED`.
+        # - `SUSPICIOUS_ACTIVITY` - The card has one or more suspicious transactions or
+        #   activities that require review. This can involve prompting the cardholder to
+        #   confirm legitimate use or report confirmed fraud.
+        # - `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
+        #   review.
+        # - `EXPIRED` - The card has expired and has been closed without being reissued.
+        # - `UNDELIVERABLE` - The card cannot be delivered to the cardholder and has been
+        #   returned.
+        # - `OTHER` - The reason for the status does not fall into any of the above
+        #   categories. A comment should be provided to specify the reason.
+        substatus: nil,
         request_options: {}
       )
       end

data/rbi/lithic/resources/management_operations.rbi

@@ -16,6 +16,8 @@ module Lithic
           financial_account_token: String,
           token: String,
           memo: String,
+          on_closed_account:
+            Lithic::ManagementOperationCreateParams::OnClosedAccount::OrSymbol,
           subtype: String,
           user_defined_id: String,
           request_options: Lithic::RequestOptions::OrHash
@@ -30,6 +32,8 @@ module Lithic
         financial_account_token:,
         token: nil,
         memo: nil,
+        # What to do if the financial account is closed when posting an operation
+        on_closed_account: nil,
         subtype: nil,
         user_defined_id: nil,
         request_options: {}

data/rbi/lithic/resources/network_programs.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class NetworkPrograms
+      # Get network program.
+      sig do
+        params(
+          network_program_token: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(Lithic::NetworkProgram)
+      end
+      def retrieve(
+        # Globally unique identifier for the network program.
+        network_program_token,
+        request_options: {}
+      )
+      end
+
+      # List network programs.
+      sig do
+        params(
+          begin_: Time,
+          end_: Time,
+          page_size: Integer,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(Lithic::Internal::SinglePage[Lithic::NetworkProgram])
+      end
+      def list(
+        # Date string in RFC 3339 format. Only entries created after the specified time
+        # will be included. UTC time zone.
+        begin_: nil,
+        # Date string in RFC 3339 format. Only entries created before the specified time
+        # will be included. UTC time zone.
+        end_: nil,
+        # Page size (for pagination).
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Lithic::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/lithic/client.rbs

@@ -69,6 +69,8 @@ module Lithic
 
     attr_reader fraud: Lithic::Resources::Fraud
 
+    attr_reader network_programs: Lithic::Resources::NetworkPrograms
+
     def api_status: (
       ?request_options: Lithic::request_opts
     ) -> Lithic::APIStatus

data/sig/lithic/models/account.rbs

@@ -9,6 +9,8 @@ module Lithic
         account_holder: Lithic::Account::AccountHolder,
         auth_rule_tokens: ::Array[String],
         cardholder_currency: String,
+        comment: String,
+        substatus: Lithic::Models::Account::substatus,
         verification_address: Lithic::Account::VerificationAddress
       }
 
@@ -35,6 +37,16 @@ module Lithic
 
       def cardholder_currency=: (String) -> String
 
+      attr_reader comment: String?
+
+      def comment=: (String) -> String
+
+      attr_reader substatus: Lithic::Models::Account::substatus?
+
+      def substatus=: (
+        Lithic::Models::Account::substatus
+      ) -> Lithic::Models::Account::substatus
+
       attr_reader verification_address: Lithic::Account::VerificationAddress?
 
       def verification_address=: (
@@ -49,6 +61,8 @@ module Lithic
         ?account_holder: Lithic::Account::AccountHolder,
         ?auth_rule_tokens: ::Array[String],
         ?cardholder_currency: String,
+        ?comment: String,
+        ?substatus: Lithic::Models::Account::substatus,
         ?verification_address: Lithic::Account::VerificationAddress
       ) -> void
 
@@ -60,6 +74,8 @@ module Lithic
         account_holder: Lithic::Account::AccountHolder,
         auth_rule_tokens: ::Array[String],
         cardholder_currency: String,
+        comment: String,
+        substatus: Lithic::Models::Account::substatus,
         verification_address: Lithic::Account::VerificationAddress
       }
 
@@ -125,6 +141,31 @@ module Lithic
         }
       end
 
+      type substatus =
+        :FRAUD_IDENTIFIED
+        | :SUSPICIOUS_ACTIVITY
+        | :RISK_VIOLATION
+        | :END_USER_REQUEST
+        | :ISSUER_REQUEST
+        | :NOT_ACTIVE
+        | :INTERNAL_REVIEW
+        | :OTHER
+
+      module Substatus
+        extend Lithic::Internal::Type::Enum
+
+        FRAUD_IDENTIFIED: :FRAUD_IDENTIFIED
+        SUSPICIOUS_ACTIVITY: :SUSPICIOUS_ACTIVITY
+        RISK_VIOLATION: :RISK_VIOLATION
+        END_USER_REQUEST: :END_USER_REQUEST
+        ISSUER_REQUEST: :ISSUER_REQUEST
+        NOT_ACTIVE: :NOT_ACTIVE
+        INTERNAL_REVIEW: :INTERNAL_REVIEW
+        OTHER: :OTHER
+
+        def self?.values: -> ::Array[Lithic::Models::Account::substatus]
+      end
+
       type verification_address =
         {
           :address1 => String,

data/sig/lithic/models/account_update_params.rbs

@@ -2,10 +2,12 @@ module Lithic
   module Models
     type account_update_params =
       {
+        comment: String,
         daily_spend_limit: Integer,
         lifetime_spend_limit: Integer,
         monthly_spend_limit: Integer,
         state: Lithic::Models::AccountUpdateParams::state,
+        substatus: Lithic::Models::AccountUpdateParams::substatus,
         verification_address: Lithic::AccountUpdateParams::VerificationAddress
       }
       & Lithic::Internal::Type::request_parameters
@@ -14,6 +16,10 @@ module Lithic
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
+      attr_reader comment: String?
+
+      def comment=: (String) -> String
+
       attr_reader daily_spend_limit: Integer?
 
       def daily_spend_limit=: (Integer) -> Integer
@@ -32,6 +38,12 @@ module Lithic
         Lithic::Models::AccountUpdateParams::state
       ) -> Lithic::Models::AccountUpdateParams::state
 
+      attr_reader substatus: Lithic::Models::AccountUpdateParams::substatus?
+
+      def substatus=: (
+        Lithic::Models::AccountUpdateParams::substatus
+      ) -> Lithic::Models::AccountUpdateParams::substatus
+
       attr_reader verification_address: Lithic::AccountUpdateParams::VerificationAddress?
 
       def verification_address=: (
@@ -39,19 +51,23 @@ module Lithic
       ) -> Lithic::AccountUpdateParams::VerificationAddress
 
       def initialize: (
+        ?comment: String,
         ?daily_spend_limit: Integer,
         ?lifetime_spend_limit: Integer,
         ?monthly_spend_limit: Integer,
         ?state: Lithic::Models::AccountUpdateParams::state,
+        ?substatus: Lithic::Models::AccountUpdateParams::substatus,
         ?verification_address: Lithic::AccountUpdateParams::VerificationAddress,
         ?request_options: Lithic::request_opts
       ) -> void
 
       def to_hash: -> {
+        comment: String,
         daily_spend_limit: Integer,
         lifetime_spend_limit: Integer,
         monthly_spend_limit: Integer,
         state: Lithic::Models::AccountUpdateParams::state,
+        substatus: Lithic::Models::AccountUpdateParams::substatus,
         verification_address: Lithic::AccountUpdateParams::VerificationAddress,
         request_options: Lithic::RequestOptions
       }
@@ -68,6 +84,31 @@ module Lithic
         def self?.values: -> ::Array[Lithic::Models::AccountUpdateParams::state]
       end
 
+      type substatus =
+        :FRAUD_IDENTIFIED
+        | :SUSPICIOUS_ACTIVITY
+        | :RISK_VIOLATION
+        | :END_USER_REQUEST
+        | :ISSUER_REQUEST
+        | :NOT_ACTIVE
+        | :INTERNAL_REVIEW
+        | :OTHER
+
+      module Substatus
+        extend Lithic::Internal::Type::Enum
+
+        FRAUD_IDENTIFIED: :FRAUD_IDENTIFIED
+        SUSPICIOUS_ACTIVITY: :SUSPICIOUS_ACTIVITY
+        RISK_VIOLATION: :RISK_VIOLATION
+        END_USER_REQUEST: :END_USER_REQUEST
+        ISSUER_REQUEST: :ISSUER_REQUEST
+        NOT_ACTIVE: :NOT_ACTIVE
+        INTERNAL_REVIEW: :INTERNAL_REVIEW
+        OTHER: :OTHER
+
+        def self?.values: -> ::Array[Lithic::Models::AccountUpdateParams::substatus]
+      end
+
       type verification_address =
         {
           :address1 => String,

data/sig/lithic/models/aggregate_balance.rbs

@@ -61,7 +61,7 @@ module Lithic
         updated: Time
       }
 
-      type financial_account_type = :ISSUING | :OPERATING | :RESERVE
+      type financial_account_type = :ISSUING | :OPERATING | :RESERVE | :SECURITY
 
       module FinancialAccountType
         extend Lithic::Internal::Type::Enum
@@ -69,6 +69,7 @@ module Lithic
         ISSUING: :ISSUING
         OPERATING: :OPERATING
         RESERVE: :RESERVE
+        SECURITY: :SECURITY
 
         def self?.values: -> ::Array[Lithic::Models::AggregateBalance::financial_account_type]
       end

data/sig/lithic/models/aggregate_balance_list_params.rbs

@@ -26,7 +26,7 @@ module Lithic
         request_options: Lithic::RequestOptions
       }
 
-      type financial_account_type = :ISSUING | :OPERATING | :RESERVE
+      type financial_account_type = :ISSUING | :OPERATING | :RESERVE | :SECURITY
 
       module FinancialAccountType
         extend Lithic::Internal::Type::Enum
@@ -34,6 +34,7 @@ module Lithic
         ISSUING: :ISSUING
         OPERATING: :OPERATING
         RESERVE: :RESERVE
+        SECURITY: :SECURITY
 
         def self?.values: -> ::Array[Lithic::Models::AggregateBalanceListParams::financial_account_type]
       end

data/sig/lithic/models/auth_rules/velocity_limit_params.rbs

@@ -4,7 +4,7 @@ module Lithic
       type velocity_limit_params =
         {
           filters: Lithic::AuthRules::VelocityLimitParams::Filters,
-          period: Lithic::Models::AuthRules::VelocityLimitParams::period,
+          period: Lithic::Models::AuthRules::velocity_limit_params_period_window,
           scope: Lithic::Models::AuthRules::VelocityLimitParams::scope,
           limit_amount: Integer?,
           limit_count: Integer?
@@ -13,7 +13,7 @@ module Lithic
       class VelocityLimitParams < Lithic::Internal::Type::BaseModel
         attr_accessor filters: Lithic::AuthRules::VelocityLimitParams::Filters
 
-        attr_accessor period: Lithic::Models::AuthRules::VelocityLimitParams::period
+        attr_accessor period: Lithic::Models::AuthRules::velocity_limit_params_period_window
 
         attr_accessor scope: Lithic::Models::AuthRules::VelocityLimitParams::scope
 
@@ -23,7 +23,7 @@ module Lithic
 
         def initialize: (
           filters: Lithic::AuthRules::VelocityLimitParams::Filters,
-          period: Lithic::Models::AuthRules::VelocityLimitParams::period,
+          period: Lithic::Models::AuthRules::velocity_limit_params_period_window,
           scope: Lithic::Models::AuthRules::VelocityLimitParams::scope,
           ?limit_amount: Integer?,
           ?limit_count: Integer?
@@ -31,7 +31,7 @@ module Lithic
 
         def to_hash: -> {
           filters: Lithic::AuthRules::VelocityLimitParams::Filters,
-          period: Lithic::Models::AuthRules::VelocityLimitParams::period,
+          period: Lithic::Models::AuthRules::velocity_limit_params_period_window,
           scope: Lithic::Models::AuthRules::VelocityLimitParams::scope,
           limit_amount: Integer?,
           limit_count: Integer?
@@ -69,16 +69,6 @@ module Lithic
           }
         end
 
-        type period =
-          Integer
-          | Lithic::Models::AuthRules::velocity_limit_params_period_window
-
-        module Period
-          extend Lithic::Internal::Type::Union
-
-          def self?.variants: -> ::Array[Lithic::Models::AuthRules::VelocityLimitParams::period]
-        end
-
         type scope = :CARD | :ACCOUNT
 
         module Scope