amocrm-client/src/interfaces/custom_field.ts

JS Library for AmoCRM

import { ICriteria, IEntityAttributes } from "./api";
import { IntRange } from "./common";

export type FIeldCriteria = Partial<Pick<ICriteria<{ id: number, name: string }, never, IntRange<1, 51>>, "page" | "limit">>

export interface IFieldAttributes extends IEntityAttributes {
    name: string;
    type: string;
    code: string;
    sort: number;
    is_api_only: boolean;
    enums: null | Array<{ id: number, value: string, sort: number, code: string }>;
    group_id: string;
    required_statuses: Array<{ pipeline_id: number, status_id: number }>;
    is_visible?: boolean;
    is_required?: boolean;
    settings: Array<any>;
    remind: null | "never" | "day" | "week" | "month";
    is_deletable: boolean;
    is_predefined: boolean;
    entity_type: string;
    tracking_callback: string;
    triggers: Array<any>
}

export interface IFieldGroupAttributes extends IEntityAttributes {
    name: string;
    is_predefined: boolean;
    type: string;
    fields: number[];
    entity_type: string;
    sort: number;
}

export interface ICustomFieldValue {
    field_id: number;
    field_name?: string;
    field_code?: string;
    field_type?: string;
    values: Array<{ value: any, enum_code?: string }>
}