@qlik/api 2.3.1 → 2.4.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.
- package/analytics/change-stores.d.ts +40 -76
- package/analytics/change-stores.js +9 -10
- package/analytics.d.ts +1 -2
- package/analytics.js +5 -6
- package/api-keys.d.ts +46 -100
- package/api-keys.js +3 -4
- package/apps.d.ts +334 -461
- package/apps.js +74 -6
- package/assistants.d.ts +172 -337
- package/assistants.js +3 -4
- package/audits.d.ts +41 -85
- package/audits.js +3 -4
- package/auth-types.d.ts +110 -1
- package/auth-types.js +22 -1
- package/auth.d.ts +1 -2
- package/auth.js +1 -1
- package/automation-connections.d.ts +44 -95
- package/automation-connections.js +3 -4
- package/automation-connectors.d.ts +10 -20
- package/automation-connectors.js +3 -4
- package/automations.d.ts +54 -112
- package/automations.js +3 -4
- package/automl-deployments.d.ts +17 -36
- package/automl-deployments.js +3 -4
- package/automl-predictions.d.ts +12 -24
- package/automl-predictions.js +3 -4
- package/banners.d.ts +8 -14
- package/banners.js +3 -4
- package/brands.d.ts +19 -39
- package/brands.js +3 -4
- package/chunks/auth-B8lJw7rm.js +31 -0
- package/chunks/{interceptors-2VSXImC9.js → boot-interceptors-DqRxTczb.js} +50 -150
- package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
- package/chunks/{invoke-fetch-CckTK7bh.js → invoke-fetch-DMAi6Fg3.js} +3 -3
- package/chunks/{invoke-fetch-D9lpiAb-.js → invoke-fetch-pMN6iqup.js} +2 -3
- package/chunks/platform-types-CECrZkOF.d.ts +29 -0
- package/chunks/{public-runtime-modules-BqxAMJ9M.js → public-runtime-modules-2KfyI2qM.js} +5 -5
- package/chunks/{qix-DpvHvpx7.js → qix-BdNrIA4s.js} +19 -20
- package/chunks/{qix-chunk-entrypoint-BXZPnE6J.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
- package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
- package/collections.d.ts +67 -144
- package/collections.js +3 -4
- package/conditions.d.ts +87 -190
- package/conditions.js +3 -4
- package/consumption.d.ts +35 -72
- package/consumption.js +3 -4
- package/core/ip-policies.d.ts +43 -93
- package/core/ip-policies.js +5 -6
- package/core.d.ts +1 -2
- package/core.js +5 -6
- package/csp-origins.d.ts +42 -85
- package/csp-origins.js +3 -4
- package/csrf-token.d.ts +6 -11
- package/csrf-token.js +3 -4
- package/data-alerts.d.ts +152 -325
- package/data-alerts.js +3 -4
- package/data-assets.d.ts +16 -31
- package/data-assets.js +3 -4
- package/data-connections.d.ts +123 -257
- package/data-connections.js +3 -4
- package/data-credentials.d.ts +36 -76
- package/data-credentials.js +3 -4
- package/data-files.d.ts +60 -121
- package/data-files.js +3 -4
- package/data-governance/data-products.d.ts +429 -0
- package/data-governance/data-products.js +212 -0
- package/data-governance.d.ts +13 -0
- package/data-governance.js +12 -0
- package/data-qualities.d.ts +11 -25
- package/data-qualities.js +3 -4
- package/data-sets.d.ts +28 -57
- package/data-sets.js +3 -4
- package/data-sources.d.ts +45 -97
- package/data-sources.js +3 -4
- package/data-stores.d.ts +53 -107
- package/data-stores.js +3 -4
- package/dcaas.d.ts +32 -67
- package/dcaas.js +3 -4
- package/di-projects.d.ts +111 -136
- package/di-projects.js +25 -4
- package/direct-access-agents.d.ts +29 -63
- package/direct-access-agents.js +3 -4
- package/encryption.d.ts +28 -59
- package/encryption.js +3 -4
- package/extensions.d.ts +35 -73
- package/extensions.js +3 -4
- package/global-types.d.ts +139 -1
- package/glossaries.d.ts +75 -158
- package/glossaries.js +3 -4
- package/groups.d.ts +58 -125
- package/groups.js +3 -4
- package/identity-providers.d.ts +148 -324
- package/identity-providers.js +3 -4
- package/index.d.ts +18 -4
- package/index.js +64 -19
- package/interceptors.d.ts +2 -3
- package/interceptors.js +104 -2
- package/invoke-fetch-types.d.ts +97 -1
- package/items.d.ts +85 -181
- package/items.js +3 -4
- package/knowledgebases.d.ts +137 -270
- package/knowledgebases.js +3 -4
- package/licenses.d.ts +71 -153
- package/licenses.js +3 -4
- package/lineage-graphs.d.ts +39 -85
- package/lineage-graphs.js +3 -4
- package/ml.d.ts +290 -621
- package/ml.js +3 -4
- package/notes.d.ts +9 -18
- package/notes.js +3 -4
- package/notifications.d.ts +14 -30
- package/notifications.js +3 -4
- package/oauth-clients.d.ts +98 -159
- package/oauth-clients.js +4 -5
- package/oauth-tokens.d.ts +16 -33
- package/oauth-tokens.js +3 -4
- package/package.json +6 -3
- package/qix.d.ts +46 -2
- package/qix.js +2 -3
- package/questions.d.ts +53 -110
- package/questions.js +3 -4
- package/quotas.d.ts +13 -26
- package/quotas.js +3 -4
- package/reload-tasks.d.ts +23 -46
- package/reload-tasks.js +3 -4
- package/reloads.d.ts +26 -52
- package/reloads.js +3 -4
- package/report-templates.d.ts +30 -63
- package/report-templates.js +3 -4
- package/reports.d.ts +111 -238
- package/reports.js +3 -4
- package/roles.d.ts +36 -77
- package/roles.js +3 -4
- package/sharing-tasks.d.ts +201 -427
- package/sharing-tasks.js +3 -4
- package/spaces.d.ts +71 -157
- package/spaces.js +3 -4
- package/tasks.d.ts +76 -164
- package/tasks.js +3 -4
- package/temp-contents.d.ts +17 -35
- package/temp-contents.js +3 -4
- package/tenant-settings.d.ts +298 -0
- package/tenant-settings.js +107 -0
- package/tenants.d.ts +31 -67
- package/tenants.js +3 -4
- package/themes.d.ts +27 -55
- package/themes.js +3 -4
- package/transports.d.ts +46 -106
- package/transports.js +3 -4
- package/ui-config.d.ts +8 -17
- package/ui-config.js +3 -4
- package/users.d.ts +80 -170
- package/users.js +3 -4
- package/web-integrations.d.ts +38 -83
- package/web-integrations.js +3 -4
- package/web-notifications.d.ts +14 -29
- package/web-notifications.js +3 -4
- package/webhooks.d.ts +77 -162
- package/webhooks.js +3 -4
- package/chunks/auth-XusKk8IA.js +0 -32
- package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
- package/chunks/auth-types-h43TVDpB.js +0 -24
- package/chunks/global-types-CEVAJebk.js +0 -1
- /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
- /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
- /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
- /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
package/conditions.d.ts
CHANGED
|
@@ -1,30 +1,23 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
1
|
+
import { ApiCallOptions } from "./invoke-fetch-types.js";
|
|
2
|
+
import "./chunks/invoke-fetch-DFc3yzaj.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/conditions.d.ts
|
|
5
5
|
type APISettings = {
|
|
6
|
-
/** Whether API endpoints for condition manager are enabled */
|
|
7
|
-
"enable-conditions": boolean;
|
|
8
|
-
/** These persisted api settings are only available for this tenant. Extracted from request JWT. */
|
|
6
|
+
/** Whether API endpoints for condition manager are enabled */"enable-conditions": boolean; /** These persisted api settings are only available for this tenant. Extracted from request JWT. */
|
|
9
7
|
readonly tenantId?: string;
|
|
10
8
|
};
|
|
11
9
|
type APISettingsUpload = {
|
|
12
|
-
/** Whether API endpoints for condition manager are enabled */
|
|
13
|
-
"enable-conditions": boolean;
|
|
10
|
+
/** Whether API endpoints for condition manager are enabled */"enable-conditions": boolean;
|
|
14
11
|
};
|
|
15
12
|
type CausalEvent = {
|
|
16
|
-
data?: CausalEventData;
|
|
17
|
-
/** the event id from eventing */
|
|
13
|
+
data?: CausalEventData; /** the event id from eventing */
|
|
18
14
|
eventID?: string;
|
|
19
15
|
extensions?: CausalEventExtensions;
|
|
20
|
-
manualTrigger?: boolean;
|
|
21
|
-
/** the manual trigger id from eventing if present */
|
|
16
|
+
manualTrigger?: boolean; /** the manual trigger id from eventing if present */
|
|
22
17
|
manualTriggerID?: string;
|
|
23
18
|
};
|
|
24
19
|
type CausalEventData = {
|
|
25
|
-
/** the event id from eventing service. */
|
|
26
|
-
eventID?: string;
|
|
27
|
-
/** The time of the last reload */
|
|
20
|
+
/** the event id from eventing service. */eventID?: string; /** The time of the last reload */
|
|
28
21
|
lastReloadTime?: string;
|
|
29
22
|
};
|
|
30
23
|
type CausalEventExtensions = {
|
|
@@ -36,73 +29,49 @@ type CausalEventExtensions = {
|
|
|
36
29
|
* A condition made up of other conditions
|
|
37
30
|
*/
|
|
38
31
|
type CompoundCondition = {
|
|
39
|
-
/** A base condition */
|
|
40
|
-
conditionBase?: ConditionBase;
|
|
41
|
-
/** Condition data */
|
|
32
|
+
/** A base condition */conditionBase?: ConditionBase; /** Condition data */
|
|
42
33
|
data?: CompoundConditionData;
|
|
43
34
|
};
|
|
44
35
|
/**
|
|
45
36
|
* Condition data
|
|
46
37
|
*/
|
|
47
38
|
type CompoundConditionData = {
|
|
48
|
-
/** Array of condition ids */
|
|
49
|
-
|
|
50
|
-
/** Boolean expression made up of variable names defined from the conditions section */
|
|
51
|
-
expression?: string;
|
|
52
|
-
/** History properties */
|
|
39
|
+
/** Array of condition ids */conditions?: string[]; /** Boolean expression made up of variable names defined from the conditions section */
|
|
40
|
+
expression?: string; /** History properties */
|
|
53
41
|
history?: HistoryProperties;
|
|
54
42
|
};
|
|
55
43
|
/**
|
|
56
44
|
* only one of compoundCondition or dataCondition should be set
|
|
57
45
|
*/
|
|
58
46
|
type Condition = {
|
|
59
|
-
/** A condition made up of other conditions */
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
/** UserID of the condition owner */
|
|
64
|
-
ownerId?: string;
|
|
65
|
-
/** The tenant id */
|
|
66
|
-
tenantId?: string;
|
|
67
|
-
/** Indicates the condition type */
|
|
47
|
+
/** A condition made up of other conditions */compoundCondition?: CompoundCondition; /** A condition based on data within an app */
|
|
48
|
+
dataCondition?: DataCondition; /** UserID of the condition owner */
|
|
49
|
+
ownerId?: string; /** The tenant id */
|
|
50
|
+
tenantId?: string; /** Indicates the condition type */
|
|
68
51
|
type: "compound" | "data";
|
|
69
52
|
};
|
|
70
53
|
/**
|
|
71
54
|
* A base condition
|
|
72
55
|
*/
|
|
73
56
|
type ConditionBase = {
|
|
74
|
-
/** The id of the app the condition is evaluated against */
|
|
75
|
-
|
|
76
|
-
/** The
|
|
77
|
-
|
|
78
|
-
/**
|
|
79
|
-
readonly
|
|
80
|
-
/** The id of the user which
|
|
81
|
-
readonly
|
|
82
|
-
/**
|
|
83
|
-
|
|
84
|
-
/** The unique id for the resource */
|
|
85
|
-
readonly id?: string;
|
|
86
|
-
/** The time of the last reload, if the scan is triggered by a reload. If exists and value does not match app's last reload time, the evaluation will fail. */
|
|
87
|
-
readonly lastReloadTime?: string;
|
|
88
|
-
/** The id of the user the user which owns the condition */
|
|
89
|
-
readonly ownerId?: string;
|
|
90
|
-
/** The tenant id */
|
|
91
|
-
readonly tenantId?: string;
|
|
92
|
-
/** Indicates the condition type */
|
|
93
|
-
type?: "compound" | "data";
|
|
94
|
-
/** When the resource was last updated */
|
|
57
|
+
/** The id of the app the condition is evaluated against */appId?: string; /** The bookmark corresponding to the selection state to apply to the app at evaluation time */
|
|
58
|
+
bookmarkId?: string; /** When the resource was created */
|
|
59
|
+
readonly created?: string; /** The id of the user which created the condition */
|
|
60
|
+
readonly createdById?: string; /** Description of the condition */
|
|
61
|
+
description?: string; /** The unique id for the resource */
|
|
62
|
+
readonly id?: string; /** The time of the last reload, if the scan is triggered by a reload. If exists and value does not match app's last reload time, the evaluation will fail. */
|
|
63
|
+
readonly lastReloadTime?: string; /** The id of the user the user which owns the condition */
|
|
64
|
+
readonly ownerId?: string; /** The tenant id */
|
|
65
|
+
readonly tenantId?: string; /** Indicates the condition type */
|
|
66
|
+
type?: "compound" | "data"; /** When the resource was last updated */
|
|
95
67
|
readonly updated?: string;
|
|
96
68
|
};
|
|
97
69
|
/**
|
|
98
70
|
* only one of compoundCondition or dataCondition should be set
|
|
99
71
|
*/
|
|
100
72
|
type ConditionCreateRequest = {
|
|
101
|
-
/** A condition made up of other conditions */
|
|
102
|
-
|
|
103
|
-
/** A condition based on data within an app */
|
|
104
|
-
dataCondition?: DataConditionCreateRequest;
|
|
105
|
-
/** Indicates the condition type */
|
|
73
|
+
/** A condition made up of other conditions */compoundCondition?: CompoundCondition; /** A condition based on data within an app */
|
|
74
|
+
dataCondition?: DataConditionCreateRequest; /** Indicates the condition type */
|
|
106
75
|
type: "compound" | "data";
|
|
107
76
|
};
|
|
108
77
|
/**
|
|
@@ -110,11 +79,8 @@ type ConditionCreateRequest = {
|
|
|
110
79
|
*/
|
|
111
80
|
type ConditionDimensions = ConditionDimensionsInner[];
|
|
112
81
|
type ConditionDimensionsInner = {
|
|
113
|
-
/** Field referred to the dimension where the selection is made. This may be used to generate deep links. */
|
|
114
|
-
|
|
115
|
-
/** Refers to a dimension stored in the library */
|
|
116
|
-
qLibraryId?: string;
|
|
117
|
-
/** Dimension title */
|
|
82
|
+
/** Field referred to the dimension where the selection is made. This may be used to generate deep links. */field?: string; /** Refers to a dimension stored in the library */
|
|
83
|
+
qLibraryId?: string; /** Dimension title */
|
|
118
84
|
title?: string;
|
|
119
85
|
};
|
|
120
86
|
/**
|
|
@@ -130,11 +96,8 @@ type ConditionHeaders = string[];
|
|
|
130
96
|
*/
|
|
131
97
|
type ConditionMeasures = ConditionMeasuresInner[];
|
|
132
98
|
type ConditionMeasuresInner = {
|
|
133
|
-
/** Refers to a measure stored in the library */
|
|
134
|
-
|
|
135
|
-
/** Format of the field */
|
|
136
|
-
qNumFormat?: unknown;
|
|
137
|
-
/** Measure title */
|
|
99
|
+
/** Refers to a measure stored in the library */qLibraryId?: string; /** Format of the field */
|
|
100
|
+
qNumFormat?: unknown; /** Measure title */
|
|
138
101
|
title?: string;
|
|
139
102
|
};
|
|
140
103
|
/**
|
|
@@ -165,77 +128,52 @@ type ConditionMeasuresInner = {
|
|
|
165
128
|
*/
|
|
166
129
|
type ConditionPatch = ConditionPatchInner[];
|
|
167
130
|
type ConditionPatchInner = {
|
|
168
|
-
/** The operation to be performed. */
|
|
169
|
-
|
|
170
|
-
/** The path for the given resource field to patch. */
|
|
171
|
-
path: string;
|
|
172
|
-
/** The value to be used for this operation. */
|
|
131
|
+
/** The operation to be performed. */op: "replace" | "remove" | "add"; /** The path for the given resource field to patch. */
|
|
132
|
+
path: string; /** The value to be used for this operation. */
|
|
173
133
|
value?: unknown;
|
|
174
134
|
};
|
|
175
135
|
type ConditionResponse = {
|
|
176
|
-
/** only one of compoundCondition or dataCondition should be set */
|
|
177
|
-
condition?: Condition;
|
|
136
|
+
/** only one of compoundCondition or dataCondition should be set */condition?: Condition;
|
|
178
137
|
errors?: Errors;
|
|
179
138
|
};
|
|
180
139
|
type CreateEvaluationRequest = {
|
|
181
|
-
/** The id of the alerting task the condition and evaluation is part of */
|
|
182
|
-
|
|
183
|
-
causalEvent: CausalEvent;
|
|
184
|
-
/** Extra context information to carry through to the result if any */
|
|
140
|
+
/** The id of the alerting task the condition and evaluation is part of */alertId?: string;
|
|
141
|
+
causalEvent: CausalEvent; /** Extra context information to carry through to the result if any */
|
|
185
142
|
contextId: string;
|
|
186
143
|
};
|
|
187
144
|
type CreateEvaluationResponse = {
|
|
188
|
-
/** Extra context information to carry through to the result if any */
|
|
189
|
-
|
|
190
|
-
errors?: Errors;
|
|
191
|
-
/** Extra context information to carry through to the result if any */
|
|
145
|
+
/** Extra context information to carry through to the result if any */contextId?: string;
|
|
146
|
+
errors?: Errors; /** Extra context information to carry through to the result if any */
|
|
192
147
|
evaluationId?: string;
|
|
193
148
|
};
|
|
194
149
|
/**
|
|
195
150
|
* A condition based on data within an app
|
|
196
151
|
*/
|
|
197
152
|
type DataCondition = {
|
|
198
|
-
/** A base condition */
|
|
199
|
-
|
|
200
|
-
/** List of
|
|
201
|
-
|
|
202
|
-
/** List of returned
|
|
203
|
-
|
|
204
|
-
/** List of header labels */
|
|
205
|
-
headers?: ConditionHeaders;
|
|
206
|
-
/** History properties */
|
|
207
|
-
history?: HistoryProperties;
|
|
208
|
-
/** List of returned measures */
|
|
209
|
-
measures?: ConditionMeasures;
|
|
210
|
-
/** List of fields according to the bookmark definition */
|
|
153
|
+
/** A base condition */conditionBase?: ConditionBase; /** List of parameters specific to data condition are available in DCE and will be passed as is to DCE as per the API docs of data-condition-evaluator */
|
|
154
|
+
conditionData?: unknown; /** List of returned dimensions */
|
|
155
|
+
dimensions?: ConditionDimensions; /** List of header labels */
|
|
156
|
+
headers?: ConditionHeaders; /** History properties */
|
|
157
|
+
history?: HistoryProperties; /** List of returned measures */
|
|
158
|
+
measures?: ConditionMeasures; /** List of fields according to the bookmark definition */
|
|
211
159
|
selections?: Selections;
|
|
212
160
|
};
|
|
213
161
|
/**
|
|
214
162
|
* A condition based on data within an app
|
|
215
163
|
*/
|
|
216
164
|
type DataConditionCreateRequest = {
|
|
217
|
-
/** A base condition */
|
|
218
|
-
|
|
219
|
-
/** List of
|
|
220
|
-
|
|
221
|
-
/** List of returned
|
|
222
|
-
|
|
223
|
-
/** List of header labels */
|
|
224
|
-
headers?: ConditionHeaders;
|
|
225
|
-
/** History properties */
|
|
226
|
-
history?: HistoryProperties;
|
|
227
|
-
/** List of returned measures */
|
|
228
|
-
measures?: ConditionMeasures;
|
|
229
|
-
/** List of fields according to the bookmark definition */
|
|
165
|
+
/** A base condition */conditionBase?: ConditionBase; /** List of parameters specific to data condition are available in DCE and will be passed as is to DCE as per the API docs of data-condition-evaluator */
|
|
166
|
+
conditionData?: unknown; /** List of returned dimensions */
|
|
167
|
+
dimensions?: ConditionDimensions; /** List of header labels */
|
|
168
|
+
headers?: ConditionHeaders; /** History properties */
|
|
169
|
+
history?: HistoryProperties; /** List of returned measures */
|
|
170
|
+
measures?: ConditionMeasures; /** List of fields according to the bookmark definition */
|
|
230
171
|
selections?: Selections;
|
|
231
172
|
};
|
|
232
173
|
type Error = {
|
|
233
|
-
/** Error code specific to condition manager. */
|
|
234
|
-
readonly code?: string;
|
|
235
|
-
/** Error cause. */
|
|
174
|
+
/** Error code specific to condition manager. */readonly code?: string; /** Error cause. */
|
|
236
175
|
readonly detail?: string;
|
|
237
|
-
meta?: unknown;
|
|
238
|
-
/** Error title. */
|
|
176
|
+
meta?: unknown; /** Error title. */
|
|
239
177
|
readonly title?: string;
|
|
240
178
|
};
|
|
241
179
|
/**
|
|
@@ -251,105 +189,71 @@ type Error = {
|
|
|
251
189
|
* }
|
|
252
190
|
*/
|
|
253
191
|
type ErrorResponse = {
|
|
254
|
-
/** Array of errors */
|
|
255
|
-
errors?: SingleErrorResponse[];
|
|
256
|
-
/** trace id */
|
|
192
|
+
/** Array of errors */errors?: SingleErrorResponse[]; /** trace id */
|
|
257
193
|
traceId?: string;
|
|
258
194
|
};
|
|
259
195
|
type Errors = Error[];
|
|
260
196
|
type Evaluation = {
|
|
261
|
-
/** The id of the alerting task the condition and evaluation is part of */
|
|
262
|
-
|
|
263
|
-
/**
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
causalEvent?: unknown;
|
|
267
|
-
/** only one of compoundCondition or dataCondition should be set */
|
|
268
|
-
condition?: Condition;
|
|
269
|
-
/** The unique id of the associated condition */
|
|
270
|
-
readonly conditionId?: string;
|
|
271
|
-
/** Extra context information to carry through to the result if one was included on when the evaluation was triggered */
|
|
197
|
+
/** The id of the alerting task the condition and evaluation is part of */alertId?: string; /** internal identifier used when migrating keys */
|
|
198
|
+
byokMigrationId?: string; /** Representation of the event that caused the condition to be evaluated if one was included on when the evaluation was triggered */
|
|
199
|
+
causalEvent?: unknown; /** only one of compoundCondition or dataCondition should be set */
|
|
200
|
+
condition?: Condition; /** The unique id of the associated condition */
|
|
201
|
+
readonly conditionId?: string; /** Extra context information to carry through to the result if one was included on when the evaluation was triggered */
|
|
272
202
|
contextId?: string;
|
|
273
203
|
/** @deprecated
|
|
274
204
|
* The unique id for the resource given from Data Condition Evaluator. */
|
|
275
|
-
readonly dataConditionEvaluatorId?: string;
|
|
276
|
-
/** The time the evaluation ended */
|
|
205
|
+
readonly dataConditionEvaluatorId?: string; /** The time the evaluation ended */
|
|
277
206
|
readonly endTime?: string;
|
|
278
|
-
errors?: EvaluationErrors;
|
|
279
|
-
/**
|
|
280
|
-
readonly
|
|
281
|
-
/**
|
|
282
|
-
|
|
283
|
-
/**
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
/** The
|
|
288
|
-
readonly
|
|
289
|
-
/** Condition type specific result, one of dataResult or compoundResult */
|
|
290
|
-
resultData?: unknown;
|
|
291
|
-
/** number of retries sent to DCE */
|
|
292
|
-
readonly retries?: number;
|
|
293
|
-
/** what kind of retry policy this evaluation has */
|
|
294
|
-
retryPolicy?: "NONE" | "TOO_MANY_REQUESTS" | "GENERIC_ERROR";
|
|
295
|
-
/** The time the evaluation started */
|
|
296
|
-
readonly startTime?: string;
|
|
297
|
-
/** The status of the evaluation execution */
|
|
298
|
-
readonly status?: "RUNNING" | "FAILED" | "FINISHED" | "DELETING";
|
|
299
|
-
/** The tenant id */
|
|
207
|
+
errors?: EvaluationErrors; /** The unique id for the resource */
|
|
208
|
+
readonly id?: string; /** userId of user being impersonated to evaluate the condition */
|
|
209
|
+
readonly ownerId?: string; /** The time when the reload was completed in Engine */
|
|
210
|
+
readonly reloadEndTime?: string; /** The number of times we have attempted to remove this evaluation data-file */
|
|
211
|
+
removalErrorCount?: number; /** The final result of the evalution */
|
|
212
|
+
readonly result?: boolean; /** Condition type specific result, one of dataResult or compoundResult */
|
|
213
|
+
resultData?: unknown; /** number of retries sent to DCE */
|
|
214
|
+
readonly retries?: number; /** what kind of retry policy this evaluation has */
|
|
215
|
+
retryPolicy?: "NONE" | "TOO_MANY_REQUESTS" | "GENERIC_ERROR"; /** The time the evaluation started */
|
|
216
|
+
readonly startTime?: string; /** The status of the evaluation execution */
|
|
217
|
+
readonly status?: "RUNNING" | "FAILED" | "FINISHED" | "DELETING"; /** The tenant id */
|
|
300
218
|
readonly tenantId?: string;
|
|
301
219
|
};
|
|
302
220
|
type EvaluationError = {
|
|
303
|
-
/** Error code specific to condition smanager. */
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
/** Error status. */
|
|
307
|
-
readonly status?: unknown;
|
|
308
|
-
/** Error title. */
|
|
221
|
+
/** Error code specific to condition smanager. */readonly code?: string;
|
|
222
|
+
meta?: EvaluationErrorMeta; /** Error status. */
|
|
223
|
+
readonly status?: unknown; /** Error title. */
|
|
309
224
|
readonly title?: string;
|
|
310
225
|
};
|
|
311
226
|
type EvaluationErrorMeta = {
|
|
312
|
-
/** defines whether an error is recoverable or not */
|
|
313
|
-
fatal?: boolean;
|
|
227
|
+
/** defines whether an error is recoverable or not */fatal?: boolean;
|
|
314
228
|
};
|
|
315
229
|
type EvaluationErrors = EvaluationError[];
|
|
316
230
|
/**
|
|
317
231
|
* Get response returns the evaluation and condition associated
|
|
318
232
|
*/
|
|
319
233
|
type GetEvaluationResponse = {
|
|
320
|
-
/** only one of compoundCondition or dataCondition should be set */
|
|
321
|
-
condition?: Condition;
|
|
234
|
+
/** only one of compoundCondition or dataCondition should be set */condition?: Condition;
|
|
322
235
|
evaluation?: Evaluation;
|
|
323
236
|
};
|
|
324
237
|
/**
|
|
325
238
|
* History properties
|
|
326
239
|
*/
|
|
327
240
|
type HistoryProperties = {
|
|
328
|
-
/** Is history enabled */
|
|
329
|
-
enabled?: boolean;
|
|
241
|
+
/** Is history enabled */enabled?: boolean;
|
|
330
242
|
};
|
|
331
243
|
type PreviewEvaluation = {
|
|
332
|
-
/** The time the evaluation ended */
|
|
333
|
-
readonly
|
|
334
|
-
|
|
335
|
-
readonly
|
|
336
|
-
/** URL to download the condition results */
|
|
337
|
-
resultUrl?: string;
|
|
338
|
-
/** The time the evaluation started */
|
|
339
|
-
readonly startTime?: string;
|
|
340
|
-
/** The tenant id */
|
|
244
|
+
/** The time the evaluation ended */readonly endTime?: string; /** userId of user being impersonated to evaluate the condition */
|
|
245
|
+
readonly ownerId?: string; /** URL to download the condition results */
|
|
246
|
+
resultUrl?: string; /** The time the evaluation started */
|
|
247
|
+
readonly startTime?: string; /** The tenant id */
|
|
341
248
|
readonly tenantId?: string;
|
|
342
249
|
};
|
|
343
250
|
type PreviewResponse = {
|
|
344
|
-
/** When the resource was created */
|
|
345
|
-
readonly previewId?: string;
|
|
251
|
+
/** When the resource was created */readonly previewId?: string;
|
|
346
252
|
};
|
|
347
253
|
type PreviewStatusResponse = {
|
|
348
|
-
/** only one of compoundCondition or dataCondition should be set */
|
|
349
|
-
condition?: Condition;
|
|
254
|
+
/** only one of compoundCondition or dataCondition should be set */condition?: Condition;
|
|
350
255
|
errors?: Errors;
|
|
351
|
-
evaluation?: PreviewEvaluation;
|
|
352
|
-
/** When the resource was created */
|
|
256
|
+
evaluation?: PreviewEvaluation; /** When the resource was created */
|
|
353
257
|
readonly previewId?: string;
|
|
354
258
|
readonly status?: "ACCEPTED" | "FAILED" | "RUNNING" | "SUCCESSFUL";
|
|
355
259
|
};
|
|
@@ -358,21 +262,14 @@ type PreviewStatusResponse = {
|
|
|
358
262
|
*/
|
|
359
263
|
type Selections = SelectionsInner[];
|
|
360
264
|
type SelectionsInner = {
|
|
361
|
-
/** The count */
|
|
362
|
-
|
|
363
|
-
/** Field name */
|
|
364
|
-
field?: string;
|
|
365
|
-
/** Array of selected */
|
|
265
|
+
/** The count */count?: number; /** Field name */
|
|
266
|
+
field?: string; /** Array of selected */
|
|
366
267
|
selectedSummary?: string[];
|
|
367
268
|
};
|
|
368
269
|
type SingleErrorResponse = {
|
|
369
|
-
/** Error code specific to condition manager. */
|
|
370
|
-
readonly
|
|
371
|
-
/** Error
|
|
372
|
-
readonly detail?: string;
|
|
373
|
-
/** meta properties for an error. */
|
|
374
|
-
meta?: unknown;
|
|
375
|
-
/** Error title. */
|
|
270
|
+
/** Error code specific to condition manager. */readonly code?: string; /** Error cause. */
|
|
271
|
+
readonly detail?: string; /** meta properties for an error. */
|
|
272
|
+
meta?: unknown; /** Error title. */
|
|
376
273
|
readonly title?: string;
|
|
377
274
|
};
|
|
378
275
|
/**
|
package/conditions.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "./chunks/public-runtime-modules-
|
|
2
|
-
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-
|
|
1
|
+
import "./chunks/public-runtime-modules-2KfyI2qM.js";
|
|
2
|
+
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/conditions.ts
|
|
5
5
|
/**
|
|
@@ -194,7 +194,6 @@ const conditionsExport = {
|
|
|
194
194
|
getConditionEvaluation,
|
|
195
195
|
clearCache
|
|
196
196
|
};
|
|
197
|
-
var conditions_default = conditionsExport;
|
|
198
197
|
|
|
199
198
|
//#endregion
|
|
200
|
-
export { clearCache, createCondition, createConditionEvaluation, createConditionPreview,
|
|
199
|
+
export { clearCache, createCondition, createConditionEvaluation, createConditionPreview, conditionsExport as default, deleteCondition, deleteConditionEvaluation, getCondition, getConditionEvaluation, getConditionPreview, getConditionsSettings, patchCondition, setConditionsSettings };
|
package/consumption.d.ts
CHANGED
|
@@ -1,11 +1,9 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
1
|
+
import { ApiCallOptions } from "./invoke-fetch-types.js";
|
|
2
|
+
import "./chunks/invoke-fetch-DFc3yzaj.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/consumption.d.ts
|
|
5
5
|
type Enforcement = {
|
|
6
|
-
/** Resource action type to be blocked */
|
|
7
|
-
actionToBlock?: string;
|
|
8
|
-
/** Resource type to be blocked */
|
|
6
|
+
/** Resource action type to be blocked */actionToBlock?: string; /** Resource type to be blocked */
|
|
9
7
|
resourceType?: string;
|
|
10
8
|
};
|
|
11
9
|
/**
|
|
@@ -25,53 +23,32 @@ type ErrorResponse = {
|
|
|
25
23
|
traceId?: string;
|
|
26
24
|
};
|
|
27
25
|
type ExecutionResponse = {
|
|
28
|
-
blocked?: boolean;
|
|
29
|
-
|
|
30
|
-
blockedEventTime?: string;
|
|
31
|
-
/** The capacity limit. */
|
|
26
|
+
blocked?: boolean; /** RFC3339 timestamp when a block event was last emitted for this execution. */
|
|
27
|
+
blockedEventTime?: string; /** The capacity limit. */
|
|
32
28
|
capacityLimit?: number;
|
|
33
|
-
closeToOverage?: boolean;
|
|
34
|
-
/** The
|
|
35
|
-
|
|
36
|
-
/** The
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
enforcement?: Enforcement[];
|
|
40
|
-
/** The global usage. */
|
|
41
|
-
globalUsage?: number;
|
|
42
|
-
/** The guardrail limit. */
|
|
43
|
-
guardrailLimit?: number;
|
|
44
|
-
/** The local usage. */
|
|
29
|
+
closeToOverage?: boolean; /** The id of the consumption report */
|
|
30
|
+
consumptionReportId?: string; /** The field to determine if a resource should be visible on the client. */
|
|
31
|
+
customerFacing?: boolean; /** Contains a list of resources that are blocked when quota for this is reached. */
|
|
32
|
+
enforcement?: Enforcement[]; /** The global usage. */
|
|
33
|
+
globalUsage?: number; /** The guardrail limit. */
|
|
34
|
+
guardrailLimit?: number; /** The local usage. */
|
|
45
35
|
localUsage?: number;
|
|
46
|
-
overage?: boolean;
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
/** The end of the associated period. */
|
|
50
|
-
periodEnd?: string;
|
|
51
|
-
/** The start of the associated period. */
|
|
36
|
+
overage?: boolean; /** RFC3339 timestamp when a overage event was last emitted for this execution. */
|
|
37
|
+
overageEventTime?: string; /** The end of the associated period. */
|
|
38
|
+
periodEnd?: string; /** The start of the associated period. */
|
|
52
39
|
periodStart?: string;
|
|
53
|
-
periodType?: "day" | "month" | "year" | "" | "fixed" | "minute";
|
|
54
|
-
/** The resource
|
|
55
|
-
|
|
56
|
-
/** The resource id. */
|
|
57
|
-
resourceId?: string;
|
|
58
|
-
/** The resource type. */
|
|
40
|
+
periodType?: "day" | "month" | "year" | "" | "fixed" | "minute"; /** The resource action. */
|
|
41
|
+
resourceAction?: "report.generated" | "reload" | "scheduledReload" | "executed" | "aggregation" | "import" | "updated" | "deployed" | "3rd_party_executed" | "standard_executed"; /** The resource id. */
|
|
42
|
+
resourceId?: string; /** The resource type. */
|
|
59
43
|
resourceType?: "app" | "automations" | "space" | "data.volume.consumption";
|
|
60
|
-
scope?: ("user" | "tenant" | "resourceId" | "resourceType" | "resourceAction")[];
|
|
61
|
-
/** The map to the resource scope. */
|
|
44
|
+
scope?: ("user" | "tenant" | "resourceId" | "resourceType" | "resourceAction")[]; /** The map to the resource scope. */
|
|
62
45
|
scopeMapping?: string;
|
|
63
|
-
segments?: Record<string, unknown>[];
|
|
64
|
-
/** The resource task
|
|
65
|
-
|
|
66
|
-
/**
|
|
67
|
-
|
|
68
|
-
/** The
|
|
69
|
-
tenantId?: string;
|
|
70
|
-
/** Unit of measurement for the resource consumption */
|
|
71
|
-
unit?: string;
|
|
72
|
-
/** The RFC3339 timestamp when the resource was updated. */
|
|
73
|
-
updateTime?: string;
|
|
74
|
-
/** The user id. */
|
|
46
|
+
segments?: Record<string, unknown>[]; /** The resource task description. */
|
|
47
|
+
taskDescription?: string; /** The resource task name. */
|
|
48
|
+
taskName?: string; /** The tenant id. */
|
|
49
|
+
tenantId?: string; /** Unit of measurement for the resource consumption */
|
|
50
|
+
unit?: string; /** The RFC3339 timestamp when the resource was updated. */
|
|
51
|
+
updateTime?: string; /** The user id. */
|
|
75
52
|
userId?: string;
|
|
76
53
|
};
|
|
77
54
|
type ExecutionsByTenantList = StandardListResponseProps & {
|
|
@@ -83,16 +60,12 @@ type ExecutionsByTenantList = StandardListResponseProps & {
|
|
|
83
60
|
};
|
|
84
61
|
type ListLinks = {
|
|
85
62
|
next?: Page;
|
|
86
|
-
prev?: Page;
|
|
87
|
-
/** Object with Href to a particular element or set of elements */
|
|
63
|
+
prev?: Page; /** Object with Href to a particular element or set of elements */
|
|
88
64
|
self?: Self;
|
|
89
65
|
};
|
|
90
66
|
type Page = {
|
|
91
|
-
/** URL to particular set of elements */
|
|
92
|
-
|
|
93
|
-
/** Page unique token */
|
|
94
|
-
token?: string;
|
|
95
|
-
/** Page type, can be next or prev */
|
|
67
|
+
/** URL to particular set of elements */href?: string; /** Page unique token */
|
|
68
|
+
token?: string; /** Page type, can be next or prev */
|
|
96
69
|
type?: "prev" | "next";
|
|
97
70
|
};
|
|
98
71
|
/**
|
|
@@ -102,22 +75,16 @@ type Self = {
|
|
|
102
75
|
href?: string;
|
|
103
76
|
};
|
|
104
77
|
type SingleErrorResponse = {
|
|
105
|
-
/** Error code specific to usage-tracker. */
|
|
106
|
-
readonly
|
|
107
|
-
/** Error
|
|
108
|
-
readonly detail?: string;
|
|
109
|
-
/** meta properties for an error. */
|
|
110
|
-
meta?: unknown;
|
|
111
|
-
/** Error title. */
|
|
78
|
+
/** Error code specific to usage-tracker. */readonly code?: string; /** Error cause. */
|
|
79
|
+
readonly detail?: string; /** meta properties for an error. */
|
|
80
|
+
meta?: unknown; /** Error title. */
|
|
112
81
|
readonly title?: string;
|
|
113
82
|
};
|
|
114
83
|
/**
|
|
115
84
|
* properties that should be added to every list response
|
|
116
85
|
*/
|
|
117
86
|
type StandardListResponseProps = {
|
|
118
|
-
/** count of entries on the currently shown page */
|
|
119
|
-
currentPageCount: number;
|
|
120
|
-
/** total count of entries in the collection as a whole */
|
|
87
|
+
/** count of entries on the currently shown page */currentPageCount: number; /** total count of entries in the collection as a whole */
|
|
121
88
|
totalCount: number;
|
|
122
89
|
};
|
|
123
90
|
/**
|
|
@@ -135,14 +102,10 @@ declare function getConsumptionExecutions(query: {
|
|
|
135
102
|
* The following fields are supported: `scope`, `resourcetype`, `resourceaction`, `resourceid`, `capacitylimit`,
|
|
136
103
|
* `localusage`, `globalusage`, `overage`, `blocked`, `periodstart`, `periodend`, `consumptionreportid`, `blockedeventtime`,
|
|
137
104
|
* `overageeventtime`, `taskname`, `taskdescription`, `userid`, `tenantid`, `customerfacing`, `actiontoblock` */
|
|
138
|
-
filter?: string;
|
|
139
|
-
/**
|
|
140
|
-
|
|
141
|
-
/**
|
|
142
|
-
offset?: number;
|
|
143
|
-
/** The cursor to the page of data. */
|
|
144
|
-
page?: string;
|
|
145
|
-
/** Specifies which periods to include regardless of the period type, start and end specified */
|
|
105
|
+
filter?: string; /** Limit the returned result set */
|
|
106
|
+
limit?: number; /** Offset for pagination - how many elements to skip */
|
|
107
|
+
offset?: number; /** The cursor to the page of data. */
|
|
108
|
+
page?: string; /** Specifies which periods to include regardless of the period type, start and end specified */
|
|
146
109
|
periodsToInclude?: ("current" | "previous")[];
|
|
147
110
|
sort?: ("periodstart" | "-periodstart" | "+periodstart" | "periodend" | "-periodend" | "+periodend")[];
|
|
148
111
|
}, options?: ApiCallOptions): Promise<GetConsumptionExecutionsHttpResponse>;
|
package/consumption.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "./chunks/public-runtime-modules-
|
|
2
|
-
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-
|
|
1
|
+
import "./chunks/public-runtime-modules-2KfyI2qM.js";
|
|
2
|
+
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/consumption.ts
|
|
5
5
|
/**
|
|
@@ -29,7 +29,6 @@ const consumptionExport = {
|
|
|
29
29
|
getConsumptionExecutions,
|
|
30
30
|
clearCache
|
|
31
31
|
};
|
|
32
|
-
var consumption_default = consumptionExport;
|
|
33
32
|
|
|
34
33
|
//#endregion
|
|
35
|
-
export { clearCache,
|
|
34
|
+
export { clearCache, consumptionExport as default, getConsumptionExecutions };
|