import { APIResource } from "../../core/resource.js";
import { APIPromise } from "../../core/api-promise.js";
import { PageCursorURL, PagePromise } from "../../core/pagination.js";
import { RequestOptions } from "../../internal/request-options.js";
/**
 * Custom object fields defined by the company
 */
export declare class Fields extends APIResource {
    /**
     * A list of custom object fields.
     *
     * - Requires: `API Tier 1`
     */
    list(customObjectAPIName: string, options?: RequestOptions): PagePromise<CustomObjectFieldsPageCursorURL, CustomObjectField>;
    /**
     * Create a new custom object field.
     */
    create(customObjectAPIName: string, body?: FieldCreateParams | null | undefined, options?: RequestOptions): APIPromise<CustomObjectField>;
    /**
     * Retrieve a specific custom object field.
     */
    retrieve(customObjectAPIName: string, fieldAPIName: string, options?: RequestOptions): APIPromise<CustomObjectField>;
    /**
     * Update a specific custom object field.
     */
    update(customObjectAPIName: string, fieldAPIName: string, body?: FieldUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomObjectField>;
    /**
     * Delete a custom object field.
     */
    delete(customObjectAPIName: string, fieldAPIName: string, options?: RequestOptions): APIPromise<void>;
}
export type CustomObjectFieldsPageCursorURL = PageCursorURL<CustomObjectField>;
export interface CustomObjectField {
    /**
     * Identifier field
     */
    id: string;
    /**
     * The api name of the custom object field
     */
    api_name: string;
    /**
     * Record creation date
     */
    created_at: string;
    /**
     * The custom object which the field belongs to
     */
    custom_object: string;
    /**
     * The field type
     */
    data_type: unknown;
    /**
     * whether the history is enable for the field
     */
    enable_history: boolean;
    /**
     * whether the field is imuatable
     */
    is_immutable: boolean;
    /**
     * whether the field is standard field
     */
    is_standard: boolean;
    /**
     * This field specifies whether a particular column value has unique values
     */
    is_unique: boolean;
    /**
     * The name of the custom object field
     */
    name: string;
    /**
     * Record update date
     */
    updated_at: string;
    /**
     * The description of the custom object field
     */
    description?: string;
    /**
     * The id of the package which the custom object field belongs to
     */
    managed_package_install_id?: string;
}
export interface FieldCreateParams {
    /**
     * The data type configuration for the field.
     */
    data_type?: unknown;
    /**
     * Configuration for derived aggregated fields.
     */
    derived_aggregated_field?: unknown;
    /**
     * The formula for derived fields.
     */
    derived_field_formula?: string;
    /**
     * A description of the field.
     */
    description?: string;
    /**
     * Whether to track history for this field.
     */
    enable_history?: boolean;
    /**
     * Metadata for formula attributes.
     */
    formula_attr_metas?: unknown;
    /**
     * Whether field values must be unique.
     */
    is_unique?: boolean;
    /**
     * The name of the field.
     */
    name?: string;
    /**
     * Whether this field is required.
     */
    required?: boolean;
    /**
     * The RQL definition for computed fields.
     */
    rql_definition?: unknown;
    /**
     * The section configuration for the field.
     */
    section?: unknown;
}
export interface FieldUpdateParams {
    /**
     * The data type configuration for the field.
     */
    data_type?: unknown;
    /**
     * The formula for derived fields.
     */
    derived_field_formula?: string;
    /**
     * A description of the field.
     */
    description?: string;
    /**
     * Whether to track history for this field.
     */
    enable_history?: boolean;
    /**
     * Metadata for formula attributes.
     */
    formula_attr_metas?: unknown;
    /**
     * Whether field values must be unique.
     */
    is_unique?: boolean;
    /**
     * The name of the field.
     */
    name?: string;
    /**
     * Configuration for name field display.
     */
    name_field_details?: unknown;
    /**
     * Whether this field is required.
     */
    required?: boolean;
    /**
     * The RQL definition for computed fields.
     */
    rql_definition?: unknown;
    /**
     * The section configuration for the field.
     */
    section?: unknown;
}
export declare namespace Fields {
    export { type CustomObjectField as CustomObjectField, type CustomObjectFieldsPageCursorURL as CustomObjectFieldsPageCursorURL, type FieldCreateParams as FieldCreateParams, type FieldUpdateParams as FieldUpdateParams, };
}
//# sourceMappingURL=fields.d.ts.map