@gohighlevel/api-client
Version:
Official SDK for HighLevel Public APIs
242 lines • 10.2 kB
TypeScript
import { AxiosInstance, AxiosRequestConfig } from 'axios';
import * as Models from './models/custom-fields';
/**
* CustomFields Service
* Custom fields are data points that allow you to capture and store specific information tailored to your business requirements. You can create fields across field types like text, numeric, selection options and special fields like date/time or signature
*/
export declare class CustomFields {
private client;
constructor(httpClient: AxiosInstance);
/**
* Get Custom Field / Folder By Id
* <div>
<p> Get Custom Field / Folder By Id.</p>
<div>
<span style= "display: inline-block;
width: 25px; height: 25px;
background-color: yellow;
color: black;
font-weight: bold;
font-size: 24px;
text-align: center;
line-height: 22px;
border: 2px solid black;
border-radius: 10%;
margin-right: 10px;">
!
</span>
<span>
<strong>
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
</strong>
</span>
</div>
</div>
*/
getCustomFieldById(params: {
id: string;
}, options?: AxiosRequestConfig): Promise<Models.CustomFieldSuccessfulResponseDto>;
/**
* Update Custom Field By Id
* <div>
<p> Update Custom Field By Id </p>
<div>
<span style= "display: inline-block;
width: 25px; height: 25px;
background-color: yellow;
color: black;
font-weight: bold;
font-size: 24px;
text-align: center;
line-height: 22px;
border: 2px solid black;
border-radius: 10%;
margin-right: 10px;">
!
</span>
<span>
<strong>
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
</strong>
</span>
</div>
</div>
*/
updateCustomField(params: {
id: string;
}, requestBody: Models.UpdateCustomFieldsDTO, options?: AxiosRequestConfig): Promise<Models.CustomFieldSuccessfulResponseDto>;
/**
* Delete Custom Field By Id
* <div>
<p> Delete Custom Field By Id </p>
<div>
<span style= "display: inline-block;
width: 25px; height: 25px;
background-color: yellow;
color: black;
font-weight: bold;
font-size: 24px;
text-align: center;
line-height: 22px;
border: 2px solid black;
border-radius: 10%;
margin-right: 10px;">
!
</span>
<span>
<strong>
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
</strong>
</span>
</div>
</div>
*/
deleteCustomField(params: {
id: string;
}, options?: AxiosRequestConfig): Promise<Models.CustomFolderDeleteResponseDto>;
/**
* Get Custom Fields By Object Key
* <div>
<p> Get Custom Fields By Object Key</p>
<div>
<span style= "display: inline-block;
width: 25px; height: 25px;
background-color: yellow;
color: black;
font-weight: bold;
font-size: 24px;
text-align: center;
line-height: 22px;
border: 2px solid black;
border-radius: 10%;
margin-right: 10px;">
!
</span>
<span>
<strong>
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
</strong>
</span>
</div>
</div>
*/
getCustomFieldsByObjectKey(params: {
objectKey: string;
locationId: string;
}, options?: AxiosRequestConfig): Promise<Models.CustomFieldsResponseDTO>;
/**
* Create Custom Field Folder
* <div>
<p> Create Custom Field Folder </p>
<div>
<span style= "display: inline-block;
width: 25px; height: 25px;
background-color: yellow;
color: black;
font-weight: bold;
font-size: 24px;
text-align: center;
line-height: 22px;
border: 2px solid black;
border-radius: 10%;
margin-right: 10px;">
!
</span>
<span>
<strong>
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
</strong>
</span>
</div>
</div>
*/
createCustomFieldFolder(requestBody: Models.CreateFolder, options?: AxiosRequestConfig): Promise<Models.ICustomFieldFolder>;
/**
* Update Custom Field Folder Name
* <div>
<p> Create Custom Field Folder </p>
<div>
<span style= "display: inline-block;
width: 25px; height: 25px;
background-color: yellow;
color: black;
font-weight: bold;
font-size: 24px;
text-align: center;
line-height: 22px;
border: 2px solid black;
border-radius: 10%;
margin-right: 10px;">
!
</span>
<span>
<strong>
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
</strong>
</span>
</div>
</div>
*/
updateCustomFieldFolder(params: {
id: string;
}, requestBody: Models.UpdateFolder, options?: AxiosRequestConfig): Promise<Models.ICustomFieldFolder>;
/**
* Delete Custom Field Folder
* <div>
<p> Create Custom Field Folder </p>
<div>
<span style= "display: inline-block;
width: 25px; height: 25px;
background-color: yellow;
color: black;
font-weight: bold;
font-size: 24px;
text-align: center;
line-height: 22px;
border: 2px solid black;
border-radius: 10%;
margin-right: 10px;">
!
</span>
<span>
<strong>
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
</strong>
</span>
</div>
</div>
*/
deleteCustomFieldFolder(params: {
id: string;
locationId: string;
}, options?: AxiosRequestConfig): Promise<Models.CustomFolderDeleteResponseDto>;
/**
* Create Custom Field
* <div>
<p> Create Custom Field </p>
<div>
<span style= "display: inline-block;
width: 25px; height: 25px;
background-color: yellow;
color: black;
font-weight: bold;
font-size: 24px;
text-align: center;
line-height: 22px;
border: 2px solid black;
border-radius: 10%;
margin-right: 10px;">
!
</span>
<span>
<strong>
Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
</strong>
</span>
</div>
</div>
*/
createCustomField(requestBody: Models.CreateCustomFieldsDTO, options?: AxiosRequestConfig): Promise<Models.CustomFieldSuccessfulResponseDto>;
}
export default CustomFields;
//# sourceMappingURL=custom-fields.d.ts.map