@edgeiq/edgeiq-api-js 1.6.6 → 1.6.8

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.
@@ -2,15 +2,14 @@ import { BaseModelInterface } from '../core/ModelClass';
2
2
  import { BulkActionResponse } from '../models';
3
3
  import { Configuration, ConfigurationInput, ConfigurationsFilters, PaginatedConfigurations } from './models';
4
4
  import { Command } from '../commands/models';
5
- import { Device } from '../devices/models';
6
5
  import { DeviceType } from '../deviceTypes/models';
7
6
  interface ConfigurationsInterface extends BaseModelInterface<Configuration, ConfigurationInput, ConfigurationsFilters, PaginatedConfigurations> {
8
7
  update(configuration: Configuration): Promise<Configuration>;
9
8
  deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
10
9
  addCommand(id: string, commandId: string, usage: string): Promise<string>;
10
+ removeCommand(id: string, commandId: string): Promise<string>;
11
11
  getSendCommands(id: string): Promise<Command[]>;
12
12
  getFetchCommand(id: string): Promise<Command>;
13
- getDevices(id: string): Promise<Device[]>;
14
13
  getDeviceTypes(id: string): Promise<DeviceType[]>;
15
14
  }
16
15
  export declare const Configurations: ConfigurationsInterface;
@@ -243,19 +243,19 @@ exports.Configurations = (function (_super) {
243
243
  });
244
244
  });
245
245
  };
246
- class_1.getSendCommands = function (id) {
246
+ class_1.removeCommand = function (id, commandId) {
247
247
  return __awaiter(this, void 0, void 0, function () {
248
- var axios, result, error_8;
248
+ var axios, error_8;
249
249
  return __generator(this, function (_a) {
250
250
  switch (_a.label) {
251
251
  case 0:
252
252
  _a.trys.push([0, 2, , 3]);
253
- this.logAction("Getting send commands attached to configuration with id " + id);
253
+ this.logAction("Removing a relation between configuration with id: " + id + " and command with id " + commandId);
254
254
  axios = core_1.EdgeIQAPI.getAxios();
255
- return [4, axios.get(constants_1.Endpoints.configuration + "/" + id + "/" + constants_1.Endpoints.command + "?usage=send")];
255
+ return [4, axios.delete(constants_1.Endpoints.configuration + "/" + id + "/commands/" + commandId)];
256
256
  case 1:
257
- result = _a.sent();
258
- return [2, result === null || result === void 0 ? void 0 : result.data];
257
+ _a.sent();
258
+ return [2, (0, constants_1.getAttachMessage)('Command', 'detach', 'configuration')];
259
259
  case 2:
260
260
  error_8 = _a.sent();
261
261
  if ((0, helpers_1.isApiError)(error_8)) {
@@ -267,19 +267,19 @@ exports.Configurations = (function (_super) {
267
267
  });
268
268
  });
269
269
  };
270
- class_1.getFetchCommand = function (id) {
270
+ class_1.getSendCommands = function (id) {
271
271
  return __awaiter(this, void 0, void 0, function () {
272
272
  var axios, result, error_9;
273
273
  return __generator(this, function (_a) {
274
274
  switch (_a.label) {
275
275
  case 0:
276
276
  _a.trys.push([0, 2, , 3]);
277
- this.logAction("Getting fetch command attached to configuration with id " + id);
277
+ this.logAction("Getting send commands attached to configuration with id " + id);
278
278
  axios = core_1.EdgeIQAPI.getAxios();
279
- return [4, axios.get(constants_1.Endpoints.configuration + "/" + id + "/" + constants_1.Endpoints.command + "?usage=fetch")];
279
+ return [4, axios.get(constants_1.Endpoints.configuration + "/" + id + "/" + constants_1.Endpoints.command + "?usage=send")];
280
280
  case 1:
281
281
  result = _a.sent();
282
- return [2, result === null || result === void 0 ? void 0 : result.data[0]];
282
+ return [2, result === null || result === void 0 ? void 0 : result.data];
283
283
  case 2:
284
284
  error_9 = _a.sent();
285
285
  if ((0, helpers_1.isApiError)(error_9)) {
@@ -291,19 +291,19 @@ exports.Configurations = (function (_super) {
291
291
  });
292
292
  });
293
293
  };
294
- class_1.getDevices = function (id) {
294
+ class_1.getFetchCommand = function (id) {
295
295
  return __awaiter(this, void 0, void 0, function () {
296
296
  var axios, result, error_10;
297
297
  return __generator(this, function (_a) {
298
298
  switch (_a.label) {
299
299
  case 0:
300
300
  _a.trys.push([0, 2, , 3]);
301
- this.logAction("Getting Devices attached to configuration with id " + id);
301
+ this.logAction("Getting fetch command attached to configuration with id " + id);
302
302
  axios = core_1.EdgeIQAPI.getAxios();
303
- return [4, axios.get(constants_1.Endpoints.configuration + "/" + id + "/devices")];
303
+ return [4, axios.get(constants_1.Endpoints.configuration + "/" + id + "/" + constants_1.Endpoints.command + "?usage=fetch")];
304
304
  case 1:
305
305
  result = _a.sent();
306
- return [2, result === null || result === void 0 ? void 0 : result.data];
306
+ return [2, result === null || result === void 0 ? void 0 : result.data[0]];
307
307
  case 2:
308
308
  error_10 = _a.sent();
309
309
  if ((0, helpers_1.isApiError)(error_10)) {
@@ -9,7 +9,6 @@ export interface ConfigurationInput {
9
9
  export interface Configuration extends ConfigurationInput, Base {
10
10
  }
11
11
  export interface ConfigurationsFilters extends Filters {
12
- configuration_id?: Filter;
13
12
  unique_identifier?: Filter;
14
13
  }
15
14
  export interface PaginatedConfigurations {
@@ -1,4 +1,4 @@
1
- import { Ingestor, PollableAttribute, Rule, Command } from '..';
1
+ import { Configuration, Command, Ingestor, PollableAttribute, Rule, Setting } from '..';
2
2
  import { BaseModelInterface } from '../core/ModelClass';
3
3
  import { BulkActionResponse } from '../models';
4
4
  import { DeviceType, DeviceTypeInput, DeviceTypesFilters, PaginatedDeviceTypes } from './models';
@@ -15,8 +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
+ getConfigurations(id: string): Promise<Configuration[]>;
18
19
  attachConfiguration(id: string, configId: string): Promise<string>;
19
20
  detachConfiguration(id: string, configId: string): Promise<string>;
21
+ getSettings(id: string, configId?: string): Promise<Setting[]>;
20
22
  attachSettings(id: string, settingsId: string): Promise<string>;
21
23
  detachSettings(id: string, settingsId: string): Promise<string>;
22
24
  }
@@ -460,19 +460,19 @@ exports.DeviceTypes = (function (_super) {
460
460
  });
461
461
  });
462
462
  };
463
- class_1.attachConfiguration = function (id, configId) {
463
+ class_1.getConfigurations = function (id) {
464
464
  return __awaiter(this, void 0, void 0, function () {
465
- var axios, error_17;
465
+ var axios, result, error_17;
466
466
  return __generator(this, function (_a) {
467
467
  switch (_a.label) {
468
468
  case 0:
469
469
  _a.trys.push([0, 2, , 3]);
470
- this.logAction("Attach configuration with id: " + configId + " to device\u00A0type with id: " + id);
470
+ this.logAction("Getting configurations attached to device type with id " + id);
471
471
  axios = __1.EdgeIQAPI.getAxios();
472
- return [4, axios.put(constants_1.Endpoints.deviceType + "/" + id + "/configurations/" + configId)];
472
+ return [4, axios.get(constants_1.Endpoints.deviceType + "/" + id + "/" + constants_1.Endpoints.configuration)];
473
473
  case 1:
474
- _a.sent();
475
- return [2, (0, constants_1.getAttachMessage)('Configuration', 'attach', 'device type')];
474
+ result = _a.sent();
475
+ return [2, result === null || result === void 0 ? void 0 : result.data];
476
476
  case 2:
477
477
  error_17 = _a.sent();
478
478
  if ((0, helpers_1.isApiError)(error_17)) {
@@ -484,19 +484,19 @@ exports.DeviceTypes = (function (_super) {
484
484
  });
485
485
  });
486
486
  };
487
- class_1.detachConfiguration = function (id, configId) {
487
+ class_1.attachConfiguration = function (id, configId) {
488
488
  return __awaiter(this, void 0, void 0, function () {
489
489
  var axios, error_18;
490
490
  return __generator(this, function (_a) {
491
491
  switch (_a.label) {
492
492
  case 0:
493
493
  _a.trys.push([0, 2, , 3]);
494
- this.logAction("Detach configuration with id: " + configId + " from device\u00A0type with id: " + id);
494
+ this.logAction("Attach configuration with id: " + configId + " to device\u00A0type with id: " + id);
495
495
  axios = __1.EdgeIQAPI.getAxios();
496
- return [4, axios.delete(constants_1.Endpoints.deviceType + "/" + id + "/configurations/" + configId)];
496
+ return [4, axios.put(constants_1.Endpoints.deviceType + "/" + id + "/configurations/" + configId)];
497
497
  case 1:
498
498
  _a.sent();
499
- return [2, (0, constants_1.getAttachMessage)('Configuration', 'detach', 'device type')];
499
+ return [2, (0, constants_1.getAttachMessage)('Configuration', 'attach', 'device type')];
500
500
  case 2:
501
501
  error_18 = _a.sent();
502
502
  if ((0, helpers_1.isApiError)(error_18)) {
@@ -508,19 +508,19 @@ exports.DeviceTypes = (function (_super) {
508
508
  });
509
509
  });
510
510
  };
511
- class_1.attachSettings = function (id, settingsId) {
511
+ class_1.detachConfiguration = function (id, configId) {
512
512
  return __awaiter(this, void 0, void 0, function () {
513
513
  var axios, error_19;
514
514
  return __generator(this, function (_a) {
515
515
  switch (_a.label) {
516
516
  case 0:
517
517
  _a.trys.push([0, 2, , 3]);
518
- this.logAction("Attach settings with id: " + settingsId + " to device type with id: " + id);
518
+ this.logAction("Detach configuration with id: " + configId + " from device\u00A0type with id: " + id);
519
519
  axios = __1.EdgeIQAPI.getAxios();
520
- return [4, axios.put(constants_1.Endpoints.deviceType + "/" + id + "/settings/" + settingsId)];
520
+ return [4, axios.delete(constants_1.Endpoints.deviceType + "/" + id + "/configurations/" + configId)];
521
521
  case 1:
522
522
  _a.sent();
523
- return [2, (0, constants_1.getAttachMessage)('Settings', 'attach', 'device type')];
523
+ return [2, (0, constants_1.getAttachMessage)('Configuration', 'detach', 'device type')];
524
524
  case 2:
525
525
  error_19 = _a.sent();
526
526
  if ((0, helpers_1.isApiError)(error_19)) {
@@ -532,9 +532,57 @@ exports.DeviceTypes = (function (_super) {
532
532
  });
533
533
  });
534
534
  };
535
+ class_1.getSettings = function (id, configId) {
536
+ return __awaiter(this, void 0, void 0, function () {
537
+ var axios, result, 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("Getting settings attached to device type with id " + id);
543
+ axios = __1.EdgeIQAPI.getAxios();
544
+ return [4, axios.get(constants_1.Endpoints.deviceType + "/" + id + "/" + constants_1.Endpoints.setting + (configId ? "?configuration_id=" + configId : ''))];
545
+ case 1:
546
+ result = _a.sent();
547
+ return [2, result === null || result === void 0 ? void 0 : result.data];
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
+ };
559
+ class_1.attachSettings = function (id, settingsId) {
560
+ return __awaiter(this, void 0, void 0, function () {
561
+ var axios, error_21;
562
+ return __generator(this, function (_a) {
563
+ switch (_a.label) {
564
+ case 0:
565
+ _a.trys.push([0, 2, , 3]);
566
+ this.logAction("Attach settings with id: " + settingsId + " to device type with id: " + id);
567
+ axios = __1.EdgeIQAPI.getAxios();
568
+ return [4, axios.put(constants_1.Endpoints.deviceType + "/" + id + "/settings/" + settingsId)];
569
+ case 1:
570
+ _a.sent();
571
+ return [2, (0, constants_1.getAttachMessage)('Settings', 'attach', 'device type')];
572
+ case 2:
573
+ error_21 = _a.sent();
574
+ if ((0, helpers_1.isApiError)(error_21)) {
575
+ throw error_21;
576
+ }
577
+ throw error_21;
578
+ case 3: return [2];
579
+ }
580
+ });
581
+ });
582
+ };
535
583
  class_1.detachSettings = function (id, settingsId) {
536
584
  return __awaiter(this, void 0, void 0, function () {
537
- var axios, error_20;
585
+ var axios, error_22;
538
586
  return __generator(this, function (_a) {
539
587
  switch (_a.label) {
540
588
  case 0:
@@ -546,11 +594,11 @@ exports.DeviceTypes = (function (_super) {
546
594
  _a.sent();
547
595
  return [2, (0, constants_1.getAttachMessage)('Settings', 'detach', 'device type')];
548
596
  case 2:
549
- error_20 = _a.sent();
550
- if ((0, helpers_1.isApiError)(error_20)) {
551
- throw error_20;
597
+ error_22 = _a.sent();
598
+ if ((0, helpers_1.isApiError)(error_22)) {
599
+ throw error_22;
552
600
  }
553
- throw error_20;
601
+ throw error_22;
554
602
  case 3: return [2];
555
603
  }
556
604
  });
@@ -1,4 +1,4 @@
1
- import { Ingestor, Rule, Command, Log, EIQFile } from '..';
1
+ import { Command, EIQFile, Ingestor, Log, Rule, Setting } from '..';
2
2
  import { BaseModelInterface } from '../core/ModelClass';
3
3
  import { GatewayCommand, GatewayCommandRequest } from '../gatewayCommands/models';
4
4
  import { BulkActionResponse, PaginationFilter } from '../models';
@@ -34,8 +34,7 @@ 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>;
37
+ getSettings(id: string, configId?: string): Promise<Setting[]>;
39
38
  attachSettings(id: string, settingsId: string): Promise<string>;
40
39
  detachSettings(id: string, settingsId: string): Promise<string>;
41
40
  }
@@ -829,19 +829,19 @@ exports.Devices = (function (_super) {
829
829
  });
830
830
  });
831
831
  };
832
- class_1.attachConfiguration = function (id, configId) {
832
+ class_1.getSettings = function (id, configId) {
833
833
  return __awaiter(this, void 0, void 0, function () {
834
- var axios, error_30;
834
+ var axios, result, error_30;
835
835
  return __generator(this, function (_a) {
836
836
  switch (_a.label) {
837
837
  case 0:
838
838
  _a.trys.push([0, 2, , 3]);
839
- this.logAction("Attach configuration with id: " + configId + " to device with id: " + id);
839
+ this.logAction("Getting settings attached to device with id " + id);
840
840
  axios = __1.EdgeIQAPI.getAxios();
841
- return [4, axios.put(constants_1.Endpoints.device + "/" + id + "/configurations/" + configId)];
841
+ return [4, axios.get(constants_1.Endpoints.device + "/" + id + "/" + constants_1.Endpoints.setting + (configId ? "?configuration_id=" + configId : ''))];
842
842
  case 1:
843
- _a.sent();
844
- return [2, (0, constants_1.getAttachMessage)('Configuration', 'attach', 'device')];
843
+ result = _a.sent();
844
+ return [2, result === null || result === void 0 ? void 0 : result.data];
845
845
  case 2:
846
846
  error_30 = _a.sent();
847
847
  if ((0, helpers_1.isApiError)(error_30)) {
@@ -853,19 +853,19 @@ exports.Devices = (function (_super) {
853
853
  });
854
854
  });
855
855
  };
856
- class_1.detachConfiguration = function (id, configId) {
856
+ class_1.attachSettings = function (id, sttingsId) {
857
857
  return __awaiter(this, void 0, void 0, function () {
858
858
  var axios, error_31;
859
859
  return __generator(this, function (_a) {
860
860
  switch (_a.label) {
861
861
  case 0:
862
862
  _a.trys.push([0, 2, , 3]);
863
- this.logAction("Detach configuration with id: " + configId + " from device with id: " + id);
863
+ this.logAction("Attach settings with id: " + sttingsId + " to device with id: " + id);
864
864
  axios = __1.EdgeIQAPI.getAxios();
865
- return [4, axios.delete(constants_1.Endpoints.device + "/" + id + "/configurations/" + configId)];
865
+ return [4, axios.put(constants_1.Endpoints.device + "/" + id + "/settings/" + sttingsId)];
866
866
  case 1:
867
867
  _a.sent();
868
- return [2, (0, constants_1.getAttachMessage)('Configuration', 'detach', 'device')];
868
+ return [2, (0, constants_1.getAttachMessage)('Settings', 'attach', 'device')];
869
869
  case 2:
870
870
  error_31 = _a.sent();
871
871
  if ((0, helpers_1.isApiError)(error_31)) {
@@ -877,19 +877,19 @@ exports.Devices = (function (_super) {
877
877
  });
878
878
  });
879
879
  };
880
- class_1.attachSettings = function (id, sttingsId) {
880
+ class_1.detachSettings = function (id, sttingsId) {
881
881
  return __awaiter(this, void 0, void 0, function () {
882
882
  var axios, error_32;
883
883
  return __generator(this, function (_a) {
884
884
  switch (_a.label) {
885
885
  case 0:
886
886
  _a.trys.push([0, 2, , 3]);
887
- this.logAction("Attach settings with id: " + sttingsId + " to device with id: " + id);
887
+ this.logAction("Detach settings with id: " + sttingsId + " from device with id: " + id);
888
888
  axios = __1.EdgeIQAPI.getAxios();
889
- return [4, axios.put(constants_1.Endpoints.device + "/" + id + "/settings/" + sttingsId)];
889
+ return [4, axios.delete(constants_1.Endpoints.device + "/" + id + "/settings/" + sttingsId)];
890
890
  case 1:
891
891
  _a.sent();
892
- return [2, (0, constants_1.getAttachMessage)('Settings', 'attach', 'device')];
892
+ return [2, (0, constants_1.getAttachMessage)('Settings', 'detach', 'device')];
893
893
  case 2:
894
894
  error_32 = _a.sent();
895
895
  if ((0, helpers_1.isApiError)(error_32)) {
@@ -901,29 +901,5 @@ exports.Devices = (function (_super) {
901
901
  });
902
902
  });
903
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
- };
928
904
  return class_1;
929
905
  }(ModelClass_1.BaseModelClass));
@@ -1,5 +1,5 @@
1
1
  import { Base, Filter, Filters, Pagination } from '../models';
2
- export declare type GatewayCommandType = 'activate_cloud_native_device' | 'backup' | 'data_restriction' | 'deactivate_cloud_native_device' | 'disable_data_restriction' | 'enable_data_restriction' | 'greengrass_initialize' | 'awsiot_attach_thing_groups' | 'awsiot_detach_thing_groups' | 'cancel_password_change' | 'file_from_device' | 'file_to_device' | 'heartbeat' | 'log_level' | 'log_upload' | 'lwm2m_request' | 'lwm2m_file' | 'restore_backup' | 'reboot' | 'reset' | 'send_config' | 'setting' | 'software_update' | 'status';
2
+ export declare type GatewayCommandType = 'activate_cloud_native_device' | 'backup' | 'data_restriction' | 'deactivate_cloud_native_device' | 'disable_data_restriction' | 'enable_data_restriction' | 'greengrass_initialize' | 'awsiot_attach_thing_groups' | 'awsiot_detach_thing_groups' | 'cancel_password_change' | 'file_from_device' | 'file_to_device' | 'heartbeat' | 'log_level' | 'log_upload' | 'lwm2m_request' | 'lwm2m_file' | 'restore_backup' | 'reboot' | 'reset' | 'send_config' | 'setting' | 'setting_fetch' | 'software_update' | 'status';
3
3
  export declare type CommandType = 'download' | 'fileupload' | 'filedownload' | 'execute' | 'observe' | 'observe_stop' | 'read' | 'upload' | 'write';
4
4
  export interface CommandSchedule {
5
5
  start_datetime: string;
@@ -27,6 +27,7 @@ export interface GatewayCommandRequest {
27
27
  type?: CommandType;
28
28
  filepath?: string;
29
29
  file_id?: string;
30
+ configuration_id?: string;
30
31
  }
31
32
  export interface Lwm2mRequest extends GatewayCommandRequest {
32
33
  type: CommandType;
@@ -3,6 +3,7 @@ import { SettingFilters, Setting, SettingInput, PaginatedSettings } from './mode
3
3
  import { Device } from '../devices/models';
4
4
  import { DeviceType } from '../deviceTypes/models';
5
5
  interface SettingsInterface extends BaseModelInterface<Setting, SettingInput, SettingFilters, PaginatedSettings> {
6
+ getOneById(id: string, version?: number): Promise<Setting>;
6
7
  update(setting: Setting): Promise<Setting>;
7
8
  getDevices(id: string): Promise<Device[]>;
8
9
  getDeviceTypes(id: string): Promise<DeviceType[]>;
@@ -146,7 +146,7 @@ exports.Settings = (function (_super) {
146
146
  });
147
147
  });
148
148
  };
149
- class_1.getOneById = function (id) {
149
+ class_1.getOneById = function (id, version) {
150
150
  return __awaiter(this, void 0, void 0, function () {
151
151
  var axios, result, error_4;
152
152
  return __generator(this, function (_a) {
@@ -155,7 +155,7 @@ exports.Settings = (function (_super) {
155
155
  _a.trys.push([0, 2, , 3]);
156
156
  this.logAction("Getting setting with id: " + id);
157
157
  axios = __1.EdgeIQAPI.getAxios();
158
- return [4, axios.get(constants_1.Endpoints.setting + "/" + id)];
158
+ return [4, axios.get(constants_1.Endpoints.setting + "/" + id + (version ? "?version=" + version : ''))];
159
159
  case 1:
160
160
  result = _a.sent();
161
161
  return [2, result === null || result === void 0 ? void 0 : result.data];
@@ -14,6 +14,7 @@ export interface Setting extends SettingInput, Base {
14
14
  export interface SettingFilters extends Filters {
15
15
  name?: Filter;
16
16
  configuration_id?: Filter;
17
+ version?: Filter;
17
18
  }
18
19
  export interface PaginatedSettings {
19
20
  settings: Setting[];
@@ -57,7 +57,7 @@ var SettingApplicationRecords = {
57
57
  case 1:
58
58
  result = _e.sent();
59
59
  return [2, {
60
- settingsApplicationRecord: (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.resources,
60
+ settingsApplicationRecords: (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.resources,
61
61
  pagination: {
62
62
  page: (_b = result === null || result === void 0 ? void 0 : result.data) === null || _b === void 0 ? void 0 : _b.page,
63
63
  itemsPerPage: (_c = result === null || result === void 0 ? void 0 : result.data) === null || _c === void 0 ? void 0 : _c.per_page,
@@ -4,8 +4,9 @@ import { Command } from '../commands/models';
4
4
  import { CommandExecution } from '../commandExecutions/models';
5
5
  import { Device } from '../devices/models';
6
6
  import { Setting } from '../settings/models';
7
+ export declare type SettingsApplicationRecordType = 'sent' | 'reported';
7
8
  export interface SettingsApplicationRecord extends Base {
8
- settings_id: string;
9
+ setting_id: string;
9
10
  gateway_command_id: string;
10
11
  configuration_id: string;
11
12
  configuration: Configuration;
@@ -14,15 +15,18 @@ export interface SettingsApplicationRecord extends Base {
14
15
  device_id: string;
15
16
  device: Device;
16
17
  setting: Setting;
17
- size: number;
18
+ version: number;
19
+ type: SettingsApplicationRecordType;
18
20
  }
19
21
  export interface SettingsApplicationRecordFilters extends Filters {
20
22
  settings_id?: Filter;
21
23
  gateway_command_id?: Filter;
22
24
  device_id?: Filter;
23
25
  configuration_id?: Filter;
26
+ version?: Filter;
27
+ type?: Filter;
24
28
  }
25
29
  export interface PaginatedSettingsApplicationRecord {
26
- settingsApplicationRecord: SettingsApplicationRecord[];
30
+ settingsApplicationRecords: SettingsApplicationRecord[];
27
31
  pagination: Pagination;
28
32
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@edgeiq/edgeiq-api-js",
3
- "version": "1.6.6",
3
+ "version": "1.6.8",
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,278 +0,0 @@
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.DeviceFiles = 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.DeviceFiles = (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 (file) {
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 file with unique ID: " + file);
73
- axios = __1.EdgeIQAPI.getAxios();
74
- data = JSON.stringify(file);
75
- return [4, axios.post(constants_1.Endpoints.file, 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 (file) {
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 file with ID: " + file._id);
98
- axios = __1.EdgeIQAPI.getAxios();
99
- data = JSON.stringify(file);
100
- return [4, axios.put(constants_1.Endpoints.file + "/" + file._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 files 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.file, {
126
- params: (0, filtersParser_1.parseFilters)(filters, pagination),
127
- })];
128
- case 1:
129
- result = _e.sent();
130
- return [2, {
131
- files: (_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 file with id: " + id);
157
- axios = __1.EdgeIQAPI.getAxios();
158
- return [4, axios.get(constants_1.Endpoints.file + "/" + 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 file with id " + id);
181
- axios = __1.EdgeIQAPI.getAxios();
182
- return [4, axios.delete(constants_1.Endpoints.file + "/" + id)];
183
- case 1:
184
- _a.sent();
185
- return [2, (0, helpers_1.getReturnDeleteMessage)('file')];
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.uploadFile = function (id, file) {
198
- return __awaiter(this, void 0, void 0, function () {
199
- var axios, form, 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("Uploading file to device");
205
- 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
- },
212
- })];
213
- case 1:
214
- result = _a.sent();
215
- return [2, result === null || result === void 0 ? void 0 : result.data];
216
- case 2:
217
- error_6 = _a.sent();
218
- if ((0, helpers_1.isApiError)(error_6)) {
219
- throw error_6;
220
- }
221
- throw error_6;
222
- case 3: return [2];
223
- }
224
- });
225
- });
226
- };
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
- return class_1;
278
- }(ModelClass_1.BaseModelClass));
@@ -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,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -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 });