/* 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.
 */

/**
 * Represents a client or group role.
 */
export interface ClientRole {
  /**
   * `TRUE` if clients with this client role can be used as guarantors, `FALSE` otherwise.
   */
  canGuarantee?: boolean;
  /**
   * `TRUE` if new accounts for this client type can be created, `FALSE` otherwise.
   */
  canOpenAccounts?: boolean;
  /**
   * Indicated the account holder type.
   */
  clientType?: ClientRoleClientTypeEnum;
  /**
   * The creation date of the client role.
   */
  creationDate?: string;
  /**
   * The text description for this client role.
   */
  description?: string;
  /**
   * The encoded key of the client, which is unique and generated.
   */
  encodedKey?: string;
  /**
   * The ID of the client role, which can be generated and customized - but must be unique.
   */
  id?: string;
  /**
   * The pattern used in generating the client ID.
   */
  idPattern?: string;
  /**
   * The name of the client role.
   */
  name?: string;
  /**
   * `TRUE` if identification documents must be provided for the client to be created, `FALSE` otherwise. Does not apply for groups.
   */
  requireID?: boolean;
  /**
   * `TRUE` if the Mambu default address section is available, `FALSE` otherwise.
   */
  useDefaultAddress?: boolean;
}

export const ClientRoleClientTypeEnum = {
  Client: 'CLIENT',
  Group: 'GROUP',
} as const;

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