@qlik/api 0.0.1 → 0.0.3
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.
- package/.github/CODEOWNERS +2 -0
- package/.github/workflows/release.yaml +35 -0
- package/README.md +1 -3
- package/api-keys.d.mts +27 -13
- package/api-keys.d.ts +27 -13
- package/api-keys.js +17 -13
- package/api-keys.mjs +12 -8
- package/apps.d.mts +580 -165
- package/apps.d.ts +580 -165
- package/apps.js +111 -44
- package/apps.mjs +78 -11
- package/audits.d.mts +20 -8
- package/audits.d.ts +20 -8
- package/audits.js +12 -11
- package/audits.mjs +7 -6
- package/auth-AWZV4DPP.js +41 -0
- package/{auth-TE272Q34.mjs → auth-CPBNNC7S.mjs} +8 -3
- package/auth.js +4 -3
- package/auth.mjs +3 -2
- package/automations.d.mts +56 -20
- package/automations.d.ts +56 -20
- package/automations.js +32 -25
- package/automations.mjs +18 -11
- package/brands.d.mts +45 -4
- package/brands.d.ts +45 -4
- package/brands.js +20 -15
- package/brands.mjs +7 -2
- package/{chunk-ZT4C7KCQ.js → chunk-2STFUQKQ.js} +3 -3
- package/{chunk-WM7FQU2U.mjs → chunk-3SVRHJII.mjs} +3 -3
- package/{chunk-CKPJE4IA.mjs → chunk-67GJTTPV.mjs} +1 -1
- package/{chunk-4ES65KO3.js → chunk-7RY3NO6N.js} +2 -2
- package/{chunk-4OMEH5SW.mjs → chunk-CYRLVHU3.mjs} +321 -53
- package/{chunk-XASXL2NC.js → chunk-D52VW5UN.js} +323 -55
- package/{chunk-GUQBHY3H.mjs → chunk-GNWU6SP2.mjs} +1 -1
- package/{chunk-4FLMND6T.js → chunk-GV5SRHY2.js} +4 -4
- package/{chunk-OULT3V2U.js → chunk-JNGURO23.js} +3 -3
- package/chunk-P57PW2II.js +11 -0
- package/{chunk-3YE7EI7I.mjs → chunk-TE7XMBT5.mjs} +1 -1
- package/chunk-ZFXKCRJC.mjs +11 -0
- package/collections.d.mts +52 -18
- package/collections.d.ts +52 -18
- package/collections.js +28 -14
- package/collections.mjs +16 -2
- package/csp-origins.d.mts +12 -0
- package/csp-origins.d.ts +12 -0
- package/csp-origins.js +12 -9
- package/csp-origins.mjs +5 -2
- package/data-assets.d.mts +10 -0
- package/data-assets.d.ts +10 -0
- package/data-assets.js +13 -8
- package/data-assets.mjs +7 -2
- package/data-connections.d.mts +20 -0
- package/data-connections.d.ts +20 -0
- package/data-connections.js +19 -12
- package/data-connections.mjs +9 -2
- package/data-credentials.d.mts +10 -0
- package/data-credentials.d.ts +10 -0
- package/data-credentials.js +10 -7
- package/data-credentials.mjs +5 -2
- package/data-files.d.mts +114 -29
- package/data-files.d.ts +114 -29
- package/data-files.js +25 -18
- package/data-files.mjs +15 -8
- package/{enigma-session-TEB53FAF.js → enigma-session-XPXDQAIV.js} +12 -7
- package/{enigma-session-4L373ALV.mjs → enigma-session-ZH6MYA54.mjs} +10 -5
- package/{esm-4X3DKK5D.js → esm-3VXX2GKL.js} +13 -9
- package/{esm-SOWVJKOQ.mjs → esm-OY4XVIJB.mjs} +13 -9
- package/extensions.d.mts +26 -2
- package/extensions.d.ts +26 -2
- package/extensions.js +13 -10
- package/extensions.mjs +5 -2
- package/glossaries.d.mts +55 -20
- package/glossaries.d.ts +55 -20
- package/glossaries.js +39 -27
- package/glossaries.mjs +14 -2
- package/groups.d.mts +29 -13
- package/groups.d.ts +29 -13
- package/groups.js +19 -14
- package/groups.mjs +13 -8
- package/identity-providers.d.mts +23 -7
- package/identity-providers.d.ts +23 -7
- package/identity-providers.js +16 -13
- package/identity-providers.mjs +8 -5
- package/index.js +150 -112
- package/index.mjs +146 -108
- package/{invoke-fetch-MSSJAZ7K.mjs → invoke-fetch-3WZWAAZH.mjs} +4 -1
- package/invoke-fetch-UNTAUR7O.js +17 -0
- package/items.d.mts +25 -22
- package/items.d.ts +25 -22
- package/items.js +17 -14
- package/items.mjs +11 -8
- package/licenses.d.mts +20 -0
- package/licenses.d.ts +20 -0
- package/licenses.js +17 -12
- package/licenses.mjs +7 -2
- package/package.json +7 -18
- package/{qix-RLTISYTB.js → qix-UNWXPGMA.js} +9 -8
- package/{qix-EU7PXRZ6.mjs → qix-ZSJ4PIK3.mjs} +5 -4
- package/qix.d.mts +1066 -1017
- package/qix.d.ts +1066 -1017
- package/qix.js +4 -3
- package/qix.mjs +3 -2
- package/quotas.d.mts +4 -0
- package/quotas.d.ts +4 -0
- package/quotas.js +6 -5
- package/quotas.mjs +3 -2
- package/reload-tasks.d.mts +2 -0
- package/reload-tasks.d.ts +2 -0
- package/reload-tasks.js +11 -8
- package/reload-tasks.mjs +5 -2
- package/reloads.d.mts +20 -11
- package/reloads.d.ts +20 -11
- package/reloads.js +9 -7
- package/reloads.mjs +4 -2
- package/roles.d.mts +4 -0
- package/roles.d.ts +4 -0
- package/roles.js +6 -5
- package/roles.mjs +3 -2
- package/spaces.d.mts +36 -30
- package/spaces.d.ts +36 -30
- package/spaces.js +21 -15
- package/spaces.mjs +8 -2
- package/temp-contents.d.mts +9 -70
- package/temp-contents.d.ts +9 -70
- package/temp-contents.js +10 -29
- package/temp-contents.mjs +5 -24
- package/tenants.d.mts +12 -0
- package/tenants.d.ts +12 -0
- package/tenants.js +14 -9
- package/tenants.mjs +7 -2
- package/themes.d.mts +26 -2
- package/themes.d.ts +26 -2
- package/themes.js +13 -10
- package/themes.mjs +5 -2
- package/transports.d.mts +12 -0
- package/transports.d.ts +12 -0
- package/transports.js +12 -9
- package/transports.mjs +5 -2
- package/users.d.mts +48 -29
- package/users.d.ts +48 -29
- package/users.js +18 -13
- package/users.mjs +7 -2
- package/web-integrations.d.mts +10 -0
- package/web-integrations.d.ts +10 -0
- package/web-integrations.js +11 -8
- package/web-integrations.mjs +5 -2
- package/web-notifications.d.mts +12 -0
- package/web-notifications.d.ts +12 -0
- package/web-notifications.js +12 -9
- package/web-notifications.mjs +5 -2
- package/webhooks.d.mts +27 -7
- package/webhooks.d.ts +27 -7
- package/webhooks.js +17 -13
- package/webhooks.mjs +6 -2
- package/auth-CSVTXOZX.js +0 -36
- package/invoke-fetch-PEI54KZO.js +0 -14
package/items.d.mts
CHANGED
|
@@ -18,8 +18,7 @@ type ItemsSettingsPatch = {
|
|
|
18
18
|
op: "replace";
|
|
19
19
|
/** Field of Settings to be patched (updated). */
|
|
20
20
|
path: "/usageMetricsEnabled";
|
|
21
|
-
/** The value to be used within the operations.
|
|
22
|
-
// */
|
|
21
|
+
/** The value to be used within the operations. */
|
|
23
22
|
value: boolean;
|
|
24
23
|
}[];
|
|
25
24
|
type ItemsSettingsResponseBody = {
|
|
@@ -173,7 +172,7 @@ type ItemTagResponseBody = {
|
|
|
173
172
|
type ItemViewsResponseBody = {
|
|
174
173
|
/** Total number of views the resource got during the last 28 days. */
|
|
175
174
|
total?: number;
|
|
176
|
-
/** Trend in views over the last 4 weeks. */
|
|
175
|
+
/** Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks. */
|
|
177
176
|
trend?: number;
|
|
178
177
|
/** Number of unique users who viewed the resource during the last 28 days. */
|
|
179
178
|
unique?: number;
|
|
@@ -215,6 +214,7 @@ type Meta = {
|
|
|
215
214
|
/** Is the error a timeout? */
|
|
216
215
|
timeout?: boolean;
|
|
217
216
|
};
|
|
217
|
+
type SpaceTypeEnum = "shared" | "managed" | "personal" | "data";
|
|
218
218
|
/**
|
|
219
219
|
* Finds and returns items that the user has access to.
|
|
220
220
|
*
|
|
@@ -234,8 +234,7 @@ declare const getItems: (query: {
|
|
|
234
234
|
name?: string | undefined;
|
|
235
235
|
/** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
|
|
236
236
|
next?: string | undefined;
|
|
237
|
-
/** If set to true, the user's available actions for each item will not be evaluated meaning the actions-array will be omitted from the response (reduces response time).
|
|
238
|
-
// */
|
|
237
|
+
/** If set to true, the user's available actions for each item will not be evaluated meaning the actions-array will be omitted from the response (reduces response time). */
|
|
239
238
|
noActions?: boolean | undefined;
|
|
240
239
|
/** User's unique identifier. */
|
|
241
240
|
notCreatedByUserId?: string | undefined;
|
|
@@ -260,9 +259,11 @@ declare const getItems: (query: {
|
|
|
260
259
|
/** Whether or not to return items in a shared space. */
|
|
261
260
|
shared?: boolean | undefined;
|
|
262
261
|
/** The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively. */
|
|
263
|
-
sort?: "
|
|
262
|
+
sort?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;
|
|
264
263
|
/** The space's unique identifier (supports \'personal\' as spaceId). */
|
|
265
264
|
spaceId?: string | undefined;
|
|
265
|
+
/** The case-sensitive string used to filter items on space type(s). For example '?spaceType=shared,personal'. */
|
|
266
|
+
spaceType?: SpaceTypeEnum | undefined;
|
|
266
267
|
}, options?: ApiCallOptions) => Promise<GetItemsHttpResponse>;
|
|
267
268
|
type GetItemsHttpResponse = {
|
|
268
269
|
data: ItemsListItemsResponseBody;
|
|
@@ -279,31 +280,32 @@ type GetItemsHttpError = {
|
|
|
279
280
|
/**
|
|
280
281
|
* Finds and returns the settings for the current tenant.
|
|
281
282
|
*
|
|
282
|
-
* @throws
|
|
283
|
+
* @throws GetItemsSettingsHttpError
|
|
283
284
|
*/
|
|
284
|
-
declare const
|
|
285
|
-
type
|
|
285
|
+
declare const getItemsSettings: (options?: ApiCallOptions) => Promise<GetItemsSettingsHttpResponse>;
|
|
286
|
+
type GetItemsSettingsHttpResponse = {
|
|
286
287
|
data: ItemsSettingsResponseBody;
|
|
287
288
|
headers: Headers;
|
|
288
289
|
status: number;
|
|
289
290
|
};
|
|
290
|
-
type
|
|
291
|
+
type GetItemsSettingsHttpError = {
|
|
291
292
|
data: ErrorResponseBody;
|
|
292
293
|
headers: Headers;
|
|
293
294
|
status: number;
|
|
294
295
|
};
|
|
295
296
|
/**
|
|
296
297
|
* Updates the settings provided in the patch body.
|
|
298
|
+
*
|
|
297
299
|
* @param body an object with the body content
|
|
298
|
-
* @throws
|
|
300
|
+
* @throws PatchItemsSettingsHttpError
|
|
299
301
|
*/
|
|
300
|
-
declare const
|
|
301
|
-
type
|
|
302
|
+
declare const patchItemsSettings: (body: ItemsSettingsPatch, options?: ApiCallOptions) => Promise<PatchItemsSettingsHttpResponse>;
|
|
303
|
+
type PatchItemsSettingsHttpResponse = {
|
|
302
304
|
data: ItemsSettingsResponseBody;
|
|
303
305
|
headers: Headers;
|
|
304
306
|
status: number;
|
|
305
307
|
};
|
|
306
|
-
type
|
|
308
|
+
type PatchItemsSettingsHttpError = {
|
|
307
309
|
data: ErrorResponseBody;
|
|
308
310
|
headers: Headers;
|
|
309
311
|
status: number;
|
|
@@ -379,7 +381,7 @@ declare const getItemCollections: (itemId: string, query: {
|
|
|
379
381
|
/** The case-insensitive string used to search for a resource by name or description. */
|
|
380
382
|
query?: string | undefined;
|
|
381
383
|
/** The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively. */
|
|
382
|
-
sort?: "
|
|
384
|
+
sort?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;
|
|
383
385
|
/** The case-sensitive string used to search for a collection by type. */
|
|
384
386
|
type?: CollectionTypes | undefined;
|
|
385
387
|
}, options?: ApiCallOptions) => Promise<GetItemCollectionsHttpResponse>;
|
|
@@ -396,7 +398,7 @@ type GetItemCollectionsHttpError = {
|
|
|
396
398
|
status: number;
|
|
397
399
|
};
|
|
398
400
|
/**
|
|
399
|
-
* Finds and returns the published items for a given item.
|
|
401
|
+
* Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item.
|
|
400
402
|
*
|
|
401
403
|
* @param itemId The item's unique identifier
|
|
402
404
|
* @param query an object with query parameters
|
|
@@ -441,15 +443,16 @@ interface ItemsAPI {
|
|
|
441
443
|
/**
|
|
442
444
|
* Finds and returns the settings for the current tenant.
|
|
443
445
|
*
|
|
444
|
-
* @throws
|
|
446
|
+
* @throws GetItemsSettingsHttpError
|
|
445
447
|
*/
|
|
446
|
-
|
|
448
|
+
getItemsSettings: typeof getItemsSettings;
|
|
447
449
|
/**
|
|
448
450
|
* Updates the settings provided in the patch body.
|
|
451
|
+
*
|
|
449
452
|
* @param body an object with the body content
|
|
450
|
-
* @throws
|
|
453
|
+
* @throws PatchItemsSettingsHttpError
|
|
451
454
|
*/
|
|
452
|
-
|
|
455
|
+
patchItemsSettings: typeof patchItemsSettings;
|
|
453
456
|
/**
|
|
454
457
|
* Deletes an item and removes the item from all collections.
|
|
455
458
|
*
|
|
@@ -481,7 +484,7 @@ interface ItemsAPI {
|
|
|
481
484
|
*/
|
|
482
485
|
getItemCollections: typeof getItemCollections;
|
|
483
486
|
/**
|
|
484
|
-
* Finds and returns the published items for a given item.
|
|
487
|
+
* Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item.
|
|
485
488
|
*
|
|
486
489
|
* @param itemId The item's unique identifier
|
|
487
490
|
* @param query an object with query parameters
|
|
@@ -498,4 +501,4 @@ interface ItemsAPI {
|
|
|
498
501
|
*/
|
|
499
502
|
declare const itemsExport: ItemsAPI;
|
|
500
503
|
|
|
501
|
-
export { type CollectionLinksResponseBody, type CollectionMetaResponseBody, type CollectionResultResponseBody, type CollectionTypes, type CollectionsLinksResponseBody, type DeleteItemHttpError, type DeleteItemHttpResponse, type ErrorResponseBody, type GetItemCollectionsHttpError, type GetItemCollectionsHttpResponse, type GetItemHttpError, type GetItemHttpResponse, type
|
|
504
|
+
export { type CollectionLinksResponseBody, type CollectionMetaResponseBody, type CollectionResultResponseBody, type CollectionTypes, type CollectionsLinksResponseBody, type DeleteItemHttpError, type DeleteItemHttpResponse, type ErrorResponseBody, type GetItemCollectionsHttpError, type GetItemCollectionsHttpResponse, type GetItemHttpError, type GetItemHttpResponse, type GetItemsHttpError, type GetItemsHttpResponse, type GetItemsSettingsHttpError, type GetItemsSettingsHttpResponse, type GetPublishedItemsHttpError, type GetPublishedItemsHttpResponse, type ItemLinksResponseBody, type ItemMetaResponseBody, type ItemResourceTypeEnum, type ItemResultResponseBody, type ItemTagResponseBody, type ItemViewsResponseBody, type ItemViewsWeeksResponseBody, type ItemsAPI, type ItemsLinksResponseBody, type ItemsListItemCollectionsResponseBody, type ItemsListItemsResponseBody, type ItemsResourceSizeResponseBody, type ItemsResultResponseBody, type ItemsSettingsPatch, type ItemsSettingsResponseBody, type ItemsUpdateItemRequestBody, type Link, type Meta, type PatchItemsSettingsHttpError, type PatchItemsSettingsHttpResponse, type ServiceError, type SpaceTypeEnum, type UpdateItemHttpError, type UpdateItemHttpResponse, clearCache, itemsExport as default, deleteItem, getItem, getItemCollections, getItems, getItemsSettings, getPublishedItems, patchItemsSettings, updateItem };
|
package/items.d.ts
CHANGED
|
@@ -18,8 +18,7 @@ type ItemsSettingsPatch = {
|
|
|
18
18
|
op: "replace";
|
|
19
19
|
/** Field of Settings to be patched (updated). */
|
|
20
20
|
path: "/usageMetricsEnabled";
|
|
21
|
-
/** The value to be used within the operations.
|
|
22
|
-
// */
|
|
21
|
+
/** The value to be used within the operations. */
|
|
23
22
|
value: boolean;
|
|
24
23
|
}[];
|
|
25
24
|
type ItemsSettingsResponseBody = {
|
|
@@ -173,7 +172,7 @@ type ItemTagResponseBody = {
|
|
|
173
172
|
type ItemViewsResponseBody = {
|
|
174
173
|
/** Total number of views the resource got during the last 28 days. */
|
|
175
174
|
total?: number;
|
|
176
|
-
/** Trend in views over the last 4 weeks. */
|
|
175
|
+
/** Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks. */
|
|
177
176
|
trend?: number;
|
|
178
177
|
/** Number of unique users who viewed the resource during the last 28 days. */
|
|
179
178
|
unique?: number;
|
|
@@ -215,6 +214,7 @@ type Meta = {
|
|
|
215
214
|
/** Is the error a timeout? */
|
|
216
215
|
timeout?: boolean;
|
|
217
216
|
};
|
|
217
|
+
type SpaceTypeEnum = "shared" | "managed" | "personal" | "data";
|
|
218
218
|
/**
|
|
219
219
|
* Finds and returns items that the user has access to.
|
|
220
220
|
*
|
|
@@ -234,8 +234,7 @@ declare const getItems: (query: {
|
|
|
234
234
|
name?: string | undefined;
|
|
235
235
|
/** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
|
|
236
236
|
next?: string | undefined;
|
|
237
|
-
/** If set to true, the user's available actions for each item will not be evaluated meaning the actions-array will be omitted from the response (reduces response time).
|
|
238
|
-
// */
|
|
237
|
+
/** If set to true, the user's available actions for each item will not be evaluated meaning the actions-array will be omitted from the response (reduces response time). */
|
|
239
238
|
noActions?: boolean | undefined;
|
|
240
239
|
/** User's unique identifier. */
|
|
241
240
|
notCreatedByUserId?: string | undefined;
|
|
@@ -260,9 +259,11 @@ declare const getItems: (query: {
|
|
|
260
259
|
/** Whether or not to return items in a shared space. */
|
|
261
260
|
shared?: boolean | undefined;
|
|
262
261
|
/** The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively. */
|
|
263
|
-
sort?: "
|
|
262
|
+
sort?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;
|
|
264
263
|
/** The space's unique identifier (supports \'personal\' as spaceId). */
|
|
265
264
|
spaceId?: string | undefined;
|
|
265
|
+
/** The case-sensitive string used to filter items on space type(s). For example '?spaceType=shared,personal'. */
|
|
266
|
+
spaceType?: SpaceTypeEnum | undefined;
|
|
266
267
|
}, options?: ApiCallOptions) => Promise<GetItemsHttpResponse>;
|
|
267
268
|
type GetItemsHttpResponse = {
|
|
268
269
|
data: ItemsListItemsResponseBody;
|
|
@@ -279,31 +280,32 @@ type GetItemsHttpError = {
|
|
|
279
280
|
/**
|
|
280
281
|
* Finds and returns the settings for the current tenant.
|
|
281
282
|
*
|
|
282
|
-
* @throws
|
|
283
|
+
* @throws GetItemsSettingsHttpError
|
|
283
284
|
*/
|
|
284
|
-
declare const
|
|
285
|
-
type
|
|
285
|
+
declare const getItemsSettings: (options?: ApiCallOptions) => Promise<GetItemsSettingsHttpResponse>;
|
|
286
|
+
type GetItemsSettingsHttpResponse = {
|
|
286
287
|
data: ItemsSettingsResponseBody;
|
|
287
288
|
headers: Headers;
|
|
288
289
|
status: number;
|
|
289
290
|
};
|
|
290
|
-
type
|
|
291
|
+
type GetItemsSettingsHttpError = {
|
|
291
292
|
data: ErrorResponseBody;
|
|
292
293
|
headers: Headers;
|
|
293
294
|
status: number;
|
|
294
295
|
};
|
|
295
296
|
/**
|
|
296
297
|
* Updates the settings provided in the patch body.
|
|
298
|
+
*
|
|
297
299
|
* @param body an object with the body content
|
|
298
|
-
* @throws
|
|
300
|
+
* @throws PatchItemsSettingsHttpError
|
|
299
301
|
*/
|
|
300
|
-
declare const
|
|
301
|
-
type
|
|
302
|
+
declare const patchItemsSettings: (body: ItemsSettingsPatch, options?: ApiCallOptions) => Promise<PatchItemsSettingsHttpResponse>;
|
|
303
|
+
type PatchItemsSettingsHttpResponse = {
|
|
302
304
|
data: ItemsSettingsResponseBody;
|
|
303
305
|
headers: Headers;
|
|
304
306
|
status: number;
|
|
305
307
|
};
|
|
306
|
-
type
|
|
308
|
+
type PatchItemsSettingsHttpError = {
|
|
307
309
|
data: ErrorResponseBody;
|
|
308
310
|
headers: Headers;
|
|
309
311
|
status: number;
|
|
@@ -379,7 +381,7 @@ declare const getItemCollections: (itemId: string, query: {
|
|
|
379
381
|
/** The case-insensitive string used to search for a resource by name or description. */
|
|
380
382
|
query?: string | undefined;
|
|
381
383
|
/** The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively. */
|
|
382
|
-
sort?: "
|
|
384
|
+
sort?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;
|
|
383
385
|
/** The case-sensitive string used to search for a collection by type. */
|
|
384
386
|
type?: CollectionTypes | undefined;
|
|
385
387
|
}, options?: ApiCallOptions) => Promise<GetItemCollectionsHttpResponse>;
|
|
@@ -396,7 +398,7 @@ type GetItemCollectionsHttpError = {
|
|
|
396
398
|
status: number;
|
|
397
399
|
};
|
|
398
400
|
/**
|
|
399
|
-
* Finds and returns the published items for a given item.
|
|
401
|
+
* Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item.
|
|
400
402
|
*
|
|
401
403
|
* @param itemId The item's unique identifier
|
|
402
404
|
* @param query an object with query parameters
|
|
@@ -441,15 +443,16 @@ interface ItemsAPI {
|
|
|
441
443
|
/**
|
|
442
444
|
* Finds and returns the settings for the current tenant.
|
|
443
445
|
*
|
|
444
|
-
* @throws
|
|
446
|
+
* @throws GetItemsSettingsHttpError
|
|
445
447
|
*/
|
|
446
|
-
|
|
448
|
+
getItemsSettings: typeof getItemsSettings;
|
|
447
449
|
/**
|
|
448
450
|
* Updates the settings provided in the patch body.
|
|
451
|
+
*
|
|
449
452
|
* @param body an object with the body content
|
|
450
|
-
* @throws
|
|
453
|
+
* @throws PatchItemsSettingsHttpError
|
|
451
454
|
*/
|
|
452
|
-
|
|
455
|
+
patchItemsSettings: typeof patchItemsSettings;
|
|
453
456
|
/**
|
|
454
457
|
* Deletes an item and removes the item from all collections.
|
|
455
458
|
*
|
|
@@ -481,7 +484,7 @@ interface ItemsAPI {
|
|
|
481
484
|
*/
|
|
482
485
|
getItemCollections: typeof getItemCollections;
|
|
483
486
|
/**
|
|
484
|
-
* Finds and returns the published items for a given item.
|
|
487
|
+
* Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item.
|
|
485
488
|
*
|
|
486
489
|
* @param itemId The item's unique identifier
|
|
487
490
|
* @param query an object with query parameters
|
|
@@ -498,4 +501,4 @@ interface ItemsAPI {
|
|
|
498
501
|
*/
|
|
499
502
|
declare const itemsExport: ItemsAPI;
|
|
500
503
|
|
|
501
|
-
export { type CollectionLinksResponseBody, type CollectionMetaResponseBody, type CollectionResultResponseBody, type CollectionTypes, type CollectionsLinksResponseBody, type DeleteItemHttpError, type DeleteItemHttpResponse, type ErrorResponseBody, type GetItemCollectionsHttpError, type GetItemCollectionsHttpResponse, type GetItemHttpError, type GetItemHttpResponse, type
|
|
504
|
+
export { type CollectionLinksResponseBody, type CollectionMetaResponseBody, type CollectionResultResponseBody, type CollectionTypes, type CollectionsLinksResponseBody, type DeleteItemHttpError, type DeleteItemHttpResponse, type ErrorResponseBody, type GetItemCollectionsHttpError, type GetItemCollectionsHttpResponse, type GetItemHttpError, type GetItemHttpResponse, type GetItemsHttpError, type GetItemsHttpResponse, type GetItemsSettingsHttpError, type GetItemsSettingsHttpResponse, type GetPublishedItemsHttpError, type GetPublishedItemsHttpResponse, type ItemLinksResponseBody, type ItemMetaResponseBody, type ItemResourceTypeEnum, type ItemResultResponseBody, type ItemTagResponseBody, type ItemViewsResponseBody, type ItemViewsWeeksResponseBody, type ItemsAPI, type ItemsLinksResponseBody, type ItemsListItemCollectionsResponseBody, type ItemsListItemsResponseBody, type ItemsResourceSizeResponseBody, type ItemsResultResponseBody, type ItemsSettingsPatch, type ItemsSettingsResponseBody, type ItemsUpdateItemRequestBody, type Link, type Meta, type PatchItemsSettingsHttpError, type PatchItemsSettingsHttpResponse, type ServiceError, type SpaceTypeEnum, type UpdateItemHttpError, type UpdateItemHttpResponse, clearCache, itemsExport as default, deleteItem, getItem, getItemCollections, getItems, getItemsSettings, getPublishedItems, patchItemsSettings, updateItem };
|
package/items.js
CHANGED
|
@@ -1,54 +1,57 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
2
|
|
|
3
3
|
|
|
4
|
-
var
|
|
5
|
-
require('./chunk-
|
|
4
|
+
var _chunkJNGURO23js = require('./chunk-JNGURO23.js');
|
|
5
|
+
require('./chunk-2STFUQKQ.js');
|
|
6
|
+
require('./chunk-P57PW2II.js');
|
|
6
7
|
|
|
7
8
|
// src/public/rest/items.ts
|
|
8
|
-
var getItems = async (query, options) =>
|
|
9
|
+
var getItems = async (query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "items", {
|
|
9
10
|
method: "get",
|
|
10
11
|
pathTemplate: "/api/v1/items",
|
|
11
12
|
query,
|
|
12
13
|
options
|
|
13
14
|
});
|
|
14
|
-
var
|
|
15
|
+
var getItemsSettings = async (options) => _chunkJNGURO23js.invokeFetch.call(void 0, "items", {
|
|
15
16
|
method: "get",
|
|
16
17
|
pathTemplate: "/api/v1/items/settings",
|
|
17
18
|
options
|
|
18
19
|
});
|
|
19
|
-
var
|
|
20
|
+
var patchItemsSettings = async (body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "items", {
|
|
20
21
|
method: "patch",
|
|
21
22
|
pathTemplate: "/api/v1/items/settings",
|
|
22
23
|
body,
|
|
24
|
+
contentType: "application/json",
|
|
23
25
|
options
|
|
24
26
|
});
|
|
25
|
-
var deleteItem = async (itemId, options) =>
|
|
27
|
+
var deleteItem = async (itemId, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "items", {
|
|
26
28
|
method: "delete",
|
|
27
29
|
pathTemplate: "/api/v1/items/{itemId}",
|
|
28
30
|
pathVariables: { itemId },
|
|
29
31
|
options
|
|
30
32
|
});
|
|
31
|
-
var getItem = async (itemId, options) =>
|
|
33
|
+
var getItem = async (itemId, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "items", {
|
|
32
34
|
method: "get",
|
|
33
35
|
pathTemplate: "/api/v1/items/{itemId}",
|
|
34
36
|
pathVariables: { itemId },
|
|
35
37
|
options
|
|
36
38
|
});
|
|
37
|
-
var updateItem = async (itemId, body, options) =>
|
|
39
|
+
var updateItem = async (itemId, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "items", {
|
|
38
40
|
method: "put",
|
|
39
41
|
pathTemplate: "/api/v1/items/{itemId}",
|
|
40
42
|
pathVariables: { itemId },
|
|
41
43
|
body,
|
|
44
|
+
contentType: "application/json",
|
|
42
45
|
options
|
|
43
46
|
});
|
|
44
|
-
var getItemCollections = async (itemId, query, options) =>
|
|
47
|
+
var getItemCollections = async (itemId, query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "items", {
|
|
45
48
|
method: "get",
|
|
46
49
|
pathTemplate: "/api/v1/items/{itemId}/collections",
|
|
47
50
|
pathVariables: { itemId },
|
|
48
51
|
query,
|
|
49
52
|
options
|
|
50
53
|
});
|
|
51
|
-
var getPublishedItems = async (itemId, query, options) =>
|
|
54
|
+
var getPublishedItems = async (itemId, query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "items", {
|
|
52
55
|
method: "get",
|
|
53
56
|
pathTemplate: "/api/v1/items/{itemId}/publisheditems",
|
|
54
57
|
pathVariables: { itemId },
|
|
@@ -56,12 +59,12 @@ var getPublishedItems = async (itemId, query, options) => _chunkOULT3V2Ujs.invok
|
|
|
56
59
|
options
|
|
57
60
|
});
|
|
58
61
|
function clearCache() {
|
|
59
|
-
return
|
|
62
|
+
return _chunkJNGURO23js.clearApiCache.call(void 0, "items");
|
|
60
63
|
}
|
|
61
64
|
var itemsExport = {
|
|
62
65
|
getItems,
|
|
63
|
-
|
|
64
|
-
|
|
66
|
+
getItemsSettings,
|
|
67
|
+
patchItemsSettings,
|
|
65
68
|
deleteItem,
|
|
66
69
|
getItem,
|
|
67
70
|
updateItem,
|
|
@@ -81,4 +84,4 @@ var items_default = itemsExport;
|
|
|
81
84
|
|
|
82
85
|
|
|
83
86
|
|
|
84
|
-
exports.clearCache = clearCache; exports.default = items_default; exports.deleteItem = deleteItem; exports.getItem = getItem; exports.getItemCollections = getItemCollections; exports.
|
|
87
|
+
exports.clearCache = clearCache; exports.default = items_default; exports.deleteItem = deleteItem; exports.getItem = getItem; exports.getItemCollections = getItemCollections; exports.getItems = getItems; exports.getItemsSettings = getItemsSettings; exports.getPublishedItems = getPublishedItems; exports.patchItemsSettings = patchItemsSettings; exports.updateItem = updateItem;
|
package/items.mjs
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import {
|
|
2
2
|
clearApiCache,
|
|
3
3
|
invokeFetch
|
|
4
|
-
} from "./chunk-
|
|
5
|
-
import "./chunk-
|
|
4
|
+
} from "./chunk-TE7XMBT5.mjs";
|
|
5
|
+
import "./chunk-3SVRHJII.mjs";
|
|
6
|
+
import "./chunk-ZFXKCRJC.mjs";
|
|
6
7
|
|
|
7
8
|
// src/public/rest/items.ts
|
|
8
9
|
var getItems = async (query, options) => invokeFetch("items", {
|
|
@@ -11,15 +12,16 @@ var getItems = async (query, options) => invokeFetch("items", {
|
|
|
11
12
|
query,
|
|
12
13
|
options
|
|
13
14
|
});
|
|
14
|
-
var
|
|
15
|
+
var getItemsSettings = async (options) => invokeFetch("items", {
|
|
15
16
|
method: "get",
|
|
16
17
|
pathTemplate: "/api/v1/items/settings",
|
|
17
18
|
options
|
|
18
19
|
});
|
|
19
|
-
var
|
|
20
|
+
var patchItemsSettings = async (body, options) => invokeFetch("items", {
|
|
20
21
|
method: "patch",
|
|
21
22
|
pathTemplate: "/api/v1/items/settings",
|
|
22
23
|
body,
|
|
24
|
+
contentType: "application/json",
|
|
23
25
|
options
|
|
24
26
|
});
|
|
25
27
|
var deleteItem = async (itemId, options) => invokeFetch("items", {
|
|
@@ -39,6 +41,7 @@ var updateItem = async (itemId, body, options) => invokeFetch("items", {
|
|
|
39
41
|
pathTemplate: "/api/v1/items/{itemId}",
|
|
40
42
|
pathVariables: { itemId },
|
|
41
43
|
body,
|
|
44
|
+
contentType: "application/json",
|
|
42
45
|
options
|
|
43
46
|
});
|
|
44
47
|
var getItemCollections = async (itemId, query, options) => invokeFetch("items", {
|
|
@@ -60,8 +63,8 @@ function clearCache() {
|
|
|
60
63
|
}
|
|
61
64
|
var itemsExport = {
|
|
62
65
|
getItems,
|
|
63
|
-
|
|
64
|
-
|
|
66
|
+
getItemsSettings,
|
|
67
|
+
patchItemsSettings,
|
|
65
68
|
deleteItem,
|
|
66
69
|
getItem,
|
|
67
70
|
updateItem,
|
|
@@ -76,9 +79,9 @@ export {
|
|
|
76
79
|
deleteItem,
|
|
77
80
|
getItem,
|
|
78
81
|
getItemCollections,
|
|
79
|
-
getItemSettings,
|
|
80
82
|
getItems,
|
|
83
|
+
getItemsSettings,
|
|
81
84
|
getPublishedItems,
|
|
82
|
-
|
|
85
|
+
patchItemsSettings,
|
|
83
86
|
updateItem
|
|
84
87
|
};
|
package/licenses.d.mts
CHANGED
|
@@ -206,6 +206,7 @@ type SettingsBody = {
|
|
|
206
206
|
};
|
|
207
207
|
/**
|
|
208
208
|
* Retrieves assignments for the current tenant
|
|
209
|
+
*
|
|
209
210
|
* @param query an object with query parameters
|
|
210
211
|
* @throws GetLicenseAssignmentsHttpError
|
|
211
212
|
*/
|
|
@@ -214,6 +215,8 @@ declare const getLicenseAssignments: (query: {
|
|
|
214
215
|
filter?: string;
|
|
215
216
|
/** The preferred number of entries to return. */
|
|
216
217
|
limit?: number;
|
|
218
|
+
/** Only return assignments which are 'orphans' in the current tenant. */
|
|
219
|
+
orphans?: boolean;
|
|
217
220
|
/** The requested page. */
|
|
218
221
|
page?: string;
|
|
219
222
|
/** The field to sort on; can be prefixed with +/- for ascending/descending sort order. */
|
|
@@ -233,6 +236,7 @@ type GetLicenseAssignmentsHttpError = {
|
|
|
233
236
|
};
|
|
234
237
|
/**
|
|
235
238
|
* Assigns license access to the given users
|
|
239
|
+
*
|
|
236
240
|
* @param body an object with the body content
|
|
237
241
|
* @throws AddLicenseAssignmentsHttpError
|
|
238
242
|
*/
|
|
@@ -249,6 +253,7 @@ type AddLicenseAssignmentsHttpError = {
|
|
|
249
253
|
};
|
|
250
254
|
/**
|
|
251
255
|
* Removes license access for the given users
|
|
256
|
+
*
|
|
252
257
|
* @param body an object with the body content
|
|
253
258
|
* @throws DeleteLicenseAssignmentsHttpError
|
|
254
259
|
*/
|
|
@@ -265,6 +270,7 @@ type DeleteLicenseAssignmentsHttpError = {
|
|
|
265
270
|
};
|
|
266
271
|
/**
|
|
267
272
|
* Updates license access for the given users
|
|
273
|
+
*
|
|
268
274
|
* @param body an object with the body content
|
|
269
275
|
* @throws UpdateLicenseAssignmentsHttpError
|
|
270
276
|
*/
|
|
@@ -281,6 +287,7 @@ type UpdateLicenseAssignmentsHttpError = {
|
|
|
281
287
|
};
|
|
282
288
|
/**
|
|
283
289
|
* Retrieves license consumption for the current tenant
|
|
290
|
+
*
|
|
284
291
|
* @param query an object with query parameters
|
|
285
292
|
* @throws GetLicenseConsumptionHttpError
|
|
286
293
|
*/
|
|
@@ -308,6 +315,7 @@ type GetLicenseConsumptionHttpError = {
|
|
|
308
315
|
};
|
|
309
316
|
/**
|
|
310
317
|
* Gets the general information of the license applied to the current tenant
|
|
318
|
+
*
|
|
311
319
|
* @throws GetLicenseOverviewHttpError
|
|
312
320
|
*/
|
|
313
321
|
declare const getLicenseOverview: (options?: ApiCallOptions) => Promise<GetLicenseOverviewHttpResponse>;
|
|
@@ -323,6 +331,7 @@ type GetLicenseOverviewHttpError = {
|
|
|
323
331
|
};
|
|
324
332
|
/**
|
|
325
333
|
* Get auto assign settings for tenant.
|
|
334
|
+
*
|
|
326
335
|
* @throws GetLicenseSettingsHttpError
|
|
327
336
|
*/
|
|
328
337
|
declare const getLicenseSettings: (options?: ApiCallOptions) => Promise<GetLicenseSettingsHttpResponse>;
|
|
@@ -338,6 +347,7 @@ type GetLicenseSettingsHttpError = {
|
|
|
338
347
|
};
|
|
339
348
|
/**
|
|
340
349
|
* Set auto assign settings for tenant
|
|
350
|
+
*
|
|
341
351
|
* @param body an object with the body content
|
|
342
352
|
* @throws UpdateLicenseSettingsHttpError
|
|
343
353
|
*/
|
|
@@ -354,6 +364,7 @@ type UpdateLicenseSettingsHttpError = {
|
|
|
354
364
|
};
|
|
355
365
|
/**
|
|
356
366
|
* Gets the license status information of the current tenant
|
|
367
|
+
*
|
|
357
368
|
* @throws GetLicenseStatusHttpError
|
|
358
369
|
*/
|
|
359
370
|
declare const getLicenseStatus: (options?: ApiCallOptions) => Promise<GetLicenseStatusHttpResponse>;
|
|
@@ -374,52 +385,61 @@ declare function clearCache(): void;
|
|
|
374
385
|
interface LicensesAPI {
|
|
375
386
|
/**
|
|
376
387
|
* Retrieves assignments for the current tenant
|
|
388
|
+
*
|
|
377
389
|
* @param query an object with query parameters
|
|
378
390
|
* @throws GetLicenseAssignmentsHttpError
|
|
379
391
|
*/
|
|
380
392
|
getLicenseAssignments: typeof getLicenseAssignments;
|
|
381
393
|
/**
|
|
382
394
|
* Assigns license access to the given users
|
|
395
|
+
*
|
|
383
396
|
* @param body an object with the body content
|
|
384
397
|
* @throws AddLicenseAssignmentsHttpError
|
|
385
398
|
*/
|
|
386
399
|
addLicenseAssignments: typeof addLicenseAssignments;
|
|
387
400
|
/**
|
|
388
401
|
* Removes license access for the given users
|
|
402
|
+
*
|
|
389
403
|
* @param body an object with the body content
|
|
390
404
|
* @throws DeleteLicenseAssignmentsHttpError
|
|
391
405
|
*/
|
|
392
406
|
deleteLicenseAssignments: typeof deleteLicenseAssignments;
|
|
393
407
|
/**
|
|
394
408
|
* Updates license access for the given users
|
|
409
|
+
*
|
|
395
410
|
* @param body an object with the body content
|
|
396
411
|
* @throws UpdateLicenseAssignmentsHttpError
|
|
397
412
|
*/
|
|
398
413
|
updateLicenseAssignments: typeof updateLicenseAssignments;
|
|
399
414
|
/**
|
|
400
415
|
* Retrieves license consumption for the current tenant
|
|
416
|
+
*
|
|
401
417
|
* @param query an object with query parameters
|
|
402
418
|
* @throws GetLicenseConsumptionHttpError
|
|
403
419
|
*/
|
|
404
420
|
getLicenseConsumption: typeof getLicenseConsumption;
|
|
405
421
|
/**
|
|
406
422
|
* Gets the general information of the license applied to the current tenant
|
|
423
|
+
*
|
|
407
424
|
* @throws GetLicenseOverviewHttpError
|
|
408
425
|
*/
|
|
409
426
|
getLicenseOverview: typeof getLicenseOverview;
|
|
410
427
|
/**
|
|
411
428
|
* Get auto assign settings for tenant.
|
|
429
|
+
*
|
|
412
430
|
* @throws GetLicenseSettingsHttpError
|
|
413
431
|
*/
|
|
414
432
|
getLicenseSettings: typeof getLicenseSettings;
|
|
415
433
|
/**
|
|
416
434
|
* Set auto assign settings for tenant
|
|
435
|
+
*
|
|
417
436
|
* @param body an object with the body content
|
|
418
437
|
* @throws UpdateLicenseSettingsHttpError
|
|
419
438
|
*/
|
|
420
439
|
updateLicenseSettings: typeof updateLicenseSettings;
|
|
421
440
|
/**
|
|
422
441
|
* Gets the license status information of the current tenant
|
|
442
|
+
*
|
|
423
443
|
* @throws GetLicenseStatusHttpError
|
|
424
444
|
*/
|
|
425
445
|
getLicenseStatus: typeof getLicenseStatus;
|