@edgeiq/edgeiq-api-js 1.1.8 → 1.2.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 (158) hide show
  1. package/README.md +55 -55
  2. package/dist/__tests__/auth.test.d.ts +1 -1
  3. package/dist/__tests__/auth.test.js +143 -110
  4. package/dist/__tests__/companies.test.d.ts +1 -1
  5. package/dist/__tests__/companies.test.js +196 -196
  6. package/dist/__tests__/deviceTypes.test.d.ts +1 -1
  7. package/dist/__tests__/deviceTypes.test.js +172 -172
  8. package/dist/__tests__/devices.test.d.ts +1 -1
  9. package/dist/__tests__/devices.test.js +204 -204
  10. package/dist/__tests__/discoveredDevice.test.d.ts +1 -0
  11. package/dist/__tests__/discoveredDevice.test.js +126 -0
  12. package/dist/__tests__/ingestors.test.d.ts +1 -1
  13. package/dist/__tests__/ingestors.test.js +172 -172
  14. package/dist/__tests__/integrations.test.d.ts +1 -1
  15. package/dist/__tests__/integrations.test.js +192 -192
  16. package/dist/__tests__/pollableAttributes.test.d.ts +1 -1
  17. package/dist/__tests__/pollableAttributes.test.js +172 -172
  18. package/dist/__tests__/rules.test.d.ts +1 -1
  19. package/dist/__tests__/rules.test.js +172 -172
  20. package/dist/__tests__/translators.test.d.ts +1 -1
  21. package/dist/__tests__/translators.test.js +172 -172
  22. package/dist/__tests__/users.test.d.ts +1 -1
  23. package/dist/__tests__/users.test.js +208 -208
  24. package/dist/auth/index.d.ts +8 -8
  25. package/dist/auth/index.js +158 -147
  26. package/dist/bulkResponses/index.d.ts +8 -8
  27. package/dist/bulkResponses/index.js +124 -124
  28. package/dist/bulkResponses/models.d.ts +43 -43
  29. package/dist/bulkResponses/models.js +2 -2
  30. package/dist/commands/index.d.ts +9 -9
  31. package/dist/commands/index.js +224 -224
  32. package/dist/commands/models.d.ts +28 -28
  33. package/dist/commands/models.js +2 -2
  34. package/dist/companies/index.d.ts +7 -7
  35. package/dist/companies/index.js +198 -198
  36. package/dist/companies/models.d.ts +94 -94
  37. package/dist/companies/models.js +2 -2
  38. package/dist/constants.d.ts +130 -127
  39. package/dist/constants.js +146 -143
  40. package/dist/core/ModelClass.d.ts +13 -13
  41. package/dist/core/ModelClass.js +19 -19
  42. package/dist/core/handleResponseError.d.ts +2 -2
  43. package/dist/core/handleResponseError.js +167 -167
  44. package/dist/core/index.d.ts +19 -19
  45. package/dist/core/index.js +63 -63
  46. package/dist/deviceConfigs/index.d.ts +9 -9
  47. package/dist/deviceConfigs/index.js +224 -224
  48. package/dist/deviceConfigs/models.d.ts +38 -38
  49. package/dist/deviceConfigs/models.js +2 -2
  50. package/dist/deviceLocationObservations/index.d.ts +5 -5
  51. package/dist/deviceLocationObservations/index.js +189 -189
  52. package/dist/deviceLocationObservations/models.d.ts +26 -26
  53. package/dist/deviceLocationObservations/models.js +2 -2
  54. package/dist/deviceTemplates/index.d.ts +9 -9
  55. package/dist/deviceTemplates/index.js +226 -226
  56. package/dist/deviceTemplates/models.d.ts +36 -36
  57. package/dist/deviceTemplates/models.js +2 -2
  58. package/dist/deviceTransferRequests/index.d.ts +7 -7
  59. package/dist/deviceTransferRequests/index.js +198 -198
  60. package/dist/deviceTransferRequests/models.d.ts +26 -26
  61. package/dist/deviceTransferRequests/models.js +2 -2
  62. package/dist/deviceTypes/index.d.ts +19 -19
  63. package/dist/deviceTypes/index.js +440 -440
  64. package/dist/deviceTypes/models.d.ts +104 -104
  65. package/dist/deviceTypes/models.js +2 -2
  66. package/dist/devices/index.d.ts +20 -20
  67. package/dist/devices/index.js +487 -487
  68. package/dist/devices/models.d.ts +114 -114
  69. package/dist/devices/models.js +2 -2
  70. package/dist/discoveredDevices/index.d.ts +14 -0
  71. package/dist/discoveredDevices/index.js +334 -0
  72. package/dist/discoveredDevices/models.d.ts +41 -0
  73. package/dist/discoveredDevices/models.js +2 -0
  74. package/dist/downstreamSystems/index.d.ts +7 -7
  75. package/dist/downstreamSystems/index.js +198 -198
  76. package/dist/downstreamSystems/models.d.ts +17 -17
  77. package/dist/downstreamSystems/models.js +2 -2
  78. package/dist/escrowDevices/index.d.ts +9 -9
  79. package/dist/escrowDevices/index.js +224 -224
  80. package/dist/escrowDevices/models.d.ts +21 -21
  81. package/dist/escrowDevices/models.js +2 -2
  82. package/dist/filtersParser.d.ts +5 -5
  83. package/dist/filtersParser.js +52 -52
  84. package/dist/gatewayCommands/index.d.ts +10 -10
  85. package/dist/gatewayCommands/index.js +261 -261
  86. package/dist/gatewayCommands/models.d.ts +41 -41
  87. package/dist/gatewayCommands/models.js +2 -2
  88. package/dist/helpers.d.ts +3 -3
  89. package/dist/helpers.js +11 -11
  90. package/dist/index.d.ts +56 -54
  91. package/dist/index.js +98 -95
  92. package/dist/ingestors/index.d.ts +9 -9
  93. package/dist/ingestors/index.js +224 -224
  94. package/dist/ingestors/models.d.ts +37 -37
  95. package/dist/ingestors/models.js +2 -2
  96. package/dist/integrations/index.d.ts +9 -9
  97. package/dist/integrations/index.js +306 -306
  98. package/dist/integrations/models.d.ts +61 -61
  99. package/dist/integrations/models.js +2 -2
  100. package/dist/models/index.d.ts +1893 -1893
  101. package/dist/models/index.js +2 -2
  102. package/dist/models.d.ts +67 -67
  103. package/dist/models.js +2 -2
  104. package/dist/pollableAttributes/index.d.ts +7 -7
  105. package/dist/pollableAttributes/index.js +198 -198
  106. package/dist/pollableAttributes/models.d.ts +28 -28
  107. package/dist/pollableAttributes/models.js +2 -2
  108. package/dist/regions/index.d.ts +5 -5
  109. package/dist/regions/index.js +173 -173
  110. package/dist/regions/models.d.ts +17 -17
  111. package/dist/regions/models.js +2 -2
  112. package/dist/reports/index.d.ts +8 -8
  113. package/dist/reports/index.js +199 -199
  114. package/dist/reports/models.d.ts +25 -25
  115. package/dist/reports/models.js +2 -2
  116. package/dist/rules/index.d.ts +9 -9
  117. package/dist/rules/index.js +224 -224
  118. package/dist/rules/models.d.ts +108 -108
  119. package/dist/rules/models.js +2 -2
  120. package/dist/secrets/index.d.ts +5 -5
  121. package/dist/secrets/index.js +173 -173
  122. package/dist/secrets/models.d.ts +16 -16
  123. package/dist/secrets/models.js +2 -2
  124. package/dist/softwareUpdates/index.d.ts +9 -9
  125. package/dist/softwareUpdates/index.js +224 -224
  126. package/dist/softwareUpdates/models.d.ts +22 -22
  127. package/dist/softwareUpdates/models.js +2 -2
  128. package/dist/stats/index.d.ts +8 -8
  129. package/dist/stats/index.js +116 -116
  130. package/dist/stats/models.d.ts +27 -27
  131. package/dist/stats/models.js +2 -2
  132. package/dist/systemCommandJobs/index.d.ts +5 -5
  133. package/dist/systemCommandJobs/index.js +173 -173
  134. package/dist/systemCommandJobs/models.d.ts +32 -32
  135. package/dist/systemCommandJobs/models.js +2 -2
  136. package/dist/systemCommands/index.d.ts +7 -7
  137. package/dist/systemCommands/index.js +198 -198
  138. package/dist/systemCommands/models.d.ts +32 -32
  139. package/dist/systemCommands/models.js +2 -2
  140. package/dist/testConstants.d.ts +44 -42
  141. package/dist/testConstants.js +220 -214
  142. package/dist/translators/index.d.ts +9 -9
  143. package/dist/translators/index.js +224 -224
  144. package/dist/translators/models.d.ts +21 -21
  145. package/dist/translators/models.js +2 -2
  146. package/dist/userTypes/index.d.ts +7 -7
  147. package/dist/userTypes/index.js +198 -198
  148. package/dist/userTypes/models.d.ts +79 -79
  149. package/dist/userTypes/models.js +2 -2
  150. package/dist/users/index.d.ts +10 -10
  151. package/dist/users/index.js +252 -252
  152. package/dist/users/models.d.ts +41 -41
  153. package/dist/users/models.js +2 -2
  154. package/package.json +56 -56
  155. package/dist/__tests__/testConstants.d.ts +0 -7
  156. package/dist/__tests__/testConstants.js +0 -14
  157. package/dist/example/index.d.ts +0 -1
  158. package/dist/example/index.js +0 -5
@@ -1,104 +1,104 @@
1
- import { Base, Filter, Filters, Pagination } from '../models';
2
- export declare type TypeDeviceType = 'gateway' | 'sensor' | 'cloud_native' | 'modem' | 'lwm2m';
3
- export interface NetworkConnection {
4
- type: string;
5
- interface?: string;
6
- name: string;
7
- }
8
- export interface Peripheral {
9
- type: string;
10
- device: string;
11
- }
12
- export interface Firmware {
13
- upgrade: boolean;
14
- backup: boolean;
15
- }
16
- export interface Actions {
17
- sms_at_command_status_request: boolean;
18
- notification: boolean;
19
- enable_data_restriction: boolean;
20
- disable_data_restriction: boolean;
21
- send_config: boolean;
22
- deploy_deployment: boolean;
23
- request_deployment_status: boolean;
24
- data_restore: boolean;
25
- update_edge: boolean;
26
- update_firmware: boolean;
27
- restore_backup: boolean;
28
- backup: boolean;
29
- log_level: boolean;
30
- log_config: boolean;
31
- log_upload: boolean;
32
- reboot: boolean;
33
- reset: boolean;
34
- data_reset: boolean;
35
- heartbeat: boolean;
36
- status: boolean;
37
- software_update: boolean;
38
- provision_marmon_button: boolean;
39
- greengrass_initialize: boolean;
40
- greengrass_restart: boolean;
41
- greengrass_redeploy: boolean;
42
- amag_add_modify_card_holder: boolean;
43
- amag_delete_card_holder: boolean;
44
- activate_cloud_native_device: boolean;
45
- deactivate_cloud_native_device: boolean;
46
- lwm2m_request: boolean;
47
- log: boolean;
48
- sms: boolean;
49
- email: boolean;
50
- relay: boolean;
51
- http_request: boolean;
52
- mqtt: boolean;
53
- aws_iot: boolean;
54
- bluemix_iot: boolean;
55
- azure_iot: boolean;
56
- tcp: boolean;
57
- prtg: boolean;
58
- tcp_modbus: boolean;
59
- opcua: boolean;
60
- bacnet: boolean;
61
- }
62
- export interface SMSATCommands {
63
- status_commands: string[];
64
- send_config_commands: string[];
65
- }
66
- export interface Capabilities {
67
- network_connections: NetworkConnection[];
68
- peripherals: Peripheral[];
69
- iptables: boolean;
70
- firmware: Firmware;
71
- actions?: Actions;
72
- sms_at_commands?: SMSATCommands;
73
- }
74
- export interface DeviceTypeInput {
75
- name: string;
76
- company_id: string;
77
- image?: string;
78
- model: string;
79
- manufacturer: string;
80
- long_description?: string;
81
- type: TypeDeviceType;
82
- capabilities: Capabilities;
83
- heartbeat_values?: string[];
84
- origin_id?: string;
85
- ingestor_ids?: string[];
86
- command_ids?: string[];
87
- software_update_ids?: string[];
88
- metadata?: {
89
- [key: string]: string;
90
- };
91
- }
92
- export interface DeviceType extends DeviceTypeInput, Base {
93
- }
94
- export interface DeviceTypesFilters extends Filters {
95
- name?: Filter;
96
- model?: Filter;
97
- manufacturer?: Filter;
98
- long_description?: string;
99
- type?: Filter;
100
- }
101
- export interface PaginatedDeviceTypes {
102
- deviceTypes: DeviceType[];
103
- pagination: Pagination;
104
- }
1
+ import { Base, Filter, Filters, Pagination } from '../models';
2
+ export declare type TypeDeviceType = 'gateway' | 'sensor' | 'cloud_native' | 'modem' | 'lwm2m';
3
+ export interface NetworkConnection {
4
+ type: string;
5
+ interface?: string;
6
+ name: string;
7
+ }
8
+ export interface Peripheral {
9
+ type: string;
10
+ device: string;
11
+ }
12
+ export interface Firmware {
13
+ upgrade: boolean;
14
+ backup: boolean;
15
+ }
16
+ export interface Actions {
17
+ sms_at_command_status_request: boolean;
18
+ notification: boolean;
19
+ enable_data_restriction: boolean;
20
+ disable_data_restriction: boolean;
21
+ send_config: boolean;
22
+ deploy_deployment: boolean;
23
+ request_deployment_status: boolean;
24
+ data_restore: boolean;
25
+ update_edge: boolean;
26
+ update_firmware: boolean;
27
+ restore_backup: boolean;
28
+ backup: boolean;
29
+ log_level: boolean;
30
+ log_config: boolean;
31
+ log_upload: boolean;
32
+ reboot: boolean;
33
+ reset: boolean;
34
+ data_reset: boolean;
35
+ heartbeat: boolean;
36
+ status: boolean;
37
+ software_update: boolean;
38
+ provision_marmon_button: boolean;
39
+ greengrass_initialize: boolean;
40
+ greengrass_restart: boolean;
41
+ greengrass_redeploy: boolean;
42
+ amag_add_modify_card_holder: boolean;
43
+ amag_delete_card_holder: boolean;
44
+ activate_cloud_native_device: boolean;
45
+ deactivate_cloud_native_device: boolean;
46
+ lwm2m_request: boolean;
47
+ log: boolean;
48
+ sms: boolean;
49
+ email: boolean;
50
+ relay: boolean;
51
+ http_request: boolean;
52
+ mqtt: boolean;
53
+ aws_iot: boolean;
54
+ bluemix_iot: boolean;
55
+ azure_iot: boolean;
56
+ tcp: boolean;
57
+ prtg: boolean;
58
+ tcp_modbus: boolean;
59
+ opcua: boolean;
60
+ bacnet: boolean;
61
+ }
62
+ export interface SMSATCommands {
63
+ status_commands: string[];
64
+ send_config_commands: string[];
65
+ }
66
+ export interface Capabilities {
67
+ network_connections: NetworkConnection[];
68
+ peripherals: Peripheral[];
69
+ iptables: boolean;
70
+ firmware: Firmware;
71
+ actions?: Actions;
72
+ sms_at_commands?: SMSATCommands;
73
+ }
74
+ export interface DeviceTypeInput {
75
+ name: string;
76
+ company_id: string;
77
+ image?: string;
78
+ model: string;
79
+ manufacturer: string;
80
+ long_description?: string;
81
+ type: TypeDeviceType;
82
+ capabilities: Capabilities;
83
+ heartbeat_values?: string[];
84
+ origin_id?: string;
85
+ ingestor_ids?: string[];
86
+ command_ids?: string[];
87
+ software_update_ids?: string[];
88
+ metadata?: {
89
+ [key: string]: string;
90
+ };
91
+ }
92
+ export interface DeviceType extends DeviceTypeInput, Base {
93
+ }
94
+ export interface DeviceTypesFilters extends Filters {
95
+ name?: Filter;
96
+ model?: Filter;
97
+ manufacturer?: Filter;
98
+ long_description?: string;
99
+ type?: Filter;
100
+ }
101
+ export interface PaginatedDeviceTypes {
102
+ deviceTypes: DeviceType[];
103
+ pagination: Pagination;
104
+ }
@@ -1,2 +1,2 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,20 +1,20 @@
1
- import { Ingestor, Rule } from '..';
2
- import { BaseModelInterface } from '../core/ModelClass';
3
- import { BulkActionResponse } from '../models';
4
- import { DevicesFilters, Device, DeviceInput, PaginatedDevices } from './models';
5
- interface DevicesInterface extends BaseModelInterface<Device, DeviceInput, DevicesFilters, PaginatedDevices> {
6
- bulkCreate(uniqueIds: string[], deviceTypeId: string, namePrefix: string): Promise<BulkActionResponse>;
7
- update(device: Device): Promise<Device>;
8
- getOneByUniqueId(uniqueId: string): Promise<Device>;
9
- deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
10
- attachIngestor(id: string, ingestorId: string): Promise<string>;
11
- detachIngestor(id: string, ingestorId: string): Promise<string>;
12
- getIngestors(id: string): Promise<Ingestor[]>;
13
- attachRule(id: string, ruleId: string): Promise<string>;
14
- bulkAttachRules(id: string, rulesIds: string[]): Promise<BulkActionResponse>;
15
- detachRule(id: string, ruleId: string): Promise<string>;
16
- getRules(id: string): Promise<Rule[]>;
17
- csvBulkUpload(file: File): Promise<BulkActionResponse>;
18
- }
19
- export declare const Devices: DevicesInterface;
20
- export {};
1
+ import { Ingestor, Rule } from '..';
2
+ import { BaseModelInterface } from '../core/ModelClass';
3
+ import { BulkActionResponse } from '../models';
4
+ import { DevicesFilters, Device, DeviceInput, PaginatedDevices } from './models';
5
+ interface DevicesInterface extends BaseModelInterface<Device, DeviceInput, DevicesFilters, PaginatedDevices> {
6
+ bulkCreate(uniqueIds: string[], deviceTypeId: string, namePrefix: string): Promise<BulkActionResponse>;
7
+ update(device: Device): Promise<Device>;
8
+ getOneByUniqueId(uniqueId: string): Promise<Device>;
9
+ deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
10
+ attachIngestor(id: string, ingestorId: string): Promise<string>;
11
+ detachIngestor(id: string, ingestorId: string): Promise<string>;
12
+ getIngestors(id: string): Promise<Ingestor[]>;
13
+ attachRule(id: string, ruleId: string): Promise<string>;
14
+ bulkAttachRules(id: string, rulesIds: string[]): Promise<BulkActionResponse>;
15
+ detachRule(id: string, ruleId: string): Promise<string>;
16
+ getRules(id: string): Promise<Rule[]>;
17
+ csvBulkUpload(file: File): Promise<BulkActionResponse>;
18
+ }
19
+ export declare const Devices: DevicesInterface;
20
+ export {};