Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 51 additions & 21 deletions book/en/code/Members.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
<a id="Members" name="Members"></a>

## Members ℗
## ~~Members ℗~~

Members facility
***Deprecated***

**Category**: Members
**Access**: private
**See**: [https://route4me.io/docs/#territories](https://route4me.io/docs/#territories)
**See**: [TeamManagement](TeamManagement.html)

Members facility
**Since**: 0.1.8

* [Members](#Members) ℗
* ~~[Members](#Members) ℗~~
* [new Members(requestManager)](#new_Members_new)
* [.create(data, [callback])](#Members+create)
* [.list([callback])](#Members+list)
* [.get(id, [callback])](#Members+get)
* [.update(id, data, [callback])](#Members+update)
* ~~[.create(data, [callback])](#Members+create)~~
* ~~[.list([callback])](#Members+list)~~
* ~~[.get(id, [callback])](#Members+get)~~
* ~~[.update(id, data, [callback])](#Members+update)~~
* [.addCustomData(id, data, [callback])](#Members+addCustomData)
* [.remove(id, [callback])](#Members+remove)
* ~~[.remove(id, [callback])](#Members+remove)~~
* [.authenticate(email, password, [callback])](#Members+authenticate)
* [.validateSession(id, sessionId, [callback])](#Members+validateSession)
* [.registerAccount(data, [callback])](#Members+registerAccount)
Expand All @@ -25,8 +27,6 @@ Members facility

### new Members(requestManager)

Constructor

**Returns**: [<code>Members</code>](#Members) - - Members facility

| Param | Type | Description |
Expand All @@ -35,11 +35,17 @@ Constructor

<a id="Members+create" name="Members+create"></a>

### members.create(data, [callback])
### ~~members.create(data, [callback])~~

***Deprecated***

**See**

- [TeamManagement.create](TeamManagement.html#TeamManagement+create)

Create an User
- [https://route4me.io/docs/#create-an-user](https://route4me.io/docs/#create-an-user)

**See**: [https://route4me.io/docs/#create-an-user](https://route4me.io/docs/#create-an-user)
**Since**: 0.1.9
**Todo**

Expand Down Expand Up @@ -89,13 +95,19 @@ Create an User
```
<a id="Members+list" name="Members+list"></a>

### members.list([callback])
### ~~members.list([callback])~~

***Deprecated***

**See**

- [TeamManagement.list](TeamManagement.html#TeamManagement+list)

Member’s Sub-users

View existing sub-users in a member’s account.
- [https://route4me.io/docs/#members-sub-users](https://route4me.io/docs/#members-sub-users)

**See**: [https://route4me.io/docs/#members-sub-users](https://route4me.io/docs/#members-sub-users)
**Since**: 0.1.9
**Todo**

Expand All @@ -108,11 +120,17 @@ View existing sub-users in a member’s account.

<a id="Members+get" name="Members+get"></a>

### members.get(id, [callback])
### ~~members.get(id, [callback])~~

***Deprecated***

**See**

- [TeamManagement.get](TeamManagement.html#TeamManagement+get)

Get an User Details
- [https://route4me.io/docs/#get-an-user-details](https://route4me.io/docs/#get-an-user-details)

**See**: [https://route4me.io/docs/#get-an-user-details](https://route4me.io/docs/#get-an-user-details)
**Since**: 0.1.9
**Todo**

Expand All @@ -126,11 +144,17 @@ Get an User Details

<a id="Members+update" name="Members+update"></a>

### members.update(id, data, [callback])
### ~~members.update(id, data, [callback])~~

***Deprecated***

**See**

- [TeamManagement.update](TeamManagement.html#TeamManagement+update)

Update an existing user.
- [https://route4me.io/docs/#update-an-user](https://route4me.io/docs/#update-an-user)

**See**: [https://route4me.io/docs/#update-an-user](https://route4me.io/docs/#update-an-user)
**Since**: 0.1.9
**Todo**

Expand Down Expand Up @@ -209,11 +233,17 @@ Add Custom Data to a User.
```
<a id="Members+remove" name="Members+remove"></a>

### members.remove(id, [callback])
### ~~members.remove(id, [callback])~~

***Deprecated***

**See**

- [TeamManagement.delete](TeamManagement.html#TeamManagement+delete)

Remove existing user from a member’s account.
- [https://route4me.io/docs/#remove-an-user](https://route4me.io/docs/#remove-an-user)

**See**: [https://route4me.io/docs/#remove-an-user](https://route4me.io/docs/#remove-an-user)
**Since**: 0.1.9

| Param | Type | Description |
Expand Down
24 changes: 15 additions & 9 deletions book/en/code/Vehicles.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
<a id="Vehicles" name="Vehicles"></a>

## Vehicles ℗
## ~~Vehicles ℗~~

Vehicles facility
***Deprecated***

**Category**: Vehicles
**Access**: private
**See**: [https://route4me.io/docs/#vehicles](https://route4me.io/docs/#vehicles)
**See**: [VehiclesV5](VehiclesV5.html)

Vehicles facility
**Since**: 0.1.4

* [Vehicles](#Vehicles) ℗
* ~~[Vehicles](#Vehicles) ℗~~
* [new Vehicles(requestManager)](#new_Vehicles_new)
* [.list([callback])](#Vehicles+list)
* ~~[.list([callback])](#Vehicles+list)~~

<a id="new_Vehicles_new" name="new_Vehicles_new"></a>

### new Vehicles(requestManager)

Constructor

**Returns**: [<code>Vehicles</code>](#Vehicles) - - Vehicles facility

| Param | Type | Description |
Expand All @@ -27,11 +27,17 @@ Constructor

<a id="Vehicles+list" name="Vehicles+list"></a>

### vehicles.list([callback])
### ~~vehicles.list([callback])~~

***Deprecated***

**See**

- [VehiclesV5.list](VehiclesV5.html#VehiclesV5+list)

Get vehicles that belong to the Route4Me account
- [https://route4me.io/docs/#get-vehicles](https://route4me.io/docs/#get-vehicles)

**See**: [https://route4me.io/docs/#get-vehicles](https://route4me.io/docs/#get-vehicles)
**Todo**

- [ ] Fix error in API docs: there the method utilizes `POST`-http-method to get results
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": "route4me-nodejs-sdk",
"version": "1.0.22",
"version": "1.0.24",
"description": "Access Route4Me's logistics-as-a-service API using our Node.js SDK",
"main": "src/index.js",
"browser": "src/route4me.js",
Expand Down
21 changes: 21 additions & 0 deletions src/resources/members.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,18 @@ function _validateSessionValidate(data, ctx, res) {
}

/**
* @deprecated since version 1.0.24
* @see {@link TeamManagement.html TeamManagement}
*
* Members facility
*
* @category Members
*/
class Members {
/**
* @deprecated since version 1.0.24
* @see {@link TeamManagement.html#new_TeamManagement_new TeamManagement}
*
* Constructor
*
* @see {@link https://route4me.io/docs/#territories}
Expand All @@ -113,6 +119,9 @@ class Members {
}

/**
* @deprecated since version 1.0.24
* @see {@link TeamManagement.html#TeamManagement+create TeamManagement.create}
*
* Create an User
*
* @see {@link https://route4me.io/docs/#create-an-user}
Expand Down Expand Up @@ -170,6 +179,9 @@ class Members {
}

/**
* @deprecated since version 1.0.24
* @see {@link TeamManagement.html#TeamManagement+list TeamManagement.list}
*
* Member’s Sub-users
*
* View existing sub-users in a member’s account.
Expand All @@ -190,6 +202,9 @@ class Members {
}

/**
* @deprecated since version 1.0.24
* @see {@link TeamManagement.html#TeamManagement+get TeamManagement.get}
*
* Get an User Details
*
* @see {@link https://route4me.io/docs/#get-an-user-details}
Expand All @@ -212,6 +227,9 @@ class Members {
}

/**
* @deprecated since version 1.0.24
* @see {@link TeamManagement.html#TeamManagement+update TeamManagement.update}
*
* Update an existing user.
*
* @see {@link https://route4me.io/docs/#update-an-user}
Expand Down Expand Up @@ -306,6 +324,9 @@ class Members {
}

/**
* @deprecated since version 1.0.24
* @see {@link TeamManagement.html#TeamManagement+delete TeamManagement.delete}
*
* Remove existing user from a member’s account.
*
* @see {@link https://route4me.io/docs/#remove-an-user}
Expand Down
9 changes: 9 additions & 0 deletions src/resources/vehicles.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
"use strict"

/**
* @deprecated since version 1.0.23
* @see {@link VehiclesV5.html VehiclesV5}
*
* Vehicles facility
*
* @category Vehicles
*/
class Vehicles {
/**
* @deprecated since version 1.0.23
* @see {@link VehiclesV5.html#new_VehiclesV5_new VehiclesV5}
*
* Constructor
*
* @see {@link https://route4me.io/docs/#vehicles}
Expand All @@ -21,6 +27,9 @@ class Vehicles {
}

/**
* @deprecated since version 1.0.23
* @see {@link VehiclesV5.html#VehiclesV5+list VehiclesV5.list}
*
* Get vehicles that belong to the Route4Me account
*
* @todo Fix error in API docs: there the method utilizes `POST`-http-method to get results
Expand Down