@qlik/api 2.2.0 → 2.3.1

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 (232) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/auth-XusKk8IA.js +32 -0
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-2VSXImC9.js} +498 -146
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-CckTK7bh.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-D9lpiAb-.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-BqxAMJ9M.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-DpvHvpx7.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-BXZPnE6J.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +5 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-Cle0_tmz.js +0 -32
  163. package/chunks/auth-D11iO7ZV.js +0 -65
  164. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  165. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  166. package/chunks/automations-BGy83EBO.d.ts +0 -797
  167. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  168. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  169. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  170. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  171. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  172. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  173. package/chunks/consumption-DerFk437.d.ts +0 -182
  174. package/chunks/core-DQXNZdnf.d.ts +0 -12
  175. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  176. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  177. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  178. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  179. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  180. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  181. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  182. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  183. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  184. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  185. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  186. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  187. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  188. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  189. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  190. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  191. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  192. package/chunks/groups-C86-UG7S.d.ts +0 -511
  193. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  194. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  195. package/chunks/interceptors-DTYm37AU.js +0 -104
  196. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  197. package/chunks/ip-policies-DXlf172B.js +0 -108
  198. package/chunks/items-C-jzqvFW.d.ts +0 -536
  199. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  200. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  201. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  202. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  203. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  204. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  205. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  206. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  207. package/chunks/qix-CYQsLyGQ.js +0 -40
  208. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  209. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  210. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  211. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  212. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  213. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  214. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  215. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  216. package/chunks/spaces-BK823t-b.d.ts +0 -780
  217. package/chunks/tasks-COKDfShO.d.ts +0 -564
  218. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  219. package/chunks/tenants-Bhn86519.d.ts +0 -361
  220. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  221. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  222. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  223. package/chunks/users-BSOBU_fg.d.ts +0 -675
  224. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  225. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  226. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  227. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  228. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  229. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  230. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  231. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  232. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
package/conditions.d.ts CHANGED
@@ -1,4 +1,663 @@
1
- import "./chunks/auth-types-E99tzdN0.js";
2
- import "./chunks/invoke-fetch-CbU2Dgqr.js";
3
- import { $ as PreviewEvaluation, A as DeleteConditionEvaluationHttpError, B as EvaluationErrors, C as CreateConditionHttpResponse, D as CreateEvaluationResponse, E as CreateEvaluationRequest, F as ErrorResponse, G as GetConditionPreviewHttpError, H as GetConditionEvaluationHttpResponse, I as Errors, J as GetConditionsSettingsHttpResponse, K as GetConditionPreviewHttpResponse, L as Evaluation, M as DeleteConditionHttpError, N as DeleteConditionHttpResponse, O as DataCondition, P as Error, Q as PatchConditionHttpResponse, R as EvaluationError, S as CreateConditionHttpError, T as CreateConditionPreviewHttpResponse, U as GetConditionHttpError, V as GetConditionEvaluationHttpError, W as GetConditionHttpResponse, X as HistoryProperties, Y as GetEvaluationResponse, Z as PatchConditionHttpError, _ as ConditionPatchInner, _t as getConditionsSettings, a as CausalEventExtensions, at as SetConditionsSettingsHttpResponse, b as CreateConditionEvaluationHttpError, c as Condition, ct as conditionsExport, d as ConditionDimensions, dt as createConditionPreview, et as PreviewResponse, f as ConditionDimensionsInner, ft as deleteCondition, g as ConditionPatch, gt as getConditionPreview, h as ConditionMeasuresInner, ht as getConditionEvaluation, i as CausalEventData, it as SetConditionsSettingsHttpError, j as DeleteConditionEvaluationHttpResponse, k as DataConditionCreateRequest, l as ConditionBase, lt as createCondition, m as ConditionMeasures, mt as getCondition, n as APISettingsUpload, nt as Selections, o as CompoundCondition, ot as SingleErrorResponse, p as ConditionHeaders, pt as deleteConditionEvaluation, q as GetConditionsSettingsHttpError, r as CausalEvent, rt as SelectionsInner, s as CompoundConditionData, st as clearCache, t as APISettings, tt as PreviewStatusResponse, u as ConditionCreateRequest, ut as createConditionEvaluation, v as ConditionResponse, vt as patchCondition, w as CreateConditionPreviewHttpError, x as CreateConditionEvaluationHttpResponse, y as ConditionsAPI, yt as setConditionsSettings, z as EvaluationErrorMeta } from "./chunks/conditions-CJJG7Uph.js";
1
+ import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
+ import "./chunks/invoke-fetch-C1Z0RJYU.js";
3
+
4
+ //#region src/public/rest/conditions.d.ts
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. */
9
+ readonly tenantId?: string;
10
+ };
11
+ type APISettingsUpload = {
12
+ /** Whether API endpoints for condition manager are enabled */
13
+ "enable-conditions": boolean;
14
+ };
15
+ type CausalEvent = {
16
+ data?: CausalEventData;
17
+ /** the event id from eventing */
18
+ eventID?: string;
19
+ extensions?: CausalEventExtensions;
20
+ manualTrigger?: boolean;
21
+ /** the manual trigger id from eventing if present */
22
+ manualTriggerID?: string;
23
+ };
24
+ type CausalEventData = {
25
+ /** the event id from eventing service. */
26
+ eventID?: string;
27
+ /** The time of the last reload */
28
+ lastReloadTime?: string;
29
+ };
30
+ type CausalEventExtensions = {
31
+ sessionID?: string;
32
+ tenantID?: string;
33
+ userID?: string;
34
+ };
35
+ /**
36
+ * A condition made up of other conditions
37
+ */
38
+ type CompoundCondition = {
39
+ /** A base condition */
40
+ conditionBase?: ConditionBase;
41
+ /** Condition data */
42
+ data?: CompoundConditionData;
43
+ };
44
+ /**
45
+ * Condition data
46
+ */
47
+ type CompoundConditionData = {
48
+ /** Array of condition ids */
49
+ conditions?: string[];
50
+ /** Boolean expression made up of variable names defined from the conditions section */
51
+ expression?: string;
52
+ /** History properties */
53
+ history?: HistoryProperties;
54
+ };
55
+ /**
56
+ * only one of compoundCondition or dataCondition should be set
57
+ */
58
+ type Condition = {
59
+ /** A condition made up of other conditions */
60
+ compoundCondition?: CompoundCondition;
61
+ /** A condition based on data within an app */
62
+ dataCondition?: DataCondition;
63
+ /** UserID of the condition owner */
64
+ ownerId?: string;
65
+ /** The tenant id */
66
+ tenantId?: string;
67
+ /** Indicates the condition type */
68
+ type: "compound" | "data";
69
+ };
70
+ /**
71
+ * A base condition
72
+ */
73
+ type ConditionBase = {
74
+ /** The id of the app the condition is evaluated against */
75
+ appId?: string;
76
+ /** The bookmark corresponding to the selection state to apply to the app at evaluation time */
77
+ bookmarkId?: string;
78
+ /** When the resource was created */
79
+ readonly created?: string;
80
+ /** The id of the user which created the condition */
81
+ readonly createdById?: string;
82
+ /** Description of the condition */
83
+ description?: string;
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 */
95
+ readonly updated?: string;
96
+ };
97
+ /**
98
+ * only one of compoundCondition or dataCondition should be set
99
+ */
100
+ type ConditionCreateRequest = {
101
+ /** A condition made up of other conditions */
102
+ compoundCondition?: CompoundCondition;
103
+ /** A condition based on data within an app */
104
+ dataCondition?: DataConditionCreateRequest;
105
+ /** Indicates the condition type */
106
+ type: "compound" | "data";
107
+ };
108
+ /**
109
+ * List of returned dimensions
110
+ */
111
+ type ConditionDimensions = ConditionDimensionsInner[];
112
+ type ConditionDimensionsInner = {
113
+ /** Field referred to the dimension where the selection is made. This may be used to generate deep links. */
114
+ field?: string;
115
+ /** Refers to a dimension stored in the library */
116
+ qLibraryId?: string;
117
+ /** Dimension title */
118
+ title?: string;
119
+ };
120
+ /**
121
+ * List of header labels
122
+ * @example
123
+ * [
124
+ * "sumnum"
125
+ * ]
126
+ */
127
+ type ConditionHeaders = string[];
128
+ /**
129
+ * List of returned measures
130
+ */
131
+ type ConditionMeasures = ConditionMeasuresInner[];
132
+ type ConditionMeasuresInner = {
133
+ /** Refers to a measure stored in the library */
134
+ qLibraryId?: string;
135
+ /** Format of the field */
136
+ qNumFormat?: unknown;
137
+ /** Measure title */
138
+ title?: string;
139
+ };
140
+ /**
141
+ * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
142
+ * @example
143
+ * [
144
+ * {
145
+ * op: "replace",
146
+ * path: "/compoundCondition/conditionBase/ownerId"
147
+ * },
148
+ * {
149
+ * op: "replace",
150
+ * path: "/dataCondition/conditionBase/description"
151
+ * },
152
+ * {
153
+ * op: "remove",
154
+ * path: "/compoundCondition/data/conditions/0"
155
+ * },
156
+ * {
157
+ * op: "replace",
158
+ * path: "/compoundCondition//data/expression"
159
+ * },
160
+ * {
161
+ * op: "replace",
162
+ * path: "/dataCondition/conditionData/measure"
163
+ * }
164
+ * ]
165
+ */
166
+ type ConditionPatch = ConditionPatchInner[];
167
+ type ConditionPatchInner = {
168
+ /** The operation to be performed. */
169
+ op: "replace" | "remove" | "add";
170
+ /** The path for the given resource field to patch. */
171
+ path: string;
172
+ /** The value to be used for this operation. */
173
+ value?: unknown;
174
+ };
175
+ type ConditionResponse = {
176
+ /** only one of compoundCondition or dataCondition should be set */
177
+ condition?: Condition;
178
+ errors?: Errors;
179
+ };
180
+ type CreateEvaluationRequest = {
181
+ /** The id of the alerting task the condition and evaluation is part of */
182
+ alertId?: string;
183
+ causalEvent: CausalEvent;
184
+ /** Extra context information to carry through to the result if any */
185
+ contextId: string;
186
+ };
187
+ type CreateEvaluationResponse = {
188
+ /** Extra context information to carry through to the result if any */
189
+ contextId?: string;
190
+ errors?: Errors;
191
+ /** Extra context information to carry through to the result if any */
192
+ evaluationId?: string;
193
+ };
194
+ /**
195
+ * A condition based on data within an app
196
+ */
197
+ type DataCondition = {
198
+ /** A base condition */
199
+ conditionBase?: ConditionBase;
200
+ /** 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 */
201
+ conditionData?: unknown;
202
+ /** List of returned dimensions */
203
+ dimensions?: ConditionDimensions;
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 */
211
+ selections?: Selections;
212
+ };
213
+ /**
214
+ * A condition based on data within an app
215
+ */
216
+ type DataConditionCreateRequest = {
217
+ /** A base condition */
218
+ conditionBase?: ConditionBase;
219
+ /** 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 */
220
+ conditionData?: unknown;
221
+ /** List of returned dimensions */
222
+ dimensions?: ConditionDimensions;
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 */
230
+ selections?: Selections;
231
+ };
232
+ type Error = {
233
+ /** Error code specific to condition manager. */
234
+ readonly code?: string;
235
+ /** Error cause. */
236
+ readonly detail?: string;
237
+ meta?: unknown;
238
+ /** Error title. */
239
+ readonly title?: string;
240
+ };
241
+ /**
242
+ * @example
243
+ * {
244
+ * errors: [
245
+ * {
246
+ * code: "HTTP-123",
247
+ * title: "short error message"
248
+ * }
249
+ * ],
250
+ * traceId: "7975401f3954aa47"
251
+ * }
252
+ */
253
+ type ErrorResponse = {
254
+ /** Array of errors */
255
+ errors?: SingleErrorResponse[];
256
+ /** trace id */
257
+ traceId?: string;
258
+ };
259
+ type Errors = Error[];
260
+ type Evaluation = {
261
+ /** The id of the alerting task the condition and evaluation is part of */
262
+ alertId?: string;
263
+ /** internal identifier used when migrating keys */
264
+ byokMigrationId?: string;
265
+ /** Representation of the event that caused the condition to be evaluated if one was included on when the evaluation was triggered */
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 */
272
+ contextId?: string;
273
+ /** @deprecated
274
+ * The unique id for the resource given from Data Condition Evaluator. */
275
+ readonly dataConditionEvaluatorId?: string;
276
+ /** The time the evaluation ended */
277
+ readonly endTime?: string;
278
+ errors?: EvaluationErrors;
279
+ /** The unique id for the resource */
280
+ readonly id?: string;
281
+ /** userId of user being impersonated to evaluate the condition */
282
+ readonly ownerId?: string;
283
+ /** The time when the reload was completed in Engine */
284
+ readonly reloadEndTime?: string;
285
+ /** The number of times we have attempted to remove this evaluation data-file */
286
+ removalErrorCount?: number;
287
+ /** The final result of the evalution */
288
+ readonly result?: boolean;
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 */
300
+ readonly tenantId?: string;
301
+ };
302
+ type EvaluationError = {
303
+ /** Error code specific to condition smanager. */
304
+ readonly code?: string;
305
+ meta?: EvaluationErrorMeta;
306
+ /** Error status. */
307
+ readonly status?: unknown;
308
+ /** Error title. */
309
+ readonly title?: string;
310
+ };
311
+ type EvaluationErrorMeta = {
312
+ /** defines whether an error is recoverable or not */
313
+ fatal?: boolean;
314
+ };
315
+ type EvaluationErrors = EvaluationError[];
316
+ /**
317
+ * Get response returns the evaluation and condition associated
318
+ */
319
+ type GetEvaluationResponse = {
320
+ /** only one of compoundCondition or dataCondition should be set */
321
+ condition?: Condition;
322
+ evaluation?: Evaluation;
323
+ };
324
+ /**
325
+ * History properties
326
+ */
327
+ type HistoryProperties = {
328
+ /** Is history enabled */
329
+ enabled?: boolean;
330
+ };
331
+ type PreviewEvaluation = {
332
+ /** The time the evaluation ended */
333
+ readonly endTime?: string;
334
+ /** userId of user being impersonated to evaluate the condition */
335
+ readonly ownerId?: string;
336
+ /** URL to download the condition results */
337
+ resultUrl?: string;
338
+ /** The time the evaluation started */
339
+ readonly startTime?: string;
340
+ /** The tenant id */
341
+ readonly tenantId?: string;
342
+ };
343
+ type PreviewResponse = {
344
+ /** When the resource was created */
345
+ readonly previewId?: string;
346
+ };
347
+ type PreviewStatusResponse = {
348
+ /** only one of compoundCondition or dataCondition should be set */
349
+ condition?: Condition;
350
+ errors?: Errors;
351
+ evaluation?: PreviewEvaluation;
352
+ /** When the resource was created */
353
+ readonly previewId?: string;
354
+ readonly status?: "ACCEPTED" | "FAILED" | "RUNNING" | "SUCCESSFUL";
355
+ };
356
+ /**
357
+ * List of fields according to the bookmark definition
358
+ */
359
+ type Selections = SelectionsInner[];
360
+ type SelectionsInner = {
361
+ /** The count */
362
+ count?: number;
363
+ /** Field name */
364
+ field?: string;
365
+ /** Array of selected */
366
+ selectedSummary?: string[];
367
+ };
368
+ type SingleErrorResponse = {
369
+ /** Error code specific to condition manager. */
370
+ readonly code?: string;
371
+ /** Error cause. */
372
+ readonly detail?: string;
373
+ /** meta properties for an error. */
374
+ meta?: unknown;
375
+ /** Error title. */
376
+ readonly title?: string;
377
+ };
378
+ /**
379
+ * Creates a new condition.
380
+ *
381
+ * @param body an object with the body content
382
+ * @throws CreateConditionHttpError
383
+ */
384
+ declare function createCondition(body: ConditionCreateRequest, options?: ApiCallOptions): Promise<CreateConditionHttpResponse>;
385
+ type CreateConditionHttpResponse = {
386
+ data: ConditionResponse;
387
+ headers: Headers;
388
+ status: 201;
389
+ };
390
+ type CreateConditionHttpError = {
391
+ data: ErrorResponse;
392
+ headers: Headers;
393
+ status: number;
394
+ };
395
+ /**
396
+ * Create condition preview request.
397
+ *
398
+ * @param body an object with the body content
399
+ * @throws CreateConditionPreviewHttpError
400
+ */
401
+ declare function createConditionPreview(body: ConditionCreateRequest, options?: ApiCallOptions): Promise<CreateConditionPreviewHttpResponse>;
402
+ type CreateConditionPreviewHttpResponse = {
403
+ data: PreviewResponse;
404
+ headers: Headers;
405
+ status: 201;
406
+ };
407
+ type CreateConditionPreviewHttpError = {
408
+ data: ErrorResponse;
409
+ headers: Headers;
410
+ status: number;
411
+ };
412
+ /**
413
+ * Get condition preview response.
414
+ *
415
+ * @param id The id of the condition
416
+ * @throws GetConditionPreviewHttpError
417
+ */
418
+ declare function getConditionPreview(id: string, options?: ApiCallOptions): Promise<GetConditionPreviewHttpResponse>;
419
+ type GetConditionPreviewHttpResponse = {
420
+ data: PreviewStatusResponse;
421
+ headers: Headers;
422
+ status: 200;
423
+ };
424
+ type GetConditionPreviewHttpError = {
425
+ data: ErrorResponse;
426
+ headers: Headers;
427
+ status: number;
428
+ };
429
+ /**
430
+ * Retrieves condition manager settings
431
+ *
432
+ * @throws GetConditionsSettingsHttpError
433
+ */
434
+ declare function getConditionsSettings(options?: ApiCallOptions): Promise<GetConditionsSettingsHttpResponse>;
435
+ type GetConditionsSettingsHttpResponse = {
436
+ data: APISettings;
437
+ headers: Headers;
438
+ status: 200;
439
+ };
440
+ type GetConditionsSettingsHttpError = {
441
+ data: ErrorResponse;
442
+ headers: Headers;
443
+ status: number;
444
+ };
445
+ /**
446
+ * Updates API configuration. Accessible only by tenant admins.
447
+ *
448
+ * @param body an object with the body content
449
+ * @throws SetConditionsSettingsHttpError
450
+ */
451
+ declare function setConditionsSettings(body: APISettingsUpload, options?: ApiCallOptions): Promise<SetConditionsSettingsHttpResponse>;
452
+ type SetConditionsSettingsHttpResponse = {
453
+ data: void;
454
+ headers: Headers;
455
+ status: 204;
456
+ };
457
+ type SetConditionsSettingsHttpError = {
458
+ data: ErrorResponse;
459
+ headers: Headers;
460
+ status: number;
461
+ };
462
+ /**
463
+ * Delete the condition
464
+ *
465
+ * @param id The id of the condition
466
+ * @throws DeleteConditionHttpError
467
+ */
468
+ declare function deleteCondition(id: string, options?: ApiCallOptions): Promise<DeleteConditionHttpResponse>;
469
+ type DeleteConditionHttpResponse = {
470
+ data: void;
471
+ headers: Headers;
472
+ status: 204;
473
+ };
474
+ type DeleteConditionHttpError = {
475
+ data: ErrorResponse;
476
+ headers: Headers;
477
+ status: number;
478
+ };
479
+ /**
480
+ * Retrieve a specific condition by id.
481
+ *
482
+ * @param id The id of the condition
483
+ * @throws GetConditionHttpError
484
+ */
485
+ declare function getCondition(id: string, options?: ApiCallOptions): Promise<GetConditionHttpResponse>;
486
+ type GetConditionHttpResponse = {
487
+ data: Condition;
488
+ headers: Headers;
489
+ status: 200;
490
+ };
491
+ type GetConditionHttpError = {
492
+ data: ErrorResponse;
493
+ headers: Headers;
494
+ status: number;
495
+ };
496
+ /**
497
+ * Patch values in the condition
498
+ *
499
+ * @param id The id of the condition
500
+ * @param body an object with the body content
501
+ * @throws PatchConditionHttpError
502
+ */
503
+ declare function patchCondition(id: string, body: ConditionPatch, options?: ApiCallOptions): Promise<PatchConditionHttpResponse>;
504
+ type PatchConditionHttpResponse = {
505
+ data: void;
506
+ headers: Headers;
507
+ status: 204;
508
+ };
509
+ type PatchConditionHttpError = {
510
+ data: ErrorResponse;
511
+ headers: Headers;
512
+ status: number;
513
+ };
514
+ /**
515
+ * Executes the condition
516
+ *
517
+ * @param id The id of the condition
518
+ * @param body an object with the body content
519
+ * @throws CreateConditionEvaluationHttpError
520
+ */
521
+ declare function createConditionEvaluation(id: string, body: CreateEvaluationRequest, options?: ApiCallOptions): Promise<CreateConditionEvaluationHttpResponse>;
522
+ type CreateConditionEvaluationHttpResponse = {
523
+ data: CreateEvaluationResponse;
524
+ headers: Headers;
525
+ status: 201;
526
+ };
527
+ type CreateConditionEvaluationHttpError = {
528
+ data: ErrorResponse;
529
+ headers: Headers;
530
+ status: number;
531
+ };
532
+ /**
533
+ * Delete an Evaluation
534
+ *
535
+ * @param id The id of the condition
536
+ * @param evaluationId The id of the evaluation
537
+ * @throws DeleteConditionEvaluationHttpError
538
+ */
539
+ declare function deleteConditionEvaluation(id: string, evaluationId: string, options?: ApiCallOptions): Promise<DeleteConditionEvaluationHttpResponse>;
540
+ type DeleteConditionEvaluationHttpResponse = {
541
+ data: void;
542
+ headers: Headers;
543
+ status: 204;
544
+ };
545
+ type DeleteConditionEvaluationHttpError = {
546
+ data: ErrorResponse;
547
+ headers: Headers;
548
+ status: number;
549
+ };
550
+ /**
551
+ * Get an Evaluation
552
+ *
553
+ * @param id The id of the condition
554
+ * @param evaluationId The id of the evaluation
555
+ * @throws GetConditionEvaluationHttpError
556
+ */
557
+ declare function getConditionEvaluation(id: string, evaluationId: string, options?: ApiCallOptions): Promise<GetConditionEvaluationHttpResponse>;
558
+ type GetConditionEvaluationHttpResponse = {
559
+ data: GetEvaluationResponse;
560
+ headers: Headers;
561
+ status: 200;
562
+ };
563
+ type GetConditionEvaluationHttpError = {
564
+ data: ErrorResponse;
565
+ headers: Headers;
566
+ status: number;
567
+ };
568
+ /**
569
+ * Clears the cache for conditions api requests.
570
+ */
571
+ declare function clearCache(): void;
572
+ type ConditionsAPI = {
573
+ /**
574
+ * Creates a new condition.
575
+ *
576
+ * @param body an object with the body content
577
+ * @throws CreateConditionHttpError
578
+ */
579
+ createCondition: typeof createCondition;
580
+ /**
581
+ * Create condition preview request.
582
+ *
583
+ * @param body an object with the body content
584
+ * @throws CreateConditionPreviewHttpError
585
+ */
586
+ createConditionPreview: typeof createConditionPreview;
587
+ /**
588
+ * Get condition preview response.
589
+ *
590
+ * @param id The id of the condition
591
+ * @throws GetConditionPreviewHttpError
592
+ */
593
+ getConditionPreview: typeof getConditionPreview;
594
+ /**
595
+ * Retrieves condition manager settings
596
+ *
597
+ * @throws GetConditionsSettingsHttpError
598
+ */
599
+ getConditionsSettings: typeof getConditionsSettings;
600
+ /**
601
+ * Updates API configuration. Accessible only by tenant admins.
602
+ *
603
+ * @param body an object with the body content
604
+ * @throws SetConditionsSettingsHttpError
605
+ */
606
+ setConditionsSettings: typeof setConditionsSettings;
607
+ /**
608
+ * Delete the condition
609
+ *
610
+ * @param id The id of the condition
611
+ * @throws DeleteConditionHttpError
612
+ */
613
+ deleteCondition: typeof deleteCondition;
614
+ /**
615
+ * Retrieve a specific condition by id.
616
+ *
617
+ * @param id The id of the condition
618
+ * @throws GetConditionHttpError
619
+ */
620
+ getCondition: typeof getCondition;
621
+ /**
622
+ * Patch values in the condition
623
+ *
624
+ * @param id The id of the condition
625
+ * @param body an object with the body content
626
+ * @throws PatchConditionHttpError
627
+ */
628
+ patchCondition: typeof patchCondition;
629
+ /**
630
+ * Executes the condition
631
+ *
632
+ * @param id The id of the condition
633
+ * @param body an object with the body content
634
+ * @throws CreateConditionEvaluationHttpError
635
+ */
636
+ createConditionEvaluation: typeof createConditionEvaluation;
637
+ /**
638
+ * Delete an Evaluation
639
+ *
640
+ * @param id The id of the condition
641
+ * @param evaluationId The id of the evaluation
642
+ * @throws DeleteConditionEvaluationHttpError
643
+ */
644
+ deleteConditionEvaluation: typeof deleteConditionEvaluation;
645
+ /**
646
+ * Get an Evaluation
647
+ *
648
+ * @param id The id of the condition
649
+ * @param evaluationId The id of the evaluation
650
+ * @throws GetConditionEvaluationHttpError
651
+ */
652
+ getConditionEvaluation: typeof getConditionEvaluation;
653
+ /**
654
+ * Clears the cache for conditions api requests.
655
+ */
656
+ clearCache: typeof clearCache;
657
+ };
658
+ /**
659
+ * Functions for the conditions api
660
+ */
661
+ declare const conditionsExport: ConditionsAPI;
662
+ //#endregion
4
663
  export { APISettings, APISettingsUpload, CausalEvent, CausalEventData, CausalEventExtensions, CompoundCondition, CompoundConditionData, Condition, ConditionBase, ConditionCreateRequest, ConditionDimensions, ConditionDimensionsInner, ConditionHeaders, ConditionMeasures, ConditionMeasuresInner, ConditionPatch, ConditionPatchInner, ConditionResponse, ConditionsAPI, CreateConditionEvaluationHttpError, CreateConditionEvaluationHttpResponse, CreateConditionHttpError, CreateConditionHttpResponse, CreateConditionPreviewHttpError, CreateConditionPreviewHttpResponse, CreateEvaluationRequest, CreateEvaluationResponse, DataCondition, DataConditionCreateRequest, DeleteConditionEvaluationHttpError, DeleteConditionEvaluationHttpResponse, DeleteConditionHttpError, DeleteConditionHttpResponse, Error, ErrorResponse, Errors, Evaluation, EvaluationError, EvaluationErrorMeta, EvaluationErrors, GetConditionEvaluationHttpError, GetConditionEvaluationHttpResponse, GetConditionHttpError, GetConditionHttpResponse, GetConditionPreviewHttpError, GetConditionPreviewHttpResponse, GetConditionsSettingsHttpError, GetConditionsSettingsHttpResponse, GetEvaluationResponse, HistoryProperties, PatchConditionHttpError, PatchConditionHttpResponse, PreviewEvaluation, PreviewResponse, PreviewStatusResponse, Selections, SelectionsInner, SetConditionsSettingsHttpError, SetConditionsSettingsHttpResponse, SingleErrorResponse, clearCache, createCondition, createConditionEvaluation, createConditionPreview, conditionsExport as default, deleteCondition, deleteConditionEvaluation, getCondition, getConditionEvaluation, getConditionPreview, getConditionsSettings, patchCondition, setConditionsSettings };
package/conditions.js CHANGED
@@ -1,6 +1,5 @@
1
- import "./chunks/utils-BnC4lrlq.js";
2
- import "./chunks/public-runtime-modules-Dwjzb3l8.js";
3
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
1
+ import "./chunks/public-runtime-modules-BqxAMJ9M.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
4
3
 
5
4
  //#region src/public/rest/conditions.ts
6
5
  /**