/* tslint:disable */
/* eslint-disable */
/**
 * customfieldsets
 * 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 { CustomFieldIdentity } from './custom-field-identity';
// May contain unused imports in some cases
// @ts-ignore
import type { CustomFieldSetDisplaySettings } from './custom-field-set-display-settings';

/**
 * Model representation of a Custom Field Set
 */
export interface CustomFieldSetMeta {
  /**
   * Indicates the entity that the custom field set is associated with (eg. clients or any entity that allows CF definition)
   */
  availableFor?: CustomFieldSetMetaAvailableForEnum;
  /**
   * Date at which the custom field set was created
   */
  creationDate?: string;
  /**
   * This section lists all the custom fields associated with this set
   */
  customFields?: Array<CustomFieldIdentity>;
  /**
   * Free text field to store eventual notes with regard to custom field group purpose/details
   */
  description?: string;
  displaySettings?: CustomFieldSetDisplaySettings;
  /**
   * The encoded key of the entity, generated, globally unique
   */
  encodedKey?: string;
  /**
   * The usage decides how the custom field set will be used in the UI and how the custom field values will be stored. For STANDARD set type the custom field set can be used only once (i.e Personal Information). For GROUPED set type the custom field set can be used multiple times (i.e Addresses). For further details please see [here](https://docs.mambu.com/docs/custom-fields/)
   */
  fieldSetType?: CustomFieldSetMetaFieldSetTypeEnum;
  /**
   * User-defined ID, gobally unique
   */
  id?: string;
}

export const CustomFieldSetMetaAvailableForEnum = {
  Client: 'CLIENT',
  Group: 'GROUP',
  CreditArrangement: 'CREDIT_ARRANGEMENT',
  LoanAccount: 'LOAN_ACCOUNT',
  Guarantor: 'GUARANTOR',
  Asset: 'ASSET',
  DepositAccount: 'DEPOSIT_ACCOUNT',
  DepositProduct: 'DEPOSIT_PRODUCT',
  TransactionChannel: 'TRANSACTION_CHANNEL',
  TransactionType: 'TRANSACTION_TYPE',
  Branch: 'BRANCH',
  Centre: 'CENTRE',
  User: 'USER',
} as const;

export type CustomFieldSetMetaAvailableForEnum =
  (typeof CustomFieldSetMetaAvailableForEnum)[keyof typeof CustomFieldSetMetaAvailableForEnum];
export const CustomFieldSetMetaFieldSetTypeEnum = {
  Standard: 'STANDARD',
  Grouped: 'GROUPED',
} as const;

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