Skip to content

Commit

Permalink
v0.0.17
Browse files Browse the repository at this point in the history
  • Loading branch information
k-grube committed Aug 24, 2018
1 parent ca89599 commit a28254d
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 2 deletions.
75 changes: 74 additions & 1 deletion doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
<dd></dd>
<dt><a href="#Configurations">Configurations</a></dt>
<dd></dd>
<dt><a href="#ContactRelationships">ContactRelationships</a></dt>
<dd></dd>
<dt><a href="#Contacts">Contacts</a></dt>
<dd></dd>
<dt><a href="#CompanyAPI">CompanyAPI</a></dt>
Expand Down Expand Up @@ -82,8 +84,12 @@
<dd></dd>
<dt><a href="#ConfigurationQuestion">ConfigurationQuestion</a> : <code>object</code></dt>
<dd></dd>
<dt><a href="#Relationship">Relationship</a> : <code>object</code></dt>
<dd></dd>
<dt><a href="#Contact">Contact</a> : <code>object</code></dt>
<dd></dd>
<dt><a href="#ContactType">ContactType</a> : <code>object</code></dt>
<dd></dd>
<dt><a href="#PortalSecurity">PortalSecurity</a> : <code>object</code></dt>
<dd></dd>
<dt><a href="#ValidatePortalResponse">ValidatePortalResponse</a> : <code>object</code></dt>
Expand Down Expand Up @@ -548,6 +554,33 @@
| id | <code>string</code> \| <code>number</code> |
| config | [<code>Configuration</code>](#Configuration) |

<a name="ContactRelationships"></a>

## ContactRelationships
**Kind**: global class
**Inherits**: [<code>ConnectWise</code>](#ConnectWise)

* [ContactRelationships](#ContactRelationships)
* [new ContactRelationships(options)](#new_ContactRelationships_new)
* [.getRelationships(params)](#ContactRelationships+getRelationships) ⇒ <code>Promise.&lt;Array.&lt;Relationship&gt;&gt;</code>

<a name="new_ContactRelationships_new"></a>

### new ContactRelationships(options)

| Param | Type |
| --- | --- |
| options | [<code>CWOptions</code>](#CWOptions) |

<a name="ContactRelationships+getRelationships"></a>

### contactRelationships.getRelationships(params) ⇒ <code>Promise.&lt;Array.&lt;Relationship&gt;&gt;</code>
**Kind**: instance method of [<code>ContactRelationships</code>](#ContactRelationships)

| Param | Type |
| --- | --- |
| params | [<code>Params</code>](#Params) |

<a name="Contacts"></a>

## Contacts
Expand All @@ -559,6 +592,7 @@
* [.getContacts(params)](#Contacts+getContacts) ⇒ <code>Promise.&lt;Array.&lt;Contact&gt;&gt;</code>
* [.createContact(contact)](#Contacts+createContact)[<code>Promise.&lt;Contact&gt;</code>](#Contact)
* [.getContactsCount(params)](#Contacts+getContactsCount)[<code>Promise.&lt;Count&gt;</code>](#Count)
* [.getContactTypes(params)](#Contacts+getContactTypes)[<code>Promise.&lt;ContactType&gt;</code>](#ContactType)
* [.deleteContactById(id, transferContactId)](#Contacts+deleteContactById)[<code>Promise.&lt;DeleteResponse&gt;</code>](#DeleteResponse)
* [.getContactById(id)](#Contacts+getContactById)[<code>Promise.&lt;Contact&gt;</code>](#Contact)
* [.updateContact(id, operations)](#Contacts+updateContact)[<code>Promise.&lt;Contact&gt;</code>](#Contact)
Expand Down Expand Up @@ -603,6 +637,15 @@
| --- | --- |
| params | [<code>ParamsConditions</code>](#ParamsConditions) |

<a name="Contacts+getContactTypes"></a>

### contacts.getContactTypes(params) ⇒ [<code>Promise.&lt;ContactType&gt;</code>](#ContactType)
**Kind**: instance method of [<code>Contacts</code>](#Contacts)

| Param | Type |
| --- | --- |
| params | [<code>ParamsConditions</code>](#ParamsConditions) |

<a name="Contacts+deleteContactById"></a>

### contacts.deleteContactById(id, transferContactId) ⇒ [<code>Promise.&lt;DeleteResponse&gt;</code>](#DeleteResponse)
Expand Down Expand Up @@ -3228,6 +3271,20 @@ GET
| numberOfDecimals | <code>number</code> | |
| fieldType | <code>string</code> | ['Text', 'Button', 'Currency', 'Date', 'Hyperlink', 'IPAddress', 'Checkbox', 'Number', 'Percent', 'TextArea', 'Password'] |

<a name="Relationship"></a>

## Relationship : <code>object</code>
**Kind**: global typedef
**Properties**

| Name | Type |
| --- | --- |
| id | <code>number</code> |
| name | <code>string</code> |
| _info | <code>object</code> |
| _info.lastUpdated | <code>string</code> |
| _info.updatedBy | <code>string</code> |

<a name="Contact"></a>

## Contact : <code>object</code>
Expand Down Expand Up @@ -3278,6 +3335,21 @@ GET
| _info.tracks_href | <code>string</code> | |
| _info.updatedBy | <code>string</code> | |

<a name="ContactType"></a>

## ContactType : <code>object</code>
**Kind**: global typedef
**Properties**

| Name | Type |
| --- | --- |
| id | <code>number</code> |
| description | <code>string</code> |
| defaultFlag | <code>boolean</code> |
| _info | <code>object</code> |
| _info.lastUpdated | <code>string</code> |
| _info.updatedBy | <code>string</code> |

<a name="PortalSecurity"></a>

## PortalSecurity : <code>object</code>
Expand Down Expand Up @@ -3311,6 +3383,7 @@ GET
| Companies | [<code>Companies</code>](#Companies) |
| Contacts | [<code>Contacts</code>](#Contacts) |
| Configurations | [<code>Configurations</code>](#Configurations) |
| ContactRelationships | [<code>ContactRelationships</code>](#ContactRelationships) |

<a name="new_CompanyAPI_new"></a>

Expand Down Expand Up @@ -3342,11 +3415,11 @@ GET
| Name | Type |
| --- | --- |
| API | [<code>ConnectWise</code>](#ConnectWise) |
| CompanyAPI | [<code>CompanyAPI</code>](#CompanyAPI) |
| FinanceAPI | [<code>FinanceAPI</code>](#FinanceAPI) |
| ServiceDeskAPI | [<code>ServiceDeskAPI</code>](#ServiceDeskAPI) |
| TimeAPI | [<code>TimeAPI</code>](#TimeAPI) |
| ProjectAPI | [<code>ProjectAPI</code>](#ProjectAPI) |
| CompanyAPI | [<code>CompanyAPI</code>](#CompanyAPI) |
| ScheduleAPI | [<code>ScheduleAPI</code>](#ScheduleAPI) |
| SystemAPI | [<code>SystemAPI</code>](#SystemAPI) |
| SalesAPI | [<code>SalesAPI</code>](#SalesAPI) |
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit a28254d

Please sign in to comment.