@qlik/api 1.24.0 → 1.25.0

package/chunks/UA6BE3VB.js

@@ -6,7 +6,7 @@ import {
 } from "./2ZQ3ZX7F.js";
 
 // src/public/invoke-fetch.ts
-var defaultUserAgent = "qlik-api/1.24.0";
+var defaultUserAgent = "qlik-api/1.25.0";
 async function invokeFetch(api, props) {
   const hostConfig = props.options?.hostConfig;
   let userAgent;

package/groups.d.ts

@@ -108,8 +108,8 @@ type GroupPatch = {
     op: "replace";
     /** Attribute name of a field of the Groups entity. "Name" and "description" is only available for custom groups. */
     path: "assignedRoles" | "name" | "description";
-    /** The roles to assign to the group (limit of 100 roles per group). */
-    value: AssignedRolesRefIDs | AssignedRolesRefNames;
+    /** The roles to assign to the group (limit of 100 roles per group) or the new custom group name or description. */
+    value: AssignedRolesRefIDs | AssignedRolesRefNames | string;
 };
 /**
  * An array of JSON Patches for a group.

package/items.d.ts

@@ -289,8 +289,8 @@ declare const getItems: (query: {
     /** @deprecated
      * Whether or not to return items in a shared space. */
     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?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
+    /** The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, recentlyUsed and name. A property must be prefixed by + or   - to indicate ascending or descending sort order respectively. */
+    sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt" | "+recentlyUsed" | "-recentlyUsed";
     /** The space's unique identifier (supports \'personal\' as spaceId). */
     spaceId?: string;
     /** The case-sensitive string used to filter items on space type(s). For example '?spaceType=shared,personal'. */

package/package.json

@@ -56,5 +56,5 @@
     "./qix": "./qix.js",
     "./auth": "./auth.js"
   },
-  "version": "1.24.0"
+  "version": "1.25.0"
 }

package/qix.d.ts

@@ -1,7 +1,7 @@
 import { H as HostConfig } from './auth-types-PkN9CAF_.js';
 import './invoke-fetch-types-BLrpeZOL.js';
 
-declare const QIX_SCHEMA_VERSION = "12.2241.0";
+declare const QIX_SCHEMA_VERSION = "12.2246.0";
 type AlfaNumString = {
     /**
      * Calculated value.
@@ -10391,6 +10391,22 @@ type NativeGenericObjectFunctions<CustomProperties, CustomLayout, GenericObjectR
      * Stability: *locked*
      */
     selectPivotCells: (path: string, selections: NxSelectionCell[], softLock?: boolean, deselectOnlyOneSelected?: boolean) => Promise<boolean>;
+    /**
+     * You can use the SetActiveField method with any object that contains a cyclic group as a dimension.
+     * This method allows you to jump to a specific field in a cyclic dimension. If NewIndex is out-of-bounds of the dimension's fields then no action is taken.
+     * A hypercube will avoid field collisions with its other dimensions when setting the active field in this manner. If there are any collisions then no action is performed.
+     *
+     * Parameters:
+     *
+     * - `path`       -   Path to the definition of the object to be selected.
+     * For example, _/qHyperCubeDef_ .
+     * - `dimNo`      -   Dimension number or index starting from 0.
+     * The default value is 0.
+     * - `newIndex`   -   Index of the field to jump to.
+     *
+     * Stability: *experimental*
+     */
+    setActiveField: (path: string, dimNo: number, newIndex: number) => Promise<void>;
     /**
      * Sets the order of the children in a generic object.
      * <div class=note>To change the order of the children in a generic object, the identifiers of all the children must be included in the list of the identifiers (in _qIds_ ). </div>
@@ -10428,6 +10444,23 @@ type NativeGenericObjectFunctions<CustomProperties, CustomLayout, GenericObjectR
      * Stability: *locked*
      */
     setProperties: (prop: CustomProperties) => Promise<void>;
+    /**
+     * You can use the StepCycle method with any object that contains a cyclic group as a dimension.
+     * This method allows you to move between different fields in a cyclic dimension.
+     * A hypercube will avoid field collisions with its other dimensions when cycling in this manner. If all other fields cause collisions then no cycling is performed.
+     *
+     * Parameters:
+     *
+     * - `path`       -   Path to the definition of the object to be selected.
+     * For example, _/qHyperCubeDef_ .
+     * - `dimNo`      -   Dimension number or index starting from 0.
+     * The default value is 0.
+     * - `nbrSteps`   -   Number of steps you want to cycle.
+     * Positive values cycle forwards while negative values cycle backwards. A value of 0 leads to no action being taken.
+     *
+     * Stability: *experimental*
+     */
+    stepCycle: (path: string, dimNo: number, nbrSteps: number) => Promise<void>;
     /**
      * Removes the generic object from the list of approved objects
      * <div class=note>This operation is possible only in Qlik Sense Enterprise.</div>

package/spaces.d.ts

@@ -2,9 +2,9 @@ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 /**
- * The supported actions for user-created spaces like Shared or Managed spaces.
+ * The supported actions for user-created spaces.
  */
-type ActionName = "create" | "read" | "update" | "delete" | "publish";
+type ActionName = "change_owner" | "create" | "read" | "update" | "delete" | "publish";
 type Assignment = {
     /** The userId or groupId based on the type. */
     assigneeId: string;
@@ -33,7 +33,7 @@ type Assignment = {
 type AssignmentCreate = {
     /** The userId or groupId based on the type. */
     assigneeId: string;
-    /** The roles assigned to the assigneeId. */
+    /** The roles assigned to the assigneeId. For the full list of roles assignable in this space type, call `GET /spaces/{spaceId}` and inspect the `meta.assignableRoles` object. */
     roles: RoleType[];
     /** The type of assignment such as user or group */
     type: AssignmentType;
@@ -43,7 +43,7 @@ type AssignmentCreate = {
  */
 type AssignmentType = "user" | "group";
 type AssignmentUpdate = {
-    /** The roles assigned to the assigneeId. */
+    /** The roles assigned to the assigneeId. For the full list of roles assignable in this space type, call `GET /spaces/{spaceId}` and inspect the `meta.assignableRoles` object. */
     roles?: RoleType[];
 };
 type Assignments = {
@@ -111,9 +111,9 @@ type Link = {
  * Supported roles by space type:
  * - Shared: codeveloper, consumer, dataconsumer, facilitator, producer
  * - Managed: consumer, contributor, dataconsumer, facilitator, publisher, basicconsumer
- * - Data: consumer, dataconsumer, facilitator, operator, producer, publisher
+ * - Data: consumer, dataconsumer, datapreview, facilitator, operator, producer, publisher
  */
-type RoleType = "consumer" | "contributor" | "dataconsumer" | "facilitator" | "operator" | "producer" | "publisher" | "basicconsumer" | "codeveloper";
+type RoleType = "consumer" | "contributor" | "dataconsumer" | "datapreview" | "facilitator" | "operator" | "producer" | "publisher" | "basicconsumer" | "codeveloper";
 /**
  * The supported roles for Shared spaces.
  */
@@ -249,7 +249,7 @@ type GetSpacesHttpError = {
     status: number;
 };
 /**
- * Creates a space.
+ * Creates a space. Spaces names must be unique. Spaces of type `data` should only be used for Qlik Talend Data Integration projects.
  *
  * @param body an object with the body content
  * @throws CreateSpaceHttpError
@@ -266,7 +266,7 @@ type CreateSpaceHttpError = {
     status: number;
 };
 /**
- * Gets a list of distinct space types.
+ * Gets a list of distinct space types available for use in the tenant.
  *
  * @throws GetSpaceTypesHttpError
  */
@@ -316,7 +316,7 @@ type GetSpaceHttpError = {
     status: number;
 };
 /**
- * Patches (updates) a space (partially).
+ * Updates one or more properties of a space. To update all properties at once, use `PUT /spaces/{spaceId}`.
  *
  * @param spaceId The ID of the space to update.
  * @param body an object with the body content
@@ -334,7 +334,7 @@ type PatchSpaceHttpError = {
     status: number;
 };
 /**
- * Updates a space.
+ * Updates a space. To update specific properties, use `PATCH /spaces/{spaceId}`.
  *
  * @param spaceId The ID of the space to update.
  * @param body an object with the body content
@@ -352,7 +352,7 @@ type UpdateSpaceHttpError = {
     status: number;
 };
 /**
- * Retrieves the assignments of the space matching the query.
+ * Retrieves the assignments of the space matching the query. Each assignment represents one user or group and their corresponding roles in the space. Assignments are not shown for the owner of a space, who receive all `assignableRoles` by default.
  *
  * @param spaceId The ID of the space of the assignment.
  * @param query an object with query parameters
@@ -383,7 +383,7 @@ type GetSpaceAssignmentsHttpError = {
     status: number;
 };
 /**
- * Creates an assignment.
+ * Creates an assignment for a user or group (assignee) to a space with the specified roles. Assignments are not required for space owners, who receive all `assignableRoles` by default. Only one assignment can exist per space, per user or group.
  *
  * @param spaceId The ID of the space of the assignment.
  * @param body an object with the body content
@@ -419,7 +419,7 @@ type DeleteSpaceAssignmentHttpError = {
     status: number;
 };
 /**
- * Retrieves a single assignment by ID.
+ * Retrieves a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID.
  *
  * @param spaceId The ID of the space of the assignment.
  * @param assignmentId The ID of the assignment to retrieve.
@@ -437,7 +437,7 @@ type GetSpaceAssignmentHttpError = {
     status: number;
 };
 /**
- * Updates a single assignment by ID. The complete list of roles must be provided.
+ * Updates a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID. The complete list of roles must be provided.
  *
  * @param spaceId The ID of the space of the assignment.
  * @param assignmentId The ID of the assignment to update.
@@ -468,14 +468,14 @@ interface SpacesAPI {
      */
     getSpaces: typeof getSpaces;
     /**
-     * Creates a space.
+     * Creates a space. Spaces names must be unique. Spaces of type `data` should only be used for Qlik Talend Data Integration projects.
      *
      * @param body an object with the body content
      * @throws CreateSpaceHttpError
      */
     createSpace: typeof createSpace;
     /**
-     * Gets a list of distinct space types.
+     * Gets a list of distinct space types available for use in the tenant.
      *
      * @throws GetSpaceTypesHttpError
      */
@@ -495,7 +495,7 @@ interface SpacesAPI {
      */
     getSpace: typeof getSpace;
     /**
-     * Patches (updates) a space (partially).
+     * Updates one or more properties of a space. To update all properties at once, use `PUT /spaces/{spaceId}`.
      *
      * @param spaceId The ID of the space to update.
      * @param body an object with the body content
@@ -503,7 +503,7 @@ interface SpacesAPI {
      */
     patchSpace: typeof patchSpace;
     /**
-     * Updates a space.
+     * Updates a space. To update specific properties, use `PATCH /spaces/{spaceId}`.
      *
      * @param spaceId The ID of the space to update.
      * @param body an object with the body content
@@ -511,7 +511,7 @@ interface SpacesAPI {
      */
     updateSpace: typeof updateSpace;
     /**
-     * Retrieves the assignments of the space matching the query.
+     * Retrieves the assignments of the space matching the query. Each assignment represents one user or group and their corresponding roles in the space. Assignments are not shown for the owner of a space, who receive all `assignableRoles` by default.
      *
      * @param spaceId The ID of the space of the assignment.
      * @param query an object with query parameters
@@ -519,7 +519,7 @@ interface SpacesAPI {
      */
     getSpaceAssignments: typeof getSpaceAssignments;
     /**
-     * Creates an assignment.
+     * Creates an assignment for a user or group (assignee) to a space with the specified roles. Assignments are not required for space owners, who receive all `assignableRoles` by default. Only one assignment can exist per space, per user or group.
      *
      * @param spaceId The ID of the space of the assignment.
      * @param body an object with the body content
@@ -535,7 +535,7 @@ interface SpacesAPI {
      */
     deleteSpaceAssignment: typeof deleteSpaceAssignment;
     /**
-     * Retrieves a single assignment by ID.
+     * Retrieves a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID.
      *
      * @param spaceId The ID of the space of the assignment.
      * @param assignmentId The ID of the assignment to retrieve.
@@ -543,7 +543,7 @@ interface SpacesAPI {
      */
     getSpaceAssignment: typeof getSpaceAssignment;
     /**
-     * Updates a single assignment by ID. The complete list of roles must be provided.
+     * Updates a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID. The complete list of roles must be provided.
      *
      * @param spaceId The ID of the space of the assignment.
      * @param assignmentId The ID of the assignment to update.

package/users.d.ts

@@ -14,6 +14,15 @@ type AssignedGroups = {
     /** The provider type of the group */
     providerType?: "idp" | "custom";
 }[];
+/**
+ * An array of group reference names and provider type.
+ */
+type AssignedGroupsRefNames = {
+    /** The name of the group */
+    name: string;
+    /** The type of provider for the group. */
+    providerType: "idp" | "custom";
+}[];
 /**
  * An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
  */
@@ -28,21 +37,7 @@ type AssignedRoles = {
     readonly type: "default" | "custom";
 }[];
 /**
- * An array of role reference identifiers.
- */
-type AssignedRolesRefIDs = {
-    /** The unique role identitier */
-    id: string;
-}[];
-/**
- * An array of role reference names.
- */
-type AssignedRolesRefNames = {
-    /** The name of the role */
-    name: string;
-}[];
-/**
- * An array of scopes assigned to user
+ * An array of scopes assigned to a user
  */
 type AssignedScopes = string[];
 /**
@@ -132,17 +127,31 @@ type InviteRequestData = {
  * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
  */
 type JSONPatch = {
-    /** The operation to be performed. */
-    op: "replace" | "set (Deprecated)" | "unset (Deprecated)" | "add (Deprecated)" | "renew";
-    /** A JSON Pointer. */
-    path: "/name" | "/roles (Deprecated)" | "/assignedRoles" | "/inviteExpiry" | "/preferredZoneinfo" | "/preferredLocale" | "/status" | "/assignedGroups";
+    /** The operation to be performed. The fields `set`, `unset`, and `add` are deprecated. */
+    op: "replace" | "set" | "unset" | "add" | "renew";
+    /** A JSON Pointer. The field `roles` is deprecated. */
+    path: "/name" | "/roles" | "/assignedRoles" | "/inviteExpiry" | "/preferredZoneinfo" | "/preferredLocale" | "/status" | "/assignedGroups";
     /** The value to be used for this operation. */
-    value: string | boolean | unknown[] | AssignedRolesRefIDs | AssignedRolesRefNames;
+    value: string | boolean | unknown[] | RefIDs | RefNames | AssignedGroupsRefNames;
 };
 /**
  * An array of JSON Patch documents
  */
 type JSONPatchArray = JSONPatch[];
+/**
+ * An array of entity reference identifiers (e.g. roles, groups).
+ */
+type RefIDs = {
+    /** The unique identitier */
+    id: string;
+}[];
+/**
+ * An array of reference names (e.g. roles).
+ */
+type RefNames = {
+    /** The name of the entity */
+    name: string;
+}[];
 /**
  * Invitee result item
  */
@@ -164,7 +173,7 @@ type User = {
     assignedGroups?: AssignedGroups;
     /** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
     assignedRoles?: AssignedRoles;
-    /** An array of scopes assigned to user */
+    /** An array of scopes assigned to a user */
     readonly assignedScopes?: AssignedScopes;
     /** @deprecated
      * Deprecated. Use `createdAt` instead. */
@@ -204,7 +213,7 @@ type User = {
      * List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use `assignedRoles` instead. */
     roles?: ("TenantAdmin" | "Developer" | "AnalyticsAdmin" | "DataAdmin" | "DataSpaceCreator" | "ManagedSpaceCreator" | "SharedSpaceCreator")[];
     /** The status of the user within the tenant. */
-    status?: "active" | "invited" | "disabled" | "deleted";
+    status?: "active" | "invited" | "disabled" | "deleted" | "provisioned";
     /** The unique user identitier from an identity provider. */
     subject: string;
     /** The tenant that the user belongs too. */
@@ -221,7 +230,7 @@ type UserCount = {
 };
 type UserPostSchema = {
     /** The roles to assign to the user. */
-    assignedRoles?: AssignedRolesRefIDs | AssignedRolesRefNames;
+    assignedRoles?: RefIDs | RefNames;
     /** The email address for the user. This is a required field when inviting a user. */
     email?: string;
     /** The name of the user. */
@@ -259,6 +268,8 @@ type Users = {
             href: string;
         };
     };
+    /** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
+    totalResults?: number;
 };
 /**
  * Returns a list of users using cursor-based pagination.
@@ -315,7 +326,7 @@ declare const getUsers: (query: {
      * The role to filter by. Deprecated. */
     role?: string;
     /** The field to sort by, with +/- prefix indicating sort order */
-    sort?: "name" | "+name" | "-name";
+    sort?: "name" | "+name" | "-name" | "_id" | "+_id" | "-_id" | "id" | "+id" | "-id" | "tenantId" | "+tenantId" | "-tenantId" | "clientId" | "+clientId" | "-clientId" | "status" | "+status" | "-status" | "subject" | "+subject" | "-subject" | "email" | "+email" | "-email" | "inviteExpiry" | "+inviteExpiry" | "-inviteExpiry" | "createdAt" | "+createdAt" | "-createdAt";
     /** @deprecated
      * The user parameter to sort by. Deprecated. Use `sort` instead. */
     sortBy?: "name";
@@ -327,7 +338,7 @@ declare const getUsers: (query: {
     startingAfter?: string;
     /** @deprecated
      * The status to filter by. Supports multiple values delimited by commas. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
-    status?: "active" | "invited" | "disabled" | "deleted";
+    status?: "active" | "invited" | "disabled" | "deleted" | "provisioned";
     /** @deprecated
      * The subject to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
     subject?: string;
@@ -593,4 +604,4 @@ interface UsersAPI {
  */
 declare const usersExport: UsersAPI;
 
-export { type AssignedGroups, type AssignedRoles, type AssignedRolesRefIDs, type AssignedRolesRefNames, type AssignedScopes, type CountUsersHttpError, type CountUsersHttpResponse, type CreateUserHttpError, type CreateUserHttpResponse, type DeleteUserHttpError, type DeleteUserHttpResponse, type Error, type ErrorItem, type Errors, type ErrorsResponse, type Filter, type FilterUsersHttpError, type FilterUsersHttpResponse, type GetMyUserHttpError, type GetMyUserHttpResponse, type GetUserHttpError, type GetUserHttpResponse, type GetUsersHttpError, type GetUsersHttpResponse, type InviteDataResponse, type InviteErrorItem, type InviteItem, type InviteRequestData, type InviteUsersHttpError, type InviteUsersHttpResponse, type JSONPatch, type JSONPatchArray, type PatchUser204HttpResponse, type PatchUser207HttpResponse, type PatchUserHttpError, type PatchUserHttpResponse, type ResultItem, type User, type UserCount, type UserPostSchema, type Users, type UsersAPI, clearCache, countUsers, createUser, usersExport as default, deleteUser, filterUsers, getMyUser, getUser, getUsers, inviteUsers, patchUser };
+export { type AssignedGroups, type AssignedGroupsRefNames, type AssignedRoles, type AssignedScopes, type CountUsersHttpError, type CountUsersHttpResponse, type CreateUserHttpError, type CreateUserHttpResponse, type DeleteUserHttpError, type DeleteUserHttpResponse, type Error, type ErrorItem, type Errors, type ErrorsResponse, type Filter, type FilterUsersHttpError, type FilterUsersHttpResponse, type GetMyUserHttpError, type GetMyUserHttpResponse, type GetUserHttpError, type GetUserHttpResponse, type GetUsersHttpError, type GetUsersHttpResponse, type InviteDataResponse, type InviteErrorItem, type InviteItem, type InviteRequestData, type InviteUsersHttpError, type InviteUsersHttpResponse, type JSONPatch, type JSONPatchArray, type PatchUser204HttpResponse, type PatchUser207HttpResponse, type PatchUserHttpError, type PatchUserHttpResponse, type RefIDs, type RefNames, type ResultItem, type User, type UserCount, type UserPostSchema, type Users, type UsersAPI, clearCache, countUsers, createUser, usersExport as default, deleteUser, filterUsers, getMyUser, getUser, getUsers, inviteUsers, patchUser };