/* tslint:disable */
/* eslint-disable */
/**
 * configuration/customfields
 * 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 { AccessRights } from './access-rights';
// May contain unused imports in some cases
// @ts-ignore
import type { DisplaySettings } from './display-settings';
// May contain unused imports in some cases
// @ts-ignore
import type { SelectionOption } from './selection-option';
// May contain unused imports in some cases
// @ts-ignore
import type { Usage } from './usage';
// May contain unused imports in some cases
// @ts-ignore
import type { ValidationRules } from './validation-rules';

/**
 * Represents the custom field definition configuration.
 */
export interface CustomFieldConfiguration {
  /**
   * `TRUE` if a custom field is available for all objects, `FALSE` otherwise.
   */
  availableForAll?: boolean;
  default?: boolean;
  /**
   * Can be defined only for selection custom field definitions. Indicates the parent custom field definition on which the dependency is based upon.
   */
  dependentFieldId?: string;
  displaySettings: DisplaySettings;
  editRights?: AccessRights;
  /**
   * The user-defined ID, which is globally unique.
   */
  id: string;
  required?: boolean;
  /**
   * The search index information for the custom field definition. empty if field is not searchable
   */
  searchIndexes?: { [key: string]: number };
  /**
   * Can be defined only for selection custom field definitions. Indicates that the field has predefined selections and only those can be used to populate it.
   */
  selectionOptions?: Array<SelectionOption>;
  /**
   * Indicates whether the custom field definition is active or inactive.
   */
  state: CustomFieldConfigurationStateEnum;
  /**
   * The type of custom field definition.
   */
  type: CustomFieldConfigurationTypeEnum;
  /**
   * Defines the usage at the record type level. The custom field definition is going to be available only for the record types that are referenced in the list by ID. Mutually exclusive with usage defined on custom field definition level by the`required` and `default` properties. For selection custom field definitions that have a `dependentFieldId` set, the usage is inherited from the dependent field and must not be defined.
   */
  usage?: Array<Usage>;
  validationRules?: ValidationRules;
  viewRights?: AccessRights;
}

export const CustomFieldConfigurationStateEnum = {
  Active: 'ACTIVE',
  Inactive: 'INACTIVE',
} as const;

export type CustomFieldConfigurationStateEnum =
  (typeof CustomFieldConfigurationStateEnum)[keyof typeof CustomFieldConfigurationStateEnum];
export const CustomFieldConfigurationTypeEnum = {
  FreeText: 'FREE_TEXT',
  Selection: 'SELECTION',
  Number: 'NUMBER',
  Checkbox: 'CHECKBOX',
  Date: 'DATE',
  DateTime: 'DATE_TIME',
  ClientLink: 'CLIENT_LINK',
  GroupLink: 'GROUP_LINK',
  UserLink: 'USER_LINK',
} as const;

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