Class CustomFieldsClient

Hierarchy

GhlClient
- CustomFieldsClient

Index

Constructors

Methods

findById update remove findByObjectKey createFolder updateFolder removeFolder create

Constructors

constructor

new CustomFieldsClient(accessToken: string): CustomFieldsClient
Parameters
- accessToken: string
Returns CustomFieldsClient
Overrides GhlClient.constructor
- Defined in custom-fields/custom-fields.client.ts:14

Methods

findById

findById(id: string): Promise<CustomFieldResponse>
Parameters
- id: string
Returns Promise<CustomFieldResponse>
- Defined in custom-fields/custom-fields.client.ts:18

update

update(id: string, dto: UpdateCustomFieldDto): Promise<CustomFieldResponse>
Parameters
- id: string
- dto: UpdateCustomFieldDto
Returns Promise<CustomFieldResponse>
- Defined in custom-fields/custom-fields.client.ts:22

remove

remove(id: string): Promise<RemoveCustomFieldResponse>
Parameters
- id: string
Returns Promise<RemoveCustomFieldResponse>
- Defined in custom-fields/custom-fields.client.ts:29

findByObjectKey

findByObjectKey(
locationId: string,
objectKey: string,
): Promise<ListCustomFieldsResponse>
Parameters
- locationId: string
- objectKey: string
Returns Promise<ListCustomFieldsResponse>
- Defined in custom-fields/custom-fields.client.ts:33

createFolder

createFolder(dto: CreateCustomFieldFolderDto): Promise<CustomFieldFolder>
Parameters
- dto: CreateCustomFieldFolderDto
Returns Promise<CustomFieldFolder>
- Defined in custom-fields/custom-fields.client.ts:43

updateFolder

updateFolder(
folderId: string,
dto: UpdateCustomFieldFolderDto,
): Promise<CustomFieldFolder>
Parameters
- folderId: string
- dto: UpdateCustomFieldFolderDto
Returns Promise<CustomFieldFolder>
- Defined in custom-fields/custom-fields.client.ts:49

removeFolder

removeFolder(
locationId: string,
folderId: string,
): Promise<RemoveCustomFieldResponse>
Parameters
- locationId: string
- folderId: string
Returns Promise<RemoveCustomFieldResponse>
- Defined in custom-fields/custom-fields.client.ts:59

create

create(dto: CreateCustomFieldDto): Promise<CustomFieldResponse>
Parameters
- dto: CreateCustomFieldDto
Returns Promise<CustomFieldResponse>
- Defined in custom-fields/custom-fields.client.ts:69