Class: ContactsAPI

new ContactsAPI(rest)

This class is used to interact with Contacts in TidyHQ.

Parameters:

Name	Type	Description
`rest`	Rest	The rest instance to use for requests.

Source: src/Contacts.js, line 15

Methods

(async) createContact(contact, optionsopt) → {Promise.<TidyAPI_V1_Contact>}

Creates a new contact with the given data in TidyHQ.

Parameters:

Name Type Attributes Default Description

contact Tidy_V1_ContactParams The contact to create. Requires a first name.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Contacts.js, line 102

Returns:

- The newly created contact.

Type:: Promise.<TidyAPI_V1_Contact>

(async) deleteContact(contact_id, optionsopt) → {Promise.<TidyAPI_Response>}

Deletes a contact from TidyHQ.

Parameters:

Name Type Attributes Default Description

contact_id number The ID of the contact to delete.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Contacts.js, line 133

Returns:

- Success or failure.

Type:: Promise.<TidyAPI_Response>

(async) getContact(contactIDopt, optionsopt) → {Promise.<TidyAPI_V1_Contact>}

Get a single contact from TidyHQ.

Parameters:

Name Type Attributes Default Description

contactID number | string <optional> "me" The ID of the contact to get ("me" returns the contact of the user who authorized the application)

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Contacts.js, line 90

Returns:

- A contact.

Type:: Promise.<TidyAPI_V1_Contact>

(async) getContacts(optionsopt) → {Promise.<TidyAPI_V1_Contacts>}

Get a list of contacts from TidyHQ.

Parameters:

Name Type Attributes Default Description

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`limit`	number	<optional>	The maximum number of contacts to return.
`offset`	number	<optional>	The number of contacts to skip.
`search_terms`	string	<optional>	The search terms to use.
`show_all`	boolean	<optional>	Whether to show all contacts or not.
`updated_since`	string	<optional>	The timestamp of the last update in ISO 8601 format.
`ids`	Array.<number>	<optional>	An array of contact IDs to get.
`fields`	Array.<string>	<optional>	An array of fields to get.
`filter`	Array.<string>	<optional>	An array of filters to use.

Source: src/Contacts.js, line 60

Returns:

- An array of contacts.

Type:: Promise.<TidyAPI_V1_Contacts>

(async) getContactsInGroup(group_id, optionsopt) → {Promise.<TidyAPI_V1_Contacts>}

Get a list of contacts in a group from TidyHQ.

Parameters:

Name Type Attributes Default Description

group_id string The ID of the group to get contacts from.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`limit`	number	<optional>	The maximum number of contacts to return.
`offset`	number	<optional>	The number of contacts to skip.
`search_terms`	string	<optional>	The search terms to use.
`show_all`	boolean	<optional>	Whether to show all contacts or not.
`updated_since`	string	<optional>	The timestamp of the last update in ISO 8601 format.
`ids`	Array.<number>	<optional>	An array of contact IDs to get.
`fields`	Array.<string>	<optional>	An array of fields to get.
`filter`	Array.<string>	<optional>	An array of filters to use.

Source: src/Contacts.js, line 79

Returns:

- An array of contacts.

Type:: Promise.<TidyAPI_V1_Contacts>

(async) updateContact(contact_id, contact, optionsopt) → {Promise.<TidyAPI_V1_Contact>}

Updates a contact with the given data in TidyHQ.

Parameters:

Name Type Attributes Default Description

contact_id number The ID of the contact to update.

contact Tidy_V1_ContactParams The contact to update.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Contacts.js, line 118

Returns:

- The updated contact.

Type:: Promise.<TidyAPI_V1_Contact>