Class LocationsClient

Hierarchy

GhlClient
- LocationsClient

Constructors

constructor

new LocationsClient(accessToken: string): LocationsClient
Parameters
- accessToken: string
Returns LocationsClient
Overrides GhlClient.constructor
- Defined in locations/locations.client.ts:30

Methods

findById

findById(locationId: string): Promise<LocationResponse>
Parameters
- locationId: string
Returns Promise<LocationResponse>
- Defined in locations/locations.client.ts:34

update

update(
locationId: string,
dto: UpdateLocationDto,
): Promise<CreateUpdateLocationResponse>
Parameters
- locationId: string
- dto: UpdateLocationDto
Returns Promise<CreateUpdateLocationResponse>
- Defined in locations/locations.client.ts:38

remove

remove(
locationId: string,
deleteTwilioAccount?: boolean,
): Promise<DeleteLocationResponse>
Parameters
- locationId: string
- deleteTwilioAccount: boolean = false
Returns Promise<DeleteLocationResponse>
- Defined in locations/locations.client.ts:48

create

create(dto: CreateLocationDto): Promise<CreateUpdateLocationResponse>
Parameters
- dto: CreateLocationDto
Returns Promise<CreateUpdateLocationResponse>
- Defined in locations/locations.client.ts:57

search

search(params: LocationSearchParams): Promise<ListLocationsResponse>
Parameters
- params: LocationSearchParams
Returns Promise<ListLocationsResponse>
- Defined in locations/locations.client.ts:63

findCustomFields

findCustomFields(
locationId: string,
model?: "all" | "contact" | "opportunity",
): Promise<ListLocationCustomFieldsResponse>
Parameters
- locationId: string
- model: "all" | "contact" | "opportunity" = undefined
Returns Promise<ListLocationCustomFieldsResponse>
- Defined in locations/locations.client.ts:71

createCustomField

createCustomField(
locationId: string,
dto: CreateLocationCustomFieldDto,
): Promise<LocationCustomFieldResponse>
Parameters
- locationId: string
- dto: CreateLocationCustomFieldDto
Returns Promise<LocationCustomFieldResponse>
- Defined in locations/locations.client.ts:81

findCustomFieldById

findCustomFieldById(
locationId: string,
customFieldId: string,
): Promise<LocationCustomFieldResponse>
Parameters
- locationId: string
- customFieldId: string
Returns Promise<LocationCustomFieldResponse>
- Defined in locations/locations.client.ts:91

updateCustomField

updateCustomField(
    locationId: string,
    customFieldId: string,
    dto: UpdateLocationCustomFieldDto,
): Promise<LocationCustomFieldResponse>
Parameters
- locationId: string
- customFieldId: string
- dto: UpdateLocationCustomFieldDto
Returns Promise<LocationCustomFieldResponse>
- Defined in locations/locations.client.ts:100

removeCustomField

removeCustomField(
locationId: string,
customFieldId: string,
): Promise<SuccededDeleteResponse>
Parameters
- locationId: string
- customFieldId: string
Returns Promise<SuccededDeleteResponse>
- Defined in locations/locations.client.ts:111

uploadCustomFieldFile

uploadCustomFieldFile(
    locationId: string,
    customFieldId: string,
    files: LocationsFileInterface[],
): Promise<LocationsFileUploadResponse>
Parameters
- locationId: string
- customFieldId: string
- files: LocationsFileInterface[]
Returns Promise<LocationsFileUploadResponse>
- Defined in locations/locations.client.ts:120

findCustomValues

findCustomValues(locationId: string): Promise<ListLocationCustomValuesResponse>
Parameters
- locationId: string
Returns Promise<ListLocationCustomValuesResponse>
- Defined in locations/locations.client.ts:136

createCustomValue

createCustomValue(
locationId: string,
dto: LocationCustomValueDto,
): Promise<LocationCustomValueResponse>
Parameters
- locationId: string
- dto: LocationCustomValueDto
Returns Promise<LocationCustomValueResponse>
- Defined in locations/locations.client.ts:144

findCustomValueById

findCustomValueById(
locationId: string,
customValueId: string,
): Promise<LocationCustomValueResponse>
Parameters
- locationId: string
- customValueId: string
Returns Promise<LocationCustomValueResponse>
- Defined in locations/locations.client.ts:154

updateCustomValue

updateCustomValue(
    locationId: string,
    customValueId: string,
    dto: LocationCustomValueDto,
): Promise<LocationCustomValueResponse>
Parameters
- locationId: string
- customValueId: string
- dto: LocationCustomValueDto
Returns Promise<LocationCustomValueResponse>
- Defined in locations/locations.client.ts:163

removeCustomValue

removeCustomValue(
locationId: string,
customValueId: string,
): Promise<SuccededDeleteResponse>
Parameters
- locationId: string
- customValueId: string
Returns Promise<SuccededDeleteResponse>
- Defined in locations/locations.client.ts:174

findTemplates

findTemplates(
locationId: string,
params: LocationTemplateSearchParams,
): Promise<ListLocationTemplatesResponse>
Parameters
- locationId: string
- params: LocationTemplateSearchParams
Returns Promise<ListLocationTemplatesResponse>
- Defined in locations/locations.client.ts:183

removeTemplate

removeTemplate(
locationId: string,
templateId: string,
): Promise<SuccededDeleteResponse>
Parameters
- locationId: string
- templateId: string
Returns Promise<SuccededDeleteResponse>
- Defined in locations/locations.client.ts:193

findTags

findTags(locationId: string): Promise<ListLocationTagsResponse>
Parameters
- locationId: string
Returns Promise<ListLocationTagsResponse>
- Defined in locations/locations.client.ts:202

createTag

createTag(locationId: string, name: string): Promise<LocationTagResponse>
Parameters
- locationId: string
- name: string
Returns Promise<LocationTagResponse>
- Defined in locations/locations.client.ts:206

findTagById

findTagById(locationId: string, tagId: string): Promise<LocationTagResponse>
Parameters
- locationId: string
- tagId: string
Returns Promise<LocationTagResponse>
- Defined in locations/locations.client.ts:215

updateTag

updateTag(
    locationId: string,
    tagId: string,
    name: string,
): Promise<LocationTagResponse>
Parameters
- locationId: string
- tagId: string
- name: string
Returns Promise<LocationTagResponse>
- Defined in locations/locations.client.ts:224

removeTag

removeTag(locationId: string, tagId: string): Promise<SuccededDeleteResponse>
Parameters
- locationId: string
- tagId: string
Returns Promise<SuccededDeleteResponse>
- Defined in locations/locations.client.ts:235

searchTasks

searchTasks(
locationId: string,
dto: LocationTaskSearchParams,
): Promise<ListLocationTasksResponse>
Parameters
- locationId: string
- dto: LocationTaskSearchParams
Returns Promise<ListLocationTasksResponse>
- Defined in locations/locations.client.ts:244

findTimezones

findTimezones(locationId: string): Promise<LocationTimeZonesResponse>
Parameters
- locationId: string
Returns Promise<LocationTimeZonesResponse>
- Defined in locations/locations.client.ts:254