@qlik/api 0.0.9 → 0.0.10

package/themes.d.ts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
+/**
+ * An error object.
+ */
 type Error = {
     /** Object containing meta data regarding an error. It does not necessarily contain all the properties. */
     meta?: Meta;
@@ -11,6 +14,9 @@ type Error = {
     /** Title of the HTTP status code. */
     title: string;
 };
+/**
+ * Object containing meta data regarding an error. It does not necessarily contain all the properties.
+ */
 type Meta = {
     /** A more detailed message explaining the error. */
     message?: string;
@@ -19,6 +25,9 @@ type Meta = {
     /** Full stack trace of the error that was raised. */
     stack?: string;
 };
+/**
+ * The theme model.
+ */
 type Theme = {
     /** Author of the theme. */
     author?: string;

package/themes.js

@@ -1,36 +1,36 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _EL2GSPZZjs = require('./chunks/EL2GSPZZ.js');
-require('./chunks/W2I5OQA5.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/themes.ts
-var getThemes = async (options) => _EL2GSPZZjs.invokeFetch.call(void 0, "themes", {
+var getThemes = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "themes", {
   method: "get",
   pathTemplate: "/api/v1/themes",
   options
 });
-var uploadTheme = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "themes", {
+var uploadTheme = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "themes", {
   method: "post",
   pathTemplate: "/api/v1/themes",
   body,
   contentType: "multipart/form-data",
   options
 });
-var deleteTheme = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "themes", {
+var deleteTheme = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "themes", {
   method: "delete",
   pathTemplate: "/api/v1/themes/{id}",
   pathVariables: { id },
   options
 });
-var getTheme = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "themes", {
+var getTheme = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "themes", {
   method: "get",
   pathTemplate: "/api/v1/themes/{id}",
   pathVariables: { id },
   options
 });
-var patchTheme = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "themes", {
+var patchTheme = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "themes", {
   method: "patch",
   pathTemplate: "/api/v1/themes/{id}",
   pathVariables: { id },
@@ -38,20 +38,20 @@ var patchTheme = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(void
   contentType: "multipart/form-data",
   options
 });
-var downloadTheme = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "themes", {
+var downloadTheme = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "themes", {
   method: "get",
   pathTemplate: "/api/v1/themes/{id}/file",
   pathVariables: { id },
   options
 });
-var downloadFileFromTheme = async (id, filepath, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "themes", {
+var downloadFileFromTheme = async (id, filepath, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "themes", {
   method: "get",
   pathTemplate: "/api/v1/themes/{id}/file/{filepath}",
   pathVariables: { id, filepath },
   options
 });
 function clearCache() {
-  return _EL2GSPZZjs.clearApiCache.call(void 0, "themes");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "themes");
 }
 var themesExport = {
   getThemes,

package/themes.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/POR3DZIU.mjs";
-import "./chunks/VLLTA4EY.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/themes.ts

package/transports.d.mts

@@ -9,6 +9,9 @@ type DeleteConfigNotFoundError = {
         title: string;
     }[];
 };
+/**
+ * An error object.
+ */
 type ErrorPublic = {
     /** The error code. */
     code: string;
@@ -58,6 +61,9 @@ type Email = {
     /** email subject */
     subject?: string;
 };
+/**
+ * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
+ */
 type EmailConfigFieldPatch = {
     /** The operation to be performed. */
     op: "replace, remove, add";
@@ -95,6 +101,9 @@ type SmtpCheck = {
     /** true if smtp config is correct and complete. Will return false if smtp-config does not exist at all */
     isValid?: boolean;
 };
+/**
+ * Contains statusCode and statusReason
+ */
 type SmtpConfigStatus = {
     /** Status code */
     statusCode?: number;

package/transports.d.ts

@@ -9,6 +9,9 @@ type DeleteConfigNotFoundError = {
         title: string;
     }[];
 };
+/**
+ * An error object.
+ */
 type ErrorPublic = {
     /** The error code. */
     code: string;
@@ -58,6 +61,9 @@ type Email = {
     /** email subject */
     subject?: string;
 };
+/**
+ * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
+ */
 type EmailConfigFieldPatch = {
     /** The operation to be performed. */
     op: "replace, remove, add";
@@ -95,6 +101,9 @@ type SmtpCheck = {
     /** true if smtp config is correct and complete. Will return false if smtp-config does not exist at all */
     isValid?: boolean;
 };
+/**
+ * Contains statusCode and statusReason
+ */
 type SmtpConfigStatus = {
     /** Status code */
     statusCode?: number;

package/transports.js

@@ -1,47 +1,47 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _EL2GSPZZjs = require('./chunks/EL2GSPZZ.js');
-require('./chunks/W2I5OQA5.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/transports.ts
-var deleteEmailConfig = async (options) => _EL2GSPZZjs.invokeFetch.call(void 0, "transports", {
+var deleteEmailConfig = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "transports", {
   method: "delete",
   pathTemplate: "/api/v1/transports/email-config",
   options
 });
-var getEmailConfig = async (options) => _EL2GSPZZjs.invokeFetch.call(void 0, "transports", {
+var getEmailConfig = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "transports", {
   method: "get",
   pathTemplate: "/api/v1/transports/email-config",
   options
 });
-var patchEmailConfig = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "transports", {
+var patchEmailConfig = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "transports", {
   method: "patch",
   pathTemplate: "/api/v1/transports/email-config",
   body,
   contentType: "application/json",
   options
 });
-var sendTestEmail = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "transports", {
+var sendTestEmail = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "transports", {
   method: "post",
   pathTemplate: "/api/v1/transports/email-config/actions/send-test-email",
   body,
   contentType: "application/json",
   options
 });
-var validateEmailConfig = async (options) => _EL2GSPZZjs.invokeFetch.call(void 0, "transports", {
+var validateEmailConfig = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "transports", {
   method: "post",
   pathTemplate: "/api/v1/transports/email-config/actions/validate",
   options
 });
-var verifyEmailConfigConnection = async (options) => _EL2GSPZZjs.invokeFetch.call(void 0, "transports", {
+var verifyEmailConfigConnection = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "transports", {
   method: "post",
   pathTemplate: "/api/v1/transports/email-config/actions/verify-connection",
   options
 });
 function clearCache() {
-  return _EL2GSPZZjs.clearApiCache.call(void 0, "transports");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "transports");
 }
 var transportsExport = {
   deleteEmailConfig,

package/transports.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/POR3DZIU.mjs";
-import "./chunks/VLLTA4EY.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/transports.ts

package/users.d.mts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * An array of group references.
+ */
 type AssignedGroups = {
     /** An array of role references. */
     assignedRoles?: AssignedRoles;
@@ -9,6 +12,9 @@ type AssignedGroups = {
     /** The group name */
     readonly name: string;
 }[];
+/**
+ * An array of role references.
+ */
 type AssignedRoles = {
     /** The unique role identitier */
     id: string;
@@ -21,15 +27,27 @@ type AssignedRoles = {
     /** The type of role */
     readonly type: "default";
 }[];
+/**
+ * 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
+ */
 type AssignedScopes = string[];
+/**
+ * An error object describing the error.
+ */
 type Error = {
     /** The error code. */
     code: string;
@@ -49,6 +67,9 @@ type Error = {
     /** Summary of the problem. */
     title: string;
 };
+/**
+ * Error object.
+ */
 type ErrorItem = {
     /** Error code */
     code: number;
@@ -57,6 +78,9 @@ type ErrorItem = {
     /** Summary of the problem */
     title: string;
 };
+/**
+ * The error response object describing the error from the handling of an HTTP request.
+ */
 type Errors = {
     /** An array of errors related to the operation. */
     errors?: Error[];
@@ -66,13 +90,22 @@ type Errors = {
 type ErrorsResponse = {
     errors?: ErrorItem[];
 };
+/**
+ * An advanced query filter to be used for complex user querying in the tenant.
+ */
 type Filter = {
     /** The advanced filtering to be applied the query. All conditional statements within this query parameter are case insensitive. */
     filter?: string;
 };
+/**
+ * Data list - ResultItem or ErrorItem for each InviteeItem.
+ */
 type InviteDataResponse = {
     data?: (ResultItem | InviteErrorItem)[];
 };
+/**
+ * Error object.
+ */
 type InviteErrorItem = ErrorItem & {
     /** Error code - | HTTP Status code | 1001 - Active User | 1002 - Disabled User | 1003 - Default External Dependency Error | */
     code?: string;
@@ -95,6 +128,9 @@ type InviteRequestData = {
     /** List of invitees who should receive an invite email. */
     invitees?: InviteItem[];
 };
+/**
+ * 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";
@@ -103,11 +139,22 @@ type JSONPatch = {
     /** The value to be used for this operation. */
     value: string | boolean | unknown[] | AssignedRolesRefIDs | AssignedRolesRefNames;
 };
+/**
+ * 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
+ */
 type ResultItem = {
     /** Email specified for this invitee */
     email: string;
@@ -118,6 +165,9 @@ type ResultItem = {
     /** UserId for this invitee */
     userId: string;
 };
+/**
+ * A user object.
+ */
 type User = {
     /** An array of group references. */
     assignedGroups?: AssignedGroups;
@@ -125,7 +175,8 @@ type User = {
     assignedRoles?: AssignedRoles;
     /** An array of scopes assigned to user */
     readonly assignedScopes?: AssignedScopes;
-    /** Deprecated. Use `createdAt` instead. */
+    /** @deprecated
+     * Deprecated. Use `createdAt` instead. */
     readonly created?: string;
     /** The timestamp for when the user record was created. */
     readonly createdAt?: string;
@@ -135,7 +186,8 @@ type User = {
     readonly id: string;
     /** The number of seconds until the user invitation will expire. */
     readonly inviteExpiry?: number;
-    /** Deprecated. Use `lastUpdatedAt` instead. */
+    /** @deprecated
+     * Deprecated. Use `lastUpdatedAt` instead. */
     readonly lastUpdated?: string;
     /** The timestamp for when the user record was last updated. */
     readonly lastUpdatedAt?: string;
@@ -157,7 +209,8 @@ type User = {
     preferredLocale?: string;
     /** Represents the end-user's preferred time zone. */
     preferredZoneinfo?: string;
-    /** List of system roles to which the user has been assigned. Only returned when permitted by access control. Deprecated. Use `assignedRoles` instead. */
+    /** @deprecated
+     * 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";
@@ -168,6 +221,9 @@ type User = {
     /** Represents the end-user's time zone. */
     zoneinfo?: string;
 };
+/**
+ * The result object for the user count.
+ */
 type UserCount = {
     /** The total number of users in the tenant. */
     total: number;
@@ -181,7 +237,8 @@ type UserPostSchema = {
     name?: string;
     /** A static url linking to the avatar of the user. */
     picture?: string;
-    /** List of system roles to which the user has been assigned. Only returned when permitted by access control. */
+    /** @deprecated
+     * List of system roles to which the user has been assigned. Only returned when permitted by access control. */
     roles?: ("TenantAdmin" | "Developer" | "AnalyticsAdmin" | "DataAdmin" | "DataSpaceCreator" | "ManagedSpaceCreator" | "SharedSpaceCreator")[];
     /** The status of the created user within the tenant. */
     status?: "invited";
@@ -219,9 +276,11 @@ type Users = {
  * @throws GetUsersHttpError
  */
 declare const getUsers: (query: {
-    /** The email to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
+    /** @deprecated
+     * The email to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
     email?: string;
-    /** Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with startingAfter. Deprecated. Use `prev` instead. */
+    /** @deprecated
+     * Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with startingAfter. Deprecated. Use `prev` instead. */
     endingBefore?: string;
     /** A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted. */
     fields?: string;
@@ -261,21 +320,28 @@ declare const getUsers: (query: {
     next?: string;
     /** Get users that come before this cursor value when sorted. Cannot be used in conjunction with `next`. */
     prev?: string;
-    /** The role to filter by. Deprecated. */
+    /** @deprecated
+     * The role to filter by. Deprecated. */
     role?: string;
     /** The field to sort by, with +/- prefix indicating sort order */
     sort?: "name" | "+name" | "-name";
-    /** The user parameter to sort by. Deprecated. Use `sort` instead. */
+    /** @deprecated
+     * The user parameter to sort by. Deprecated. Use `sort` instead. */
     sortBy?: "name";
-    /** The sort order, either ascending or descending. Deprecated. Use `sort` instead. */
+    /** @deprecated
+     * The sort order, either ascending or descending. Deprecated. Use `sort` instead. */
     sortOrder?: "asc" | "desc";
-    /** Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with endingBefore. Deprecated. Use `next` instead. */
+    /** @deprecated
+     * Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with endingBefore. Deprecated. Use `next` instead. */
     startingAfter?: string;
-    /** The status to filter by. Supports multiple values delimited by commas. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
+    /** @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";
-    /** The subject to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
+    /** @deprecated
+     * The subject to filter by. Deprecated. Use the new `filter` parameter to provide an advanced query filter. */
     subject?: string;
-    /** The tenant ID to filter by. Deprecated. */
+    /** @deprecated
+     * The tenant ID to filter by. Deprecated. */
     tenantId?: string;
     /** Whether to return a total match count in the result. Defaults to false. It will trigger an extra DB query to count, reducing the efficiency of the endpoint. */
     totalResults?: boolean;
@@ -316,7 +382,8 @@ type CreateUserHttpError = {
  * @throws CountUsersHttpError
  */
 declare const countUsers: (query: {
-    /** The tenant ID to filter by. */
+    /** @deprecated
+     * The tenant ID to filter by. */
     tenantId?: string;
 }, options?: ApiCallOptions) => Promise<CountUsersHttpResponse>;
 type CountUsersHttpResponse = {
@@ -394,6 +461,8 @@ type GetMyUserHttpError = {
     status: number;
 };
 /**
+ * @deprecated
+ *
  * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
  *
  * @throws GetUsersMetadataHttpError
@@ -519,6 +588,8 @@ interface UsersAPI {
      */
     getMyUser: typeof getMyUser;
     /**
+     * @deprecated
+     *
      * Returns the metadata with regard to the user configuration. Deprecated, use GET /v1/roles instead.
      *
      * @throws GetUsersMetadataHttpError