@qlik/api 1.30.0 → 1.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (138) hide show
  1. package/api-keys.d.ts +2 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +4 -2
  4. package/apps.js +2 -2
  5. package/assistants.d.ts +1301 -0
  6. package/assistants.js +273 -0
  7. package/audits.d.ts +2 -2
  8. package/audits.js +2 -2
  9. package/{auth-types-PkN9CAF_.d.ts → auth-types-DqfMuSRX.d.ts} +1 -0
  10. package/auth.d.ts +27 -3
  11. package/auth.js +8 -4
  12. package/automation-connections.d.ts +366 -0
  13. package/automation-connections.js +91 -0
  14. package/automations.d.ts +2 -2
  15. package/automations.js +2 -2
  16. package/automl-deployments.d.ts +97 -0
  17. package/automl-deployments.js +27 -0
  18. package/automl-predictions.d.ts +214 -0
  19. package/automl-predictions.js +72 -0
  20. package/brands.d.ts +2 -2
  21. package/brands.js +2 -2
  22. package/chunks/{JIX6RMFP.js → 6ZONDHRN.js} +1 -1
  23. package/chunks/ETNHFALU.js +61 -0
  24. package/chunks/{G6QUM5WQ.js → FKDGGR2O.js} +137 -45
  25. package/chunks/{TXC5XORK.js → LTNGXTXG.js} +3 -3
  26. package/chunks/{OTTC4QSX.js → LY7RP2HA.js} +7 -3
  27. package/chunks/{FKCZFVJL.js → M64RLKVG.js} +2074 -12
  28. package/chunks/{F5UDCCRD.js → PLVPW5IR.js} +1 -1
  29. package/chunks/{QK4TMJ64.js → RCLKKVYB.js} +11 -1
  30. package/chunks/{QWQLGDMI.js → UZTIZ4H5.js} +392 -372
  31. package/chunks/{PTDXR7AY.js → VVD2DPKQ.js} +2 -2
  32. package/chunks/{IQBP2PKS.js → YTT2FEVE.js} +1 -1
  33. package/collections.d.ts +3 -3
  34. package/collections.js +2 -2
  35. package/conditions.d.ts +662 -0
  36. package/conditions.js +113 -0
  37. package/consumption.d.ts +182 -0
  38. package/consumption.js +24 -0
  39. package/csp-origins.d.ts +2 -2
  40. package/csp-origins.js +2 -2
  41. package/csrf-token.d.ts +62 -0
  42. package/csrf-token.js +23 -0
  43. package/data-alerts.d.ts +1004 -0
  44. package/data-alerts.js +155 -0
  45. package/data-assets.d.ts +2 -2
  46. package/data-assets.js +2 -2
  47. package/data-connections.d.ts +7 -7
  48. package/data-connections.js +2 -2
  49. package/data-credentials.d.ts +2 -2
  50. package/data-credentials.js +2 -2
  51. package/data-files.d.ts +2 -2
  52. package/data-files.js +2 -2
  53. package/data-qualities.d.ts +175 -0
  54. package/data-qualities.js +44 -0
  55. package/data-sets.d.ts +424 -0
  56. package/data-sets.js +75 -0
  57. package/data-sources.d.ts +268 -0
  58. package/data-sources.js +39 -0
  59. package/data-stores.d.ts +537 -0
  60. package/data-stores.js +108 -0
  61. package/dcaas.d.ts +192 -0
  62. package/dcaas.js +39 -0
  63. package/di-projects.d.ts +673 -0
  64. package/di-projects.js +164 -0
  65. package/docs/authentication.md +47 -0
  66. package/encryption.d.ts +370 -0
  67. package/encryption.js +98 -0
  68. package/extensions.d.ts +2 -2
  69. package/extensions.js +2 -2
  70. package/glossaries.d.ts +2 -2
  71. package/glossaries.js +2 -2
  72. package/groups.d.ts +5 -4
  73. package/groups.js +2 -2
  74. package/identity-providers.d.ts +2 -2
  75. package/identity-providers.js +2 -2
  76. package/index.d.ts +110 -4
  77. package/index.js +556 -4
  78. package/interceptors.d.ts +2 -2
  79. package/{invoke-fetch-types-BXn-uSF5.d.ts → invoke-fetch-types-Cq7bjkqn.d.ts} +10 -2
  80. package/items.d.ts +3 -3
  81. package/items.js +2 -2
  82. package/knowledgebases.d.ts +890 -0
  83. package/knowledgebases.js +169 -0
  84. package/licenses.d.ts +6 -3
  85. package/licenses.js +2 -2
  86. package/lineage-graphs.d.ts +712 -0
  87. package/lineage-graphs.js +92 -0
  88. package/ml.d.ts +2628 -0
  89. package/ml.js +384 -0
  90. package/notes.d.ts +110 -0
  91. package/notes.js +31 -0
  92. package/notifications.d.ts +98 -0
  93. package/notifications.js +24 -0
  94. package/oauth-clients.d.ts +7 -2
  95. package/oauth-clients.js +2 -2
  96. package/oauth-tokens.d.ts +126 -0
  97. package/oauth-tokens.js +31 -0
  98. package/package.json +29 -2
  99. package/qix.d.ts +421 -26
  100. package/qix.js +2 -2
  101. package/questions.d.ts +364 -0
  102. package/questions.js +34 -0
  103. package/quotas.d.ts +2 -2
  104. package/quotas.js +2 -2
  105. package/reload-tasks.d.ts +4 -2
  106. package/reload-tasks.js +2 -2
  107. package/reloads.d.ts +4 -2
  108. package/reloads.js +2 -2
  109. package/report-templates.d.ts +287 -0
  110. package/report-templates.js +80 -0
  111. package/reports.d.ts +2 -2
  112. package/reports.js +2 -2
  113. package/roles.d.ts +2 -2
  114. package/roles.js +2 -2
  115. package/sharing-tasks.d.ts +952 -0
  116. package/sharing-tasks.js +105 -0
  117. package/spaces.d.ts +3 -7
  118. package/spaces.js +2 -2
  119. package/tasks.d.ts +564 -0
  120. package/tasks.js +106 -0
  121. package/temp-contents.d.ts +2 -2
  122. package/temp-contents.js +2 -2
  123. package/tenants.d.ts +2 -2
  124. package/tenants.js +2 -2
  125. package/themes.d.ts +2 -2
  126. package/themes.js +2 -2
  127. package/transports.d.ts +2 -2
  128. package/transports.js +2 -2
  129. package/ui-config.d.ts +274 -0
  130. package/ui-config.js +77 -0
  131. package/users.d.ts +2 -2
  132. package/users.js +2 -2
  133. package/web-integrations.d.ts +2 -2
  134. package/web-integrations.js +2 -2
  135. package/web-notifications.d.ts +2 -2
  136. package/web-notifications.js +2 -2
  137. package/webhooks.d.ts +2 -2
  138. package/webhooks.js +2 -2
@@ -0,0 +1,537 @@
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
+
4
+ type BatchIdDto = {
5
+ ids?: string[];
6
+ };
7
+ type DataAsset = {
8
+ appId?: string;
9
+ appType: string;
10
+ /** The value is automatically set by the application. User defined value is ignored. */
11
+ readonly createdBy?: string;
12
+ /** The value is automatically set by the application. User defined value is ignored. */
13
+ readonly createdTime?: string;
14
+ /** The date-time when the source data was last changed */
15
+ dataFreshness?: string;
16
+ dataStoreInfo?: DataStoreInfo;
17
+ description?: string;
18
+ /** Only required when updating the resource. Must be null for new resources. */
19
+ id?: string;
20
+ /** The value is automatically set by the application. User defined value is ignored. */
21
+ readonly lastModifiedBy?: string;
22
+ /** The value is automatically set by the application. User defined value is ignored. */
23
+ readonly lastModifiedTime?: string;
24
+ name?: string;
25
+ /** The value is automatically set by the application. */
26
+ ownerId?: string;
27
+ /** A Map of name-value pairs. */
28
+ properties?: Record<string, unknown>;
29
+ spaceId?: string;
30
+ tags?: string[];
31
+ technicalDescription?: string;
32
+ technicalName: string;
33
+ /** The value is automatically set by the application. User defined value is ignored. */
34
+ readonly tenantId?: string;
35
+ /** Only required when updating the resource. Must be null for new resources. */
36
+ version?: number;
37
+ };
38
+ type DataAssetInfo = {
39
+ dataStoreInfo?: DataStoreInfo;
40
+ id: string;
41
+ readonly name?: string;
42
+ };
43
+ type DataField = {
44
+ alias?: string;
45
+ dataType: FieldDataType;
46
+ description?: string;
47
+ encrypted?: boolean;
48
+ readonly index?: number;
49
+ name: string;
50
+ nullable?: boolean;
51
+ ordinalPositionInKey?: number;
52
+ orphan?: boolean;
53
+ primaryKey?: boolean;
54
+ properties?: Record<string, unknown>;
55
+ sensitive?: boolean;
56
+ /** An array of system tags */
57
+ tags?: string[];
58
+ /** An array of user-supplied tags */
59
+ userTags?: UserTag[];
60
+ };
61
+ type DataSet = {
62
+ /** Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema */
63
+ additionalSchemas?: Schema[];
64
+ /** Optional override of DataAsset appType. */
65
+ appTypeOverride?: string;
66
+ /** The value is automatically set by the application. User defined value is ignored. */
67
+ readonly createdBy?: string;
68
+ /** The connectionId that created the Dataset. Optional. */
69
+ createdByConnectionId?: string;
70
+ /** The value is automatically set by the application. User defined value is ignored. */
71
+ readonly createdTime?: string;
72
+ dataAssetInfo: DataAssetInfo;
73
+ description?: string;
74
+ /** Only required when updating the resource. Must be null for new resources. */
75
+ id?: string;
76
+ /** The value is automatically set by the application. User defined value is ignored. */
77
+ readonly lastModifiedBy?: string;
78
+ /** The value is automatically set by the application. User defined value is ignored. */
79
+ readonly lastModifiedTime?: string;
80
+ name?: string;
81
+ operational?: Operational;
82
+ /** The value is automatically set by the application. */
83
+ ownerId?: string;
84
+ /** A Map of name-value pairs. */
85
+ properties?: Record<string, unknown>;
86
+ /** NOTE: this will be deprecated after migration to secureQri. Required user defined field. All the parts in the format must be separated by ':'. The first part denotes the resourceType, followed by dataStoreType and tenant guid. The spaceGuid or userGuid is to be populated based on if the dataset is in shared or private space and finally the full file name. This field is auto populated for the dataSet generated for qix-datafiles. */
87
+ qri: string;
88
+ /** Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema */
89
+ schema?: Schema;
90
+ secureQri: string;
91
+ spaceId?: string;
92
+ tags?: string[];
93
+ technicalDescription?: string;
94
+ technicalName: string;
95
+ /** The value is automatically set by the application. User defined value is ignored. */
96
+ readonly tenantId?: string;
97
+ type?: string;
98
+ /** Only required when updating the resource. Must be null for new resources. */
99
+ version?: number;
100
+ };
101
+ type DataStore = {
102
+ /** The value is automatically set by the application. User defined value is ignored. */
103
+ readonly createdBy?: string;
104
+ /** The value is automatically set by the application. User defined value is ignored. */
105
+ readonly createdTime?: string;
106
+ description?: string;
107
+ /** Only required when updating the resource. Must be null for new resources. */
108
+ id?: string;
109
+ /** The value is automatically set by the application. User defined value is ignored. */
110
+ readonly lastModifiedBy?: string;
111
+ /** The value is automatically set by the application. User defined value is ignored. */
112
+ readonly lastModifiedTime?: string;
113
+ name?: string;
114
+ /** The value is automatically set by the application. */
115
+ ownerId?: string;
116
+ /** A Map of name-value pairs. */
117
+ properties?: Record<string, unknown>;
118
+ spaceId?: string;
119
+ tags?: string[];
120
+ technicalDescription?: string;
121
+ technicalName: string;
122
+ /** The value is automatically set by the application. User defined value is ignored. */
123
+ readonly tenantId?: string;
124
+ type: string;
125
+ uri?: string;
126
+ /** Only required when updating the resource. Must be null for new resources. */
127
+ version?: number;
128
+ };
129
+ type DataStoreInfo = {
130
+ id: string;
131
+ readonly name?: string;
132
+ readonly type?: string;
133
+ };
134
+ type Error = {
135
+ code?: string;
136
+ detail?: string;
137
+ status?: string;
138
+ title?: string;
139
+ };
140
+ type ErrorResponse = {
141
+ errors?: Error[];
142
+ traceId?: string;
143
+ };
144
+ type FieldDataType = {
145
+ originalType?: string;
146
+ /** The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined. */
147
+ properties?: Record<string, unknown>;
148
+ /** Each datatype may vary in terms of required properties. Example: Datatype DECIMAL requires two mandatory properties to be defined - precision and scale, each one accepts integer value. All other datatypes does not have any required properties. */
149
+ type: "DATE" | "TIME" | "DATETIME" | "TIMESTAMP" | "STRING" | "DOUBLE" | "DECIMAL" | "INTEGER" | "BOOLEAN" | "BINARY" | "CUSTOM";
150
+ };
151
+ type JsonPatch = {
152
+ /** A JSON Pointer path pointing to the location to move/copy from. */
153
+ from?: string;
154
+ /** The operation to be performed. */
155
+ op: "add" | "remove" | "replace" | "move" | "copy" | "test";
156
+ /** A JSON pointer to the property being affected. */
157
+ path: string;
158
+ /** The value to add, replace or test. */
159
+ value?: unknown;
160
+ };
161
+ type Link = {
162
+ href?: string;
163
+ };
164
+ type Links = {
165
+ first?: Link;
166
+ last?: Link;
167
+ next?: Link;
168
+ prev?: Link;
169
+ self?: Link;
170
+ };
171
+ type Operational = {
172
+ contentUpdated?: boolean;
173
+ endDate?: string;
174
+ lastLoadTime?: string;
175
+ lastUpdateTime?: string;
176
+ location?: string;
177
+ logMessage?: string;
178
+ rowCount?: number;
179
+ size?: number;
180
+ startDate?: string;
181
+ status?: string;
182
+ tableConnectionInfo?: TableConnectionInfo;
183
+ tableOwner?: string;
184
+ };
185
+ type PageDataAsset = {
186
+ data?: DataAsset[];
187
+ limit?: number;
188
+ links?: Links;
189
+ page?: number;
190
+ pages?: number;
191
+ total?: number;
192
+ };
193
+ type PageDataSet = {
194
+ data?: DataSet[];
195
+ limit?: number;
196
+ links?: Links;
197
+ page?: number;
198
+ pages?: number;
199
+ total?: number;
200
+ };
201
+ type PageDataStore = {
202
+ data?: DataStore[];
203
+ limit?: number;
204
+ links?: Links;
205
+ page?: number;
206
+ pages?: number;
207
+ total?: number;
208
+ };
209
+ /**
210
+ * Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema
211
+ */
212
+ type Schema = {
213
+ /** Anomalies associated with this schema. Example: $warning-unknown-headers */
214
+ anomalies?: string[];
215
+ dataFields: DataField[];
216
+ readonly effectiveDate?: string;
217
+ /** Options for loading files. Example: "qLabel": "embedded labels" */
218
+ loadOptions?: Record<string, unknown>;
219
+ overrideSchemaAnomalies?: boolean;
220
+ schemaName?: string;
221
+ };
222
+ type TableConnectionInfo = {
223
+ additionalProperties?: Record<string, string>;
224
+ selectionScript?: string;
225
+ tableName?: string;
226
+ };
227
+ /**
228
+ * An array of user-supplied tags
229
+ */
230
+ type UserTag = {
231
+ /** The id of the tag in Collections */
232
+ id?: string;
233
+ name?: string;
234
+ };
235
+ /**
236
+ * Delete data stores if it does not contain any data-assets.
237
+ *
238
+ * @param body an object with the body content
239
+ * @throws DeleteDataStoresHttpError
240
+ */
241
+ declare const deleteDataStores: (body: BatchIdDto, options?: ApiCallOptions) => Promise<DeleteDataStoresHttpResponse>;
242
+ type DeleteDataStoresHttpResponse = {
243
+ data: void;
244
+ headers: Headers;
245
+ status: 204;
246
+ };
247
+ type DeleteDataStoresHttpError = {
248
+ data: ErrorResponse;
249
+ headers: Headers;
250
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
251
+ };
252
+ /**
253
+ * Get all data stores.
254
+ *
255
+ * @param query an object with query parameters
256
+ * @throws GetDataStoresHttpError
257
+ */
258
+ declare const getDataStores: (query: {
259
+ /** Page size limit. */
260
+ limit?: number;
261
+ page?: number;
262
+ /** Comma-separated fields to return in the response. */
263
+ projections?: string[];
264
+ /** Comma-separated fields and field start with '-' character sorts the result set in descending order. */
265
+ sort?: string[];
266
+ }, options?: ApiCallOptions) => Promise<GetDataStoresHttpResponse>;
267
+ type GetDataStoresHttpResponse = {
268
+ data: PageDataStore;
269
+ headers: Headers;
270
+ status: 200;
271
+ prev?: (options?: ApiCallOptions) => Promise<GetDataStoresHttpResponse>;
272
+ next?: (options?: ApiCallOptions) => Promise<GetDataStoresHttpResponse>;
273
+ };
274
+ type GetDataStoresHttpError = {
275
+ data: ErrorResponse;
276
+ headers: Headers;
277
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
278
+ };
279
+ /**
280
+ * Save new data store.
281
+ *
282
+ * @param body an object with the body content
283
+ * @throws CreateDataStoreHttpError
284
+ */
285
+ declare const createDataStore: (body: DataStore, options?: ApiCallOptions) => Promise<CreateDataStoreHttpResponse>;
286
+ type CreateDataStoreHttpResponse = {
287
+ data: DataStore;
288
+ headers: Headers;
289
+ status: 201;
290
+ };
291
+ type CreateDataStoreHttpError = {
292
+ data: ErrorResponse;
293
+ headers: Headers;
294
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
295
+ };
296
+ /**
297
+ * Delete data assets and child data-sets by data-store IDs.
298
+ *
299
+ * @param dataStoreIds Comma-separated data store IDs or * to include all data stores.
300
+ * @throws DeleteDataStoreDataAssetsHttpError
301
+ */
302
+ declare const deleteDataStoreDataAssets: (dataStoreIds: string, options?: ApiCallOptions) => Promise<DeleteDataStoreDataAssetsHttpResponse>;
303
+ type DeleteDataStoreDataAssetsHttpResponse = {
304
+ data: void;
305
+ headers: Headers;
306
+ status: 204;
307
+ };
308
+ type DeleteDataStoreDataAssetsHttpError = {
309
+ data: ErrorResponse;
310
+ headers: Headers;
311
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
312
+ };
313
+ /**
314
+ * Get all data assets belonging to the data store(s).
315
+ *
316
+ * @param dataStoreIds Comma-separated data store IDs or * to include all data stores.
317
+ * @param query an object with query parameters
318
+ * @throws GetDataStoreDataAssetsHttpError
319
+ */
320
+ declare const getDataStoreDataAssets: (dataStoreIds: string, query: {
321
+ /** Page size limit. */
322
+ limit?: number;
323
+ page?: number;
324
+ /** Comma-separated fields to return in the response. */
325
+ projections?: string[];
326
+ /** Comma-separated fields and field start with '-' character sorts the result set in descending order. */
327
+ sort?: string[];
328
+ }, options?: ApiCallOptions) => Promise<GetDataStoreDataAssetsHttpResponse>;
329
+ type GetDataStoreDataAssetsHttpResponse = {
330
+ data: PageDataAsset;
331
+ headers: Headers;
332
+ status: 200;
333
+ prev?: (options?: ApiCallOptions) => Promise<GetDataStoreDataAssetsHttpResponse>;
334
+ next?: (options?: ApiCallOptions) => Promise<GetDataStoreDataAssetsHttpResponse>;
335
+ };
336
+ type GetDataStoreDataAssetsHttpError = {
337
+ data: ErrorResponse;
338
+ headers: Headers;
339
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
340
+ };
341
+ /**
342
+ * Delete data sets by data-store IDs and data-asset IDs.
343
+ *
344
+ * @param dataStoreIds Comma-separated data store IDs or * to include all data stores.
345
+ * @param dataAssetIds Comma-separated data asset IDs or * to include all data assets.
346
+ * @throws DeleteDataStoreDataAssetDataSetsHttpError
347
+ */
348
+ declare const deleteDataStoreDataAssetDataSets: (dataStoreIds: string, dataAssetIds: string, options?: ApiCallOptions) => Promise<DeleteDataStoreDataAssetDataSetsHttpResponse>;
349
+ type DeleteDataStoreDataAssetDataSetsHttpResponse = {
350
+ data: void;
351
+ headers: Headers;
352
+ status: 204;
353
+ };
354
+ type DeleteDataStoreDataAssetDataSetsHttpError = {
355
+ data: ErrorResponse;
356
+ headers: Headers;
357
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
358
+ };
359
+ /**
360
+ * Get all data sets belonging to the data store(s) and data asset(s).
361
+ *
362
+ * @param dataStoreIds Comma-separated data store IDs or * to include all data stores.
363
+ * @param dataAssetIds Comma-separated data asset IDs or * to include all data assets.
364
+ * @param query an object with query parameters
365
+ * @throws GetDataStoreDataAssetDataSetsHttpError
366
+ */
367
+ declare const getDataStoreDataAssetDataSets: (dataStoreIds: string, dataAssetIds: string, query: {
368
+ /** Page size limit. */
369
+ limit?: number;
370
+ page?: number;
371
+ /** Comma-separated fields to return in the response. */
372
+ projections?: string[];
373
+ /** Comma-separated fields and field start with '-' character sorts the result set in descending order. */
374
+ sort?: string[];
375
+ }, options?: ApiCallOptions) => Promise<GetDataStoreDataAssetDataSetsHttpResponse>;
376
+ type GetDataStoreDataAssetDataSetsHttpResponse = {
377
+ data: PageDataSet;
378
+ headers: Headers;
379
+ status: 200;
380
+ prev?: (options?: ApiCallOptions) => Promise<GetDataStoreDataAssetDataSetsHttpResponse>;
381
+ next?: (options?: ApiCallOptions) => Promise<GetDataStoreDataAssetDataSetsHttpResponse>;
382
+ };
383
+ type GetDataStoreDataAssetDataSetsHttpError = {
384
+ data: ErrorResponse;
385
+ headers: Headers;
386
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
387
+ };
388
+ /**
389
+ * Get data store by ID.
390
+ *
391
+ * @param dataStoreId
392
+ * @param query an object with query parameters
393
+ * @throws GetDataStoreHttpError
394
+ */
395
+ declare const getDataStore: (dataStoreId: string, query: {
396
+ /** Comma-separated fields to return in the response. */
397
+ projections?: string[];
398
+ }, options?: ApiCallOptions) => Promise<GetDataStoreHttpResponse>;
399
+ type GetDataStoreHttpResponse = {
400
+ data: DataStore;
401
+ headers: Headers;
402
+ status: 200;
403
+ };
404
+ type GetDataStoreHttpError = {
405
+ data: ErrorResponse;
406
+ headers: Headers;
407
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
408
+ };
409
+ /**
410
+ * Patch data store.
411
+ *
412
+ * @param dataStoreId
413
+ * @param body an object with the body content
414
+ * @throws PatchDataStoreHttpError
415
+ */
416
+ declare const patchDataStore: (dataStoreId: string, body: JsonPatch[], options?: ApiCallOptions) => Promise<PatchDataStoreHttpResponse>;
417
+ type PatchDataStoreHttpResponse = {
418
+ data: DataStore;
419
+ headers: Headers;
420
+ status: 200 | 204;
421
+ };
422
+ type PatchDataStoreHttpError = {
423
+ data: ErrorResponse;
424
+ headers: Headers;
425
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
426
+ };
427
+ /**
428
+ * Update data store.
429
+ *
430
+ * @param dataStoreId
431
+ * @param body an object with the body content
432
+ * @throws UpdateDataStoreHttpError
433
+ */
434
+ declare const updateDataStore: (dataStoreId: string, body: DataStore, options?: ApiCallOptions) => Promise<UpdateDataStoreHttpResponse>;
435
+ type UpdateDataStoreHttpResponse = {
436
+ data: DataStore;
437
+ headers: Headers;
438
+ status: 200;
439
+ };
440
+ type UpdateDataStoreHttpError = {
441
+ data: ErrorResponse;
442
+ headers: Headers;
443
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
444
+ };
445
+ /**
446
+ * Clears the cache for data-stores api requests.
447
+ */
448
+ declare function clearCache(): void;
449
+ interface DataStoresAPI {
450
+ /**
451
+ * Delete data stores if it does not contain any data-assets.
452
+ *
453
+ * @param body an object with the body content
454
+ * @throws DeleteDataStoresHttpError
455
+ */
456
+ deleteDataStores: typeof deleteDataStores;
457
+ /**
458
+ * Get all data stores.
459
+ *
460
+ * @param query an object with query parameters
461
+ * @throws GetDataStoresHttpError
462
+ */
463
+ getDataStores: typeof getDataStores;
464
+ /**
465
+ * Save new data store.
466
+ *
467
+ * @param body an object with the body content
468
+ * @throws CreateDataStoreHttpError
469
+ */
470
+ createDataStore: typeof createDataStore;
471
+ /**
472
+ * Delete data assets and child data-sets by data-store IDs.
473
+ *
474
+ * @param dataStoreIds Comma-separated data store IDs or * to include all data stores.
475
+ * @throws DeleteDataStoreDataAssetsHttpError
476
+ */
477
+ deleteDataStoreDataAssets: typeof deleteDataStoreDataAssets;
478
+ /**
479
+ * Get all data assets belonging to the data store(s).
480
+ *
481
+ * @param dataStoreIds Comma-separated data store IDs or * to include all data stores.
482
+ * @param query an object with query parameters
483
+ * @throws GetDataStoreDataAssetsHttpError
484
+ */
485
+ getDataStoreDataAssets: typeof getDataStoreDataAssets;
486
+ /**
487
+ * Delete data sets by data-store IDs and data-asset IDs.
488
+ *
489
+ * @param dataStoreIds Comma-separated data store IDs or * to include all data stores.
490
+ * @param dataAssetIds Comma-separated data asset IDs or * to include all data assets.
491
+ * @throws DeleteDataStoreDataAssetDataSetsHttpError
492
+ */
493
+ deleteDataStoreDataAssetDataSets: typeof deleteDataStoreDataAssetDataSets;
494
+ /**
495
+ * Get all data sets belonging to the data store(s) and data asset(s).
496
+ *
497
+ * @param dataStoreIds Comma-separated data store IDs or * to include all data stores.
498
+ * @param dataAssetIds Comma-separated data asset IDs or * to include all data assets.
499
+ * @param query an object with query parameters
500
+ * @throws GetDataStoreDataAssetDataSetsHttpError
501
+ */
502
+ getDataStoreDataAssetDataSets: typeof getDataStoreDataAssetDataSets;
503
+ /**
504
+ * Get data store by ID.
505
+ *
506
+ * @param dataStoreId
507
+ * @param query an object with query parameters
508
+ * @throws GetDataStoreHttpError
509
+ */
510
+ getDataStore: typeof getDataStore;
511
+ /**
512
+ * Patch data store.
513
+ *
514
+ * @param dataStoreId
515
+ * @param body an object with the body content
516
+ * @throws PatchDataStoreHttpError
517
+ */
518
+ patchDataStore: typeof patchDataStore;
519
+ /**
520
+ * Update data store.
521
+ *
522
+ * @param dataStoreId
523
+ * @param body an object with the body content
524
+ * @throws UpdateDataStoreHttpError
525
+ */
526
+ updateDataStore: typeof updateDataStore;
527
+ /**
528
+ * Clears the cache for data-stores api requests.
529
+ */
530
+ clearCache: typeof clearCache;
531
+ }
532
+ /**
533
+ * Functions for the data-stores api
534
+ */
535
+ declare const dataStoresExport: DataStoresAPI;
536
+
537
+ export { type BatchIdDto, type CreateDataStoreHttpError, type CreateDataStoreHttpResponse, type DataAsset, type DataAssetInfo, type DataField, type DataSet, type DataStore, type DataStoreInfo, type DataStoresAPI, type DeleteDataStoreDataAssetDataSetsHttpError, type DeleteDataStoreDataAssetDataSetsHttpResponse, type DeleteDataStoreDataAssetsHttpError, type DeleteDataStoreDataAssetsHttpResponse, type DeleteDataStoresHttpError, type DeleteDataStoresHttpResponse, type Error, type ErrorResponse, type FieldDataType, type GetDataStoreDataAssetDataSetsHttpError, type GetDataStoreDataAssetDataSetsHttpResponse, type GetDataStoreDataAssetsHttpError, type GetDataStoreDataAssetsHttpResponse, type GetDataStoreHttpError, type GetDataStoreHttpResponse, type GetDataStoresHttpError, type GetDataStoresHttpResponse, type JsonPatch, type Link, type Links, type Operational, type PageDataAsset, type PageDataSet, type PageDataStore, type PatchDataStoreHttpError, type PatchDataStoreHttpResponse, type Schema, type TableConnectionInfo, type UpdateDataStoreHttpError, type UpdateDataStoreHttpResponse, type UserTag, clearCache, createDataStore, dataStoresExport as default, deleteDataStoreDataAssetDataSets, deleteDataStoreDataAssets, deleteDataStores, getDataStore, getDataStoreDataAssetDataSets, getDataStoreDataAssets, getDataStores, patchDataStore, updateDataStore };
package/data-stores.js ADDED
@@ -0,0 +1,108 @@
1
+ import {
2
+ clearApiCache,
3
+ invokeFetch
4
+ } from "./chunks/VVD2DPKQ.js";
5
+ import "./chunks/LTNGXTXG.js";
6
+ import "./chunks/2ZQ3ZX7F.js";
7
+
8
+ // src/public/rest/data-stores.ts
9
+ var deleteDataStores = async (body, options) => invokeFetch("data-stores", {
10
+ method: "delete",
11
+ pathTemplate: "/api/v1/data-stores",
12
+ body,
13
+ contentType: "application/json",
14
+ options
15
+ });
16
+ var getDataStores = async (query, options) => invokeFetch("data-stores", {
17
+ method: "get",
18
+ pathTemplate: "/api/v1/data-stores",
19
+ query,
20
+ options
21
+ });
22
+ var createDataStore = async (body, options) => invokeFetch("data-stores", {
23
+ method: "post",
24
+ pathTemplate: "/api/v1/data-stores",
25
+ body,
26
+ contentType: "application/json",
27
+ options
28
+ });
29
+ var deleteDataStoreDataAssets = async (dataStoreIds, options) => invokeFetch("data-stores", {
30
+ method: "delete",
31
+ pathTemplate: "/api/v1/data-stores/{data-store-ids}/data-assets",
32
+ pathVariables: { "data-store-ids": dataStoreIds },
33
+ options
34
+ });
35
+ var getDataStoreDataAssets = async (dataStoreIds, query, options) => invokeFetch("data-stores", {
36
+ method: "get",
37
+ pathTemplate: "/api/v1/data-stores/{data-store-ids}/data-assets",
38
+ pathVariables: { "data-store-ids": dataStoreIds },
39
+ query,
40
+ options
41
+ });
42
+ var deleteDataStoreDataAssetDataSets = async (dataStoreIds, dataAssetIds, options) => invokeFetch("data-stores", {
43
+ method: "delete",
44
+ pathTemplate: "/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets",
45
+ pathVariables: { "data-store-ids": dataStoreIds, "data-asset-ids": dataAssetIds },
46
+ options
47
+ });
48
+ var getDataStoreDataAssetDataSets = async (dataStoreIds, dataAssetIds, query, options) => invokeFetch("data-stores", {
49
+ method: "get",
50
+ pathTemplate: "/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets",
51
+ pathVariables: { "data-store-ids": dataStoreIds, "data-asset-ids": dataAssetIds },
52
+ query,
53
+ options
54
+ });
55
+ var getDataStore = async (dataStoreId, query, options) => invokeFetch("data-stores", {
56
+ method: "get",
57
+ pathTemplate: "/api/v1/data-stores/{data-store-id}",
58
+ pathVariables: { "data-store-id": dataStoreId },
59
+ query,
60
+ options
61
+ });
62
+ var patchDataStore = async (dataStoreId, body, options) => invokeFetch("data-stores", {
63
+ method: "patch",
64
+ pathTemplate: "/api/v1/data-stores/{data-store-id}",
65
+ pathVariables: { "data-store-id": dataStoreId },
66
+ body,
67
+ contentType: "application/json",
68
+ options
69
+ });
70
+ var updateDataStore = async (dataStoreId, body, options) => invokeFetch("data-stores", {
71
+ method: "put",
72
+ pathTemplate: "/api/v1/data-stores/{data-store-id}",
73
+ pathVariables: { "data-store-id": dataStoreId },
74
+ body,
75
+ contentType: "application/json",
76
+ options
77
+ });
78
+ function clearCache() {
79
+ return clearApiCache("data-stores");
80
+ }
81
+ var dataStoresExport = {
82
+ deleteDataStores,
83
+ getDataStores,
84
+ createDataStore,
85
+ deleteDataStoreDataAssets,
86
+ getDataStoreDataAssets,
87
+ deleteDataStoreDataAssetDataSets,
88
+ getDataStoreDataAssetDataSets,
89
+ getDataStore,
90
+ patchDataStore,
91
+ updateDataStore,
92
+ clearCache
93
+ };
94
+ var data_stores_default = dataStoresExport;
95
+ export {
96
+ clearCache,
97
+ createDataStore,
98
+ data_stores_default as default,
99
+ deleteDataStoreDataAssetDataSets,
100
+ deleteDataStoreDataAssets,
101
+ deleteDataStores,
102
+ getDataStore,
103
+ getDataStoreDataAssetDataSets,
104
+ getDataStoreDataAssets,
105
+ getDataStores,
106
+ patchDataStore,
107
+ updateDataStore
108
+ };