gohl/dist/classes/customfields.d.ts

Go Highlevel Node Js ease of use library implementation to their API

import { AuthData } from "../interfaces/auth/authdata";
import { ICustomFieldResponse, ICustomFieldFolderResponse, ICustomFieldListResponse, ICustomFieldListParams, ICreateCustomField, IUpdateCustomField, ICreateCustomFieldFolder, IUpdateCustomFieldFolder } from "../interfaces/customfield";
export declare class CustomFields {
    private authData?;
    constructor(authData?: AuthData);
    /**
     * Create Custom Field
     * Documentation - https://highlevel.stoplight.io/docs/integrations/55c9675bf56ce-create-custom-field
     * @param data
     * @returns
     */
    create(data: ICreateCustomField): Promise<ICustomFieldResponse>;
    /**
     * Update Custom Field by ID
     * Documentation - https://highlevel.stoplight.io/docs/integrations/0d21eea479ed7-update-custom-field-by-id
     * @param fieldId
     * @param data
     * @returns
     */
    update(fieldId: string, data: IUpdateCustomField): Promise<ICustomFieldResponse>;
    /**
     * Delete Custom Field by ID
     * Documentation - https://highlevel.stoplight.io/docs/integrations/65ae8f7b10460-delete-custom-field-by-id
     * @param fieldId
     * @returns
     */
    delete(fieldId: string): Promise<ICustomFieldResponse>;
    /**
     * Get Custom Fields by Object Key
     * Documentation - https://highlevel.stoplight.io/docs/integrations/33719c4eef9bd-get-custom-fields-by-object-key
     * @param params
     * @returns
     */
    getByObjectType(params: ICustomFieldListParams): Promise<ICustomFieldListResponse>;
    /**
     * Create Custom Field Folder
     * Documentation - https://highlevel.stoplight.io/docs/integrations/52e9e97f3c50a-create-custom-field-folder
     * @param data
     * @returns
     */
    createFolder(data: ICreateCustomFieldFolder): Promise<ICustomFieldFolderResponse>;
    /**
     * Get Custom Field Folder by ID
     * Documentation - https://highlevel.stoplight.io/docs/integrations/e08551df3d324-get-custom-field-folder-by-id
     * @param folderId
     * @returns
     */
    getFolder(folderId: string): Promise<ICustomFieldFolderResponse>;
    /**
     * Update Custom Field Folder Name
     * Documentation - https://highlevel.stoplight.io/docs/integrations/0bd8bc7fd50ff-update-custom-field-folder-name
     * @param folderId
     * @param data
     * @returns
     */
    updateFolder(folderId: string, data: IUpdateCustomFieldFolder): Promise<ICustomFieldFolderResponse>;
    /**
     * Delete Custom Field Folder
     * Documentation - https://highlevel.stoplight.io/docs/integrations/ca8b8b09ee5a0-delete-custom-field-folder
     * @param folderId
     * @returns
     */
    deleteFolder(folderId: string): Promise<ICustomFieldFolderResponse>;
}