Constructor
new Base(client)
Constructor for Base
Parameters:
| Name | Type | Description |
|---|---|---|
client |
Object | Intercom client. |
Methods
_getAllObjects(body, objects)
Helper method to get all objects from all pages
Parameters:
| Name | Type | Description |
|---|---|---|
body |
Object | Response body from Intercom |
objects |
Promise.<Array> | Concatenated list of all objects |
list() → {Promise}
List Objects.
Returns:
Resolves with the body of the list call for the type.
- Type
- Promise
listBy(query) → {Promise.<Array>}
List objects by specific parameters
Parameters:
| Name | Type | Description |
|---|---|---|
query |
Object |
Returns:
- Returns success if intercom is disabled,
otherwise returns list of companies
- Type
- Promise.<Array>