@qlik/api 2.2.0 → 2.3.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 (231) 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-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
  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-DipDBQQ5.js} +258 -54
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.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 +6 -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-D11iO7ZV.js +0 -65
  163. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  164. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  165. package/chunks/automations-BGy83EBO.d.ts +0 -797
  166. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  167. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  168. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  169. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  170. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  171. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  172. package/chunks/consumption-DerFk437.d.ts +0 -182
  173. package/chunks/core-DQXNZdnf.d.ts +0 -12
  174. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  175. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  176. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  177. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  178. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  179. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  180. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  181. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  182. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  183. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  184. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  185. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  186. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  187. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  188. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  189. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  190. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  191. package/chunks/groups-C86-UG7S.d.ts +0 -511
  192. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  193. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  194. package/chunks/interceptors-DTYm37AU.js +0 -104
  195. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  196. package/chunks/ip-policies-DXlf172B.js +0 -108
  197. package/chunks/items-C-jzqvFW.d.ts +0 -536
  198. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  199. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  200. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  201. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  202. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  203. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  204. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  205. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  206. package/chunks/qix-CYQsLyGQ.js +0 -40
  207. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  208. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  209. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  210. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  211. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  212. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  213. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  214. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  215. package/chunks/spaces-BK823t-b.d.ts +0 -780
  216. package/chunks/tasks-COKDfShO.d.ts +0 -564
  217. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  218. package/chunks/tenants-Bhn86519.d.ts +0 -361
  219. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  220. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  221. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  222. package/chunks/users-BSOBU_fg.d.ts +0 -675
  223. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  224. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  225. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  226. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  227. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  228. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  229. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  230. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  231. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,697 +0,0 @@
1
- import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/lineage-graphs.d.ts
4
-
5
- /**
6
- * The data integration data asset where the node belongs to
7
- */
8
- type DataAsset = {
9
- /** The id (QRI) of the data asset */
10
- id?: string;
11
- /** The lable of the data asset */
12
- label?: string;
13
- /** The subtype of the data asset */
14
- subtype?: string;
15
- /** The type of the data asset */
16
- type?: string;
17
- };
18
- type Edge = {
19
- /** The index of edges. This is only used in the POST request. */
20
- id?: string;
21
- metadata?: {
22
- type?: string;
23
- };
24
- relation?: string;
25
- /** The id (QRI) of the source node on this edge. */
26
- source?: string;
27
- /** The id (QRI) of the target node on this edge. */
28
- target?: string;
29
- };
30
- type EmptyReturn = unknown;
31
- type ErrorResponse400 = {
32
- errors?: {
33
- code?: string;
34
- detail?: string;
35
- title?: string;
36
- }[];
37
- traceId?: string;
38
- };
39
- type ErrorResponse403 = {
40
- errors?: {
41
- code?: string;
42
- detail?: string;
43
- title?: string;
44
- }[];
45
- traceId?: string;
46
- };
47
- type ErrorResponse404 = {
48
- errors?: {
49
- code?: string;
50
- detail?: string;
51
- title?: string;
52
- }[];
53
- traceId?: string;
54
- };
55
- type ErrorResponse429 = {
56
- code?: string;
57
- title?: string;
58
- };
59
- type ErrorResponse500 = {
60
- errors?: {
61
- code?: string;
62
- detail?: string;
63
- /** The meta contains additional inforomation when requests fail due to internal errors. */
64
- meta?: unknown;
65
- title?: string;
66
- }[];
67
- traceId?: string;
68
- };
69
- type ErrorResponse503 = {
70
- errors?: {
71
- code?: string;
72
- detail?: string;
73
- title?: string;
74
- }[];
75
- traceId?: string;
76
- };
77
- /**
78
- * The lineage graph containing the node.
79
- */
80
- type Graph = {
81
- /** Returns true if the graph is directed. */
82
- directed?: boolean;
83
- edges?: Edge[];
84
- /** Label string for this graph. */
85
- label?: string;
86
- metadata?: {
87
- /** The date and time when the graph is created. */
88
- createdAt?: string;
89
- /** The id (QRI) of the graph producer. */
90
- producerId?: string;
91
- /** The type of the graph producer. */
92
- producerType?: string;
93
- specVersion?: string;
94
- /** The total number of nodes retrieved in this graph. */
95
- total?: number;
96
- };
97
- /** All the nodes contained in a graph. */
98
- nodes?: Nodes;
99
- type?: string;
100
- };
101
- type GraphLevelsResponse = {
102
- /** The lineage graph containing the node. */
103
- graph?: Graph;
104
- /** The list of lineage graphs. */
105
- graphs?: Graphs;
106
- };
107
- type GraphResponse = {
108
- /** The lineage graph containing the node. */
109
- graph?: Graph;
110
- };
111
- /**
112
- * The list of lineage graphs.
113
- */
114
- type Graphs = {
115
- graphs?: Graph[];
116
- };
117
- type GraphsResponse = {
118
- /** The list of lineage graphs. */
119
- graphs?: Graphs;
120
- };
121
- type LineageOverviewInfo = {
122
- /** Resource level label */
123
- resourceLabel?: string;
124
- /** Resource level QRI */
125
- resourceQRI?: string;
126
- /** Table level label */
127
- tableLabel?: string;
128
- /** Table level QRI that the field belongs to. */
129
- tableQRI?: string;
130
- };
131
- type MultiStatusResponse = {
132
- data?: MultiStatusResponseItem[];
133
- };
134
- type MultiStatusResponseItem = {
135
- code?: string;
136
- resource?: OverviewItem;
137
- status?: number;
138
- title?: string;
139
- };
140
- type Node = {
141
- /** Name label of the node. */
142
- label?: string;
143
- /** This contains additional node information such as node types, subtypes, queryExpressions, etc. */
144
- metadata?: {
145
- /** The data integration data asset where the node belongs to */
146
- dataAsset?: DataAsset;
147
- /** The number of fields that are impacted.
148
- * This will be returned as part of the response from /impact/{id}/overview and /impact/{id}/actions/expand on the table level. */
149
- fields?: number;
150
- /** The file path of a node */
151
- filePath?: string;
152
- /** The id (QRI) of the node */
153
- id: string;
154
- /** The subtype of the node. */
155
- subtype?: string;
156
- /** The number of tables that are impacted.
157
- * This will be returned as part of the response from /impact/{id}/overview. */
158
- tables?: number;
159
- /** The type of the node. */
160
- type: string;
161
- };
162
- };
163
- /**
164
- * All the nodes contained in a graph.
165
- */
166
- type Nodes = Record<string, Node>;
167
- type OverviewItem = {
168
- lineage?: LineageOverviewInfo[];
169
- /** Input QRI that we are getting the overview for. */
170
- qri?: string;
171
- };
172
- type OverviewItems = {
173
- resources?: OverviewItem[];
174
- };
175
- type Qris = string[];
176
- /**
177
- * Returns next-level nodes inside a specified node on an impact analysis graph retrieved using a base node.
178
- *
179
- * @param id The QRI for base node.
180
- * @param query an object with query parameters
181
- * @throws ExpandLineageGraphImpactHttpError
182
- */
183
- declare function expandLineageGraphImpact(id: string, query: {
184
- /** The number of downstream resource levels nodes to retrieve. (5 if not provided, -1 means unlimited and 1 means direct lineage) */
185
- down?: number;
186
- /** The level to get the nodes on. */
187
- level: "field" | "table";
188
- /** 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,
189
- * use the RESOURCE level QRI for the node. Similarly, use the TABLE level QRI to get the FIELD level nodes.
190
- * If a TABLE level QRI is used with `level` parameter being `TABLE`, only the RESOURCE level of the node will be
191
- * taken into consideration. */
192
- node: string;
193
- }, options?: ApiCallOptions): Promise<ExpandLineageGraphImpactHttpResponse>;
194
- type ExpandLineageGraphImpactHttpResponse = {
195
- data: GraphResponse;
196
- headers: Headers;
197
- status: 200;
198
- };
199
- type ExpandLineageGraphImpactHttpError = ExpandLineageGraphImpact400HttpError | ExpandLineageGraphImpact403HttpError | ExpandLineageGraphImpact404HttpError | ExpandLineageGraphImpact429HttpError | ExpandLineageGraphImpact500HttpError | ExpandLineageGraphImpact503HttpError;
200
- type ExpandLineageGraphImpact400HttpError = {
201
- data: ErrorResponse400;
202
- headers: Headers;
203
- status: 400;
204
- };
205
- type ExpandLineageGraphImpact403HttpError = {
206
- data: ErrorResponse403;
207
- headers: Headers;
208
- status: 403;
209
- };
210
- type ExpandLineageGraphImpact404HttpError = {
211
- data: ErrorResponse404;
212
- headers: Headers;
213
- status: 404;
214
- };
215
- type ExpandLineageGraphImpact429HttpError = {
216
- data: ErrorResponse429;
217
- headers: Headers;
218
- status: 429;
219
- };
220
- type ExpandLineageGraphImpact500HttpError = {
221
- data: ErrorResponse500;
222
- headers: Headers;
223
- status: 500;
224
- };
225
- type ExpandLineageGraphImpact503HttpError = {
226
- data: ErrorResponse503;
227
- headers: Headers;
228
- status: 503;
229
- };
230
- /**
231
- * Searchs all labels within a impact graph on all available levels. 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 function 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. The number of tables and fields that are impacted for each resource are included as metadata. The id (QRI) can be on any level (FIELD, TABLE or RESOURCE) and the impact will be collected based on the starting QRI.
289
- *
290
- * @param id The qri for root node.
291
- * @param query an object with query parameters
292
- * @throws GetLineageGraphImpactOverviewHttpError
293
- */
294
- declare function getLineageGraphImpactOverview(id: string, query: {
295
- /** The number of downstream resource levels nodes to retrieve. (5 if not provided, -1 means unlimited and 1 means direct lineage) */
296
- down?: number;
297
- }, options?: ApiCallOptions): Promise<GetLineageGraphImpactOverviewHttpResponse>;
298
- type GetLineageGraphImpactOverviewHttpResponse = {
299
- data: GraphResponse;
300
- headers: Headers;
301
- status: 200;
302
- };
303
- type GetLineageGraphImpactOverviewHttpError = GetLineageGraphImpactOverview400HttpError | GetLineageGraphImpactOverview403HttpError | GetLineageGraphImpactOverview404HttpError | GetLineageGraphImpactOverview429HttpError | GetLineageGraphImpactOverview500HttpError | GetLineageGraphImpactOverview503HttpError;
304
- type GetLineageGraphImpactOverview400HttpError = {
305
- data: ErrorResponse400;
306
- headers: Headers;
307
- status: 400;
308
- };
309
- type GetLineageGraphImpactOverview403HttpError = {
310
- data: ErrorResponse403;
311
- headers: Headers;
312
- status: 403;
313
- };
314
- type GetLineageGraphImpactOverview404HttpError = {
315
- data: ErrorResponse404;
316
- headers: Headers;
317
- status: 404;
318
- };
319
- type GetLineageGraphImpactOverview429HttpError = {
320
- data: ErrorResponse429;
321
- headers: Headers;
322
- status: 429;
323
- };
324
- type GetLineageGraphImpactOverview500HttpError = {
325
- data: ErrorResponse500;
326
- headers: Headers;
327
- status: 500;
328
- };
329
- type GetLineageGraphImpactOverview503HttpError = {
330
- data: ErrorResponse503;
331
- headers: Headers;
332
- status: 503;
333
- };
334
- /**
335
- * Returns all levels of the requested root node. Only node information will be returned.
336
- * @example
337
- * getLineageGraphImpactSource(
338
- * "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5"
339
- * )
340
- *
341
- * @param id The id (QRI) for root node.
342
- * @throws GetLineageGraphImpactSourceHttpError
343
- */
344
- declare function getLineageGraphImpactSource(id: string, options?: ApiCallOptions): Promise<GetLineageGraphImpactSourceHttpResponse>;
345
- type GetLineageGraphImpactSourceHttpResponse = {
346
- data: GraphsResponse;
347
- headers: Headers;
348
- status: 200;
349
- };
350
- type GetLineageGraphImpactSourceHttpError = GetLineageGraphImpactSource400HttpError | GetLineageGraphImpactSource403HttpError | GetLineageGraphImpactSource404HttpError | GetLineageGraphImpactSource429HttpError | GetLineageGraphImpactSource500HttpError | GetLineageGraphImpactSource503HttpError;
351
- type GetLineageGraphImpactSource400HttpError = {
352
- data: ErrorResponse400;
353
- headers: Headers;
354
- status: 400;
355
- };
356
- type GetLineageGraphImpactSource403HttpError = {
357
- data: ErrorResponse403;
358
- headers: Headers;
359
- status: 403;
360
- };
361
- type GetLineageGraphImpactSource404HttpError = {
362
- data: ErrorResponse404;
363
- headers: Headers;
364
- status: 404;
365
- };
366
- type GetLineageGraphImpactSource429HttpError = {
367
- data: ErrorResponse429;
368
- headers: Headers;
369
- status: 429;
370
- };
371
- type GetLineageGraphImpactSource500HttpError = {
372
- data: ErrorResponse500;
373
- headers: Headers;
374
- status: 500;
375
- };
376
- type GetLineageGraphImpactSource503HttpError = {
377
- data: ErrorResponse503;
378
- headers: Headers;
379
- status: 503;
380
- };
381
- /**
382
- * Returns lineage graphs of a source node. The id (QRI) can point to an item on the field, table and resource level.
383
- *
384
- * @param id The id (QRI) for the source node.
385
- * @param query an object with query parameters
386
- * @throws GetLineageGraphNodeHttpError
387
- */
388
- declare function getLineageGraphNode(id: string, query: {
389
- /** To collapse internal nodes, set to true, false otherwise. */
390
- collapse?: boolean;
391
- /** The graph level to retrieve. */
392
- level?: "field" | "table" | "resource" | "all";
393
- /** The number of upstream levels of nodes to retrieve. (5 if not provided, -1 means unlimited) */
394
- up?: number;
395
- }, options?: ApiCallOptions): Promise<GetLineageGraphNodeHttpResponse>;
396
- type GetLineageGraphNodeHttpResponse = {
397
- data: GraphLevelsResponse;
398
- headers: Headers;
399
- status: 200;
400
- };
401
- type GetLineageGraphNodeHttpError = GetLineageGraphNode400HttpError | GetLineageGraphNode403HttpError | GetLineageGraphNode404HttpError | GetLineageGraphNode429HttpError | GetLineageGraphNode500HttpError | GetLineageGraphNode503HttpError;
402
- type GetLineageGraphNode400HttpError = {
403
- data: ErrorResponse400;
404
- headers: Headers;
405
- status: 400;
406
- };
407
- type GetLineageGraphNode403HttpError = {
408
- data: ErrorResponse403;
409
- headers: Headers;
410
- status: 403;
411
- };
412
- type GetLineageGraphNode404HttpError = {
413
- data: ErrorResponse404;
414
- headers: Headers;
415
- status: 404;
416
- };
417
- type GetLineageGraphNode429HttpError = {
418
- data: ErrorResponse429;
419
- headers: Headers;
420
- status: 429;
421
- };
422
- type GetLineageGraphNode500HttpError = {
423
- data: ErrorResponse500;
424
- headers: Headers;
425
- status: 500;
426
- };
427
- type GetLineageGraphNode503HttpError = {
428
- data: ErrorResponse503;
429
- headers: Headers;
430
- status: 503;
431
- };
432
- /**
433
- * Returns the expanded node and its edges. Up and downstream nodes are not part of the response, edges are. 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.
434
- *
435
- * @param id The id (QRI) for the source node.
436
- * @param query an object with query parameters
437
- * @throws ExpandLineageGraphNodeHttpError
438
- */
439
- declare function expandLineageGraphNode(id: string, query: {
440
- /** To collapse internal nodes, set to true, false otherwise. */
441
- collapse?: boolean;
442
- /** The level to expand to. */
443
- level: "field" | "table";
444
- /** The QRI of the node in the upstream graph for expansion. */
445
- node: string;
446
- /** The number of upstream levels of nodes retrieved to expand. (5 if not provided, -1 means unlimited) */
447
- up?: number;
448
- }, options?: ApiCallOptions): Promise<ExpandLineageGraphNodeHttpResponse>;
449
- type ExpandLineageGraphNodeHttpResponse = {
450
- data: GraphResponse;
451
- headers: Headers;
452
- status: 200;
453
- };
454
- type ExpandLineageGraphNodeHttpError = ExpandLineageGraphNode400HttpError | ExpandLineageGraphNode403HttpError | ExpandLineageGraphNode404HttpError | ExpandLineageGraphNode429HttpError | ExpandLineageGraphNode500HttpError | ExpandLineageGraphNode503HttpError;
455
- type ExpandLineageGraphNode400HttpError = {
456
- data: ErrorResponse400;
457
- headers: Headers;
458
- status: 400;
459
- };
460
- type ExpandLineageGraphNode403HttpError = {
461
- data: ErrorResponse403;
462
- headers: Headers;
463
- status: 403;
464
- };
465
- type ExpandLineageGraphNode404HttpError = {
466
- data: ErrorResponse404;
467
- headers: Headers;
468
- status: 404;
469
- };
470
- type ExpandLineageGraphNode429HttpError = {
471
- data: ErrorResponse429;
472
- headers: Headers;
473
- status: 429;
474
- };
475
- type ExpandLineageGraphNode500HttpError = {
476
- data: ErrorResponse500;
477
- headers: Headers;
478
- status: 500;
479
- };
480
- type ExpandLineageGraphNode503HttpError = {
481
- data: ErrorResponse503;
482
- headers: Headers;
483
- status: 503;
484
- };
485
- /**
486
- * Returns result per level by searching all labels within a lineage graph on all available levels.
487
- * @example
488
- * searchLineageGraphNode(
489
- * "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
490
- * {
491
- * filter: "label co \"label1\" or label co \"label2\""
492
- * }
493
- * )
494
- *
495
- * @param id The qri for root node.
496
- * @param query an object with query parameters
497
- * @throws SearchLineageGraphNodeHttpError
498
- */
499
- declare function searchLineageGraphNode(id: string, query: {
500
- /** To collapse internal nodes, set to true, false otherwise. */
501
- collapse?: boolean;
502
- /** The expression that matches the SCIM filter format. The filter has to be encoded.
503
- * 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. */
504
- filter: string;
505
- /** The number of upstream levels of nodes retrieved to search. (5 if not provided, -1 means unlimited) */
506
- up?: number;
507
- }, options?: ApiCallOptions): Promise<SearchLineageGraphNodeHttpResponse>;
508
- type SearchLineageGraphNodeHttpResponse = {
509
- data: GraphsResponse;
510
- headers: Headers;
511
- status: 200;
512
- };
513
- type SearchLineageGraphNodeHttpError = SearchLineageGraphNode400HttpError | SearchLineageGraphNode403HttpError | SearchLineageGraphNode404HttpError | SearchLineageGraphNode429HttpError | SearchLineageGraphNode500HttpError | SearchLineageGraphNode503HttpError;
514
- type SearchLineageGraphNode400HttpError = {
515
- data: ErrorResponse400;
516
- headers: Headers;
517
- status: 400;
518
- };
519
- type SearchLineageGraphNode403HttpError = {
520
- data: ErrorResponse403;
521
- headers: Headers;
522
- status: 403;
523
- };
524
- type SearchLineageGraphNode404HttpError = {
525
- data: ErrorResponse404;
526
- headers: Headers;
527
- status: 404;
528
- };
529
- type SearchLineageGraphNode429HttpError = {
530
- data: ErrorResponse429;
531
- headers: Headers;
532
- status: 429;
533
- };
534
- type SearchLineageGraphNode500HttpError = {
535
- data: ErrorResponse500;
536
- headers: Headers;
537
- status: 500;
538
- };
539
- type SearchLineageGraphNode503HttpError = {
540
- data: ErrorResponse503;
541
- headers: Headers;
542
- status: 503;
543
- };
544
- /**
545
- * Returns the first generation upstream direct lineage. For each field QRI, will find any direct linege dataset or application.
546
- *
547
- * @param id The qri for root node.
548
- * @param query an object with query parameters
549
- * @param body an object with the body content
550
- * @throws CreateLineageGraphNodeOverviewHttpError
551
- */
552
- declare function createLineageGraphNodeOverview(id: string, query: {
553
- /** To collapse internal nodes, set to true, false otherwise. */
554
- collapse?: boolean;
555
- /** The number of upstream levels of nodes retrieved to get overview from. (5 if not provided, -1 means unlimited) */
556
- up?: number;
557
- }, body: Qris, options?: ApiCallOptions): Promise<CreateLineageGraphNodeOverviewHttpResponse>;
558
- type CreateLineageGraphNodeOverviewHttpResponse = CreateLineageGraphNodeOverview200HttpResponse | CreateLineageGraphNodeOverview201HttpResponse | CreateLineageGraphNodeOverview207HttpResponse;
559
- type CreateLineageGraphNodeOverview200HttpResponse = {
560
- data: OverviewItems;
561
- headers: Headers;
562
- status: 200;
563
- };
564
- type CreateLineageGraphNodeOverview201HttpResponse = {
565
- data: EmptyReturn;
566
- headers: Headers;
567
- status: 201;
568
- };
569
- type CreateLineageGraphNodeOverview207HttpResponse = {
570
- data: MultiStatusResponse;
571
- headers: Headers;
572
- status: 207;
573
- };
574
- type CreateLineageGraphNodeOverviewHttpError = CreateLineageGraphNodeOverview400HttpError | CreateLineageGraphNodeOverview403HttpError | CreateLineageGraphNodeOverview404HttpError | CreateLineageGraphNodeOverview500HttpError | CreateLineageGraphNodeOverview503HttpError;
575
- type CreateLineageGraphNodeOverview400HttpError = {
576
- data: ErrorResponse400;
577
- headers: Headers;
578
- status: 400;
579
- };
580
- type CreateLineageGraphNodeOverview403HttpError = {
581
- data: ErrorResponse403;
582
- headers: Headers;
583
- status: 403;
584
- };
585
- type CreateLineageGraphNodeOverview404HttpError = {
586
- data: ErrorResponse404;
587
- headers: Headers;
588
- status: 404;
589
- };
590
- type CreateLineageGraphNodeOverview500HttpError = {
591
- data: ErrorResponse500;
592
- headers: Headers;
593
- status: 500;
594
- };
595
- type CreateLineageGraphNodeOverview503HttpError = {
596
- data: ErrorResponse503;
597
- headers: Headers;
598
- status: 503;
599
- };
600
- /**
601
- * Clears the cache for lineage-graphs api requests.
602
- */
603
- declare function clearCache(): void;
604
- type LineageGraphsAPI = {
605
- /**
606
- * Returns next-level nodes inside a specified node on an impact analysis graph retrieved using a base node.
607
- *
608
- * @param id The QRI for base node.
609
- * @param query an object with query parameters
610
- * @throws ExpandLineageGraphImpactHttpError
611
- */
612
- expandLineageGraphImpact: typeof expandLineageGraphImpact;
613
- /**
614
- * Searchs all labels within a impact graph on all available levels. Returns result per level.
615
- * @example
616
- * searchLineageGraphImpact(
617
- * "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
618
- * {
619
- * filter: "label co \"label1\" or label co \"label2\""
620
- * }
621
- * )
622
- *
623
- * @param id The qri for root node.
624
- * @param query an object with query parameters
625
- * @throws SearchLineageGraphImpactHttpError
626
- */
627
- searchLineageGraphImpact: typeof searchLineageGraphImpact;
628
- /**
629
- * Returns all RESOURCE level nodes that are impacted by a change in the source node. The number of tables and fields that are impacted for each resource are included as metadata. The id (QRI) can be on any level (FIELD, TABLE or RESOURCE) and the impact will be collected based on the starting QRI.
630
- *
631
- * @param id The qri for root node.
632
- * @param query an object with query parameters
633
- * @throws GetLineageGraphImpactOverviewHttpError
634
- */
635
- getLineageGraphImpactOverview: typeof getLineageGraphImpactOverview;
636
- /**
637
- * Returns all levels of the requested root node. Only node information will be returned.
638
- * @example
639
- * getLineageGraphImpactSource(
640
- * "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5"
641
- * )
642
- *
643
- * @param id The id (QRI) for root node.
644
- * @throws GetLineageGraphImpactSourceHttpError
645
- */
646
- getLineageGraphImpactSource: typeof getLineageGraphImpactSource;
647
- /**
648
- * Returns lineage graphs of a source node. The id (QRI) can point to an item on the field, table and resource level.
649
- *
650
- * @param id The id (QRI) for the source node.
651
- * @param query an object with query parameters
652
- * @throws GetLineageGraphNodeHttpError
653
- */
654
- getLineageGraphNode: typeof getLineageGraphNode;
655
- /**
656
- * Returns the expanded node and its edges. Up and downstream nodes are not part of the response, edges are. 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.
657
- *
658
- * @param id The id (QRI) for the source node.
659
- * @param query an object with query parameters
660
- * @throws ExpandLineageGraphNodeHttpError
661
- */
662
- expandLineageGraphNode: typeof expandLineageGraphNode;
663
- /**
664
- * Returns result per level by searching all labels within a lineage graph on all available levels.
665
- * @example
666
- * searchLineageGraphNode(
667
- * "qri:app:sense://e5c651d5-1198-45a2-be5d-f016cee0baf5",
668
- * {
669
- * filter: "label co \"label1\" or label co \"label2\""
670
- * }
671
- * )
672
- *
673
- * @param id The qri for root node.
674
- * @param query an object with query parameters
675
- * @throws SearchLineageGraphNodeHttpError
676
- */
677
- searchLineageGraphNode: typeof searchLineageGraphNode;
678
- /**
679
- * Returns the first generation upstream direct lineage. For each field QRI, will find any direct linege dataset or application.
680
- *
681
- * @param id The qri for root node.
682
- * @param query an object with query parameters
683
- * @param body an object with the body content
684
- * @throws CreateLineageGraphNodeOverviewHttpError
685
- */
686
- createLineageGraphNodeOverview: typeof createLineageGraphNodeOverview;
687
- /**
688
- * Clears the cache for lineage-graphs api requests.
689
- */
690
- clearCache: typeof clearCache;
691
- };
692
- /**
693
- * Functions for the lineage-graphs api
694
- */
695
- declare const lineageGraphsExport: LineageGraphsAPI;
696
- //#endregion
697
- export { GetLineageGraphNode403HttpError as $, ExpandLineageGraphNode404HttpError as A, SearchLineageGraphNode404HttpError as At, GetLineageGraphImpactOverview500HttpError as B, getLineageGraphImpactOverview as Bt, ExpandLineageGraphImpact429HttpError as C, SearchLineageGraphImpact429HttpError as Ct, ExpandLineageGraphImpactHttpResponse as D, SearchLineageGraphImpactHttpResponse as Dt, ExpandLineageGraphImpactHttpError as E, SearchLineageGraphImpactHttpError as Et, ExpandLineageGraphNodeHttpResponse as F, SearchLineageGraphNodeHttpResponse as Ft, GetLineageGraphImpactSource403HttpError as G, searchLineageGraphNode as Gt, GetLineageGraphImpactOverviewHttpError as H, getLineageGraphNode as Ht, GetLineageGraphImpactOverview400HttpError as I, clearCache as It, GetLineageGraphImpactSource500HttpError as J, GetLineageGraphImpactSource404HttpError as K, GetLineageGraphImpactOverview403HttpError as L, createLineageGraphNodeOverview as Lt, ExpandLineageGraphNode500HttpError as M, SearchLineageGraphNode500HttpError as Mt, ExpandLineageGraphNode503HttpError as N, SearchLineageGraphNode503HttpError as Nt, ExpandLineageGraphNode400HttpError as O, SearchLineageGraphNode400HttpError as Ot, ExpandLineageGraphNodeHttpError as P, SearchLineageGraphNodeHttpError as Pt, GetLineageGraphNode400HttpError as Q, GetLineageGraphImpactOverview404HttpError as R, expandLineageGraphImpact as Rt, ExpandLineageGraphImpact404HttpError as S, SearchLineageGraphImpact404HttpError as St, ExpandLineageGraphImpact503HttpError as T, SearchLineageGraphImpact503HttpError as Tt, GetLineageGraphImpactOverviewHttpResponse as U, lineageGraphsExport as Ut, GetLineageGraphImpactOverview503HttpError as V, getLineageGraphImpactSource as Vt, GetLineageGraphImpactSource400HttpError as W, searchLineageGraphImpact as Wt, GetLineageGraphImpactSourceHttpError as X, GetLineageGraphImpactSource503HttpError as Y, GetLineageGraphImpactSourceHttpResponse as Z, ErrorResponse429 as _, OverviewItem as _t, CreateLineageGraphNodeOverview403HttpError as a, GetLineageGraphNodeHttpResponse as at, ExpandLineageGraphImpact400HttpError as b, SearchLineageGraphImpact400HttpError as bt, CreateLineageGraphNodeOverview503HttpError as c, GraphResponse as ct, DataAsset as d, LineageGraphsAPI as dt, GetLineageGraphNode404HttpError as et, Edge as f, LineageOverviewInfo as ft, ErrorResponse404 as g, Nodes as gt, ErrorResponse403 as h, Node as ht, CreateLineageGraphNodeOverview400HttpError as i, GetLineageGraphNodeHttpError as it, ExpandLineageGraphNode429HttpError as j, SearchLineageGraphNode429HttpError as jt, ExpandLineageGraphNode403HttpError as k, SearchLineageGraphNode403HttpError as kt, CreateLineageGraphNodeOverviewHttpError as l, Graphs as lt, ErrorResponse400 as m, MultiStatusResponseItem as mt, CreateLineageGraphNodeOverview201HttpResponse as n, GetLineageGraphNode500HttpError as nt, CreateLineageGraphNodeOverview404HttpError as o, Graph as ot, EmptyReturn as p, MultiStatusResponse as pt, GetLineageGraphImpactSource429HttpError as q, CreateLineageGraphNodeOverview207HttpResponse as r, GetLineageGraphNode503HttpError as rt, CreateLineageGraphNodeOverview500HttpError as s, GraphLevelsResponse as st, CreateLineageGraphNodeOverview200HttpResponse as t, GetLineageGraphNode429HttpError as tt, CreateLineageGraphNodeOverviewHttpResponse as u, GraphsResponse as ut, ErrorResponse500 as v, OverviewItems as vt, ExpandLineageGraphImpact500HttpError as w, SearchLineageGraphImpact500HttpError as wt, ExpandLineageGraphImpact403HttpError as x, SearchLineageGraphImpact403HttpError as xt, ErrorResponse503 as y, Qris as yt, GetLineageGraphImpactOverview429HttpError as z, expandLineageGraphNode as zt };