/* 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 { Address } from './address';
// May contain unused imports in some cases
// @ts-ignore
import type { IdentificationDocument } from './identification-document';
// May contain unused imports in some cases
// @ts-ignore
import type { PortalSettings } from './portal-settings';

/**
 * Represents a client.
 */
export interface Client {
  /**
   * The date when a client was set as active for the first time.
   */
  activationDate?: string;
  /**
   * The addresses associated with this client.
   */
  addresses?: Array<Address>;
  /**
   * The date when a client was approved.
   */
  approvedDate?: string;
  /**
   * The encoded key of the branch a client is assigned to.
   */
  assignedBranchKey?: string;
  /**
   * The encoded key of the centre a client is assigned to.
   */
  assignedCentreKey?: string;
  /**
   * The encoded key of the user a client is assigned to.
   */
  assignedUserKey?: string;
  /**
   * The client\'s date of birth.
   */
  birthDate?: string;
  /**
   * A role which describes the intended use of a client in the system.
   */
  clientRoleKey?: string;
  /**
   * The date when the client state was changed to closed.
   */
  closedDate?: string;
  /**
   * The date a client was created.
   */
  creationDate?: string;
  /**
   * The client\'s email address.
   */
  emailAddress?: string;
  /**
   * The encoded key of the client, which is unique and generated.
   */
  encodedKey?: string;
  /**
   * The first name, personal name, given name, or forename of the client.
   */
  firstName: string;
  /**
   * The client\'s gender, the options are male or female.
   */
  gender?: ClientGenderEnum;
  /**
   * The groups to which this client belongs.
   */
  groupKeys?: Array<string>;
  /**
   * Number of paid and closed (with \'obligations met\') accounts for a client\'s group; when the closing operation is reverted, this is reduced.
   */
  groupLoanCycle?: number;
  /**
   * The client\'s home phone number.
   */
  homePhone?: string;
  /**
   * The ID of the client, which can be generated and customized - but must be unique.
   */
  id?: string;
  /**
   * The identification documents for this client.
   */
  idDocuments?: Array<IdentificationDocument>;
  /**
   * The last date a client was modified.
   */
  lastModifiedDate?: string;
  /**
   * The last name, surname, or family name of the client.
   */
  lastName: string;
  /**
   * Number of paid and closed (with \'obligations met\') accounts for a client; when the closing operation is reverted, this is reduced.
   */
  loanCycle?: number;
  /**
   * The middle name of the client.
   */
  middleName?: string;
  /**
   * The migration event encoded key associated with a client.
   */
  migrationEventKey?: string;
  /**
   * The client\'s mobile phone number.
   */
  mobilePhone?: string;
  /**
   * The client\'s second mobile phone number.
   */
  mobilePhone2?: string;
  /**
   * The additional notes about a client.
   */
  notes?: string;
  portalSettings?: PortalSettings;
  /**
   * The client\'s preferred language. This will determine the language for the reports, schedules, and account statements you generate for the client.
   */
  preferredLanguage?: ClientPreferredLanguageEnum;
  /**
   * The encoded key of a client\'s profile picture.
   */
  profilePictureKey?: string;
  /**
   * The encoded key of the client\'s profile signature.
   */
  profileSignatureKey?: string;
  /**
   * The state of a client. It shows where the client is in the client life cycle.
   */
  state?: ClientStateEnum;
}

export const ClientGenderEnum = {
  Male: 'MALE',
  Female: 'FEMALE',
} as const;

export type ClientGenderEnum =
  (typeof ClientGenderEnum)[keyof typeof ClientGenderEnum];
export const ClientPreferredLanguageEnum = {
  English: 'ENGLISH',
  Portugese: 'PORTUGESE',
  Spanish: 'SPANISH',
  Russian: 'RUSSIAN',
  French: 'FRENCH',
  Georgian: 'GEORGIAN',
  Chinese: 'CHINESE',
  Indonesian: 'INDONESIAN',
  Romanian: 'ROMANIAN',
  Burmese: 'BURMESE',
  German: 'GERMAN',
  PortugueseBrazil: 'PORTUGUESE_BRAZIL',
  Vietnamese: 'VIETNAMESE',
  Italian: 'ITALIAN',
  Thai: 'THAI',
  Norwegian: 'NORWEGIAN',
  Phrase: 'PHRASE',
} as const;

export type ClientPreferredLanguageEnum =
  (typeof ClientPreferredLanguageEnum)[keyof typeof ClientPreferredLanguageEnum];
export const ClientStateEnum = {
  PendingApproval: 'PENDING_APPROVAL',
  Inactive: 'INACTIVE',
  Active: 'ACTIVE',
  Exited: 'EXITED',
  Blacklisted: 'BLACKLISTED',
  Rejected: 'REJECTED',
} as const;

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