@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
@@ -1,777 +0,0 @@
1
- import { S as DownloadableBlob, y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/di-projects.d.ts
4
- type AsyncActionDetails = {
5
- endTime?: string;
6
- error?: AsyncActionError;
7
- /** Name of the async operation */
8
- name?: string;
9
- startTime?: string;
10
- /** State of the action */
11
- state?: AsyncCallStatus;
12
- taskDetails?: {
13
- error?: AsyncActionError;
14
- /** Additional details about task state */
15
- info?: string;
16
- name?: string;
17
- /** State of the action */
18
- state?: AsyncCallStatus;
19
- taskId?: string;
20
- }[];
21
- taskProgress?: AsyncActionTaskProgress;
22
- /** Type of action being performed */
23
- type?: AsyncActionType;
24
- };
25
- type AsyncActionError = {
26
- /** Error code */
27
- code?: string;
28
- /** Additional error details */
29
- details?: string;
30
- /** Error message */
31
- message?: string;
32
- };
33
- type AsyncActionRsp = {
34
- /** Identifier for tracking the action */
35
- actionId: string;
36
- };
37
- type AsyncActionTaskProgress = {
38
- /** Number of tasks canceled */
39
- canceled?: number;
40
- /** Number of tasks completed successfully */
41
- completed?: number;
42
- /** Number of tasks currently executing */
43
- executing?: number;
44
- /** Number of tasks that failed */
45
- failed?: number;
46
- /** Number of tasks pending execution */
47
- pending?: number;
48
- /** Number of tasks skipped due to conflicts */
49
- skipped?: number;
50
- };
51
- /**
52
- * Type of action being performed
53
- */
54
- type AsyncActionType = "PROJECT_PREPARE" | "PROJECT_VALIDATE" | "TASK_PREPARE" | "TASK_VALIDATE";
55
- /**
56
- * State of the action
57
- */
58
- type AsyncCallStatus = "PENDING" | "EXECUTING" | "COMPLETED" | "FAILED" | "CANCELED" | "SKIPPED";
59
- type CreateDiProjectReq = {
60
- /** The cloud staging connection string */
61
- cloudStagingConnection?: string;
62
- /** A description of the project */
63
- description?: string;
64
- /** The name of the project */
65
- name?: string;
66
- /** The platform connection string */
67
- platformConnection?: string;
68
- /** The platform type of the project. Supported values: - SNOWFLAKE: Snowflake - BIGQUERY: Google BigQuery - SYNAPSE: Azure Synapse - DATABRICKS: Databricks - REDSHIFT: Amazon Redshift - MSSQL: Microsoft SQL Server - FABRIC: Microsoft Fabric (OneLake) - QLIK_QVD: Qlik-managed QVD - QLIK_QVD_CUSTOMER_MANAGED: Customer-managed QVD */
69
- platformType?: "SNOWFLAKE" | "BIGQUERY" | "SYNAPSE" | "DATABRICKS" | "REDSHIFT" | "MSSQL" | "FABRIC" | "QLIK_QVD" | "QLIK_QVD_CUSTOMER_MANAGED";
70
- /** The ID of the space where the project will be created */
71
- space?: string;
72
- /** The type of the project */
73
- type?: "DATA_PIPELINE" | "DATA_MOVEMENT";
74
- };
75
- type DataTaskDatasetState = {
76
- cdcStatus?: {
77
- /** Number of DDL statements executed during the last run */
78
- ddlCount?: number;
79
- /** delete portion of totalProcessedCount. Only available for some task types */
80
- deleteCount?: number;
81
- /** Insert portion of totalProcessedCount. Only available for some task types */
82
- insertCount?: number;
83
- lastProcessed?: string;
84
- message?: string;
85
- state?: "QUEUED" | "PROCESSING" | "ACCUMULATING_CHANGES" | "COMPLETED" | "ERROR";
86
- /** Total number of changes/DMLs applied to the dataset */
87
- totalProcessedCount?: number;
88
- /** update portion of totalProcessedCount. Only available for some task types */
89
- updateCount?: number;
90
- };
91
- /** Is the data ready for use? */
92
- dataReadiness?: "READY" | "NOT_READY" | "ERROR";
93
- /** Id of the dataset */
94
- datasetId?: string;
95
- fullLoad?: {
96
- /** Number of changes captured and cached during full load (CDC landing/replication tasks only) */
97
- cachedChangesCount?: number;
98
- /** Duration in HH:MM:SS format (hours:minutes:seconds) */
99
- duration?: string;
100
- endTime?: string;
101
- /** Number of records that failed to load (currently only for knowledge marts) */
102
- failedRecordsCount?: number;
103
- message?: string;
104
- startTime?: string;
105
- state?: "QUEUED" | "LOADING" | "COMPLETED" | "ERROR";
106
- /** Number of records (or docs in knowledge marts) were loaded. */
107
- totalProcessedCount?: number;
108
- };
109
- lastBatchOfChanges?: {
110
- /** Duration in HH:MM:SS format (hours:minutes:seconds) */
111
- duration?: string;
112
- endTime?: string;
113
- message?: string;
114
- startTime?: string;
115
- state?: "QUEUED" | "PROCESSING" | "COMPLETED" | "ERROR";
116
- /** Throughput in records per second */
117
- throughputInRecordsPerSecond?: number;
118
- totalProcessedCount?: number;
119
- };
120
- /** Name of the dataset */
121
- name?: string;
122
- /** Original name of the dataset, relevant only for data movement tasks */
123
- sourceName?: string;
124
- };
125
- type DataTaskInstanceState = {
126
- cdcStatus?: {
127
- accumulatingChangesCount?: number;
128
- applyingChangesCount?: number;
129
- /** Duration in HH:MM:SS format (hours:minutes:seconds) */
130
- latency?: string;
131
- /** Throughput in kilobytes per second */
132
- throughputInKilobytesPerSecond?: number;
133
- totalProcessedCount?: number;
134
- };
135
- /** Duration in HH:MM:SS format (hours:minutes:seconds) */
136
- duration?: string;
137
- /** Timestamp indicating when the task instance ended */
138
- endTime?: string;
139
- fullLoad?: {
140
- /** Number of datasets that have completed full load in this task run */
141
- completedCount?: number;
142
- /** Number of datasets that have failed full load in this task run */
143
- errorCount?: number;
144
- /** Number of datasets that are currently being loaded in this task run */
145
- loadingCount?: number;
146
- /** Number of datasets that are queued for full load in this task run */
147
- queuedCount?: number;
148
- };
149
- general?: {
150
- /** The latest point in time the data reflects, based on updates from the source system. */
151
- dataTaskUpdatedTo?: string;
152
- /** Total number of datasets produced by the task, including ones in error */
153
- datasetCount?: number;
154
- /** Count of datasets that encountered errors */
155
- datasetsInErrorCount?: number;
156
- /** For tasks that run on a gateway, this is the id of the gateway */
157
- gatewayId?: string;
158
- /** For tasks that run on a gateway, this is the name of the gateway */
159
- gatewayName?: string;
160
- /** For tasks that run on a gateway, this is the internal name of the task on the gateway */
161
- gatewayTaskName?: string;
162
- /** For lakehouse storage tasks, this is the name of the cluster where the task runs */
163
- lakehouseClusterName?: string;
164
- /** The latest point in time the live views reflect, based on updates from the source system. */
165
- liveViewsUpdatedTo?: string;
166
- };
167
- lastBatchOfChanges?: {
168
- /** This batch starts with operational source changes from this time. */
169
- relatesToRecordsFrom?: string;
170
- /** This batch ends with operational source changes from this time. */
171
- relatesToRecordsTo?: string;
172
- /** Throughput in records per second */
173
- throughputInRecordsPerSecond?: number;
174
- totalProcessedCount?: number;
175
- };
176
- message?: string;
177
- /** Timestamp indicating when the task instance started */
178
- startTime?: string;
179
- state?: "STARTING" | "RUNNING" | "COMPLETED" | "FAILED" | "CANCELED" | "STOPPING";
180
- };
181
- type DataTaskItemRsp = {
182
- description?: string;
183
- id?: string;
184
- name?: string;
185
- ownerId?: string;
186
- spaceId?: string;
187
- type?: DataTaskType;
188
- };
189
- type DataTaskRuntimeState = {
190
- lastRun?: DataTaskInstanceState;
191
- /** Name of the data task */
192
- name?: string;
193
- runReadiness?: {
194
- message?: string;
195
- state?: "READY_TO_RUN" | "ALREADY_RUNNING" | "NOT_RUNNABLE";
196
- };
197
- type?: DataTaskType;
198
- };
199
- type DataTaskType = "LANDING" | "STORAGE" | "QVD_STORAGE" | "TRANSFORM" | "DATAMART" | "REGISTERED_DATA" | "REPLICATION" | "DISTRIBUTION" | "LAKE_LANDING" | "KNOWLEDGE_MART" | "FILE_BASED_KNOWLEDGE_MART" | "LAKEHOUSE_STORAGE" | "LAKEHOUSE_MIRROR";
200
- type DiProjectItemRsp = {
201
- description?: string;
202
- id?: string;
203
- name?: string;
204
- ownerId?: string;
205
- spaceId?: string;
206
- };
207
- type DiProjectOperationSelectedTask = {
208
- /** Task identifier */
209
- taskId: string;
210
- };
211
- type Error = {
212
- code?: string;
213
- detail?: string;
214
- source?: ErrorSource;
215
- status?: number;
216
- title?: string;
217
- };
218
- type ErrorSource = {
219
- parameter?: string;
220
- pointer?: string;
221
- };
222
- type Errors = {
223
- errors?: Error[];
224
- traceId?: string;
225
- };
226
- type ExportDiProjectReq = {
227
- /** Include bindings in the exported zip file (optional, default is false) */
228
- includeBindings?: boolean;
229
- };
230
- type GetDiExportProjectVariablesRsp = {
231
- nameToIdMap?: Record<string, string>;
232
- variables?: Record<string, string>;
233
- };
234
- type ImportDiProjectRsp = unknown;
235
- type ListDataTasksRsp = {
236
- dataTasks?: DataTaskItemRsp[];
237
- };
238
- type ListDiProjectsRsp = {
239
- projects?: DiProjectItemRsp[];
240
- };
241
- type PrepareProjectReq = {
242
- allowRecreate?: boolean;
243
- /** Array of tasks to prepare. Leave empty to trigger project-level orchestration using built-in logic (same as in the user interface). */
244
- selectedTasks?: TaskSelectionList;
245
- };
246
- type PrepareTaskReq = {
247
- /** Allow recreation of existing artifacts */
248
- allowRecreate: boolean;
249
- };
250
- type ReloadDiTaskReq = {
251
- /** Reload strategy (optional, applies to materialized SQL transformations and transformation flows tasks) */
252
- reloadStrategy?: "NONE" | "TRUNCATE" | "COMPARE_AND_APPLY";
253
- /** Datasets to reload (optional, if omitted or empty, all datasets will be reloaded). */
254
- selectedDatasets?: {
255
- datasetId?: string;
256
- }[];
257
- };
258
- /**
259
- * Indicates whether the reload request was registered successfully.
260
- */
261
- type ReloadRequestResponse = {
262
- /** Always true when the server successfully registers the request. */
263
- success: boolean;
264
- };
265
- /**
266
- * Array of tasks to prepare. Leave empty to trigger project-level orchestration using built-in logic (same as in the user interface).
267
- */
268
- type TaskSelectionList = DiProjectOperationSelectedTask[];
269
- type UpdateDiExportProjectVariablesReq = {
270
- variables?: Record<string, string>;
271
- };
272
- type UpdateDiExportProjectVariablesRsp = unknown;
273
- type ValidateProjectReq = {
274
- /** Array of tasks to prepare. Leave empty to trigger project-level orchestration using built-in logic (same as in the user interface). */
275
- selectedTasks?: TaskSelectionList;
276
- };
277
- /**
278
- * Request body for task validation
279
- */
280
- type ValidateTaskReq = unknown;
281
- /**
282
- * List data integration projects.
283
- *
284
- * @param query an object with query parameters
285
- * @throws GetDiProjectsHttpError
286
- */
287
- declare function getDiProjects(query: {
288
- /** Filter by space id */
289
- spaceId?: string;
290
- }, options?: ApiCallOptions): Promise<GetDiProjectsHttpResponse>;
291
- type GetDiProjectsHttpResponse = {
292
- data: ListDiProjectsRsp;
293
- headers: Headers;
294
- status: 200;
295
- };
296
- type GetDiProjectsHttpError = {
297
- data: Errors;
298
- headers: Headers;
299
- status: 400 | 404;
300
- };
301
- /**
302
- * Creates a new data integration project in the specified space.
303
- *
304
- * @param body an object with the body content
305
- * @throws CreateDiProjectHttpError
306
- */
307
- declare function createDiProject(body: CreateDiProjectReq, options?: ApiCallOptions): Promise<CreateDiProjectHttpResponse>;
308
- type CreateDiProjectHttpResponse = {
309
- data: DiProjectItemRsp;
310
- headers: Headers;
311
- status: 201;
312
- };
313
- type CreateDiProjectHttpError = {
314
- data: Errors;
315
- headers: Headers;
316
- status: 400 | 500;
317
- };
318
- /**
319
- * Retrieves the status of an asynchronous operation.
320
- *
321
- * @param actionId Identifier of the action.
322
- * @param query an object with query parameters
323
- * @throws GetDiProjectHttpError
324
- */
325
- declare function getDiProject(actionId: string, query: {
326
- /** Specifies whether to include detailed status information in the response. Set to `true` to return detailed information. */
327
- detailed?: boolean;
328
- }, options?: ApiCallOptions): Promise<GetDiProjectHttpResponse>;
329
- type GetDiProjectHttpResponse = {
330
- data: AsyncActionDetails;
331
- headers: Headers;
332
- status: 200;
333
- };
334
- type GetDiProjectHttpError = {
335
- data: Errors;
336
- headers: Headers;
337
- status: 404;
338
- };
339
- /**
340
- * Exports the specified data integration project.
341
- *
342
- * @param projectId Identifier of the data project.
343
- * @param body an object with the body content
344
- * @throws ExportDiProjectHttpError
345
- */
346
- declare function exportDiProject(projectId: string, body: ExportDiProjectReq, options?: ApiCallOptions): Promise<ExportDiProjectHttpResponse>;
347
- type ExportDiProjectHttpResponse = {
348
- data: DownloadableBlob;
349
- headers: Headers;
350
- status: 200;
351
- };
352
- type ExportDiProjectHttpError = {
353
- data: Errors;
354
- headers: Headers;
355
- status: 400 | 404 | 500;
356
- };
357
- /**
358
- * Imports a data integration project from a `.zip` file.
359
- *
360
- * @param projectId Identifier of the data project.
361
- * @param body an object with the body content
362
- * @throws ImportDiProjectHttpError
363
- */
364
- declare function importDiProject(projectId: string, body: {
365
- zip?: BodyInit;
366
- }, options?: ApiCallOptions): Promise<ImportDiProjectHttpResponse>;
367
- type ImportDiProjectHttpResponse = {
368
- data: ImportDiProjectRsp;
369
- headers: Headers;
370
- status: 200;
371
- };
372
- type ImportDiProjectHttpError = {
373
- data: Errors;
374
- headers: Headers;
375
- status: 400 | 404 | 500;
376
- };
377
- /**
378
- * Prepares the data integration project and its tasks for execution.
379
- *
380
- * @param projectId Identifier of the data project.
381
- * @param body an object with the body content
382
- * @throws PrepareDiProjectHttpError
383
- */
384
- declare function prepareDiProject(projectId: string, body: PrepareProjectReq, options?: ApiCallOptions): Promise<PrepareDiProjectHttpResponse>;
385
- type PrepareDiProjectHttpResponse = {
386
- data: AsyncActionRsp;
387
- headers: Headers;
388
- status: 202;
389
- };
390
- type PrepareDiProjectHttpError = {
391
- data: Errors;
392
- headers: Headers;
393
- status: 400 | 404;
394
- };
395
- /**
396
- * Validates the data integration project and its tasks.
397
- *
398
- * @param projectId Identifier of the data project.
399
- * @param body an object with the body content
400
- * @throws ValidateDiProjectHttpError
401
- */
402
- declare function validateDiProject(projectId: string, body: ValidateProjectReq, options?: ApiCallOptions): Promise<ValidateDiProjectHttpResponse>;
403
- type ValidateDiProjectHttpResponse = {
404
- data: AsyncActionRsp;
405
- headers: Headers;
406
- status: 202;
407
- };
408
- type ValidateDiProjectHttpError = {
409
- data: Errors;
410
- headers: Headers;
411
- status: 400 | 404;
412
- };
413
- /**
414
- * Retrieves the export variables for a specific data integration project.
415
- *
416
- * @param projectId Identifier of the data project.
417
- * @param query an object with query parameters
418
- * @throws GetDiProjectExportVariablesHttpError
419
- */
420
- declare function getDiProjectExportVariables(projectId: string, query: {
421
- /** Recalculate the bindings if true, otherwise saved bindings are returned. */
422
- recalculate?: boolean;
423
- }, options?: ApiCallOptions): Promise<GetDiProjectExportVariablesHttpResponse>;
424
- type GetDiProjectExportVariablesHttpResponse = {
425
- data: GetDiExportProjectVariablesRsp;
426
- headers: Headers;
427
- status: 200;
428
- };
429
- type GetDiProjectExportVariablesHttpError = {
430
- data: Errors;
431
- headers: Headers;
432
- status: 400 | 404;
433
- };
434
- /**
435
- * Updates the export variables for a specific data integration project.
436
- *
437
- * @param projectId Identifier of the data project.
438
- * @param body an object with the body content
439
- * @throws SetDiProjectExportVariablesHttpError
440
- */
441
- declare function setDiProjectExportVariables(projectId: string, body: UpdateDiExportProjectVariablesReq, options?: ApiCallOptions): Promise<SetDiProjectExportVariablesHttpResponse>;
442
- type SetDiProjectExportVariablesHttpResponse = {
443
- data: UpdateDiExportProjectVariablesRsp;
444
- headers: Headers;
445
- status: 200;
446
- };
447
- type SetDiProjectExportVariablesHttpError = {
448
- data: Errors;
449
- headers: Headers;
450
- status: 400 | 404 | 500;
451
- };
452
- /**
453
- * Lists data tasks within a given data integration project.
454
- *
455
- * @param projectId Identifier of the data project.
456
- * @throws GetDiProjectDiTasksHttpError
457
- */
458
- declare function getDiProjectDiTasks(projectId: string, options?: ApiCallOptions): Promise<GetDiProjectDiTasksHttpResponse>;
459
- type GetDiProjectDiTasksHttpResponse = {
460
- data: ListDataTasksRsp;
461
- headers: Headers;
462
- status: 200;
463
- };
464
- type GetDiProjectDiTasksHttpError = {
465
- data: Errors;
466
- headers: Headers;
467
- status: 400 | 404;
468
- };
469
- /**
470
- * Get a specific data task within a project.
471
- *
472
- * @param projectId Identifier of the data project.
473
- * @param dataTaskId Identifier of the data task.
474
- * @throws GetDiProjectDiTaskHttpError
475
- */
476
- declare function getDiProjectDiTask(projectId: string, dataTaskId: string, options?: ApiCallOptions): Promise<GetDiProjectDiTaskHttpResponse>;
477
- type GetDiProjectDiTaskHttpResponse = {
478
- data: DataTaskItemRsp;
479
- headers: Headers;
480
- status: 200;
481
- };
482
- type GetDiProjectDiTaskHttpError = {
483
- data: Errors;
484
- headers: Headers;
485
- status: 400 | 404;
486
- };
487
- /**
488
- * Prepares the specified data task for execution.
489
- *
490
- * @param projectId Identifier of the data project.
491
- * @param dataTaskId Identifier of the data task.
492
- * @param body an object with the body content
493
- * @throws PrepareDiProjectDiTaskHttpError
494
- */
495
- declare function prepareDiProjectDiTask(projectId: string, dataTaskId: string, body: PrepareTaskReq, options?: ApiCallOptions): Promise<PrepareDiProjectDiTaskHttpResponse>;
496
- type PrepareDiProjectDiTaskHttpResponse = {
497
- data: AsyncActionRsp;
498
- headers: Headers;
499
- status: 202;
500
- };
501
- type PrepareDiProjectDiTaskHttpError = {
502
- data: Errors;
503
- headers: Headers;
504
- status: 400 | 404;
505
- };
506
- /**
507
- * Registers a request to reload the datasets associated with the specified data task. The reload does not occur immediately; it will take effect on the next scheduled or manual run of the task.
508
- *
509
- * @param projectId Identifier of the data project.
510
- * @param dataTaskId Identifier of the data task.
511
- * @param body an object with the body content
512
- * @throws RequestReloadDiProjectDiTaskHttpError
513
- */
514
- declare function requestReloadDiProjectDiTask(projectId: string, dataTaskId: string, body: ReloadDiTaskReq, options?: ApiCallOptions): Promise<RequestReloadDiProjectDiTaskHttpResponse>;
515
- type RequestReloadDiProjectDiTaskHttpResponse = {
516
- data: ReloadRequestResponse;
517
- headers: Headers;
518
- status: 200;
519
- };
520
- type RequestReloadDiProjectDiTaskHttpError = {
521
- data: Errors;
522
- headers: Headers;
523
- status: 400 | 404;
524
- };
525
- /**
526
- * Validates the specified data task.
527
- *
528
- * @param projectId Identifier of the data project.
529
- * @param dataTaskId Identifier of the data task.
530
- * @param body an object with the body content
531
- * @throws ValidateDiProjectDiTaskHttpError
532
- */
533
- declare function validateDiProjectDiTask(projectId: string, dataTaskId: string, body: ValidateTaskReq, options?: ApiCallOptions): Promise<ValidateDiProjectDiTaskHttpResponse>;
534
- type ValidateDiProjectDiTaskHttpResponse = {
535
- data: AsyncActionRsp;
536
- headers: Headers;
537
- status: 202;
538
- };
539
- type ValidateDiProjectDiTaskHttpError = {
540
- data: Errors;
541
- headers: Headers;
542
- status: 400 | 404;
543
- };
544
- /**
545
- * Start a data task on a data integration project.
546
- *
547
- * @param projectId Identifier of the data project.
548
- * @param dataTaskId Identifier of the data task.
549
- * @throws StartDiProjectDiTaskRuntimeHttpError
550
- */
551
- declare function startDiProjectDiTaskRuntime(projectId: string, dataTaskId: string, options?: ApiCallOptions): Promise<StartDiProjectDiTaskRuntimeHttpResponse>;
552
- type StartDiProjectDiTaskRuntimeHttpResponse = {
553
- data: void;
554
- headers: Headers;
555
- status: 204;
556
- };
557
- type StartDiProjectDiTaskRuntimeHttpError = {
558
- data: Errors;
559
- headers: Headers;
560
- status: 400 | 404;
561
- };
562
- /**
563
- * Stop a data task on a data integration project.
564
- *
565
- * @param projectId Identifier of the data project.
566
- * @param dataTaskId Identifier of the data task.
567
- * @throws StopDiProjectDiTaskRuntimeHttpError
568
- */
569
- declare function stopDiProjectDiTaskRuntime(projectId: string, dataTaskId: string, options?: ApiCallOptions): Promise<StopDiProjectDiTaskRuntimeHttpResponse>;
570
- type StopDiProjectDiTaskRuntimeHttpResponse = {
571
- data: void;
572
- headers: Headers;
573
- status: 204;
574
- };
575
- type StopDiProjectDiTaskRuntimeHttpError = {
576
- data: Errors;
577
- headers: Headers;
578
- status: 400 | 404;
579
- };
580
- /**
581
- * Get the current runtime state of a data task
582
- *
583
- * @param projectId Identifier of the data project.
584
- * @param dataTaskId Identifier of the data task.
585
- * @throws GetDiProjectDiTaskRuntimeStateHttpError
586
- */
587
- declare function getDiProjectDiTaskRuntimeState(projectId: string, dataTaskId: string, options?: ApiCallOptions): Promise<GetDiProjectDiTaskRuntimeStateHttpResponse>;
588
- type GetDiProjectDiTaskRuntimeStateHttpResponse = {
589
- data: DataTaskRuntimeState;
590
- headers: Headers;
591
- status: 200;
592
- };
593
- type GetDiProjectDiTaskRuntimeStateHttpError = {
594
- data: Errors;
595
- headers: Headers;
596
- status: 400 | 404;
597
- };
598
- /**
599
- * Returns dataset-level runtime state for a data task
600
- *
601
- * @param projectId Identifier of the data project.
602
- * @param dataTaskId Identifier of the data task.
603
- * @throws GetDiProjectDiTaskRuntimeStateDatasetsHttpError
604
- */
605
- declare function getDiProjectDiTaskRuntimeStateDatasets(projectId: string, dataTaskId: string, options?: ApiCallOptions): Promise<GetDiProjectDiTaskRuntimeStateDatasetsHttpResponse>;
606
- type GetDiProjectDiTaskRuntimeStateDatasetsHttpResponse = {
607
- data: {
608
- datasets?: DataTaskDatasetState[];
609
- };
610
- headers: Headers;
611
- status: 200;
612
- };
613
- type GetDiProjectDiTaskRuntimeStateDatasetsHttpError = {
614
- data: Errors;
615
- headers: Headers;
616
- status: 400 | 404;
617
- };
618
- /**
619
- * Clears the cache for di-projects api requests.
620
- */
621
- declare function clearCache(): void;
622
- type DiProjectsAPI = {
623
- /**
624
- * List data integration projects.
625
- *
626
- * @param query an object with query parameters
627
- * @throws GetDiProjectsHttpError
628
- */
629
- getDiProjects: typeof getDiProjects;
630
- /**
631
- * Creates a new data integration project in the specified space.
632
- *
633
- * @param body an object with the body content
634
- * @throws CreateDiProjectHttpError
635
- */
636
- createDiProject: typeof createDiProject;
637
- /**
638
- * Retrieves the status of an asynchronous operation.
639
- *
640
- * @param actionId Identifier of the action.
641
- * @param query an object with query parameters
642
- * @throws GetDiProjectHttpError
643
- */
644
- getDiProject: typeof getDiProject;
645
- /**
646
- * Exports the specified data integration project.
647
- *
648
- * @param projectId Identifier of the data project.
649
- * @param body an object with the body content
650
- * @throws ExportDiProjectHttpError
651
- */
652
- exportDiProject: typeof exportDiProject;
653
- /**
654
- * Imports a data integration project from a `.zip` file.
655
- *
656
- * @param projectId Identifier of the data project.
657
- * @param body an object with the body content
658
- * @throws ImportDiProjectHttpError
659
- */
660
- importDiProject: typeof importDiProject;
661
- /**
662
- * Prepares the data integration project and its tasks for execution.
663
- *
664
- * @param projectId Identifier of the data project.
665
- * @param body an object with the body content
666
- * @throws PrepareDiProjectHttpError
667
- */
668
- prepareDiProject: typeof prepareDiProject;
669
- /**
670
- * Validates the data integration project and its tasks.
671
- *
672
- * @param projectId Identifier of the data project.
673
- * @param body an object with the body content
674
- * @throws ValidateDiProjectHttpError
675
- */
676
- validateDiProject: typeof validateDiProject;
677
- /**
678
- * Retrieves the export variables for a specific data integration project.
679
- *
680
- * @param projectId Identifier of the data project.
681
- * @param query an object with query parameters
682
- * @throws GetDiProjectExportVariablesHttpError
683
- */
684
- getDiProjectExportVariables: typeof getDiProjectExportVariables;
685
- /**
686
- * Updates the export variables for a specific data integration project.
687
- *
688
- * @param projectId Identifier of the data project.
689
- * @param body an object with the body content
690
- * @throws SetDiProjectExportVariablesHttpError
691
- */
692
- setDiProjectExportVariables: typeof setDiProjectExportVariables;
693
- /**
694
- * Lists data tasks within a given data integration project.
695
- *
696
- * @param projectId Identifier of the data project.
697
- * @throws GetDiProjectDiTasksHttpError
698
- */
699
- getDiProjectDiTasks: typeof getDiProjectDiTasks;
700
- /**
701
- * Get a specific data task within a project.
702
- *
703
- * @param projectId Identifier of the data project.
704
- * @param dataTaskId Identifier of the data task.
705
- * @throws GetDiProjectDiTaskHttpError
706
- */
707
- getDiProjectDiTask: typeof getDiProjectDiTask;
708
- /**
709
- * Prepares the specified data task for execution.
710
- *
711
- * @param projectId Identifier of the data project.
712
- * @param dataTaskId Identifier of the data task.
713
- * @param body an object with the body content
714
- * @throws PrepareDiProjectDiTaskHttpError
715
- */
716
- prepareDiProjectDiTask: typeof prepareDiProjectDiTask;
717
- /**
718
- * Registers a request to reload the datasets associated with the specified data task. The reload does not occur immediately; it will take effect on the next scheduled or manual run of the task.
719
- *
720
- * @param projectId Identifier of the data project.
721
- * @param dataTaskId Identifier of the data task.
722
- * @param body an object with the body content
723
- * @throws RequestReloadDiProjectDiTaskHttpError
724
- */
725
- requestReloadDiProjectDiTask: typeof requestReloadDiProjectDiTask;
726
- /**
727
- * Validates the specified data task.
728
- *
729
- * @param projectId Identifier of the data project.
730
- * @param dataTaskId Identifier of the data task.
731
- * @param body an object with the body content
732
- * @throws ValidateDiProjectDiTaskHttpError
733
- */
734
- validateDiProjectDiTask: typeof validateDiProjectDiTask;
735
- /**
736
- * Start a data task on a data integration project.
737
- *
738
- * @param projectId Identifier of the data project.
739
- * @param dataTaskId Identifier of the data task.
740
- * @throws StartDiProjectDiTaskRuntimeHttpError
741
- */
742
- startDiProjectDiTaskRuntime: typeof startDiProjectDiTaskRuntime;
743
- /**
744
- * Stop a data task on a data integration project.
745
- *
746
- * @param projectId Identifier of the data project.
747
- * @param dataTaskId Identifier of the data task.
748
- * @throws StopDiProjectDiTaskRuntimeHttpError
749
- */
750
- stopDiProjectDiTaskRuntime: typeof stopDiProjectDiTaskRuntime;
751
- /**
752
- * Get the current runtime state of a data task
753
- *
754
- * @param projectId Identifier of the data project.
755
- * @param dataTaskId Identifier of the data task.
756
- * @throws GetDiProjectDiTaskRuntimeStateHttpError
757
- */
758
- getDiProjectDiTaskRuntimeState: typeof getDiProjectDiTaskRuntimeState;
759
- /**
760
- * Returns dataset-level runtime state for a data task
761
- *
762
- * @param projectId Identifier of the data project.
763
- * @param dataTaskId Identifier of the data task.
764
- * @throws GetDiProjectDiTaskRuntimeStateDatasetsHttpError
765
- */
766
- getDiProjectDiTaskRuntimeStateDatasets: typeof getDiProjectDiTaskRuntimeStateDatasets;
767
- /**
768
- * Clears the cache for di-projects api requests.
769
- */
770
- clearCache: typeof clearCache;
771
- };
772
- /**
773
- * Functions for the di-projects api
774
- */
775
- declare const diProjectsExport: DiProjectsAPI;
776
- //#endregion
777
- export { RequestReloadDiProjectDiTaskHttpResponse as $, GetDiProjectDiTaskRuntimeStateHttpResponse as A, setDiProjectExportVariables as At, ImportDiProjectHttpResponse as B, ExportDiProjectReq as C, getDiProjectDiTasks as Ct, GetDiProjectDiTaskRuntimeStateDatasetsHttpError as D, prepareDiProject as Dt, GetDiProjectDiTaskHttpResponse as E, importDiProject as Et, GetDiProjectHttpError as F, PrepareDiProjectDiTaskHttpResponse as G, ListDataTasksRsp as H, GetDiProjectHttpResponse as I, PrepareProjectReq as J, PrepareDiProjectHttpError as K, GetDiProjectsHttpError as L, GetDiProjectDiTasksHttpResponse as M, stopDiProjectDiTaskRuntime as Mt, GetDiProjectExportVariablesHttpError as N, validateDiProject as Nt, GetDiProjectDiTaskRuntimeStateDatasetsHttpResponse as O, prepareDiProjectDiTask as Ot, GetDiProjectExportVariablesHttpResponse as P, validateDiProjectDiTask as Pt, RequestReloadDiProjectDiTaskHttpError as Q, GetDiProjectsHttpResponse as R, ExportDiProjectHttpResponse as S, getDiProjectDiTaskRuntimeStateDatasets as St, GetDiProjectDiTaskHttpError as T, getDiProjects as Tt, ListDiProjectsRsp as U, ImportDiProjectRsp as V, PrepareDiProjectDiTaskHttpError as W, ReloadDiTaskReq as X, PrepareTaskReq as Y, ReloadRequestResponse as Z, DiProjectsAPI as _, diProjectsExport as _t, AsyncActionType as a, StopDiProjectDiTaskRuntimeHttpResponse as at, Errors as b, getDiProjectDiTask as bt, CreateDiProjectHttpResponse as c, UpdateDiExportProjectVariablesRsp as ct, DataTaskInstanceState as d, ValidateDiProjectHttpError as dt, SetDiProjectExportVariablesHttpError as et, DataTaskItemRsp as f, ValidateDiProjectHttpResponse as ft, DiProjectOperationSelectedTask as g, createDiProject as gt, DiProjectItemRsp as h, clearCache as ht, AsyncActionTaskProgress as i, StopDiProjectDiTaskRuntimeHttpError as it, GetDiProjectDiTasksHttpError as j, startDiProjectDiTaskRuntime as jt, GetDiProjectDiTaskRuntimeStateHttpError as k, requestReloadDiProjectDiTask as kt, CreateDiProjectReq as l, ValidateDiProjectDiTaskHttpError as lt, DataTaskType as m, ValidateTaskReq as mt, AsyncActionError as n, StartDiProjectDiTaskRuntimeHttpError as nt, AsyncCallStatus as o, TaskSelectionList as ot, DataTaskRuntimeState as p, ValidateProjectReq as pt, PrepareDiProjectHttpResponse as q, AsyncActionRsp as r, StartDiProjectDiTaskRuntimeHttpResponse as rt, CreateDiProjectHttpError as s, UpdateDiExportProjectVariablesReq as st, AsyncActionDetails as t, SetDiProjectExportVariablesHttpResponse as tt, DataTaskDatasetState as u, ValidateDiProjectDiTaskHttpResponse as ut, Error as v, exportDiProject as vt, GetDiExportProjectVariablesRsp as w, getDiProjectExportVariables as wt, ExportDiProjectHttpError as x, getDiProjectDiTaskRuntimeState as xt, ErrorSource as y, getDiProject as yt, ImportDiProjectHttpError as z };