@edgeiq/edgeiq-api-js 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (148) hide show
  1. package/README.md +74 -0
  2. package/dist/__tests__/auth.test.d.ts +1 -0
  3. package/dist/__tests__/auth.test.js +110 -0
  4. package/dist/__tests__/companies.test.d.ts +1 -0
  5. package/dist/__tests__/companies.test.js +196 -0
  6. package/dist/__tests__/deviceTypes.test.d.ts +1 -0
  7. package/dist/__tests__/deviceTypes.test.js +172 -0
  8. package/dist/__tests__/devices.test.d.ts +1 -0
  9. package/dist/__tests__/devices.test.js +204 -0
  10. package/dist/__tests__/ingestors.test.d.ts +1 -0
  11. package/dist/__tests__/ingestors.test.js +172 -0
  12. package/dist/__tests__/integrations.test.d.ts +1 -0
  13. package/dist/__tests__/integrations.test.js +192 -0
  14. package/dist/__tests__/pollableAttributes.test.d.ts +1 -0
  15. package/dist/__tests__/pollableAttributes.test.js +172 -0
  16. package/dist/__tests__/rules.test.d.ts +1 -0
  17. package/dist/__tests__/rules.test.js +172 -0
  18. package/dist/__tests__/testConstants.d.ts +7 -0
  19. package/dist/__tests__/testConstants.js +14 -0
  20. package/dist/__tests__/translators.test.d.ts +1 -0
  21. package/dist/__tests__/translators.test.js +172 -0
  22. package/dist/__tests__/users.test.d.ts +1 -0
  23. package/dist/__tests__/users.test.js +208 -0
  24. package/dist/auth/index.d.ts +6 -0
  25. package/dist/auth/index.js +95 -0
  26. package/dist/bulkResponses/index.d.ts +8 -0
  27. package/dist/bulkResponses/index.js +124 -0
  28. package/dist/bulkResponses/models.d.ts +43 -0
  29. package/dist/bulkResponses/models.js +2 -0
  30. package/dist/commands/index.d.ts +9 -0
  31. package/dist/commands/index.js +224 -0
  32. package/dist/commands/models.d.ts +28 -0
  33. package/dist/commands/models.js +2 -0
  34. package/dist/companies/index.d.ts +7 -0
  35. package/dist/companies/index.js +198 -0
  36. package/dist/companies/models.d.ts +94 -0
  37. package/dist/companies/models.js +2 -0
  38. package/dist/constants.d.ts +122 -0
  39. package/dist/constants.js +138 -0
  40. package/dist/core/ModelClass.d.ts +13 -0
  41. package/dist/core/ModelClass.js +19 -0
  42. package/dist/core/handleResponseError.d.ts +2 -0
  43. package/dist/core/handleResponseError.js +162 -0
  44. package/dist/core/index.d.ts +19 -0
  45. package/dist/core/index.js +63 -0
  46. package/dist/deviceConfigs/index.d.ts +9 -0
  47. package/dist/deviceConfigs/index.js +224 -0
  48. package/dist/deviceConfigs/models.d.ts +38 -0
  49. package/dist/deviceConfigs/models.js +2 -0
  50. package/dist/deviceLocationObservations/index.d.ts +5 -0
  51. package/dist/deviceLocationObservations/index.js +189 -0
  52. package/dist/deviceLocationObservations/models.d.ts +26 -0
  53. package/dist/deviceLocationObservations/models.js +2 -0
  54. package/dist/deviceTemplates/index.d.ts +9 -0
  55. package/dist/deviceTemplates/index.js +226 -0
  56. package/dist/deviceTemplates/models.d.ts +36 -0
  57. package/dist/deviceTemplates/models.js +2 -0
  58. package/dist/deviceTransferRequests/index.d.ts +7 -0
  59. package/dist/deviceTransferRequests/index.js +198 -0
  60. package/dist/deviceTransferRequests/models.d.ts +26 -0
  61. package/dist/deviceTransferRequests/models.js +2 -0
  62. package/dist/deviceTypes/index.d.ts +19 -0
  63. package/dist/deviceTypes/index.js +440 -0
  64. package/dist/deviceTypes/models.d.ts +104 -0
  65. package/dist/deviceTypes/models.js +2 -0
  66. package/dist/devices/index.d.ts +18 -0
  67. package/dist/devices/index.js +431 -0
  68. package/dist/devices/models.d.ts +113 -0
  69. package/dist/devices/models.js +2 -0
  70. package/dist/downstreamSystems/index.d.ts +7 -0
  71. package/dist/downstreamSystems/index.js +198 -0
  72. package/dist/downstreamSystems/models.d.ts +17 -0
  73. package/dist/downstreamSystems/models.js +2 -0
  74. package/dist/escrowDevices/index.d.ts +9 -0
  75. package/dist/escrowDevices/index.js +224 -0
  76. package/dist/escrowDevices/models.d.ts +20 -0
  77. package/dist/escrowDevices/models.js +2 -0
  78. package/dist/example/index.d.ts +1 -0
  79. package/dist/example/index.js +5 -0
  80. package/dist/filtersParser.d.ts +5 -0
  81. package/dist/filtersParser.js +43 -0
  82. package/dist/gatewayCommands/index.d.ts +10 -0
  83. package/dist/gatewayCommands/index.js +261 -0
  84. package/dist/gatewayCommands/models.d.ts +41 -0
  85. package/dist/gatewayCommands/models.js +2 -0
  86. package/dist/helpers.d.ts +3 -0
  87. package/dist/helpers.js +11 -0
  88. package/dist/index.d.ts +52 -0
  89. package/dist/index.js +92 -0
  90. package/dist/ingestors/index.d.ts +9 -0
  91. package/dist/ingestors/index.js +224 -0
  92. package/dist/ingestors/models.d.ts +37 -0
  93. package/dist/ingestors/models.js +2 -0
  94. package/dist/integrations/index.d.ts +9 -0
  95. package/dist/integrations/index.js +306 -0
  96. package/dist/integrations/models.d.ts +61 -0
  97. package/dist/integrations/models.js +2 -0
  98. package/dist/models/index.d.ts +1893 -0
  99. package/dist/models/index.js +2 -0
  100. package/dist/models.d.ts +66 -0
  101. package/dist/models.js +2 -0
  102. package/dist/pollableAttributes/index.d.ts +7 -0
  103. package/dist/pollableAttributes/index.js +198 -0
  104. package/dist/pollableAttributes/models.d.ts +28 -0
  105. package/dist/pollableAttributes/models.js +2 -0
  106. package/dist/regions/index.d.ts +5 -0
  107. package/dist/regions/index.js +173 -0
  108. package/dist/regions/models.d.ts +17 -0
  109. package/dist/regions/models.js +2 -0
  110. package/dist/reports/index.d.ts +8 -0
  111. package/dist/reports/index.js +199 -0
  112. package/dist/reports/models.d.ts +25 -0
  113. package/dist/reports/models.js +2 -0
  114. package/dist/rules/index.d.ts +9 -0
  115. package/dist/rules/index.js +224 -0
  116. package/dist/rules/models.d.ts +108 -0
  117. package/dist/rules/models.js +2 -0
  118. package/dist/secrets/index.d.ts +5 -0
  119. package/dist/secrets/index.js +173 -0
  120. package/dist/secrets/models.d.ts +16 -0
  121. package/dist/secrets/models.js +2 -0
  122. package/dist/softwareUpdates/index.d.ts +9 -0
  123. package/dist/softwareUpdates/index.js +224 -0
  124. package/dist/softwareUpdates/models.d.ts +22 -0
  125. package/dist/softwareUpdates/models.js +2 -0
  126. package/dist/systemCommandJobs/index.d.ts +5 -0
  127. package/dist/systemCommandJobs/index.js +173 -0
  128. package/dist/systemCommandJobs/models.d.ts +32 -0
  129. package/dist/systemCommandJobs/models.js +2 -0
  130. package/dist/systemCommands/index.d.ts +7 -0
  131. package/dist/systemCommands/index.js +198 -0
  132. package/dist/systemCommands/models.d.ts +32 -0
  133. package/dist/systemCommands/models.js +2 -0
  134. package/dist/testConstants.d.ts +42 -0
  135. package/dist/testConstants.js +214 -0
  136. package/dist/translators/index.d.ts +9 -0
  137. package/dist/translators/index.js +224 -0
  138. package/dist/translators/models.d.ts +21 -0
  139. package/dist/translators/models.js +2 -0
  140. package/dist/userTypes/index.d.ts +7 -0
  141. package/dist/userTypes/index.js +198 -0
  142. package/dist/userTypes/models.d.ts +79 -0
  143. package/dist/userTypes/models.js +2 -0
  144. package/dist/users/index.d.ts +10 -0
  145. package/dist/users/index.js +252 -0
  146. package/dist/users/models.d.ts +41 -0
  147. package/dist/users/models.js +2 -0
  148. package/package.json +56 -0
@@ -0,0 +1,199 @@
1
+ "use strict";
2
+ var __extends = (this && this.__extends) || (function () {
3
+ var extendStatics = function (d, b) {
4
+ extendStatics = Object.setPrototypeOf ||
5
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
6
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
7
+ return extendStatics(d, b);
8
+ };
9
+ return function (d, b) {
10
+ if (typeof b !== "function" && b !== null)
11
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
12
+ extendStatics(d, b);
13
+ function __() { this.constructor = d; }
14
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
15
+ };
16
+ })();
17
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
18
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
19
+ return new (P || (P = Promise))(function (resolve, reject) {
20
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
21
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
22
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
23
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
24
+ });
25
+ };
26
+ var __generator = (this && this.__generator) || function (thisArg, body) {
27
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
28
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
29
+ function verb(n) { return function (v) { return step([n, v]); }; }
30
+ function step(op) {
31
+ if (f) throw new TypeError("Generator is already executing.");
32
+ while (_) try {
33
+ 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;
34
+ if (y = 0, t) op = [op[0] & 2, t.value];
35
+ switch (op[0]) {
36
+ case 0: case 1: t = op; break;
37
+ case 4: _.label++; return { value: op[1], done: false };
38
+ case 5: _.label++; y = op[1]; op = [0]; continue;
39
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
40
+ default:
41
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
42
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
43
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
44
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
45
+ if (t[2]) _.ops.pop();
46
+ _.trys.pop(); continue;
47
+ }
48
+ op = body.call(thisArg, _);
49
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
50
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
51
+ }
52
+ };
53
+ Object.defineProperty(exports, "__esModule", { value: true });
54
+ exports.Reports = void 0;
55
+ var __1 = require("..");
56
+ var constants_1 = require("../constants");
57
+ var ModelClass_1 = require("../core/ModelClass");
58
+ var filtersParser_1 = require("../filtersParser");
59
+ var helpers_1 = require("../helpers");
60
+ exports.Reports = (function (_super) {
61
+ __extends(class_1, _super);
62
+ function class_1() {
63
+ return _super !== null && _super.apply(this, arguments) || this;
64
+ }
65
+ class_1.create = function (report) {
66
+ return __awaiter(this, void 0, void 0, function () {
67
+ var axios, data, result, error_1;
68
+ return __generator(this, function (_a) {
69
+ switch (_a.label) {
70
+ case 0:
71
+ _a.trys.push([0, 2, , 3]);
72
+ this.logAction("Creating report for device with id " + report.device_id);
73
+ axios = __1.EdgeIQAPI.getAxios();
74
+ data = JSON.stringify(report);
75
+ return [4, axios.post(constants_1.Endpoints.report, data)];
76
+ case 1:
77
+ result = _a.sent();
78
+ return [2, result === null || result === void 0 ? void 0 : result.data];
79
+ case 2:
80
+ error_1 = _a.sent();
81
+ if ((0, helpers_1.isApiError)(error_1)) {
82
+ throw error_1;
83
+ }
84
+ throw error_1;
85
+ case 3: return [2];
86
+ }
87
+ });
88
+ });
89
+ };
90
+ class_1.list = function (filters, pagination) {
91
+ var _a, _b, _c, _d;
92
+ return __awaiter(this, void 0, void 0, function () {
93
+ var axios, result, error_2;
94
+ return __generator(this, function (_e) {
95
+ switch (_e.label) {
96
+ case 0:
97
+ _e.trys.push([0, 2, , 3]);
98
+ this.logAction("Listing reports with following filters: " + (filters !== null && filters !== void 0 ? filters : '{}') + ".\n And pagination " + (pagination !== null && pagination !== void 0 ? pagination : '{}'));
99
+ axios = __1.EdgeIQAPI.getAxios();
100
+ return [4, axios.get(constants_1.Endpoints.report, {
101
+ params: (0, filtersParser_1.parseFilters)(filters, pagination),
102
+ })];
103
+ case 1:
104
+ result = _e.sent();
105
+ return [2, {
106
+ reports: (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.resources,
107
+ pagination: {
108
+ page: (_b = result === null || result === void 0 ? void 0 : result.data) === null || _b === void 0 ? void 0 : _b.page,
109
+ itemsPerPage: (_c = result === null || result === void 0 ? void 0 : result.data) === null || _c === void 0 ? void 0 : _c.per_page,
110
+ total: (_d = result === null || result === void 0 ? void 0 : result.data) === null || _d === void 0 ? void 0 : _d.total,
111
+ },
112
+ }];
113
+ case 2:
114
+ error_2 = _e.sent();
115
+ if ((0, helpers_1.isApiError)(error_2)) {
116
+ throw error_2;
117
+ }
118
+ throw error_2;
119
+ case 3: return [2];
120
+ }
121
+ });
122
+ });
123
+ };
124
+ class_1.getOneById = function (id) {
125
+ return __awaiter(this, void 0, void 0, function () {
126
+ var axios, result, error_3;
127
+ return __generator(this, function (_a) {
128
+ switch (_a.label) {
129
+ case 0:
130
+ _a.trys.push([0, 2, , 3]);
131
+ this.logAction("Getting report with id: " + id);
132
+ axios = __1.EdgeIQAPI.getAxios();
133
+ return [4, axios.get(constants_1.Endpoints.report + "/" + id)];
134
+ case 1:
135
+ result = _a.sent();
136
+ return [2, result === null || result === void 0 ? void 0 : result.data];
137
+ case 2:
138
+ error_3 = _a.sent();
139
+ if ((0, helpers_1.isApiError)(error_3)) {
140
+ throw error_3;
141
+ }
142
+ throw error_3;
143
+ case 3: return [2];
144
+ }
145
+ });
146
+ });
147
+ };
148
+ class_1.delete = function (id) {
149
+ return __awaiter(this, void 0, void 0, function () {
150
+ var axios, error_4;
151
+ return __generator(this, function (_a) {
152
+ switch (_a.label) {
153
+ case 0:
154
+ _a.trys.push([0, 2, , 3]);
155
+ this.logAction("Deleting report with id " + id);
156
+ axios = __1.EdgeIQAPI.getAxios();
157
+ return [4, axios.delete(constants_1.Endpoints.report + "/" + id)];
158
+ case 1:
159
+ _a.sent();
160
+ return [2, (0, helpers_1.getReturnDeleteMessage)('report')];
161
+ case 2:
162
+ error_4 = _a.sent();
163
+ if ((0, helpers_1.isApiError)(error_4)) {
164
+ throw error_4;
165
+ }
166
+ throw error_4;
167
+ case 3: return [2];
168
+ }
169
+ });
170
+ });
171
+ };
172
+ class_1.deleteMultiple = function (ids) {
173
+ return __awaiter(this, void 0, void 0, function () {
174
+ var axios, result, error_5;
175
+ return __generator(this, function (_a) {
176
+ switch (_a.label) {
177
+ case 0:
178
+ _a.trys.push([0, 2, , 3]);
179
+ this.logAction("Deleting reports with ids " + ids.join(', '));
180
+ axios = __1.EdgeIQAPI.getAxios();
181
+ return [4, axios.delete(constants_1.Endpoints.report + "/bulk", {
182
+ data: { ids: ids },
183
+ })];
184
+ case 1:
185
+ result = _a.sent();
186
+ return [2, result === null || result === void 0 ? void 0 : result.data];
187
+ case 2:
188
+ error_5 = _a.sent();
189
+ if ((0, helpers_1.isApiError)(error_5)) {
190
+ throw error_5;
191
+ }
192
+ throw error_5;
193
+ case 3: return [2];
194
+ }
195
+ });
196
+ });
197
+ };
198
+ return class_1;
199
+ }(ModelClass_1.BaseModelClass));
@@ -0,0 +1,25 @@
1
+ import { Base, Filter, Filters, Pagination } from '../models';
2
+ export interface ReportInput {
3
+ device_id: string;
4
+ device_name: string;
5
+ device_datetime: string;
6
+ payload: {
7
+ [key: string]: unknown;
8
+ };
9
+ raw_data?: string;
10
+ seq: number;
11
+ heartbeat?: boolean;
12
+ type?: string;
13
+ }
14
+ export interface Report extends ReportInput, Base {
15
+ }
16
+ export interface ReportsFilters extends Filters {
17
+ device_id?: Filter;
18
+ device_name?: Filter;
19
+ device_datetime?: Filter;
20
+ type?: Filter;
21
+ }
22
+ export interface PaginatedReports {
23
+ reports: Report[];
24
+ pagination: Pagination;
25
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ import { BaseModelInterface } from '../core/ModelClass';
2
+ import { BulkActionResponse } from '../models';
3
+ import { Rule, RuleInput, PaginatedRules, RulesFilters } from './models';
4
+ interface RulesInterface extends BaseModelInterface<Rule, RuleInput, RulesFilters, PaginatedRules> {
5
+ update(rule: Rule): Promise<Rule>;
6
+ deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
7
+ }
8
+ export declare const Rules: RulesInterface;
9
+ export {};
@@ -0,0 +1,224 @@
1
+ "use strict";
2
+ var __extends = (this && this.__extends) || (function () {
3
+ var extendStatics = function (d, b) {
4
+ extendStatics = Object.setPrototypeOf ||
5
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
6
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
7
+ return extendStatics(d, b);
8
+ };
9
+ return function (d, b) {
10
+ if (typeof b !== "function" && b !== null)
11
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
12
+ extendStatics(d, b);
13
+ function __() { this.constructor = d; }
14
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
15
+ };
16
+ })();
17
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
18
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
19
+ return new (P || (P = Promise))(function (resolve, reject) {
20
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
21
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
22
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
23
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
24
+ });
25
+ };
26
+ var __generator = (this && this.__generator) || function (thisArg, body) {
27
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
28
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
29
+ function verb(n) { return function (v) { return step([n, v]); }; }
30
+ function step(op) {
31
+ if (f) throw new TypeError("Generator is already executing.");
32
+ while (_) try {
33
+ 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;
34
+ if (y = 0, t) op = [op[0] & 2, t.value];
35
+ switch (op[0]) {
36
+ case 0: case 1: t = op; break;
37
+ case 4: _.label++; return { value: op[1], done: false };
38
+ case 5: _.label++; y = op[1]; op = [0]; continue;
39
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
40
+ default:
41
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
42
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
43
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
44
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
45
+ if (t[2]) _.ops.pop();
46
+ _.trys.pop(); continue;
47
+ }
48
+ op = body.call(thisArg, _);
49
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
50
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
51
+ }
52
+ };
53
+ Object.defineProperty(exports, "__esModule", { value: true });
54
+ exports.Rules = void 0;
55
+ var __1 = require("..");
56
+ var constants_1 = require("../constants");
57
+ var ModelClass_1 = require("../core/ModelClass");
58
+ var filtersParser_1 = require("../filtersParser");
59
+ var helpers_1 = require("../helpers");
60
+ exports.Rules = (function (_super) {
61
+ __extends(class_1, _super);
62
+ function class_1() {
63
+ return _super !== null && _super.apply(this, arguments) || this;
64
+ }
65
+ class_1.create = function (rule) {
66
+ return __awaiter(this, void 0, void 0, function () {
67
+ var axios, data, result, error_1;
68
+ return __generator(this, function (_a) {
69
+ switch (_a.label) {
70
+ case 0:
71
+ _a.trys.push([0, 2, , 3]);
72
+ this.logAction("Creating a rule with description: " + rule.description);
73
+ axios = __1.EdgeIQAPI.getAxios();
74
+ data = JSON.stringify(rule);
75
+ return [4, axios.post(constants_1.Endpoints.rule, data)];
76
+ case 1:
77
+ result = _a.sent();
78
+ return [2, result === null || result === void 0 ? void 0 : result.data];
79
+ case 2:
80
+ error_1 = _a.sent();
81
+ if ((0, helpers_1.isApiError)(error_1)) {
82
+ throw error_1;
83
+ }
84
+ throw error_1;
85
+ case 3: return [2];
86
+ }
87
+ });
88
+ });
89
+ };
90
+ class_1.update = function (rule) {
91
+ return __awaiter(this, void 0, void 0, function () {
92
+ var axios, data, result, error_2;
93
+ return __generator(this, function (_a) {
94
+ switch (_a.label) {
95
+ case 0:
96
+ _a.trys.push([0, 2, , 3]);
97
+ this.logAction("Updating rule with id: " + rule._id);
98
+ axios = __1.EdgeIQAPI.getAxios();
99
+ data = JSON.stringify(rule);
100
+ return [4, axios.put(constants_1.Endpoints.rule + "/" + rule._id, data)];
101
+ case 1:
102
+ result = _a.sent();
103
+ return [2, result === null || result === void 0 ? void 0 : result.data];
104
+ case 2:
105
+ error_2 = _a.sent();
106
+ if ((0, helpers_1.isApiError)(error_2)) {
107
+ throw error_2;
108
+ }
109
+ throw error_2;
110
+ case 3: return [2];
111
+ }
112
+ });
113
+ });
114
+ };
115
+ class_1.list = function (filters, pagination) {
116
+ var _a, _b, _c, _d;
117
+ return __awaiter(this, void 0, void 0, function () {
118
+ var axios, result, error_3;
119
+ return __generator(this, function (_e) {
120
+ switch (_e.label) {
121
+ case 0:
122
+ _e.trys.push([0, 2, , 3]);
123
+ this.logAction("Listing rules with following filters: " + (filters !== null && filters !== void 0 ? filters : '{}') + ".\n And pagination " + (pagination !== null && pagination !== void 0 ? pagination : '{}'));
124
+ axios = __1.EdgeIQAPI.getAxios();
125
+ return [4, axios.get(constants_1.Endpoints.rule, {
126
+ params: (0, filtersParser_1.parseFilters)(filters, pagination),
127
+ })];
128
+ case 1:
129
+ result = _e.sent();
130
+ return [2, {
131
+ rules: (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.resources,
132
+ pagination: {
133
+ page: (_b = result === null || result === void 0 ? void 0 : result.data) === null || _b === void 0 ? void 0 : _b.page,
134
+ itemsPerPage: (_c = result === null || result === void 0 ? void 0 : result.data) === null || _c === void 0 ? void 0 : _c.per_page,
135
+ total: (_d = result === null || result === void 0 ? void 0 : result.data) === null || _d === void 0 ? void 0 : _d.total,
136
+ },
137
+ }];
138
+ case 2:
139
+ error_3 = _e.sent();
140
+ if ((0, helpers_1.isApiError)(error_3)) {
141
+ throw error_3;
142
+ }
143
+ throw error_3;
144
+ case 3: return [2];
145
+ }
146
+ });
147
+ });
148
+ };
149
+ class_1.getOneById = function (id) {
150
+ return __awaiter(this, void 0, void 0, function () {
151
+ var axios, result, error_4;
152
+ return __generator(this, function (_a) {
153
+ switch (_a.label) {
154
+ case 0:
155
+ _a.trys.push([0, 2, , 3]);
156
+ this.logAction("Getting rule with id: " + id);
157
+ axios = __1.EdgeIQAPI.getAxios();
158
+ return [4, axios.get(constants_1.Endpoints.rule + "/" + id)];
159
+ case 1:
160
+ result = _a.sent();
161
+ return [2, result === null || result === void 0 ? void 0 : result.data];
162
+ case 2:
163
+ error_4 = _a.sent();
164
+ if ((0, helpers_1.isApiError)(error_4)) {
165
+ throw error_4;
166
+ }
167
+ throw error_4;
168
+ case 3: return [2];
169
+ }
170
+ });
171
+ });
172
+ };
173
+ class_1.delete = function (id) {
174
+ return __awaiter(this, void 0, void 0, function () {
175
+ var axios, error_5;
176
+ return __generator(this, function (_a) {
177
+ switch (_a.label) {
178
+ case 0:
179
+ _a.trys.push([0, 2, , 3]);
180
+ this.logAction("Deleting rule with id " + id);
181
+ axios = __1.EdgeIQAPI.getAxios();
182
+ return [4, axios.delete(constants_1.Endpoints.rule + "/" + id)];
183
+ case 1:
184
+ _a.sent();
185
+ return [2, (0, helpers_1.getReturnDeleteMessage)('rule')];
186
+ case 2:
187
+ error_5 = _a.sent();
188
+ if ((0, helpers_1.isApiError)(error_5)) {
189
+ throw error_5;
190
+ }
191
+ throw error_5;
192
+ case 3: return [2];
193
+ }
194
+ });
195
+ });
196
+ };
197
+ class_1.deleteMultiple = function (ids) {
198
+ return __awaiter(this, void 0, void 0, function () {
199
+ var axios, result, error_6;
200
+ return __generator(this, function (_a) {
201
+ switch (_a.label) {
202
+ case 0:
203
+ _a.trys.push([0, 2, , 3]);
204
+ this.logAction("Deleting rules with ids " + ids.join(', '));
205
+ axios = __1.EdgeIQAPI.getAxios();
206
+ return [4, axios.delete(constants_1.Endpoints.rule + "/bulk", {
207
+ data: { ids: ids },
208
+ })];
209
+ case 1:
210
+ result = _a.sent();
211
+ return [2, result === null || result === void 0 ? void 0 : result.data];
212
+ case 2:
213
+ error_6 = _a.sent();
214
+ if ((0, helpers_1.isApiError)(error_6)) {
215
+ throw error_6;
216
+ }
217
+ throw error_6;
218
+ case 3: return [2];
219
+ }
220
+ });
221
+ });
222
+ };
223
+ return class_1;
224
+ }(ModelClass_1.BaseModelClass));
@@ -0,0 +1,108 @@
1
+ import { Base, Filter, Filters, Pagination } from '../models';
2
+ export declare type RuleConditionType = 'true' | 'false' | 'equal' | 'not_equal' | 'less_than' | 'less_than_equal' | 'greater_than' | 'greater_than_equal' | 'in' | 'not_in' | 'moving_average' | 'value_changed' | 'device_error' | 'status_changed' | 'heartbeat_status_changed' | 'device_location_transition' | 'and' | 'or';
3
+ export declare type DeviceErrorType = 'system' | 'rule_action' | 'config' | 'aws_iot' | 'aws_greengrass_iot' | 'azure_iot' | 'bluemix_iot';
4
+ export declare type RuleActionType = 'aws_iot' | 'aws_iot_publish' | 'azure_iot' | 'create_device_health_status_event' | 'create_device_location_observation' | 'disable_data_restriction' | 'email' | 'enable_data_restriction' | 'greengrass_restart' | 'http_request' | 'mqtt' | 'notification' | 'relay' | 'sms' | 'tcp' | 'update_device_metadata' | 'workflow';
5
+ export declare type RuleActionBodyType = 'html' | 'text';
6
+ export declare type LocationVia = 'gps' | 'cell_tower' | 'bluetooth' | 'wifi' | 'other';
7
+ export declare type GeneratedAtFormat = 'rfc3339' | 'unix_timestamp';
8
+ export declare type LocationTransitionDirectionType = 'arriving' | 'leaving';
9
+ export interface CredentialData {
10
+ type?: string;
11
+ value: string;
12
+ secret_id: string;
13
+ }
14
+ export interface Credentials {
15
+ type: string;
16
+ data: {
17
+ [key: string]: CredentialData;
18
+ };
19
+ }
20
+ export interface PRTGChannel {
21
+ name?: string;
22
+ value?: string;
23
+ type?: string;
24
+ default?: number;
25
+ enum?: {
26
+ [key: string]: number;
27
+ };
28
+ }
29
+ export interface RuleAction {
30
+ action_frequency?: unknown;
31
+ body_template?: string;
32
+ body_type?: RuleActionBodyType;
33
+ clear?: boolean;
34
+ client_id?: string;
35
+ credentials?: Credentials;
36
+ integration_id?: string;
37
+ last_run?: string;
38
+ password?: string;
39
+ retries?: number;
40
+ retry_timeout: number;
41
+ send_to?: string;
42
+ subject?: string;
43
+ topic?: string;
44
+ type: RuleActionType;
45
+ url?: string;
46
+ username?: string;
47
+ will_topic?: string;
48
+ keep_alive?: boolean;
49
+ method?: string;
50
+ headers?: {
51
+ [key: string]: string;
52
+ };
53
+ from?: string;
54
+ metadata_key?: string;
55
+ health_status?: string;
56
+ latitude_template?: string;
57
+ longitude_template?: string;
58
+ radius_template?: string;
59
+ generated_at_template?: string;
60
+ generated_at_format?: GeneratedAtFormat;
61
+ location_via?: LocationVia;
62
+ channels?: PRTGChannel[];
63
+ definition_id?: string;
64
+ }
65
+ export interface RuleCondition {
66
+ type: RuleConditionType;
67
+ property?: string;
68
+ value?: unknown;
69
+ value_type?: string;
70
+ rule_conditions?: (RuleCondition | undefined)[];
71
+ error_type?: DeviceErrorType;
72
+ location_transition_evaluator?: LocationTransitionEvaluator;
73
+ }
74
+ export interface LocationTransitionEvaluator {
75
+ region_id: string;
76
+ direction: LocationTransitionDirectionType;
77
+ num_observations_to_consider: number;
78
+ required_num_breaching_observations: number;
79
+ confidence_threshold: number;
80
+ allow_breach_on_initial_observation: boolean;
81
+ }
82
+ export interface RuleInput {
83
+ active: boolean;
84
+ description: string;
85
+ company_id: string;
86
+ then_actions: (RuleAction | undefined)[];
87
+ else_actions: (RuleAction | undefined)[];
88
+ rule_condition: RuleCondition;
89
+ cloud_rule: boolean;
90
+ }
91
+ export interface Rule extends Base, RuleInput {
92
+ last_run_status: number;
93
+ plain_english: string;
94
+ pass_count: number;
95
+ fail_count: number;
96
+ scheduled_only?: boolean;
97
+ schedule?: string;
98
+ scheduler_job_id?: string;
99
+ }
100
+ export interface RulesFilters extends Filters {
101
+ description?: Filter;
102
+ active?: Filter;
103
+ cloud_rule?: Filter;
104
+ }
105
+ export interface PaginatedRules {
106
+ rules: Rule[];
107
+ pagination: Pagination;
108
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,5 @@
1
+ import { BaseModelInterface } from '../core/ModelClass';
2
+ import { Secret, SecretInput, SecretsFilters, PaginatedSecrets } from './models';
3
+ declare type SecretsInterface = BaseModelInterface<Secret, SecretInput, SecretsFilters, PaginatedSecrets>;
4
+ export declare const Secrets: SecretsInterface;
5
+ export {};