@qlik/api 2.3.1 → 2.4.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 (167) hide show
  1. package/analytics/change-stores.d.ts +40 -76
  2. package/analytics/change-stores.js +9 -10
  3. package/analytics.d.ts +1 -2
  4. package/analytics.js +5 -6
  5. package/api-keys.d.ts +46 -100
  6. package/api-keys.js +3 -4
  7. package/apps.d.ts +334 -461
  8. package/apps.js +74 -6
  9. package/assistants.d.ts +172 -337
  10. package/assistants.js +3 -4
  11. package/audits.d.ts +41 -85
  12. package/audits.js +3 -4
  13. package/auth-types.d.ts +110 -1
  14. package/auth-types.js +22 -1
  15. package/auth.d.ts +1 -2
  16. package/auth.js +1 -1
  17. package/automation-connections.d.ts +44 -95
  18. package/automation-connections.js +3 -4
  19. package/automation-connectors.d.ts +10 -20
  20. package/automation-connectors.js +3 -4
  21. package/automations.d.ts +54 -112
  22. package/automations.js +3 -4
  23. package/automl-deployments.d.ts +17 -36
  24. package/automl-deployments.js +3 -4
  25. package/automl-predictions.d.ts +12 -24
  26. package/automl-predictions.js +3 -4
  27. package/banners.d.ts +8 -14
  28. package/banners.js +3 -4
  29. package/brands.d.ts +19 -39
  30. package/brands.js +3 -4
  31. package/chunks/auth-B8lJw7rm.js +31 -0
  32. package/chunks/{interceptors-2VSXImC9.js → boot-interceptors-DqRxTczb.js} +50 -150
  33. package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
  34. package/chunks/{invoke-fetch-CckTK7bh.js → invoke-fetch-DMAi6Fg3.js} +3 -3
  35. package/chunks/{invoke-fetch-D9lpiAb-.js → invoke-fetch-pMN6iqup.js} +2 -3
  36. package/chunks/platform-types-CECrZkOF.d.ts +29 -0
  37. package/chunks/{public-runtime-modules-BqxAMJ9M.js → public-runtime-modules-2KfyI2qM.js} +5 -5
  38. package/chunks/{qix-DpvHvpx7.js → qix-BdNrIA4s.js} +19 -20
  39. package/chunks/{qix-chunk-entrypoint-BXZPnE6J.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
  40. package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
  41. package/collections.d.ts +67 -144
  42. package/collections.js +3 -4
  43. package/conditions.d.ts +87 -190
  44. package/conditions.js +3 -4
  45. package/consumption.d.ts +35 -72
  46. package/consumption.js +3 -4
  47. package/core/ip-policies.d.ts +43 -93
  48. package/core/ip-policies.js +5 -6
  49. package/core.d.ts +1 -2
  50. package/core.js +5 -6
  51. package/csp-origins.d.ts +42 -85
  52. package/csp-origins.js +3 -4
  53. package/csrf-token.d.ts +6 -11
  54. package/csrf-token.js +3 -4
  55. package/data-alerts.d.ts +152 -325
  56. package/data-alerts.js +3 -4
  57. package/data-assets.d.ts +16 -31
  58. package/data-assets.js +3 -4
  59. package/data-connections.d.ts +123 -257
  60. package/data-connections.js +3 -4
  61. package/data-credentials.d.ts +36 -76
  62. package/data-credentials.js +3 -4
  63. package/data-files.d.ts +60 -121
  64. package/data-files.js +3 -4
  65. package/data-governance/data-products.d.ts +429 -0
  66. package/data-governance/data-products.js +212 -0
  67. package/data-governance.d.ts +13 -0
  68. package/data-governance.js +12 -0
  69. package/data-qualities.d.ts +11 -25
  70. package/data-qualities.js +3 -4
  71. package/data-sets.d.ts +28 -57
  72. package/data-sets.js +3 -4
  73. package/data-sources.d.ts +45 -97
  74. package/data-sources.js +3 -4
  75. package/data-stores.d.ts +53 -107
  76. package/data-stores.js +3 -4
  77. package/dcaas.d.ts +32 -67
  78. package/dcaas.js +3 -4
  79. package/di-projects.d.ts +111 -136
  80. package/di-projects.js +25 -4
  81. package/direct-access-agents.d.ts +29 -63
  82. package/direct-access-agents.js +3 -4
  83. package/encryption.d.ts +28 -59
  84. package/encryption.js +3 -4
  85. package/extensions.d.ts +35 -73
  86. package/extensions.js +3 -4
  87. package/global-types.d.ts +139 -1
  88. package/glossaries.d.ts +75 -158
  89. package/glossaries.js +3 -4
  90. package/groups.d.ts +58 -125
  91. package/groups.js +3 -4
  92. package/identity-providers.d.ts +148 -324
  93. package/identity-providers.js +3 -4
  94. package/index.d.ts +18 -4
  95. package/index.js +64 -19
  96. package/interceptors.d.ts +2 -3
  97. package/interceptors.js +104 -2
  98. package/invoke-fetch-types.d.ts +97 -1
  99. package/items.d.ts +85 -181
  100. package/items.js +3 -4
  101. package/knowledgebases.d.ts +137 -270
  102. package/knowledgebases.js +3 -4
  103. package/licenses.d.ts +71 -153
  104. package/licenses.js +3 -4
  105. package/lineage-graphs.d.ts +39 -85
  106. package/lineage-graphs.js +3 -4
  107. package/ml.d.ts +290 -621
  108. package/ml.js +3 -4
  109. package/notes.d.ts +9 -18
  110. package/notes.js +3 -4
  111. package/notifications.d.ts +14 -30
  112. package/notifications.js +3 -4
  113. package/oauth-clients.d.ts +98 -159
  114. package/oauth-clients.js +4 -5
  115. package/oauth-tokens.d.ts +16 -33
  116. package/oauth-tokens.js +3 -4
  117. package/package.json +6 -3
  118. package/qix.d.ts +46 -2
  119. package/qix.js +2 -3
  120. package/questions.d.ts +53 -110
  121. package/questions.js +3 -4
  122. package/quotas.d.ts +13 -26
  123. package/quotas.js +3 -4
  124. package/reload-tasks.d.ts +23 -46
  125. package/reload-tasks.js +3 -4
  126. package/reloads.d.ts +26 -52
  127. package/reloads.js +3 -4
  128. package/report-templates.d.ts +30 -63
  129. package/report-templates.js +3 -4
  130. package/reports.d.ts +111 -238
  131. package/reports.js +3 -4
  132. package/roles.d.ts +36 -77
  133. package/roles.js +3 -4
  134. package/sharing-tasks.d.ts +201 -427
  135. package/sharing-tasks.js +3 -4
  136. package/spaces.d.ts +71 -157
  137. package/spaces.js +3 -4
  138. package/tasks.d.ts +76 -164
  139. package/tasks.js +3 -4
  140. package/temp-contents.d.ts +17 -35
  141. package/temp-contents.js +3 -4
  142. package/tenant-settings.d.ts +298 -0
  143. package/tenant-settings.js +107 -0
  144. package/tenants.d.ts +31 -67
  145. package/tenants.js +3 -4
  146. package/themes.d.ts +27 -55
  147. package/themes.js +3 -4
  148. package/transports.d.ts +46 -106
  149. package/transports.js +3 -4
  150. package/ui-config.d.ts +8 -17
  151. package/ui-config.js +3 -4
  152. package/users.d.ts +80 -170
  153. package/users.js +3 -4
  154. package/web-integrations.d.ts +38 -83
  155. package/web-integrations.js +3 -4
  156. package/web-notifications.d.ts +14 -29
  157. package/web-notifications.js +3 -4
  158. package/webhooks.d.ts +77 -162
  159. package/webhooks.js +3 -4
  160. package/chunks/auth-XusKk8IA.js +0 -32
  161. package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
  162. package/chunks/auth-types-h43TVDpB.js +0 -24
  163. package/chunks/global-types-CEVAJebk.js +0 -1
  164. /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
  165. /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
  166. /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
  167. /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
@@ -0,0 +1,429 @@
1
+ import { ApiCallOptions } from "../invoke-fetch-types.js";
2
+ import "../chunks/invoke-fetch-DFc3yzaj.js";
3
+
4
+ //#region src/public/rest/data-governance/data-products.d.ts
5
+ declare namespace data_products_d_exports {
6
+ export { ActivateDataProductHttpError, ActivateDataProductHttpResponse, ActivateDataProductRequest, ArrayOfUniqueStrings, ChangelogOperation, CreateDataProductHttpError, CreateDataProductHttpResponse, CreateDataProductRequest, DataProductChangelog, DataProductChangelogResponse, DataProductResponse, DataProductsAPI, DeactivateDataProductHttpError, DeactivateDataProductHttpResponse, DeleteDataProductHttpError, DeleteDataProductHttpResponse, Error, ErrorResponse, ExportDocumentationDataProductHttpError, ExportDocumentationDataProductHttpResponse, GenerateProviderUrlDataProductsHttpError, GenerateProviderUrlDataProductsHttpResponse, GenerateProviderUrlResponse, GetDataProductChangelogsHttpError, GetDataProductChangelogsHttpResponse, GetDataProductHttpError, GetDataProductHttpResponse, KeyContact, Link, Links, MoveDataProductHttpError, MoveDataProductHttpResponse, MoveDataProductRequest, PatchDataProductHttpError, PatchDataProductHttpResponse, PatchDataProductRequest, Quality, TrustScore, TrustScoreDimension, activateDataProduct, clearCache, createDataProduct, deactivateDataProduct, dataProductsExport as default, deleteDataProduct, exportDocumentationDataProduct, generateProviderUrlDataProducts, getDataProduct, getDataProductChangelogs, moveDataProduct, patchDataProduct };
7
+ }
8
+ type ActivateDataProductRequest = {
9
+ /** A description of the data product. */description?: string; /** Name of the data product to activate. */
10
+ name: string; /** Unique identifier of the space. */
11
+ spaceId?: string;
12
+ tags?: string[];
13
+ };
14
+ type ArrayOfUniqueStrings = string[];
15
+ type ChangelogOperation = {
16
+ operator?: "replace" | "add" | "remove";
17
+ path?: "/name" | "/description" | "/spaceId" | "/datasetIds" | "/glossaryIds" | "/readMe" | "/keyContacts" | "/tags" | "/activatedOn" | "/apiConsumableDatasetIds";
18
+ value?: string | ArrayOfUniqueStrings | unknown[];
19
+ };
20
+ /**
21
+ * Request payload for creating a data product.
22
+ */
23
+ type CreateDataProductRequest = {
24
+ /** A description of the Data Product. */description?: string; /** List of key contacts for the data product. */
25
+ keyContacts?: KeyContact[]; /** Display name of the data product. */
26
+ name: string; /** A readme of the Data Product. */
27
+ readMe?: string; /** Unique identifier of the space. */
28
+ spaceId?: string; /** List of tags for the data product. */
29
+ tags?: string[];
30
+ };
31
+ type DataProductChangelog = {
32
+ changes?: ChangelogOperation[]; /** Timestamp when this changelog entry was created in ISO 8601 format. */
33
+ createdAt?: string; /** Identifier of the user who made these changes. */
34
+ createdBy?: string;
35
+ id?: string;
36
+ };
37
+ type DataProductChangelogResponse = {
38
+ data?: DataProductChangelog[];
39
+ limit?: number;
40
+ links?: Links;
41
+ page?: number;
42
+ pages?: number;
43
+ total?: number;
44
+ };
45
+ type DataProductResponse = {
46
+ /** Indicates whether the data product is currently activated for consumption. */activated?: boolean; /** Timestamp when the data product was most recently activated in ISO 8601 format. */
47
+ activatedAt?: string; /** List of target environments or platforms where the data product is activated. */
48
+ activatedOn?: string[];
49
+ apiConsumableDatasetIds?: string[]; /** Timestamp when the data product was created in ISO 8601 format. */
50
+ createdAt?: string; /** Identifier of the user who created the data product. */
51
+ createdBy?: string;
52
+ datasetIds?: string[];
53
+ description?: string;
54
+ glossaryIds?: string[];
55
+ id: string;
56
+ keyContacts?: KeyContact[]; /** Primary identifier used for main data product reference. */
57
+ mainId?: string;
58
+ name: string; /** Identifier of the user who owns the data product and is responsible for governance. */
59
+ ownerId?: string; /** Qlik Resource Identifier (QRI) uniquely identifying the data product across the platform. */
60
+ qri?: string;
61
+ quality?: Quality; /** Documentation in Markdown format providing detailed information about the data product. */
62
+ readMe?: string;
63
+ spaceId?: string;
64
+ tags?: string[];
65
+ tenantId: string;
66
+ trustScore?: TrustScore; /** Timestamp of the most recent update in ISO 8601 format. */
67
+ updatedAt?: string; /** Identifier of the user who last updated the data product. */
68
+ updatedBy?: string;
69
+ };
70
+ type Error = {
71
+ code?: string;
72
+ detail?: string;
73
+ status?: string;
74
+ title?: string;
75
+ };
76
+ type ErrorResponse = {
77
+ errors?: Error[];
78
+ traceId?: string;
79
+ };
80
+ type GenerateProviderUrlResponse = {
81
+ url: string;
82
+ };
83
+ /**
84
+ * Represents a designated contact person for a data product, optionally with their role.
85
+ */
86
+ type KeyContact = {
87
+ /** Role of the key contact in the Data Product. */role?: string; /** Unique identifier of the user. */
88
+ userId: string;
89
+ };
90
+ type Link = {
91
+ href?: string;
92
+ };
93
+ type Links = {
94
+ first?: Link;
95
+ last?: Link;
96
+ next?: Link;
97
+ prev?: Link;
98
+ self?: Link;
99
+ };
100
+ type MoveDataProductRequest = {
101
+ /** Unique identifier of the space. */spaceId: string;
102
+ };
103
+ type PatchDataProductRequest = {
104
+ op: "replace";
105
+ path: "/name" | "/description" | "/datasetIds" | "/glossaryIds" | "/readMe" | "/keyContacts" | "/tags" | "/apiConsumableDatasetIds";
106
+ value?: string | ArrayOfUniqueStrings | unknown[];
107
+ }[];
108
+ type Quality = {
109
+ completeness: number;
110
+ validity: number;
111
+ };
112
+ type TrustScore = {
113
+ applicableDatasets: number;
114
+ dimensions?: TrustScoreDimension[];
115
+ previousScore?: number;
116
+ score: number;
117
+ };
118
+ type TrustScoreDimension = {
119
+ applicableDatasets: number;
120
+ id: string;
121
+ previousScore?: number;
122
+ score?: number;
123
+ };
124
+ /**
125
+ * Creates a new data product with specified metadata, datasets, and governance information.
126
+ * Use this endpoint to package related datasets into a governed, discoverable asset.
127
+ * Requires create permissions in the target space.
128
+ *
129
+ * @param body an object with the body content
130
+ * @throws CreateDataProductHttpError
131
+ */
132
+ declare function createDataProduct(body: CreateDataProductRequest, options?: ApiCallOptions): Promise<CreateDataProductHttpResponse>;
133
+ type CreateDataProductHttpResponse = {
134
+ data: DataProductResponse;
135
+ headers: Headers;
136
+ status: 201;
137
+ };
138
+ type CreateDataProductHttpError = {
139
+ data: ErrorResponse;
140
+ headers: Headers;
141
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
142
+ };
143
+ /**
144
+ * Generates a URL to access a third-party provider's user interface.
145
+ * Use this endpoint to integrate external services with your data product.
146
+ *
147
+ * @param query an object with query parameters
148
+ * @throws GenerateProviderUrlDataProductsHttpError
149
+ */
150
+ declare function generateProviderUrlDataProducts(query: {
151
+ /** Unique identifier of the dataset. */dataSetId: string;
152
+ }, options?: ApiCallOptions): Promise<GenerateProviderUrlDataProductsHttpResponse>;
153
+ type GenerateProviderUrlDataProductsHttpResponse = {
154
+ data: GenerateProviderUrlResponse;
155
+ headers: Headers;
156
+ status: 200;
157
+ };
158
+ type GenerateProviderUrlDataProductsHttpError = {
159
+ data: ErrorResponse;
160
+ headers: Headers;
161
+ status: 400 | 401 | 403 | 404 | 500 | 503;
162
+ };
163
+ /**
164
+ * Permanently removes a data product from the tenant.
165
+ * This action cannot be undone and does not affect the underlying datasets.
166
+ * Requires delete permissions for the data product.
167
+ *
168
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
169
+ * @throws DeleteDataProductHttpError
170
+ */
171
+ declare function deleteDataProduct(dataProductId: string, options?: ApiCallOptions): Promise<DeleteDataProductHttpResponse>;
172
+ type DeleteDataProductHttpResponse = {
173
+ data: void;
174
+ headers: Headers;
175
+ status: 204;
176
+ };
177
+ type DeleteDataProductHttpError = {
178
+ data: ErrorResponse;
179
+ headers: Headers;
180
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
181
+ };
182
+ /**
183
+ * Retrieves the details of the specified data product, including name, description, associated datasets, key contacts, and activation status.
184
+ * Requires read access to the Data Product.
185
+ *
186
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
187
+ * @throws GetDataProductHttpError
188
+ */
189
+ declare function getDataProduct(dataProductId: string, options?: ApiCallOptions): Promise<GetDataProductHttpResponse>;
190
+ type GetDataProductHttpResponse = {
191
+ data: DataProductResponse;
192
+ headers: Headers;
193
+ status: 200;
194
+ };
195
+ type GetDataProductHttpError = {
196
+ data: ErrorResponse;
197
+ headers: Headers;
198
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
199
+ };
200
+ /**
201
+ * Partially updates an existing data product using JSON Patch operations.
202
+ * Use this endpoint to modify properties such as name, description, datasets, tags, or key contacts.
203
+ * Changes are tracked in the data product changelog.
204
+ *
205
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
206
+ * @param body an object with the body content
207
+ * @throws PatchDataProductHttpError
208
+ */
209
+ declare function patchDataProduct(dataProductId: string, body: PatchDataProductRequest, options?: ApiCallOptions): Promise<PatchDataProductHttpResponse>;
210
+ type PatchDataProductHttpResponse = {
211
+ data: void;
212
+ headers: Headers;
213
+ status: 204;
214
+ };
215
+ type PatchDataProductHttpError = {
216
+ data: ErrorResponse;
217
+ headers: Headers;
218
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
219
+ };
220
+ /**
221
+ * Activates a data product for publishing and consumption.
222
+ * Once activated, the data product becomes discoverable and accessible to authorized users.
223
+ * Requires publish permissions and valid data product configuration.
224
+ *
225
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
226
+ * @param body an object with the body content
227
+ * @throws ActivateDataProductHttpError
228
+ */
229
+ declare function activateDataProduct(dataProductId: string, body: ActivateDataProductRequest, options?: ApiCallOptions): Promise<ActivateDataProductHttpResponse>;
230
+ type ActivateDataProductHttpResponse = {
231
+ data: DataProductResponse;
232
+ headers: Headers;
233
+ status: 201;
234
+ };
235
+ type ActivateDataProductHttpError = {
236
+ data: ErrorResponse;
237
+ headers: Headers;
238
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
239
+ };
240
+ /**
241
+ * Deactivates a data product, preventing it from being consumed by other services or users.
242
+ *
243
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
244
+ * @throws DeactivateDataProductHttpError
245
+ */
246
+ declare function deactivateDataProduct(dataProductId: string, options?: ApiCallOptions): Promise<DeactivateDataProductHttpResponse>;
247
+ type DeactivateDataProductHttpResponse = {
248
+ data: void;
249
+ headers: Headers;
250
+ status: 204;
251
+ };
252
+ type DeactivateDataProductHttpError = {
253
+ data: ErrorResponse;
254
+ headers: Headers;
255
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
256
+ };
257
+ /**
258
+ * Exports data product documentation in Markdown format.
259
+ * Use this endpoint to generate documentation for sharing or archiving.
260
+ * Requires read access to the data product.
261
+ *
262
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
263
+ * @throws ExportDocumentationDataProductHttpError
264
+ */
265
+ declare function exportDocumentationDataProduct(dataProductId: string, options?: ApiCallOptions): Promise<ExportDocumentationDataProductHttpResponse>;
266
+ type ExportDocumentationDataProductHttpResponse = {
267
+ data: void;
268
+ headers: Headers;
269
+ status: 200;
270
+ };
271
+ type ExportDocumentationDataProductHttpError = {
272
+ data: ErrorResponse;
273
+ headers: Headers;
274
+ status: 400 | 401 | 403 | 404 | 406 | 415 | 500 | 503;
275
+ };
276
+ /**
277
+ * Moves a data product from its current space to a different space.
278
+ * Use this endpoint to reorganize data products across workspaces or governance domains.
279
+ * Requires delete permissions in the source space and create permissions in the target space.
280
+ *
281
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
282
+ * @param body an object with the body content
283
+ * @throws MoveDataProductHttpError
284
+ */
285
+ declare function moveDataProduct(dataProductId: string, body: MoveDataProductRequest, options?: ApiCallOptions): Promise<MoveDataProductHttpResponse>;
286
+ type MoveDataProductHttpResponse = {
287
+ data: void;
288
+ headers: Headers;
289
+ status: 204;
290
+ };
291
+ type MoveDataProductHttpError = {
292
+ data: ErrorResponse;
293
+ headers: Headers;
294
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
295
+ };
296
+ /**
297
+ * Retrieves a paginated history of all notable changes made to a data product.
298
+ * Each changelog entry captures the operation type, affected property, and timestamp.
299
+ * Use this endpoint to track the history of changes or data product evolution over time.
300
+ *
301
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
302
+ * @param query an object with query parameters
303
+ * @throws GetDataProductChangelogsHttpError
304
+ */
305
+ declare function getDataProductChangelogs(dataProductId: string, query: {
306
+ /** Maximum number of items to return per page. */limit?: number; /** Page number. */
307
+ page?: number;
308
+ /** Sort order for changelog entries. Use `+createdAt` for oldest first or `-createdAt` for newest first.
309
+ * Prefix with `+` for ascending or `-` for descending order. Default: -createdAt. */
310
+ sort?: "+createdAt" | "-createdAt";
311
+ }, options?: ApiCallOptions): Promise<GetDataProductChangelogsHttpResponse>;
312
+ type GetDataProductChangelogsHttpResponse = {
313
+ data: DataProductChangelogResponse;
314
+ headers: Headers;
315
+ status: 200;
316
+ prev?: (options?: ApiCallOptions) => Promise<GetDataProductChangelogsHttpResponse>;
317
+ next?: (options?: ApiCallOptions) => Promise<GetDataProductChangelogsHttpResponse>;
318
+ };
319
+ type GetDataProductChangelogsHttpError = {
320
+ data: ErrorResponse;
321
+ headers: Headers;
322
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
323
+ };
324
+ /**
325
+ * Clears the cache for data-governance/data-products api requests.
326
+ */
327
+ declare function clearCache(): void;
328
+ type DataProductsAPI = {
329
+ /**
330
+ * Creates a new data product with specified metadata, datasets, and governance information.
331
+ * Use this endpoint to package related datasets into a governed, discoverable asset.
332
+ * Requires create permissions in the target space.
333
+ *
334
+ * @param body an object with the body content
335
+ * @throws CreateDataProductHttpError
336
+ */
337
+ createDataProduct: typeof createDataProduct;
338
+ /**
339
+ * Generates a URL to access a third-party provider's user interface.
340
+ * Use this endpoint to integrate external services with your data product.
341
+ *
342
+ * @param query an object with query parameters
343
+ * @throws GenerateProviderUrlDataProductsHttpError
344
+ */
345
+ generateProviderUrlDataProducts: typeof generateProviderUrlDataProducts;
346
+ /**
347
+ * Permanently removes a data product from the tenant.
348
+ * This action cannot be undone and does not affect the underlying datasets.
349
+ * Requires delete permissions for the data product.
350
+ *
351
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
352
+ * @throws DeleteDataProductHttpError
353
+ */
354
+ deleteDataProduct: typeof deleteDataProduct;
355
+ /**
356
+ * Retrieves the details of the specified data product, including name, description, associated datasets, key contacts, and activation status.
357
+ * Requires read access to the Data Product.
358
+ *
359
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
360
+ * @throws GetDataProductHttpError
361
+ */
362
+ getDataProduct: typeof getDataProduct;
363
+ /**
364
+ * Partially updates an existing data product using JSON Patch operations.
365
+ * Use this endpoint to modify properties such as name, description, datasets, tags, or key contacts.
366
+ * Changes are tracked in the data product changelog.
367
+ *
368
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
369
+ * @param body an object with the body content
370
+ * @throws PatchDataProductHttpError
371
+ */
372
+ patchDataProduct: typeof patchDataProduct;
373
+ /**
374
+ * Activates a data product for publishing and consumption.
375
+ * Once activated, the data product becomes discoverable and accessible to authorized users.
376
+ * Requires publish permissions and valid data product configuration.
377
+ *
378
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
379
+ * @param body an object with the body content
380
+ * @throws ActivateDataProductHttpError
381
+ */
382
+ activateDataProduct: typeof activateDataProduct;
383
+ /**
384
+ * Deactivates a data product, preventing it from being consumed by other services or users.
385
+ *
386
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
387
+ * @throws DeactivateDataProductHttpError
388
+ */
389
+ deactivateDataProduct: typeof deactivateDataProduct;
390
+ /**
391
+ * Exports data product documentation in Markdown format.
392
+ * Use this endpoint to generate documentation for sharing or archiving.
393
+ * Requires read access to the data product.
394
+ *
395
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
396
+ * @throws ExportDocumentationDataProductHttpError
397
+ */
398
+ exportDocumentationDataProduct: typeof exportDocumentationDataProduct;
399
+ /**
400
+ * Moves a data product from its current space to a different space.
401
+ * Use this endpoint to reorganize data products across workspaces or governance domains.
402
+ * Requires delete permissions in the source space and create permissions in the target space.
403
+ *
404
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
405
+ * @param body an object with the body content
406
+ * @throws MoveDataProductHttpError
407
+ */
408
+ moveDataProduct: typeof moveDataProduct;
409
+ /**
410
+ * Retrieves a paginated history of all notable changes made to a data product.
411
+ * Each changelog entry captures the operation type, affected property, and timestamp.
412
+ * Use this endpoint to track the history of changes or data product evolution over time.
413
+ *
414
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
415
+ * @param query an object with query parameters
416
+ * @throws GetDataProductChangelogsHttpError
417
+ */
418
+ getDataProductChangelogs: typeof getDataProductChangelogs;
419
+ /**
420
+ * Clears the cache for data-products api requests.
421
+ */
422
+ clearCache: typeof clearCache;
423
+ };
424
+ /**
425
+ * Functions for the data-products api
426
+ */
427
+ declare const dataProductsExport: DataProductsAPI;
428
+ //#endregion
429
+ export { ActivateDataProductHttpError, ActivateDataProductHttpResponse, ActivateDataProductRequest, ArrayOfUniqueStrings, ChangelogOperation, CreateDataProductHttpError, CreateDataProductHttpResponse, CreateDataProductRequest, DataProductChangelog, DataProductChangelogResponse, DataProductResponse, DataProductsAPI, DeactivateDataProductHttpError, DeactivateDataProductHttpResponse, DeleteDataProductHttpError, DeleteDataProductHttpResponse, Error, ErrorResponse, ExportDocumentationDataProductHttpError, ExportDocumentationDataProductHttpResponse, GenerateProviderUrlDataProductsHttpError, GenerateProviderUrlDataProductsHttpResponse, GenerateProviderUrlResponse, GetDataProductChangelogsHttpError, GetDataProductChangelogsHttpResponse, GetDataProductHttpError, GetDataProductHttpResponse, KeyContact, Link, Links, MoveDataProductHttpError, MoveDataProductHttpResponse, MoveDataProductRequest, PatchDataProductHttpError, PatchDataProductHttpResponse, PatchDataProductRequest, Quality, TrustScore, TrustScoreDimension, activateDataProduct, clearCache, createDataProduct, deactivateDataProduct, dataProductsExport as default, deleteDataProduct, exportDocumentationDataProduct, generateProviderUrlDataProducts, getDataProduct, getDataProductChangelogs, moveDataProduct, patchDataProduct, data_products_d_exports as t };
@@ -0,0 +1,212 @@
1
+ import { t as __exportAll } from "../chunks/chunk-BdHzlgOL.js";
2
+ import "../chunks/public-runtime-modules-2KfyI2qM.js";
3
+ import { n as invokeFetch, t as clearApiCache } from "../chunks/invoke-fetch-DMAi6Fg3.js";
4
+
5
+ //#region src/public/rest/data-governance/data-products.ts
6
+ var data_products_exports = /* @__PURE__ */ __exportAll({
7
+ activateDataProduct: () => activateDataProduct,
8
+ clearCache: () => clearCache,
9
+ createDataProduct: () => createDataProduct,
10
+ deactivateDataProduct: () => deactivateDataProduct,
11
+ default: () => dataProductsExport,
12
+ deleteDataProduct: () => deleteDataProduct,
13
+ exportDocumentationDataProduct: () => exportDocumentationDataProduct,
14
+ generateProviderUrlDataProducts: () => generateProviderUrlDataProducts,
15
+ getDataProduct: () => getDataProduct,
16
+ getDataProductChangelogs: () => getDataProductChangelogs,
17
+ moveDataProduct: () => moveDataProduct,
18
+ patchDataProduct: () => patchDataProduct
19
+ });
20
+ /**
21
+ * Creates a new data product with specified metadata, datasets, and governance information.
22
+ * Use this endpoint to package related datasets into a governed, discoverable asset.
23
+ * Requires create permissions in the target space.
24
+ *
25
+ * @param body an object with the body content
26
+ * @throws CreateDataProductHttpError
27
+ */
28
+ async function createDataProduct(body, options) {
29
+ return invokeFetch("data-governance/data-products", {
30
+ method: "post",
31
+ pathTemplate: "/api/data-governance/data-products",
32
+ body,
33
+ contentType: "application/json",
34
+ options
35
+ });
36
+ }
37
+ /**
38
+ * Generates a URL to access a third-party provider's user interface.
39
+ * Use this endpoint to integrate external services with your data product.
40
+ *
41
+ * @param query an object with query parameters
42
+ * @throws GenerateProviderUrlDataProductsHttpError
43
+ */
44
+ async function generateProviderUrlDataProducts(query, options) {
45
+ return invokeFetch("data-governance/data-products", {
46
+ method: "post",
47
+ pathTemplate: "/api/data-governance/data-products/actions/generate-provider-url",
48
+ query,
49
+ options
50
+ });
51
+ }
52
+ /**
53
+ * Permanently removes a data product from the tenant.
54
+ * This action cannot be undone and does not affect the underlying datasets.
55
+ * Requires delete permissions for the data product.
56
+ *
57
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
58
+ * @throws DeleteDataProductHttpError
59
+ */
60
+ async function deleteDataProduct(dataProductId, options) {
61
+ return invokeFetch("data-governance/data-products", {
62
+ method: "delete",
63
+ pathTemplate: "/api/data-governance/data-products/{dataProductId}",
64
+ pathVariables: { dataProductId },
65
+ options
66
+ });
67
+ }
68
+ /**
69
+ * Retrieves the details of the specified data product, including name, description, associated datasets, key contacts, and activation status.
70
+ * Requires read access to the Data Product.
71
+ *
72
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
73
+ * @throws GetDataProductHttpError
74
+ */
75
+ async function getDataProduct(dataProductId, options) {
76
+ return invokeFetch("data-governance/data-products", {
77
+ method: "get",
78
+ pathTemplate: "/api/data-governance/data-products/{dataProductId}",
79
+ pathVariables: { dataProductId },
80
+ options
81
+ });
82
+ }
83
+ /**
84
+ * Partially updates an existing data product using JSON Patch operations.
85
+ * Use this endpoint to modify properties such as name, description, datasets, tags, or key contacts.
86
+ * Changes are tracked in the data product changelog.
87
+ *
88
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
89
+ * @param body an object with the body content
90
+ * @throws PatchDataProductHttpError
91
+ */
92
+ async function patchDataProduct(dataProductId, body, options) {
93
+ return invokeFetch("data-governance/data-products", {
94
+ method: "patch",
95
+ pathTemplate: "/api/data-governance/data-products/{dataProductId}",
96
+ pathVariables: { dataProductId },
97
+ body,
98
+ contentType: "application/json",
99
+ options
100
+ });
101
+ }
102
+ /**
103
+ * Activates a data product for publishing and consumption.
104
+ * Once activated, the data product becomes discoverable and accessible to authorized users.
105
+ * Requires publish permissions and valid data product configuration.
106
+ *
107
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
108
+ * @param body an object with the body content
109
+ * @throws ActivateDataProductHttpError
110
+ */
111
+ async function activateDataProduct(dataProductId, body, options) {
112
+ return invokeFetch("data-governance/data-products", {
113
+ method: "post",
114
+ pathTemplate: "/api/data-governance/data-products/{dataProductId}/actions/activate",
115
+ pathVariables: { dataProductId },
116
+ body,
117
+ contentType: "application/json",
118
+ options
119
+ });
120
+ }
121
+ /**
122
+ * Deactivates a data product, preventing it from being consumed by other services or users.
123
+ *
124
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
125
+ * @throws DeactivateDataProductHttpError
126
+ */
127
+ async function deactivateDataProduct(dataProductId, options) {
128
+ return invokeFetch("data-governance/data-products", {
129
+ method: "post",
130
+ pathTemplate: "/api/data-governance/data-products/{dataProductId}/actions/deactivate",
131
+ pathVariables: { dataProductId },
132
+ options
133
+ });
134
+ }
135
+ /**
136
+ * Exports data product documentation in Markdown format.
137
+ * Use this endpoint to generate documentation for sharing or archiving.
138
+ * Requires read access to the data product.
139
+ *
140
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
141
+ * @throws ExportDocumentationDataProductHttpError
142
+ */
143
+ async function exportDocumentationDataProduct(dataProductId, options) {
144
+ return invokeFetch("data-governance/data-products", {
145
+ method: "get",
146
+ pathTemplate: "/api/data-governance/data-products/{dataProductId}/actions/export-documentation",
147
+ pathVariables: { dataProductId },
148
+ options
149
+ });
150
+ }
151
+ /**
152
+ * Moves a data product from its current space to a different space.
153
+ * Use this endpoint to reorganize data products across workspaces or governance domains.
154
+ * Requires delete permissions in the source space and create permissions in the target space.
155
+ *
156
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
157
+ * @param body an object with the body content
158
+ * @throws MoveDataProductHttpError
159
+ */
160
+ async function moveDataProduct(dataProductId, body, options) {
161
+ return invokeFetch("data-governance/data-products", {
162
+ method: "post",
163
+ pathTemplate: "/api/data-governance/data-products/{dataProductId}/actions/move",
164
+ pathVariables: { dataProductId },
165
+ body,
166
+ contentType: "application/json",
167
+ options
168
+ });
169
+ }
170
+ /**
171
+ * Retrieves a paginated history of all notable changes made to a data product.
172
+ * Each changelog entry captures the operation type, affected property, and timestamp.
173
+ * Use this endpoint to track the history of changes or data product evolution over time.
174
+ *
175
+ * @param dataProductId Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.
176
+ * @param query an object with query parameters
177
+ * @throws GetDataProductChangelogsHttpError
178
+ */
179
+ async function getDataProductChangelogs(dataProductId, query, options) {
180
+ return invokeFetch("data-governance/data-products", {
181
+ method: "get",
182
+ pathTemplate: "/api/data-governance/data-products/{dataProductId}/changelogs",
183
+ pathVariables: { dataProductId },
184
+ query,
185
+ options
186
+ });
187
+ }
188
+ /**
189
+ * Clears the cache for data-governance/data-products api requests.
190
+ */
191
+ function clearCache() {
192
+ return clearApiCache("data-governance/data-products");
193
+ }
194
+ /**
195
+ * Functions for the data-products api
196
+ */
197
+ const dataProductsExport = {
198
+ createDataProduct,
199
+ generateProviderUrlDataProducts,
200
+ deleteDataProduct,
201
+ getDataProduct,
202
+ patchDataProduct,
203
+ activateDataProduct,
204
+ deactivateDataProduct,
205
+ exportDocumentationDataProduct,
206
+ moveDataProduct,
207
+ getDataProductChangelogs,
208
+ clearCache
209
+ };
210
+
211
+ //#endregion
212
+ export { activateDataProduct, clearCache, createDataProduct, deactivateDataProduct, dataProductsExport as default, deleteDataProduct, exportDocumentationDataProduct, generateProviderUrlDataProducts, getDataProduct, getDataProductChangelogs, moveDataProduct, patchDataProduct, data_products_exports as t };
@@ -0,0 +1,13 @@
1
+ import "./chunks/invoke-fetch-DFc3yzaj.js";
2
+ import dataProductsExport, { t as data_products_d_exports } from "./data-governance/data-products.js";
3
+
4
+ //#region src/public/rest/data-governance.d.ts
5
+ type DataGovernanceAPI = {};
6
+ /**
7
+ * Functions for the data-governance api
8
+ */
9
+ declare const dataGovernanceExport: DataGovernanceAPI & {
10
+ dataProducts: typeof dataProductsExport;
11
+ };
12
+ //#endregion
13
+ export { DataGovernanceAPI, data_products_d_exports as dataProducts, dataGovernanceExport as default };
@@ -0,0 +1,12 @@
1
+ import "./chunks/public-runtime-modules-2KfyI2qM.js";
2
+ import "./chunks/invoke-fetch-DMAi6Fg3.js";
3
+ import dataProductsExport, { t as data_products_exports } from "./data-governance/data-products.js";
4
+
5
+ //#region src/public/rest/data-governance.ts
6
+ /**
7
+ * Functions for the data-governance api
8
+ */
9
+ const dataGovernanceExport = { dataProducts: dataProductsExport };
10
+
11
+ //#endregion
12
+ export { data_products_exports as dataProducts, dataGovernanceExport as default };