@edgeiq/edgeiq-api-js 1.3.58 → 1.3.60

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 (204) 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 +159 -143
  4. package/dist/__tests__/command.test.d.ts +1 -1
  5. package/dist/__tests__/command.test.js +212 -212
  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 +232 -232
  14. package/dist/__tests__/discoveredDevice.test.d.ts +1 -1
  15. package/dist/__tests__/discoveredDevice.test.js +155 -155
  16. package/dist/__tests__/files.test.d.ts +1 -1
  17. package/dist/__tests__/files.test.js +162 -162
  18. package/dist/__tests__/ingestors.test.d.ts +1 -1
  19. package/dist/__tests__/ingestors.test.js +198 -198
  20. package/dist/__tests__/integrations.test.d.ts +1 -1
  21. package/dist/__tests__/integrations.test.js +211 -211
  22. package/dist/__tests__/notifications.test.d.ts +1 -1
  23. package/dist/__tests__/notifications.test.js +72 -72
  24. package/dist/__tests__/pollableAttributes.test.d.ts +1 -1
  25. package/dist/__tests__/pollableAttributes.test.js +172 -172
  26. package/dist/__tests__/rules.test.d.ts +1 -1
  27. package/dist/__tests__/rules.test.js +172 -172
  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 +9 -8
  33. package/dist/auth/index.js +183 -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/commandExecutions/index.d.ts +8 -8
  39. package/dist/commandExecutions/index.js +220 -220
  40. package/dist/commandExecutions/models.d.ts +25 -25
  41. package/dist/commandExecutions/models.js +2 -2
  42. package/dist/commands/index.d.ts +21 -21
  43. package/dist/commands/index.js +378 -378
  44. package/dist/commands/models.d.ts +40 -40
  45. package/dist/commands/models.js +16 -16
  46. package/dist/companies/index.d.ts +7 -7
  47. package/dist/companies/index.js +222 -222
  48. package/dist/companies/models.d.ts +110 -110
  49. package/dist/companies/models.js +2 -2
  50. package/dist/configurations/index.d.ts +9 -9
  51. package/dist/configurations/index.js +223 -223
  52. package/dist/configurations/models.d.ts +34 -34
  53. package/dist/configurations/models.js +2 -2
  54. package/dist/constants.d.ts +153 -152
  55. package/dist/constants.js +169 -168
  56. package/dist/core/ModelClass.d.ts +13 -13
  57. package/dist/core/ModelClass.js +19 -19
  58. package/dist/core/handleResponseError.d.ts +2 -2
  59. package/dist/core/handleResponseError.js +167 -167
  60. package/dist/core/index.d.ts +19 -19
  61. package/dist/core/index.js +63 -63
  62. package/dist/deviceConfigs/index.d.ts +9 -9
  63. package/dist/deviceConfigs/index.js +224 -224
  64. package/dist/deviceConfigs/models.d.ts +38 -38
  65. package/dist/deviceConfigs/models.js +2 -2
  66. package/dist/deviceErrors/index.d.ts +8 -8
  67. package/dist/deviceErrors/index.js +124 -124
  68. package/dist/deviceErrors/models.d.ts +19 -19
  69. package/dist/deviceErrors/models.js +2 -2
  70. package/dist/deviceLocationObservations/index.d.ts +5 -5
  71. package/dist/deviceLocationObservations/index.js +189 -189
  72. package/dist/deviceLocationObservations/models.d.ts +26 -26
  73. package/dist/deviceLocationObservations/models.js +2 -2
  74. package/dist/deviceTemplates/index.d.ts +9 -9
  75. package/dist/deviceTemplates/index.js +226 -226
  76. package/dist/deviceTemplates/models.d.ts +36 -36
  77. package/dist/deviceTemplates/models.js +2 -2
  78. package/dist/deviceTransferRequests/index.d.ts +10 -10
  79. package/dist/deviceTransferRequests/index.js +247 -247
  80. package/dist/deviceTransferRequests/models.d.ts +26 -26
  81. package/dist/deviceTransferRequests/models.js +2 -2
  82. package/dist/deviceTypes/index.d.ts +20 -20
  83. package/dist/deviceTypes/index.js +464 -464
  84. package/dist/deviceTypes/models.d.ts +108 -108
  85. package/dist/deviceTypes/models.js +2 -2
  86. package/dist/devices/index.d.ts +32 -32
  87. package/dist/devices/index.js +730 -730
  88. package/dist/devices/models.d.ts +124 -124
  89. package/dist/devices/models.js +2 -2
  90. package/dist/discoveredDevices/index.d.ts +15 -15
  91. package/dist/discoveredDevices/index.js +361 -361
  92. package/dist/discoveredDevices/models.d.ts +41 -41
  93. package/dist/discoveredDevices/models.js +2 -2
  94. package/dist/downstreamSystems/index.d.ts +7 -7
  95. package/dist/downstreamSystems/index.js +198 -198
  96. package/dist/downstreamSystems/models.d.ts +17 -17
  97. package/dist/downstreamSystems/models.js +2 -2
  98. package/dist/escrowDevices/index.d.ts +9 -9
  99. package/dist/escrowDevices/index.js +224 -224
  100. package/dist/escrowDevices/models.d.ts +30 -30
  101. package/dist/escrowDevices/models.js +2 -2
  102. package/dist/files/index.d.ts +11 -11
  103. package/dist/files/index.js +278 -278
  104. package/dist/files/models.d.ts +20 -20
  105. package/dist/files/models.js +2 -2
  106. package/dist/filtersParser.d.ts +5 -5
  107. package/dist/filtersParser.js +54 -54
  108. package/dist/gatewayCommands/index.d.ts +9 -9
  109. package/dist/gatewayCommands/index.js +224 -224
  110. package/dist/gatewayCommands/models.d.ts +81 -81
  111. package/dist/gatewayCommands/models.js +2 -2
  112. package/dist/helpers.d.ts +3 -3
  113. package/dist/helpers.js +11 -11
  114. package/dist/index.d.ts +74 -74
  115. package/dist/index.js +124 -124
  116. package/dist/ingestors/index.d.ts +9 -9
  117. package/dist/ingestors/index.js +224 -224
  118. package/dist/ingestors/models.d.ts +97 -97
  119. package/dist/ingestors/models.js +2 -2
  120. package/dist/integrations/index.d.ts +10 -10
  121. package/dist/integrations/index.js +340 -340
  122. package/dist/integrations/models.d.ts +76 -76
  123. package/dist/integrations/models.js +2 -2
  124. package/dist/log/models.d.ts +6 -6
  125. package/dist/log/models.js +2 -2
  126. package/dist/lwm2m/index.d.ts +5 -5
  127. package/dist/lwm2m/index.js +71 -71
  128. package/dist/lwm2m/models.d.ts +39 -39
  129. package/dist/lwm2m/models.js +2 -2
  130. package/dist/models/index.d.ts +1893 -1893
  131. package/dist/models/index.js +2 -2
  132. package/dist/models.d.ts +67 -67
  133. package/dist/models.js +2 -2
  134. package/dist/notifications/index.d.ts +8 -8
  135. package/dist/notifications/index.js +124 -124
  136. package/dist/notifications/models.d.ts +19 -19
  137. package/dist/notifications/models.js +2 -2
  138. package/dist/pollableAttributes/index.d.ts +7 -7
  139. package/dist/pollableAttributes/index.js +198 -198
  140. package/dist/pollableAttributes/models.d.ts +49 -49
  141. package/dist/pollableAttributes/models.js +2 -2
  142. package/dist/regions/index.d.ts +5 -5
  143. package/dist/regions/index.js +173 -173
  144. package/dist/regions/models.d.ts +17 -17
  145. package/dist/regions/models.js +2 -2
  146. package/dist/reports/index.d.ts +8 -8
  147. package/dist/reports/index.js +199 -199
  148. package/dist/reports/models.d.ts +25 -25
  149. package/dist/reports/models.js +2 -2
  150. package/dist/rules/index.d.ts +12 -12
  151. package/dist/rules/index.js +272 -272
  152. package/dist/rules/models.d.ts +127 -127
  153. package/dist/rules/models.js +2 -2
  154. package/dist/secrets/index.d.ts +8 -8
  155. package/dist/secrets/index.js +199 -199
  156. package/dist/secrets/models.d.ts +18 -18
  157. package/dist/secrets/models.js +2 -2
  158. package/dist/settings/index.d.ts +7 -7
  159. package/dist/settings/index.js +198 -198
  160. package/dist/settings/models.d.ts +25 -25
  161. package/dist/settings/models.js +2 -2
  162. package/dist/settingsApplicationRecord/index.d.ts +6 -6
  163. package/dist/settingsApplicationRecord/index.js +79 -79
  164. package/dist/settingsApplicationRecord/models.d.ts +28 -28
  165. package/dist/settingsApplicationRecord/models.js +2 -2
  166. package/dist/softwareUpdates/index.d.ts +15 -15
  167. package/dist/softwareUpdates/index.js +374 -374
  168. package/dist/softwareUpdates/models.d.ts +31 -31
  169. package/dist/softwareUpdates/models.js +2 -2
  170. package/dist/stats/index.d.ts +9 -9
  171. package/dist/stats/index.js +140 -140
  172. package/dist/stats/models.d.ts +27 -27
  173. package/dist/stats/models.js +2 -2
  174. package/dist/systemCommandJobs/index.d.ts +5 -5
  175. package/dist/systemCommandJobs/index.js +173 -173
  176. package/dist/systemCommandJobs/models.d.ts +32 -32
  177. package/dist/systemCommandJobs/models.js +2 -2
  178. package/dist/systemCommands/index.d.ts +7 -7
  179. package/dist/systemCommands/index.js +198 -198
  180. package/dist/systemCommands/models.d.ts +32 -32
  181. package/dist/systemCommands/models.js +2 -2
  182. package/dist/testConstants.d.ts +50 -50
  183. package/dist/testConstants.js +331 -331
  184. package/dist/translators/index.d.ts +9 -9
  185. package/dist/translators/index.js +224 -224
  186. package/dist/translators/models.d.ts +21 -21
  187. package/dist/translators/models.js +2 -2
  188. package/dist/userTypes/index.d.ts +7 -7
  189. package/dist/userTypes/index.js +198 -198
  190. package/dist/userTypes/models.d.ts +79 -79
  191. package/dist/userTypes/models.js +2 -2
  192. package/dist/users/index.d.ts +12 -12
  193. package/dist/users/index.js +300 -300
  194. package/dist/users/models.d.ts +42 -41
  195. package/dist/users/models.js +2 -2
  196. package/package.json +56 -56
  197. package/dist/__tests__/testConstants.d.ts +0 -7
  198. package/dist/__tests__/testConstants.js +0 -14
  199. package/dist/example/index.d.ts +0 -1
  200. package/dist/example/index.js +0 -5
  201. package/dist/lwm2mState/index.d.ts +0 -5
  202. package/dist/lwm2mState/index.js +0 -71
  203. package/dist/lwm2mState/models.d.ts +0 -10
  204. package/dist/lwm2mState/models.js +0 -2
@@ -1,127 +1,127 @@
1
- import { Base, Filter, Filters, Pagination } from '../models';
2
- export declare type RuleConditionType = 'true' | 'false' | 'equal' | 'not_equal' | 'less_than' | 'less_than_equal' | 'greater_than' | 'greater_than_equal' | 'in' | 'not_in' | 'moving_average' | 'value_changed' | 'device_error' | 'status_changed' | 'heartbeat_status_changed' | 'device_location_transition' | 'and' | 'or';
3
- export declare type DeviceErrorType = 'system' | 'rule_action' | 'config' | 'aws_iot' | 'aws_greengrass_iot' | 'azure_iot' | 'bluemix_iot';
4
- export declare type RuleActionType = 'aws_iot' | 'aws_iot_publish' | 'azure_iot' | 'create_device_health_status_event' | 'create_device_location_observation' | 'disable_data_restriction' | 'email' | 'enable_data_restriction' | 'greengrass_restart' | 'http_request' | 'mqtt' | 'notification' | 'relay' | 'sms' | 'tcp' | 'update_device_metadata' | 'workflow';
5
- export declare type RuleActionBodyType = 'html' | 'text';
6
- export declare type LocationVia = 'gps' | 'cell_tower' | 'bluetooth' | 'wifi' | 'other';
7
- export declare type GeneratedAtFormat = 'rfc3339' | 'unix_timestamp';
8
- export declare type LocationTransitionDirectionType = 'arriving' | 'leaving';
9
- export declare type DerivedValuesTypes = 'count' | 'min' | 'max' | 'avg' | 'sum' | 'convert_indexed_keys';
10
- export declare type WhereConditionTypes = 'where' | 'or_where';
11
- export declare type WhereConditionOperators = 'equal' | 'not_equal' | 'greater_than' | 'greater_than_equal' | 'less_than' | 'less_than_equal' | 'in' | 'not_in' | 'starts_with' | 'ends_with' | 'contains' | 'strict_contains' | 'length_equals' | 'length_not_equals' | 'length_greater_than' | 'length_greater_than_equal' | 'length_less_than' | 'length_less_than_equal';
12
- export interface CredentialData {
13
- type?: string;
14
- value: string;
15
- secret_id: string;
16
- }
17
- export interface Credentials {
18
- type: string;
19
- data: {
20
- [key: string]: CredentialData;
21
- };
22
- }
23
- export interface PRTGChannel {
24
- name?: string;
25
- value?: string;
26
- type?: string;
27
- default?: number;
28
- enum?: {
29
- [key: string]: number;
30
- };
31
- }
32
- export interface RuleAction {
33
- action_frequency?: unknown;
34
- body_template?: string;
35
- body_type?: RuleActionBodyType;
36
- clear?: boolean;
37
- client_id?: string;
38
- credentials?: Credentials;
39
- integration_id?: string;
40
- last_run?: string;
41
- password?: string;
42
- retries?: number;
43
- retry_timeout: number;
44
- send_to?: string;
45
- subject?: string;
46
- topic?: string;
47
- type: RuleActionType;
48
- url?: string;
49
- username?: string;
50
- will_topic?: string;
51
- keep_alive?: boolean;
52
- method?: string;
53
- headers?: {
54
- [key: string]: string;
55
- };
56
- from?: string;
57
- metadata_key?: string;
58
- health_status?: string;
59
- latitude_template?: string;
60
- longitude_template?: string;
61
- radius_template?: string;
62
- generated_at_template?: string;
63
- generated_at_format?: GeneratedAtFormat;
64
- location_via?: LocationVia;
65
- channels?: PRTGChannel[];
66
- definition_id?: string;
67
- }
68
- export interface WhereCondition {
69
- type?: WhereConditionTypes;
70
- operator?: WhereConditionOperators;
71
- property?: string;
72
- value?: string | string[];
73
- }
74
- export interface DerivedValue {
75
- name?: string;
76
- type?: DerivedValuesTypes;
77
- property?: string;
78
- properties?: string[];
79
- data_set?: string;
80
- where_conditions?: WhereCondition[];
81
- }
82
- export interface RuleCondition {
83
- type: RuleConditionType;
84
- property?: string;
85
- value?: string[];
86
- value_type?: string;
87
- rule_conditions?: (RuleCondition | undefined)[];
88
- error_type?: DeviceErrorType;
89
- location_transition_evaluator?: LocationTransitionEvaluator;
90
- cold_start_trigger?: boolean;
91
- derived_values?: DerivedValue[];
92
- }
93
- export interface LocationTransitionEvaluator {
94
- region_id: string;
95
- direction: LocationTransitionDirectionType;
96
- num_observations_to_consider: number;
97
- required_num_breaching_observations: number;
98
- confidence_threshold: number;
99
- allow_breach_on_initial_observation: boolean;
100
- }
101
- export interface RuleInput {
102
- active: boolean;
103
- description: string;
104
- company_id: string;
105
- then_actions: (RuleAction | undefined)[];
106
- else_actions: (RuleAction | undefined)[];
107
- rule_condition: RuleCondition;
108
- cloud_rule: boolean;
109
- }
110
- export interface Rule extends Base, RuleInput {
111
- last_run_status: number;
112
- plain_english: string;
113
- pass_count: number;
114
- fail_count: number;
115
- scheduled_only?: boolean;
116
- schedule?: string;
117
- scheduler_job_id?: string;
118
- }
119
- export interface RulesFilters extends Filters {
120
- description?: Filter;
121
- active?: Filter;
122
- cloud_rule?: Filter;
123
- }
124
- export interface PaginatedRules {
125
- rules: Rule[];
126
- pagination: Pagination;
127
- }
1
+ import { Base, Filter, Filters, Pagination } from '../models';
2
+ export declare type RuleConditionType = 'true' | 'false' | 'equal' | 'not_equal' | 'less_than' | 'less_than_equal' | 'greater_than' | 'greater_than_equal' | 'in' | 'not_in' | 'moving_average' | 'value_changed' | 'device_error' | 'status_changed' | 'heartbeat_status_changed' | 'device_location_transition' | 'and' | 'or';
3
+ export declare type DeviceErrorType = 'system' | 'rule_action' | 'config' | 'aws_iot' | 'aws_greengrass_iot' | 'azure_iot' | 'bluemix_iot';
4
+ export declare type RuleActionType = 'aws_iot' | 'aws_iot_publish' | 'azure_iot' | 'create_device_health_status_event' | 'create_device_location_observation' | 'disable_data_restriction' | 'email' | 'enable_data_restriction' | 'greengrass_restart' | 'http_request' | 'mqtt' | 'notification' | 'relay' | 'sms' | 'tcp' | 'update_device_metadata' | 'workflow';
5
+ export declare type RuleActionBodyType = 'html' | 'text';
6
+ export declare type LocationVia = 'gps' | 'cell_tower' | 'bluetooth' | 'wifi' | 'other';
7
+ export declare type GeneratedAtFormat = 'rfc3339' | 'unix_timestamp';
8
+ export declare type LocationTransitionDirectionType = 'arriving' | 'leaving';
9
+ export declare type DerivedValuesTypes = 'count' | 'min' | 'max' | 'avg' | 'sum' | 'convert_indexed_keys';
10
+ export declare type WhereConditionTypes = 'where' | 'or_where';
11
+ export declare type WhereConditionOperators = 'equal' | 'not_equal' | 'greater_than' | 'greater_than_equal' | 'less_than' | 'less_than_equal' | 'in' | 'not_in' | 'starts_with' | 'ends_with' | 'contains' | 'strict_contains' | 'length_equals' | 'length_not_equals' | 'length_greater_than' | 'length_greater_than_equal' | 'length_less_than' | 'length_less_than_equal';
12
+ export interface CredentialData {
13
+ type?: string;
14
+ value: string;
15
+ secret_id: string;
16
+ }
17
+ export interface Credentials {
18
+ type: string;
19
+ data: {
20
+ [key: string]: CredentialData;
21
+ };
22
+ }
23
+ export interface PRTGChannel {
24
+ name?: string;
25
+ value?: string;
26
+ type?: string;
27
+ default?: number;
28
+ enum?: {
29
+ [key: string]: number;
30
+ };
31
+ }
32
+ export interface RuleAction {
33
+ action_frequency?: unknown;
34
+ body_template?: string;
35
+ body_type?: RuleActionBodyType;
36
+ clear?: boolean;
37
+ client_id?: string;
38
+ credentials?: Credentials;
39
+ integration_id?: string;
40
+ last_run?: string;
41
+ password?: string;
42
+ retries?: number;
43
+ retry_timeout: number;
44
+ send_to?: string;
45
+ subject?: string;
46
+ topic?: string;
47
+ type: RuleActionType;
48
+ url?: string;
49
+ username?: string;
50
+ will_topic?: string;
51
+ keep_alive?: boolean;
52
+ method?: string;
53
+ headers?: {
54
+ [key: string]: string;
55
+ };
56
+ from?: string;
57
+ metadata_key?: string;
58
+ health_status?: string;
59
+ latitude_template?: string;
60
+ longitude_template?: string;
61
+ radius_template?: string;
62
+ generated_at_template?: string;
63
+ generated_at_format?: GeneratedAtFormat;
64
+ location_via?: LocationVia;
65
+ channels?: PRTGChannel[];
66
+ definition_id?: string;
67
+ }
68
+ export interface WhereCondition {
69
+ type?: WhereConditionTypes;
70
+ operator?: WhereConditionOperators;
71
+ property?: string;
72
+ value?: string | string[];
73
+ }
74
+ export interface DerivedValue {
75
+ name?: string;
76
+ type?: DerivedValuesTypes;
77
+ property?: string;
78
+ properties?: string[];
79
+ data_set?: string;
80
+ where_conditions?: WhereCondition[];
81
+ }
82
+ export interface RuleCondition {
83
+ type: RuleConditionType;
84
+ property?: string;
85
+ value?: string[];
86
+ value_type?: string;
87
+ rule_conditions?: (RuleCondition | undefined)[];
88
+ error_type?: DeviceErrorType;
89
+ location_transition_evaluator?: LocationTransitionEvaluator;
90
+ cold_start_trigger?: boolean;
91
+ derived_values?: DerivedValue[];
92
+ }
93
+ export interface LocationTransitionEvaluator {
94
+ region_id: string;
95
+ direction: LocationTransitionDirectionType;
96
+ num_observations_to_consider: number;
97
+ required_num_breaching_observations: number;
98
+ confidence_threshold: number;
99
+ allow_breach_on_initial_observation: boolean;
100
+ }
101
+ export interface RuleInput {
102
+ active: boolean;
103
+ description: string;
104
+ company_id: string;
105
+ then_actions: (RuleAction | undefined)[];
106
+ else_actions: (RuleAction | undefined)[];
107
+ rule_condition: RuleCondition;
108
+ cloud_rule: boolean;
109
+ }
110
+ export interface Rule extends Base, RuleInput {
111
+ last_run_status: number;
112
+ plain_english: string;
113
+ pass_count: number;
114
+ fail_count: number;
115
+ scheduled_only?: boolean;
116
+ schedule?: string;
117
+ scheduler_job_id?: string;
118
+ }
119
+ export interface RulesFilters extends Filters {
120
+ description?: Filter;
121
+ active?: Filter;
122
+ cloud_rule?: Filter;
123
+ }
124
+ export interface PaginatedRules {
125
+ rules: Rule[];
126
+ pagination: Pagination;
127
+ }
@@ -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,8 +1,8 @@
1
- import { BaseModelInterface } from '../core/ModelClass';
2
- import { BulkActionResponse } from '../models';
3
- import { Secret, SecretInput, SecretsFilters, PaginatedSecrets } from './models';
4
- interface SecretsInterface extends BaseModelInterface<Secret, SecretInput, SecretsFilters, PaginatedSecrets> {
5
- deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
6
- }
7
- export declare const Secrets: SecretsInterface;
8
- export {};
1
+ import { BaseModelInterface } from '../core/ModelClass';
2
+ import { BulkActionResponse } from '../models';
3
+ import { Secret, SecretInput, SecretsFilters, PaginatedSecrets } from './models';
4
+ interface SecretsInterface extends BaseModelInterface<Secret, SecretInput, SecretsFilters, PaginatedSecrets> {
5
+ deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
6
+ }
7
+ export declare const Secrets: SecretsInterface;
8
+ export {};