diff --git a/doc.md b/doc.md index 0b3f6d8..2657807 100644 --- a/doc.md +++ b/doc.md @@ -7,6 +7,8 @@
Configurations
+
ContactRelationships
+
Contacts
CompanyAPI
@@ -82,8 +84,12 @@
ConfigurationQuestion : object
+
Relationship : object
+
Contact : object
+
ContactType : object
+
PortalSecurity : object
ValidatePortalResponse : object
@@ -548,6 +554,33 @@ | id | string \| number | | config | [Configuration](#Configuration) | + + +## ContactRelationships +**Kind**: global class +**Inherits**: [ConnectWise](#ConnectWise) + +* [ContactRelationships](#ContactRelationships) + * [new ContactRelationships(options)](#new_ContactRelationships_new) + * [.getRelationships(params)](#ContactRelationships+getRelationships) ⇒ Promise.<Array.<Relationship>> + + + +### new ContactRelationships(options) + +| Param | Type | +| --- | --- | +| options | [CWOptions](#CWOptions) | + + + +### contactRelationships.getRelationships(params) ⇒ Promise.<Array.<Relationship>> +**Kind**: instance method of [ContactRelationships](#ContactRelationships) + +| Param | Type | +| --- | --- | +| params | [Params](#Params) | + ## Contacts @@ -559,6 +592,7 @@ * [.getContacts(params)](#Contacts+getContacts) ⇒ Promise.<Array.<Contact>> * [.createContact(contact)](#Contacts+createContact) ⇒ [Promise.<Contact>](#Contact) * [.getContactsCount(params)](#Contacts+getContactsCount) ⇒ [Promise.<Count>](#Count) + * [.getContactTypes(params)](#Contacts+getContactTypes) ⇒ [Promise.<ContactType>](#ContactType) * [.deleteContactById(id, transferContactId)](#Contacts+deleteContactById) ⇒ [Promise.<DeleteResponse>](#DeleteResponse) * [.getContactById(id)](#Contacts+getContactById) ⇒ [Promise.<Contact>](#Contact) * [.updateContact(id, operations)](#Contacts+updateContact) ⇒ [Promise.<Contact>](#Contact) @@ -603,6 +637,15 @@ | --- | --- | | params | [ParamsConditions](#ParamsConditions) | + + +### contacts.getContactTypes(params) ⇒ [Promise.<ContactType>](#ContactType) +**Kind**: instance method of [Contacts](#Contacts) + +| Param | Type | +| --- | --- | +| params | [ParamsConditions](#ParamsConditions) | + ### contacts.deleteContactById(id, transferContactId) ⇒ [Promise.<DeleteResponse>](#DeleteResponse) @@ -3228,6 +3271,20 @@ GET | numberOfDecimals | number | | | fieldType | string | ['Text', 'Button', 'Currency', 'Date', 'Hyperlink', 'IPAddress', 'Checkbox', 'Number', 'Percent', 'TextArea', 'Password'] | + + +## Relationship : object +**Kind**: global typedef +**Properties** + +| Name | Type | +| --- | --- | +| id | number | +| name | string | +| _info | object | +| _info.lastUpdated | string | +| _info.updatedBy | string | + ## Contact : object @@ -3278,6 +3335,21 @@ GET | _info.tracks_href | string | | | _info.updatedBy | string | | + + +## ContactType : object +**Kind**: global typedef +**Properties** + +| Name | Type | +| --- | --- | +| id | number | +| description | string | +| defaultFlag | boolean | +| _info | object | +| _info.lastUpdated | string | +| _info.updatedBy | string | + ## PortalSecurity : object @@ -3311,6 +3383,7 @@ GET | Companies | [Companies](#Companies) | | Contacts | [Contacts](#Contacts) | | Configurations | [Configurations](#Configurations) | +| ContactRelationships | [ContactRelationships](#ContactRelationships) | @@ -3342,11 +3415,11 @@ GET | Name | Type | | --- | --- | | API | [ConnectWise](#ConnectWise) | +| CompanyAPI | [CompanyAPI](#CompanyAPI) | | FinanceAPI | [FinanceAPI](#FinanceAPI) | | ServiceDeskAPI | [ServiceDeskAPI](#ServiceDeskAPI) | | TimeAPI | [TimeAPI](#TimeAPI) | | ProjectAPI | [ProjectAPI](#ProjectAPI) | -| CompanyAPI | [CompanyAPI](#CompanyAPI) | | ScheduleAPI | [ScheduleAPI](#ScheduleAPI) | | SystemAPI | [SystemAPI](#SystemAPI) | | SalesAPI | [SalesAPI](#SalesAPI) | diff --git a/package.json b/package.json index 6871142..5f9eada 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "connectwise-rest", - "version": "0.0.16", + "version": "0.0.17", "description": "A nodejs module for interacting with the ConnectWise REST API.", "main": "index.js", "scripts": {