@edgeiq/edgeiq-api-js 1.3.15 → 1.3.18

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