/* tslint:disable */
/* eslint-disable */
/**
 * cards
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: v2
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

// May contain unused imports in some cases
// @ts-ignore
import type { AccountBalances } from './account-balances';
// May contain unused imports in some cases
// @ts-ignore
import type { CardAcceptor } from './card-acceptor';

/**
 * Details for retrieving a authorization hold. Deprecated due to encodedKey field.
 */
export interface GetAuthorizationHold {
  /**
   * The key of the account linked with the authorization hold.
   */
  accountKey?: string;
  /**
   * Whether the given request should be accepted without balance validations.
   */
  advice: boolean;
  /**
   * The amount of money to be held as a result of the authorization hold request.
   */
  amount: number;
  balances?: AccountBalances;
  cardAcceptor?: CardAcceptor;
  /**
   * The reference token of the card.
   */
  cardToken?: string;
  /**
   * The organization time when the authorization hold was created
   */
  creationDate?: string;
  /**
   * Indicates whether the authorization hold amount is credited or debited
   */
  creditDebitIndicator?: GetAuthorizationHoldCreditDebitIndicatorEnum;
  /**
   * The ISO currency code in which the hold was created. The amounts are stored in the base currency, but the user could have enter it in a foreign currency.
   */
  currencyCode?: string;
  /**
   * The custom expiration period for the hold which overwrites mcc and default expiration periods
   */
  customExpirationPeriod?: number;
  /**
   * The internal ID of the authorization hold, auto generated, unique.
   */
  encodedKey?: string;
  /**
   * The exchange rate for the original currency.
   */
  exchangeRate?: number;
  /**
   * The external reference ID to be used to reference the account hold in subsequent requests.
   */
  externalReferenceId: string;
  /**
   * The original amount of money to be held as a result of the authorization hold request.
   */
  originalAmount?: number;
  /**
   * The original currency in which the hold was created.
   */
  originalCurrency?: string;
  /**
   * Indicates whether the authorization is partial or not
   */
  partial?: boolean;
  /**
   * The date to consider as start date when calculating the number of days passed until expiration
   */
  referenceDateForExpiration?: string;
  /**
   * Indicates the source of the authorization hold
   */
  source?: GetAuthorizationHoldSourceEnum;
  /**
   * The enumeration containing the statuses of an authorization hold.
   */
  status?: GetAuthorizationHoldStatusEnum;
  /**
   * The formatted time at which the user made this authorization hold.
   */
  userTransactionTime?: string;
}

export const GetAuthorizationHoldCreditDebitIndicatorEnum = {
  Dbit: 'DBIT',
  Crdt: 'CRDT',
} as const;

export type GetAuthorizationHoldCreditDebitIndicatorEnum =
  (typeof GetAuthorizationHoldCreditDebitIndicatorEnum)[keyof typeof GetAuthorizationHoldCreditDebitIndicatorEnum];
export const GetAuthorizationHoldSourceEnum = {
  Card: 'CARD',
  Account: 'ACCOUNT',
} as const;

export type GetAuthorizationHoldSourceEnum =
  (typeof GetAuthorizationHoldSourceEnum)[keyof typeof GetAuthorizationHoldSourceEnum];
export const GetAuthorizationHoldStatusEnum = {
  Pending: 'PENDING',
  Reversed: 'REVERSED',
  Settled: 'SETTLED',
  Expired: 'EXPIRED',
} as const;

export type GetAuthorizationHoldStatusEnum =
  (typeof GetAuthorizationHoldStatusEnum)[keyof typeof GetAuthorizationHoldStatusEnum];