v2.ts

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../../core/resource';
import * as V2API from './v2';
import * as BacktestsAPI from './backtests';
import {
  BacktestCreateParams,
  BacktestCreateResponse,
  BacktestResults,
  BacktestRetrieveParams,
  Backtests,
} from './backtests';
import { APIPromise } from '../../../core/api-promise';
import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pagination';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';

export class V2 extends APIResource {
  backtests: BacktestsAPI.Backtests = new BacktestsAPI.Backtests(this._client);

  /**
   * Creates a new V2 Auth rule in draft mode
   */
  create(body: V2CreateParams, options?: RequestOptions): APIPromise<AuthRule> {
    return this._client.post('/v2/auth_rules', { body, ...options });
  }

  /**
   * Fetches a V2 Auth rule by its token
   */
  retrieve(authRuleToken: string, options?: RequestOptions): APIPromise<AuthRule> {
    return this._client.get(path`/v2/auth_rules/${authRuleToken}`, options);
  }

  /**
   * Updates a V2 Auth rule's properties
   *
   * If `account_tokens`, `card_tokens`, `program_level`, `excluded_card_tokens`,
   * `excluded_account_tokens`, or `excluded_business_account_tokens` is provided,
   * this will replace existing associations with the provided list of entities.
   */
  update(authRuleToken: string, body: V2UpdateParams, options?: RequestOptions): APIPromise<AuthRule> {
    return this._client.patch(path`/v2/auth_rules/${authRuleToken}`, { body, ...options });
  }

  /**
   * Lists V2 Auth rules
   */
  list(
    query: V2ListParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<AuthRulesCursorPage, AuthRule> {
    return this._client.getAPIList('/v2/auth_rules', CursorPage<AuthRule>, { query, ...options });
  }

  /**
   * Deletes a V2 Auth rule
   */
  delete(authRuleToken: string, options?: RequestOptions): APIPromise<void> {
    return this._client.delete(path`/v2/auth_rules/${authRuleToken}`, options);
  }

  /**
   * Creates a new draft version of a rule that will be ran in shadow mode.
   *
   * This can also be utilized to reset the draft parameters, causing a draft version
   * to no longer be ran in shadow mode.
   */
  draft(authRuleToken: string, body: V2DraftParams, options?: RequestOptions): APIPromise<AuthRule> {
    return this._client.post(path`/v2/auth_rules/${authRuleToken}/draft`, { body, ...options });
  }

  /**
   * 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
   */
  listResults(
    query: V2ListResultsParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<V2ListResultsResponsesCursorPage, V2ListResultsResponse> {
    return this._client.getAPIList('/v2/auth_rules/results', CursorPage<V2ListResultsResponse>, {
      query,
      ...options,
    });
  }

  /**
   * Returns all versions of an auth rule, sorted by version number descending
   * (newest first).
   */
  listVersions(authRuleToken: string, options?: RequestOptions): APIPromise<V2ListVersionsResponse> {
    return this._client.get(path`/v2/auth_rules/${authRuleToken}/versions`, options);
  }

  /**
   * Promotes the draft version of an Auth rule to the currently active version such
   * that it is enforced in the respective stream.
   */
  promote(authRuleToken: string, options?: RequestOptions): APIPromise<AuthRule> {
    return this._client.post(path`/v2/auth_rules/${authRuleToken}/promote`, options);
  }

  /**
   * Fetches the current calculated Feature values for the given Auth Rule
   *
   * This only calculates the features for the active version.
   *
   * - VelocityLimit Rules calculates the current Velocity Feature data. This
   *   requires a `card_token` or `account_token` matching what the rule is Scoped
   *   to.
   * - ConditionalBlock Rules calculates the CARD*TRANSACTION_COUNT*\* attributes on
   *   the rule. This requires a `card_token`
   */
  retrieveFeatures(
    authRuleToken: string,
    query: V2RetrieveFeaturesParams | null | undefined = {},
    options?: RequestOptions,
  ): APIPromise<V2RetrieveFeaturesResponse> {
    return this._client.get(path`/v2/auth_rules/${authRuleToken}/features`, { query, ...options });
  }

  /**
   * Retrieves a performance report for an Auth rule containing daily statistics and
   * evaluation outcomes.
   *
   * **Time Range Limitations:**
   *
   * - Reports are supported for the past 3 months only
   * - Maximum interval length is 1 month
   * - Report data is available only through the previous day in UTC (current day
   *   data is not available)
   *
   * The report provides daily statistics for both current and draft versions of the
   * Auth rule, including approval, decline, and challenge counts along with sample
   * events.
   */
  retrieveReport(
    authRuleToken: string,
    query: V2RetrieveReportParams,
    options?: RequestOptions,
  ): APIPromise<V2RetrieveReportResponse> {
    return this._client.get(path`/v2/auth_rules/${authRuleToken}/report`, { query, ...options });
  }
}

export type AuthRulesCursorPage = CursorPage<AuthRule>;

export type V2ListResultsResponsesCursorPage = CursorPage<V2ListResultsResponse>;

export type ACHPaymentUpdateAction =
  | ACHPaymentUpdateAction.TagAction
  | ACHPaymentUpdateAction.CreateCaseAction;

export namespace ACHPaymentUpdateAction {
  export interface TagAction {
    /**
     * The key of the tag to apply to the payment
     */
    key: string;

    /**
     * Tag the payment with key-value metadata
     */
    type: 'TAG';

    /**
     * The value of the tag to apply to the payment
     */
    value: string;
  }

  export interface CreateCaseAction {
    /**
     * The token of the queue to create the case in
     */
    queue_token: string;

    /**
     * The scope of the case to create
     */
    scope: 'FINANCIAL_ACCOUNT';

    /**
     * Create a case for the payment
     */
    type: 'CREATE_CASE';
  }
}

export interface AuthRule {
  /**
   * Auth Rule Token
   */
  token: string;

  /**
   * Account tokens to which the Auth Rule applies.
   */
  account_tokens: Array<string>;

  /**
   * Business Account tokens to which the Auth Rule applies.
   */
  business_account_tokens: Array<string>;

  /**
   * Card tokens to which the Auth Rule applies.
   */
  card_tokens: Array<string>;

  current_version: AuthRule.CurrentVersion | null;

  draft_version: AuthRule.DraftVersion | null;

  /**
   * The event stream during which the rule will be evaluated.
   */
  event_stream: EventStream;

  /**
   * Indicates whether this auth rule is managed by Lithic. If true, the rule cannot
   * be modified or deleted by the user
   */
  lithic_managed: boolean;

  /**
   * Auth Rule Name
   */
  name: string | null;

  /**
   * Whether the Auth Rule applies to all authorizations on the card program.
   */
  program_level: boolean;

  /**
   * The state of the Auth Rule
   */
  state: 'ACTIVE' | 'INACTIVE';

  /**
   * The type of Auth Rule. For certain rule types, this determines the event stream
   * during which it will be evaluated. For rules that can be applied to one of
   * several event streams, the effective one is defined by the separate
   * `event_stream` field.
   *
   * - `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,
   *   ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
   *   ACH_PAYMENT_UPDATE event stream.
   * - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
   *   ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
   *   ACH_PAYMENT_UPDATE event stream.
   */
  type: 'CONDITIONAL_BLOCK' | 'VELOCITY_LIMIT' | 'MERCHANT_LOCK' | 'CONDITIONAL_ACTION' | 'TYPESCRIPT_CODE';

  /**
   * Account tokens to which the Auth Rule does not apply.
   */
  excluded_account_tokens?: Array<string>;

  /**
   * Business account tokens to which the Auth Rule does not apply.
   */
  excluded_business_account_tokens?: Array<string>;

  /**
   * Card tokens to which the Auth Rule does not apply.
   */
  excluded_card_tokens?: Array<string>;
}

export namespace AuthRule {
  export interface CurrentVersion {
    /**
     * Parameters for the Auth Rule
     */
    parameters:
      | V2API.ConditionalBlockParameters
      | V2API.VelocityLimitParams
      | V2API.MerchantLockParameters
      | V2API.Conditional3DSActionParameters
      | V2API.ConditionalAuthorizationActionParameters
      | V2API.ConditionalACHActionParameters
      | V2API.ConditionalTokenizationActionParameters
      | V2API.ConditionalCardTransactionUpdateActionParameters
      | V2API.ConditionalACHPaymentUpdateActionParameters
      | V2API.TypescriptCodeParameters
      | V2API.ConditionalAuthorizationAdjustmentParameters;

    /**
     * The version of the rule, this is incremented whenever the rule's parameters
     * change.
     */
    version: number;
  }

  export interface DraftVersion {
    /**
     * An error message if the draft version failed compilation. Populated when `state`
     * is `ERROR`, `null` otherwise.
     */
    error: string | null;

    /**
     * Parameters for the Auth Rule
     */
    parameters:
      | V2API.ConditionalBlockParameters
      | V2API.VelocityLimitParams
      | V2API.MerchantLockParameters
      | V2API.Conditional3DSActionParameters
      | V2API.ConditionalAuthorizationActionParameters
      | V2API.ConditionalACHActionParameters
      | V2API.ConditionalTokenizationActionParameters
      | V2API.ConditionalCardTransactionUpdateActionParameters
      | V2API.ConditionalACHPaymentUpdateActionParameters
      | V2API.TypescriptCodeParameters
      | V2API.ConditionalAuthorizationAdjustmentParameters;

    /**
     * The state of the draft version. Most rules are created synchronously and the
     * state is immediately `SHADOWING`. Rules backed by TypeScript code are compiled
     * asynchronously — the state starts as `PENDING` and transitions to `SHADOWING` on
     * success or `ERROR` on failure.
     *
     * - `PENDING`: Compilation of the rule is in progress (TypeScript rules only).
     * - `SHADOWING`: The draft version is ready and evaluating in shadow mode
     *   alongside the current active version. It can be promoted to the active
     *   version.
     * - `ERROR`: Compilation of the rule failed. Check the `error` field for details.
     */
    state: 'PENDING' | 'SHADOWING' | 'ERROR';

    /**
     * The version of the rule, this is incremented whenever the rule's parameters
     * change.
     */
    version: number;
  }
}

export interface AuthRuleCondition {
  /**
   * The attribute to target.
   *
   * The following attributes may be targeted:
   *
   * - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
   *   business by the types of goods or services it provides.
   * - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
   *   ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
   *   Netherlands Antilles.
   * - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
   *   the transaction.
   * - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
   *   (merchant).
   * - `DESCRIPTOR`: Short description of card acceptor.
   * - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
   *   applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
   *   `TOKEN_AUTHENTICATED`.
   * - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
   *   (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
   *   `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
   *   `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
   *   `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
   * - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
   *   fee field in the settlement/cardholder billing currency. This is the amount
   *   the issuer should authorize against unless the issuer is paying the acquirer
   *   fee on behalf of the cardholder.
   * - `RISK_SCORE`: Network-provided score assessing risk level associated with a
   *   given authorization. Scores are on a range of 0-999, with 0 representing the
   *   lowest risk and 999 representing the highest risk. For Visa transactions,
   *   where the raw score has a range of 0-99, Lithic will normalize the score by
   *   multiplying the raw score by 10x.
   * - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
   *   trailing 15 minutes before the authorization.
   * - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
   *   trailing hour up and until the authorization.
   * - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
   *   trailing 24 hours up and until the authorization.
   * - `CARD_STATE`: The current state of the card associated with the transaction.
   *   Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
   *   `PENDING_FULFILLMENT`.
   * - `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction.
   *   Valid values are `TRUE`, `FALSE`.
   * - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
   *   `OK`, `BLOCKED`.
   * - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
   *   source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
   *   `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
   * - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
   *   data with the cardholder KYC data if it exists. Valid values are `MATCH`,
   *   `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
   */
  attribute: ConditionalAttribute;

  /**
   * The operation to apply to the attribute
   */
  operation: ConditionalOperation;

  /**
   * A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
   */
  value: ConditionalValue;
}

export interface AuthRuleVersion {
  /**
   * Timestamp of when this version was created.
   */
  created: string;

  /**
   * Parameters for the Auth Rule
   */
  parameters:
    | ConditionalBlockParameters
    | VelocityLimitParams
    | MerchantLockParameters
    | Conditional3DSActionParameters
    | ConditionalAuthorizationActionParameters
    | ConditionalACHActionParameters
    | ConditionalTokenizationActionParameters
    | ConditionalCardTransactionUpdateActionParameters
    | ConditionalACHPaymentUpdateActionParameters
    | TypescriptCodeParameters
    | ConditionalAuthorizationAdjustmentParameters;

  /**
   * The current state of this version.
   */
  state: 'ACTIVE' | 'SHADOW' | 'INACTIVE';

  /**
   * The version of the rule, this is incremented whenever the rule's parameters
   * change.
   */
  version: number;
}

export interface BacktestStats {
  /**
   * The total number of historical transactions approved by this rule during the
   * backtest period, or the number of transactions that would have been approved if
   * the rule was evaluated in shadow mode.
   */
  approved?: number;

  /**
   * The total number of historical transactions challenged by this rule during the
   * 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?: number;

  /**
   * The total number of historical transactions declined by this rule during the
   * backtest period, or the number of transactions that would have been declined if
   * the rule was evaluated in shadow mode.
   */
  declined?: number;

  /**
   * Example events and their outcomes.
   */
  examples?: Array<BacktestStats.Example>;

  /**
   * The version of the rule, this is incremented whenever the rule's parameters
   * change.
   */
  version?: number;
}

export namespace BacktestStats {
  export interface Example {
    /**
     * The decision made by the rule for this event.
     */
    decision?: 'APPROVED' | 'DECLINED' | 'CHALLENGED';

    /**
     * The event token.
     */
    event_token?: string;

    /**
     * The timestamp of the event.
     */
    timestamp?: string;

    /**
     * The token of the transaction associated with the event
     */
    transaction_token?: string | null;
  }
}

export type CardTransactionUpdateAction =
  | CardTransactionUpdateAction.TagAction
  | CardTransactionUpdateAction.CreateCaseAction;

export namespace CardTransactionUpdateAction {
  export interface TagAction {
    /**
     * The key of the tag to apply to the transaction
     */
    key: string;

    /**
     * Tag the transaction with key-value metadata
     */
    type: 'TAG';

    /**
     * The value of the tag to apply to the transaction
     */
    value: string;
  }

  export interface CreateCaseAction {
    /**
     * The token of the queue to create the case in
     */
    queue_token: string;

    /**
     * The scope of the case to create
     */
    scope: 'CARD' | 'ACCOUNT';

    /**
     * Create a case for the transaction
     */
    type: 'CREATE_CASE';
  }
}

export interface Conditional3DSActionParameters {
  /**
   * The action to take if the conditions are met.
   */
  action: 'DECLINE' | 'CHALLENGE';

  conditions: Array<Conditional3DSActionParameters.Condition>;
}

export namespace Conditional3DSActionParameters {
  export interface Condition {
    /**
     * The attribute to target.
     *
     * The following attributes may be targeted:
     *
     * - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
     *   business by the types of goods or services it provides.
     * - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
     *   ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
     *   Netherlands Antilles.
     * - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
     *   the transaction.
     * - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
     *   (merchant).
     * - `DESCRIPTOR`: Short description of card acceptor.
     * - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
     *   fee field in the settlement/cardholder billing currency. This is the amount
     *   the issuer should authorize against unless the issuer is paying the acquirer
     *   fee on behalf of the cardholder. Use an integer value.
     * - `RISK_SCORE`: Mastercard only: Assessment by the network of the authentication
     *   risk level, with a higher value indicating a higher amount of risk. Use an
     *   integer value.
     * - `MESSAGE_CATEGORY`: The category of the authentication being processed.
     * - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
     *   data with the cardholder KYC data if it exists. Valid values are `MATCH`,
     *   `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
     */
    attribute:
      | 'MCC'
      | 'COUNTRY'
      | 'CURRENCY'
      | 'MERCHANT_ID'
      | 'DESCRIPTOR'
      | 'TRANSACTION_AMOUNT'
      | 'RISK_SCORE'
      | 'MESSAGE_CATEGORY'
      | 'ADDRESS_MATCH';

    /**
     * The operation to apply to the attribute
     */
    operation: V2API.ConditionalOperation;

    /**
     * A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
     */
    value: V2API.ConditionalValue;
  }
}

export interface ConditionalACHActionParameters {
  /**
   * The action to take if the conditions are met.
   */
  action: ConditionalACHActionParameters.ApproveActionACH | ConditionalACHActionParameters.ReturnAction;

  conditions: Array<ConditionalACHActionParameters.Condition>;
}

export namespace ConditionalACHActionParameters {
  export interface ApproveActionACH {
    /**
     * Approve the ACH transaction
     */
    type: 'APPROVE';
  }

  export interface ReturnAction {
    /**
     * NACHA return code to use when returning the transaction. Note that the list of
     * available return codes is subject to an allowlist configured at the program
     * level
     */
    code:
      | 'R01'
      | 'R02'
      | 'R03'
      | 'R04'
      | 'R05'
      | 'R06'
      | 'R07'
      | 'R08'
      | 'R09'
      | 'R10'
      | 'R11'
      | 'R12'
      | 'R13'
      | 'R14'
      | 'R15'
      | 'R16'
      | 'R17'
      | 'R18'
      | 'R19'
      | 'R20'
      | 'R21'
      | 'R22'
      | 'R23'
      | 'R24'
      | 'R25'
      | 'R26'
      | 'R27'
      | 'R28'
      | 'R29'
      | 'R30'
      | 'R31'
      | 'R32'
      | 'R33'
      | 'R34'
      | 'R35'
      | 'R36'
      | 'R37'
      | 'R38'
      | 'R39'
      | 'R40'
      | 'R41'
      | 'R42'
      | 'R43'
      | 'R44'
      | 'R45'
      | 'R46'
      | 'R47'
      | 'R50'
      | 'R51'
      | 'R52'
      | 'R53'
      | 'R61'
      | 'R62'
      | 'R67'
      | 'R68'
      | 'R69'
      | 'R70'
      | 'R71'
      | 'R72'
      | 'R73'
      | 'R74'
      | 'R75'
      | 'R76'
      | 'R77'
      | 'R80'
      | 'R81'
      | 'R82'
      | 'R83'
      | 'R84'
      | 'R85';

    /**
     * Return the ACH transaction
     */
    type: 'RETURN';
  }

  export interface Condition {
    /**
     * The attribute to target.
     *
     * The following attributes may be targeted:
     *
     * - `COMPANY_NAME`: The name of the company initiating the ACH transaction.
     * - `COMPANY_ID`: The company ID (also known as Standard Entry Class (SEC) Company
     *   ID) of the entity initiating the ACH transaction.
     * - `TIMESTAMP`: The timestamp of the ACH transaction in ISO 8601 format.
     * - `TRANSACTION_AMOUNT`: The amount of the ACH transaction in minor units
     *   (cents). Use an integer value.
     * - `SEC_CODE`: Standard Entry Class code indicating the type of ACH transaction.
     *   Valid values include PPD (Prearranged Payment and Deposit Entry), CCD
     *   (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL
     *   (Telephone-Initiated Entry), and others.
     * - `MEMO`: Optional memo or description field included with the ACH transaction.
     */
    attribute: 'COMPANY_NAME' | 'COMPANY_ID' | 'TIMESTAMP' | 'TRANSACTION_AMOUNT' | 'SEC_CODE' | 'MEMO';

    /**
     * The operation to apply to the attribute
     */
    operation: V2API.ConditionalOperation;

    /**
     * A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
     */
    value: V2API.ConditionalValue;
  }
}

export interface ConditionalACHPaymentUpdateActionParameters {
  /**
   * The action to take if the conditions are met.
   */
  action: ACHPaymentUpdateAction;

  conditions: Array<ConditionalACHPaymentUpdateActionParameters.Condition>;
}

export namespace ConditionalACHPaymentUpdateActionParameters {
  export interface Condition {
    /**
     * The attribute to target.
     *
     * The following attributes may be targeted:
     *
     * - `TRANSACTION_AMOUNT`: The total amount of the ACH payment in minor units
     *   (cents), calculated as the sum of the settled and pending amounts. Use an
     *   integer value.
     * - `SEC_CODE`: Standard Entry Class code indicating the type of ACH transaction.
     *   Valid values include PPD (Prearranged Payment and Deposit Entry), CCD
     *   (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL
     *   (Telephone-Initiated Entry), and others.
     * - `RETURN_REASON_CODE`: NACHA return reason code associated with the payment
     *   (for example, `R01`).
     * - `ACCOUNT_AGE`: The age of the account in seconds at the time of the payment.
     *   Use an integer value. For programs where Lithic does not manage or retain
     *   account holder data, this attribute does not evaluate.
     * - `EXTERNAL_BANK_ACCOUNT_AGE`: The age of the external bank account in seconds
     *   at the time of the payment. Use an integer value.
     * - `EXTERNAL_BANK_ACCOUNT_VERIFICATION_METHOD`: The method used to verify the
     *   external bank account. Valid values are `MANUAL`, `MICRO_DEPOSIT`, `PRENOTE`,
     *   `EXTERNALLY_VERIFIED`, or `UNVERIFIED`.
     * - `EXTERNAL_BANK_ACCOUNT_VERIFICATION_STATE`: The verification state of the
     *   external bank account. Valid values are `PENDING`, `ENABLED`,
     *   `FAILED_VERIFICATION`, or `INSUFFICIENT_FUNDS`.
     * - `EXTERNAL_BANK_ACCOUNT_OWNER_TYPE`: The owner type of the external bank
     *   account. Valid values are `INDIVIDUAL` or `BUSINESS`.
     * - `ACH_EVENT_TYPE`: The type of ACH payment event being evaluated. Valid values
     *   include `ACH_ORIGINATION_INITIATED`, `ACH_ORIGINATION_REVIEWED`,
     *   `ACH_ORIGINATION_CANCELLED`, `ACH_ORIGINATION_PROCESSED`,
     *   `ACH_ORIGINATION_SETTLED`, `ACH_ORIGINATION_RELEASED`,
     *   `ACH_ORIGINATION_REJECTED`, `ACH_RECEIPT_PROCESSED`, `ACH_RECEIPT_SETTLED`,
     *   `ACH_RECEIPT_RELEASED`, `ACH_RECEIPT_RELEASED_EARLY`, `ACH_RETURN_INITIATED`,
     *   `ACH_RETURN_PROCESSED`, `ACH_RETURN_SETTLED`, and `ACH_RETURN_REJECTED`.
     */
    attribute:
      | 'TRANSACTION_AMOUNT'
      | 'SEC_CODE'
      | 'RETURN_REASON_CODE'
      | 'ACCOUNT_AGE'
      | 'EXTERNAL_BANK_ACCOUNT_AGE'
      | 'EXTERNAL_BANK_ACCOUNT_VERIFICATION_METHOD'
      | 'EXTERNAL_BANK_ACCOUNT_VERIFICATION_STATE'
      | 'EXTERNAL_BANK_ACCOUNT_OWNER_TYPE'
      | 'ACH_EVENT_TYPE';

    /**
     * The operation to apply to the attribute
     */
    operation: V2API.ConditionalOperation;

    /**
     * A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
     */
    value: V2API.ConditionalValue;
  }
}

/**
 * The attribute to target.
 *
 * The following attributes may be targeted:
 *
 * - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
 *   business by the types of goods or services it provides.
 * - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
 *   ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
 *   Netherlands Antilles.
 * - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
 *   the transaction.
 * - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
 *   (merchant).
 * - `DESCRIPTOR`: Short description of card acceptor.
 * - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
 *   applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
 *   `TOKEN_AUTHENTICATED`.
 * - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
 *   (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
 *   `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
 *   `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
 *   `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
 * - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
 *   fee field in the settlement/cardholder billing currency. This is the amount
 *   the issuer should authorize against unless the issuer is paying the acquirer
 *   fee on behalf of the cardholder.
 * - `RISK_SCORE`: Network-provided score assessing risk level associated with a
 *   given authorization. Scores are on a range of 0-999, with 0 representing the
 *   lowest risk and 999 representing the highest risk. For Visa transactions,
 *   where the raw score has a range of 0-99, Lithic will normalize the score by
 *   multiplying the raw score by 10x.
 * - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
 *   trailing 15 minutes before the authorization.
 * - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
 *   trailing hour up and until the authorization.
 * - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
 *   trailing 24 hours up and until the authorization.
 * - `CARD_STATE`: The current state of the card associated with the transaction.
 *   Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
 *   `PENDING_FULFILLMENT`.
 * - `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction.
 *   Valid values are `TRUE`, `FALSE`.
 * - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
 *   `OK`, `BLOCKED`.
 * - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
 *   source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
 *   `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
 * - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
 *   data with the cardholder KYC data if it exists. Valid values are `MATCH`,
 *   `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
 */
export type ConditionalAttribute =
  | 'MCC'
  | 'COUNTRY'
  | 'CURRENCY'
  | 'MERCHANT_ID'
  | 'DESCRIPTOR'
  | 'LIABILITY_SHIFT'
  | 'PAN_ENTRY_MODE'
  | 'TRANSACTION_AMOUNT'
  | 'RISK_SCORE'
  | 'CARD_TRANSACTION_COUNT_15M'
  | 'CARD_TRANSACTION_COUNT_1H'
  | 'CARD_TRANSACTION_COUNT_24H'
  | 'CARD_STATE'
  | 'PIN_ENTERED'
  | 'PIN_STATUS'
  | 'WALLET_TYPE'
  | 'ADDRESS_MATCH';

export interface ConditionalAuthorizationActionParameters {
  /**
   * The action to take if the conditions are met.
   */
  action: 'DECLINE' | 'CHALLENGE';

  conditions: Array<ConditionalAuthorizationActionParameters.Condition>;
}

export namespace ConditionalAuthorizationActionParameters {
  export interface Condition {
    /**
     * The attribute to target.
     *
     * The following attributes may be targeted:
     *
     * - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
     *   business by the types of goods or services it provides.
     * - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
     *   ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
     *   Netherlands Antilles.
     * - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
     *   the transaction.
     * - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
     *   (merchant).
     * - `DESCRIPTOR`: Short description of card acceptor.
     * - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
     *   applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
     *   `TOKEN_AUTHENTICATED`.
     * - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
     *   (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
     *   `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
     *   `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
     *   `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
     * - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
     *   fee field in the settlement/cardholder billing currency. This is the amount
     *   the issuer should authorize against unless the issuer is paying the acquirer
     *   fee on behalf of the cardholder. Use an integer value.
     * - `CASH_AMOUNT`: The cash amount of the transaction in minor units (cents). This
     *   represents the amount of cash being withdrawn or advanced. Use an integer
     *   value.
     * - `RISK_SCORE`: Network-provided score assessing risk level associated with a
     *   given authorization. Scores are on a range of 0-999, with 0 representing the
     *   lowest risk and 999 representing the highest risk. For Visa transactions,
     *   where the raw score has a range of 0-99, Lithic will normalize the score by
     *   multiplying the raw score by 10x. Use an integer value.
     * - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
     *   trailing 15 minutes before the authorization. Use an integer value.
     * - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
     *   trailing hour up and until the authorization. Use an integer value.
     * - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
     *   trailing 24 hours up and until the authorization. Use an integer value.
     * - `CARD_DECLINE_COUNT_15M`: The number of declined transactions on the card in
     *   the trailing 15 minutes before the authorization. Use an integer value.
     * - `CARD_DECLINE_COUNT_1H`: The number of declined transactions on the card in
     *   the trailing hour up and until the authorization. Use an integer value.
     * - `CARD_DECLINE_COUNT_24H`: The number of declined transactions on the card in
     *   the trailing 24 hours up and until the authorization. Use an integer value.
     * - `CARD_STATE`: The current state of the card associated with the transaction.
     *   Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
     *   `PENDING_FULFILLMENT`.
     * - `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction.
     *   Valid values are `TRUE`, `FALSE`.
     * - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
     *   `OK`, `BLOCKED`.
     * - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
     *   source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
     *   `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
     * - `TRANSACTION_INITIATOR`: The entity that initiated the transaction indicates
     *   the source of the token. Valid values are `CARDHOLDER`, `MERCHANT`, `UNKNOWN`.
     * - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
     *   data with the cardholder KYC data if it exists. Valid values are `MATCH`,
     *   `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
     * - `SERVICE_LOCATION_STATE`: The state/province code (ISO 3166-2) where the
     *   cardholder received the service, e.g. "NY". When a service location is present
     *   in the network data, the service location state is used. Otherwise, falls back
     *   to the card acceptor state.
     * - `SERVICE_LOCATION_POSTAL_CODE`: The postal code where the cardholder received
     *   the service, e.g. "10001". When a service location is present in the network
     *   data, the service location postal code is used. Otherwise, falls back to the
     *   card acceptor postal code.
     * - `CARD_AGE`: The age of the card in seconds at the time of the authorization.
     *   Use an integer value.
     * - `ACCOUNT_AGE`: The age of the account holder's account in seconds at the time
     *   of the authorization. Use an integer value. For programs where Lithic does not
     *   manage or retain account holder data, this attribute does not evaluate.
     * - `AMOUNT_Z_SCORE`: The z-score of the transaction amount relative to the
     *   entity's transaction history. Null if fewer than 30 approved transactions in
     *   the specified window. Requires `parameters.scope` and `parameters.interval`.
     *   Use a decimal value.
     * - `AVG_TRANSACTION_AMOUNT`: The average approved transaction amount for the
     *   entity over the specified window, in cents. Requires `parameters.scope` and
     *   `parameters.interval`. Use a decimal value.
     * - `STDEV_TRANSACTION_AMOUNT`: The standard deviation of approved transaction
     *   amounts for the entity over the specified window, in cents. Null if fewer than
     *   30 approved transactions in the specified window. Requires `parameters.scope`
     *   and `parameters.interval`. Use a decimal value.
     * - `IS_NEW_COUNTRY`: Whether the transaction's merchant country has not been seen
     *   in the entity's transaction history. Valid values are `TRUE`, `FALSE`.
     *   Requires `parameters.scope`.
     * - `IS_NEW_MCC`: Whether the transaction's MCC has not been seen in the entity's
     *   transaction history. Valid values are `TRUE`, `FALSE`. Requires
     *   `parameters.scope`.
     * - `IS_FIRST_TRANSACTION`: Whether this is the first transaction for the entity.
     *   Valid values are `TRUE`, `FALSE`. Requires `parameters.scope`.
     * - `CONSECUTIVE_DECLINES`: The number of consecutive declined transactions for
     *   the entity over the last 30 days (rolling). Requires `parameters.scope`. Not
     *   supported for `BUSINESS_ACCOUNT` scope. Use an integer value.
     * - `TIME_SINCE_LAST_TRANSACTION`: The number of days since the last approved
     *   transaction for the entity, rounded to the nearest whole day. Requires
     *   `parameters.scope`. Use an integer value.
     * - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
     *   the entity's transaction history. Requires `parameters.scope`. Use an integer
     *   value.
     * - `IS_NEW_MERCHANT`: Whether the card acceptor ID has not been seen in the
     *   card's approved transaction history (capped at the 1000 most recently seen
     *   merchants). Valid values are `TRUE`, `FALSE`. Card-scoped only; no
     *   `parameters` required.
     * - `THREE_DS_SUCCESS_RATE`: The 3DS authentication success rate for the card, as
     *   a percentage from 0.0 to 100.0. Card-scoped only; no `parameters` required.
     *   Use a decimal value.
     * - `TRAVEL_SPEED`: The estimated speed of travel derived from the distance
     *   between the postal code centers of the last card-present transaction and the
     *   current transaction, divided by the elapsed time. Null if there is no prior
     *   card-present transaction, if either postal code cannot be geocoded, or if
     *   elapsed time is zero. Requires `parameters.unit` set to `MPH` or `KPH`. Use a
     *   decimal value.
     * - `DISTANCE_FROM_LAST_TRANSACTION`: The estimated distance between the postal
     *   code centers of the last card-present transaction and the current transaction.
     *   Null if there is no prior card-present transaction or if either postal code
     *   cannot be geocoded. Requires `parameters.unit` set to `MILES` or `KILOMETERS`.
     *   Use a decimal value.
     */
    attribute:
      | 'MCC'
      | 'COUNTRY'
      | 'CURRENCY'
      | 'MERCHANT_ID'
      | 'DESCRIPTOR'
      | 'LIABILITY_SHIFT'
      | 'PAN_ENTRY_MODE'
      | 'TRANSACTION_AMOUNT'
      | 'CASH_AMOUNT'
      | 'RISK_SCORE'
      | 'CARD_TRANSACTION_COUNT_15M'
      | 'CARD_TRANSACTION_COUNT_1H'
      | 'CARD_TRANSACTION_COUNT_24H'
      | 'CARD_DECLINE_COUNT_15M'
      | 'CARD_DECLINE_COUNT_1H'
      | 'CARD_DECLINE_COUNT_24H'
      | 'CARD_STATE'
      | 'PIN_ENTERED'
      | 'PIN_STATUS'
      | 'WALLET_TYPE'
      | 'TRANSACTION_INITIATOR'
      | 'ADDRESS_MATCH'
      | 'SERVICE_LOCATION_STATE'
      | 'SERVICE_LOCATION_POSTAL_CODE'
      | 'CARD_AGE'
      | 'ACCOUNT_AGE'
      | 'AMOUNT_Z_SCORE'
      | 'AVG_TRANSACTION_AMOUNT'
      | 'STDEV_TRANSACTION_AMOUNT'
      | 'IS_NEW_COUNTRY'
      | 'IS_NEW_MCC'
      | 'IS_FIRST_TRANSACTION'
      | 'CONSECUTIVE_DECLINES'
      | 'TIME_SINCE_LAST_TRANSACTION'
      | 'DISTINCT_COUNTRY_COUNT'
      | 'IS_NEW_MERCHANT'
      | 'THREE_DS_SUCCESS_RATE'
      | 'TRAVEL_SPEED'
      | 'DISTANCE_FROM_LAST_TRANSACTION';

    /**
     * The operation to apply to the attribute
     */
    operation: V2API.ConditionalOperation;

    /**
     * A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
     */
    value: V2API.ConditionalValue;

    /**
     * Additional parameters for certain attributes. Required when `attribute` is one
     * of `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`,
     * `IS_NEW_COUNTRY`, `IS_NEW_MCC`, `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`,
     * `TIME_SINCE_LAST_TRANSACTION`, or `DISTINCT_COUNTRY_COUNT` (require `scope`); or
     * `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used
     * for other attributes.
     */
    parameters?: Condition.Parameters;
  }

  export namespace Condition {
    /**
     * Additional parameters for certain attributes. Required when `attribute` is one
     * of `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`,
     * `IS_NEW_COUNTRY`, `IS_NEW_MCC`, `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`,
     * `TIME_SINCE_LAST_TRANSACTION`, or `DISTINCT_COUNTRY_COUNT` (require `scope`); or
     * `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used
     * for other attributes.
     */
    export interface Parameters {
      /**
       * The time window for statistical attributes (`AMOUNT_Z_SCORE`,
       * `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`). Use `LIFETIME` for
       * all-time history or a specific window (`7D`, `30D`, `90D`).
       */
      interval?: 'LIFETIME' | '7D' | '30D' | '90D';

      /**
       * The entity scope to evaluate the attribute against.
       */
      scope?: 'CARD' | 'ACCOUNT' | 'BUSINESS_ACCOUNT';

      /**
       * The unit for impossible travel attributes. Required when `attribute` is
       * `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION`.
       *
       * For `TRAVEL_SPEED`: `MPH` (miles per hour) or `KPH` (kilometers per hour).
       *
       * For `DISTANCE_FROM_LAST_TRANSACTION`: `MILES` or `KILOMETERS`.
       */
      unit?: 'MPH' | 'KPH' | 'MILES' | 'KILOMETERS';
    }
  }
}

export interface ConditionalAuthorizationAdjustmentParameters {
  /**
   * The hold adjustment to apply if the conditions are met.
   */
  action: ConditionalAuthorizationAdjustmentParameters.Action;

  conditions: Array<ConditionalAuthorizationAdjustmentParameters.Condition>;
}

export namespace ConditionalAuthorizationAdjustmentParameters {
  /**
   * The hold adjustment to apply if the conditions are met.
   */
  export interface Action {
    /**
     * The mode of the hold adjustment, determining how the value is interpreted:
     *
     * - `REPLACE_WITH_AMOUNT`: The value is the approved hold amount in cents.
     * - `ADD_PERCENTAGE`: The value adjusts the hold amount by a percentage. 1000
     *   represents a 10% increase, 0 represents no change.
     * - `ADD_AMOUNT`: The value is added to the hold amount in cents.
     */
    mode: 'REPLACE_WITH_AMOUNT' | 'ADD_PERCENTAGE' | 'ADD_AMOUNT';

    /**
     * The type of adjustment to apply
     */
    type: 'HOLD_ADJUSTMENT';

    /**
     * The value used for the hold adjustment, interpreted based on the mode
     */
    value: number;
  }

  export interface Condition {
    /**
     * The attribute to target.
     *
     * The following attributes may be targeted:
     *
     * - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
     *   business by the types of goods or services it provides.
     * - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
     *   ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
     *   Netherlands Antilles.
     * - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
     *   the transaction.
     * - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
     *   (merchant).
     * - `DESCRIPTOR`: Short description of card acceptor.
     * - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
     *   applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
     *   `TOKEN_AUTHENTICATED`.
     * - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
     *   (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
     *   `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
     *   `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
     *   `UNKNOWN`, `CREDENTIAL_ON_FILE`, or `ECOMMERCE`.
     * - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
     *   fee field in the settlement/cardholder billing currency. This is the amount
     *   the issuer should authorize against unless the issuer is paying the acquirer
     *   fee on behalf of the cardholder. Use an integer value.
     * - `CASH_AMOUNT`: The cash amount of the transaction in minor units (cents). This
     *   represents the amount of cash being withdrawn or advanced. Use an integer
     *   value.
     * - `RISK_SCORE`: Network-provided score assessing risk level associated with a
     *   given authorization. Scores are on a range of 0-999, with 0 representing the
     *   lowest risk and 999 representing the highest risk. For Visa transactions,
     *   where the raw score has a range of 0-99, Lithic will normalize the score by
     *   multiplying the raw score by 10x. Use an integer value.
     * - `CARD_TRANSACTION_COUNT_15M`: The number of transactions on the card in the
     *   trailing 15 minutes before the authorization. Use an integer value.
     * - `CARD_TRANSACTION_COUNT_1H`: The number of transactions on the card in the
     *   trailing hour up and until the authorization. Use an integer value.
     * - `CARD_TRANSACTION_COUNT_24H`: The number of transactions on the card in the
     *   trailing 24 hours up and until the authorization. Use an integer value.
     * - `CARD_DECLINE_COUNT_15M`: The number of declined transactions on the card in
     *   the trailing 15 minutes before the authorization. Use an integer value.
     * - `CARD_DECLINE_COUNT_1H`: The number of declined transactions on the card in
     *   the trailing hour up and until the authorization. Use an integer value.
     * - `CARD_DECLINE_COUNT_24H`: The number of declined transactions on the card in
     *   the trailing 24 hours up and until the authorization. Use an integer value.
     * - `CARD_STATE`: The current state of the card associated with the transaction.
     *   Valid values are `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`,
     *   `PENDING_FULFILLMENT`.
     * - `PIN_ENTERED`: Indicates whether a PIN was entered during the transaction.
     *   Valid values are `TRUE`, `FALSE`.
     * - `PIN_STATUS`: The current state of card's PIN. Valid values are `NOT_SET`,
     *   `OK`, `BLOCKED`.
     * - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
     *   source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
     *   `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
     * - `TRANSACTION_INITIATOR`: The entity that initiated the transaction indicates
     *   the source of the token. Valid values are `CARDHOLDER`, `MERCHANT`, `UNKNOWN`.
     * - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
     *   data with the cardholder KYC data if it exists. Valid values are `MATCH`,
     *   `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
     * - `SERVICE_LOCATION_STATE`: The state/province code (ISO 3166-2) where the
     *   cardholder received the service, e.g. "NY". When a service location is present
     *   in the network data, the service location state is used. Otherwise, falls back
     *   to the card acceptor state.
     * - `SERVICE_LOCATION_POSTAL_CODE`: The postal code where the cardholder received
     *   the service, e.g. "10001". When a service location is present in the network
     *   data, the service location postal code is used. Otherwise, falls back to the
     *   card acceptor postal code.
     * - `CARD_AGE`: The age of the card in seconds at the time of the authorization.
     *   Use an integer value.
     * - `ACCOUNT_AGE`: The age of the account holder's account in seconds at the time
     *   of the authorization. Use an integer value. For programs where Lithic does not
     *   manage or retain account holder data, this attribute does not evaluate.
     * - `AMOUNT_Z_SCORE`: The z-score of the transaction amount relative to the
     *   entity's transaction history. Null if fewer than 30 approved transactions in
     *   the specified window. Requires `parameters.scope` and `parameters.interval`.
     *   Use a decimal value.
     * - `AVG_TRANSACTION_AMOUNT`: The average approved transaction amount for the
     *   entity over the specified window, in cents. Requires `parameters.scope` and
     *   `parameters.interval`. Use a decimal value.
     * - `STDEV_TRANSACTION_AMOUNT`: The standard deviation of approved transaction
     *   amounts for the entity over the specified window, in cents. Null if fewer than
     *   30 approved transactions in the specified window. Requires `parameters.scope`
     *   and `parameters.interval`. Use a decimal value.
     * - `IS_NEW_COUNTRY`: Whether the transaction's merchant country has not been seen
     *   in the entity's transaction history. Valid values are `TRUE`, `FALSE`.
     *   Requires `parameters.scope`.
     * - `IS_NEW_MCC`: Whether the transaction's MCC has not been seen in the entity's
     *   transaction history. Valid values are `TRUE`, `FALSE`. Requires
     *   `parameters.scope`.
     * - `IS_FIRST_TRANSACTION`: Whether this is the first transaction for the entity.
     *   Valid values are `TRUE`, `FALSE`. Requires `parameters.scope`.
     * - `CONSECUTIVE_DECLINES`: The number of consecutive declined transactions for
     *   the entity over the last 30 days (rolling). Requires `parameters.scope`. Not
     *   supported for `BUSINESS_ACCOUNT` scope. Use an integer value.
     * - `TIME_SINCE_LAST_TRANSACTION`: The number of days since the last approved
     *   transaction for the entity, rounded to the nearest whole day. Requires
     *   `parameters.scope`. Use an integer value.
     * - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
     *   the entity's transaction history. Requires `parameters.scope`. Use an integer
     *   value.
     * - `IS_NEW_MERCHANT`: Whether the card acceptor ID has not been seen in the
     *   card's approved transaction history (capped at the 1000 most recently seen
     *   merchants). Valid values are `TRUE`, `FALSE`. Card-scoped only; no
     *   `parameters` required.
     * - `THREE_DS_SUCCESS_RATE`: The 3DS authentication success rate for the card, as
     *   a percentage from 0.0 to 100.0. Card-scoped only; no `parameters` required.
     *   Use a decimal value.
     * - `TRAVEL_SPEED`: The estimated speed of travel derived from the distance
     *   between the postal code centers of the last card-present transaction and the
     *   current transaction, divided by the elapsed time. Null if there is no prior
     *   card-present transaction, if either postal code cannot be geocoded, or if
     *   elapsed time is zero. Requires `parameters.unit` set to `MPH` or `KPH`. Use a
     *   decimal value.
     * - `DISTANCE_FROM_LAST_TRANSACTION`: The estimated distance between the postal
     *   code centers of the last card-present transaction and the current transaction.
     *   Null if there is no prior card-present transaction or if either postal code
     *   cannot be geocoded. Requires `parameters.unit` set to `MILES` or `KILOMETERS`.
     *   Use a decimal value.
     */
    attribute:
      | 'MCC'
      | 'COUNTRY'
      | 'CURRENCY'
      | 'MERCHANT_ID'
      | 'DESCRIPTOR'
      | 'LIABILITY_SHIFT'
      | 'PAN_ENTRY_MODE'
      | 'TRANSACTION_AMOUNT'
      | 'CASH_AMOUNT'
      | 'RISK_SCORE'
      | 'CARD_TRANSACTION_COUNT_15M'
      | 'CARD_TRANSACTION_COUNT_1H'
      | 'CARD_TRANSACTION_COUNT_24H'
      | 'CARD_DECLINE_COUNT_15M'
      | 'CARD_DECLINE_COUNT_1H'
      | 'CARD_DECLINE_COUNT_24H'
      | 'CARD_STATE'
      | 'PIN_ENTERED'
      | 'PIN_STATUS'
      | 'WALLET_TYPE'
      | 'TRANSACTION_INITIATOR'
      | 'ADDRESS_MATCH'
      | 'SERVICE_LOCATION_STATE'
      | 'SERVICE_LOCATION_POSTAL_CODE'
      | 'CARD_AGE'
      | 'ACCOUNT_AGE'
      | 'AMOUNT_Z_SCORE'
      | 'AVG_TRANSACTION_AMOUNT'
      | 'STDEV_TRANSACTION_AMOUNT'
      | 'IS_NEW_COUNTRY'
      | 'IS_NEW_MCC'
      | 'IS_FIRST_TRANSACTION'
      | 'CONSECUTIVE_DECLINES'
      | 'TIME_SINCE_LAST_TRANSACTION'
      | 'DISTINCT_COUNTRY_COUNT'
      | 'IS_NEW_MERCHANT'
      | 'THREE_DS_SUCCESS_RATE'
      | 'TRAVEL_SPEED'
      | 'DISTANCE_FROM_LAST_TRANSACTION';

    /**
     * The operation to apply to the attribute
     */
    operation: V2API.ConditionalOperation;

    /**
     * A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
     */
    value: V2API.ConditionalValue;

    /**
     * Additional parameters for certain attributes. Required when `attribute` is one
     * of `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`,
     * `IS_NEW_COUNTRY`, `IS_NEW_MCC`, `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`,
     * `TIME_SINCE_LAST_TRANSACTION`, or `DISTINCT_COUNTRY_COUNT` (require `scope`); or
     * `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used
     * for other attributes.
     */
    parameters?: Condition.Parameters;
  }

  export namespace Condition {
    /**
     * Additional parameters for certain attributes. Required when `attribute` is one
     * of `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`,
     * `IS_NEW_COUNTRY`, `IS_NEW_MCC`, `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`,
     * `TIME_SINCE_LAST_TRANSACTION`, or `DISTINCT_COUNTRY_COUNT` (require `scope`); or
     * `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used
     * for other attributes.
     */
    export interface Parameters {
      /**
       * The time window for statistical attributes (`AMOUNT_Z_SCORE`,
       * `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`). Use `LIFETIME` for
       * all-time history or a specific window (`7D`, `30D`, `90D`).
       */
      interval?: 'LIFETIME' | '7D' | '30D' | '90D';

      /**
       * The entity scope to evaluate the attribute against.
       */
      scope?: 'CARD' | 'ACCOUNT' | 'BUSINESS_ACCOUNT';

      /**
       * The unit for impossible travel attributes. Required when `attribute` is
       * `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION`.
       *
       * For `TRAVEL_SPEED`: `MPH` (miles per hour) or `KPH` (kilometers per hour).
       *
       * For `DISTANCE_FROM_LAST_TRANSACTION`: `MILES` or `KILOMETERS`.
       */
      unit?: 'MPH' | 'KPH' | 'MILES' | 'KILOMETERS';
    }
  }
}

/**
 * @deprecated Deprecated: Use CONDITIONAL_ACTION instead.
 */
export interface ConditionalBlockParameters {
  conditions: Array<AuthRuleCondition>;
}

export interface ConditionalCardTransactionUpdateActionParameters {
  /**
   * The action to take if the conditions are met.
   */
  action: CardTransactionUpdateAction;

  conditions: Array<ConditionalCardTransactionUpdateActionParameters.Condition>;
}

export namespace ConditionalCardTransactionUpdateActionParameters {
  export interface Condition {
    /**
     * The attribute to target.
     *
     * The following attributes may be targeted:
     *
     * - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
     *   business by the types of goods or services it provides.
     * - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
     *   ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
     *   Netherlands Antilles.
     * - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
     *   the transaction.
     * - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
     *   (merchant).
     * - `DESCRIPTOR`: Short description of card acceptor.
     * - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
     *   fee field in the settlement/cardholder billing currency. This is the amount
     *   the issuer should authorize against unless the issuer is paying the acquirer
     *   fee on behalf of the cardholder. Use an integer value.
     * - `RISK_SCORE`: Network-provided score assessing risk level associated with a
     *   given authorization. Scores are on a range of 0-999, with 0 representing the
     *   lowest risk and 999 representing the highest risk. For Visa transactions,
     *   where the raw score has a range of 0-99, Lithic will normalize the score by
     *   multiplying the raw score by 10x. Use an integer value.
     * - `TRANSACTION_STATUS`: The status of the transaction. Valid values are
     *   `PENDING`, `VOIDED`, `SETTLING`, `SETTLED`, `BOUNCED`, `RETURNED`, `DECLINED`,
     *   `EXPIRED`.
     * - `LAST_EVENT_TYPE`: The type of the most recent event on the transaction. Valid
     *   values are `AUTHORIZATION`, `AUTHORIZATION_ADVICE`, `AUTHORIZATION_EXPIRY`,
     *   `AUTHORIZATION_REVERSAL`, `BALANCE_INQUIRY`, `CLEARING`, `CORRECTION_CREDIT`,
     *   `CORRECTION_DEBIT`, `CREDIT_AUTHORIZATION`, `CREDIT_AUTHORIZATION_ADVICE`,
     *   `FINANCIAL_AUTHORIZATION`, `FINANCIAL_CREDIT_AUTHORIZATION`, `RETURN`,
     *   `RETURN_REVERSAL`.
     * - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
     *   applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
     *   `TOKEN_AUTHENTICATED`.
     * - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
     *   (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
     *   `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
     *   `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
     *   `UNKNOWN`, or `CREDENTIAL_ON_FILE`.
     * - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
     *   source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
     *   `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
     * - `CARD_AGE`: The age of the card in seconds at the time of the transaction. Use
     *   an integer value.
     * - `ACCOUNT_AGE`: The age of the account in seconds at the time of the
     *   transaction. Use an integer value. For programs where Lithic does not manage
     *   or retain account holder data, this attribute does not evaluate.
     * - `SPEND_VELOCITY_COUNT`: The number of transactions matching the specified
     *   filters within the given period. Requires `parameters` with `scope`, `period`,
     *   and optional `filters`. Use an integer value.
     * - `SPEND_VELOCITY_AMOUNT`: The total spend amount (in cents) of transactions
     *   matching the specified filters within the given period. Requires `parameters`
     *   with `scope`, `period`, and optional `filters`. Use an integer value.
     * - `AMOUNT_Z_SCORE`: The z-score of the transaction amount relative to the
     *   entity's transaction history. Null if fewer than 30 approved transactions in
     *   the specified window. Requires `parameters.scope` and `parameters.interval`.
     *   Use a decimal value.
     * - `AVG_TRANSACTION_AMOUNT`: The average approved transaction amount for the
     *   entity over the specified window, in cents. Requires `parameters.scope` and
     *   `parameters.interval`. Use a decimal value.
     * - `STDEV_TRANSACTION_AMOUNT`: The standard deviation of approved transaction
     *   amounts for the entity over the specified window, in cents. Null if fewer than
     *   30 approved transactions in the specified window. Requires `parameters.scope`
     *   and `parameters.interval`. Use a decimal value.
     * - `IS_NEW_COUNTRY`: Whether the transaction's merchant country has not been seen
     *   in the entity's transaction history. Valid values are `TRUE`, `FALSE`.
     *   Requires `parameters.scope`.
     * - `IS_NEW_MCC`: Whether the transaction's MCC has not been seen in the entity's
     *   transaction history. Valid values are `TRUE`, `FALSE`. Requires
     *   `parameters.scope`.
     * - `IS_FIRST_TRANSACTION`: Whether this is the first transaction for the entity.
     *   Valid values are `TRUE`, `FALSE`. Requires `parameters.scope`.
     * - `CONSECUTIVE_DECLINES`: The number of consecutive declined transactions for
     *   the entity over the last 30 days (rolling). Requires `parameters.scope`. Use
     *   an integer value.
     * - `TIME_SINCE_LAST_TRANSACTION`: The number of days since the last approved
     *   transaction for the entity, rounded to the nearest whole day. Requires
     *   `parameters.scope`. Use an integer value.
     * - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
     *   the entity's transaction history. Requires `parameters.scope`. Use an integer
     *   value.
     * - `IS_NEW_MERCHANT`: Whether the card acceptor ID has not been seen in the
     *   card's approved transaction history (capped at the 1000 most recently seen
     *   merchants). Valid values are `TRUE`, `FALSE`. Card-scoped only; no
     *   `parameters` required.
     * - `THREE_DS_SUCCESS_RATE`: The 3DS authentication success rate for the card, as
     *   a percentage from 0.0 to 100.0. Card-scoped only; no `parameters` required.
     *   Use a decimal value.
     * - `TRAVEL_SPEED`: The estimated speed of travel derived from the distance
     *   between the postal code centers of the last card-present transaction and the
     *   current transaction, divided by the elapsed time. Null if there is no prior
     *   card-present transaction, if either postal code cannot be geocoded, or if
     *   elapsed time is zero. Requires `parameters.unit` set to `MPH` or `KPH`. Use a
     *   decimal value.
     * - `DISTANCE_FROM_LAST_TRANSACTION`: The estimated distance between the postal
     *   code centers of the last card-present transaction and the current transaction.
     *   Null if there is no prior card-present transaction or if either postal code
     *   cannot be geocoded. Requires `parameters.unit` set to `MILES` or `KILOMETERS`.
     *   Use a decimal value.
     */
    attribute:
      | 'MCC'
      | 'COUNTRY'
      | 'CURRENCY'
      | 'MERCHANT_ID'
      | 'DESCRIPTOR'
      | 'TRANSACTION_AMOUNT'
      | 'RISK_SCORE'
      | 'TRANSACTION_STATUS'
      | 'LAST_EVENT_TYPE'
      | 'LIABILITY_SHIFT'
      | 'PAN_ENTRY_MODE'
      | 'WALLET_TYPE'
      | 'CARD_AGE'
      | 'ACCOUNT_AGE'
      | 'SPEND_VELOCITY_COUNT'
      | 'SPEND_VELOCITY_AMOUNT'
      | 'AMOUNT_Z_SCORE'
      | 'AVG_TRANSACTION_AMOUNT'
      | 'STDEV_TRANSACTION_AMOUNT'
      | 'IS_NEW_COUNTRY'
      | 'IS_NEW_MCC'
      | 'IS_FIRST_TRANSACTION'
      | 'CONSECUTIVE_DECLINES'
      | 'TIME_SINCE_LAST_TRANSACTION'
      | 'DISTINCT_COUNTRY_COUNT'
      | 'IS_NEW_MERCHANT'
      | 'THREE_DS_SUCCESS_RATE'
      | 'TRAVEL_SPEED'
      | 'DISTANCE_FROM_LAST_TRANSACTION';

    /**
     * The operation to apply to the attribute
     */
    operation: V2API.ConditionalOperation;

    /**
     * A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
     */
    value: V2API.ConditionalValue;

    /**
     * Additional parameters for certain attributes. Required when `attribute` is
     * `SPEND_VELOCITY_COUNT` or `SPEND_VELOCITY_AMOUNT` (require `scope`, `period`,
     * and optional `filters`); `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`,
     * `STDEV_TRANSACTION_AMOUNT`, `IS_NEW_COUNTRY`, `IS_NEW_MCC`,
     * `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`, `TIME_SINCE_LAST_TRANSACTION`,
     * or `DISTINCT_COUNTRY_COUNT` (require `scope`, and additionally `interval` for
     * the statistical attributes); or `TRAVEL_SPEED` or
     * `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used for other
     * attributes.
     */
    parameters?: Condition.Parameters;
  }

  export namespace Condition {
    /**
     * Additional parameters for certain attributes. Required when `attribute` is
     * `SPEND_VELOCITY_COUNT` or `SPEND_VELOCITY_AMOUNT` (require `scope`, `period`,
     * and optional `filters`); `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`,
     * `STDEV_TRANSACTION_AMOUNT`, `IS_NEW_COUNTRY`, `IS_NEW_MCC`,
     * `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`, `TIME_SINCE_LAST_TRANSACTION`,
     * or `DISTINCT_COUNTRY_COUNT` (require `scope`, and additionally `interval` for
     * the statistical attributes); or `TRAVEL_SPEED` or
     * `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used for other
     * attributes.
     */
    export interface Parameters {
      filters?: V2API.SpendVelocityFilters;

      /**
       * The time window for statistical attributes (`AMOUNT_Z_SCORE`,
       * `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`). Use `LIFETIME` for
       * all-time history or a specific window (`7D`, `30D`, `90D`).
       */
      interval?: 'LIFETIME' | '7D' | '30D' | '90D';

      /**
       * The time period over which to calculate the spend velocity.
       */
      period?: V2API.VelocityLimitPeriod;

      /**
       * The entity scope to evaluate the attribute against. `GLOBAL` is only valid for
       * spend velocity attributes.
       */
      scope?: 'CARD' | 'ACCOUNT' | 'GLOBAL';

      /**
       * The unit for impossible travel attributes. Required when `attribute` is
       * `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION`.
       *
       * For `TRAVEL_SPEED`: `MPH` (miles per hour) or `KPH` (kilometers per hour).
       *
       * For `DISTANCE_FROM_LAST_TRANSACTION`: `MILES` or `KILOMETERS`.
       */
      unit?: 'MPH' | 'KPH' | 'MILES' | 'KILOMETERS';
    }
  }
}

/**
 * The operation to apply to the attribute
 */
export type ConditionalOperation =
  | 'IS_ONE_OF'
  | 'IS_NOT_ONE_OF'
  | 'MATCHES'
  | 'DOES_NOT_MATCH'
  | 'IS_EQUAL_TO'
  | 'IS_NOT_EQUAL_TO'
  | 'IS_GREATER_THAN'
  | 'IS_GREATER_THAN_OR_EQUAL_TO'
  | 'IS_LESS_THAN'
  | 'IS_LESS_THAN_OR_EQUAL_TO'
  | 'IS_AFTER'
  | 'IS_BEFORE'
  | 'CONTAINS_ANY'
  | 'CONTAINS_ALL'
  | 'CONTAINS_NONE';

export interface ConditionalTokenizationActionParameters {
  /**
   * The action to take if the conditions are met.
   */
  action:
    | ConditionalTokenizationActionParameters.DeclineActionTokenization
    | ConditionalTokenizationActionParameters.RequireTfaAction;

  conditions: Array<ConditionalTokenizationActionParameters.Condition>;
}

export namespace ConditionalTokenizationActionParameters {
  export interface DeclineActionTokenization {
    /**
     * Decline the tokenization request
     */
    type: 'DECLINE';

    /**
     * Reason code for declining the tokenization request
     */
    reason?:
      | 'ACCOUNT_SCORE_1'
      | 'DEVICE_SCORE_1'
      | 'ALL_WALLET_DECLINE_REASONS_PRESENT'
      | 'WALLET_RECOMMENDED_DECISION_RED'
      | 'CVC_MISMATCH'
      | 'CARD_EXPIRY_MONTH_MISMATCH'
      | 'CARD_EXPIRY_YEAR_MISMATCH'
      | 'CARD_INVALID_STATE'
      | 'CUSTOMER_RED_PATH'
      | 'INVALID_CUSTOMER_RESPONSE'
      | 'NETWORK_FAILURE'
      | 'GENERIC_DECLINE'
      | 'DIGITAL_CARD_ART_REQUIRED';
  }

  export interface RequireTfaAction {
    /**
     * Require two-factor authentication for the tokenization request
     */
    type: 'REQUIRE_TFA';

    /**
     * Reason code for requiring two-factor authentication
     */
    reason?:
      | 'WALLET_RECOMMENDED_TFA'
      | 'SUSPICIOUS_ACTIVITY'
      | 'DEVICE_RECENTLY_LOST'
      | 'TOO_MANY_RECENT_ATTEMPTS'
      | 'TOO_MANY_RECENT_TOKENS'
      | 'TOO_MANY_DIFFERENT_CARDHOLDERS'
      | 'OUTSIDE_HOME_TERRITORY'
      | 'HAS_SUSPENDED_TOKENS'
      | 'HIGH_RISK'
      | 'ACCOUNT_SCORE_LOW'
      | 'DEVICE_SCORE_LOW'
      | 'CARD_STATE_TFA'
      | 'HARDCODED_TFA'
      | 'CUSTOMER_RULE_TFA'
      | 'DEVICE_HOST_CARD_EMULATION';
  }

  export interface Condition {
    /**
     * The attribute to target.
     *
     * The following attributes may be targeted:
     *
     * - `TIMESTAMP`: The timestamp of the tokenization request in ISO 8601 format.
     * - `TOKENIZATION_CHANNEL`: The channel through which the tokenization request was
     *   initiated. Valid values are `DIGITAL_WALLET`, `MERCHANT`.
     * - `TOKENIZATION_SOURCE`: The source of the tokenization request. Valid values
     *   are `ACCOUNT_ON_FILE`, `MANUAL_PROVISION`, `PUSH_PROVISION`, `CHIP_DIP`,
     *   `CONTACTLESS_TAP`, `TOKEN`, `UNKNOWN`.
     * - `TOKEN_REQUESTOR_NAME`: The name of the entity requesting the token. Valid
     *   values are `ALT_ID`, `AMAZON_ONE`, `AMERICAN_EXPRESS_TOKEN_SERVICE`,
     *   `ANDROID_PAY`, `APPLE_PAY`, `FACEBOOK`, `FITBIT_PAY`, `GARMIN_PAY`,
     *   `GOOGLE_PAY`, `GOOGLE_VCN`, `ISSUER_HCE`, `MICROSOFT_PAY`, `NETFLIX`,
     *   `SAMSUNG_PAY`, `UNKNOWN`, `VISA_CHECKOUT`.
     * - `WALLET_ACCOUNT_SCORE`: Risk score for the account in the digital wallet.
     *   Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2
     *   = medium risk). Use an integer value.
     * - `WALLET_DEVICE_SCORE`: Risk score for the device in the digital wallet.
     *   Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2
     *   = medium risk). Use an integer value.
     * - `WALLET_RECOMMENDED_DECISION`: The decision recommended by the digital wallet
     *   provider. Valid values include APPROVE, DECLINE,
     *   REQUIRE_ADDITIONAL_AUTHENTICATION.
     * - `WALLET_RECOMMENDATION_REASONS`: List of reasons provided by the digital
     *   wallet provider for the recommended decision. Valid values are:
     *   - Common: `ACCOUNT_CARD_TOO_NEW`, `ACCOUNT_RECENTLY_CHANGED`,
     *     `ACCOUNT_TOO_NEW`, `ACCOUNT_TOO_NEW_SINCE_LAUNCH`, `DEVICE_RECENTLY_LOST`,
     *     `HAS_SUSPENDED_TOKENS`, `HIGH_RISK`, `INACTIVE_ACCOUNT`,
     *     `LOW_ACCOUNT_SCORE`, `LOW_DEVICE_SCORE`, `OUTSIDE_HOME_TERRITORY`,
     *     `SUSPICIOUS_ACTIVITY`, `TOO_MANY_DIFFERENT_CARDHOLDERS`,
     *     `TOO_MANY_RECENT_ATTEMPTS`, `TOO_MANY_RECENT_TOKENS`, `UNABLE_TO_ASSESS`
     *   - Visa only: `ACCOUNT_DATA_RECENTLY_CHANGED`, `ACCOUNT_PAN_PAIRING_TOO_NEW`,
     *     `LOW_TRANSACTION_VOLUME`, `USER_ACCOUNT_DEVICE_TOO_NEW`,
     *     `WALLET_ACCOUNT_TOO_NEW`
     *   - Amex only: `DEVICE_USING_VPN_PROXY`,
     *     `EXCESSIVE_BILLING_NAME_ATTEMPTS_MODERATE`,
     *     `EXCESSIVE_BILLING_NAME_ATTEMPTS_SEVERE`,
     *     `EXCESSIVE_CARD_PROVISION_ATTEMPTS_MODERATE`,
     *     `EXCESSIVE_CARD_PROVISION_ATTEMPTS_SEVERE`, `EXCESSIVE_WALLET_RESETS`,
     *     `EXCESSIVE_ZIP_ATTEMPTS_MODERATE`, `EXCESSIVE_ZIP_ATTEMPTS_SEVERE`,
     *     `USER_ID_CARD_PAIRING_TOO_NEW`, `USER_ID_DEVICE_ID_PAIRING_TOO_NEW`,
     *     `USER_ID_OS_ID_PAIRING_TOO_NEW`, `USER_ID_TOO_NEW`
     * - `TOKEN_REQUESTOR_ID`: Unique identifier for the entity requesting the token.
     * - `WALLET_TOKEN_STATUS`: The current status of the wallet token.
     * - `CARD_STATE`: The state of the card being tokenized. Valid values are
     *   `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`, `PENDING_FULFILLMENT`.
     */
    attribute:
      | 'TIMESTAMP'
      | 'TOKENIZATION_CHANNEL'
      | 'TOKENIZATION_SOURCE'
      | 'TOKEN_REQUESTOR_NAME'
      | 'WALLET_ACCOUNT_SCORE'
      | 'WALLET_DEVICE_SCORE'
      | 'WALLET_RECOMMENDED_DECISION'
      | 'WALLET_RECOMMENDATION_REASONS'
      | 'TOKEN_REQUESTOR_ID'
      | 'WALLET_TOKEN_STATUS'
      | 'CARD_STATE';

    /**
     * The operation to apply to the attribute
     */
    operation: V2API.ConditionalOperation;

    /**
     * A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
     */
    value: V2API.ConditionalValue;
  }
}

/**
 * A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
 */
export type ConditionalValue = string | number | number | Array<string> | (string & {});

/**
 * The event stream during which the rule will be evaluated.
 */
export type EventStream =
  | 'AUTHORIZATION'
  | 'THREE_DS_AUTHENTICATION'
  | 'TOKENIZATION'
  | 'ACH_CREDIT_RECEIPT'
  | 'ACH_DEBIT_RECEIPT'
  | 'CARD_TRANSACTION_UPDATE'
  | 'ACH_PAYMENT_UPDATE';

export interface MerchantLockParameters {
  /**
   * A list of merchant locks defining specific merchants or groups of merchants
   * (based on descriptors or IDs) that the lock applies to.
   */
  merchants: Array<MerchantLockParameters.Merchant>;
}

export namespace MerchantLockParameters {
  /**
   * Represents a specific merchant lock based on their ID or descriptor. Each
   * merchant object allows transaction rules to work at a granular level and
   * requires at least one of merchant_id or descriptor.
   */
  export interface Merchant {
    /**
     * A comment or explanation about the merchant, used internally for rule management
     * purposes.
     */
    comment?: string;

    /**
     * Short description of the merchant, often used to provide more human-readable
     * context about the transaction merchant. This is typically the name or label
     * shown on transaction summaries.
     */
    descriptor?: string;

    /**
     * Unique alphanumeric identifier for the payment card acceptor (merchant). This
     * attribute specifies the merchant entity that will be locked or referenced for
     * authorization rules.
     */
    merchant_id?: string;
  }
}

export interface ReportStats {
  /**
   * A mapping of action types to the number of times that action was returned by
   * this version during the relevant period. Actions are the possible outcomes of a
   * rule evaluation, such as DECLINE, CHALLENGE, REQUIRE_TFA, etc. In case rule
   * didn't trigger any action, it's counted under NO_ACTION key.
   */
  action_counts: { [key: string]: number };

  /**
   * Example events and their outcomes for this version.
   */
  examples: Array<ReportStats.Example>;

  /**
   * The evaluation mode of this version during the reported period.
   */
  state: 'ACTIVE' | 'SHADOW' | 'INACTIVE';

  /**
   * The rule version number.
   */
  version: number;
}

export namespace ReportStats {
  export interface Example {
    /**
     * The actions taken by this version for this event.
     */
    actions: Array<
      | Example.DeclineActionAuthorization
      | Example.ChallengeActionAuthorization
      | Example.ResultAuthentication3DSAction
      | Example.DeclineActionTokenization
      | Example.RequireTfaAction
      | Example.ApproveActionACH
      | Example.ReturnAction
    >;

    /**
     * The event token.
     */
    event_token: string;

    /**
     * The timestamp of the event.
     */
    timestamp: string;

    /**
     * The token of the transaction associated with the event
     */
    transaction_token?: string | null;
  }

  export namespace Example {
    export interface DeclineActionAuthorization {
      /**
       * The detailed result code explaining the specific reason for the decline
       */
      code:
        | 'ACCOUNT_DAILY_SPEND_LIMIT_EXCEEDED'
        | 'ACCOUNT_DELINQUENT'
        | 'ACCOUNT_INACTIVE'
        | 'ACCOUNT_LIFETIME_SPEND_LIMIT_EXCEEDED'
        | 'ACCOUNT_MONTHLY_SPEND_LIMIT_EXCEEDED'
        | 'ACCOUNT_PAUSED'
        | 'ACCOUNT_UNDER_REVIEW'
        | 'ADDRESS_INCORRECT'
        | 'APPROVED'
        | 'AUTH_RULE_ALLOWED_COUNTRY'
        | 'AUTH_RULE_ALLOWED_MCC'
        | 'AUTH_RULE_BLOCKED_COUNTRY'
        | 'AUTH_RULE_BLOCKED_MCC'
        | 'AUTH_RULE'
        | 'CARD_CLOSED'
        | 'CARD_CRYPTOGRAM_VALIDATION_FAILURE'
        | 'CARD_EXPIRED'
        | 'CARD_EXPIRY_DATE_INCORRECT'
        | 'CARD_INVALID'
        | 'CARD_NOT_ACTIVATED'
        | 'CARD_PAUSED'
        | 'CARD_PIN_INCORRECT'
        | 'CARD_RESTRICTED'
        | 'CARD_SECURITY_CODE_INCORRECT'
        | 'CARD_SPEND_LIMIT_EXCEEDED'
        | 'CONTACT_CARD_ISSUER'
        | 'CUSTOMER_ASA_TIMEOUT'
        | 'CUSTOM_ASA_RESULT'
        | 'DECLINED'
        | 'DO_NOT_HONOR'
        | 'DRIVER_NUMBER_INVALID'
        | 'FORMAT_ERROR'
        | 'INSUFFICIENT_FUNDING_SOURCE_BALANCE'
        | 'INSUFFICIENT_FUNDS'
        | 'LITHIC_SYSTEM_ERROR'
        | 'LITHIC_SYSTEM_RATE_LIMIT'
        | 'MALFORMED_ASA_RESPONSE'
        | 'MERCHANT_INVALID'
        | 'MERCHANT_LOCKED_CARD_ATTEMPTED_ELSEWHERE'
        | 'MERCHANT_NOT_PERMITTED'
        | 'OVER_REVERSAL_ATTEMPTED'
        | 'PIN_BLOCKED'
        | 'PROGRAM_CARD_SPEND_LIMIT_EXCEEDED'
        | 'PROGRAM_SUSPENDED'
        | 'PROGRAM_USAGE_RESTRICTION'
        | 'REVERSAL_UNMATCHED'
        | 'SECURITY_VIOLATION'
        | 'SINGLE_USE_CARD_REATTEMPTED'
        | 'SUSPECTED_FRAUD'
        | 'TRANSACTION_INVALID'
        | 'TRANSACTION_NOT_PERMITTED_TO_ACQUIRER_OR_TERMINAL'
        | 'TRANSACTION_NOT_PERMITTED_TO_ISSUER_OR_CARDHOLDER'
        | 'TRANSACTION_PREVIOUSLY_COMPLETED'
        | 'UNAUTHORIZED_MERCHANT'
        | 'VEHICLE_NUMBER_INVALID'
        | 'CARDHOLDER_CHALLENGED'
        | 'CARDHOLDER_CHALLENGE_FAILED';

      type: 'DECLINE';
    }

    export interface ChallengeActionAuthorization {
      type: 'CHALLENGE';
    }

    export interface ResultAuthentication3DSAction {
      type: 'DECLINE' | 'CHALLENGE';
    }

    export interface DeclineActionTokenization {
      /**
       * Decline the tokenization request
       */
      type: 'DECLINE';

      /**
       * Reason code for declining the tokenization request
       */
      reason?:
        | 'ACCOUNT_SCORE_1'
        | 'DEVICE_SCORE_1'
        | 'ALL_WALLET_DECLINE_REASONS_PRESENT'
        | 'WALLET_RECOMMENDED_DECISION_RED'
        | 'CVC_MISMATCH'
        | 'CARD_EXPIRY_MONTH_MISMATCH'
        | 'CARD_EXPIRY_YEAR_MISMATCH'
        | 'CARD_INVALID_STATE'
        | 'CUSTOMER_RED_PATH'
        | 'INVALID_CUSTOMER_RESPONSE'
        | 'NETWORK_FAILURE'
        | 'GENERIC_DECLINE'
        | 'DIGITAL_CARD_ART_REQUIRED';
    }

    export interface RequireTfaAction {
      /**
       * Require two-factor authentication for the tokenization request
       */
      type: 'REQUIRE_TFA';

      /**
       * Reason code for requiring two-factor authentication
       */
      reason?:
        | 'WALLET_RECOMMENDED_TFA'
        | 'SUSPICIOUS_ACTIVITY'
        | 'DEVICE_RECENTLY_LOST'
        | 'TOO_MANY_RECENT_ATTEMPTS'
        | 'TOO_MANY_RECENT_TOKENS'
        | 'TOO_MANY_DIFFERENT_CARDHOLDERS'
        | 'OUTSIDE_HOME_TERRITORY'
        | 'HAS_SUSPENDED_TOKENS'
        | 'HIGH_RISK'
        | 'ACCOUNT_SCORE_LOW'
        | 'DEVICE_SCORE_LOW'
        | 'CARD_STATE_TFA'
        | 'HARDCODED_TFA'
        | 'CUSTOMER_RULE_TFA'
        | 'DEVICE_HOST_CARD_EMULATION';
    }

    export interface ApproveActionACH {
      /**
       * Approve the ACH transaction
       */
      type: 'APPROVE';
    }

    export interface ReturnAction {
      /**
       * NACHA return code to use when returning the transaction. Note that the list of
       * available return codes is subject to an allowlist configured at the program
       * level
       */
      code:
        | 'R01'
        | 'R02'
        | 'R03'
        | 'R04'
        | 'R05'
        | 'R06'
        | 'R07'
        | 'R08'
        | 'R09'
        | 'R10'
        | 'R11'
        | 'R12'
        | 'R13'
        | 'R14'
        | 'R15'
        | 'R16'
        | 'R17'
        | 'R18'
        | 'R19'
        | 'R20'
        | 'R21'
        | 'R22'
        | 'R23'
        | 'R24'
        | 'R25'
        | 'R26'
        | 'R27'
        | 'R28'
        | 'R29'
        | 'R30'
        | 'R31'
        | 'R32'
        | 'R33'
        | 'R34'
        | 'R35'
        | 'R36'
        | 'R37'
        | 'R38'
        | 'R39'
        | 'R40'
        | 'R41'
        | 'R42'
        | 'R43'
        | 'R44'
        | 'R45'
        | 'R46'
        | 'R47'
        | 'R50'
        | 'R51'
        | 'R52'
        | 'R53'
        | 'R61'
        | 'R62'
        | 'R67'
        | 'R68'
        | 'R69'
        | 'R70'
        | 'R71'
        | 'R72'
        | 'R73'
        | 'R74'
        | 'R75'
        | 'R76'
        | 'R77'
        | 'R80'
        | 'R81'
        | 'R82'
        | 'R83'
        | 'R84'
        | 'R85';

      /**
       * Return the ACH transaction
       */
      type: 'RETURN';
    }
  }
}

/**
 * A feature made available to the rule. The `name` field is the variable name used
 * in the rule function signature. The `type` field determines which data the
 * feature provides to the rule at evaluation time.
 *
 * - `AUTHORIZATION`: The authorization request being evaluated. Only available for
 *   AUTHORIZATION event stream rules.
 * - `AUTHENTICATION`: The 3DS authentication request being evaluated. Only
 *   available for THREE_DS_AUTHENTICATION event stream rules.
 * - `TOKENIZATION`: The tokenization request being evaluated. Only available for
 *   TOKENIZATION event stream rules.
 * - `ACH_RECEIPT`: The ACH receipt being evaluated. Only available for
 *   ACH_CREDIT_RECEIPT and ACH_DEBIT_RECEIPT event stream rules.
 * - `CARD_TRANSACTION`: The card transaction being evaluated. Only available for
 *   CARD_TRANSACTION_UPDATE event stream rules.
 * - `ACH_PAYMENT`: The ACH payment being evaluated. Only available for
 *   ACH_PAYMENT_UPDATE event stream rules.
 * - `EXTERNAL_BANK_ACCOUNT`: The external bank account tied to the ACH payment
 *   being evaluated. Only available for ACH_PAYMENT_UPDATE event stream rules.
 * - `CARD`: The card associated with the event. Available for AUTHORIZATION,
 *   THREE_DS_AUTHENTICATION, and CARD_TRANSACTION_UPDATE event stream rules.
 * - `ACCOUNT_HOLDER`: The account holder associated with the event. Available for
 *   AUTHORIZATION, THREE_DS_AUTHENTICATION, CARD_TRANSACTION_UPDATE, and
 *   ACH_PAYMENT_UPDATE event stream rules.
 * - `IP_METADATA`: IP address metadata for the request. Available for
 *   THREE_DS_AUTHENTICATION event stream rules.
 * - `SPEND_VELOCITY`: Spend velocity data for the card or account. Requires
 *   `scope`, `period`, and optionally `filters` to configure the velocity
 *   calculation. Available for AUTHORIZATION and CARD_TRANSACTION_UPDATE event
 *   stream rules.
 * - `PAYMENT_VELOCITY`: ACH payment velocity data, aggregated over the given
 *   scope. Requires `scope`, `period`, and optionally `filters` to configure the
 *   velocity calculation. Available for ACH_PAYMENT_UPDATE event stream rules.
 * - `CONSECUTIVE_DECLINES`: The number of consecutive declined transactions since
 *   the last approval for the card or account. Requires `scope`. Available for
 *   AUTHORIZATION and CARD_TRANSACTION_UPDATE event stream rules.
 * - `ACH_PAYMENT_HISTORY`: Windowed settled-amount statistics derived from the
 *   financial account's ACH payment history. Requires `scope`. Available for
 *   ACH_PAYMENT_UPDATE event stream rules.
 * - `TRANSACTION_HISTORY_SIGNALS`: Behavioral feature state derived from the
 *   entity's transaction history. Requires `scope` to specify whether to load
 *   card, account, or business account history. Available for AUTHORIZATION and
 *   CARD_TRANSACTION_UPDATE event stream rules.
 */
export type RuleFeature =
  | RuleFeature.AuthorizationFeature
  | RuleFeature.AuthenticationFeature
  | RuleFeature.TokenizationFeature
  | RuleFeature.ACHReceiptFeature
  | RuleFeature.CardTransactionFeature
  | RuleFeature.ACHPaymentFeature
  | RuleFeature.ExternalBankAccountFeature
  | RuleFeature.CardFeature
  | RuleFeature.AccountHolderFeature
  | RuleFeature.IPMetadataFeature
  | RuleFeature.SpendVelocityFeature
  | RuleFeature.PaymentVelocityFeature
  | RuleFeature.TransactionHistorySignalsFeature
  | RuleFeature.ConsecutiveDeclinesFeature
  | RuleFeature.ACHPaymentHistoryFeature;

export namespace RuleFeature {
  export interface AuthorizationFeature {
    type: 'AUTHORIZATION';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface AuthenticationFeature {
    type: 'AUTHENTICATION';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface TokenizationFeature {
    type: 'TOKENIZATION';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface ACHReceiptFeature {
    type: 'ACH_RECEIPT';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface CardTransactionFeature {
    type: 'CARD_TRANSACTION';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface ACHPaymentFeature {
    type: 'ACH_PAYMENT';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface ExternalBankAccountFeature {
    type: 'EXTERNAL_BANK_ACCOUNT';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface CardFeature {
    type: 'CARD';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface AccountHolderFeature {
    type: 'ACCOUNT_HOLDER';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface IPMetadataFeature {
    type: 'IP_METADATA';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface SpendVelocityFeature {
    /**
     * Velocity over the current day since 00:00 / 12 AM in Eastern Time
     */
    period: V2API.VelocityLimitPeriod;

    /**
     * The scope the velocity is calculated for
     */
    scope: 'CARD' | 'ACCOUNT';

    type: 'SPEND_VELOCITY';

    filters?: V2API.VelocityLimitFilters;

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface PaymentVelocityFeature {
    /**
     * Velocity over the current day since 00:00 / 12 AM in Eastern Time
     */
    period: V2API.VelocityLimitPeriod;

    /**
     * The scope over which the ACH payment velocity is aggregated.
     */
    scope: 'FINANCIAL_ACCOUNT' | 'GLOBAL';

    type: 'PAYMENT_VELOCITY';

    /**
     * Optional filters applied when aggregating ACH payment velocity. Payments not
     * matching the provided filters are excluded from the calculated velocity.
     */
    filters?: PaymentVelocityFeature.Filters;

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export namespace PaymentVelocityFeature {
    /**
     * Optional filters applied when aggregating ACH payment velocity. Payments not
     * matching the provided filters are excluded from the calculated velocity.
     */
    export interface Filters {
      /**
       * Exclude payments matching any of the provided tag key-value pairs.
       */
      exclude_tags?: { [key: string]: string } | null;

      /**
       * Payment types to include in the velocity calculation.
       */
      include_payment_types?: Array<'ORIGINATION' | 'RECEIPT'> | null;

      /**
       * Payment polarities to include in the velocity calculation.
       */
      include_polarities?: Array<'CREDIT' | 'DEBIT'> | null;

      /**
       * Payment statuses to include in the velocity calculation.
       */
      include_statuses?: Array<
        'PENDING' | 'SETTLED' | 'DECLINED' | 'REVERSED' | 'CANCELED' | 'RETURNED'
      > | null;

      /**
       * Only include payments matching all of the provided tag key-value pairs.
       */
      include_tags?: { [key: string]: string } | null;

      /**
       * Only include payments with the given result.
       */
      result?: 'APPROVED' | 'DECLINED';
    }
  }

  export interface TransactionHistorySignalsFeature {
    /**
     * The entity scope to load transaction history signals for.
     */
    scope: 'CARD' | 'ACCOUNT' | 'BUSINESS_ACCOUNT';

    type: 'TRANSACTION_HISTORY_SIGNALS';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface ConsecutiveDeclinesFeature {
    /**
     * The entity scope to count consecutive declines for.
     */
    scope: 'CARD' | 'ACCOUNT';

    type: 'CONSECUTIVE_DECLINES';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }

  export interface ACHPaymentHistoryFeature {
    /**
     * The entity scope to load ACH payment history for.
     */
    scope: 'FINANCIAL_ACCOUNT';

    type: 'ACH_PAYMENT_HISTORY';

    /**
     * The variable name for this feature in the rule function signature
     */
    name?: string;
  }
}

export interface SpendVelocityFilters extends VelocityLimitFilters {
  /**
   * Tag key-value pairs to exclude from the velocity calculation. Transactions
   * matching all specified tag key-value pairs will be excluded from the calculated
   * velocity.
   */
  exclude_tags?: { [key: string]: string } | null;

  /**
   * Tag key-value pairs to include in the velocity calculation. Only transactions
   * matching all specified tag key-value pairs will be included in the calculated
   * velocity.
   */
  include_tags?: { [key: string]: string } | null;
}

/**
 * Parameters for defining a TypeScript code rule
 */
export interface TypescriptCodeParameters {
  /**
   * The TypeScript source code of the rule. Must define a `rule()` function that
   * accepts the declared features as positional arguments (in the same order as the
   * `features` array) and returns an array of actions.
   */
  code: string;

  /**
   * Features available to the TypeScript code at evaluation time
   */
  features: Array<RuleFeature>;
}

export interface VelocityLimitFilters {
  /**
   * ISO-3166-1 alpha-3 Country Codes to exclude from the velocity calculation.
   * Transactions matching any of the provided will be excluded from the calculated
   * velocity.
   */
  exclude_countries?: Array<string> | null;

  /**
   * Merchant Category Codes to exclude from the velocity calculation. Transactions
   * matching this MCC will be excluded from the calculated velocity.
   */
  exclude_mccs?: Array<string> | null;

  /**
   * ISO-3166-1 alpha-3 Country Codes to include in the velocity calculation.
   * Transactions not matching any of the provided will not be included in the
   * calculated velocity.
   */
  include_countries?: Array<string> | null;

  /**
   * Merchant Category Codes to include in the velocity calculation. Transactions not
   * matching this MCC will not be included in the calculated velocity.
   */
  include_mccs?: Array<string> | null;

  /**
   * PAN entry modes to include in the velocity calculation. Transactions not
   * matching any of the provided will not be included in the calculated velocity.
   */
  include_pan_entry_modes?: Array<
    | 'AUTO_ENTRY'
    | 'BAR_CODE'
    | 'CONTACTLESS'
    | 'CREDENTIAL_ON_FILE'
    | 'ECOMMERCE'
    | 'ERROR_KEYED'
    | 'ERROR_MAGNETIC_STRIPE'
    | 'ICC'
    | 'KEY_ENTERED'
    | 'MAGNETIC_STRIPE'
    | 'MANUAL'
    | 'OCR'
    | 'SECURE_CARDLESS'
    | 'UNSPECIFIED'
    | 'UNKNOWN'
  > | null;
}

export interface VelocityLimitParams {
  /**
   * Velocity over the current day since 00:00 / 12 AM in Eastern Time
   */
  period: VelocityLimitPeriod;

  /**
   * The scope the velocity is calculated for
   */
  scope: 'CARD' | 'ACCOUNT';

  filters?: VelocityLimitFilters;

  /**
   * The maximum amount of spend velocity allowed in the period in minor units (the
   * smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
   * limit will be declined.
   */
  limit_amount?: number | null;

  /**
   * The number of spend velocity impacting transactions may not exceed this limit in
   * the period. Transactions exceeding this limit will be declined. A spend velocity
   * impacting transaction is a transaction that has been authorized, and optionally
   * settled, or a force post (a transaction that settled without prior
   * authorization).
   */
  limit_count?: number | null;
}

/**
 * Velocity over the current day since 00:00 / 12 AM in Eastern Time
 */
export type VelocityLimitPeriod =
  | VelocityLimitPeriod.TrailingWindowObject
  | VelocityLimitPeriod.FixedWindowDay
  | VelocityLimitPeriod.FixedWindowWeek
  | VelocityLimitPeriod.FixedWindowMonth
  | VelocityLimitPeriod.FixedWindowYear;

export namespace VelocityLimitPeriod {
  export interface TrailingWindowObject {
    /**
     * The size of the trailing window to calculate Spend Velocity over in seconds. The
     * minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
     */
    duration: number;

    type: 'CUSTOM';
  }

  /**
   * Velocity over the current day since 00:00 / 12 AM in Eastern Time
   */
  export interface FixedWindowDay {
    type: 'DAY';
  }

  /**
   * Velocity over the current week since 00:00 / 12 AM in Eastern Time on specified
   * `day_of_week`
   */
  export interface FixedWindowWeek {
    type: 'WEEK';

    /**
     * The day of the week to start the week from. Following ISO-8601, 1 is Monday and
     * 7 is Sunday. Defaults to Monday if not specified.
     */
    day_of_week?: number;
  }

  /**
   * Velocity over the current month since 00:00 / 12 AM in Eastern Time on specified
   * `day_of_month`.
   */
  export interface FixedWindowMonth {
    type: 'MONTH';

    /**
     * The day of the month to start from. Accepts values from 1 to 31, and will reset
     * at the end of the month if the day exceeds the number of days in the month.
     * Defaults to the 1st of the month if not specified.
     */
    day_of_month?: number;
  }

  /**
   * Velocity over the current year since 00:00 / 12 AM in Eastern Time on specified
   * `month` and `day_of_month`. This validates the month and day of the year to
   * start from is a real date. In the event that February 29th is selected, in
   * non-leap years, the window will start from February 28th.
   */
  export interface FixedWindowYear {
    type: 'YEAR';

    /**
     * The day of the month to start from. Defaults to the 1st of the month if not
     * specified.
     */
    day_of_month?: number;

    /**
     * The month to start from. 1 is January and 12 is December. Defaults to January if
     * not specified.
     */
    month?: number;
  }
}

/**
 * Result of an Auth Rule evaluation
 */
export type V2ListResultsResponse =
  | V2ListResultsResponse.AuthorizationResult
  | V2ListResultsResponse.Authentication3DSResult
  | V2ListResultsResponse.TokenizationResult
  | V2ListResultsResponse.ACHResult
  | V2ListResultsResponse.CardTransactionUpdateResult
  | V2ListResultsResponse.ACHPaymentUpdateResult;

export namespace V2ListResultsResponse {
  export interface AuthorizationResult {
    /**
     * Globally unique identifier for the evaluation
     */
    token: string;

    /**
     * Actions returned by the rule evaluation
     */
    actions: Array<
      AuthorizationResult.DeclineActionAuthorization | AuthorizationResult.ChallengeActionAuthorization
    >;

    /**
     * The Auth Rule token
     */
    auth_rule_token: string;

    /**
     * Timestamp of the rule evaluation
     */
    evaluation_time: string;

    /**
     * The event stream during which the rule was evaluated
     */
    event_stream: 'AUTHORIZATION';

    /**
     * Token of the event that triggered the evaluation
     */
    event_token: string;

    /**
     * The state of the Auth Rule
     */
    mode: 'ACTIVE' | 'INACTIVE';

    /**
     * Version of the rule that was evaluated
     */
    rule_version: number;

    /**
     * The token of the transaction that triggered the rule evaluation
     */
    transaction_token: string | null;
  }

  export namespace AuthorizationResult {
    export interface DeclineActionAuthorization {
      /**
       * The detailed result code explaining the specific reason for the decline
       */
      code:
        | 'ACCOUNT_DAILY_SPEND_LIMIT_EXCEEDED'
        | 'ACCOUNT_DELINQUENT'
        | 'ACCOUNT_INACTIVE'
        | 'ACCOUNT_LIFETIME_SPEND_LIMIT_EXCEEDED'
        | 'ACCOUNT_MONTHLY_SPEND_LIMIT_EXCEEDED'
        | 'ACCOUNT_PAUSED'
        | 'ACCOUNT_UNDER_REVIEW'
        | 'ADDRESS_INCORRECT'
        | 'APPROVED'
        | 'AUTH_RULE_ALLOWED_COUNTRY'
        | 'AUTH_RULE_ALLOWED_MCC'
        | 'AUTH_RULE_BLOCKED_COUNTRY'
        | 'AUTH_RULE_BLOCKED_MCC'
        | 'AUTH_RULE'
        | 'CARD_CLOSED'
        | 'CARD_CRYPTOGRAM_VALIDATION_FAILURE'
        | 'CARD_EXPIRED'
        | 'CARD_EXPIRY_DATE_INCORRECT'
        | 'CARD_INVALID'
        | 'CARD_NOT_ACTIVATED'
        | 'CARD_PAUSED'
        | 'CARD_PIN_INCORRECT'
        | 'CARD_RESTRICTED'
        | 'CARD_SECURITY_CODE_INCORRECT'
        | 'CARD_SPEND_LIMIT_EXCEEDED'
        | 'CONTACT_CARD_ISSUER'
        | 'CUSTOMER_ASA_TIMEOUT'
        | 'CUSTOM_ASA_RESULT'
        | 'DECLINED'
        | 'DO_NOT_HONOR'
        | 'DRIVER_NUMBER_INVALID'
        | 'FORMAT_ERROR'
        | 'INSUFFICIENT_FUNDING_SOURCE_BALANCE'
        | 'INSUFFICIENT_FUNDS'
        | 'LITHIC_SYSTEM_ERROR'
        | 'LITHIC_SYSTEM_RATE_LIMIT'
        | 'MALFORMED_ASA_RESPONSE'
        | 'MERCHANT_INVALID'
        | 'MERCHANT_LOCKED_CARD_ATTEMPTED_ELSEWHERE'
        | 'MERCHANT_NOT_PERMITTED'
        | 'OVER_REVERSAL_ATTEMPTED'
        | 'PIN_BLOCKED'
        | 'PROGRAM_CARD_SPEND_LIMIT_EXCEEDED'
        | 'PROGRAM_SUSPENDED'
        | 'PROGRAM_USAGE_RESTRICTION'
        | 'REVERSAL_UNMATCHED'
        | 'SECURITY_VIOLATION'
        | 'SINGLE_USE_CARD_REATTEMPTED'
        | 'SUSPECTED_FRAUD'
        | 'TRANSACTION_INVALID'
        | 'TRANSACTION_NOT_PERMITTED_TO_ACQUIRER_OR_TERMINAL'
        | 'TRANSACTION_NOT_PERMITTED_TO_ISSUER_OR_CARDHOLDER'
        | 'TRANSACTION_PREVIOUSLY_COMPLETED'
        | 'UNAUTHORIZED_MERCHANT'
        | 'VEHICLE_NUMBER_INVALID'
        | 'CARDHOLDER_CHALLENGED'
        | 'CARDHOLDER_CHALLENGE_FAILED';

      type: 'DECLINE';

      /**
       * Optional explanation for why this action was taken
       */
      explanation?: string;
    }

    export interface ChallengeActionAuthorization {
      type: 'CHALLENGE';

      /**
       * Optional explanation for why this action was taken
       */
      explanation?: string;
    }
  }

  export interface Authentication3DSResult {
    /**
     * Globally unique identifier for the evaluation
     */
    token: string;

    /**
     * Actions returned by the rule evaluation
     */
    actions: Array<Authentication3DSResult.Action>;

    /**
     * The Auth Rule token
     */
    auth_rule_token: string;

    /**
     * Timestamp of the rule evaluation
     */
    evaluation_time: string;

    /**
     * The event stream during which the rule was evaluated
     */
    event_stream: 'THREE_DS_AUTHENTICATION';

    /**
     * Token of the event that triggered the evaluation
     */
    event_token: string;

    /**
     * The state of the Auth Rule
     */
    mode: 'ACTIVE' | 'INACTIVE';

    /**
     * Version of the rule that was evaluated
     */
    rule_version: number;

    /**
     * The token of the transaction that triggered the rule evaluation
     */
    transaction_token: string | null;
  }

  export namespace Authentication3DSResult {
    export interface Action {
      type: 'DECLINE' | 'CHALLENGE';

      /**
       * Optional explanation for why this action was taken
       */
      explanation?: string;
    }
  }

  export interface TokenizationResult {
    /**
     * Globally unique identifier for the evaluation
     */
    token: string;

    /**
     * Actions returned by the rule evaluation
     */
    actions: Array<TokenizationResult.DeclineActionTokenization | TokenizationResult.RequireTfaAction>;

    /**
     * The Auth Rule token
     */
    auth_rule_token: string;

    /**
     * Timestamp of the rule evaluation
     */
    evaluation_time: string;

    /**
     * The event stream during which the rule was evaluated
     */
    event_stream: 'TOKENIZATION';

    /**
     * Token of the event that triggered the evaluation
     */
    event_token: string;

    /**
     * The state of the Auth Rule
     */
    mode: 'ACTIVE' | 'INACTIVE';

    /**
     * Version of the rule that was evaluated
     */
    rule_version: number;

    /**
     * The token of the transaction that triggered the rule evaluation
     */
    transaction_token: string | null;
  }

  export namespace TokenizationResult {
    export interface DeclineActionTokenization {
      /**
       * Decline the tokenization request
       */
      type: 'DECLINE';

      /**
       * Optional explanation for why this action was taken
       */
      explanation?: string;

      /**
       * Reason code for declining the tokenization request
       */
      reason?:
        | 'ACCOUNT_SCORE_1'
        | 'DEVICE_SCORE_1'
        | 'ALL_WALLET_DECLINE_REASONS_PRESENT'
        | 'WALLET_RECOMMENDED_DECISION_RED'
        | 'CVC_MISMATCH'
        | 'CARD_EXPIRY_MONTH_MISMATCH'
        | 'CARD_EXPIRY_YEAR_MISMATCH'
        | 'CARD_INVALID_STATE'
        | 'CUSTOMER_RED_PATH'
        | 'INVALID_CUSTOMER_RESPONSE'
        | 'NETWORK_FAILURE'
        | 'GENERIC_DECLINE'
        | 'DIGITAL_CARD_ART_REQUIRED';
    }

    export interface RequireTfaAction {
      /**
       * Require two-factor authentication for the tokenization request
       */
      type: 'REQUIRE_TFA';

      /**
       * Optional explanation for why this action was taken
       */
      explanation?: string;

      /**
       * Reason code for requiring two-factor authentication
       */
      reason?:
        | 'WALLET_RECOMMENDED_TFA'
        | 'SUSPICIOUS_ACTIVITY'
        | 'DEVICE_RECENTLY_LOST'
        | 'TOO_MANY_RECENT_ATTEMPTS'
        | 'TOO_MANY_RECENT_TOKENS'
        | 'TOO_MANY_DIFFERENT_CARDHOLDERS'
        | 'OUTSIDE_HOME_TERRITORY'
        | 'HAS_SUSPENDED_TOKENS'
        | 'HIGH_RISK'
        | 'ACCOUNT_SCORE_LOW'
        | 'DEVICE_SCORE_LOW'
        | 'CARD_STATE_TFA'
        | 'HARDCODED_TFA'
        | 'CUSTOMER_RULE_TFA'
        | 'DEVICE_HOST_CARD_EMULATION';
    }
  }

  export interface ACHResult {
    /**
     * Globally unique identifier for the evaluation
     */
    token: string;

    /**
     * Actions returned by the rule evaluation
     */
    actions: Array<ACHResult.ApproveActionACH | ACHResult.ReturnAction>;

    /**
     * The Auth Rule token
     */
    auth_rule_token: string;

    /**
     * Timestamp of the rule evaluation
     */
    evaluation_time: string;

    /**
     * The event stream during which the rule was evaluated
     */
    event_stream: 'ACH_CREDIT_RECEIPT' | 'ACH_DEBIT_RECEIPT';

    /**
     * Token of the event that triggered the evaluation
     */
    event_token: string;

    /**
     * The state of the Auth Rule
     */
    mode: 'ACTIVE' | 'INACTIVE';

    /**
     * Version of the rule that was evaluated
     */
    rule_version: number;

    /**
     * The token of the transaction that triggered the rule evaluation
     */
    transaction_token: string | null;
  }

  export namespace ACHResult {
    export interface ApproveActionACH {
      /**
       * Approve the ACH transaction
       */
      type: 'APPROVE';

      /**
       * Optional explanation for why this action was taken
       */
      explanation?: string;
    }

    export interface ReturnAction {
      /**
       * NACHA return code to use when returning the transaction. Note that the list of
       * available return codes is subject to an allowlist configured at the program
       * level
       */
      code:
        | 'R01'
        | 'R02'
        | 'R03'
        | 'R04'
        | 'R05'
        | 'R06'
        | 'R07'
        | 'R08'
        | 'R09'
        | 'R10'
        | 'R11'
        | 'R12'
        | 'R13'
        | 'R14'
        | 'R15'
        | 'R16'
        | 'R17'
        | 'R18'
        | 'R19'
        | 'R20'
        | 'R21'
        | 'R22'
        | 'R23'
        | 'R24'
        | 'R25'
        | 'R26'
        | 'R27'
        | 'R28'
        | 'R29'
        | 'R30'
        | 'R31'
        | 'R32'
        | 'R33'
        | 'R34'
        | 'R35'
        | 'R36'
        | 'R37'
        | 'R38'
        | 'R39'
        | 'R40'
        | 'R41'
        | 'R42'
        | 'R43'
        | 'R44'
        | 'R45'
        | 'R46'
        | 'R47'
        | 'R50'
        | 'R51'
        | 'R52'
        | 'R53'
        | 'R61'
        | 'R62'
        | 'R67'
        | 'R68'
        | 'R69'
        | 'R70'
        | 'R71'
        | 'R72'
        | 'R73'
        | 'R74'
        | 'R75'
        | 'R76'
        | 'R77'
        | 'R80'
        | 'R81'
        | 'R82'
        | 'R83'
        | 'R84'
        | 'R85';

      /**
       * Return the ACH transaction
       */
      type: 'RETURN';

      /**
       * Optional explanation for why this action was taken
       */
      explanation?: string;
    }
  }

  export interface CardTransactionUpdateResult {
    /**
     * Globally unique identifier for the evaluation
     */
    token: string;

    /**
     * Actions returned by the rule evaluation
     */
    actions: Array<CardTransactionUpdateResult.TagAction | CardTransactionUpdateResult.CreateCaseAction>;

    /**
     * The Auth Rule token
     */
    auth_rule_token: string;

    /**
     * Timestamp of the rule evaluation
     */
    evaluation_time: string;

    /**
     * The event stream during which the rule was evaluated
     */
    event_stream: 'CARD_TRANSACTION_UPDATE';

    /**
     * Token of the event that triggered the evaluation
     */
    event_token: string;

    /**
     * The state of the Auth Rule
     */
    mode: 'ACTIVE' | 'INACTIVE';

    /**
     * Version of the rule that was evaluated
     */
    rule_version: number;

    /**
     * The token of the transaction that triggered the rule evaluation
     */
    transaction_token: string | null;
  }

  export namespace CardTransactionUpdateResult {
    export interface TagAction {
      /**
       * The key of the tag to apply to the transaction
       */
      key: string;

      /**
       * Tag the transaction with key-value metadata
       */
      type: 'TAG';

      /**
       * The value of the tag to apply to the transaction
       */
      value: string;

      /**
       * Optional explanation for why this action was taken
       */
      explanation?: string;
    }

    export interface CreateCaseAction {
      /**
       * The token of the queue to create the case in
       */
      queue_token: string;

      /**
       * The scope of the case to create
       */
      scope: 'CARD' | 'ACCOUNT';

      /**
       * Create a case for the transaction
       */
      type: 'CREATE_CASE';

      /**
       * Optional explanation for why this action was taken
       */
      explanation?: string;
    }
  }

  export interface ACHPaymentUpdateResult {
    /**
     * Globally unique identifier for the evaluation
     */
    token: string;

    /**
     * Actions returned by the rule evaluation
     */
    actions: Array<ACHPaymentUpdateResult.TagAction | ACHPaymentUpdateResult.CreateCaseAction>;

    /**
     * The Auth Rule token
     */
    auth_rule_token: string;

    /**
     * Timestamp of the rule evaluation
     */
    evaluation_time: string;

    /**
     * The event stream during which the rule was evaluated
     */
    event_stream: 'ACH_PAYMENT_UPDATE';

    /**
     * Token of the event that triggered the evaluation
     */
    event_token: string;

    /**
     * The state of the Auth Rule
     */
    mode: 'ACTIVE' | 'INACTIVE';

    /**
     * Version of the rule that was evaluated
     */
    rule_version: number;

    /**
     * The token of the transaction that triggered the rule evaluation
     */
    transaction_token: string | null;
  }

  export namespace ACHPaymentUpdateResult {
    export interface TagAction {
      /**
       * The key of the tag to apply to the payment
       */
      key: string;

      /**
       * Tag the payment with key-value metadata
       */
      type: 'TAG';

      /**
       * The value of the tag to apply to the payment
       */
      value: string;

      /**
       * Optional explanation for why this action was taken
       */
      explanation?: string;
    }

    export interface CreateCaseAction {
      /**
       * The token of the queue to create the case in
       */
      queue_token: string;

      /**
       * The scope of the case to create
       */
      scope: 'FINANCIAL_ACCOUNT';

      /**
       * Create a case for the payment
       */
      type: 'CREATE_CASE';

      /**
       * Optional explanation for why this action was taken
       */
      explanation?: string;
    }
  }
}

export interface V2ListVersionsResponse {
  data: Array<AuthRuleVersion>;
}

export interface V2RetrieveFeaturesResponse {
  /**
   * Timestamp at which the Features were evaluated
   */
  evaluated: string;

  /**
   * Calculated Features used for evaluation of the provided Auth Rule
   */
  features: Array<V2RetrieveFeaturesResponse.Feature>;
}

export namespace V2RetrieveFeaturesResponse {
  export interface Feature {
    filters: V2API.VelocityLimitFilters;

    /**
     * Velocity over the current day since 00:00 / 12 AM in Eastern Time
     */
    period: V2API.VelocityLimitPeriod;

    /**
     * The scope the velocity is calculated for
     */
    scope: 'CARD' | 'ACCOUNT';

    value: Feature.Value;
  }

  export namespace Feature {
    export interface Value {
      /**
       * Amount (in cents) for the given Auth Rule that is used as input for calculating
       * the rule. For Velocity Limit rules this would be the calculated Velocity. For
       * Conditional Rules using CARD*TRANSACTION_COUNT*\* this will be 0
       */
      amount: number;

      /**
       * Number of velocity impacting transactions matching the given scope, period and
       * filters
       */
      count: number;
    }
  }
}

export interface V2RetrieveReportResponse {
  /**
   * Auth Rule Token
   */
  auth_rule_token: string;

  /**
   * The start date (UTC) of the report.
   */
  begin: string;

  /**
   * Daily evaluation statistics for the Auth Rule.
   */
  daily_statistics: Array<V2RetrieveReportResponse.DailyStatistic>;

  /**
   * The end date (UTC) of the report.
   */
  end: string;
}

export namespace V2RetrieveReportResponse {
  export interface DailyStatistic {
    /**
     * The date (UTC) for which the statistics are reported.
     */
    date: string;

    /**
     * Statistics for each version of the rule that was evaluated during the reported
     * day.
     */
    versions: Array<V2API.ReportStats>;
  }
}

export type V2CreateParams =
  | V2CreateParams.AccountLevelRule
  | V2CreateParams.CardLevelRule
  | V2CreateParams.ProgramLevelRule;

export declare namespace V2CreateParams {
  export interface AccountLevelRule {
    /**
     * Parameters for the Auth Rule
     */
    parameters:
      | ConditionalBlockParameters
      | VelocityLimitParams
      | MerchantLockParameters
      | Conditional3DSActionParameters
      | ConditionalAuthorizationActionParameters
      | ConditionalACHActionParameters
      | ConditionalTokenizationActionParameters
      | ConditionalCardTransactionUpdateActionParameters
      | ConditionalACHPaymentUpdateActionParameters
      | TypescriptCodeParameters
      | ConditionalAuthorizationAdjustmentParameters;

    /**
     * The type of Auth Rule. For certain rule types, this determines the event stream
     * during which it will be evaluated. For rules that can be applied to one of
     * several event streams, the effective one is defined by the separate
     * `event_stream` field.
     *
     * - `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,
     *   ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
     *   ACH_PAYMENT_UPDATE event stream.
     * - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
     *   ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
     *   ACH_PAYMENT_UPDATE event stream.
     */
    type: 'CONDITIONAL_BLOCK' | 'VELOCITY_LIMIT' | 'MERCHANT_LOCK' | 'CONDITIONAL_ACTION' | 'TYPESCRIPT_CODE';

    /**
     * Account tokens to which the Auth Rule applies.
     */
    account_tokens?: Array<string>;

    /**
     * Business Account tokens to which the Auth Rule applies.
     */
    business_account_tokens?: Array<string>;

    /**
     * The event stream during which the rule will be evaluated.
     */
    event_stream?: EventStream;

    /**
     * Auth Rule Name
     */
    name?: string | null;
  }

  export interface CardLevelRule {
    /**
     * Card tokens to which the Auth Rule applies.
     */
    card_tokens: Array<string>;

    /**
     * Parameters for the Auth Rule
     */
    parameters:
      | ConditionalBlockParameters
      | VelocityLimitParams
      | MerchantLockParameters
      | Conditional3DSActionParameters
      | ConditionalAuthorizationActionParameters
      | ConditionalACHActionParameters
      | ConditionalTokenizationActionParameters
      | ConditionalCardTransactionUpdateActionParameters
      | ConditionalACHPaymentUpdateActionParameters
      | TypescriptCodeParameters
      | ConditionalAuthorizationAdjustmentParameters;

    /**
     * The type of Auth Rule. For certain rule types, this determines the event stream
     * during which it will be evaluated. For rules that can be applied to one of
     * several event streams, the effective one is defined by the separate
     * `event_stream` field.
     *
     * - `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,
     *   ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
     *   ACH_PAYMENT_UPDATE event stream.
     * - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
     *   ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
     *   ACH_PAYMENT_UPDATE event stream.
     */
    type: 'CONDITIONAL_BLOCK' | 'VELOCITY_LIMIT' | 'MERCHANT_LOCK' | 'CONDITIONAL_ACTION' | 'TYPESCRIPT_CODE';

    /**
     * The event stream during which the rule will be evaluated.
     */
    event_stream?: EventStream;

    /**
     * Auth Rule Name
     */
    name?: string | null;
  }

  export interface ProgramLevelRule {
    /**
     * Parameters for the Auth Rule
     */
    parameters:
      | ConditionalBlockParameters
      | VelocityLimitParams
      | MerchantLockParameters
      | Conditional3DSActionParameters
      | ConditionalAuthorizationActionParameters
      | ConditionalACHActionParameters
      | ConditionalTokenizationActionParameters
      | ConditionalCardTransactionUpdateActionParameters
      | ConditionalACHPaymentUpdateActionParameters
      | TypescriptCodeParameters
      | ConditionalAuthorizationAdjustmentParameters;

    /**
     * Whether the Auth Rule applies to all authorizations on the card program.
     */
    program_level: boolean;

    /**
     * The type of Auth Rule. For certain rule types, this determines the event stream
     * during which it will be evaluated. For rules that can be applied to one of
     * several event streams, the effective one is defined by the separate
     * `event_stream` field.
     *
     * - `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,
     *   ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
     *   ACH_PAYMENT_UPDATE event stream.
     * - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
     *   ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
     *   ACH_PAYMENT_UPDATE event stream.
     */
    type: 'CONDITIONAL_BLOCK' | 'VELOCITY_LIMIT' | 'MERCHANT_LOCK' | 'CONDITIONAL_ACTION' | 'TYPESCRIPT_CODE';

    /**
     * The event stream during which the rule will be evaluated.
     */
    event_stream?: EventStream;

    /**
     * Account tokens to which the Auth Rule does not apply.
     */
    excluded_account_tokens?: Array<string>;

    /**
     * Business account tokens to which the Auth Rule does not apply.
     */
    excluded_business_account_tokens?: Array<string>;

    /**
     * Card tokens to which the Auth Rule does not apply.
     */
    excluded_card_tokens?: Array<string>;

    /**
     * Auth Rule Name
     */
    name?: string | null;
  }
}

export type V2UpdateParams =
  | V2UpdateParams.AccountLevelRule
  | V2UpdateParams.CardLevelRule
  | V2UpdateParams.ProgramLevelRule;

export declare namespace V2UpdateParams {
  export interface AccountLevelRule {
    /**
     * Account tokens to which the Auth Rule applies.
     */
    account_tokens?: Array<string>;

    /**
     * Business Account tokens to which the Auth Rule applies.
     */
    business_account_tokens?: Array<string>;

    /**
     * Auth Rule Name
     */
    name?: string | null;

    /**
     * The desired state of the Auth Rule.
     *
     * Note that only deactivating an Auth Rule through this endpoint is supported at
     * this time. If you need to (re-)activate an Auth Rule the /promote endpoint
     * should be used to promote a draft to the currently active version.
     */
    state?: 'INACTIVE';
  }

  export interface CardLevelRule {
    /**
     * Card tokens to which the Auth Rule applies.
     */
    card_tokens?: Array<string>;

    /**
     * Auth Rule Name
     */
    name?: string | null;

    /**
     * The desired state of the Auth Rule.
     *
     * Note that only deactivating an Auth Rule through this endpoint is supported at
     * this time. If you need to (re-)activate an Auth Rule the /promote endpoint
     * should be used to promote a draft to the currently active version.
     */
    state?: 'INACTIVE';
  }

  export interface ProgramLevelRule {
    /**
     * Account tokens to which the Auth Rule does not apply.
     */
    excluded_account_tokens?: Array<string>;

    /**
     * Business account tokens to which the Auth Rule does not apply.
     */
    excluded_business_account_tokens?: Array<string>;

    /**
     * Card tokens to which the Auth Rule does not apply.
     */
    excluded_card_tokens?: Array<string>;

    /**
     * Auth Rule Name
     */
    name?: string | null;

    /**
     * Whether the Auth Rule applies to all authorizations on the card program.
     */
    program_level?: boolean;

    /**
     * The desired state of the Auth Rule.
     *
     * Note that only deactivating an Auth Rule through this endpoint is supported at
     * this time. If you need to (re-)activate an Auth Rule the /promote endpoint
     * should be used to promote a draft to the currently active version.
     */
    state?: 'INACTIVE';
  }
}

export interface V2ListParams extends CursorPageParams {
  /**
   * Only return Auth Rules that are bound to the provided account token.
   */
  account_token?: string;

  /**
   * Only return Auth Rules that are bound to the provided business account token.
   */
  business_account_token?: string;

  /**
   * Only return Auth Rules that are bound to the provided card token.
   */
  card_token?: string;

  /**
   * Deprecated: Use event_streams instead. Only return Auth rules that are executed
   * during the provided event stream.
   */
  event_stream?: EventStream;

  /**
   * Only return Auth rules that are executed during any of the provided event
   * streams. If event_streams and event_stream are specified, the values will be
   * combined.
   */
  event_streams?: Array<EventStream>;

  /**
   * Only return Auth Rules that are bound to the provided scope.
   */
  scope?: 'PROGRAM' | 'ACCOUNT' | 'BUSINESS_ACCOUNT' | 'CARD' | 'ANY';
}

export interface V2DraftParams {
  /**
   * Parameters for the Auth Rule
   */
  parameters?:
    | ConditionalBlockParameters
    | VelocityLimitParams
    | MerchantLockParameters
    | Conditional3DSActionParameters
    | ConditionalAuthorizationActionParameters
    | ConditionalACHActionParameters
    | ConditionalTokenizationActionParameters
    | ConditionalCardTransactionUpdateActionParameters
    | ConditionalACHPaymentUpdateActionParameters
    | TypescriptCodeParameters
    | ConditionalAuthorizationAdjustmentParameters
    | null;
}

export interface V2ListResultsParams extends CursorPageParams {
  /**
   * Filter by Auth Rule token
   */
  auth_rule_token?: string;

  /**
   * Date string in RFC 3339 format. Only events evaluated after the specified time
   * will be included. UTC time zone.
   */
  begin?: string;

  /**
   * Date string in RFC 3339 format. Only events evaluated before the specified time
   * will be included. UTC time zone.
   */
  end?: string;

  /**
   * Filter by event token
   */
  event_token?: string;

  /**
   * Filter by whether the rule evaluation produced any actions. When not provided,
   * all results are returned.
   */
  has_actions?: boolean;
}

export interface V2RetrieveFeaturesParams {
  account_token?: string;

  card_token?: string;
}

export interface V2RetrieveReportParams {
  /**
   * Start date for the report
   */
  begin: string;

  /**
   * End date for the report
   */
  end: string;
}

V2.Backtests = Backtests;

export declare namespace V2 {
  export {
    type ACHPaymentUpdateAction as ACHPaymentUpdateAction,
    type AuthRule as AuthRule,
    type AuthRuleCondition as AuthRuleCondition,
    type AuthRuleVersion as AuthRuleVersion,
    type BacktestStats as BacktestStats,
    type CardTransactionUpdateAction as CardTransactionUpdateAction,
    type Conditional3DSActionParameters as Conditional3DSActionParameters,
    type ConditionalACHActionParameters as ConditionalACHActionParameters,
    type ConditionalACHPaymentUpdateActionParameters as ConditionalACHPaymentUpdateActionParameters,
    type ConditionalAttribute as ConditionalAttribute,
    type ConditionalAuthorizationActionParameters as ConditionalAuthorizationActionParameters,
    type ConditionalAuthorizationAdjustmentParameters as ConditionalAuthorizationAdjustmentParameters,
    type ConditionalBlockParameters as ConditionalBlockParameters,
    type ConditionalCardTransactionUpdateActionParameters as ConditionalCardTransactionUpdateActionParameters,
    type ConditionalOperation as ConditionalOperation,
    type ConditionalTokenizationActionParameters as ConditionalTokenizationActionParameters,
    type ConditionalValue as ConditionalValue,
    type EventStream as EventStream,
    type MerchantLockParameters as MerchantLockParameters,
    type ReportStats as ReportStats,
    type RuleFeature as RuleFeature,
    type SpendVelocityFilters as SpendVelocityFilters,
    type TypescriptCodeParameters as TypescriptCodeParameters,
    type VelocityLimitFilters as VelocityLimitFilters,
    type VelocityLimitParams as VelocityLimitParams,
    type VelocityLimitPeriod as VelocityLimitPeriod,
    type V2ListResultsResponse as V2ListResultsResponse,
    type V2ListVersionsResponse as V2ListVersionsResponse,
    type V2RetrieveFeaturesResponse as V2RetrieveFeaturesResponse,
    type V2RetrieveReportResponse as V2RetrieveReportResponse,
    type AuthRulesCursorPage as AuthRulesCursorPage,
    type V2ListResultsResponsesCursorPage as V2ListResultsResponsesCursorPage,
    type V2CreateParams as V2CreateParams,
    type V2UpdateParams as V2UpdateParams,
    type V2ListParams as V2ListParams,
    type V2DraftParams as V2DraftParams,
    type V2ListResultsParams as V2ListResultsParams,
    type V2RetrieveFeaturesParams as V2RetrieveFeaturesParams,
    type V2RetrieveReportParams as V2RetrieveReportParams,
  };

  export {
    Backtests as Backtests,
    type BacktestResults as BacktestResults,
    type BacktestCreateResponse as BacktestCreateResponse,
    type BacktestCreateParams as BacktestCreateParams,
    type BacktestRetrieveParams as BacktestRetrieveParams,
  };
}