@qlik/api 1.30.0 → 1.32.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.
Files changed (138) hide show
  1. package/api-keys.d.ts +2 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +4 -2
  4. package/apps.js +2 -2
  5. package/assistants.d.ts +1301 -0
  6. package/assistants.js +273 -0
  7. package/audits.d.ts +2 -2
  8. package/audits.js +2 -2
  9. package/{auth-types-PkN9CAF_.d.ts → auth-types-DqfMuSRX.d.ts} +1 -0
  10. package/auth.d.ts +27 -3
  11. package/auth.js +8 -4
  12. package/automation-connections.d.ts +366 -0
  13. package/automation-connections.js +91 -0
  14. package/automations.d.ts +2 -2
  15. package/automations.js +2 -2
  16. package/automl-deployments.d.ts +97 -0
  17. package/automl-deployments.js +27 -0
  18. package/automl-predictions.d.ts +214 -0
  19. package/automl-predictions.js +72 -0
  20. package/brands.d.ts +2 -2
  21. package/brands.js +2 -2
  22. package/chunks/{JIX6RMFP.js → 6ZONDHRN.js} +1 -1
  23. package/chunks/ETNHFALU.js +61 -0
  24. package/chunks/{G6QUM5WQ.js → FKDGGR2O.js} +137 -45
  25. package/chunks/{TXC5XORK.js → LTNGXTXG.js} +3 -3
  26. package/chunks/{OTTC4QSX.js → LY7RP2HA.js} +7 -3
  27. package/chunks/{FKCZFVJL.js → M64RLKVG.js} +2074 -12
  28. package/chunks/{F5UDCCRD.js → PLVPW5IR.js} +1 -1
  29. package/chunks/{QK4TMJ64.js → RCLKKVYB.js} +11 -1
  30. package/chunks/{QWQLGDMI.js → UZTIZ4H5.js} +392 -372
  31. package/chunks/{PTDXR7AY.js → VVD2DPKQ.js} +2 -2
  32. package/chunks/{IQBP2PKS.js → YTT2FEVE.js} +1 -1
  33. package/collections.d.ts +3 -3
  34. package/collections.js +2 -2
  35. package/conditions.d.ts +662 -0
  36. package/conditions.js +113 -0
  37. package/consumption.d.ts +182 -0
  38. package/consumption.js +24 -0
  39. package/csp-origins.d.ts +2 -2
  40. package/csp-origins.js +2 -2
  41. package/csrf-token.d.ts +62 -0
  42. package/csrf-token.js +23 -0
  43. package/data-alerts.d.ts +1004 -0
  44. package/data-alerts.js +155 -0
  45. package/data-assets.d.ts +2 -2
  46. package/data-assets.js +2 -2
  47. package/data-connections.d.ts +7 -7
  48. package/data-connections.js +2 -2
  49. package/data-credentials.d.ts +2 -2
  50. package/data-credentials.js +2 -2
  51. package/data-files.d.ts +2 -2
  52. package/data-files.js +2 -2
  53. package/data-qualities.d.ts +175 -0
  54. package/data-qualities.js +44 -0
  55. package/data-sets.d.ts +424 -0
  56. package/data-sets.js +75 -0
  57. package/data-sources.d.ts +268 -0
  58. package/data-sources.js +39 -0
  59. package/data-stores.d.ts +537 -0
  60. package/data-stores.js +108 -0
  61. package/dcaas.d.ts +192 -0
  62. package/dcaas.js +39 -0
  63. package/di-projects.d.ts +673 -0
  64. package/di-projects.js +164 -0
  65. package/docs/authentication.md +47 -0
  66. package/encryption.d.ts +370 -0
  67. package/encryption.js +98 -0
  68. package/extensions.d.ts +2 -2
  69. package/extensions.js +2 -2
  70. package/glossaries.d.ts +2 -2
  71. package/glossaries.js +2 -2
  72. package/groups.d.ts +5 -4
  73. package/groups.js +2 -2
  74. package/identity-providers.d.ts +2 -2
  75. package/identity-providers.js +2 -2
  76. package/index.d.ts +110 -4
  77. package/index.js +556 -4
  78. package/interceptors.d.ts +2 -2
  79. package/{invoke-fetch-types-BXn-uSF5.d.ts → invoke-fetch-types-Cq7bjkqn.d.ts} +10 -2
  80. package/items.d.ts +3 -3
  81. package/items.js +2 -2
  82. package/knowledgebases.d.ts +890 -0
  83. package/knowledgebases.js +169 -0
  84. package/licenses.d.ts +6 -3
  85. package/licenses.js +2 -2
  86. package/lineage-graphs.d.ts +712 -0
  87. package/lineage-graphs.js +92 -0
  88. package/ml.d.ts +2628 -0
  89. package/ml.js +384 -0
  90. package/notes.d.ts +110 -0
  91. package/notes.js +31 -0
  92. package/notifications.d.ts +98 -0
  93. package/notifications.js +24 -0
  94. package/oauth-clients.d.ts +7 -2
  95. package/oauth-clients.js +2 -2
  96. package/oauth-tokens.d.ts +126 -0
  97. package/oauth-tokens.js +31 -0
  98. package/package.json +29 -2
  99. package/qix.d.ts +421 -26
  100. package/qix.js +2 -2
  101. package/questions.d.ts +364 -0
  102. package/questions.js +34 -0
  103. package/quotas.d.ts +2 -2
  104. package/quotas.js +2 -2
  105. package/reload-tasks.d.ts +4 -2
  106. package/reload-tasks.js +2 -2
  107. package/reloads.d.ts +4 -2
  108. package/reloads.js +2 -2
  109. package/report-templates.d.ts +287 -0
  110. package/report-templates.js +80 -0
  111. package/reports.d.ts +2 -2
  112. package/reports.js +2 -2
  113. package/roles.d.ts +2 -2
  114. package/roles.js +2 -2
  115. package/sharing-tasks.d.ts +952 -0
  116. package/sharing-tasks.js +105 -0
  117. package/spaces.d.ts +3 -7
  118. package/spaces.js +2 -2
  119. package/tasks.d.ts +564 -0
  120. package/tasks.js +106 -0
  121. package/temp-contents.d.ts +2 -2
  122. package/temp-contents.js +2 -2
  123. package/tenants.d.ts +2 -2
  124. package/tenants.js +2 -2
  125. package/themes.d.ts +2 -2
  126. package/themes.js +2 -2
  127. package/transports.d.ts +2 -2
  128. package/transports.js +2 -2
  129. package/ui-config.d.ts +274 -0
  130. package/ui-config.js +77 -0
  131. package/users.d.ts +2 -2
  132. package/users.js +2 -2
  133. package/web-integrations.d.ts +2 -2
  134. package/web-integrations.js +2 -2
  135. package/web-notifications.d.ts +2 -2
  136. package/web-notifications.js +2 -2
  137. package/webhooks.d.ts +2 -2
  138. package/webhooks.js +2 -2
@@ -0,0 +1,673 @@
1
+ import { A as ApiCallOptions, D as DownloadableBlob } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
+
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 */
69
+ platformType?: "SNOWFLAKE" | "BIGQUERY" | "SYNAPSE" | "DATABRICKS" | "REDSHIFT" | "MSSQL" | "FABRIC";
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 DataTaskInstanceState = {
76
+ message?: string;
77
+ state?: "STARTING" | "RUNNING" | "COMPLETED" | "FAILED" | "CANCELED";
78
+ };
79
+ type DataTaskItemRsp = {
80
+ description?: string;
81
+ id?: string;
82
+ name?: string;
83
+ ownerId?: string;
84
+ spaceId?: string;
85
+ type?: DataTaskType;
86
+ };
87
+ type DataTaskType = "LANDING" | "STORAGE" | "QVD_STORAGE" | "TRANSFORM" | "DATAMART" | "REGISTERED_DATA" | "REPLICATION" | "DISTRIBUTION" | "LAKE_LANDING";
88
+ type DiProjectItemRsp = {
89
+ description?: string;
90
+ id?: string;
91
+ name?: string;
92
+ ownerId?: string;
93
+ spaceId?: string;
94
+ };
95
+ type DiProjectOperationSelectedTask = {
96
+ /** Task identifier */
97
+ taskId: string;
98
+ };
99
+ type Error = {
100
+ code?: string;
101
+ detail?: string;
102
+ source?: ErrorSource;
103
+ status?: number;
104
+ title?: string;
105
+ };
106
+ type ErrorSource = {
107
+ parameter?: string;
108
+ pointer?: string;
109
+ };
110
+ type Errors = {
111
+ errors?: Error[];
112
+ traceId?: string;
113
+ };
114
+ type ExportDiProjectReq = {
115
+ /** Include bindings in the exported zip file (optional, default is false) */
116
+ includeBindings?: boolean;
117
+ };
118
+ type GetDiExportProjectVariablesRsp = {
119
+ variables?: Record<string, string>;
120
+ };
121
+ type ImportDiProjectRsp = unknown;
122
+ type ListDataTasksRsp = {
123
+ dataTasks?: DataTaskItemRsp[];
124
+ };
125
+ type ListDiProjectsRsp = {
126
+ projects?: DiProjectItemRsp[];
127
+ };
128
+ type PrepareProjectReq = {
129
+ allowRecreate?: boolean;
130
+ /** Array of tasks to prepare. Leave empty to trigger project-level orchestration using built-in logic (same as in the user interface). */
131
+ selectedTasks?: TaskSelectionList;
132
+ };
133
+ type PrepareTaskReq = {
134
+ /** Allow recreation of existing artifacts */
135
+ allowRecreate: boolean;
136
+ };
137
+ /**
138
+ * Array of tasks to prepare. Leave empty to trigger project-level orchestration using built-in logic (same as in the user interface).
139
+ */
140
+ type TaskSelectionList = DiProjectOperationSelectedTask[];
141
+ type UpdateDiExportProjectVariablesReq = {
142
+ variables?: Record<string, string>;
143
+ };
144
+ type UpdateDiExportProjectVariablesRsp = unknown;
145
+ type ValidateProjectReq = {
146
+ /** Array of tasks to prepare. Leave empty to trigger project-level orchestration using built-in logic (same as in the user interface). */
147
+ selectedTasks?: TaskSelectionList;
148
+ };
149
+ /**
150
+ * Request body for task validation
151
+ */
152
+ type ValidateTaskReq = unknown;
153
+ /**
154
+ * List data integration projects.
155
+ *
156
+ * @param query an object with query parameters
157
+ * @throws GetDiProjectsHttpError
158
+ */
159
+ declare const getDiProjects: (query: {
160
+ /** Filter by space id */
161
+ spaceId?: string;
162
+ }, options?: ApiCallOptions) => Promise<GetDiProjectsHttpResponse>;
163
+ type GetDiProjectsHttpResponse = {
164
+ data: ListDiProjectsRsp;
165
+ headers: Headers;
166
+ status: 200;
167
+ };
168
+ type GetDiProjectsHttpError = {
169
+ data: Errors;
170
+ headers: Headers;
171
+ status: 400 | 404;
172
+ };
173
+ /**
174
+ * Creates a new data integration project in the specified space.
175
+ *
176
+ * @param body an object with the body content
177
+ * @throws CreateDiProjectHttpError
178
+ */
179
+ declare const createDiProject: (body: CreateDiProjectReq, options?: ApiCallOptions) => Promise<CreateDiProjectHttpResponse>;
180
+ type CreateDiProjectHttpResponse = {
181
+ data: DiProjectItemRsp;
182
+ headers: Headers;
183
+ status: 201;
184
+ };
185
+ type CreateDiProjectHttpError = {
186
+ data: Errors;
187
+ headers: Headers;
188
+ status: 400 | 500;
189
+ };
190
+ /**
191
+ * Retrieves the status of an asynchronous operation.
192
+ *
193
+ * @param actionId Action ID
194
+ * @param query an object with query parameters
195
+ * @throws GetDiProjectHttpError
196
+ */
197
+ declare const getDiProject: (actionId: string, query: {
198
+ /** Specifies whether to include detailed status information in the response. Set to `true` to return detailed information. */
199
+ detailed?: boolean;
200
+ }, options?: ApiCallOptions) => Promise<GetDiProjectHttpResponse>;
201
+ type GetDiProjectHttpResponse = {
202
+ data: AsyncActionDetails;
203
+ headers: Headers;
204
+ status: 200;
205
+ };
206
+ type GetDiProjectHttpError = {
207
+ data: Errors;
208
+ headers: Headers;
209
+ status: 404;
210
+ };
211
+ /**
212
+ * Exports the specified data integration project.
213
+ *
214
+ * @param projectId Data project ID
215
+ * @param body an object with the body content
216
+ * @throws ExportDiProjectHttpError
217
+ */
218
+ declare const exportDiProject: (projectId: string, body: ExportDiProjectReq, options?: ApiCallOptions) => Promise<ExportDiProjectHttpResponse>;
219
+ type ExportDiProjectHttpResponse = {
220
+ data: DownloadableBlob;
221
+ headers: Headers;
222
+ status: 200;
223
+ };
224
+ type ExportDiProjectHttpError = {
225
+ data: Errors;
226
+ headers: Headers;
227
+ status: 400 | 404 | 500;
228
+ };
229
+ /**
230
+ * Imports a data integration project from a `.zip` file.
231
+ *
232
+ * @param projectId Data project ID
233
+ * @param body an object with the body content
234
+ * @throws ImportDiProjectHttpError
235
+ */
236
+ declare const importDiProject: (projectId: string, body: {
237
+ zip?: BodyInit;
238
+ }, options?: ApiCallOptions) => Promise<ImportDiProjectHttpResponse>;
239
+ type ImportDiProjectHttpResponse = {
240
+ data: ImportDiProjectRsp;
241
+ headers: Headers;
242
+ status: 200;
243
+ };
244
+ type ImportDiProjectHttpError = {
245
+ data: Errors;
246
+ headers: Headers;
247
+ status: 400 | 404 | 500;
248
+ };
249
+ /**
250
+ * Prepares the data integration project and its tasks for execution.
251
+ *
252
+ * @param projectId Data project ID
253
+ * @param body an object with the body content
254
+ * @throws PrepareDiProjectHttpError
255
+ */
256
+ declare const prepareDiProject: (projectId: string, body: PrepareProjectReq, options?: ApiCallOptions) => Promise<PrepareDiProjectHttpResponse>;
257
+ type PrepareDiProjectHttpResponse = {
258
+ data: AsyncActionRsp;
259
+ headers: Headers;
260
+ status: 202;
261
+ };
262
+ type PrepareDiProjectHttpError = {
263
+ data: Errors;
264
+ headers: Headers;
265
+ status: 400 | 404;
266
+ };
267
+ /**
268
+ * Validates the data integration project and its tasks.
269
+ *
270
+ * @param projectId Data project ID
271
+ * @param body an object with the body content
272
+ * @throws ValidateDiProjectHttpError
273
+ */
274
+ declare const validateDiProject: (projectId: string, body: ValidateProjectReq, options?: ApiCallOptions) => Promise<ValidateDiProjectHttpResponse>;
275
+ type ValidateDiProjectHttpResponse = {
276
+ data: AsyncActionRsp;
277
+ headers: Headers;
278
+ status: 202;
279
+ };
280
+ type ValidateDiProjectHttpError = {
281
+ data: Errors;
282
+ headers: Headers;
283
+ status: 400 | 404;
284
+ };
285
+ /**
286
+ * Retrieves the export variables for a specific data integration project.
287
+ * @example
288
+ * getDiProjectExportVariables(
289
+ * "65424a71c11367914c1e659b",
290
+ * {
291
+ * recalculate: true
292
+ * }
293
+ * )
294
+ *
295
+ * @param projectId Data project ID
296
+ * @param query an object with query parameters
297
+ * @throws GetDiProjectExportVariablesHttpError
298
+ */
299
+ declare const getDiProjectExportVariables: (projectId: string, query: {
300
+ /** Recalculate the bindings if true, otherwise saved bindings are returned. */
301
+ recalculate?: boolean;
302
+ }, options?: ApiCallOptions) => Promise<GetDiProjectExportVariablesHttpResponse>;
303
+ type GetDiProjectExportVariablesHttpResponse = {
304
+ data: GetDiExportProjectVariablesRsp;
305
+ headers: Headers;
306
+ status: 200;
307
+ };
308
+ type GetDiProjectExportVariablesHttpError = {
309
+ data: Errors;
310
+ headers: Headers;
311
+ status: 400 | 404;
312
+ };
313
+ /**
314
+ * Updates the export variables for a specific data integration project.
315
+ *
316
+ * @param projectId Data project ID
317
+ * @param body an object with the body content
318
+ * @throws SetDiProjectExportVariablesHttpError
319
+ */
320
+ declare const setDiProjectExportVariables: (projectId: string, body: UpdateDiExportProjectVariablesReq, options?: ApiCallOptions) => Promise<SetDiProjectExportVariablesHttpResponse>;
321
+ type SetDiProjectExportVariablesHttpResponse = {
322
+ data: UpdateDiExportProjectVariablesRsp;
323
+ headers: Headers;
324
+ status: 200;
325
+ };
326
+ type SetDiProjectExportVariablesHttpError = {
327
+ data: Errors;
328
+ headers: Headers;
329
+ status: 400 | 404 | 500;
330
+ };
331
+ /**
332
+ * Lists data tasks within a given data integration project.
333
+ * @example
334
+ * getDiProjectDiTasks(
335
+ * "65424a71c11367914c1e659b"
336
+ * )
337
+ *
338
+ * @param projectId Data project id
339
+ * @throws GetDiProjectDiTasksHttpError
340
+ */
341
+ declare const getDiProjectDiTasks: (projectId: string, options?: ApiCallOptions) => Promise<GetDiProjectDiTasksHttpResponse>;
342
+ type GetDiProjectDiTasksHttpResponse = {
343
+ data: ListDataTasksRsp;
344
+ headers: Headers;
345
+ status: 200;
346
+ };
347
+ type GetDiProjectDiTasksHttpError = {
348
+ data: Errors;
349
+ headers: Headers;
350
+ status: 400 | 404;
351
+ };
352
+ /**
353
+ * Get a specific data task within a project.
354
+ * @example
355
+ * getDiProjectDiTask(
356
+ * "65424a71c11367914c1e659b",
357
+ * "task-cYSY"
358
+ * )
359
+ *
360
+ * @param projectId Data project id
361
+ * @param dataTaskId Data task id
362
+ * @throws GetDiProjectDiTaskHttpError
363
+ */
364
+ declare const getDiProjectDiTask: (projectId: string, dataTaskId: string, options?: ApiCallOptions) => Promise<GetDiProjectDiTaskHttpResponse>;
365
+ type GetDiProjectDiTaskHttpResponse = {
366
+ data: DataTaskItemRsp;
367
+ headers: Headers;
368
+ status: 200;
369
+ };
370
+ type GetDiProjectDiTaskHttpError = {
371
+ data: Errors;
372
+ headers: Headers;
373
+ status: 400 | 404;
374
+ };
375
+ /**
376
+ * Prepares the specified data task for execution.
377
+ *
378
+ * @param projectId Data project ID
379
+ * @param dataTaskId Data task ID
380
+ * @param body an object with the body content
381
+ * @throws PrepareDiProjectDiTaskHttpError
382
+ */
383
+ declare const prepareDiProjectDiTask: (projectId: string, dataTaskId: string, body: PrepareTaskReq, options?: ApiCallOptions) => Promise<PrepareDiProjectDiTaskHttpResponse>;
384
+ type PrepareDiProjectDiTaskHttpResponse = {
385
+ data: AsyncActionRsp;
386
+ headers: Headers;
387
+ status: 202;
388
+ };
389
+ type PrepareDiProjectDiTaskHttpError = {
390
+ data: Errors;
391
+ headers: Headers;
392
+ status: 400 | 404;
393
+ };
394
+ /**
395
+ * Validates the specified data task.
396
+ * @example
397
+ * validateDiProjectDiTask(
398
+ * "65424a71c11367914c1e659b",
399
+ * "task-cYSY",
400
+ * null
401
+ * )
402
+ *
403
+ * @param projectId Data project ID
404
+ * @param dataTaskId Data task ID
405
+ * @param body an object with the body content
406
+ * @throws ValidateDiProjectDiTaskHttpError
407
+ */
408
+ declare const validateDiProjectDiTask: (projectId: string, dataTaskId: string, body: ValidateTaskReq, options?: ApiCallOptions) => Promise<ValidateDiProjectDiTaskHttpResponse>;
409
+ type ValidateDiProjectDiTaskHttpResponse = {
410
+ data: AsyncActionRsp;
411
+ headers: Headers;
412
+ status: 202;
413
+ };
414
+ type ValidateDiProjectDiTaskHttpError = {
415
+ data: Errors;
416
+ headers: Headers;
417
+ status: 400 | 404;
418
+ };
419
+ /**
420
+ * Start a data task on a data integration project.
421
+ * @example
422
+ * startDiProjectDiTaskRuntime(
423
+ * "65424a71c11367914c1e659b",
424
+ * "task-cYSY"
425
+ * )
426
+ *
427
+ * @param projectId Data project id
428
+ * @param dataTaskId Data task id
429
+ * @throws StartDiProjectDiTaskRuntimeHttpError
430
+ */
431
+ declare const startDiProjectDiTaskRuntime: (projectId: string, dataTaskId: string, options?: ApiCallOptions) => Promise<StartDiProjectDiTaskRuntimeHttpResponse>;
432
+ type StartDiProjectDiTaskRuntimeHttpResponse = {
433
+ data: void;
434
+ headers: Headers;
435
+ status: 204;
436
+ };
437
+ type StartDiProjectDiTaskRuntimeHttpError = {
438
+ data: Errors;
439
+ headers: Headers;
440
+ status: 400 | 404;
441
+ };
442
+ /**
443
+ * Stop a data task on a data integration project.
444
+ * @example
445
+ * stopDiProjectDiTaskRuntime(
446
+ * "65424a71c11367914c1e659b",
447
+ * "task-cYSY"
448
+ * )
449
+ *
450
+ * @param projectId
451
+ * @param dataTaskId
452
+ * @throws StopDiProjectDiTaskRuntimeHttpError
453
+ */
454
+ declare const stopDiProjectDiTaskRuntime: (projectId: string, dataTaskId: string, options?: ApiCallOptions) => Promise<StopDiProjectDiTaskRuntimeHttpResponse>;
455
+ type StopDiProjectDiTaskRuntimeHttpResponse = {
456
+ data: void;
457
+ headers: Headers;
458
+ status: 204;
459
+ };
460
+ type StopDiProjectDiTaskRuntimeHttpError = {
461
+ data: Errors;
462
+ headers: Headers;
463
+ status: 400 | 404;
464
+ };
465
+ /**
466
+ * Get data task runtime state within a data integration project.
467
+ * @example
468
+ * getDiProjectDiTaskRuntimeState(
469
+ * "65424a71c11367914c1e659b",
470
+ * "task-cYSY"
471
+ * )
472
+ *
473
+ * @param projectId
474
+ * @param dataTaskId
475
+ * @throws GetDiProjectDiTaskRuntimeStateHttpError
476
+ */
477
+ declare const getDiProjectDiTaskRuntimeState: (projectId: string, dataTaskId: string, options?: ApiCallOptions) => Promise<GetDiProjectDiTaskRuntimeStateHttpResponse>;
478
+ type GetDiProjectDiTaskRuntimeStateHttpResponse = {
479
+ data: {
480
+ lastRun?: DataTaskInstanceState;
481
+ runReadiness?: {
482
+ message?: string;
483
+ state?: "READY_TO_RUN" | "ALREADY_RUNNING" | "NOT_RUNNABLE";
484
+ };
485
+ };
486
+ headers: Headers;
487
+ status: 200;
488
+ };
489
+ type GetDiProjectDiTaskRuntimeStateHttpError = {
490
+ data: Errors;
491
+ headers: Headers;
492
+ status: 400 | 404;
493
+ };
494
+ /**
495
+ * Clears the cache for di-projects api requests.
496
+ */
497
+ declare function clearCache(): void;
498
+ interface DiProjectsAPI {
499
+ /**
500
+ * List data integration projects.
501
+ *
502
+ * @param query an object with query parameters
503
+ * @throws GetDiProjectsHttpError
504
+ */
505
+ getDiProjects: typeof getDiProjects;
506
+ /**
507
+ * Creates a new data integration project in the specified space.
508
+ *
509
+ * @param body an object with the body content
510
+ * @throws CreateDiProjectHttpError
511
+ */
512
+ createDiProject: typeof createDiProject;
513
+ /**
514
+ * Retrieves the status of an asynchronous operation.
515
+ *
516
+ * @param actionId Action ID
517
+ * @param query an object with query parameters
518
+ * @throws GetDiProjectHttpError
519
+ */
520
+ getDiProject: typeof getDiProject;
521
+ /**
522
+ * Exports the specified data integration project.
523
+ *
524
+ * @param projectId Data project ID
525
+ * @param body an object with the body content
526
+ * @throws ExportDiProjectHttpError
527
+ */
528
+ exportDiProject: typeof exportDiProject;
529
+ /**
530
+ * Imports a data integration project from a `.zip` file.
531
+ *
532
+ * @param projectId Data project ID
533
+ * @param body an object with the body content
534
+ * @throws ImportDiProjectHttpError
535
+ */
536
+ importDiProject: typeof importDiProject;
537
+ /**
538
+ * Prepares the data integration project and its tasks for execution.
539
+ *
540
+ * @param projectId Data project ID
541
+ * @param body an object with the body content
542
+ * @throws PrepareDiProjectHttpError
543
+ */
544
+ prepareDiProject: typeof prepareDiProject;
545
+ /**
546
+ * Validates the data integration project and its tasks.
547
+ *
548
+ * @param projectId Data project ID
549
+ * @param body an object with the body content
550
+ * @throws ValidateDiProjectHttpError
551
+ */
552
+ validateDiProject: typeof validateDiProject;
553
+ /**
554
+ * Retrieves the export variables for a specific data integration project.
555
+ * @example
556
+ * getDiProjectExportVariables(
557
+ * "65424a71c11367914c1e659b",
558
+ * {
559
+ * recalculate: true
560
+ * }
561
+ * )
562
+ *
563
+ * @param projectId Data project ID
564
+ * @param query an object with query parameters
565
+ * @throws GetDiProjectExportVariablesHttpError
566
+ */
567
+ getDiProjectExportVariables: typeof getDiProjectExportVariables;
568
+ /**
569
+ * Updates the export variables for a specific data integration project.
570
+ *
571
+ * @param projectId Data project ID
572
+ * @param body an object with the body content
573
+ * @throws SetDiProjectExportVariablesHttpError
574
+ */
575
+ setDiProjectExportVariables: typeof setDiProjectExportVariables;
576
+ /**
577
+ * Lists data tasks within a given data integration project.
578
+ * @example
579
+ * getDiProjectDiTasks(
580
+ * "65424a71c11367914c1e659b"
581
+ * )
582
+ *
583
+ * @param projectId Data project id
584
+ * @throws GetDiProjectDiTasksHttpError
585
+ */
586
+ getDiProjectDiTasks: typeof getDiProjectDiTasks;
587
+ /**
588
+ * Get a specific data task within a project.
589
+ * @example
590
+ * getDiProjectDiTask(
591
+ * "65424a71c11367914c1e659b",
592
+ * "task-cYSY"
593
+ * )
594
+ *
595
+ * @param projectId Data project id
596
+ * @param dataTaskId Data task id
597
+ * @throws GetDiProjectDiTaskHttpError
598
+ */
599
+ getDiProjectDiTask: typeof getDiProjectDiTask;
600
+ /**
601
+ * Prepares the specified data task for execution.
602
+ *
603
+ * @param projectId Data project ID
604
+ * @param dataTaskId Data task ID
605
+ * @param body an object with the body content
606
+ * @throws PrepareDiProjectDiTaskHttpError
607
+ */
608
+ prepareDiProjectDiTask: typeof prepareDiProjectDiTask;
609
+ /**
610
+ * Validates the specified data task.
611
+ * @example
612
+ * validateDiProjectDiTask(
613
+ * "65424a71c11367914c1e659b",
614
+ * "task-cYSY",
615
+ * null
616
+ * )
617
+ *
618
+ * @param projectId Data project ID
619
+ * @param dataTaskId Data task ID
620
+ * @param body an object with the body content
621
+ * @throws ValidateDiProjectDiTaskHttpError
622
+ */
623
+ validateDiProjectDiTask: typeof validateDiProjectDiTask;
624
+ /**
625
+ * Start a data task on a data integration project.
626
+ * @example
627
+ * startDiProjectDiTaskRuntime(
628
+ * "65424a71c11367914c1e659b",
629
+ * "task-cYSY"
630
+ * )
631
+ *
632
+ * @param projectId Data project id
633
+ * @param dataTaskId Data task id
634
+ * @throws StartDiProjectDiTaskRuntimeHttpError
635
+ */
636
+ startDiProjectDiTaskRuntime: typeof startDiProjectDiTaskRuntime;
637
+ /**
638
+ * Stop a data task on a data integration project.
639
+ * @example
640
+ * stopDiProjectDiTaskRuntime(
641
+ * "65424a71c11367914c1e659b",
642
+ * "task-cYSY"
643
+ * )
644
+ *
645
+ * @param projectId
646
+ * @param dataTaskId
647
+ * @throws StopDiProjectDiTaskRuntimeHttpError
648
+ */
649
+ stopDiProjectDiTaskRuntime: typeof stopDiProjectDiTaskRuntime;
650
+ /**
651
+ * Get data task runtime state within a data integration project.
652
+ * @example
653
+ * getDiProjectDiTaskRuntimeState(
654
+ * "65424a71c11367914c1e659b",
655
+ * "task-cYSY"
656
+ * )
657
+ *
658
+ * @param projectId
659
+ * @param dataTaskId
660
+ * @throws GetDiProjectDiTaskRuntimeStateHttpError
661
+ */
662
+ getDiProjectDiTaskRuntimeState: typeof getDiProjectDiTaskRuntimeState;
663
+ /**
664
+ * Clears the cache for di-projects api requests.
665
+ */
666
+ clearCache: typeof clearCache;
667
+ }
668
+ /**
669
+ * Functions for the di-projects api
670
+ */
671
+ declare const diProjectsExport: DiProjectsAPI;
672
+
673
+ export { type AsyncActionDetails, type AsyncActionError, type AsyncActionRsp, type AsyncActionTaskProgress, type AsyncActionType, type AsyncCallStatus, type CreateDiProjectHttpError, type CreateDiProjectHttpResponse, type CreateDiProjectReq, type DataTaskInstanceState, type DataTaskItemRsp, type DataTaskType, type DiProjectItemRsp, type DiProjectOperationSelectedTask, type DiProjectsAPI, type Error, type ErrorSource, type Errors, type ExportDiProjectHttpError, type ExportDiProjectHttpResponse, type ExportDiProjectReq, type GetDiExportProjectVariablesRsp, type GetDiProjectDiTaskHttpError, type GetDiProjectDiTaskHttpResponse, type GetDiProjectDiTaskRuntimeStateHttpError, type GetDiProjectDiTaskRuntimeStateHttpResponse, type GetDiProjectDiTasksHttpError, type GetDiProjectDiTasksHttpResponse, type GetDiProjectExportVariablesHttpError, type GetDiProjectExportVariablesHttpResponse, type GetDiProjectHttpError, type GetDiProjectHttpResponse, type GetDiProjectsHttpError, type GetDiProjectsHttpResponse, type ImportDiProjectHttpError, type ImportDiProjectHttpResponse, type ImportDiProjectRsp, type ListDataTasksRsp, type ListDiProjectsRsp, type PrepareDiProjectDiTaskHttpError, type PrepareDiProjectDiTaskHttpResponse, type PrepareDiProjectHttpError, type PrepareDiProjectHttpResponse, type PrepareProjectReq, type PrepareTaskReq, type SetDiProjectExportVariablesHttpError, type SetDiProjectExportVariablesHttpResponse, type StartDiProjectDiTaskRuntimeHttpError, type StartDiProjectDiTaskRuntimeHttpResponse, type StopDiProjectDiTaskRuntimeHttpError, type StopDiProjectDiTaskRuntimeHttpResponse, type TaskSelectionList, type UpdateDiExportProjectVariablesReq, type UpdateDiExportProjectVariablesRsp, type ValidateDiProjectDiTaskHttpError, type ValidateDiProjectDiTaskHttpResponse, type ValidateDiProjectHttpError, type ValidateDiProjectHttpResponse, type ValidateProjectReq, type ValidateTaskReq, clearCache, createDiProject, diProjectsExport as default, exportDiProject, getDiProject, getDiProjectDiTask, getDiProjectDiTaskRuntimeState, getDiProjectDiTasks, getDiProjectExportVariables, getDiProjects, importDiProject, prepareDiProject, prepareDiProjectDiTask, setDiProjectExportVariables, startDiProjectDiTaskRuntime, stopDiProjectDiTaskRuntime, validateDiProject, validateDiProjectDiTask };