@qlik/api 1.23.0 → 1.24.0

package/roles.d.ts

@@ -1,6 +1,14 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
+type CreateRole = {
+    /** Selection of scopes to assign to role */
+    assignedScopes?: string[];
+    /** Role description */
+    description?: string;
+    /** Role name, needs to be unique */
+    name: string;
+};
 /**
  * An error object describing the error.
  */
@@ -55,6 +63,18 @@ type ListRolesResult = {
     /** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
     totalResults?: number;
 };
+/**
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
+ */
+type PatchRole = {
+    op: "replace";
+    path: "/name" | "/description" | "/assignedScopes";
+    value: string | string[];
+};
+/**
+ * An array of JSON Patch documents
+ */
+type PatchRoles = PatchRole[];
 type Role = {
     /** Selection of scopes added to this Role */
     assignedScopes?: string[];
@@ -129,10 +149,44 @@ type GetRolesHttpError = {
     headers: Headers;
     status: number;
 };
+/**
+ * Creates a custom role. Role names must be unique, and there is a maximum of 500 custom roles per tenant. Requestor must be assigned the `TenantAdmin` role.
+ *
+ * @param body an object with the body content
+ * @throws CreateRoleHttpError
+ */
+declare const createRole: (body: CreateRole, options?: ApiCallOptions) => Promise<CreateRoleHttpResponse>;
+type CreateRoleHttpResponse = {
+    data: Role;
+    headers: Headers;
+    status: number;
+};
+type CreateRoleHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Deletes the requested role. Role can only be deleted if it has been unassigned from all users and groups. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
+ *
+ * @param id The unique identifier for the role.
+ * @throws DeleteRoleHttpError
+ */
+declare const deleteRole: (id: string, options?: ApiCallOptions) => Promise<DeleteRoleHttpResponse>;
+type DeleteRoleHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: number;
+};
+type DeleteRoleHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
 /**
  * Returns the requested role.
  *
- * @param id The role's unique identifier
+ * @param id The unique identifier for the role.
  * @throws GetRoleHttpError
  */
 declare const getRole: (id: string, options?: ApiCallOptions) => Promise<GetRoleHttpResponse>;
@@ -146,6 +200,24 @@ type GetRoleHttpError = {
     headers: Headers;
     status: number;
 };
+/**
+ * Updates the requested role. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
+ *
+ * @param id The unique identifier for the role.
+ * @param body an object with the body content
+ * @throws PatchRoleHttpError
+ */
+declare const patchRole: (id: string, body: PatchRoles[], options?: ApiCallOptions) => Promise<PatchRoleHttpResponse>;
+type PatchRoleHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: number;
+};
+type PatchRoleHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
 /**
  * Clears the cache for roles api requests.
  */
@@ -158,13 +230,35 @@ interface RolesAPI {
      * @throws GetRolesHttpError
      */
     getRoles: typeof getRoles;
+    /**
+     * Creates a custom role. Role names must be unique, and there is a maximum of 500 custom roles per tenant. Requestor must be assigned the `TenantAdmin` role.
+     *
+     * @param body an object with the body content
+     * @throws CreateRoleHttpError
+     */
+    createRole: typeof createRole;
+    /**
+     * Deletes the requested role. Role can only be deleted if it has been unassigned from all users and groups. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
+     *
+     * @param id The unique identifier for the role.
+     * @throws DeleteRoleHttpError
+     */
+    deleteRole: typeof deleteRole;
     /**
      * Returns the requested role.
      *
-     * @param id The role's unique identifier
+     * @param id The unique identifier for the role.
      * @throws GetRoleHttpError
      */
     getRole: typeof getRole;
+    /**
+     * Updates the requested role. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
+     *
+     * @param id The unique identifier for the role.
+     * @param body an object with the body content
+     * @throws PatchRoleHttpError
+     */
+    patchRole: typeof patchRole;
     /**
      * Clears the cache for roles api requests.
      */
@@ -175,4 +269,4 @@ interface RolesAPI {
  */
 declare const rolesExport: RolesAPI;
 
-export { type Error, type Errors, type GetRoleHttpError, type GetRoleHttpResponse, type GetRolesHttpError, type GetRolesHttpResponse, type Links, type ListRolesResult, type Role, type RolesAPI, clearCache, rolesExport as default, getRole, getRoles };
+export { type CreateRole, type CreateRoleHttpError, type CreateRoleHttpResponse, type DeleteRoleHttpError, type DeleteRoleHttpResponse, type Error, type Errors, type GetRoleHttpError, type GetRoleHttpResponse, type GetRolesHttpError, type GetRolesHttpResponse, type Links, type ListRolesResult, type PatchRole, type PatchRoleHttpError, type PatchRoleHttpResponse, type PatchRoles, type Role, type RolesAPI, clearCache, createRole, rolesExport as default, deleteRole, getRole, getRoles, patchRole };

package/roles.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/roles.ts
@@ -12,20 +12,44 @@ var getRoles = async (query, options) => invokeFetch("roles", {
   query,
   options
 });
+var createRole = async (body, options) => invokeFetch("roles", {
+  method: "post",
+  pathTemplate: "/api/v1/roles",
+  body,
+  contentType: "application/json",
+  options
+});
+var deleteRole = async (id, options) => invokeFetch("roles", {
+  method: "delete",
+  pathTemplate: "/api/v1/roles/{id}",
+  pathVariables: { id },
+  options
+});
 var getRole = async (id, options) => invokeFetch("roles", {
   method: "get",
   pathTemplate: "/api/v1/roles/{id}",
   pathVariables: { id },
   options
 });
+var patchRole = async (id, body, options) => invokeFetch("roles", {
+  method: "patch",
+  pathTemplate: "/api/v1/roles/{id}",
+  pathVariables: { id },
+  body,
+  contentType: "application/json",
+  options
+});
 function clearCache() {
   return clearApiCache("roles");
 }
-var rolesExport = { getRoles, getRole, clearCache };
+var rolesExport = { getRoles, createRole, deleteRole, getRole, patchRole, clearCache };
 var roles_default = rolesExport;
 export {
   clearCache,
+  createRole,
   roles_default as default,
+  deleteRole,
   getRole,
-  getRoles
+  getRoles,
+  patchRole
 };

package/spaces.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 /**

package/spaces.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/spaces.ts

package/temp-contents.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 /**
@@ -48,7 +48,7 @@ type DetailResponse = {
     UpdatedAt?: string;
 };
 /**
- * This endpoint is used to upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
+ * Upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
  *
  * @param query an object with query parameters
  * @param body an object with the body content
@@ -104,7 +104,7 @@ type DownloadTempFileHttpError = {
     status: number;
 };
 /**
- * This endpoint is used to retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
+ * Retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
  *
  * @param id The temporary contents ID.
  * @throws GetTempFileDetailsHttpError
@@ -132,7 +132,7 @@ type GetTempFileDetailsHttpError = {
 declare function clearCache(): void;
 interface TempContentsAPI {
     /**
-     * This endpoint is used to upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
+     * Upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
      *
      * @param query an object with query parameters
      * @param body an object with the body content
@@ -148,7 +148,7 @@ interface TempContentsAPI {
      */
     downloadTempFile: typeof downloadTempFile;
     /**
-     * This endpoint is used to retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
+     * Retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
      *
      * @param id The temporary contents ID.
      * @throws GetTempFileDetailsHttpError

package/temp-contents.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/temp-contents.ts

package/tenants.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 /**

package/tenants.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/tenants.ts

package/themes.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 /**

package/themes.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/themes.ts

package/transports.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 type DeleteConfigNotFoundError = {

package/transports.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/transports.ts

package/users.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 /**
@@ -143,15 +143,6 @@ type JSONPatch = {
  * An array of JSON Patch documents
  */
 type JSONPatchArray = JSONPatch[];
-/**
- * @deprecated
- *
- * An object containing the metadata for the user configuration.
- */
-type Metadata = {
-    /** List of system roles to which the user can be assigned. */
-    valid_roles?: string[];
-};
 /**
  * Invitee result item
  */
@@ -184,7 +175,7 @@ type User = {
     email?: string;
     /** The unique user identifier. */
     readonly id: string;
-    /** The number of seconds until the user invitation will expire. */
+    /** The Unix timestamp indicating when the invite will expire. */
     readonly inviteExpiry?: number;
     /** @deprecated
      * Deprecated. Use `lastUpdatedAt` instead. */
@@ -460,24 +451,6 @@ type GetMyUserHttpError = {
     headers: Headers;
     status: number;
 };
-/**
- * @deprecated
- *
- * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
- *
- * @throws GetUsersMetadataHttpError
- */
-declare const getUsersMetadata: (options?: ApiCallOptions) => Promise<GetUsersMetadataHttpResponse>;
-type GetUsersMetadataHttpResponse = {
-    data: Metadata;
-    headers: Headers;
-    status: number;
-};
-type GetUsersMetadataHttpError = {
-    data: Errors;
-    headers: Headers;
-    status: number;
-};
 /**
  * Deletes the requested user.
  *
@@ -587,14 +560,6 @@ interface UsersAPI {
      * @throws GetMyUserHttpError
      */
     getMyUser: typeof getMyUser;
-    /**
-     * @deprecated
-     *
-     * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
-     *
-     * @throws GetUsersMetadataHttpError
-     */
-    getUsersMetadata: typeof getUsersMetadata;
     /**
      * Deletes the requested user.
      *
@@ -628,4 +593,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 GetUsersMetadataHttpError, type GetUsersMetadataHttpResponse, type InviteDataResponse, type InviteErrorItem, type InviteItem, type InviteRequestData, type InviteUsersHttpError, type InviteUsersHttpResponse, type JSONPatch, type JSONPatchArray, type Metadata, 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, getUsersMetadata, inviteUsers, patchUser };
+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 };

package/users.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/users.ts
@@ -45,11 +45,6 @@ var getMyUser = async (options) => invokeFetch("users", {
   pathTemplate: "/api/v1/users/me",
   options
 });
-var getUsersMetadata = async (options) => invokeFetch("users", {
-  method: "get",
-  pathTemplate: "/api/v1/users/metadata",
-  options
-});
 var deleteUser = async (userId, options) => invokeFetch("users", {
   method: "delete",
   pathTemplate: "/api/v1/users/{userId}",
@@ -81,7 +76,6 @@ var usersExport = {
   filterUsers,
   inviteUsers,
   getMyUser,
-  getUsersMetadata,
   deleteUser,
   getUser,
   patchUser,
@@ -98,7 +92,6 @@ export {
   getMyUser,
   getUser,
   getUsers,
-  getUsersMetadata,
   inviteUsers,
   patchUser
 };

package/web-integrations.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 /**

package/web-integrations.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/web-integrations.ts

package/web-notifications.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 /**

package/web-notifications.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/web-notifications.ts

package/webhooks.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 type Delivery = {

package/webhooks.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/webhooks.ts