traccar-api
Version:
traccar-api-client
800 lines (799 loc) • 45.4 kB
JavaScript
"use strict";
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.CommandsApi = exports.CommandsApiFactory = exports.CommandsApiFp = exports.CommandsApiAxiosParamCreator = void 0;
/* tslint:disable */
/* eslint-disable */
/**
* Traccar
* Traccar GPS tracking server API documentation. To use the API you need to have a server instance. For testing purposes you can use one of free [demo servers](https://www.traccar.org/demo-server/). For production use you can install your own server or get a [subscription service](https://www.traccar.org/product/tracking-server/).
*
* OpenAPI spec version: 4.11
* Contact: support@traccar.org
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
var axios_1 = require("axios");
// Some imports not used depending on template conditions
// @ts-ignore
var base_1 = require("../base");
/**
* CommandsApi - axios parameter creator
* @export
*/
exports.CommandsApiAxiosParamCreator = function (configuration) {
var _this = this;
return {
/**
* Without params, it returns a list of Saved Commands the user has access to
* @summary Fetch a list of Saved Commands
* @param {boolean} [all] Can only be used by admins or managers to fetch all entities
* @param {number} [userId] Standard users can use this only with their own _userId_
* @param {number} [deviceId] Standard users can use this only with _deviceId_s, they have access to
* @param {number} [groupId] Standard users can use this only with _groupId_s, they have access to
* @param {boolean} [refresh]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsGet: function (all, userId, deviceId, groupId, refresh, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions;
return __generator(this, function (_a) {
localVarPath = "/commands";
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
if (all !== undefined) {
localVarQueryParameter['all'] = all;
}
if (userId !== undefined) {
localVarQueryParameter['userId'] = userId;
}
if (deviceId !== undefined) {
localVarQueryParameter['deviceId'] = deviceId;
}
if (groupId !== undefined) {
localVarQueryParameter['groupId'] = groupId;
}
if (refresh !== undefined) {
localVarQueryParameter['refresh'] = refresh;
}
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.query) {
query.set(key, options.query[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
*
* @summary Delete a Saved Command
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsIdDelete: function (id, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions;
return __generator(this, function (_a) {
// verify required parameter 'id' is not null or undefined
if (id === null || id === undefined) {
throw new base_1.RequiredError('id', 'Required parameter id was null or undefined when calling commandsIdDelete.');
}
localVarPath = "/commands/{id}"
.replace("{" + "id" + "}", encodeURIComponent(String(id)));
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.query) {
query.set(key, options.query[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
*
* @summary Update a Saved Command
* @param {Command} body
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsIdPut: function (body, id, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions, needsSerialization;
return __generator(this, function (_a) {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new base_1.RequiredError('body', 'Required parameter body was null or undefined when calling commandsIdPut.');
}
// verify required parameter 'id' is not null or undefined
if (id === null || id === undefined) {
throw new base_1.RequiredError('id', 'Required parameter id was null or undefined when calling commandsIdPut.');
}
localVarPath = "/commands/{id}"
.replace("{" + "id" + "}", encodeURIComponent(String(id)));
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
localVarHeaderParameter['Content-Type'] = 'application/json';
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.query) {
query.set(key, options.query[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
*
* @summary Create a Saved Command
* @param {Command} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsPost: function (body, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions, needsSerialization;
return __generator(this, function (_a) {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new base_1.RequiredError('body', 'Required parameter body was null or undefined when calling commandsPost.');
}
localVarPath = "/commands";
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
localVarHeaderParameter['Content-Type'] = 'application/json';
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.query) {
query.set(key, options.query[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
* Return a list of saved commands linked to Device and its groups, filtered by current Device protocol support
* @summary Fetch a list of Saved Commands supported by Device at the moment
* @param {number} [deviceId] Standard users can use this only with _deviceId_s, they have access to
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsSendGet: function (deviceId, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions;
return __generator(this, function (_a) {
localVarPath = "/commands/send";
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
if (deviceId !== undefined) {
localVarQueryParameter['deviceId'] = deviceId;
}
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.query) {
query.set(key, options.query[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
* Dispatch a new command or Saved Command if _body.id_ set
* @summary Dispatch commands to device
* @param {Command} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsSendPost: function (body, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions, needsSerialization;
return __generator(this, function (_a) {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new base_1.RequiredError('body', 'Required parameter body was null or undefined when calling commandsSendPost.');
}
localVarPath = "/commands/send";
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
localVarHeaderParameter['Content-Type'] = 'application/json';
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.query) {
query.set(key, options.query[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
*
* @summary Fetch a list of available Commands for the Device or all possible Commands if Device ommited
* @param {number} [deviceId] Internal device identifier. Only works if device has already reported some locations
* @param {string} [protocol] Protocol name. Can be used instead of device id
* @param {boolean} [textChannel] When `true` return SMS commands. If not specified or `false` return data commands
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsTypesGet: function (deviceId, protocol, textChannel, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions;
return __generator(this, function (_a) {
localVarPath = "/commands/types";
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
if (deviceId !== undefined) {
localVarQueryParameter['deviceId'] = deviceId;
}
if (protocol !== undefined) {
localVarQueryParameter['protocol'] = protocol;
}
if (textChannel !== undefined) {
localVarQueryParameter['textChannel'] = textChannel;
}
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.query) {
query.set(key, options.query[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
};
};
/**
* CommandsApi - functional programming interface
* @export
*/
exports.CommandsApiFp = function (configuration) {
return {
/**
* Without params, it returns a list of Saved Commands the user has access to
* @summary Fetch a list of Saved Commands
* @param {boolean} [all] Can only be used by admins or managers to fetch all entities
* @param {number} [userId] Standard users can use this only with their own _userId_
* @param {number} [deviceId] Standard users can use this only with _deviceId_s, they have access to
* @param {number} [groupId] Standard users can use this only with _groupId_s, they have access to
* @param {boolean} [refresh]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsGet: function (all, userId, deviceId, groupId, refresh, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, exports.CommandsApiAxiosParamCreator(configuration).commandsGet(all, userId, deviceId, groupId, refresh, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
/**
*
* @summary Delete a Saved Command
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsIdDelete: function (id, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, exports.CommandsApiAxiosParamCreator(configuration).commandsIdDelete(id, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
/**
*
* @summary Update a Saved Command
* @param {Command} body
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsIdPut: function (body, id, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, exports.CommandsApiAxiosParamCreator(configuration).commandsIdPut(body, id, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
/**
*
* @summary Create a Saved Command
* @param {Command} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsPost: function (body, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, exports.CommandsApiAxiosParamCreator(configuration).commandsPost(body, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
/**
* Return a list of saved commands linked to Device and its groups, filtered by current Device protocol support
* @summary Fetch a list of Saved Commands supported by Device at the moment
* @param {number} [deviceId] Standard users can use this only with _deviceId_s, they have access to
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsSendGet: function (deviceId, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, exports.CommandsApiAxiosParamCreator(configuration).commandsSendGet(deviceId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
/**
* Dispatch a new command or Saved Command if _body.id_ set
* @summary Dispatch commands to device
* @param {Command} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsSendPost: function (body, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, exports.CommandsApiAxiosParamCreator(configuration).commandsSendPost(body, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
/**
*
* @summary Fetch a list of available Commands for the Device or all possible Commands if Device ommited
* @param {number} [deviceId] Internal device identifier. Only works if device has already reported some locations
* @param {string} [protocol] Protocol name. Can be used instead of device id
* @param {boolean} [textChannel] When `true` return SMS commands. If not specified or `false` return data commands
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsTypesGet: function (deviceId, protocol, textChannel, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, exports.CommandsApiAxiosParamCreator(configuration).commandsTypesGet(deviceId, protocol, textChannel, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
};
};
/**
* CommandsApi - factory interface
* @export
*/
exports.CommandsApiFactory = function (configuration, basePath, axios) {
return {
/**
* Without params, it returns a list of Saved Commands the user has access to
* @summary Fetch a list of Saved Commands
* @param {boolean} [all] Can only be used by admins or managers to fetch all entities
* @param {number} [userId] Standard users can use this only with their own _userId_
* @param {number} [deviceId] Standard users can use this only with _deviceId_s, they have access to
* @param {number} [groupId] Standard users can use this only with _groupId_s, they have access to
* @param {boolean} [refresh]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsGet: function (all, userId, deviceId, groupId, refresh, options) {
return exports.CommandsApiFp(configuration).commandsGet(all, userId, deviceId, groupId, refresh, options).then(function (request) { return request(axios, basePath); });
},
/**
*
* @summary Delete a Saved Command
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsIdDelete: function (id, options) {
return exports.CommandsApiFp(configuration).commandsIdDelete(id, options).then(function (request) { return request(axios, basePath); });
},
/**
*
* @summary Update a Saved Command
* @param {Command} body
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsIdPut: function (body, id, options) {
return exports.CommandsApiFp(configuration).commandsIdPut(body, id, options).then(function (request) { return request(axios, basePath); });
},
/**
*
* @summary Create a Saved Command
* @param {Command} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsPost: function (body, options) {
return exports.CommandsApiFp(configuration).commandsPost(body, options).then(function (request) { return request(axios, basePath); });
},
/**
* Return a list of saved commands linked to Device and its groups, filtered by current Device protocol support
* @summary Fetch a list of Saved Commands supported by Device at the moment
* @param {number} [deviceId] Standard users can use this only with _deviceId_s, they have access to
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsSendGet: function (deviceId, options) {
return exports.CommandsApiFp(configuration).commandsSendGet(deviceId, options).then(function (request) { return request(axios, basePath); });
},
/**
* Dispatch a new command or Saved Command if _body.id_ set
* @summary Dispatch commands to device
* @param {Command} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsSendPost: function (body, options) {
return exports.CommandsApiFp(configuration).commandsSendPost(body, options).then(function (request) { return request(axios, basePath); });
},
/**
*
* @summary Fetch a list of available Commands for the Device or all possible Commands if Device ommited
* @param {number} [deviceId] Internal device identifier. Only works if device has already reported some locations
* @param {string} [protocol] Protocol name. Can be used instead of device id
* @param {boolean} [textChannel] When `true` return SMS commands. If not specified or `false` return data commands
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
commandsTypesGet: function (deviceId, protocol, textChannel, options) {
return exports.CommandsApiFp(configuration).commandsTypesGet(deviceId, protocol, textChannel, options).then(function (request) { return request(axios, basePath); });
},
};
};
/**
* CommandsApi - object-oriented interface
* @export
* @class CommandsApi
* @extends {BaseAPI}
*/
var CommandsApi = /** @class */ (function (_super) {
__extends(CommandsApi, _super);
function CommandsApi() {
return _super !== null && _super.apply(this, arguments) || this;
}
/**
* Without params, it returns a list of Saved Commands the user has access to
* @summary Fetch a list of Saved Commands
* @param {boolean} [all] Can only be used by admins or managers to fetch all entities
* @param {number} [userId] Standard users can use this only with their own _userId_
* @param {number} [deviceId] Standard users can use this only with _deviceId_s, they have access to
* @param {number} [groupId] Standard users can use this only with _groupId_s, they have access to
* @param {boolean} [refresh]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CommandsApi
*/
CommandsApi.prototype.commandsGet = function (all, userId, deviceId, groupId, refresh, options) {
var _this = this;
return exports.CommandsApiFp(this.configuration).commandsGet(all, userId, deviceId, groupId, refresh, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
*
* @summary Delete a Saved Command
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CommandsApi
*/
CommandsApi.prototype.commandsIdDelete = function (id, options) {
var _this = this;
return exports.CommandsApiFp(this.configuration).commandsIdDelete(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
*
* @summary Update a Saved Command
* @param {Command} body
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CommandsApi
*/
CommandsApi.prototype.commandsIdPut = function (body, id, options) {
var _this = this;
return exports.CommandsApiFp(this.configuration).commandsIdPut(body, id, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
*
* @summary Create a Saved Command
* @param {Command} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CommandsApi
*/
CommandsApi.prototype.commandsPost = function (body, options) {
var _this = this;
return exports.CommandsApiFp(this.configuration).commandsPost(body, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Return a list of saved commands linked to Device and its groups, filtered by current Device protocol support
* @summary Fetch a list of Saved Commands supported by Device at the moment
* @param {number} [deviceId] Standard users can use this only with _deviceId_s, they have access to
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CommandsApi
*/
CommandsApi.prototype.commandsSendGet = function (deviceId, options) {
var _this = this;
return exports.CommandsApiFp(this.configuration).commandsSendGet(deviceId, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Dispatch a new command or Saved Command if _body.id_ set
* @summary Dispatch commands to device
* @param {Command} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CommandsApi
*/
CommandsApi.prototype.commandsSendPost = function (body, options) {
var _this = this;
return exports.CommandsApiFp(this.configuration).commandsSendPost(body, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
*
* @summary Fetch a list of available Commands for the Device or all possible Commands if Device ommited
* @param {number} [deviceId] Internal device identifier. Only works if device has already reported some locations
* @param {string} [protocol] Protocol name. Can be used instead of device id
* @param {boolean} [textChannel] When `true` return SMS commands. If not specified or `false` return data commands
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CommandsApi
*/
CommandsApi.prototype.commandsTypesGet = function (deviceId, protocol, textChannel, options) {
var _this = this;
return exports.CommandsApiFp(this.configuration).commandsTypesGet(deviceId, protocol, textChannel, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
return CommandsApi;
}(base_1.BaseAPI));
exports.CommandsApi = CommandsApi;