@qlik/api 1.31.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 (95) hide show
  1. package/api-keys.js +2 -2
  2. package/apps.js +2 -2
  3. package/assistants.d.ts +1301 -0
  4. package/assistants.js +273 -0
  5. package/audits.js +2 -2
  6. package/auth.js +2 -2
  7. package/automation-connections.d.ts +366 -0
  8. package/automation-connections.js +91 -0
  9. package/automations.js +2 -2
  10. package/automl-deployments.d.ts +97 -0
  11. package/automl-deployments.js +27 -0
  12. package/automl-predictions.d.ts +214 -0
  13. package/automl-predictions.js +72 -0
  14. package/brands.js +2 -2
  15. package/chunks/{GUU3KZGK.js → RCLKKVYB.js} +1 -1
  16. package/chunks/{YKZ2QYHN.js → VVD2DPKQ.js} +2 -2
  17. package/chunks/{KBSD75QL.js → YTT2FEVE.js} +1 -1
  18. package/collections.js +2 -2
  19. package/conditions.d.ts +662 -0
  20. package/conditions.js +113 -0
  21. package/consumption.d.ts +182 -0
  22. package/consumption.js +24 -0
  23. package/csp-origins.js +2 -2
  24. package/csrf-token.d.ts +62 -0
  25. package/csrf-token.js +23 -0
  26. package/data-alerts.d.ts +1004 -0
  27. package/data-alerts.js +155 -0
  28. package/data-assets.js +2 -2
  29. package/data-connections.js +2 -2
  30. package/data-credentials.js +2 -2
  31. package/data-files.js +2 -2
  32. package/data-qualities.d.ts +175 -0
  33. package/data-qualities.js +44 -0
  34. package/data-sets.d.ts +424 -0
  35. package/data-sets.js +75 -0
  36. package/data-sources.d.ts +268 -0
  37. package/data-sources.js +39 -0
  38. package/data-stores.d.ts +537 -0
  39. package/data-stores.js +108 -0
  40. package/dcaas.d.ts +192 -0
  41. package/dcaas.js +39 -0
  42. package/di-projects.d.ts +673 -0
  43. package/di-projects.js +164 -0
  44. package/encryption.d.ts +370 -0
  45. package/encryption.js +98 -0
  46. package/extensions.js +2 -2
  47. package/glossaries.js +2 -2
  48. package/groups.js +2 -2
  49. package/identity-providers.js +2 -2
  50. package/index.d.ts +105 -1
  51. package/index.js +556 -4
  52. package/items.js +2 -2
  53. package/knowledgebases.d.ts +890 -0
  54. package/knowledgebases.js +169 -0
  55. package/licenses.d.ts +1 -1
  56. package/licenses.js +2 -2
  57. package/lineage-graphs.d.ts +712 -0
  58. package/lineage-graphs.js +92 -0
  59. package/ml.d.ts +2628 -0
  60. package/ml.js +384 -0
  61. package/notes.d.ts +110 -0
  62. package/notes.js +31 -0
  63. package/notifications.d.ts +98 -0
  64. package/notifications.js +24 -0
  65. package/oauth-clients.js +2 -2
  66. package/oauth-tokens.d.ts +126 -0
  67. package/oauth-tokens.js +31 -0
  68. package/package.json +28 -2
  69. package/qix.d.ts +1 -1
  70. package/qix.js +2 -2
  71. package/questions.d.ts +364 -0
  72. package/questions.js +34 -0
  73. package/quotas.js +2 -2
  74. package/reload-tasks.js +2 -2
  75. package/reloads.js +2 -2
  76. package/report-templates.d.ts +287 -0
  77. package/report-templates.js +80 -0
  78. package/reports.js +2 -2
  79. package/roles.js +2 -2
  80. package/sharing-tasks.d.ts +952 -0
  81. package/sharing-tasks.js +105 -0
  82. package/spaces.js +2 -2
  83. package/tasks.d.ts +564 -0
  84. package/tasks.js +106 -0
  85. package/temp-contents.js +2 -2
  86. package/tenants.js +2 -2
  87. package/themes.js +2 -2
  88. package/transports.js +2 -2
  89. package/ui-config.d.ts +274 -0
  90. package/ui-config.js +77 -0
  91. package/users.js +2 -2
  92. package/web-integrations.js +2 -2
  93. package/web-notifications.js +2 -2
  94. package/webhooks.js +2 -2
  95. /package/chunks/{DLKLPD7T.js → LTNGXTXG.js} +0 -0
@@ -0,0 +1,712 @@
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
+
4
+ /**
5
+ * The data integration data asset where the node belongs to
6
+ */
7
+ type DataAsset = {
8
+ /** The id (QRI) of the data asset */
9
+ id?: string;
10
+ /** The lable of the data asset */
11
+ label?: string;
12
+ /** The subtype of the data asset */
13
+ subtype?: string;
14
+ /** The type of the data asset */
15
+ type?: string;
16
+ };
17
+ type Edge = {
18
+ /** The index of edges. This is only used in the POST request. */
19
+ id?: string;
20
+ metadata?: {
21
+ type?: string;
22
+ };
23
+ relation?: string;
24
+ /** The id (QRI) of the source node on this edge. */
25
+ source?: string;
26
+ /** The id (QRI) of the target node on this edge. */
27
+ target?: string;
28
+ };
29
+ type EmptyReturn = unknown;
30
+ type ErrorResponse400 = {
31
+ errors?: {
32
+ code?: string;
33
+ detail?: string;
34
+ title?: string;
35
+ }[];
36
+ traceId?: string;
37
+ };
38
+ type ErrorResponse403 = {
39
+ errors?: {
40
+ code?: string;
41
+ detail?: string;
42
+ title?: string;
43
+ }[];
44
+ traceId?: string;
45
+ };
46
+ type ErrorResponse404 = {
47
+ errors?: {
48
+ code?: string;
49
+ detail?: string;
50
+ title?: string;
51
+ }[];
52
+ traceId?: string;
53
+ };
54
+ type ErrorResponse429 = {
55
+ code?: string;
56
+ title?: string;
57
+ };
58
+ type ErrorResponse500 = {
59
+ errors?: {
60
+ code?: string;
61
+ detail?: string;
62
+ /** The meta contains additional inforomation when requests fail due to internal errors. */
63
+ meta?: unknown;
64
+ title?: string;
65
+ }[];
66
+ traceId?: string;
67
+ };
68
+ type ErrorResponse503 = {
69
+ errors?: {
70
+ code?: string;
71
+ detail?: string;
72
+ title?: string;
73
+ }[];
74
+ traceId?: string;
75
+ };
76
+ /**
77
+ * The lineage graph containing the node.
78
+ */
79
+ type Graph = {
80
+ /** Returns true if the graph is directed. */
81
+ directed?: boolean;
82
+ edges?: Edge[];
83
+ /** Label string for this graph. */
84
+ label?: string;
85
+ metadata?: {
86
+ /** The date and time when the graph is created. */
87
+ createdAt?: string;
88
+ /** The id (QRI) of the graph producer. */
89
+ producerId?: string;
90
+ /** The type of the graph producer. */
91
+ producerType?: string;
92
+ specVersion?: string;
93
+ /** The total number of nodes retrieved in this graph. */
94
+ total?: number;
95
+ };
96
+ /** All the nodes contained in a graph. */
97
+ nodes?: Nodes;
98
+ type?: string;
99
+ };
100
+ type GraphLevelsResponse = {
101
+ /** The lineage graph containing the node. */
102
+ graph?: Graph;
103
+ /** The list of lineage graphs. */
104
+ graphs?: Graphs;
105
+ };
106
+ type GraphResponse = {
107
+ /** The lineage graph containing the node. */
108
+ graph?: Graph;
109
+ };
110
+ /**
111
+ * The list of lineage graphs.
112
+ */
113
+ type Graphs = {
114
+ graphs?: Graph[];
115
+ };
116
+ type GraphsResponse = {
117
+ /** The list of lineage graphs. */
118
+ graphs?: Graphs;
119
+ };
120
+ type LineageOverviewInfo = {
121
+ /** Resource level label */
122
+ resourceLabel?: string;
123
+ /** Resource level QRI */
124
+ resourceQRI?: string;
125
+ /** Table level label */
126
+ tableLabel?: string;
127
+ /** Table level QRI that the field belongs to. */
128
+ tableQRI?: string;
129
+ };
130
+ type MultiStatusResponse = {
131
+ data?: MultiStatusResponseItem[];
132
+ };
133
+ type MultiStatusResponseItem = {
134
+ code?: string;
135
+ resource?: OverviewItem;
136
+ status?: number;
137
+ title?: string;
138
+ };
139
+ type Node = {
140
+ /** Name label of the node. */
141
+ label?: string;
142
+ /** This contains additional node information such as node types, subtypes, queryExpressions, etc. */
143
+ metadata?: {
144
+ /** The data integration data asset where the node belongs to */
145
+ dataAsset?: DataAsset;
146
+ /** The number of fields that are impacted.
147
+ * This will be returned as part of the response from /impact/{id}/overview and /impact/{id}/actions/expand on the table level. */
148
+ fields?: number;
149
+ /** The file path of a node */
150
+ filePath?: string;
151
+ /** The id (QRI) of the node */
152
+ id: string;
153
+ /** The subtype of the node. */
154
+ subtype?: string;
155
+ /** The number of tables that are impacted.
156
+ * This will be returned as part of the response from /impact/{id}/overview. */
157
+ tables?: number;
158
+ /** The type of the node. */
159
+ type: string;
160
+ };
161
+ };
162
+ /**
163
+ * All the nodes contained in a graph.
164
+ */
165
+ type Nodes = Record<string, Node>;
166
+ type OverviewItem = {
167
+ lineage?: LineageOverviewInfo[];
168
+ /** Input QRI that we are getting the overview for. */
169
+ qri?: string;
170
+ };
171
+ type OverviewItems = {
172
+ resources?: OverviewItem[];
173
+ };
174
+ type Qris = string[];
175
+ /**
176
+ * Returns next-level nodes inside a specified node on an impact analysis graph retrieved using a base node.
177
+ *
178
+ * @param id The QRI for base node.
179
+ * @param query an object with query parameters
180
+ * @throws ExpandLineageGraphImpactHttpError
181
+ */
182
+ declare const expandLineageGraphImpact: (id: string, query: {
183
+ /** The number of downstream resource levels nodes to retrieve. (5 if not provided, -1 means unlimited and 1 means direct lineage) */
184
+ down?: number;
185
+ /** The level to get the nodes on. */
186
+ level: "field" | "table";
187
+ /** The node in the downstream graph to get next-level nodes for. For instance, to get the TABLE level nodes inside a RESOURCE level node,
188
+ * use the RESOURCE level QRI for the node. Similarly, use the TABLE level QRI to get the FIELD level nodes.
189
+ * If a TABLE level QRI is used with `level` parameter being `TABLE`, only the RESOURCE level of the node will be
190
+ * taken into consideration. */
191
+ node: string;
192
+ }, options?: ApiCallOptions) => Promise<ExpandLineageGraphImpactHttpResponse>;
193
+ type ExpandLineageGraphImpactHttpResponse = {
194
+ data: GraphResponse;
195
+ headers: Headers;
196
+ status: 200;
197
+ };
198
+ type ExpandLineageGraphImpactHttpError = ExpandLineageGraphImpact400HttpError | ExpandLineageGraphImpact403HttpError | ExpandLineageGraphImpact404HttpError | ExpandLineageGraphImpact429HttpError | ExpandLineageGraphImpact500HttpError | ExpandLineageGraphImpact503HttpError;
199
+ type ExpandLineageGraphImpact400HttpError = {
200
+ data: ErrorResponse400;
201
+ headers: Headers;
202
+ status: 400;
203
+ };
204
+ type ExpandLineageGraphImpact403HttpError = {
205
+ data: ErrorResponse403;
206
+ headers: Headers;
207
+ status: 403;
208
+ };
209
+ type ExpandLineageGraphImpact404HttpError = {
210
+ data: ErrorResponse404;
211
+ headers: Headers;
212
+ status: 404;
213
+ };
214
+ type ExpandLineageGraphImpact429HttpError = {
215
+ data: ErrorResponse429;
216
+ headers: Headers;
217
+ status: 429;
218
+ };
219
+ type ExpandLineageGraphImpact500HttpError = {
220
+ data: ErrorResponse500;
221
+ headers: Headers;
222
+ status: 500;
223
+ };
224
+ type ExpandLineageGraphImpact503HttpError = {
225
+ data: ErrorResponse503;
226
+ headers: Headers;
227
+ status: 503;
228
+ };
229
+ /**
230
+ * Search all labels within a impact graph on all available levels.
231
+ * Returns result per level
232
+ * @example
233
+ * searchLineageGraphImpact(
234
+ * "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
235
+ * {
236
+ * filter: "label co \"label1\" or label co \"label2\""
237
+ * }
238
+ * )
239
+ *
240
+ * @param id The qri for root node.
241
+ * @param query an object with query parameters
242
+ * @throws SearchLineageGraphImpactHttpError
243
+ */
244
+ declare const searchLineageGraphImpact: (id: string, query: {
245
+ /** The number of downstream resource levels nodes to search. (5 if not provided, -1 means unlimited) and 1 means direct lineage. */
246
+ down?: number;
247
+ /** The expression that matches the SCIM filter format. The filter has to be encoded.
248
+ * The currently supported attribute is "label", attribute operator "co" (contains), and grouping operator "or". Example: 'label co "label1" or label co "label2"'. The search queries are case insensetive. */
249
+ filter: string;
250
+ }, options?: ApiCallOptions) => Promise<SearchLineageGraphImpactHttpResponse>;
251
+ type SearchLineageGraphImpactHttpResponse = {
252
+ data: GraphsResponse;
253
+ headers: Headers;
254
+ status: 200;
255
+ };
256
+ type SearchLineageGraphImpactHttpError = SearchLineageGraphImpact400HttpError | SearchLineageGraphImpact403HttpError | SearchLineageGraphImpact404HttpError | SearchLineageGraphImpact429HttpError | SearchLineageGraphImpact500HttpError | SearchLineageGraphImpact503HttpError;
257
+ type SearchLineageGraphImpact400HttpError = {
258
+ data: ErrorResponse400;
259
+ headers: Headers;
260
+ status: 400;
261
+ };
262
+ type SearchLineageGraphImpact403HttpError = {
263
+ data: ErrorResponse403;
264
+ headers: Headers;
265
+ status: 403;
266
+ };
267
+ type SearchLineageGraphImpact404HttpError = {
268
+ data: ErrorResponse404;
269
+ headers: Headers;
270
+ status: 404;
271
+ };
272
+ type SearchLineageGraphImpact429HttpError = {
273
+ data: ErrorResponse429;
274
+ headers: Headers;
275
+ status: 429;
276
+ };
277
+ type SearchLineageGraphImpact500HttpError = {
278
+ data: ErrorResponse500;
279
+ headers: Headers;
280
+ status: 500;
281
+ };
282
+ type SearchLineageGraphImpact503HttpError = {
283
+ data: ErrorResponse503;
284
+ headers: Headers;
285
+ status: 503;
286
+ };
287
+ /**
288
+ * Returns all RESOURCE level nodes that are impacted by a change in the source node.
289
+ * The number of tables and fields that are impacted for each resource are included as metadata.
290
+ * The id (QRI) can be on any level (FIELD, TABLE or RESOURCE) and the impact will be collected based on the starting QRI.
291
+ *
292
+ * @param id The qri for root node.
293
+ * @param query an object with query parameters
294
+ * @throws GetLineageGraphImpactOverviewHttpError
295
+ */
296
+ declare const getLineageGraphImpactOverview: (id: string, query: {
297
+ /** The number of downstream resource levels nodes to retrieve. (5 if not provided, -1 means unlimited and 1 means direct lineage) */
298
+ down?: number;
299
+ }, options?: ApiCallOptions) => Promise<GetLineageGraphImpactOverviewHttpResponse>;
300
+ type GetLineageGraphImpactOverviewHttpResponse = {
301
+ data: GraphResponse;
302
+ headers: Headers;
303
+ status: 200;
304
+ };
305
+ type GetLineageGraphImpactOverviewHttpError = GetLineageGraphImpactOverview400HttpError | GetLineageGraphImpactOverview403HttpError | GetLineageGraphImpactOverview404HttpError | GetLineageGraphImpactOverview429HttpError | GetLineageGraphImpactOverview500HttpError | GetLineageGraphImpactOverview503HttpError;
306
+ type GetLineageGraphImpactOverview400HttpError = {
307
+ data: ErrorResponse400;
308
+ headers: Headers;
309
+ status: 400;
310
+ };
311
+ type GetLineageGraphImpactOverview403HttpError = {
312
+ data: ErrorResponse403;
313
+ headers: Headers;
314
+ status: 403;
315
+ };
316
+ type GetLineageGraphImpactOverview404HttpError = {
317
+ data: ErrorResponse404;
318
+ headers: Headers;
319
+ status: 404;
320
+ };
321
+ type GetLineageGraphImpactOverview429HttpError = {
322
+ data: ErrorResponse429;
323
+ headers: Headers;
324
+ status: 429;
325
+ };
326
+ type GetLineageGraphImpactOverview500HttpError = {
327
+ data: ErrorResponse500;
328
+ headers: Headers;
329
+ status: 500;
330
+ };
331
+ type GetLineageGraphImpactOverview503HttpError = {
332
+ data: ErrorResponse503;
333
+ headers: Headers;
334
+ status: 503;
335
+ };
336
+ /**
337
+ * Returns all levels of the requested root node. Only node information will be returned.
338
+ * @example
339
+ * getLineageGraphImpactSource(
340
+ * "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5"
341
+ * )
342
+ *
343
+ * @param id The id (QRI) for root node.
344
+ * @throws GetLineageGraphImpactSourceHttpError
345
+ */
346
+ declare const getLineageGraphImpactSource: (id: string, options?: ApiCallOptions) => Promise<GetLineageGraphImpactSourceHttpResponse>;
347
+ type GetLineageGraphImpactSourceHttpResponse = {
348
+ data: GraphsResponse;
349
+ headers: Headers;
350
+ status: 200;
351
+ };
352
+ type GetLineageGraphImpactSourceHttpError = GetLineageGraphImpactSource400HttpError | GetLineageGraphImpactSource403HttpError | GetLineageGraphImpactSource404HttpError | GetLineageGraphImpactSource429HttpError | GetLineageGraphImpactSource500HttpError | GetLineageGraphImpactSource503HttpError;
353
+ type GetLineageGraphImpactSource400HttpError = {
354
+ data: ErrorResponse400;
355
+ headers: Headers;
356
+ status: 400;
357
+ };
358
+ type GetLineageGraphImpactSource403HttpError = {
359
+ data: ErrorResponse403;
360
+ headers: Headers;
361
+ status: 403;
362
+ };
363
+ type GetLineageGraphImpactSource404HttpError = {
364
+ data: ErrorResponse404;
365
+ headers: Headers;
366
+ status: 404;
367
+ };
368
+ type GetLineageGraphImpactSource429HttpError = {
369
+ data: ErrorResponse429;
370
+ headers: Headers;
371
+ status: 429;
372
+ };
373
+ type GetLineageGraphImpactSource500HttpError = {
374
+ data: ErrorResponse500;
375
+ headers: Headers;
376
+ status: 500;
377
+ };
378
+ type GetLineageGraphImpactSource503HttpError = {
379
+ data: ErrorResponse503;
380
+ headers: Headers;
381
+ status: 503;
382
+ };
383
+ /**
384
+ * Returns lineage graphs for requested levels of a source node.
385
+ * The id (QRI) can point to an item on the field, table and resource level.
386
+ *
387
+ * @param id The id (QRI) for the source node.
388
+ * @param query an object with query parameters
389
+ * @throws GetLineageGraphNodeHttpError
390
+ */
391
+ declare const getLineageGraphNode: (id: string, query: {
392
+ /** To collapse internal nodes, set to true, false otherwise. */
393
+ collapse?: boolean;
394
+ /** The graph level to retrieve. */
395
+ level?: "field" | "table" | "resource" | "all";
396
+ /** The number of upstream levels of nodes to retrieve. (5 if not provided, -1 means unlimited) */
397
+ up?: number;
398
+ }, options?: ApiCallOptions) => Promise<GetLineageGraphNodeHttpResponse>;
399
+ type GetLineageGraphNodeHttpResponse = {
400
+ data: GraphLevelsResponse;
401
+ headers: Headers;
402
+ status: 200;
403
+ };
404
+ type GetLineageGraphNodeHttpError = GetLineageGraphNode400HttpError | GetLineageGraphNode403HttpError | GetLineageGraphNode404HttpError | GetLineageGraphNode429HttpError | GetLineageGraphNode500HttpError | GetLineageGraphNode503HttpError;
405
+ type GetLineageGraphNode400HttpError = {
406
+ data: ErrorResponse400;
407
+ headers: Headers;
408
+ status: 400;
409
+ };
410
+ type GetLineageGraphNode403HttpError = {
411
+ data: ErrorResponse403;
412
+ headers: Headers;
413
+ status: 403;
414
+ };
415
+ type GetLineageGraphNode404HttpError = {
416
+ data: ErrorResponse404;
417
+ headers: Headers;
418
+ status: 404;
419
+ };
420
+ type GetLineageGraphNode429HttpError = {
421
+ data: ErrorResponse429;
422
+ headers: Headers;
423
+ status: 429;
424
+ };
425
+ type GetLineageGraphNode500HttpError = {
426
+ data: ErrorResponse500;
427
+ headers: Headers;
428
+ status: 500;
429
+ };
430
+ type GetLineageGraphNode503HttpError = {
431
+ data: ErrorResponse503;
432
+ headers: Headers;
433
+ status: 503;
434
+ };
435
+ /**
436
+ * Returns the expanded node and its edges.
437
+ * Up and downstream nodes are not part of the response, edges are.
438
+ * The id is the root node that lineage is requested for. The QRI of the node to expand is sent as the query parameter "node" for expansion.
439
+ *
440
+ * @param id The id (QRI) for the source node.
441
+ * @param query an object with query parameters
442
+ * @throws ExpandLineageGraphNodeHttpError
443
+ */
444
+ declare const expandLineageGraphNode: (id: string, query: {
445
+ /** To collapse internal nodes, set to true, false otherwise. */
446
+ collapse?: boolean;
447
+ /** The level to expand to. */
448
+ level: "field" | "table";
449
+ /** The QRI of the node in the upstream graph for expansion. */
450
+ node: string;
451
+ /** The number of upstream levels of nodes retrieved to expand. (5 if not provided, -1 means unlimited) */
452
+ up?: number;
453
+ }, options?: ApiCallOptions) => Promise<ExpandLineageGraphNodeHttpResponse>;
454
+ type ExpandLineageGraphNodeHttpResponse = {
455
+ data: GraphResponse;
456
+ headers: Headers;
457
+ status: 200;
458
+ };
459
+ type ExpandLineageGraphNodeHttpError = ExpandLineageGraphNode400HttpError | ExpandLineageGraphNode403HttpError | ExpandLineageGraphNode404HttpError | ExpandLineageGraphNode429HttpError | ExpandLineageGraphNode500HttpError | ExpandLineageGraphNode503HttpError;
460
+ type ExpandLineageGraphNode400HttpError = {
461
+ data: ErrorResponse400;
462
+ headers: Headers;
463
+ status: 400;
464
+ };
465
+ type ExpandLineageGraphNode403HttpError = {
466
+ data: ErrorResponse403;
467
+ headers: Headers;
468
+ status: 403;
469
+ };
470
+ type ExpandLineageGraphNode404HttpError = {
471
+ data: ErrorResponse404;
472
+ headers: Headers;
473
+ status: 404;
474
+ };
475
+ type ExpandLineageGraphNode429HttpError = {
476
+ data: ErrorResponse429;
477
+ headers: Headers;
478
+ status: 429;
479
+ };
480
+ type ExpandLineageGraphNode500HttpError = {
481
+ data: ErrorResponse500;
482
+ headers: Headers;
483
+ status: 500;
484
+ };
485
+ type ExpandLineageGraphNode503HttpError = {
486
+ data: ErrorResponse503;
487
+ headers: Headers;
488
+ status: 503;
489
+ };
490
+ /**
491
+ * Search all labels within a lineage graph on all available levels.
492
+ * Returns result per level.
493
+ * @example
494
+ * searchLineageGraphNode(
495
+ * "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
496
+ * {
497
+ * filter: "label co \"label1\" or label co \"label2\""
498
+ * }
499
+ * )
500
+ *
501
+ * @param id The qri for root node.
502
+ * @param query an object with query parameters
503
+ * @throws SearchLineageGraphNodeHttpError
504
+ */
505
+ declare const searchLineageGraphNode: (id: string, query: {
506
+ /** To collapse internal nodes, set to true, false otherwise. */
507
+ collapse?: boolean;
508
+ /** The expression that matches the SCIM filter format. The filter has to be encoded.
509
+ * The currently supported attribute is "label", attribute operator "co" (contains), and grouping operator "or". Example: 'label co "label1" or label co "label2"'. The search queries are case insensitive. */
510
+ filter: string;
511
+ /** The number of upstream levels of nodes retrieved to search. (5 if not provided, -1 means unlimited) */
512
+ up?: number;
513
+ }, options?: ApiCallOptions) => Promise<SearchLineageGraphNodeHttpResponse>;
514
+ type SearchLineageGraphNodeHttpResponse = {
515
+ data: GraphsResponse;
516
+ headers: Headers;
517
+ status: 200;
518
+ };
519
+ type SearchLineageGraphNodeHttpError = SearchLineageGraphNode400HttpError | SearchLineageGraphNode403HttpError | SearchLineageGraphNode404HttpError | SearchLineageGraphNode429HttpError | SearchLineageGraphNode500HttpError | SearchLineageGraphNode503HttpError;
520
+ type SearchLineageGraphNode400HttpError = {
521
+ data: ErrorResponse400;
522
+ headers: Headers;
523
+ status: 400;
524
+ };
525
+ type SearchLineageGraphNode403HttpError = {
526
+ data: ErrorResponse403;
527
+ headers: Headers;
528
+ status: 403;
529
+ };
530
+ type SearchLineageGraphNode404HttpError = {
531
+ data: ErrorResponse404;
532
+ headers: Headers;
533
+ status: 404;
534
+ };
535
+ type SearchLineageGraphNode429HttpError = {
536
+ data: ErrorResponse429;
537
+ headers: Headers;
538
+ status: 429;
539
+ };
540
+ type SearchLineageGraphNode500HttpError = {
541
+ data: ErrorResponse500;
542
+ headers: Headers;
543
+ status: 500;
544
+ };
545
+ type SearchLineageGraphNode503HttpError = {
546
+ data: ErrorResponse503;
547
+ headers: Headers;
548
+ status: 503;
549
+ };
550
+ /**
551
+ * Returns the first generation upstream direct lineage.
552
+ * For each field QRI, will find any direct linege dataset or application.
553
+ *
554
+ * @param id The qri for root node.
555
+ * @param query an object with query parameters
556
+ * @param body an object with the body content
557
+ * @throws CreateLineageGraphNodeOverviewHttpError
558
+ */
559
+ declare const createLineageGraphNodeOverview: (id: string, query: {
560
+ /** To collapse internal nodes, set to true, false otherwise. */
561
+ collapse?: boolean;
562
+ /** The number of upstream levels of nodes retrieved to get overview from. (5 if not provided, -1 means unlimited) */
563
+ up?: number;
564
+ }, body: Qris, options?: ApiCallOptions) => Promise<CreateLineageGraphNodeOverviewHttpResponse>;
565
+ type CreateLineageGraphNodeOverviewHttpResponse = CreateLineageGraphNodeOverview200HttpResponse | CreateLineageGraphNodeOverview201HttpResponse | CreateLineageGraphNodeOverview207HttpResponse;
566
+ type CreateLineageGraphNodeOverview200HttpResponse = {
567
+ data: OverviewItems;
568
+ headers: Headers;
569
+ status: 200;
570
+ };
571
+ type CreateLineageGraphNodeOverview201HttpResponse = {
572
+ data: EmptyReturn;
573
+ headers: Headers;
574
+ status: 201;
575
+ };
576
+ type CreateLineageGraphNodeOverview207HttpResponse = {
577
+ data: MultiStatusResponse;
578
+ headers: Headers;
579
+ status: 207;
580
+ };
581
+ type CreateLineageGraphNodeOverviewHttpError = CreateLineageGraphNodeOverview400HttpError | CreateLineageGraphNodeOverview403HttpError | CreateLineageGraphNodeOverview404HttpError | CreateLineageGraphNodeOverview500HttpError | CreateLineageGraphNodeOverview503HttpError;
582
+ type CreateLineageGraphNodeOverview400HttpError = {
583
+ data: ErrorResponse400;
584
+ headers: Headers;
585
+ status: 400;
586
+ };
587
+ type CreateLineageGraphNodeOverview403HttpError = {
588
+ data: ErrorResponse403;
589
+ headers: Headers;
590
+ status: 403;
591
+ };
592
+ type CreateLineageGraphNodeOverview404HttpError = {
593
+ data: ErrorResponse404;
594
+ headers: Headers;
595
+ status: 404;
596
+ };
597
+ type CreateLineageGraphNodeOverview500HttpError = {
598
+ data: ErrorResponse500;
599
+ headers: Headers;
600
+ status: 500;
601
+ };
602
+ type CreateLineageGraphNodeOverview503HttpError = {
603
+ data: ErrorResponse503;
604
+ headers: Headers;
605
+ status: 503;
606
+ };
607
+ /**
608
+ * Clears the cache for lineage-graphs api requests.
609
+ */
610
+ declare function clearCache(): void;
611
+ interface LineageGraphsAPI {
612
+ /**
613
+ * Returns next-level nodes inside a specified node on an impact analysis graph retrieved using a base node.
614
+ *
615
+ * @param id The QRI for base node.
616
+ * @param query an object with query parameters
617
+ * @throws ExpandLineageGraphImpactHttpError
618
+ */
619
+ expandLineageGraphImpact: typeof expandLineageGraphImpact;
620
+ /**
621
+ * Search all labels within a impact graph on all available levels.
622
+ * Returns result per level
623
+ * @example
624
+ * searchLineageGraphImpact(
625
+ * "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
626
+ * {
627
+ * filter: "label co \"label1\" or label co \"label2\""
628
+ * }
629
+ * )
630
+ *
631
+ * @param id The qri for root node.
632
+ * @param query an object with query parameters
633
+ * @throws SearchLineageGraphImpactHttpError
634
+ */
635
+ searchLineageGraphImpact: typeof searchLineageGraphImpact;
636
+ /**
637
+ * Returns all RESOURCE level nodes that are impacted by a change in the source node.
638
+ * The number of tables and fields that are impacted for each resource are included as metadata.
639
+ * The id (QRI) can be on any level (FIELD, TABLE or RESOURCE) and the impact will be collected based on the starting QRI.
640
+ *
641
+ * @param id The qri for root node.
642
+ * @param query an object with query parameters
643
+ * @throws GetLineageGraphImpactOverviewHttpError
644
+ */
645
+ getLineageGraphImpactOverview: typeof getLineageGraphImpactOverview;
646
+ /**
647
+ * Returns all levels of the requested root node. Only node information will be returned.
648
+ * @example
649
+ * getLineageGraphImpactSource(
650
+ * "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5"
651
+ * )
652
+ *
653
+ * @param id The id (QRI) for root node.
654
+ * @throws GetLineageGraphImpactSourceHttpError
655
+ */
656
+ getLineageGraphImpactSource: typeof getLineageGraphImpactSource;
657
+ /**
658
+ * Returns lineage graphs for requested levels of a source node.
659
+ * The id (QRI) can point to an item on the field, table and resource level.
660
+ *
661
+ * @param id The id (QRI) for the source node.
662
+ * @param query an object with query parameters
663
+ * @throws GetLineageGraphNodeHttpError
664
+ */
665
+ getLineageGraphNode: typeof getLineageGraphNode;
666
+ /**
667
+ * Returns the expanded node and its edges.
668
+ * Up and downstream nodes are not part of the response, edges are.
669
+ * The id is the root node that lineage is requested for. The QRI of the node to expand is sent as the query parameter "node" for expansion.
670
+ *
671
+ * @param id The id (QRI) for the source node.
672
+ * @param query an object with query parameters
673
+ * @throws ExpandLineageGraphNodeHttpError
674
+ */
675
+ expandLineageGraphNode: typeof expandLineageGraphNode;
676
+ /**
677
+ * Search all labels within a lineage graph on all available levels.
678
+ * Returns result per level.
679
+ * @example
680
+ * searchLineageGraphNode(
681
+ * "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
682
+ * {
683
+ * filter: "label co \"label1\" or label co \"label2\""
684
+ * }
685
+ * )
686
+ *
687
+ * @param id The qri for root node.
688
+ * @param query an object with query parameters
689
+ * @throws SearchLineageGraphNodeHttpError
690
+ */
691
+ searchLineageGraphNode: typeof searchLineageGraphNode;
692
+ /**
693
+ * Returns the first generation upstream direct lineage.
694
+ * For each field QRI, will find any direct linege dataset or application.
695
+ *
696
+ * @param id The qri for root node.
697
+ * @param query an object with query parameters
698
+ * @param body an object with the body content
699
+ * @throws CreateLineageGraphNodeOverviewHttpError
700
+ */
701
+ createLineageGraphNodeOverview: typeof createLineageGraphNodeOverview;
702
+ /**
703
+ * Clears the cache for lineage-graphs api requests.
704
+ */
705
+ clearCache: typeof clearCache;
706
+ }
707
+ /**
708
+ * Functions for the lineage-graphs api
709
+ */
710
+ declare const lineageGraphsExport: LineageGraphsAPI;
711
+
712
+ export { type CreateLineageGraphNodeOverview200HttpResponse, type CreateLineageGraphNodeOverview201HttpResponse, type CreateLineageGraphNodeOverview207HttpResponse, type CreateLineageGraphNodeOverview400HttpError, type CreateLineageGraphNodeOverview403HttpError, type CreateLineageGraphNodeOverview404HttpError, type CreateLineageGraphNodeOverview500HttpError, type CreateLineageGraphNodeOverview503HttpError, type CreateLineageGraphNodeOverviewHttpError, type CreateLineageGraphNodeOverviewHttpResponse, type DataAsset, type Edge, type EmptyReturn, type ErrorResponse400, type ErrorResponse403, type ErrorResponse404, type ErrorResponse429, type ErrorResponse500, type ErrorResponse503, type ExpandLineageGraphImpact400HttpError, type ExpandLineageGraphImpact403HttpError, type ExpandLineageGraphImpact404HttpError, type ExpandLineageGraphImpact429HttpError, type ExpandLineageGraphImpact500HttpError, type ExpandLineageGraphImpact503HttpError, type ExpandLineageGraphImpactHttpError, type ExpandLineageGraphImpactHttpResponse, type ExpandLineageGraphNode400HttpError, type ExpandLineageGraphNode403HttpError, type ExpandLineageGraphNode404HttpError, type ExpandLineageGraphNode429HttpError, type ExpandLineageGraphNode500HttpError, type ExpandLineageGraphNode503HttpError, type ExpandLineageGraphNodeHttpError, type ExpandLineageGraphNodeHttpResponse, type GetLineageGraphImpactOverview400HttpError, type GetLineageGraphImpactOverview403HttpError, type GetLineageGraphImpactOverview404HttpError, type GetLineageGraphImpactOverview429HttpError, type GetLineageGraphImpactOverview500HttpError, type GetLineageGraphImpactOverview503HttpError, type GetLineageGraphImpactOverviewHttpError, type GetLineageGraphImpactOverviewHttpResponse, type GetLineageGraphImpactSource400HttpError, type GetLineageGraphImpactSource403HttpError, type GetLineageGraphImpactSource404HttpError, type GetLineageGraphImpactSource429HttpError, type GetLineageGraphImpactSource500HttpError, type GetLineageGraphImpactSource503HttpError, type GetLineageGraphImpactSourceHttpError, type GetLineageGraphImpactSourceHttpResponse, type GetLineageGraphNode400HttpError, type GetLineageGraphNode403HttpError, type GetLineageGraphNode404HttpError, type GetLineageGraphNode429HttpError, type GetLineageGraphNode500HttpError, type GetLineageGraphNode503HttpError, type GetLineageGraphNodeHttpError, type GetLineageGraphNodeHttpResponse, type Graph, type GraphLevelsResponse, type GraphResponse, type Graphs, type GraphsResponse, type LineageGraphsAPI, type LineageOverviewInfo, type MultiStatusResponse, type MultiStatusResponseItem, type Node, type Nodes, type OverviewItem, type OverviewItems, type Qris, type SearchLineageGraphImpact400HttpError, type SearchLineageGraphImpact403HttpError, type SearchLineageGraphImpact404HttpError, type SearchLineageGraphImpact429HttpError, type SearchLineageGraphImpact500HttpError, type SearchLineageGraphImpact503HttpError, type SearchLineageGraphImpactHttpError, type SearchLineageGraphImpactHttpResponse, type SearchLineageGraphNode400HttpError, type SearchLineageGraphNode403HttpError, type SearchLineageGraphNode404HttpError, type SearchLineageGraphNode429HttpError, type SearchLineageGraphNode500HttpError, type SearchLineageGraphNode503HttpError, type SearchLineageGraphNodeHttpError, type SearchLineageGraphNodeHttpResponse, clearCache, createLineageGraphNodeOverview, lineageGraphsExport as default, expandLineageGraphImpact, expandLineageGraphNode, getLineageGraphImpactOverview, getLineageGraphImpactSource, getLineageGraphNode, searchLineageGraphImpact, searchLineageGraphNode };