Class ContactsClient

Hierarchy

GhlClient
- ContactsClient

Constructors

constructor

new ContactsClient(accessToken: string): ContactsClient
Parameters
- accessToken: string
Returns ContactsClient
Overrides GhlClient.constructor
- Defined in contacts/contacts.client.ts:33

Methods

findById

findById(id: string): Promise<ContactResponse>
Parameters
- id: string
Returns Promise<ContactResponse>
- Defined in contacts/contacts.client.ts:37

update

update(id: string, dto: UpdateContactDto): Promise<UpdateContactResponse>
Parameters
- id: string
- dto: UpdateContactDto
Returns Promise<UpdateContactResponse>
- Defined in contacts/contacts.client.ts:41

remove

remove(id: string): Promise<SuccededDeleteResponse>
Parameters
- id: string
Returns Promise<SuccededDeleteResponse>
- Defined in contacts/contacts.client.ts:48

upsert

upsert(dto: CreateContactDto): Promise<UpsertContactResponse>
Parameters
- dto: CreateContactDto
Returns Promise<UpsertContactResponse>
- Defined in contacts/contacts.client.ts:52

findByBusiness

findByBusiness(
businessId: string,
params: BusinessContactSearchParams,
): Promise<FindContactsResponse>
Parameters
- businessId: string
- params: BusinessContactSearchParams
Returns Promise<FindContactsResponse>
- Defined in contacts/contacts.client.ts:56

create

create(dto: CreateContactDto): Promise<ContactResponse>
Parameters
- dto: CreateContactDto
Returns Promise<ContactResponse>
- Defined in contacts/contacts.client.ts:65

find

find(params: ContactLegacySearchParams): Promise<FindContactsResponse>
Parameters
- params: ContactLegacySearchParams
Returns Promise<FindContactsResponse>
- Defined in contacts/contacts.client.ts:69

findTasks

findTasks(contactId: string): Promise<ListContactTaskResponse>
Parameters
- contactId: string
Returns Promise<ListContactTaskResponse>
- Defined in contacts/contacts.client.ts:77

createTask

createTask(
contactId: string,
dto: CreateContactTaskDto,
): Promise<ContactTaskResponse>
Parameters
- contactId: string
- dto: CreateContactTaskDto
Returns Promise<ContactTaskResponse>
- Defined in contacts/contacts.client.ts:81

findTaskById

findTaskById(contactId: string, taskId: string): Promise<ContactTaskResponse>
Parameters
- contactId: string
- taskId: string
Returns Promise<ContactTaskResponse>
- Defined in contacts/contacts.client.ts:88

updateTask

updateTask(
    contactId: string,
    taskId: string,
    dto: Partial,
): Promise<ContactTaskResponse>
Parameters
- contactId: string
- taskId: string
- dto: Partial
Returns Promise<ContactTaskResponse>
- Defined in contacts/contacts.client.ts:97

removeTask

removeTask(contactId: string, taskId: string): Promise<SuccededDeleteResponse>
Parameters
- contactId: string
- taskId: string
Returns Promise<SuccededDeleteResponse>
- Defined in contacts/contacts.client.ts:108

updateTaskStatus

updateTaskStatus(
    contactId: string,
    taskId: string,
    completed: boolean,
): Promise<ContactTaskResponse>
Parameters
- contactId: string
- taskId: string
- completed: boolean
Returns Promise<ContactTaskResponse>
- Defined in contacts/contacts.client.ts:117

findAppointments

findAppointments(contactId: string): Promise<ListContactEventsResponse>
Parameters
- contactId: string
Returns Promise<ListContactEventsResponse>
- Defined in contacts/contacts.client.ts:128

addTags

addTags(contactId: string, dto: ContactTagsDto): Promise<ContactTagsDto>
Parameters
- contactId: string
- dto: ContactTagsDto
Returns Promise<ContactTagsDto>
- Defined in contacts/contacts.client.ts:136

removeTags

removeTags(contactId: string, data: ContactTagsDto): Promise<ContactTagsDto>
Parameters
- contactId: string
- data: ContactTagsDto
Returns Promise<ContactTagsDto>
- Defined in contacts/contacts.client.ts:143

findNotes

findNotes(contactId: string): Promise<ListContactNotesResponse>
Parameters
- contactId: string
Returns Promise<ListContactNotesResponse>
- Defined in contacts/contacts.client.ts:150

createNote

createNote(contactId: string, dto: ContactNoteDto): Promise<ContactNoteResponse>
Parameters
- contactId: string
- dto: ContactNoteDto
Returns Promise<ContactNoteResponse>
- Defined in contacts/contacts.client.ts:154

findNoteById

findNoteById(contactId: string, noteId: string): Promise<ContactNoteResponse>
Parameters
- contactId: string
- noteId: string
Returns Promise<ContactNoteResponse>
- Defined in contacts/contacts.client.ts:161

updateNote

updateNote(
    contactId: string,
    noteId: string,
    dto: ContactNoteDto,
): Promise<ContactNoteResponse>
Parameters
- contactId: string
- noteId: string
- dto: ContactNoteDto
Returns Promise<ContactNoteResponse>
- Defined in contacts/contacts.client.ts:170

removeNote

removeNote(contactId: string, noteId: string): Promise<SuccededDeleteResponse>
Parameters
- contactId: string
- noteId: string
Returns Promise<SuccededDeleteResponse>
- Defined in contacts/contacts.client.ts:181

addToCampaign

addToCampaign(
contactId: string,
campaignId: string,
): Promise<ContactActionResponse>
Parameters
- contactId: string
- campaignId: string
Returns Promise<ContactActionResponse>
- Defined in contacts/contacts.client.ts:190

removeFromCampaign

removeFromCampaign(
contactId: string,
campaignId: string,
): Promise<ContactActionResponse>
Parameters
- contactId: string
- campaignId: string
Returns Promise<ContactActionResponse>
- Defined in contacts/contacts.client.ts:199

removeFromEveryCampaign

removeFromEveryCampaign(contactId: string): Promise<ContactActionResponse>
Parameters
- contactId: string
Returns Promise<ContactActionResponse>
- Defined in contacts/contacts.client.ts:208

addToWorkflow

addToWorkflow(
    contactId: string,
    workflowId: string,
    startTime: string,
): Promise<ContactActionResponse>
Parameters
- contactId: string
- workflowId: string
- startTime: string
Returns Promise<ContactActionResponse>
- Defined in contacts/contacts.client.ts:216

removeFromWorkflow

removeFromWorkflow(
contactId: string,
workflowId: string,
): Promise<SuccededDeleteResponse>
Parameters
- contactId: string
- workflowId: string
Returns Promise<SuccededDeleteResponse>
- Defined in contacts/contacts.client.ts:227

addRemoveFromBusiness

addRemoveFromBusiness(
dto: ContactBusinessUpdateDto,
): Promise<ContactBulkUpateResponse>
Parameters
- dto: ContactBusinessUpdateDto
Returns Promise<ContactBulkUpateResponse>
- Defined in contacts/contacts.client.ts:236

search

search(dto: ContactSearchOptions): Promise<ContactSearchResponse>
Parameters
- dto: ContactSearchOptions
Returns Promise<ContactSearchResponse>
- Defined in contacts/contacts.client.ts:242

findDuplicates

findDuplicates(
params: DuplicateContactSearchParams,
): Promise<ContactsDuplicateSearchResponse>
Parameters
- params: DuplicateContactSearchParams
Returns Promise<ContactsDuplicateSearchResponse>
- Defined in contacts/contacts.client.ts:248

addFollowers

addFollowers(
contactId: string,
followers: string[],
): Promise<ContactAddFollowersResponse>
Parameters
- contactId: string
- followers: string[]
Returns Promise<ContactAddFollowersResponse>
- Defined in contacts/contacts.client.ts:259

removeFollowers

removeFollowers(
contactId: string,
followers: string[],
): Promise<ContactRemoveFollowersResponse>
Parameters
- contactId: string
- followers: string[]
Returns Promise<ContactRemoveFollowersResponse>
- Defined in contacts/contacts.client.ts:269