/* tslint:disable */
/* eslint-disable */
/**
 * clients
 * 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 { Currency } from './currency';

/**
 * Represents a credit arrangement.
 */
export interface CreditArrangement {
  /**
   * The maximum credit amount the client can be exposed to.
   */
  amount: number;
  /**
   * The date when the credit arrangement was approved.
   */
  approvedDate?: string;
  /**
   * The available amount of the credit arrangement.
   */
  availableCreditAmount?: number;
  /**
   * The date when the credit arrangement was closed.
   */
  closedDate?: string;
  /**
   * The consumed amount of the credit arrangement, which is calculated as the difference between the amount and available amount.
   */
  consumedCreditAmount?: number;
  /**
   * The date when the credit arrangement was created.
   */
  creationDate?: string;
  currency?: Currency;
  /**
   * The encoded key of the credit arrangement, it is auto generated, and unique.
   */
  encodedKey?: string;
  /**
   * The date when the credit arrangement expires.
   */
  expireDate: string;
  /**
   * The type of exposure limit calculation method used for the credit arrangement.
   */
  exposureLimitType?: CreditArrangementExposureLimitTypeEnum;
  /**
   * The encoded key of the credit arrangement holder (individual client or group).
   */
  holderKey: string;
  /**
   * Indicated the account holder type.
   */
  holderType: CreditArrangementHolderTypeEnum;
  /**
   * The ID of credit arrangement, can be generated and customized, and must be unique.
   */
  id?: string;
  /**
   * The last date when the credit arrangement was modified.
   */
  lastModifiedDate?: string;
  /**
   * The notes or description of the credit arrangement.
   */
  notes?: string;
  /**
   * The start date from which the credit arrangement became active.
   */
  startDate: string;
  /**
   * The state of the credit arrangement.
   */
  state?: CreditArrangementStateEnum;
  /**
   * The substate of credit arrangement.
   */
  subState?: CreditArrangementSubStateEnum;
}

export const CreditArrangementExposureLimitTypeEnum = {
  ApprovedAmount: 'APPROVED_AMOUNT',
  OutstandingAmount: 'OUTSTANDING_AMOUNT',
} as const;

export type CreditArrangementExposureLimitTypeEnum =
  (typeof CreditArrangementExposureLimitTypeEnum)[keyof typeof CreditArrangementExposureLimitTypeEnum];
export const CreditArrangementHolderTypeEnum = {
  Client: 'CLIENT',
  Group: 'GROUP',
} as const;

export type CreditArrangementHolderTypeEnum =
  (typeof CreditArrangementHolderTypeEnum)[keyof typeof CreditArrangementHolderTypeEnum];
export const CreditArrangementStateEnum = {
  PendingApproval: 'PENDING_APPROVAL',
  Approved: 'APPROVED',
  Active: 'ACTIVE',
  Closed: 'CLOSED',
  Withdrawn: 'WITHDRAWN',
  Rejected: 'REJECTED',
} as const;

export type CreditArrangementStateEnum =
  (typeof CreditArrangementStateEnum)[keyof typeof CreditArrangementStateEnum];
export const CreditArrangementSubStateEnum = {
  PendingApproval: 'PENDING_APPROVAL',
  Approved: 'APPROVED',
  Active: 'ACTIVE',
  Closed: 'CLOSED',
  Withdrawn: 'WITHDRAWN',
  Rejected: 'REJECTED',
} as const;

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