gohl
Version:
Go Highlevel Node Js ease of use library implementation to their API
43 lines (42 loc) • 1.56 kB
TypeScript
import { AuthData } from "../interfaces/auth/authdata";
import { ICustomField } from "../interfaces/custom.fields";
export declare class CustomField {
private authData?;
constructor(authData?: AuthData);
/**
* Get CustomFields
* Documentation - https://highlevel.stoplight.io/docs/integrations/791462a3367b9-get-custom-fields
* @param locationId
* @returns
*/
getAll(locationId: string): Promise<ICustomField[]>;
/**
* Get CustomField
* Documentation - https://highlevel.stoplight.io/docs/integrations/791462a3367b9-get-custom-fields
* @param locationId
* @returns
*/
get(customFieldId: string, locationId: string): Promise<ICustomField>;
/**
* Create CustomField
* Documentation - https://highlevel.stoplight.io/docs/integrations/7b2584aa2450c-create-custom-field
* @param customField
* @returns
*/
add(locationId: string, customField: ICustomField): Promise<ICustomField>;
/**
* Update CustomField
* Documentation - https://highlevel.stoplight.io/docs/integrations/a96e05f71bdf4-update-custom-field
* @param customField
* @param locationId
* @returns
*/
update(customFieldId: string, locationId: string, customField: ICustomField): Promise<ICustomField>;
/**
* Delete CustomField
* Documentation - https://highlevel.stoplight.io/docs/integrations/ca83b24e1ca24-delete-custom-field
* @param customFieldId
* @returns
*/
remove(customFieldId: string, locationId: string): Promise<boolean>;
}