Methods
create(companyParams) → {Promise}
Upsert a company object, passes data through to intercom
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
companyParams |
Object |
Properties
|
- Source:
- See:
Returns:
- Returns success if intercom is disabled, otherwise
returns results of create command in intercom
- Type
- Promise
list() → {Promise}
List all Companies. With pagination
- Source:
Returns:
Resolves with the body of the list call for the type.
- Type
- Promise
listUsers(companyId) → {Promise.<Array>}
List all the users who belong to a particular company
Parameters:
| Name | Type | Description |
|---|---|---|
companyId |
String | ID of the company we are listing users for |
- Source:
Returns:
- Returns success if intercom is disabled,
otherwise returns list of users
- Type
- Promise.<Array>