@edgeiq/edgeiq-api-js 1.3.68 → 1.3.70
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.
- package/README.md +55 -55
- package/dist/__tests__/auth.test.d.ts +1 -1
- package/dist/__tests__/auth.test.js +159 -159
- package/dist/__tests__/command.test.d.ts +1 -1
- package/dist/__tests__/command.test.js +212 -212
- package/dist/__tests__/companies.test.d.ts +1 -1
- package/dist/__tests__/companies.test.js +196 -196
- package/dist/__tests__/deviceErrors.test.d.ts +1 -1
- package/dist/__tests__/deviceErrors.test.js +72 -72
- package/dist/__tests__/deviceTypes.test.d.ts +1 -1
- package/dist/__tests__/deviceTypes.test.js +172 -172
- package/dist/__tests__/devices.test.d.ts +1 -1
- package/dist/__tests__/devices.test.js +232 -232
- package/dist/__tests__/discoveredDevice.test.d.ts +1 -1
- package/dist/__tests__/discoveredDevice.test.js +155 -155
- package/dist/__tests__/files.test.d.ts +1 -1
- package/dist/__tests__/files.test.js +162 -162
- package/dist/__tests__/ingestors.test.d.ts +1 -1
- package/dist/__tests__/ingestors.test.js +198 -198
- package/dist/__tests__/integrations.test.d.ts +1 -1
- package/dist/__tests__/integrations.test.js +211 -211
- package/dist/__tests__/lwm2m.test.d.ts +1 -1
- package/dist/__tests__/lwm2m.test.js +73 -73
- package/dist/__tests__/notifications.test.d.ts +1 -1
- package/dist/__tests__/notifications.test.js +72 -72
- package/dist/__tests__/pollableAttributes.test.d.ts +1 -1
- package/dist/__tests__/pollableAttributes.test.js +172 -172
- package/dist/__tests__/rules.test.d.ts +1 -1
- package/dist/__tests__/rules.test.js +172 -172
- package/dist/__tests__/testConstants.d.ts +7 -0
- package/dist/__tests__/testConstants.js +14 -0
- package/dist/__tests__/translators.test.d.ts +1 -1
- package/dist/__tests__/translators.test.js +172 -172
- package/dist/__tests__/users.test.d.ts +1 -1
- package/dist/__tests__/users.test.js +208 -208
- package/dist/auth/index.d.ts +9 -9
- package/dist/auth/index.js +183 -183
- package/dist/bulkResponses/index.d.ts +8 -8
- package/dist/bulkResponses/index.js +124 -124
- package/dist/bulkResponses/models.d.ts +43 -43
- package/dist/bulkResponses/models.js +2 -2
- package/dist/commandExecutions/index.d.ts +8 -8
- package/dist/commandExecutions/index.js +220 -220
- package/dist/commandExecutions/models.d.ts +25 -25
- package/dist/commandExecutions/models.js +2 -2
- package/dist/commands/index.d.ts +18 -18
- package/dist/commands/index.js +378 -378
- package/dist/commands/models.d.ts +41 -41
- package/dist/commands/models.js +16 -16
- package/dist/companies/index.d.ts +7 -7
- package/dist/companies/index.js +222 -222
- package/dist/companies/models.d.ts +110 -110
- package/dist/companies/models.js +2 -2
- package/dist/configurations/index.d.ts +9 -9
- package/dist/configurations/index.js +223 -223
- package/dist/configurations/models.d.ts +34 -34
- package/dist/configurations/models.js +2 -2
- package/dist/constants.d.ts +153 -153
- package/dist/constants.js +169 -169
- package/dist/core/ModelClass.d.ts +13 -13
- package/dist/core/ModelClass.js +19 -19
- package/dist/core/handleResponseError.d.ts +2 -2
- package/dist/core/handleResponseError.js +167 -167
- package/dist/core/index.d.ts +19 -19
- package/dist/core/index.js +63 -63
- package/dist/deviceConfigs/index.d.ts +9 -9
- package/dist/deviceConfigs/index.js +224 -224
- package/dist/deviceConfigs/models.d.ts +38 -38
- package/dist/deviceConfigs/models.js +2 -2
- package/dist/deviceErrors/index.d.ts +8 -8
- package/dist/deviceErrors/index.js +124 -124
- package/dist/deviceErrors/models.d.ts +19 -19
- package/dist/deviceErrors/models.js +2 -2
- package/dist/deviceLocationObservations/index.d.ts +5 -5
- package/dist/deviceLocationObservations/index.js +189 -189
- package/dist/deviceLocationObservations/models.d.ts +26 -26
- package/dist/deviceLocationObservations/models.js +2 -2
- package/dist/deviceTemplates/index.d.ts +9 -9
- package/dist/deviceTemplates/index.js +226 -226
- package/dist/deviceTemplates/models.d.ts +36 -36
- package/dist/deviceTemplates/models.js +2 -2
- package/dist/deviceTransferRequests/index.d.ts +10 -10
- package/dist/deviceTransferRequests/index.js +247 -247
- package/dist/deviceTransferRequests/models.d.ts +26 -26
- package/dist/deviceTransferRequests/models.js +2 -2
- package/dist/deviceTypes/index.d.ts +20 -20
- package/dist/deviceTypes/index.js +464 -464
- package/dist/deviceTypes/models.d.ts +109 -109
- package/dist/deviceTypes/models.js +2 -2
- package/dist/devices/index.d.ts +32 -32
- package/dist/devices/index.js +730 -730
- package/dist/devices/models.d.ts +126 -126
- package/dist/devices/models.js +2 -2
- package/dist/discoveredDevices/index.d.ts +15 -15
- package/dist/discoveredDevices/index.js +361 -361
- package/dist/discoveredDevices/models.d.ts +41 -41
- package/dist/discoveredDevices/models.js +2 -2
- package/dist/downstreamSystems/index.d.ts +7 -7
- package/dist/downstreamSystems/index.js +198 -198
- package/dist/downstreamSystems/models.d.ts +17 -17
- package/dist/downstreamSystems/models.js +2 -2
- package/dist/escrowDevices/index.d.ts +9 -9
- package/dist/escrowDevices/index.js +224 -224
- package/dist/escrowDevices/models.d.ts +32 -32
- package/dist/escrowDevices/models.js +2 -2
- package/dist/example/index.d.ts +1 -0
- package/dist/example/index.js +5 -0
- package/dist/files/index.d.ts +11 -11
- package/dist/files/index.js +278 -278
- package/dist/files/models.d.ts +20 -20
- package/dist/files/models.js +2 -2
- package/dist/filtersParser.d.ts +5 -5
- package/dist/filtersParser.js +54 -54
- package/dist/gatewayCommands/index.d.ts +9 -9
- package/dist/gatewayCommands/index.js +224 -224
- package/dist/gatewayCommands/models.d.ts +81 -81
- package/dist/gatewayCommands/models.js +2 -2
- package/dist/helpers.d.ts +3 -3
- package/dist/helpers.js +11 -11
- package/dist/index.d.ts +74 -74
- package/dist/index.js +124 -124
- package/dist/ingestors/index.d.ts +9 -9
- package/dist/ingestors/index.js +224 -224
- package/dist/ingestors/models.d.ts +97 -97
- package/dist/ingestors/models.js +2 -2
- package/dist/integrations/index.d.ts +10 -10
- package/dist/integrations/index.js +340 -340
- package/dist/integrations/models.d.ts +76 -76
- package/dist/integrations/models.js +2 -2
- package/dist/log/models.d.ts +6 -6
- package/dist/log/models.js +2 -2
- package/dist/lwm2m/index.d.ts +5 -5
- package/dist/lwm2m/index.js +84 -84
- package/dist/lwm2m/models.d.ts +68 -68
- package/dist/lwm2m/models.js +2 -2
- package/dist/lwm2mState/index.d.ts +5 -0
- package/dist/lwm2mState/index.js +71 -0
- package/dist/lwm2mState/models.d.ts +10 -0
- package/dist/lwm2mState/models.js +2 -0
- package/dist/models/index.d.ts +1893 -1893
- package/dist/models/index.js +2 -2
- package/dist/models.d.ts +67 -67
- package/dist/models.js +2 -2
- package/dist/notifications/index.d.ts +8 -8
- package/dist/notifications/index.js +124 -124
- package/dist/notifications/models.d.ts +19 -19
- package/dist/notifications/models.js +2 -2
- package/dist/pollableAttributes/index.d.ts +7 -7
- package/dist/pollableAttributes/index.js +198 -198
- package/dist/pollableAttributes/models.d.ts +49 -49
- package/dist/pollableAttributes/models.js +2 -2
- package/dist/regions/index.d.ts +5 -5
- package/dist/regions/index.js +173 -173
- package/dist/regions/models.d.ts +17 -17
- package/dist/regions/models.js +2 -2
- package/dist/reports/index.d.ts +8 -8
- package/dist/reports/index.js +199 -199
- package/dist/reports/models.d.ts +25 -25
- package/dist/reports/models.js +2 -2
- package/dist/rules/index.d.ts +12 -12
- package/dist/rules/index.js +272 -272
- package/dist/rules/models.d.ts +129 -127
- package/dist/rules/models.js +2 -2
- package/dist/secrets/index.d.ts +8 -8
- package/dist/secrets/index.js +199 -199
- package/dist/secrets/models.d.ts +18 -18
- package/dist/secrets/models.js +2 -2
- package/dist/settings/index.d.ts +7 -7
- package/dist/settings/index.js +198 -198
- package/dist/settings/models.d.ts +25 -25
- package/dist/settings/models.js +2 -2
- package/dist/settingsApplicationRecord/index.d.ts +6 -6
- package/dist/settingsApplicationRecord/index.js +79 -79
- package/dist/settingsApplicationRecord/models.d.ts +28 -28
- package/dist/settingsApplicationRecord/models.js +2 -2
- package/dist/softwareUpdates/index.d.ts +15 -15
- package/dist/softwareUpdates/index.js +374 -374
- package/dist/softwareUpdates/models.d.ts +31 -31
- package/dist/softwareUpdates/models.js +2 -2
- package/dist/stats/index.d.ts +9 -9
- package/dist/stats/index.js +140 -140
- package/dist/stats/models.d.ts +27 -27
- package/dist/stats/models.js +2 -2
- package/dist/systemCommandJobs/index.d.ts +5 -5
- package/dist/systemCommandJobs/index.js +173 -173
- package/dist/systemCommandJobs/models.d.ts +32 -32
- package/dist/systemCommandJobs/models.js +2 -2
- package/dist/systemCommands/index.d.ts +7 -7
- package/dist/systemCommands/index.js +198 -198
- package/dist/systemCommands/models.d.ts +32 -32
- package/dist/systemCommands/models.js +2 -2
- package/dist/testConstants.d.ts +50 -50
- package/dist/testConstants.js +332 -332
- package/dist/translators/index.d.ts +9 -9
- package/dist/translators/index.js +224 -224
- package/dist/translators/models.d.ts +21 -21
- package/dist/translators/models.js +2 -2
- package/dist/userTypes/index.d.ts +7 -7
- package/dist/userTypes/index.js +198 -198
- package/dist/userTypes/models.d.ts +79 -79
- package/dist/userTypes/models.js +2 -2
- package/dist/users/index.d.ts +12 -12
- package/dist/users/index.js +300 -300
- package/dist/users/models.d.ts +42 -42
- package/dist/users/models.js +2 -2
- package/package.json +56 -56
package/dist/rules/models.d.ts
CHANGED
|
@@ -1,127 +1,129 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
export declare type
|
|
4
|
-
export declare type
|
|
5
|
-
export declare type
|
|
6
|
-
export declare type
|
|
7
|
-
export declare type
|
|
8
|
-
export declare type
|
|
9
|
-
export declare type
|
|
10
|
-
export declare type
|
|
11
|
-
export declare type
|
|
12
|
-
export
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
1
|
+
import { Lwm2mRequest } from '../gatewayCommands/models';
|
|
2
|
+
import { Base, Filter, Filters, Pagination } from '../models';
|
|
3
|
+
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';
|
|
4
|
+
export declare type DeviceErrorType = 'system' | 'rule_action' | 'config' | 'aws_iot' | 'aws_greengrass_iot' | 'azure_iot' | 'bluemix_iot';
|
|
5
|
+
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' | 'gateway_command';
|
|
6
|
+
export declare type RuleActionBodyType = 'html' | 'text';
|
|
7
|
+
export declare type LocationVia = 'gps' | 'cell_tower' | 'bluetooth' | 'wifi' | 'other';
|
|
8
|
+
export declare type GeneratedAtFormat = 'rfc3339' | 'unix_timestamp';
|
|
9
|
+
export declare type LocationTransitionDirectionType = 'arriving' | 'leaving';
|
|
10
|
+
export declare type DerivedValuesTypes = 'count' | 'min' | 'max' | 'avg' | 'sum' | 'convert_indexed_keys';
|
|
11
|
+
export declare type WhereConditionTypes = 'where' | 'or_where';
|
|
12
|
+
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';
|
|
13
|
+
export interface CredentialData {
|
|
14
|
+
type?: string;
|
|
15
|
+
value: string;
|
|
16
|
+
secret_id: string;
|
|
17
|
+
}
|
|
18
|
+
export interface Credentials {
|
|
19
|
+
type: string;
|
|
20
|
+
data: {
|
|
21
|
+
[key: string]: CredentialData;
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
export interface PRTGChannel {
|
|
25
|
+
name?: string;
|
|
26
|
+
value?: string;
|
|
27
|
+
type?: string;
|
|
28
|
+
default?: number;
|
|
29
|
+
enum?: {
|
|
30
|
+
[key: string]: number;
|
|
31
|
+
};
|
|
32
|
+
}
|
|
33
|
+
export interface RuleAction {
|
|
34
|
+
action_frequency?: unknown;
|
|
35
|
+
body_template?: string;
|
|
36
|
+
body_type?: RuleActionBodyType;
|
|
37
|
+
clear?: boolean;
|
|
38
|
+
client_id?: string;
|
|
39
|
+
credentials?: Credentials;
|
|
40
|
+
integration_id?: string;
|
|
41
|
+
last_run?: string;
|
|
42
|
+
password?: string;
|
|
43
|
+
retries?: number;
|
|
44
|
+
retry_timeout: number;
|
|
45
|
+
send_to?: string;
|
|
46
|
+
subject?: string;
|
|
47
|
+
topic?: string;
|
|
48
|
+
type: RuleActionType;
|
|
49
|
+
url?: string;
|
|
50
|
+
username?: string;
|
|
51
|
+
will_topic?: string;
|
|
52
|
+
keep_alive?: boolean;
|
|
53
|
+
method?: string;
|
|
54
|
+
headers?: {
|
|
55
|
+
[key: string]: string;
|
|
56
|
+
};
|
|
57
|
+
from?: string;
|
|
58
|
+
metadata_key?: string;
|
|
59
|
+
health_status?: string;
|
|
60
|
+
latitude_template?: string;
|
|
61
|
+
longitude_template?: string;
|
|
62
|
+
radius_template?: string;
|
|
63
|
+
generated_at_template?: string;
|
|
64
|
+
generated_at_format?: GeneratedAtFormat;
|
|
65
|
+
location_via?: LocationVia;
|
|
66
|
+
channels?: PRTGChannel[];
|
|
67
|
+
definition_id?: string;
|
|
68
|
+
request?: Lwm2mRequest;
|
|
69
|
+
}
|
|
70
|
+
export interface WhereCondition {
|
|
71
|
+
type?: WhereConditionTypes;
|
|
72
|
+
operator?: WhereConditionOperators;
|
|
73
|
+
property?: string;
|
|
74
|
+
value?: string | string[];
|
|
75
|
+
}
|
|
76
|
+
export interface DerivedValue {
|
|
77
|
+
name?: string;
|
|
78
|
+
type?: DerivedValuesTypes;
|
|
79
|
+
property?: string;
|
|
80
|
+
properties?: string[];
|
|
81
|
+
data_set?: string;
|
|
82
|
+
where_conditions?: WhereCondition[];
|
|
83
|
+
}
|
|
84
|
+
export interface RuleCondition {
|
|
85
|
+
type: RuleConditionType;
|
|
86
|
+
property?: string;
|
|
87
|
+
value?: string[];
|
|
88
|
+
value_type?: string;
|
|
89
|
+
rule_conditions?: (RuleCondition | undefined)[];
|
|
90
|
+
error_type?: DeviceErrorType;
|
|
91
|
+
location_transition_evaluator?: LocationTransitionEvaluator;
|
|
92
|
+
cold_start_trigger?: boolean;
|
|
93
|
+
derived_values?: DerivedValue[];
|
|
94
|
+
}
|
|
95
|
+
export interface LocationTransitionEvaluator {
|
|
96
|
+
region_id: string;
|
|
97
|
+
direction: LocationTransitionDirectionType;
|
|
98
|
+
num_observations_to_consider: number;
|
|
99
|
+
required_num_breaching_observations: number;
|
|
100
|
+
confidence_threshold: number;
|
|
101
|
+
allow_breach_on_initial_observation: boolean;
|
|
102
|
+
}
|
|
103
|
+
export interface RuleInput {
|
|
104
|
+
active: boolean;
|
|
105
|
+
description: string;
|
|
106
|
+
company_id: string;
|
|
107
|
+
then_actions: (RuleAction | undefined)[];
|
|
108
|
+
else_actions: (RuleAction | undefined)[];
|
|
109
|
+
rule_condition: RuleCondition;
|
|
110
|
+
cloud_rule: boolean;
|
|
111
|
+
}
|
|
112
|
+
export interface Rule extends Base, RuleInput {
|
|
113
|
+
last_run_status: number;
|
|
114
|
+
plain_english: string;
|
|
115
|
+
pass_count: number;
|
|
116
|
+
fail_count: number;
|
|
117
|
+
scheduled_only?: boolean;
|
|
118
|
+
schedule?: string;
|
|
119
|
+
scheduler_job_id?: string;
|
|
120
|
+
}
|
|
121
|
+
export interface RulesFilters extends Filters {
|
|
122
|
+
description?: Filter;
|
|
123
|
+
active?: Filter;
|
|
124
|
+
cloud_rule?: Filter;
|
|
125
|
+
}
|
|
126
|
+
export interface PaginatedRules {
|
|
127
|
+
rules: Rule[];
|
|
128
|
+
pagination: Pagination;
|
|
129
|
+
}
|
package/dist/rules/models.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/dist/secrets/index.d.ts
CHANGED
|
@@ -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 {};
|