forked from route4me/route4me-nodejs-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
19 changed files
with
2,133 additions
and
2,326 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| <a id="ActivityFeed" name="ActivityFeed"></a> | ||
|
|
||
| ## ActivityFeed | ||
|
|
||
| ActivityFeed facility | ||
|
|
||
| **Category**: ActivityFeed | ||
|
|
||
| * [ActivityFeed](#ActivityFeed) | ||
| * [new ActivityFeed(requestManager)](#new_ActivityFeed_new) | ||
| * [.ActivityTypeEnum](#ActivityFeed+ActivityTypeEnum) | ||
| * [.create(data, [callback])](#ActivityFeed+create) | ||
| * [.list(criteria, options, [callback])](#ActivityFeed+list) | ||
|
|
||
| <a id="new_ActivityFeed_new" name="new_ActivityFeed_new"></a> | ||
|
|
||
| ### new ActivityFeed(requestManager) | ||
|
|
||
| Constructor | ||
|
|
||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | requestManager | <code>RequestManager</code> | Request Manager | | ||
|
|
||
| <a id="ActivityFeed+ActivityTypeEnum" name="ActivityFeed+ActivityTypeEnum"></a> | ||
|
|
||
| ### activityFeed.ActivityTypeEnum | ||
|
|
||
| Enumerable of all known activity type | ||
|
|
||
| **Todo** | ||
|
|
||
| - [ ] TODO: move to PACKAGE level (to make it easier for usage) see [https://github.com/route4me/route4me-nodejs-sdk/issues/40](https://github.com/route4me/route4me-nodejs-sdk/issues/40) | ||
|
|
||
| <a id="ActivityFeed+create" name="ActivityFeed+create"></a> | ||
|
|
||
| ### activityFeed.create(data, [callback]) | ||
|
|
||
| Log a Specific Message | ||
|
|
||
| This example demonstrates how to permanently store a specific message | ||
| directly to the activity feed. For example, this can be used for one or | ||
| two-way chat. | ||
|
|
||
| **The created activity will have `activityType === "user_message"`** | ||
|
|
||
| **See**: [https://route4me.io/docs/#log-a-specific-message](https://route4me.io/docs/#log-a-specific-message) | ||
| **Since**: 0.1.12 | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | data | <code>Object</code> | Activity Feed item | | ||
| | data.routeId | <code>string</code> | Route ID | | ||
| | data.message | <code>string</code> | A message text for logging into the activity feed | | ||
| | [callback] | <code>module:route4me-node~RequestCallback</code> | | | ||
|
|
||
| <a id="ActivityFeed+list" name="ActivityFeed+list"></a> | ||
|
|
||
| ### activityFeed.list(criteria, options, [callback]) | ||
|
|
||
| Log a Specific Message | ||
|
|
||
| This example demonstrates how to permanently store a specific message | ||
| directly to the activity feed. For example, this can be used for one or | ||
| two-way chat. | ||
|
|
||
| **See**: [https://route4me.io/docs/#log-a-specific-message](https://route4me.io/docs/#log-a-specific-message) | ||
| **Since**: 0.1.12 | ||
|
|
||
| | Param | Type | Default | Description | | ||
| | --- | --- | --- | --- | | ||
| | criteria | <code>string</code> | <code>Object</code> | | Criteria for event filter. Depending on type will be considered as: * `string` - criteria is a string representation of [Activity type](ActivityTypeEnum) * `Object` - criteria is a set of filters, see below | | ||
| | [criteria.activityType] | <code>string</code> | | [Activity type](ActivityTypeEnum) | | ||
| | [criteria.routeId] | <code>string</code> | | Route ID | | ||
| | options | <code>Object</code> | | Options for activity search | | ||
| | [options.limit] | <code>number</code> | | List limit | | ||
| | [options.offset] | <code>number</code> | | List offset | | ||
| | [options.includeTeamActivities] | <code>boolean</code> | <code>false</code> | Indicate, whether team activities should be included | | ||
| | [callback] | <code>module:route4me-node~RequestCallback.<jsonschema:ActivityFeed.ActivityFeedResult></code> | | | | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| <a id="AddressBook" name="AddressBook"></a> | ||
|
|
||
| ## AddressBook : <code>object</code> | ||
|
|
||
| AddressBook facility | ||
|
|
||
| **Category**: AddressBook | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | requestManager | <code>RequestManager</code> | Request Manager | | ||
|
|
||
|
|
||
| * [AddressBook](#AddressBook) : <code>object</code> | ||
| * [.create(data, [callback])](#AddressBook+create) | ||
| * [.getMany(ids, [callback])](#AddressBook+getMany) | ||
| * [.list(options, [callback])](#AddressBook+list) | ||
| * [.search(query, options, [callback])](#AddressBook+search) | ||
| * [.update(id, data, [callback])](#AddressBook+update) | ||
| * [.remove(ids, [callback])](#AddressBook+remove) | ||
|
|
||
| <a id="AddressBook+create" name="AddressBook+create"></a> | ||
|
|
||
| ### addressBook.create(data, [callback]) | ||
|
|
||
| Create a new AddressBook. | ||
|
|
||
| **See**: [https://route4me.io/docs/#create-a-location](https://route4me.io/docs/#create-a-location) | ||
| **Since**: 0.1.8 | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | data | <code>jsonschema:AddressBook.AddressBook</code> | Valid AddressBook data. | | ||
| | [callback] | <code>module:route4me-node~RequestCallback.<jsonschema:AddressBook.AddressBook></code> | | | ||
|
|
||
| <a id="AddressBook+getMany" name="AddressBook+getMany"></a> | ||
|
|
||
| ### addressBook.getMany(ids, [callback]) | ||
|
|
||
| GET locations from an address book by a specified list of locations IDs. | ||
|
|
||
| **See**: [https://route4me.io/docs/#get-locations-by-ids](https://route4me.io/docs/#get-locations-by-ids) | ||
| **Since**: 0.1.8 | ||
| **Todo** | ||
|
|
||
| - [ ] TODO: Parse response | ||
| - [ ] TODO: Remove this method in favor of `list` [https://github.com/route4me/route4me-nodejs-sdk/issues/41](https://github.com/route4me/route4me-nodejs-sdk/issues/41) | ||
|
|
||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | ids | <code>number</code> | <code>string</code> | <code>Array.<number></code> | <code>Array.<string></code> | Address IDs (as number, string, CSV-separated string, or an array of numbers, or an array of strings). | | ||
| | [callback] | <code>module:route4me-node~RequestCallback.<jsonschema:AddressBook.AddressBookSearchResult></code> | | | ||
|
|
||
| <a id="AddressBook+list" name="AddressBook+list"></a> | ||
|
|
||
| ### addressBook.list(options, [callback]) | ||
|
|
||
| GET all locations from a user’s address book. | ||
|
|
||
| **See**: [https://route4me.io/docs/#get-locations](https://route4me.io/docs/#get-locations) | ||
| **Since**: 0.1.8 | ||
| **Todo** | ||
|
|
||
| - [ ] TODO: Parse response | ||
| - [ ] TODO: Describe ALL options (in one place, list+search) | ||
|
|
||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | options | <code>Object</code> | List-parameters | | ||
| | [callback] | <code>module:route4me-node~RequestCallback.<jsonschema:AddressBook.AddressBookSearchResult></code> | | | ||
|
|
||
| <a id="AddressBook+search" name="AddressBook+search"></a> | ||
|
|
||
| ### addressBook.search(query, options, [callback]) | ||
|
|
||
| Search an address book location by containing specified text in any | ||
| field/defined fields. | ||
|
|
||
| **See** | ||
|
|
||
| - [https://route4me.io/docs/#get-a-location](https://route4me.io/docs/#get-a-location) | ||
| - [https://route4me.io/docs/#location-search](https://route4me.io/docs/#location-search) | ||
|
|
||
| **Since**: 0.1.8 | ||
| **Todo** | ||
|
|
||
| - [ ] TODO: Parse response | ||
| - [ ] TODO: Describe ALL options (in one place, list+search) | ||
| - [ ] TODO: Handle the diffrerent format of the output (when fields are set, | ||
| see https://github.com/route4me/route4me-nodejs-sdk/issues/38) | ||
|
|
||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | query | <code>string</code> | Searched text | | ||
| | options | <code>Object</code> | List-parameters | | ||
| | [options.limit] | <code>number</code> | List limit | | ||
| | [options.offset] | <code>number</code> | List offset | | ||
| | [callback] | <code>module:route4me-node~RequestCallback.<jsonschema:AddressBook.AddressBookSearchResult></code> | | | ||
|
|
||
| <a id="AddressBook+update" name="AddressBook+update"></a> | ||
|
|
||
| ### addressBook.update(id, data, [callback]) | ||
|
|
||
| UPDATE existing address book location parameters. | ||
|
|
||
| **See**: [https://route4me.io/docs/#update-a-location](https://route4me.io/docs/#update-a-location) | ||
| **Since**: 0.1.8 | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | id | <code>string</code> | AddressBook item ID | | ||
| | data | <code>jsonschema:AddressBook.AddressBook</code> | Valid AddressBook data. | | ||
| | [callback] | <code>module:route4me-node~RequestCallback.<jsonschema:AddressBook.AddressBook></code> | | | ||
|
|
||
| <a id="AddressBook+remove" name="AddressBook+remove"></a> | ||
|
|
||
| ### addressBook.remove(ids, [callback]) | ||
|
|
||
| REMOVE locations from an address book. | ||
|
|
||
| **See**: [https://route4me.io/docs/#remove-locations](https://route4me.io/docs/#remove-locations) | ||
| **Since**: 0.1.8 | ||
| **Todo** | ||
|
|
||
| - [ ] TODO: There is no schema for the response | ||
| - [ ] TODO: parse the response | ||
|
|
||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | ids | <code>number</code> | <code>string</code> | <code>Array.<number></code> | <code>Array.<string></code> | locations IDs, CSV-string OR one ID as string OR one ID as number OR array of strings/numbers | | ||
| | [callback] | <code>module:route4me-node~RequestCallback.<boolean></code> | | | ||
|
|
||
| **Example** | ||
| ```js | ||
| SampleResponse = {"status":true} | ||
| ``` |
Oops, something went wrong.