@gohighlevel/api-client
Version:
Official SDK for HighLevel Public APIs
79 lines • 4.44 kB
TypeScript
import { AxiosInstance, AxiosRequestConfig } from 'axios';
import * as Models from './models/objects';
/**
* Objects Service
* Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies.
*/
export declare class Objects {
private client;
constructor(httpClient: AxiosInstance);
/**
* Get Object Schema by key / id
* Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0
*/
getObjectSchemaByKey(params: {
key: string;
locationId: string;
fetchProperties?: string;
}, options?: AxiosRequestConfig): Promise<Models.CustomObjectByIdResponseDTO>;
/**
* Update Object Schema By Key / Id
* Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0
*/
updateCustomObject(params: {
key: string;
}, requestBody: Models.UpdateCustomObjectSchemaDTO, options?: AxiosRequestConfig): Promise<Models.CustomObjectResponseDTO>;
/**
* Get Record By Id
* Allows you to get a Standard Object like business and custom object record by Id
*/
getRecordById(params: {
schemaKey: string;
id: string;
}, options?: AxiosRequestConfig): Promise<Models.RecordByIdResponseDTO>;
/**
* Update Record
* Update a Custom Object Record by Id. Supported Objects are business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296
*/
updateObjectRecord(params: {
schemaKey: string;
id: string;
locationId: string;
}, requestBody: Models.UpdateCustomObjectRecordDto, options?: AxiosRequestConfig): Promise<Models.RecordByIdResponseDTO>;
/**
* Delete Record
* Delete Record By Id . Supported Objects are business and custom objects.
*/
deleteObjectRecord(params: {
schemaKey: string;
id: string;
}, options?: AxiosRequestConfig): Promise<Models.ObjectRecordDeleteResponseDTO>;
/**
* Create Record
* Create a Custom Object Record. Supported Objects business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296
*/
createObjectRecord(params: {
schemaKey: string;
}, requestBody: Models.CreateCustomObjectRecordDto, options?: AxiosRequestConfig): Promise<Models.RecordByIdResponseDTO>;
/**
* Search Object Records
* Supported Objects are custom objects and standard objects like "business". Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-379336
*/
searchObjectRecords(params: {
schemaKey?: string;
}, requestBody: Models.SearchRecordsBody, options?: AxiosRequestConfig): Promise<Models.SearchRecordResponseDTO>;
/**
* Get all objects for a location
* Get all objects for a location. Supported Objects are contact, opportunity, business and custom objects.To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0
*/
getObjectByLocationId(params: {
locationId: string;
}, options?: AxiosRequestConfig): Promise<Models.CustomObjectListResponseDTO>;
/**
* Create Custom Object
* Allows you to create a custom object schema. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0
*/
createCustomObjectSchema(requestBody: Models.CreateCustomObjectSchemaDTO, options?: AxiosRequestConfig): Promise<Models.CustomObjectResponseDTO>;
}
export default Objects;
//# sourceMappingURL=objects.d.ts.map