@edgeiq/edgeiq-api-js 1.5.8 → 1.6.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.
@@ -1,9 +1,17 @@
1
1
  import { BaseModelInterface } from '../core/ModelClass';
2
2
  import { BulkActionResponse } from '../models';
3
3
  import { Configuration, ConfigurationInput, ConfigurationsFilters, PaginatedConfigurations } from './models';
4
+ import { Command } from '../commands/models';
5
+ import { Device } from '../devices/models';
6
+ import { DeviceType } from '../deviceTypes/models';
4
7
  interface ConfigurationsInterface extends BaseModelInterface<Configuration, ConfigurationInput, ConfigurationsFilters, PaginatedConfigurations> {
5
8
  update(configuration: Configuration): Promise<Configuration>;
6
9
  deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
10
+ addCommand(id: string, commandId: string, usage: string): Promise<string>;
11
+ getSendCommands(id: string): Promise<Command[]>;
12
+ getFetchCommand(id: string): Promise<Command>;
13
+ getDevices(id: string): Promise<Device[]>;
14
+ getDeviceTypes(id: string): Promise<DeviceType[]>;
7
15
  }
8
16
  export declare const Configurations: ConfigurationsInterface;
9
17
  export {};
@@ -219,5 +219,125 @@ exports.Configurations = (function (_super) {
219
219
  });
220
220
  });
221
221
  };
222
+ class_1.addCommand = function (id, commandId, usage) {
223
+ return __awaiter(this, void 0, void 0, function () {
224
+ var axios, error_7;
225
+ return __generator(this, function (_a) {
226
+ switch (_a.label) {
227
+ case 0:
228
+ _a.trys.push([0, 2, , 3]);
229
+ this.logAction("Adding a relation between configuration with id: " + id + " and command with id " + commandId + " with usage " + usage);
230
+ axios = core_1.EdgeIQAPI.getAxios();
231
+ return [4, axios.put(constants_1.Endpoints.configuration + "/" + id + "/commands/" + commandId, { usage: usage })];
232
+ case 1:
233
+ _a.sent();
234
+ return [2, (0, constants_1.getAttachMessage)('Command', 'attach', 'configuration')];
235
+ case 2:
236
+ error_7 = _a.sent();
237
+ if ((0, helpers_1.isApiError)(error_7)) {
238
+ throw error_7;
239
+ }
240
+ throw error_7;
241
+ case 3: return [2];
242
+ }
243
+ });
244
+ });
245
+ };
246
+ class_1.getSendCommands = function (id) {
247
+ return __awaiter(this, void 0, void 0, function () {
248
+ var axios, result, error_8;
249
+ return __generator(this, function (_a) {
250
+ switch (_a.label) {
251
+ case 0:
252
+ _a.trys.push([0, 2, , 3]);
253
+ this.logAction("Getting send commands attached to configuration with id " + id);
254
+ axios = core_1.EdgeIQAPI.getAxios();
255
+ return [4, axios.get(constants_1.Endpoints.configuration + "/" + id + "/" + constants_1.Endpoints.command + "?usage=send")];
256
+ case 1:
257
+ result = _a.sent();
258
+ return [2, result === null || result === void 0 ? void 0 : result.data];
259
+ case 2:
260
+ error_8 = _a.sent();
261
+ if ((0, helpers_1.isApiError)(error_8)) {
262
+ throw error_8;
263
+ }
264
+ throw error_8;
265
+ case 3: return [2];
266
+ }
267
+ });
268
+ });
269
+ };
270
+ class_1.getFetchCommand = function (id) {
271
+ return __awaiter(this, void 0, void 0, function () {
272
+ var axios, result, error_9;
273
+ return __generator(this, function (_a) {
274
+ switch (_a.label) {
275
+ case 0:
276
+ _a.trys.push([0, 2, , 3]);
277
+ this.logAction("Getting fetch command attached to configuration with id " + id);
278
+ axios = core_1.EdgeIQAPI.getAxios();
279
+ return [4, axios.get(constants_1.Endpoints.configuration + "/" + id + "/" + constants_1.Endpoints.command + "?usage=fetch")];
280
+ case 1:
281
+ result = _a.sent();
282
+ return [2, result === null || result === void 0 ? void 0 : result.data[0]];
283
+ case 2:
284
+ error_9 = _a.sent();
285
+ if ((0, helpers_1.isApiError)(error_9)) {
286
+ throw error_9;
287
+ }
288
+ throw error_9;
289
+ case 3: return [2];
290
+ }
291
+ });
292
+ });
293
+ };
294
+ class_1.getDevices = function (id) {
295
+ return __awaiter(this, void 0, void 0, function () {
296
+ var axios, result, error_10;
297
+ return __generator(this, function (_a) {
298
+ switch (_a.label) {
299
+ case 0:
300
+ _a.trys.push([0, 2, , 3]);
301
+ this.logAction("Getting Devices attached to configuration with id " + id);
302
+ axios = core_1.EdgeIQAPI.getAxios();
303
+ return [4, axios.get(constants_1.Endpoints.configuration + "/" + id + "/devices")];
304
+ case 1:
305
+ result = _a.sent();
306
+ return [2, result === null || result === void 0 ? void 0 : result.data];
307
+ case 2:
308
+ error_10 = _a.sent();
309
+ if ((0, helpers_1.isApiError)(error_10)) {
310
+ throw error_10;
311
+ }
312
+ throw error_10;
313
+ case 3: return [2];
314
+ }
315
+ });
316
+ });
317
+ };
318
+ class_1.getDeviceTypes = function (id) {
319
+ return __awaiter(this, void 0, void 0, function () {
320
+ var axios, result, error_11;
321
+ return __generator(this, function (_a) {
322
+ switch (_a.label) {
323
+ case 0:
324
+ _a.trys.push([0, 2, , 3]);
325
+ this.logAction("Getting Device types attached to configuration with id " + id);
326
+ axios = core_1.EdgeIQAPI.getAxios();
327
+ return [4, axios.get(constants_1.Endpoints.configuration + "/" + id + "/device_types")];
328
+ case 1:
329
+ result = _a.sent();
330
+ return [2, result === null || result === void 0 ? void 0 : result.data];
331
+ case 2:
332
+ error_11 = _a.sent();
333
+ if ((0, helpers_1.isApiError)(error_11)) {
334
+ throw error_11;
335
+ }
336
+ throw error_11;
337
+ case 3: return [2];
338
+ }
339
+ });
340
+ });
341
+ };
222
342
  return class_1;
223
343
  }(ModelClass_1.BaseModelClass));
@@ -1,32 +1,16 @@
1
1
  import { Base, Filter, Filters, Pagination } from '../models';
2
- export declare type ConfigurationSettingTypeEnum = 'boolean' | 'string' | 'integer' | 'predefined_list';
3
- export interface ConfigurableSettingsInput {
4
- description?: string;
5
- configuration_id?: string;
6
- key: string;
7
- type: ConfigurationSettingTypeEnum;
8
- default?: string;
9
- required: boolean;
10
- list_items?: [
11
- {
12
- label: string;
13
- value: string;
14
- }
15
- ];
16
- }
17
- export interface ConfigurableSettings extends ConfigurableSettingsInput, Base {
18
- }
19
2
  export interface ConfigurationInput {
20
- name: string;
21
3
  company_id: string;
22
- device_type_id: string;
23
- configurable_settings: ConfigurableSettingsInput[];
4
+ description?: string;
5
+ json_schema: string;
6
+ name: string;
7
+ unique_identifier: string;
24
8
  }
25
9
  export interface Configuration extends ConfigurationInput, Base {
26
10
  }
27
11
  export interface ConfigurationsFilters extends Filters {
28
12
  configuration_id?: Filter;
29
- device_type_id?: Filter;
13
+ unique_identifier?: Filter;
30
14
  }
31
15
  export interface PaginatedConfigurations {
32
16
  configurations: Configuration[];
@@ -81,6 +81,7 @@ export declare const BaseEndpoints: {
81
81
  region: string;
82
82
  report: string;
83
83
  rule: string;
84
+ scheduledJobs: string;
84
85
  secret: string;
85
86
  setting: string;
86
87
  settingsApplicationRecord: string;
@@ -92,7 +93,7 @@ export declare const BaseEndpoints: {
92
93
  userType: string;
93
94
  user: string;
94
95
  logs: string;
95
- scheduledJobs: string;
96
+ workflowDefinitions: string;
96
97
  };
97
98
  export declare const Endpoints: {
98
99
  me: string;
@@ -129,6 +130,7 @@ export declare const Endpoints: {
129
130
  region: string;
130
131
  report: string;
131
132
  rule: string;
133
+ scheduledJobs: string;
132
134
  secret: string;
133
135
  setting: string;
134
136
  settingsApplicationRecord: string;
@@ -142,7 +144,7 @@ export declare const Endpoints: {
142
144
  translator: string;
143
145
  userType: string;
144
146
  user: string;
145
- scheduledJobs: string;
147
+ workflowDefinition: string;
146
148
  };
147
149
  export declare const MethodsActions: {
148
150
  post: string;
package/dist/constants.js CHANGED
@@ -97,6 +97,7 @@ exports.BaseEndpoints = {
97
97
  region: 'regions',
98
98
  report: 'reports',
99
99
  rule: 'rules',
100
+ scheduledJobs: 'scheduled_jobs',
100
101
  secret: 'secrets',
101
102
  setting: 'settings',
102
103
  settingsApplicationRecord: 'settings_application_record',
@@ -108,7 +109,7 @@ exports.BaseEndpoints = {
108
109
  userType: 'user_types',
109
110
  user: 'users',
110
111
  logs: 'logs',
111
- scheduledJobs: 'scheduled_jobs',
112
+ workflowDefinitions: 'workflow_definitions',
112
113
  };
113
114
  exports.Endpoints = {
114
115
  me: 'me',
@@ -145,6 +146,7 @@ exports.Endpoints = {
145
146
  region: "" + exports.BaseEndpoints.region,
146
147
  report: "" + exports.BaseEndpoints.report,
147
148
  rule: "" + exports.BaseEndpoints.rule,
149
+ scheduledJobs: "" + exports.BaseEndpoints.scheduledJobs,
148
150
  secret: "" + exports.BaseEndpoints.secret,
149
151
  setting: "" + exports.BaseEndpoints.setting,
150
152
  settingsApplicationRecord: "" + exports.BaseEndpoints.settingsApplicationRecord,
@@ -158,7 +160,7 @@ exports.Endpoints = {
158
160
  translator: "" + exports.BaseEndpoints.translator,
159
161
  userType: "" + exports.BaseEndpoints.userType,
160
162
  user: "" + exports.BaseEndpoints.user,
161
- scheduledJobs: "" + exports.BaseEndpoints.scheduledJobs,
163
+ workflowDefinition: "" + exports.BaseEndpoints.workflowDefinitions,
162
164
  };
163
165
  exports.MethodsActions = {
164
166
  post: 'creating',
@@ -15,6 +15,10 @@ interface DeviceTypesInterface extends BaseModelInterface<DeviceType, DeviceType
15
15
  detachRule(id: string, ruleId: string): Promise<string>;
16
16
  getRules(id: string): Promise<Rule[]>;
17
17
  getCommands(id: string): Promise<Command[]>;
18
+ attachConfiguration(id: string, configId: string): Promise<string>;
19
+ detachConfiguration(id: string, configId: string): Promise<string>;
20
+ attachSettings(id: string, settingsId: string): Promise<string>;
21
+ detachSettings(id: string, settingsId: string): Promise<string>;
18
22
  }
19
23
  export declare const DeviceTypes: DeviceTypesInterface;
20
24
  export {};
@@ -460,5 +460,101 @@ exports.DeviceTypes = (function (_super) {
460
460
  });
461
461
  });
462
462
  };
463
+ class_1.attachConfiguration = function (id, configId) {
464
+ return __awaiter(this, void 0, void 0, function () {
465
+ var axios, error_17;
466
+ return __generator(this, function (_a) {
467
+ switch (_a.label) {
468
+ case 0:
469
+ _a.trys.push([0, 2, , 3]);
470
+ this.logAction("Attach configuration with id: " + configId + " to device\u00A0type with id: " + id);
471
+ axios = __1.EdgeIQAPI.getAxios();
472
+ return [4, axios.put(constants_1.Endpoints.deviceType + "/" + id + "/configurations/" + configId)];
473
+ case 1:
474
+ _a.sent();
475
+ return [2, (0, constants_1.getAttachMessage)('Configuration', 'attach', 'device type')];
476
+ case 2:
477
+ error_17 = _a.sent();
478
+ if ((0, helpers_1.isApiError)(error_17)) {
479
+ throw error_17;
480
+ }
481
+ throw error_17;
482
+ case 3: return [2];
483
+ }
484
+ });
485
+ });
486
+ };
487
+ class_1.detachConfiguration = function (id, configId) {
488
+ return __awaiter(this, void 0, void 0, function () {
489
+ var axios, error_18;
490
+ return __generator(this, function (_a) {
491
+ switch (_a.label) {
492
+ case 0:
493
+ _a.trys.push([0, 2, , 3]);
494
+ this.logAction("Detach configuration with id: " + configId + " from device\u00A0type with id: " + id);
495
+ axios = __1.EdgeIQAPI.getAxios();
496
+ return [4, axios.delete(constants_1.Endpoints.deviceType + "/" + id + "/configurations/" + configId)];
497
+ case 1:
498
+ _a.sent();
499
+ return [2, (0, constants_1.getAttachMessage)('Configuration', 'detach', 'device type')];
500
+ case 2:
501
+ error_18 = _a.sent();
502
+ if ((0, helpers_1.isApiError)(error_18)) {
503
+ throw error_18;
504
+ }
505
+ throw error_18;
506
+ case 3: return [2];
507
+ }
508
+ });
509
+ });
510
+ };
511
+ class_1.attachSettings = function (id, settingsId) {
512
+ return __awaiter(this, void 0, void 0, function () {
513
+ var axios, error_19;
514
+ return __generator(this, function (_a) {
515
+ switch (_a.label) {
516
+ case 0:
517
+ _a.trys.push([0, 2, , 3]);
518
+ this.logAction("Attach settings with id: " + settingsId + " to device type with id: " + id);
519
+ axios = __1.EdgeIQAPI.getAxios();
520
+ return [4, axios.put(constants_1.Endpoints.deviceType + "/" + id + "/settings/" + settingsId)];
521
+ case 1:
522
+ _a.sent();
523
+ return [2, (0, constants_1.getAttachMessage)('Settings', 'attach', 'device type')];
524
+ case 2:
525
+ error_19 = _a.sent();
526
+ if ((0, helpers_1.isApiError)(error_19)) {
527
+ throw error_19;
528
+ }
529
+ throw error_19;
530
+ case 3: return [2];
531
+ }
532
+ });
533
+ });
534
+ };
535
+ class_1.detachSettings = function (id, settingsId) {
536
+ return __awaiter(this, void 0, void 0, function () {
537
+ var axios, error_20;
538
+ return __generator(this, function (_a) {
539
+ switch (_a.label) {
540
+ case 0:
541
+ _a.trys.push([0, 2, , 3]);
542
+ this.logAction("Detach settings with id: " + settingsId + " from device\u00A0type with id: " + id);
543
+ axios = __1.EdgeIQAPI.getAxios();
544
+ return [4, axios.delete(constants_1.Endpoints.deviceType + "/" + id + "/settings/" + settingsId)];
545
+ case 1:
546
+ _a.sent();
547
+ return [2, (0, constants_1.getAttachMessage)('Settings', 'detach', 'device type')];
548
+ case 2:
549
+ error_20 = _a.sent();
550
+ if ((0, helpers_1.isApiError)(error_20)) {
551
+ throw error_20;
552
+ }
553
+ throw error_20;
554
+ case 3: return [2];
555
+ }
556
+ });
557
+ });
558
+ };
463
559
  return class_1;
464
560
  }(ModelClass_1.BaseModelClass));
@@ -34,6 +34,10 @@ interface DevicesInterface extends BaseModelInterface<Device, DeviceInput, Devic
34
34
  getCommandExecutions(id: string, filters: CommandExecutionsFilters, pagination: PaginationFilter): Promise<PaginatedCommandExecutions>;
35
35
  startRemoteTerminal(id: string, executable?: string): Promise<string>;
36
36
  stopRemoteTerminal(id: string): Promise<string>;
37
+ attachConfiguration(id: string, configId: string): Promise<string>;
38
+ detachConfiguration(id: string, configId: string): Promise<string>;
39
+ attachSettings(id: string, settingsId: string): Promise<string>;
40
+ detachSettings(id: string, settingsId: string): Promise<string>;
37
41
  }
38
42
  export declare const Devices: DevicesInterface;
39
43
  export {};
@@ -829,5 +829,101 @@ exports.Devices = (function (_super) {
829
829
  });
830
830
  });
831
831
  };
832
+ class_1.attachConfiguration = function (id, configId) {
833
+ return __awaiter(this, void 0, void 0, function () {
834
+ var axios, error_30;
835
+ return __generator(this, function (_a) {
836
+ switch (_a.label) {
837
+ case 0:
838
+ _a.trys.push([0, 2, , 3]);
839
+ this.logAction("Attach configuration with id: " + configId + " to device with id: " + id);
840
+ axios = __1.EdgeIQAPI.getAxios();
841
+ return [4, axios.put(constants_1.Endpoints.device + "/" + id + "/configurations/" + configId)];
842
+ case 1:
843
+ _a.sent();
844
+ return [2, (0, constants_1.getAttachMessage)('Configuration', 'attach', 'device')];
845
+ case 2:
846
+ error_30 = _a.sent();
847
+ if ((0, helpers_1.isApiError)(error_30)) {
848
+ throw error_30;
849
+ }
850
+ throw error_30;
851
+ case 3: return [2];
852
+ }
853
+ });
854
+ });
855
+ };
856
+ class_1.detachConfiguration = function (id, configId) {
857
+ return __awaiter(this, void 0, void 0, function () {
858
+ var axios, error_31;
859
+ return __generator(this, function (_a) {
860
+ switch (_a.label) {
861
+ case 0:
862
+ _a.trys.push([0, 2, , 3]);
863
+ this.logAction("Detach configuration with id: " + configId + " from device with id: " + id);
864
+ axios = __1.EdgeIQAPI.getAxios();
865
+ return [4, axios.delete(constants_1.Endpoints.device + "/" + id + "/configurations/" + configId)];
866
+ case 1:
867
+ _a.sent();
868
+ return [2, (0, constants_1.getAttachMessage)('Configuration', 'detach', 'device')];
869
+ case 2:
870
+ error_31 = _a.sent();
871
+ if ((0, helpers_1.isApiError)(error_31)) {
872
+ throw error_31;
873
+ }
874
+ throw error_31;
875
+ case 3: return [2];
876
+ }
877
+ });
878
+ });
879
+ };
880
+ class_1.attachSettings = function (id, sttingsId) {
881
+ return __awaiter(this, void 0, void 0, function () {
882
+ var axios, error_32;
883
+ return __generator(this, function (_a) {
884
+ switch (_a.label) {
885
+ case 0:
886
+ _a.trys.push([0, 2, , 3]);
887
+ this.logAction("Attach settings with id: " + sttingsId + " to device with id: " + id);
888
+ axios = __1.EdgeIQAPI.getAxios();
889
+ return [4, axios.put(constants_1.Endpoints.device + "/" + id + "/settings/" + sttingsId)];
890
+ case 1:
891
+ _a.sent();
892
+ return [2, (0, constants_1.getAttachMessage)('Settings', 'attach', 'device')];
893
+ case 2:
894
+ error_32 = _a.sent();
895
+ if ((0, helpers_1.isApiError)(error_32)) {
896
+ throw error_32;
897
+ }
898
+ throw error_32;
899
+ case 3: return [2];
900
+ }
901
+ });
902
+ });
903
+ };
904
+ class_1.detachSettings = function (id, sttingsId) {
905
+ return __awaiter(this, void 0, void 0, function () {
906
+ var axios, error_33;
907
+ return __generator(this, function (_a) {
908
+ switch (_a.label) {
909
+ case 0:
910
+ _a.trys.push([0, 2, , 3]);
911
+ this.logAction("Detach settings with id: " + sttingsId + " from device with id: " + id);
912
+ axios = __1.EdgeIQAPI.getAxios();
913
+ return [4, axios.delete(constants_1.Endpoints.device + "/" + id + "/settings/" + sttingsId)];
914
+ case 1:
915
+ _a.sent();
916
+ return [2, (0, constants_1.getAttachMessage)('Settings', 'detach', 'device')];
917
+ case 2:
918
+ error_33 = _a.sent();
919
+ if ((0, helpers_1.isApiError)(error_33)) {
920
+ throw error_33;
921
+ }
922
+ throw error_33;
923
+ case 3: return [2];
924
+ }
925
+ });
926
+ });
927
+ };
832
928
  return class_1;
833
929
  }(ModelClass_1.BaseModelClass));
@@ -1,7 +1,11 @@
1
1
  import { BaseModelInterface } from '../core/ModelClass';
2
2
  import { SettingFilters, Setting, SettingInput, PaginatedSettings } from './models';
3
+ import { Device } from '../devices/models';
4
+ import { DeviceType } from '../deviceTypes/models';
3
5
  interface SettingsInterface extends BaseModelInterface<Setting, SettingInput, SettingFilters, PaginatedSettings> {
4
6
  update(setting: Setting): Promise<Setting>;
7
+ getDevices(id: string): Promise<Device[]>;
8
+ getDeviceTypes(id: string): Promise<DeviceType[]>;
5
9
  }
6
10
  export declare const Settings: SettingsInterface;
7
11
  export {};
@@ -194,5 +194,53 @@ exports.Settings = (function (_super) {
194
194
  });
195
195
  });
196
196
  };
197
+ class_1.getDevices = function (id) {
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("Getting Devices attached to setting with id " + id);
205
+ axios = __1.EdgeIQAPI.getAxios();
206
+ return [4, axios.get(constants_1.Endpoints.setting + "/" + id + "/devices")];
207
+ case 1:
208
+ result = _a.sent();
209
+ return [2, result === null || result === void 0 ? void 0 : result.data];
210
+ case 2:
211
+ error_6 = _a.sent();
212
+ if ((0, helpers_1.isApiError)(error_6)) {
213
+ throw error_6;
214
+ }
215
+ throw error_6;
216
+ case 3: return [2];
217
+ }
218
+ });
219
+ });
220
+ };
221
+ class_1.getDeviceTypes = function (id) {
222
+ return __awaiter(this, void 0, void 0, function () {
223
+ var axios, result, error_7;
224
+ return __generator(this, function (_a) {
225
+ switch (_a.label) {
226
+ case 0:
227
+ _a.trys.push([0, 2, , 3]);
228
+ this.logAction("Getting Device types attached to setting with id " + id);
229
+ axios = __1.EdgeIQAPI.getAxios();
230
+ return [4, axios.get(constants_1.Endpoints.setting + "/" + id + "/device_types")];
231
+ case 1:
232
+ result = _a.sent();
233
+ return [2, result === null || result === void 0 ? void 0 : result.data];
234
+ case 2:
235
+ error_7 = _a.sent();
236
+ if ((0, helpers_1.isApiError)(error_7)) {
237
+ throw error_7;
238
+ }
239
+ throw error_7;
240
+ case 3: return [2];
241
+ }
242
+ });
243
+ });
244
+ };
197
245
  return class_1;
198
246
  }(ModelClass_1.BaseModelClass));
@@ -1,23 +1,19 @@
1
1
  import { Base, Filter, Filters, Pagination } from '../models';
2
- import { ConfigurableSettings } from '../configurations/models';
3
- export interface SettingsValue extends Base {
4
- settings_id?: string;
5
- configurable_settings_id?: string;
6
- configurable_setting?: ConfigurableSettings;
7
- value?: string;
8
- }
9
2
  export interface SettingInput {
10
3
  name: string;
11
- command_id?: string;
4
+ company_id: string;
12
5
  configuration_id: string;
13
- settings_values: SettingsValue[];
6
+ description?: string;
7
+ values: {
8
+ [key: string]: unknown;
9
+ };
10
+ version?: number;
14
11
  }
15
12
  export interface Setting extends SettingInput, Base {
16
13
  }
17
14
  export interface SettingFilters extends Filters {
18
- unique_id?: Filter;
15
+ name?: Filter;
19
16
  configuration_id?: Filter;
20
- website?: Filter;
21
17
  }
22
18
  export interface PaginatedSettings {
23
19
  settings: Setting[];
@@ -0,0 +1,5 @@
1
+ import { BaseModelInterface } from '../core/ModelClass';
2
+ import { WorkflowDefinitionsFilters, WorkflowDefinition, PaginatedWorkflowDefinitions } from './models';
3
+ declare type WorkflowDefinitionsInterface = BaseModelInterface<WorkflowDefinition, WorkflowDefinition, WorkflowDefinitionsFilters, PaginatedWorkflowDefinitions>;
4
+ export declare const WorkflowDefinitions: WorkflowDefinitionsInterface;
5
+ export {};
@@ -51,28 +51,28 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
51
51
  }
52
52
  };
53
53
  Object.defineProperty(exports, "__esModule", { value: true });
54
- exports.DeviceFiles = void 0;
54
+ exports.WorkflowDefinitions = void 0;
55
55
  var __1 = require("..");
56
56
  var constants_1 = require("../constants");
57
57
  var ModelClass_1 = require("../core/ModelClass");
58
58
  var filtersParser_1 = require("../filtersParser");
59
59
  var helpers_1 = require("../helpers");
60
- exports.DeviceFiles = (function (_super) {
60
+ exports.WorkflowDefinitions = (function (_super) {
61
61
  __extends(class_1, _super);
62
62
  function class_1() {
63
63
  return _super !== null && _super.apply(this, arguments) || this;
64
64
  }
65
- class_1.create = function (file) {
65
+ class_1.create = function (workflowDefinition) {
66
66
  return __awaiter(this, void 0, void 0, function () {
67
67
  var axios, data, result, error_1;
68
68
  return __generator(this, function (_a) {
69
69
  switch (_a.label) {
70
70
  case 0:
71
71
  _a.trys.push([0, 2, , 3]);
72
- this.logAction("Creating file with unique ID: " + file);
72
+ this.logAction("Creating workflowDefinition: " + workflowDefinition);
73
73
  axios = __1.EdgeIQAPI.getAxios();
74
- data = JSON.stringify(file);
75
- return [4, axios.post(constants_1.Endpoints.file, data)];
74
+ data = JSON.stringify(workflowDefinition);
75
+ return [4, axios.post(constants_1.Endpoints.workflowDefinition, data)];
76
76
  case 1:
77
77
  result = _a.sent();
78
78
  return [2, result === null || result === void 0 ? void 0 : result.data];
@@ -87,17 +87,17 @@ exports.DeviceFiles = (function (_super) {
87
87
  });
88
88
  });
89
89
  };
90
- class_1.update = function (file) {
90
+ class_1.update = function (workflowDefinition) {
91
91
  return __awaiter(this, void 0, void 0, function () {
92
92
  var axios, data, result, error_2;
93
93
  return __generator(this, function (_a) {
94
94
  switch (_a.label) {
95
95
  case 0:
96
96
  _a.trys.push([0, 2, , 3]);
97
- this.logAction("Updating file with ID: " + file._id);
97
+ this.logAction("Updating workflow definition with ID: " + workflowDefinition._id);
98
98
  axios = __1.EdgeIQAPI.getAxios();
99
- data = JSON.stringify(file);
100
- return [4, axios.put(constants_1.Endpoints.file + "/" + file._id, data)];
99
+ data = JSON.stringify(workflowDefinition);
100
+ return [4, axios.put(constants_1.Endpoints.workflowDefinition + "/" + workflowDefinition._id, data)];
101
101
  case 1:
102
102
  result = _a.sent();
103
103
  return [2, result === null || result === void 0 ? void 0 : result.data];
@@ -115,20 +115,21 @@ exports.DeviceFiles = (function (_super) {
115
115
  class_1.list = function (filters, pagination) {
116
116
  var _a, _b, _c, _d;
117
117
  return __awaiter(this, void 0, void 0, function () {
118
- var axios, result, error_3;
118
+ var endpoint, axios, result, error_3;
119
119
  return __generator(this, function (_e) {
120
120
  switch (_e.label) {
121
121
  case 0:
122
122
  _e.trys.push([0, 2, , 3]);
123
- this.logAction("Listing files with following filters: " + (filters !== null && filters !== void 0 ? filters : '{}') + ".\n And pagination " + (pagination !== null && pagination !== void 0 ? pagination : '{}'));
123
+ this.logAction("Listing workflow definitions with following filters: " + (filters !== null && filters !== void 0 ? filters : '{}') + ".\n And pagination " + (pagination !== null && pagination !== void 0 ? pagination : '{}'));
124
+ endpoint = constants_1.Endpoints.workflowDefinition;
124
125
  axios = __1.EdgeIQAPI.getAxios();
125
- return [4, axios.get(constants_1.Endpoints.file, {
126
+ return [4, axios.get(endpoint, {
126
127
  params: (0, filtersParser_1.parseFilters)(filters, pagination),
127
128
  })];
128
129
  case 1:
129
130
  result = _e.sent();
130
131
  return [2, {
131
- files: (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.resources,
132
+ workflow_definitions: (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.resources,
132
133
  pagination: {
133
134
  page: (_b = result === null || result === void 0 ? void 0 : result.data) === null || _b === void 0 ? void 0 : _b.page,
134
135
  itemsPerPage: (_c = result === null || result === void 0 ? void 0 : result.data) === null || _c === void 0 ? void 0 : _c.per_page,
@@ -153,9 +154,9 @@ exports.DeviceFiles = (function (_super) {
153
154
  switch (_a.label) {
154
155
  case 0:
155
156
  _a.trys.push([0, 2, , 3]);
156
- this.logAction("Getting file with id: " + id);
157
+ this.logAction("Getting workflow definition with id: " + id);
157
158
  axios = __1.EdgeIQAPI.getAxios();
158
- return [4, axios.get(constants_1.Endpoints.file + "/" + id)];
159
+ return [4, axios.get(constants_1.Endpoints.workflowDefinition + "/" + id)];
159
160
  case 1:
160
161
  result = _a.sent();
161
162
  return [2, result === null || result === void 0 ? void 0 : result.data];
@@ -177,12 +178,12 @@ exports.DeviceFiles = (function (_super) {
177
178
  switch (_a.label) {
178
179
  case 0:
179
180
  _a.trys.push([0, 2, , 3]);
180
- this.logAction("Deleting file with id " + id);
181
+ this.logAction("Deleting workflow definition with id " + id);
181
182
  axios = __1.EdgeIQAPI.getAxios();
182
- return [4, axios.delete(constants_1.Endpoints.file + "/" + id)];
183
+ return [4, axios.delete(constants_1.Endpoints.workflowDefinition + "/" + id)];
183
184
  case 1:
184
185
  _a.sent();
185
- return [2, (0, helpers_1.getReturnDeleteMessage)('file')];
186
+ return [2, (0, helpers_1.getReturnDeleteMessage)('workflowDefinition')];
186
187
  case 2:
187
188
  error_5 = _a.sent();
188
189
  if ((0, helpers_1.isApiError)(error_5)) {
@@ -194,21 +195,17 @@ exports.DeviceFiles = (function (_super) {
194
195
  });
195
196
  });
196
197
  };
197
- class_1.uploadFile = function (id, file) {
198
+ class_1.deleteMultiple = function (ids) {
198
199
  return __awaiter(this, void 0, void 0, function () {
199
- var axios, form, result, error_6;
200
+ var axios, result, error_6;
200
201
  return __generator(this, function (_a) {
201
202
  switch (_a.label) {
202
203
  case 0:
203
204
  _a.trys.push([0, 2, , 3]);
204
- this.logAction("Uploading file to device");
205
+ this.logAction("Deleting workflow definitions with id " + ids.join(', '));
205
206
  axios = __1.EdgeIQAPI.getAxios();
206
- form = new FormData();
207
- form.append('file', file);
208
- return [4, axios.post(constants_1.Endpoints.file + "/" + id, form, {
209
- headers: {
210
- 'Content-Type': 'multipart/form-data',
211
- },
207
+ return [4, axios.delete(constants_1.Endpoints.workflowDefinition + "/bulk", {
208
+ data: { ids: ids },
212
209
  })];
213
210
  case 1:
214
211
  result = _a.sent();
@@ -224,55 +221,5 @@ exports.DeviceFiles = (function (_super) {
224
221
  });
225
222
  });
226
223
  };
227
- class_1.downloadFile = function (id) {
228
- return __awaiter(this, void 0, void 0, function () {
229
- var axios, result, error_7;
230
- return __generator(this, function (_a) {
231
- switch (_a.label) {
232
- case 0:
233
- _a.trys.push([0, 2, , 3]);
234
- this.logAction("Downloading file with id: " + id);
235
- axios = __1.EdgeIQAPI.getAxios();
236
- return [4, axios.get(constants_1.Endpoints.file + "/" + id + "/download")];
237
- case 1:
238
- result = _a.sent();
239
- return [2, result === null || result === void 0 ? void 0 : result.data];
240
- case 2:
241
- error_7 = _a.sent();
242
- if ((0, helpers_1.isApiError)(error_7)) {
243
- throw error_7;
244
- }
245
- throw error_7;
246
- case 3: return [2];
247
- }
248
- });
249
- });
250
- };
251
- class_1.deleteMultiple = function (ids) {
252
- return __awaiter(this, void 0, void 0, function () {
253
- var axios, result, error_8;
254
- return __generator(this, function (_a) {
255
- switch (_a.label) {
256
- case 0:
257
- _a.trys.push([0, 2, , 3]);
258
- this.logAction("Deleting files with id " + ids.join(', '));
259
- axios = __1.EdgeIQAPI.getAxios();
260
- return [4, axios.delete(constants_1.Endpoints.file + "/bulk", {
261
- data: { ids: ids },
262
- })];
263
- case 1:
264
- result = _a.sent();
265
- return [2, result === null || result === void 0 ? void 0 : result.data];
266
- case 2:
267
- error_8 = _a.sent();
268
- if ((0, helpers_1.isApiError)(error_8)) {
269
- throw error_8;
270
- }
271
- throw error_8;
272
- case 3: return [2];
273
- }
274
- });
275
- });
276
- };
277
224
  return class_1;
278
225
  }(ModelClass_1.BaseModelClass));
@@ -0,0 +1,26 @@
1
+ import { Base, Filter, Filters, Pagination } from '../models';
2
+ export interface WorkflowContextServiceData {
3
+ resource: string;
4
+ id: string;
5
+ object?: {
6
+ [key: string]: unknown;
7
+ };
8
+ }
9
+ export interface WorkflowContext {
10
+ user_data?: {
11
+ [key: string]: unknown;
12
+ };
13
+ service_data?: WorkflowContextServiceData;
14
+ }
15
+ export interface WorkflowDefinition extends Base {
16
+ name: string;
17
+ base_context?: WorkflowContext;
18
+ default_context?: WorkflowContext;
19
+ }
20
+ export interface WorkflowDefinitionsFilters extends Filters {
21
+ name?: Filter;
22
+ }
23
+ export interface PaginatedWorkflowDefinitions {
24
+ workflow_definitions: WorkflowDefinition[];
25
+ pagination: Pagination;
26
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@edgeiq/edgeiq-api-js",
3
- "version": "1.5.8",
3
+ "version": "1.6.0",
4
4
  "author": "EdgeIQ",
5
5
  "license": "ISC",
6
6
  "description": "This project presents EdgeIQ API SDK.",
@@ -1,9 +0,0 @@
1
- import { BaseModelInterface } from '../core/ModelClass';
2
- import { BulkActionResponse } from '../models';
3
- import { DeviceFilesFilters, DeviceFile, DeviceFileInput, PaginatedDeviceFiles } from './models';
4
- interface DeviceFilesInterface extends BaseModelInterface<DeviceFile, DeviceFileInput, DeviceFilesFilters, PaginatedDeviceFiles> {
5
- update(file: DeviceFile): Promise<DeviceFile>;
6
- deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
7
- }
8
- export declare const DeviceFiles: DeviceFilesInterface;
9
- export {};
@@ -1,17 +0,0 @@
1
- import { Base, Filter, Filters, Pagination } from '../models';
2
- export interface DeviceFileInput {
3
- name: string;
4
- device_id: string;
5
- mime_type: string;
6
- metadata?: unknown;
7
- }
8
- export interface DeviceFile extends DeviceFileInput, Base {
9
- }
10
- export interface DeviceFilesFilters extends Filters {
11
- unique_id?: Filter;
12
- website?: Filter;
13
- }
14
- export interface PaginatedDeviceFiles {
15
- files: DeviceFile[];
16
- pagination: Pagination;
17
- }
@@ -1,5 +0,0 @@
1
- import { Lwm2mState, Lwm2mStatesFilters } from './models';
2
- declare const Lwm2mStates: {
3
- list: (filters?: Lwm2mStatesFilters | undefined) => Promise<Lwm2mState[]>;
4
- };
5
- export { Lwm2mStates };
@@ -1,71 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- var __generator = (this && this.__generator) || function (thisArg, body) {
12
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
13
- return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
14
- function verb(n) { return function (v) { return step([n, v]); }; }
15
- function step(op) {
16
- if (f) throw new TypeError("Generator is already executing.");
17
- while (_) try {
18
- 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;
19
- if (y = 0, t) op = [op[0] & 2, t.value];
20
- switch (op[0]) {
21
- case 0: case 1: t = op; break;
22
- case 4: _.label++; return { value: op[1], done: false };
23
- case 5: _.label++; y = op[1]; op = [0]; continue;
24
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
25
- default:
26
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
27
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
28
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
29
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
30
- if (t[2]) _.ops.pop();
31
- _.trys.pop(); continue;
32
- }
33
- op = body.call(thisArg, _);
34
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
35
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
36
- }
37
- };
38
- Object.defineProperty(exports, "__esModule", { value: true });
39
- exports.Lwm2mStates = void 0;
40
- var constants_1 = require("../constants");
41
- var helpers_1 = require("../helpers");
42
- var filtersParser_1 = require("../filtersParser");
43
- var __1 = require("..");
44
- var Lwm2mStates = {
45
- list: function (filters) { return __awaiter(void 0, void 0, void 0, function () {
46
- var axios, result, error_1;
47
- var _a;
48
- return __generator(this, function (_b) {
49
- switch (_b.label) {
50
- case 0:
51
- _b.trys.push([0, 2, , 3]);
52
- __1.EdgeIQAPI.logAction("Listing bulk responses with following filters: " + (filters !== null && filters !== void 0 ? filters : '{}'));
53
- axios = __1.EdgeIQAPI.getAxios();
54
- return [4, axios.get(constants_1.Endpoints.lwm2mStates, {
55
- params: (0, filtersParser_1.parseFilters)(filters),
56
- })];
57
- case 1:
58
- result = _b.sent();
59
- return [2, (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.resources];
60
- case 2:
61
- error_1 = _b.sent();
62
- if ((0, helpers_1.isApiError)(error_1)) {
63
- throw error_1;
64
- }
65
- throw error_1;
66
- case 3: return [2];
67
- }
68
- });
69
- }); },
70
- };
71
- exports.Lwm2mStates = Lwm2mStates;
@@ -1,10 +0,0 @@
1
- import { Base, Filter, Filters } from '../models';
2
- export interface Lwm2mState extends Base {
3
- device_id?: string;
4
- state?: {
5
- [key: string]: unknown;
6
- };
7
- }
8
- export interface Lwm2mStatesFilters extends Filters {
9
- device_id?: Filter;
10
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });