Class ObjectsClient

Hierarchy

GhlClient
- ObjectsClient

Index

Constructors

Methods

findByKey updateByKey findByLocation create findRecordById updateRecord deleteRecord createRecord searchRecords

Constructors

constructor

new ObjectsClient(accessToken: string): ObjectsClient
Parameters
- accessToken: string
Returns ObjectsClient
Overrides GhlClient.constructor
- Defined in objects/objects.client.ts:17

Methods

findByKey

findByKey(
    key: string,
    locationId: string,
    fetchProperties?: string,
): Promise<CustomObjectSchemaResponse>
Parameters
- key: string
- locationId: string
- fetchProperties: string = undefined
Returns Promise<CustomObjectSchemaResponse>
- Defined in objects/objects.client.ts:21

updateByKey

updateByKey(
key: string,
dto: UpdateCustomObjectDto,
): Promise<CustomObjectResponse>
Parameters
- key: string
- dto: UpdateCustomObjectDto
Returns Promise<CustomObjectResponse>
- Defined in objects/objects.client.ts:31

findByLocation

findByLocation(locationId: string): Promise<ListCustomObjectsResponse>
Parameters
- locationId: string
Returns Promise<ListCustomObjectsResponse>
- Defined in objects/objects.client.ts:38

create

create(dto: CreateCustomObjectDto): Promise<CustomObjectResponse>
Parameters
- dto: CreateCustomObjectDto
Returns Promise<CustomObjectResponse>
- Defined in objects/objects.client.ts:46

findRecordById

findRecordById(
key: string,
recordId: string,
): Promise<CustomObjectRecordResponse>
Parameters
- key: string
- recordId: string
Returns Promise<CustomObjectRecordResponse>
- Defined in objects/objects.client.ts:52

updateRecord

updateRecord(
    locationId: string,
    key: string,
    recordId: string,
    dto: UpdateCustomObjectRecordDto,
): Promise<CustomObjectRecordResponse>
Parameters
- locationId: string
- key: string
- recordId: string
- dto: UpdateCustomObjectRecordDto
Returns Promise<CustomObjectRecordResponse>
- Defined in objects/objects.client.ts:61

deleteRecord

deleteRecord(
key: string,
recordId: string,
): Promise<DeleteCustomObjectRecordResponse>
Parameters
- key: string
- recordId: string
Returns Promise<DeleteCustomObjectRecordResponse>
- Defined in objects/objects.client.ts:74

createRecord

createRecord(
key: string,
dto: CreateCustomObjectRecordDto,
): Promise<CustomObjectRecordResponse>
Parameters
- key: string
- dto: CreateCustomObjectRecordDto
Returns Promise<CustomObjectRecordResponse>
- Defined in objects/objects.client.ts:83

searchRecords

searchRecords(
key: string,
dto: SearchCustomObjectRecordsDto,
): Promise<CustomObjectRecordSearchResult>
Parameters
- key: string
- dto: SearchCustomObjectRecordsDto
Returns Promise<CustomObjectRecordSearchResult>
- Defined in objects/objects.client.ts:93