@qlik/api 1.17.0 → 1.19.0

package/collections.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type CollectionByIdPatch = {
     /** The operation to be performed. */
@@ -19,6 +19,7 @@ type CollectionsAddCollectionItemRequestBody = {
 };
 type CollectionsCreateCollectionRequestBody = {
     description?: string;
+    /** For `public` collections (tags), if name already exists in the tenant as a `public` collection, this call will fail with a `409` response. */
     name: string;
     type: CollectionTypes;
 };
@@ -233,7 +234,7 @@ type Meta = {
     timeout?: boolean;
 };
 /**
- * Finds and returns the collections that the user can access. This endpoint does not return the user's favorites collection.
+ * Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with `/v1/collections/favorites`.
  *
  * @param query an object with query parameters
  * @throws GetCollectionsHttpError
@@ -261,7 +262,7 @@ declare const getCollections: (query: {
      * must be prefixed by + or - to indicate ascending or descending sort order
      * respectively. */
     sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
-    /** The case-sensitive string used to filter for a collection by type. */
+    /** The case-sensitive string used to filter for a collection by type. Retrieve private collections with `private`, public collections with `publicgoverned`, and tags with `public`. */
     type?: CollectionTypes;
     /** A commaseparated case-sensitive string used to filter by multiple types. */
     types?: CollectionTypes[];
@@ -279,7 +280,7 @@ type GetCollectionsHttpError = {
     status: number;
 };
 /**
- * Creates and returns a new collection. Collections can have the same name.
+ * Creates and returns a new collection. Collections of type `public` (shown as tags in the user interface) must have unique names. Other collection types can reuse names.
  *
  * @param body an object with the body content
  * @throws CreateCollectionHttpError
@@ -296,7 +297,7 @@ type CreateCollectionHttpError = {
     status: number;
 };
 /**
- * Finds and returns the user's favorites collection.
+ * Lists the user's favorites collection.
  *
  * @throws GetFavoritesCollectionHttpError
  */
@@ -346,7 +347,7 @@ type GetCollectionHttpError = {
     status: number;
 };
 /**
- * Updates the collection fields provided in the patch body.
+ * Updates the name, description, or type fields provided in the patch body. Can be used to publish a `private` collection as a `publicgoverned` collection by patching `/type` with `publicgoverned` once the collection contains at least 1 item. Can also be used to return a `publicgoverned` collection to `private`. Cannot be used to change between `public` (tag) and `private / publicgoverned` (collection).
  *
  * @param collectionId The collection's unique identifier.
  * @param body an object with the body content
@@ -364,7 +365,7 @@ type PatchCollectionHttpError = {
     status: number;
 };
 /**
- * Updates a collection and returns the new collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
+ * Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
  *
  * @param collectionId The collection's unique identifier.
  * @param body an object with the body content
@@ -382,7 +383,7 @@ type UpdateCollectionHttpError = {
     status: number;
 };
 /**
- * Finds and returns items from a collection that the user has access to.
+ * Retrieves items from a collection that the user has access to.
  *
  * @param collectionId The collection's unique identifier. (This query also supports 'favorites' as the collectionID).
 
@@ -463,7 +464,7 @@ type DeleteCollectionItemHttpError = {
     status: number;
 };
 /**
- * Finds and returns an item. See GET /items/{id}
+ * Finds and returns an item in a specific collection. See GET `/items/{id}`.
  *
  * @param collectionId The collection's unique identifier.
  * @param itemId The item's unique identifier.
@@ -486,21 +487,21 @@ type GetCollectionItemHttpError = {
 declare function clearCache(): void;
 interface CollectionsAPI {
     /**
-     * Finds and returns the collections that the user can access. This endpoint does not return the user's favorites collection.
+     * Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with `/v1/collections/favorites`.
      *
      * @param query an object with query parameters
      * @throws GetCollectionsHttpError
      */
     getCollections: typeof getCollections;
     /**
-     * Creates and returns a new collection. Collections can have the same name.
+     * Creates and returns a new collection. Collections of type `public` (shown as tags in the user interface) must have unique names. Other collection types can reuse names.
      *
      * @param body an object with the body content
      * @throws CreateCollectionHttpError
      */
     createCollection: typeof createCollection;
     /**
-     * Finds and returns the user's favorites collection.
+     * Lists the user's favorites collection.
      *
      * @throws GetFavoritesCollectionHttpError
      */
@@ -520,7 +521,7 @@ interface CollectionsAPI {
      */
     getCollection: typeof getCollection;
     /**
-     * Updates the collection fields provided in the patch body.
+     * Updates the name, description, or type fields provided in the patch body. Can be used to publish a `private` collection as a `publicgoverned` collection by patching `/type` with `publicgoverned` once the collection contains at least 1 item. Can also be used to return a `publicgoverned` collection to `private`. Cannot be used to change between `public` (tag) and `private / publicgoverned` (collection).
      *
      * @param collectionId The collection's unique identifier.
      * @param body an object with the body content
@@ -528,7 +529,7 @@ interface CollectionsAPI {
      */
     patchCollection: typeof patchCollection;
     /**
-     * Updates a collection and returns the new collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
+     * Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
      *
      * @param collectionId The collection's unique identifier.
      * @param body an object with the body content
@@ -536,7 +537,7 @@ interface CollectionsAPI {
      */
     updateCollection: typeof updateCollection;
     /**
-     * Finds and returns items from a collection that the user has access to.
+     * Retrieves items from a collection that the user has access to.
      *
      * @param collectionId The collection's unique identifier. (This query also supports 'favorites' as the collectionID).
   
@@ -561,7 +562,7 @@ interface CollectionsAPI {
      */
     deleteCollectionItem: typeof deleteCollectionItem;
     /**
-     * Finds and returns an item. See GET /items/{id}
+     * Finds and returns an item in a specific collection. See GET `/items/{id}`.
      *
      * @param collectionId The collection's unique identifier.
      * @param itemId The item's unique identifier.

package/collections.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/BOJLTXK6.js";
+import "./chunks/VISO65GO.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/collections.ts

package/csp-origins.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type CSPEntry = {
     /** The CSP entry's unique identifier. */

package/csp-origins.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/BOJLTXK6.js";
+import "./chunks/VISO65GO.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/csp-origins.ts

package/data-assets.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type BatchIdDto = {
     ids?: string[];

package/data-assets.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/BOJLTXK6.js";
+import "./chunks/VISO65GO.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-assets.ts

package/data-connections.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type ActionDeleteRequest = {
     connections: {

package/data-connections.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/BOJLTXK6.js";
+import "./chunks/VISO65GO.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-connections.ts

package/data-credentials.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type Credential = {
     /** ID datasource that the credential is created for */

package/data-credentials.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/BOJLTXK6.js";
+import "./chunks/VISO65GO.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-credentials.ts

package/data-files.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type BatchChangeSpaceItem = {
     /** The ID of the data file whose space will be changed. */

package/data-files.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/BOJLTXK6.js";
+import "./chunks/VISO65GO.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-files.ts

package/extensions.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 /**
  * Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
@@ -96,7 +96,7 @@ type Meta = {
     stack?: string;
 };
 /**
- * Lists all extensions.
+ * Lists all imported extensions in the tenant.
  *
  * @throws GetExtensionsHttpError
  */
@@ -112,7 +112,7 @@ type GetExtensionsHttpError = {
     status: number;
 };
 /**
- * Creates a new extension. If a file is provided, the data field is not required.
+ * Creates a new extension. Accepts either provided file or data object. The name of the new extension must be different to any existing extensions.
  *
  * @param body an object with the body content
  * @throws UploadExtensionHttpError
@@ -134,7 +134,7 @@ type UploadExtensionHttpError = {
     status: number;
 };
 /**
- * Deletes a specific extension.
+ * Deletes a specific extension matching either extension ID or extension name.
  *
  * @param id Extension identifier or its qextFilename.
  * @throws DeleteExtensionHttpError
@@ -151,7 +151,7 @@ type DeleteExtensionHttpError = {
     status: number;
 };
 /**
- * Returns a specific extension.
+ * Returns a specific extension matching either extension ID or extension name.
  *
  * @param id Extension identifier or its qextFilename.
  * @throws GetExtensionHttpError
@@ -168,7 +168,7 @@ type GetExtensionHttpError = {
     status: number;
 };
 /**
- * Updates a specific extension with provided data. If a file is provided, the data field is not required.
+ * Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object.
  *
  * @param id Extension identifier or its qextFilename.
  * @param body an object with the body content
@@ -191,7 +191,7 @@ type PatchExtensionHttpError = {
     status: number;
 };
 /**
- * Downloads the extension as an archive.
+ * Downloads all files in the extension matching either extension ID or extension name as a `.zip` archive.
  *
  * @param id Extension identifier or its qextFilename.
  * @throws DownloadExtensionHttpError
@@ -208,10 +208,10 @@ type DownloadExtensionHttpError = {
     status: number;
 };
 /**
- * Downloads a file from the extension archive.
+ * Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension.
  *
  * @param id Extension identifier or its qextFilename.
- * @param filepath Path to the file archive for the specified extension archive. Folders separated with forward slashes.
+ * @param filepath Path to the file location within the specified extension archive. Folders separated with forward slashes.
  * @throws DownloadFileFromExtensionHttpError
  */
 declare const downloadFileFromExtension: (id: string, filepath: string, options?: ApiCallOptions) => Promise<DownloadFileFromExtensionHttpResponse>;
@@ -231,34 +231,34 @@ type DownloadFileFromExtensionHttpError = {
 declare function clearCache(): void;
 interface ExtensionsAPI {
     /**
-     * Lists all extensions.
+     * Lists all imported extensions in the tenant.
      *
      * @throws GetExtensionsHttpError
      */
     getExtensions: typeof getExtensions;
     /**
-     * Creates a new extension. If a file is provided, the data field is not required.
+     * Creates a new extension. Accepts either provided file or data object. The name of the new extension must be different to any existing extensions.
      *
      * @param body an object with the body content
      * @throws UploadExtensionHttpError
      */
     uploadExtension: typeof uploadExtension;
     /**
-     * Deletes a specific extension.
+     * Deletes a specific extension matching either extension ID or extension name.
      *
      * @param id Extension identifier or its qextFilename.
      * @throws DeleteExtensionHttpError
      */
     deleteExtension: typeof deleteExtension;
     /**
-     * Returns a specific extension.
+     * Returns a specific extension matching either extension ID or extension name.
      *
      * @param id Extension identifier or its qextFilename.
      * @throws GetExtensionHttpError
      */
     getExtension: typeof getExtension;
     /**
-     * Updates a specific extension with provided data. If a file is provided, the data field is not required.
+     * Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object.
      *
      * @param id Extension identifier or its qextFilename.
      * @param body an object with the body content
@@ -266,17 +266,17 @@ interface ExtensionsAPI {
      */
     patchExtension: typeof patchExtension;
     /**
-     * Downloads the extension as an archive.
+     * Downloads all files in the extension matching either extension ID or extension name as a `.zip` archive.
      *
      * @param id Extension identifier or its qextFilename.
      * @throws DownloadExtensionHttpError
      */
     downloadExtension: typeof downloadExtension;
     /**
-     * Downloads a file from the extension archive.
+     * Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension.
      *
      * @param id Extension identifier or its qextFilename.
-     * @param filepath Path to the file archive for the specified extension archive. Folders separated with forward slashes.
+     * @param filepath Path to the file location within the specified extension archive. Folders separated with forward slashes.
      * @throws DownloadFileFromExtensionHttpError
      */
     downloadFileFromExtension: typeof downloadFileFromExtension;

package/extensions.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/BOJLTXK6.js";
+import "./chunks/VISO65GO.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/extensions.ts

package/{global.types-BU2Yugjm.d.ts → global.types--37uwGji.d.ts}

@@ -1,4 +1,4 @@
-import { H as HostConfig } from './auth-types-BU5EGt_9.js';
+import { H as HostConfig } from './auth-types-PkN9CAF_.js';
 
 /** An entry in the cache for one specific cacheKey */
 type CacheEntry = {

package/glossaries.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 /**
  * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.

package/glossaries.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/BOJLTXK6.js";
+import "./chunks/VISO65GO.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/glossaries.ts

package/groups.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 /**
  * An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
@@ -268,7 +268,7 @@ type FilterGroupsHttpError = {
     status: number;
 };
 /**
- * Returns the active tenant's group settings.
+ * Returns the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.
  *
  * @throws GetGroupsSettingsHttpError
  */
@@ -284,7 +284,7 @@ type GetGroupsSettingsHttpError = {
     status: number;
 };
 /**
- * Update group settings
+ * Updates the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.
  *
  * @param body an object with the body content
  * @throws PatchGroupsSettingsHttpError
@@ -301,7 +301,7 @@ type PatchGroupsSettingsHttpError = {
     status: number;
 };
 /**
- * Delete group by id
+ * Deletes the requested group.
  *
  * @param groupId The ID of the group to delete.
  * @throws DeleteGroupHttpError
@@ -335,7 +335,7 @@ type GetGroupHttpError = {
     status: number;
 };
 /**
- * Update group by id
+ * Updates the requested group.
  *
  * @param groupId The ID of the group to update.
  * @param body an object with the body content
@@ -380,20 +380,20 @@ interface GroupsAPI {
      */
     filterGroups: typeof filterGroups;
     /**
-     * Returns the active tenant's group settings.
+     * Returns the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.
      *
      * @throws GetGroupsSettingsHttpError
      */
     getGroupsSettings: typeof getGroupsSettings;
     /**
-     * Update group settings
+     * Updates the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.
      *
      * @param body an object with the body content
      * @throws PatchGroupsSettingsHttpError
      */
     patchGroupsSettings: typeof patchGroupsSettings;
     /**
-     * Delete group by id
+     * Deletes the requested group.
      *
      * @param groupId The ID of the group to delete.
      * @throws DeleteGroupHttpError
@@ -407,7 +407,7 @@ interface GroupsAPI {
      */
     getGroup: typeof getGroup;
     /**
-     * Update group by id
+     * Updates the requested group.
      *
      * @param groupId The ID of the group to update.
      * @param body an object with the body content

package/groups.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/BOJLTXK6.js";
+import "./chunks/VISO65GO.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/groups.ts

package/identity-providers.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type BaseIDP = {
     /** Indicates whether the IdP is available for use. */

package/identity-providers.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/BOJLTXK6.js";
+import "./chunks/VISO65GO.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/identity-providers.ts

package/index.d.ts

@@ -31,8 +31,8 @@ import { UsersAPI } from './users.js';
 import { WebIntegrationsAPI } from './web-integrations.js';
 import { WebNotificationsAPI } from './web-notifications.js';
 import { WebhooksAPI } from './webhooks.js';
-import './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 declare const apiKeys: ApiKeysAPI;
 declare const apps: AppsAPI;

package/index.js

@@ -1,14 +1,14 @@
 import {
   qix_default
-} from "./chunks/JBH4H34J.js";
+} from "./chunks/KKAWWYOT.js";
 import {
   auth_default
-} from "./chunks/AVML2WPM.js";
+} from "./chunks/J6G5ZOKI.js";
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/BOJLTXK6.js";
+import "./chunks/VISO65GO.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/public-runtime-api-generator/public-runtime-api-generator.ts