class Client

Class Client

Methods

__construct(ClientInterface $clientInterface)

Client constructor.

mixed
createContact(CreateContact $contact)

Create a new CreateContact.

mixed
getContact(GetContact $contact)

Get a Contact by their Contact ID.

mixed
editContact(EditContact $contact)

Update information for a Contact.

mixed
createPipeline(CreatePipeline $pipeline)

CreatePipeline function is used to attach a new pipeline to a contact or company in your CRM.

mixed
updatePipelineItem(UpdatePipelineItem $pipelineItem)

UpdatePipelineItem function is used to edit an existing pipeline item in the CRM.

mixed
createNote(CreateNote $note)

CreateNote function is used to add a note to a contact's history.

mixed
createTask(CreateTask $task)

CreateTask function is used to add a task in your CRM.

mixed
createEvent(CreateEvent $event)

CreateEvent function is used to add an event to your calendar.

mixed
addContactToGroup(AddContactToGroup $contact)

AddContactToGroup function is used to add a contact to one of the groups in your CRM.

mixed
searchContacts(SearchContacts $search)

SearchContacts function is used to retrieve a list of contacts and companies that match a search.

mixed
deleteContact(DeleteContact $contact)

DeleteContact function is used to remove contacts from your CRM.

mixed
getPipelineReport(GetPipelineReport $pipelineReport)

GetPipelineReport function is used to retrieve the data from a pipeline report.

mixed
getUserInfo()

GetUserInfo function is used to retrieve meta information about your CRM account.

mixed
getCustomFields()

GetCustomFields function is used to retrieve a list of all the custom contact/company fields you've created in your CRM

Details

at line 33
__construct(ClientInterface $clientInterface)

Client constructor.

Parameters

ClientInterface $clientInterface

at line 44
mixed createContact(CreateContact $contact)

Create a new CreateContact.

Parameters

CreateContact $contact

Return Value

mixed

at line 55
mixed getContact(GetContact $contact)

Get a Contact by their Contact ID.

Parameters

GetContact $contact

Return Value

mixed

at line 66
mixed editContact(EditContact $contact)

Update information for a Contact.

Parameters

EditContact $contact

Return Value

mixed

at line 78
mixed createPipeline(CreatePipeline $pipeline)

CreatePipeline function is used to attach a new pipeline to a contact or company in your CRM.

Parameters

CreatePipeline $pipeline

Return Value

mixed

at line 89
mixed updatePipelineItem(UpdatePipelineItem $pipelineItem)

UpdatePipelineItem function is used to edit an existing pipeline item in the CRM.

Parameters

UpdatePipelineItem $pipelineItem

Return Value

mixed

at line 100
mixed createNote(CreateNote $note)

CreateNote function is used to add a note to a contact's history.

Parameters

CreateNote $note

Return Value

mixed

at line 111
mixed createTask(CreateTask $task)

CreateTask function is used to add a task in your CRM.

Parameters

CreateTask $task

Return Value

mixed

at line 122
mixed createEvent(CreateEvent $event)

CreateEvent function is used to add an event to your calendar.

Parameters

CreateEvent $event

Return Value

mixed

at line 133
mixed addContactToGroup(AddContactToGroup $contact)

AddContactToGroup function is used to add a contact to one of the groups in your CRM.

Parameters

AddContactToGroup $contact

Return Value

mixed

at line 145
mixed searchContacts(SearchContacts $search)

SearchContacts function is used to retrieve a list of contacts and companies that match a search.

Parameters

SearchContacts $search

Return Value

mixed

at line 156
mixed deleteContact(DeleteContact $contact)

DeleteContact function is used to remove contacts from your CRM.

Parameters

DeleteContact $contact

Return Value

mixed

at line 167
mixed getPipelineReport(GetPipelineReport $pipelineReport)

GetPipelineReport function is used to retrieve the data from a pipeline report.

Parameters

GetPipelineReport $pipelineReport

Return Value

mixed

at line 177
mixed getUserInfo()

GetUserInfo function is used to retrieve meta information about your CRM account.

Return Value

mixed

at line 188
mixed getCustomFields()

GetCustomFields function is used to retrieve a list of all the custom contact/company fields you've created in your CRM

Return Value

mixed