Onepanel.AutoCleaningApi

All URIs are relative to https://localhost/api/v3/onepanel

Method	HTTP request	Description
cancelAutoCleaning	POST /provider/spaces/{id}/auto-cleaning/cancel	Cancel space auto-cleaning
configureSpaceAutoCleaning	PATCH /provider/spaces/{id}/auto-cleaning/configuration	Configure space auto-cleaning mechanism
getProviderSpaceAutoCleaningReport	GET /provider/spaces/{id}/auto-cleaning/reports/{report_id}	Get the report from a space auto-cleaning run
getProviderSpaceAutoCleaningReports	GET /provider/spaces/{id}/auto-cleaning/reports	Get Ids of of the space auto-cleaning reports
getProviderSpaceAutoCleaningStatus	GET /provider/spaces/{id}/auto-cleaning/status	Get status of space auto-cleaning mechanism
getSpaceAutoCleaningConfiguration	GET /provider/spaces/{id}/auto-cleaning/configuration	Get space auto-cleaning configuration
triggerAutoCleaning	POST /provider/spaces/{id}/auto-cleaning/start	Trigger space auto-cleaning

cancelAutoCleaning

cancelAutoCleaning(id)

Cancel space auto-cleaning

Cancel current run of auto-cleaning mechanism for given space.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.AutoCleaningApi();

var id = "id_example"; // String | The Id of a space.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.cancelAutoCleaning(id, callback);

Parameters

Name	Type	Description	Notes
id	String	The Id of a space.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: application/json
Accept: Not defined

configureSpaceAutoCleaning

configureSpaceAutoCleaning(id, spaceAutoCleaningConfiguration)

Configure space auto-cleaning mechanism

Configures space auto-cleaning mechanism in the space.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.AutoCleaningApi();

var id = "id_example"; // String | The Id of a space.

var spaceAutoCleaningConfiguration = new Onepanel.SpaceAutoCleaningConfiguration(); // SpaceAutoCleaningConfiguration | New configuration of space auto-cleaning mechanism. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.configureSpaceAutoCleaning(id, spaceAutoCleaningConfiguration, callback);

Parameters

Name	Type	Description	Notes
id	String	The Id of a space.
spaceAutoCleaningConfiguration	SpaceAutoCleaningConfiguration	New configuration of space auto-cleaning mechanism.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

getProviderSpaceAutoCleaningReport

SpaceAutoCleaningReport getProviderSpaceAutoCleaningReport(id, reportId)

Get the report from a space auto-cleaning run

Returns the details of a specific auto-cleaning run.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.AutoCleaningApi();

var id = "id_example"; // String | The Id of a space.

var reportId = "reportId_example"; // String | The Id of an auto-cleaning report.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getProviderSpaceAutoCleaningReport(id, reportId, callback);

Parameters

Name	Type	Description	Notes
id	String	The Id of a space.
reportId	String	The Id of an auto-cleaning report.

Return type

SpaceAutoCleaningReport

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

getProviderSpaceAutoCleaningReports

SpaceAutoCleaningReports getProviderSpaceAutoCleaningReports(id, opts)

Get Ids of of the space auto-cleaning reports

Returns the list of Ids of space auto-cleaning reports. The list is sorted descending by start time of an auto-cleaning run (the newest report is first).

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.AutoCleaningApi();

var id = "id_example"; // String | The Id of a space.

var opts = { 
  'offset': 0, // Number | Allows to skip N first report Ids.
  'limit': 56, // Number | Allows to limit the number of returned report Ids up to N last reports. By default, all report Ids will be returned. 
  'index': "index_example" // String | Allows to list the report Ids starting from the specific report. 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getProviderSpaceAutoCleaningReports(id, opts, callback);

Parameters

Name	Type	Description	Notes
id	String	The Id of a space.
offset	Number	Allows to skip N first report Ids.	[optional] [default to 0]
limit	Number	Allows to limit the number of returned report Ids up to N last reports. By default, all report Ids will be returned.	[optional]
index	String	Allows to list the report Ids starting from the specific report.	[optional]

Return type

SpaceAutoCleaningReports

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

getProviderSpaceAutoCleaningStatus

SpaceAutoCleaningStatus getProviderSpaceAutoCleaningStatus(id)

Get status of space auto-cleaning mechanism

Returns status of current process of auto-cleaning for the space.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.AutoCleaningApi();

var id = "id_example"; // String | The Id of a space.


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

Parameters

Name	Type	Description	Notes
id	String	The Id of a space.

Return type

SpaceAutoCleaningStatus

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

getSpaceAutoCleaningConfiguration

SpaceAutoCleaningConfiguration getSpaceAutoCleaningConfiguration(id)

Get space auto-cleaning configuration

Returns configuration of auto-cleaning mechanism in the space specified by space Id in the path.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.AutoCleaningApi();

var id = "id_example"; // String | The Id of a space of which auto-cleaning configuration should be returned.


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

Parameters

Name	Type	Description	Notes
id	String	The Id of a space of which auto-cleaning configuration should be returned.

Return type

SpaceAutoCleaningConfiguration

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

triggerAutoCleaning

InlineResponse202 triggerAutoCleaning(id)

Trigger space auto-cleaning

Trigger one run of auto-cleaning mechanism for given space.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.AutoCleaningApi();

var id = "id_example"; // String | The Id of a space.


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

Parameters

Name	Type	Description	Notes
id	String	The Id of a space.

Return type

InlineResponse202

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: application/json
Accept: Not defined

Files

AutoCleaningApi.md

Latest commit

History

AutoCleaningApi.md

File metadata and controls

Onepanel.AutoCleaningApi

cancelAutoCleaning

Example

Parameters

Return type

Authorization

HTTP request headers

configureSpaceAutoCleaning

Example

Parameters

Return type

Authorization

HTTP request headers

getProviderSpaceAutoCleaningReport

Example

Parameters

Return type

Authorization

HTTP request headers

getProviderSpaceAutoCleaningReports

Example

Parameters

Return type

Authorization

HTTP request headers

getProviderSpaceAutoCleaningStatus

Example

Parameters

Return type

Authorization

HTTP request headers

getSpaceAutoCleaningConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

triggerAutoCleaning

Example

Parameters

Return type

Authorization

HTTP request headers