@qlik/api 1.1.0 → 1.2.0

package/api-keys.d.ts

@@ -16,10 +16,10 @@ type ApiKey = {
     readonly lastUpdated?: string;
     /** The status of the API key. */
     status: "active" | "expired" | "revoked";
-    /** The ID of the subject for the API key. */
+    /** The ID of the subject for the API key. For SCIM the format is `SCIM\\{{IDP-ID}}`, where `{{IDP-ID}}` is the ID of the IDP in Qlik. */
     sub: string;
-    /** Type of the subject. */
-    subType: "user";
+    /** Type of the subject. For SCIM, it should be `externalClient`. */
+    subType: "user" | "externalClient";
     /** The tenant ID. */
     tenantId: string;
 };
@@ -28,10 +28,10 @@ type ApiKeyBody = {
     description: string;
     /** The expiry of the API key, in ISO8601 duration format. */
     expiry?: string;
-    /** The ID of the subject for the API key. */
+    /** The ID of the subject for the API key. For SCIM the format is `SCIM\\{{IDP-ID}}`, where `{{IDP-ID}}` is the ID of the IDP in Qlik. */
     sub?: string;
-    /** Type of the subject. */
-    subType?: string;
+    /** Type of the subject. For SCIM, it should be `externalClient`. */
+    subType?: "user" | "externalClient";
 };
 /**
  * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.

package/apps.d.ts

@@ -1780,13 +1780,10 @@ type GetAppReloadMetadataHttpError = {
  */
 declare const getAppReportFilters: (appId: string, query: {
     /** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive.
-     * The following fields support the `co` (contains) operator: `name` , `description`
+     * The following fields support the `co` (contains) operator: `name`, `description`
      * The following fields support the `eq` (equals) operator: `ownerId`
-     * ```
      * Example:
-     * ```
-     * (name co "query1" or description co "query2") and ownerId eq "123"
-     * ``` */
+     * (name co "query1" or description co "query2") and ownerId eq "123" */
     filter?: string;
     /** The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark. */
     filterTypes?: ("REP" | "SUB")[];
@@ -1794,6 +1791,7 @@ declare const getAppReportFilters: (appId: string, query: {
     limit?: number;
     /** If present, the cursor that starts the page of data that is returned. */
     page?: string;
+    /** Sorting parameters. */
     sort?: ("+ownerId" | "-ownerId" | "-name" | "+name" | "+description" | "-description" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt")[];
 }, options?: ApiCallOptions) => Promise<GetAppReportFiltersHttpResponse>;
 type GetAppReportFiltersHttpResponse = {

package/collections.d.ts

@@ -240,31 +240,31 @@ type Meta = {
  */
 declare const getCollections: (query: {
     /** The case-sensitive string used to search for a resource by creatorId. */
-    creatorId?: string | undefined;
+    creatorId?: string;
     /** The collection's unique identifier. */
-    id?: string | undefined;
+    id?: string;
     /** Includes the list of items belonging to the collections. Supported parameters are 'limit', 'sort' and 'resourceType'. Supported formats are json formatted string or deep object style using square brackets. */
-    includeItems?: string | undefined;
+    includeItems?: string;
     /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
-    limit?: number | undefined;
+    limit?: number;
     /** The case-sensitive string used to search for a collection by name. */
-    name?: string | undefined;
+    name?: string;
     /** The cursor to the next page of resources. Provide either the
      * next or prev cursor, but not both. */
-    next?: string | undefined;
+    next?: string;
     /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
-    prev?: string | undefined;
+    prev?: string;
     /** The case-insensitive string used to search for a resource by name or description. */
-    query?: string | undefined;
+    query?: string;
     /** 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. */
-    sort?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;
+    sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
     /** The case-sensitive string used to filter for a collection by type. */
-    type?: CollectionTypes | undefined;
+    type?: CollectionTypes;
     /** A commaseparated case-sensitive string used to filter by multiple types. */
-    types?: CollectionTypes[] | undefined;
+    types?: CollectionTypes[];
 }, options?: ApiCallOptions) => Promise<GetCollectionsHttpResponse>;
 type GetCollectionsHttpResponse = {
     data: CollectionsListCollectionsResponseBody;
@@ -391,30 +391,30 @@ type UpdateCollectionHttpError = {
  */
 declare const getCollectionItems: (collectionId: string, query: {
     /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
-    limit?: number | undefined;
+    limit?: number;
     /** The case-insensitive string used to search for a resource by name. */
-    name?: string | undefined;
+    name?: string;
     /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
-    next?: string | undefined;
+    next?: string;
     /** 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). */
-    noActions?: boolean | undefined;
+    noActions?: boolean;
     /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
-    prev?: string | undefined;
+    prev?: string;
     /** The case-insensitive string used to search for a resource by name or description. */
-    query?: string | undefined;
+    query?: string;
     /** The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
-    resourceId?: string | undefined;
+    resourceId?: string;
     /** The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
-    resourceLink?: string | undefined;
+    resourceLink?: string;
     /** The case-sensitive string used to search for an item by resourceType. */
-    resourceType?: ItemResourceTypeEnum | undefined;
+    resourceType?: ItemResourceTypeEnum;
     /** @deprecated
      * Whether or not to return items in a shared space. */
-    shared?: boolean | undefined;
+    shared?: boolean;
     /** 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. */
-    sort?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;
+    sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
     /** The space's unique identifier (supports \'personal\' as spaceId). */
-    spaceId?: string | undefined;
+    spaceId?: string;
 }, options?: ApiCallOptions) => Promise<GetCollectionItemsHttpResponse>;
 type GetCollectionItemsHttpResponse = {
     data: CollectionsListCollectionItemsResponseBody;

package/items.d.ts

@@ -253,48 +253,48 @@ type SpaceTypeEnum = "shared" | "managed" | "personal" | "data";
  */
 declare const getItems: (query: {
     /** The collection's unique identifier. */
-    collectionId?: string | undefined;
+    collectionId?: string;
     /** User's unique identifier. */
-    createdByUserId?: string | undefined;
+    createdByUserId?: string;
     /** The item's unique identifier. */
-    id?: string | undefined;
+    id?: string;
     /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
-    limit?: number | undefined;
+    limit?: number;
     /** The case-insensitive string used to search for a resource by name. */
-    name?: string | undefined;
+    name?: string;
     /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
-    next?: string | undefined;
+    next?: string;
     /** 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). */
-    noActions?: boolean | undefined;
+    noActions?: boolean;
     /** User's unique identifier. */
-    notCreatedByUserId?: string | undefined;
+    notCreatedByUserId?: string;
     /** Owner identifier. */
-    notOwnerId?: string | undefined;
+    notOwnerId?: string;
     /** Owner identifier. */
-    ownerId?: string | undefined;
+    ownerId?: string;
     /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
-    prev?: string | undefined;
+    prev?: string;
     /** The case-insensitive string used to search for a resource by name or description. */
-    query?: string | undefined;
+    query?: string;
     /** The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
-    resourceId?: string | undefined;
+    resourceId?: string;
     /** The case-sensitive strings used to search for an item by resourceIds. The maximum number of resourceIds it supports is 100. If resourceIds is provided, then resourceType must be provided. For example '?resourceIds=appId1,appId2' */
-    resourceIds?: string | undefined;
+    resourceIds?: string;
     /** The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both. */
-    resourceLink?: string | undefined;
+    resourceLink?: string;
     /** the case-sensitive string used to filter items by resourceSubType(s). For example '?resourceSubType=chart-monitoring,qix-df,qvd'. Will return a 400 error if used in conjuction with the square bracket syntax for resourceSubType filtering in the 'resourceType' query parameter. */
-    resourceSubType?: string | undefined;
+    resourceSubType?: string;
     /** The case-sensitive string used to filter items by resourceType(s). For example '?resourceType=app,qvapp'. Additionally, a optional resourceSubType filter can be added to each resourceType. For example '?resourceType=app[qvd,chart-monitoring],qvapp'. An trailing comma can be used to include the empty resourceSubType, e.g. '?resourceType=app[qvd,chart-monitoring,]', or, to include only empty resourceSubTypes, '?resourceType=app[]' This syntax replaces the 'resourceSubType' query param, and using both in the same query will result in a 400 error. */
-    resourceType?: ItemResourceTypeEnum | undefined;
+    resourceType?: ItemResourceTypeEnum;
     /** @deprecated
      * Whether or not to return items in a shared space. */
-    shared?: boolean | undefined;
+    shared?: boolean;
     /** 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. */
-    sort?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;
+    sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
     /** The space's unique identifier (supports \'personal\' as spaceId). */
-    spaceId?: string | undefined;
+    spaceId?: string;
     /** The case-sensitive string used to filter items on space type(s). For example '?spaceType=shared,personal'. */
-    spaceType?: SpaceTypeEnum | undefined;
+    spaceType?: SpaceTypeEnum;
 }, options?: ApiCallOptions) => Promise<GetItemsHttpResponse>;
 type GetItemsHttpResponse = {
     data: ItemsListItemsResponseBody;
@@ -402,19 +402,19 @@ type UpdateItemHttpError = {
  */
 declare const getItemCollections: (itemId: string, query: {
     /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
-    limit?: number | undefined;
+    limit?: number;
     /** The case-sensitive string used to search for a collection by name. */
-    name?: string | undefined;
+    name?: string;
     /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
-    next?: string | undefined;
+    next?: string;
     /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
-    prev?: string | undefined;
+    prev?: string;
     /** The case-insensitive string used to search for a resource by name or description. */
-    query?: string | undefined;
+    query?: string;
     /** 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. */
-    sort?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;
+    sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
     /** The case-sensitive string used to search for a collection by type. */
-    type?: CollectionTypes | undefined;
+    type?: CollectionTypes;
 }, options?: ApiCallOptions) => Promise<GetItemCollectionsHttpResponse>;
 type GetItemCollectionsHttpResponse = {
     data: ItemsListItemCollectionsResponseBody;

package/package.json

@@ -58,5 +58,5 @@
     "./qix": "./qix.js",
     "./auth": "./auth.js"
   },
-  "version": "1.1.0"
+  "version": "1.2.0"
 }

package/qix.d.ts

@@ -1,7 +1,7 @@
 import './global.types-CMQsAHYd.js';
 import { H as HostConfig } from './auth-types-Bqw3vbLs.js';
 
-declare const QIX_SCHEMA_VERSION = "12.2030.0";
+declare const QIX_SCHEMA_VERSION = "12.2038.0";
 type AlfaNumString = {
     /**
      * Calculated value.
@@ -3088,9 +3088,13 @@ type NxBookmark = {
      */
     qPatches?: NxPatches[];
     /**
-     * Information about cyclic groups.
+     * Information about cyclic groups by zero-based index. This field is unused.
      */
     qCyclicGroupStates?: CyclicGroupPosition[];
+    /**
+     * Information about cyclic groups indexed by field definition.
+     */
+    qGroupStates?: GroupState[];
 };
 type NxCalcCond = {
     /**

package/spaces.d.ts

@@ -365,7 +365,7 @@ declare const getSpaceAssignments: (spaceId: string, query: {
     next?: string;
     /** The previous page cursor. Previous links make use of this. */
     prev?: string;
-    /** The type of assignment. */
+    /** The type of assignment. Supported values are user or group. */
     type?: AssignmentType;
 }, options?: ApiCallOptions) => Promise<GetSpaceAssignmentsHttpResponse>;
 type GetSpaceAssignmentsHttpResponse = {

package/webhooks.d.ts

@@ -70,6 +70,8 @@ type Link = {
     href: string;
 };
 type WebhookBase = {
+    /** If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook. */
+    checkCertificateRevocation?: boolean;
     /** The UTC timestamp when the webhook was created */
     readonly createdAt?: string;
     /** The id of the user that created the webhook */