cloud-connect-web-api-node

NodeJS API wrapper for Mobile Devices Cloud Connect

Usage

const CloudConnectWebApi = require('cloud-connect-web-api');

let credentials = {
  userToken: '653638dc733afce75130303fe6e6010f63768af0'
};

let api = new CloudConnectWebApi(credentials);

//using callback
api.getConfigurations(function(err, data){
  if (err) throw err;
  console.log(data);
}); 

//using promise
api.getConfigurations()
  .then(function (data) {
    console.log(data);
  }, function (err) {
    console.log(err);
  });

API

Asset configurations

Visible configurations information

List of existing configurations

getConfigurations()

Show details for a specific configuration

getConfiguration(configId)

Create a new configuration

createConfiguration(configName, version, options)

Update existing configuration

updateConfiguration(configId, configName, options)

List all assets linked to a specific configuration

getConfigurationAssets(configId)

List all assets compatible with a specific configuration

getConfigurationCompatibleAssets(configId)

Assets

List of visible assets

getAssets(options, cb)

Get a specific asset

getAsset(imei, options, cb)

Show vehicle information declare on the asset

getVehicleInfo(imei, cb)

Update vehicle information declare on the asset

updateVehicleInfo(imei, options, cb)

Retrieve the current configuration for a specific asset and return the configuration for the OS version and for each module that could be configured.

getAssetConfiguration(imei, cb)

Assets Group

List of existing asset groups

getAssetsGroups(callback)

Show details for a specific asset group

getAssetsGroup(assetGroupId, callback)

Create a new asset group

createAssetsGroup(options, callback)

Update existing configuration

updateAssetsGroup(assetGroupId, options, callback)

Campaigns

List of visible campaigns

getCampaigns(callback)

List of archived campaigns

getCampaignsArchive(callback)

Get a specific campaign

getCampaign(campaignId, callback)

Create a campaign

Create an asset update campaign by providing a name, a list of configurations or a sotfware version, a list of assets, and / or a list of asset groups. There can be one or more configurations, and there must be at least when valid asset (either alone or in an asset group).

createCampaignToUpdateConfig(configIds, options, callback)
createCampaignToUpdateSoftware(newVersion, options, callback)

Edit a campaign

Modify an assets name, provide a new list of assets or change configurations. You can not modify a campaign that has already been sent.

updateCampaign(campaignId, options, callback)

Launch a campaign

Launch a campaign targeting all assets both compatible and not already being updated in another campaign.

launchCampaign(campaignId, options, callback)

TODO

General

• manage pagination
• add validations
• improve docs

API

• Driver profiles
• Remote files
• Vehicles
• Versions

Test

npm test

Coverage

npm run-script test-travis

License

MIT license