-
Notifications
You must be signed in to change notification settings - Fork 53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Mesh network management API #98
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1329,6 +1329,109 @@ class Particle { | |
return this.get(`/v1/serial_numbers/${serialNumber}`, auth, undefined, context); | ||
} | ||
|
||
/** | ||
* Create a mesh network | ||
* @param {Object} options Options for this API call | ||
* @param {String} options.name Network name | ||
* @param {String} options.deviceId Gateway device ID | ||
* @param {String} [options.iccid] ICCID of the active SIM card (only for cellular gateway devices) | ||
* @param {String} options.auth Access token | ||
* @param {Object} [options.context] Request context | ||
* @return {Promise<Object>} | ||
*/ | ||
createMeshNetwork({ name, deviceId, iccid, auth, context }) { | ||
return this.post('/v1/networks', { name, device_id: deviceId, iccid }, auth, context); | ||
} | ||
|
||
/** | ||
* Remove a mesh network. | ||
* @param {Object} options Options for this API call | ||
* @param {String} options.networkId Network ID or name | ||
* @param {String} options.auth Access token | ||
* @param {Object} [options.context] Request context | ||
* @return {Promise<Object>} | ||
*/ | ||
removeMeshNetwork({ networkId, auth, context }) { | ||
return this.delete(`/v1/networks/${networkId}`, undefined, auth, context); | ||
} | ||
|
||
/** | ||
* List all mesh networks | ||
* @param {Object} options Options for this API call | ||
* @param {String} options.auth Access token | ||
* @param {Object} [options.context] Request context | ||
* @return {Promise<Object>} | ||
*/ | ||
listMeshNetworks({ auth, context }) { | ||
// TODO: Pagination | ||
return this.get('/v1/networks', auth, undefined, context); | ||
} | ||
|
||
/** | ||
* Get information about a mesh network. | ||
* @param {Object} options Options for this API call | ||
* @param {String} options.networkId Network ID or name | ||
* @param {String} options.auth Access token | ||
* @param {Object} [options.context] Request context | ||
* @return {Promise<Object>} | ||
*/ | ||
getMeshNetwork({ networkId, auth, context }) { | ||
return this.get(`/v1/networks/${networkId}`, auth, undefined, context); | ||
} | ||
|
||
/** | ||
* Modify a mesh network. | ||
* @param {Object} options Options for this API call | ||
* @param {String} options.networkId Network ID or name | ||
* @param {String} options.action 'add-device', 'remove-device', 'gateway-enable' or 'gateway-disable' | ||
* @param {String} options.deviceId Device ID | ||
* @param {String} options.auth Access token | ||
* @param {Object} [options.context] Request context | ||
* @return {Promise<Object>} | ||
*/ | ||
updateMeshNetwork({ networkId, action, deviceId, auth, context }) { | ||
return this.put(`/v1/networks/${networkId}`, { action, device_id: deviceId }, auth, context); | ||
} | ||
|
||
/** | ||
* Add a device to a mesh network. | ||
* @param {Object} options Options for this API call | ||
* @param {String} options.networkId Network ID or name | ||
* @param {String} options.deviceId Device ID | ||
* @param {String} options.auth Access token | ||
* @param {Object} [options.context] Request context | ||
* @return {Promise<Object>} | ||
*/ | ||
addMeshNetworkDevice({ networkId, deviceId, auth, context }) { | ||
return this.updateMeshNetwork({ action: 'add-device', networkId, deviceId, auth, context }); | ||
} | ||
|
||
/** | ||
* Remove a device from a mesh network. | ||
* @param {Object} options Options for this API call | ||
* @param {String} options.networkId Network ID or name | ||
* @param {String} options.deviceId Device ID | ||
* @param {String} options.auth Access token | ||
* @param {Object} [options.context] Request context | ||
* @return {Promise<Object>} | ||
*/ | ||
removeMeshNetworkDevice({ networkId, deviceId, auth, context }) { | ||
return this.updateMeshNetwork({ action: 'remove-device', networkId, deviceId, auth, context }); | ||
} | ||
|
||
/** | ||
* List all devices of a mesh network. | ||
* @param {Object} options Options for this API call | ||
* @param {String} options.networkId Network ID or name | ||
* @param {String} options.auth Access token | ||
* @param {Object} [options.context] Request context | ||
* @return {Promise<Object>} | ||
*/ | ||
listMeshNetworkDevices({ networkId, auth, context }) { | ||
// TODO: Pagination and filtering | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Filtering and pagination is supported through |
||
return this.get(`/v1/networks/${networkId}/devices`, auth, undefined, context); | ||
} | ||
|
||
|
||
/** | ||
* API URI to access a device | ||
|
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pagination is supported with
?page=1&per_page=1