Skip to content

DevicesApi.md

Latest commit

 

History

History
executable file
·
427 lines (286 loc) · 10.3 KB

DevicesApi.md

File metadata and controls

executable file
·
427 lines (286 loc) · 10.3 KB

ArtikCloud.DevicesApi

All URIs are relative to https://api.artik.cloud/v1.1

Method HTTP request Description
addDevice POST /devices Add Device
deleteDevice DELETE /devices/{deviceId} Delete Device
deleteDeviceToken DELETE /devices/{deviceId}/tokens Delete Device Token
getDevice GET /devices/{deviceId} Get Device
getDevicePresence GET /devices/{deviceId}/presence Get device presence information
getDeviceToken GET /devices/{deviceId}/tokens Get Device Token
updateDevice PUT /devices/{deviceId} Update Device
updateDeviceToken PUT /devices/{deviceId}/tokens Update Device Token

addDevice

DeviceEnvelope addDevice(device)

Add Device

Create a device

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.DevicesApi()

var device = new ArtikCloud.Device(); // {Device} Device to be added to the user


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDevice(device, callback);

Parameters

Name Type Description Notes
device Device Device to be added to the user

Return type

DeviceEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: application/json
  • Accept: application/json

deleteDevice

DeviceEnvelope deleteDevice(deviceId)

Delete Device

Deletes a device

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.DevicesApi()

var deviceId = "deviceId_example"; // {String} deviceId


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDevice(deviceId, callback);

Parameters

Name Type Description Notes
deviceId String deviceId

Return type

DeviceEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

deleteDeviceToken

DeviceTokenEnvelope deleteDeviceToken(deviceId)

Delete Device Token

Deletes a device's token

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.DevicesApi()

var deviceId = "deviceId_example"; // {String} deviceId


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDeviceToken(deviceId, callback);

Parameters

Name Type Description Notes
deviceId String deviceId

Return type

DeviceTokenEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

getDevice

DeviceEnvelope getDevice(deviceId)

Get Device

Retrieves a device

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.DevicesApi()

var deviceId = "deviceId_example"; // {String} deviceId


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDevice(deviceId, callback);

Parameters

Name Type Description Notes
deviceId String deviceId

Return type

DeviceEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

getDevicePresence

PresenceEnvelope getDevicePresence(deviceId)

Get device presence information

Return the presence status of the given device along with the time it was last seen

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.DevicesApi()

var deviceId = "deviceId_example"; // {String} Device ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDevicePresence(deviceId, callback);

Parameters

Name Type Description Notes
deviceId String Device ID.

Return type

PresenceEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

getDeviceToken

DeviceTokenEnvelope getDeviceToken(deviceId)

Get Device Token

Retrieves a device's token

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.DevicesApi()

var deviceId = "deviceId_example"; // {String} deviceId


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeviceToken(deviceId, callback);

Parameters

Name Type Description Notes
deviceId String deviceId

Return type

DeviceTokenEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

updateDevice

DeviceEnvelope updateDevice(deviceId, device)

Update Device

Updates a device

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.DevicesApi()

var deviceId = "deviceId_example"; // {String} deviceId

var device = new ArtikCloud.Device(); // {Device} Device to be updated


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDevice(deviceId, device, callback);

Parameters

Name Type Description Notes
deviceId String deviceId
device Device Device to be updated

Return type

DeviceEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: application/json
  • Accept: application/json

updateDeviceToken

DeviceTokenEnvelope updateDeviceToken(deviceId)

Update Device Token

Updates a device's token

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.DevicesApi()

var deviceId = "deviceId_example"; // {String} deviceId


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDeviceToken(deviceId, callback);

Parameters

Name Type Description Notes
deviceId String deviceId

Return type

DeviceTokenEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: text/plain
  • Accept: application/json