@qlik/api 0.0.9 → 0.0.11

package/spaces.d.mts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * The supported actions for user-created spaces like Shared or Managed spaces.
+ */
 type ActionName = "create" | "read" | "update" | "delete" | "publish";
 type Assignment = {
     /** The userId or groupId based on the type. */
@@ -35,6 +38,9 @@ type AssignmentCreate = {
     /** The type of assignment such as user or group */
     type: AssignmentType;
 };
+/**
+ * The type of assignment such as user or group
+ */
 type AssignmentType = "user" | "group";
 type AssignmentUpdate = {
     /** The roles assigned to the assigneeId. */
@@ -52,6 +58,9 @@ type Assignments = {
         count: number;
     };
 };
+/**
+ * An error object.
+ */
 type Error = {
     /** The error code. */
     code: string;
@@ -71,21 +80,26 @@ type Error = {
     title: string;
 };
 type Errors = {
-    /** The error code. */
+    /** @deprecated
+     * The error code. */
     code?: string;
-    /** A human-readable explanation specific to the occurrence of this problem. */
+    /** @deprecated
+     * A human-readable explanation specific to the occurrence of this problem. */
     detail?: string;
     errors?: Error[];
-    /** Additional properties relating to the error. */
+    /** @deprecated
+     * Additional properties relating to the error. */
     meta?: unknown;
-    /** References to the source of the error. */
+    /** @deprecated
+     * References to the source of the error. */
     source?: {
         /** The URI query parameter that caused the error. */
         parameter?: string;
         /** A JSON pointer to the property that caused the error. */
         pointer?: string;
     };
-    /** Summary of the problem. */
+    /** @deprecated
+     * Summary of the problem. */
     title?: string;
     traceId?: string;
 };
@@ -93,8 +107,20 @@ type Link = {
     /** URL that defines the resource. */
     href: string;
 };
+/**
+ * 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
+ */
 type RoleType = "consumer" | "contributor" | "dataconsumer" | "facilitator" | "operator" | "producer" | "publisher" | "basicconsumer" | "codeveloper";
+/**
+ * The supported roles for Shared spaces.
+ */
 type SharedSpaceRoleType = "facilitator" | "consumer" | "producer" | "dataconsumer" | "codeveloper";
+/**
+ * A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
+ */
 type Space = {
     /** The date and time when the space was created. */
     readonly createdAt?: string;
@@ -147,7 +173,13 @@ type SpacePatch = {
      * - ownerId: The user ID in uid format (string) of the space owner. */
     value: string;
 }[];
+/**
+ * The name of the type.
+ */
 type SpaceType = "shared" | "managed" | "data";
+/**
+ * The distinct types of spaces (shared, managed, and so on).
+ */
 type SpaceTypes = {
     readonly data?: SpaceType[];
 };

package/spaces.d.ts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
+/**
+ * The supported actions for user-created spaces like Shared or Managed spaces.
+ */
 type ActionName = "create" | "read" | "update" | "delete" | "publish";
 type Assignment = {
     /** The userId or groupId based on the type. */
@@ -35,6 +38,9 @@ type AssignmentCreate = {
     /** The type of assignment such as user or group */
     type: AssignmentType;
 };
+/**
+ * The type of assignment such as user or group
+ */
 type AssignmentType = "user" | "group";
 type AssignmentUpdate = {
     /** The roles assigned to the assigneeId. */
@@ -52,6 +58,9 @@ type Assignments = {
         count: number;
     };
 };
+/**
+ * An error object.
+ */
 type Error = {
     /** The error code. */
     code: string;
@@ -71,21 +80,26 @@ type Error = {
     title: string;
 };
 type Errors = {
-    /** The error code. */
+    /** @deprecated
+     * The error code. */
     code?: string;
-    /** A human-readable explanation specific to the occurrence of this problem. */
+    /** @deprecated
+     * A human-readable explanation specific to the occurrence of this problem. */
     detail?: string;
     errors?: Error[];
-    /** Additional properties relating to the error. */
+    /** @deprecated
+     * Additional properties relating to the error. */
     meta?: unknown;
-    /** References to the source of the error. */
+    /** @deprecated
+     * References to the source of the error. */
     source?: {
         /** The URI query parameter that caused the error. */
         parameter?: string;
         /** A JSON pointer to the property that caused the error. */
         pointer?: string;
     };
-    /** Summary of the problem. */
+    /** @deprecated
+     * Summary of the problem. */
     title?: string;
     traceId?: string;
 };
@@ -93,8 +107,20 @@ type Link = {
     /** URL that defines the resource. */
     href: string;
 };
+/**
+ * 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
+ */
 type RoleType = "consumer" | "contributor" | "dataconsumer" | "facilitator" | "operator" | "producer" | "publisher" | "basicconsumer" | "codeveloper";
+/**
+ * The supported roles for Shared spaces.
+ */
 type SharedSpaceRoleType = "facilitator" | "consumer" | "producer" | "dataconsumer" | "codeveloper";
+/**
+ * A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
+ */
 type Space = {
     /** The date and time when the space was created. */
     readonly createdAt?: string;
@@ -147,7 +173,13 @@ type SpacePatch = {
      * - ownerId: The user ID in uid format (string) of the space owner. */
     value: string;
 }[];
+/**
+ * The name of the type.
+ */
 type SpaceType = "shared" | "managed" | "data";
+/**
+ * The distinct types of spaces (shared, managed, and so on).
+ */
 type SpaceTypes = {
     readonly data?: SpaceType[];
 };

package/spaces.js

@@ -1,42 +1,42 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _EL2GSPZZjs = require('./chunks/EL2GSPZZ.js');
-require('./chunks/W2I5OQA5.js');
+var _NZ6E5ZHOjs = require('./chunks/NZ6E5ZHO.js');
+require('./chunks/NBNOAZT5.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/spaces.ts
-var getSpaces = async (query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var getSpaces = async (query, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "get",
   pathTemplate: "/api/v1/spaces",
   query,
   options
 });
-var createSpace = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var createSpace = async (body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "post",
   pathTemplate: "/api/v1/spaces",
   body,
   contentType: "application/json",
   options
 });
-var getSpaceTypes = async (options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var getSpaceTypes = async (options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "get",
   pathTemplate: "/api/v1/spaces/types",
   options
 });
-var deleteSpace = async (spaceId, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var deleteSpace = async (spaceId, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "delete",
   pathTemplate: "/api/v1/spaces/{spaceId}",
   pathVariables: { spaceId },
   options
 });
-var getSpace = async (spaceId, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var getSpace = async (spaceId, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "get",
   pathTemplate: "/api/v1/spaces/{spaceId}",
   pathVariables: { spaceId },
   options
 });
-var patchSpace = async (spaceId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var patchSpace = async (spaceId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "patch",
   pathTemplate: "/api/v1/spaces/{spaceId}",
   pathVariables: { spaceId },
@@ -44,7 +44,7 @@ var patchSpace = async (spaceId, body, options) => _EL2GSPZZjs.invokeFetch.call(
   contentType: "application/json",
   options
 });
-var updateSpace = async (spaceId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var updateSpace = async (spaceId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "put",
   pathTemplate: "/api/v1/spaces/{spaceId}",
   pathVariables: { spaceId },
@@ -52,14 +52,14 @@ var updateSpace = async (spaceId, body, options) => _EL2GSPZZjs.invokeFetch.call
   contentType: "application/json",
   options
 });
-var getSpaceAssignments = async (spaceId, query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var getSpaceAssignments = async (spaceId, query, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "get",
   pathTemplate: "/api/v1/spaces/{spaceId}/assignments",
   pathVariables: { spaceId },
   query,
   options
 });
-var createSpaceAssignment = async (spaceId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var createSpaceAssignment = async (spaceId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "post",
   pathTemplate: "/api/v1/spaces/{spaceId}/assignments",
   pathVariables: { spaceId },
@@ -67,19 +67,19 @@ var createSpaceAssignment = async (spaceId, body, options) => _EL2GSPZZjs.invoke
   contentType: "application/json",
   options
 });
-var deleteSpaceAssignment = async (spaceId, assignmentId, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var deleteSpaceAssignment = async (spaceId, assignmentId, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "delete",
   pathTemplate: "/api/v1/spaces/{spaceId}/assignments/{assignmentId}",
   pathVariables: { spaceId, assignmentId },
   options
 });
-var getSpaceAssignment = async (spaceId, assignmentId, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var getSpaceAssignment = async (spaceId, assignmentId, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "get",
   pathTemplate: "/api/v1/spaces/{spaceId}/assignments/{assignmentId}",
   pathVariables: { spaceId, assignmentId },
   options
 });
-var updateSpaceAssignment = async (spaceId, assignmentId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "spaces", {
+var updateSpaceAssignment = async (spaceId, assignmentId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "spaces", {
   method: "put",
   pathTemplate: "/api/v1/spaces/{spaceId}/assignments/{assignmentId}",
   pathVariables: { spaceId, assignmentId },
@@ -88,7 +88,7 @@ var updateSpaceAssignment = async (spaceId, assignmentId, body, options) => _EL2
   options
 });
 function clearCache() {
-  return _EL2GSPZZjs.clearApiCache.call(void 0, "spaces");
+  return _NZ6E5ZHOjs.clearApiCache.call(void 0, "spaces");
 }
 var spacesExport = {
   getSpaces,

package/spaces.mjs

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

package/temp-contents.d.mts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * An Error object.
+ */
 type Error = {
     /** The API error code. */
     code: string;
@@ -18,6 +21,9 @@ type Error = {
     /** Title of the type of API Error. */
     title: string;
 };
+/**
+ * An array of Error objects.
+ */
 type Errors = {
     errors?: Error[];
     /** A way to trace the source of the error. */

package/temp-contents.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 = {
     /** The API error code. */
     code: string;
@@ -18,6 +21,9 @@ type Error = {
     /** Title of the type of API Error. */
     title: string;
 };
+/**
+ * An array of Error objects.
+ */
 type Errors = {
     errors?: Error[];
     /** A way to trace the source of the error. */

package/temp-contents.js

@@ -1,12 +1,12 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _EL2GSPZZjs = require('./chunks/EL2GSPZZ.js');
-require('./chunks/W2I5OQA5.js');
+var _NZ6E5ZHOjs = require('./chunks/NZ6E5ZHO.js');
+require('./chunks/NBNOAZT5.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/temp-contents.ts
-var uploadTempFile = async (query, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "temp-contents", {
+var uploadTempFile = async (query, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "temp-contents", {
   method: "post",
   pathTemplate: "/api/v1/temp-contents",
   query,
@@ -14,21 +14,21 @@ var uploadTempFile = async (query, body, options) => _EL2GSPZZjs.invokeFetch.cal
   contentType: "application/octet-stream",
   options
 });
-var downloadTempFile = async (id, query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "temp-contents", {
+var downloadTempFile = async (id, query, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "temp-contents", {
   method: "get",
   pathTemplate: "/api/v1/temp-contents/{id}",
   pathVariables: { id },
   query,
   options
 });
-var getTempFileDetails = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "temp-contents", {
+var getTempFileDetails = async (id, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "temp-contents", {
   method: "get",
   pathTemplate: "/api/v1/temp-contents/{id}/details",
   pathVariables: { id },
   options
 });
 function clearCache() {
-  return _EL2GSPZZjs.clearApiCache.call(void 0, "temp-contents");
+  return _NZ6E5ZHOjs.clearApiCache.call(void 0, "temp-contents");
 }
 var tempContentsExport = { uploadTempFile, downloadTempFile, getTempFileDetails, clearCache };
 var temp_contents_default = tempContentsExport;

package/temp-contents.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/POR3DZIU.mjs";
-import "./chunks/VLLTA4EY.mjs";
+} from "./chunks/J3UXBHGX.mjs";
+import "./chunks/E3HDOP72.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/temp-contents.ts

package/tenants.d.mts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * An error object describing the error.
+ */
 type Error = {
     /** The error code. */
     code: string;
@@ -20,6 +23,9 @@ type Error = {
     /** 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[];
@@ -59,10 +65,16 @@ type TenantCreationRequest = {
     /** The signed license key of the license that will be associated with the created tenant. */
     licenseKey?: string;
 };
+/**
+ * A request to deactivate a tenant.
+ */
 type TenantDeactivateRequest = {
     /** Sets the number of days to purge the tenant after deactivation. Only available to OEMs. */
     purgeAfterDays?: number;
 };
+/**
+ * The result of tenant deactivation.
+ */
 type TenantDeactivateResponse = {
     /** The estimated date time of when tenant will be purged. */
     estimatedPurgeDate?: string;

package/tenants.d.ts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
+/**
+ * An error object describing the error.
+ */
 type Error = {
     /** The error code. */
     code: string;
@@ -20,6 +23,9 @@ type Error = {
     /** 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[];
@@ -59,10 +65,16 @@ type TenantCreationRequest = {
     /** The signed license key of the license that will be associated with the created tenant. */
     licenseKey?: string;
 };
+/**
+ * A request to deactivate a tenant.
+ */
 type TenantDeactivateRequest = {
     /** Sets the number of days to purge the tenant after deactivation. Only available to OEMs. */
     purgeAfterDays?: number;
 };
+/**
+ * The result of tenant deactivation.
+ */
 type TenantDeactivateResponse = {
     /** The estimated date time of when tenant will be purged. */
     estimatedPurgeDate?: string;

package/tenants.js

@@ -1,30 +1,30 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _EL2GSPZZjs = require('./chunks/EL2GSPZZ.js');
-require('./chunks/W2I5OQA5.js');
+var _NZ6E5ZHOjs = require('./chunks/NZ6E5ZHO.js');
+require('./chunks/NBNOAZT5.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/tenants.ts
-var createTenant = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "tenants", {
+var createTenant = async (body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "tenants", {
   method: "post",
   pathTemplate: "/api/v1/tenants",
   body,
   contentType: "application/json",
   options
 });
-var getMyTenant = async (options) => _EL2GSPZZjs.invokeFetch.call(void 0, "tenants", {
+var getMyTenant = async (options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "tenants", {
   method: "get",
   pathTemplate: "/api/v1/tenants/me",
   options
 });
-var getTenant = async (tenantId, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "tenants", {
+var getTenant = async (tenantId, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "tenants", {
   method: "get",
   pathTemplate: "/api/v1/tenants/{tenantId}",
   pathVariables: { tenantId },
   options
 });
-var patchTenant = async (tenantId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "tenants", {
+var patchTenant = async (tenantId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "tenants", {
   method: "patch",
   pathTemplate: "/api/v1/tenants/{tenantId}",
   pathVariables: { tenantId },
@@ -32,7 +32,7 @@ var patchTenant = async (tenantId, body, options) => _EL2GSPZZjs.invokeFetch.cal
   contentType: "application/json",
   options
 });
-var deactivateTenant = async (tenantId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "tenants", {
+var deactivateTenant = async (tenantId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "tenants", {
   method: "post",
   pathTemplate: "/api/v1/tenants/{tenantId}/actions/deactivate",
   pathVariables: { tenantId },
@@ -40,7 +40,7 @@ var deactivateTenant = async (tenantId, body, options) => _EL2GSPZZjs.invokeFetc
   contentType: "application/json",
   options
 });
-var reactivateTenant = async (tenantId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "tenants", {
+var reactivateTenant = async (tenantId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "tenants", {
   method: "post",
   pathTemplate: "/api/v1/tenants/{tenantId}/actions/reactivate",
   pathVariables: { tenantId },
@@ -49,7 +49,7 @@ var reactivateTenant = async (tenantId, body, options) => _EL2GSPZZjs.invokeFetc
   options
 });
 function clearCache() {
-  return _EL2GSPZZjs.clearApiCache.call(void 0, "tenants");
+  return _NZ6E5ZHOjs.clearApiCache.call(void 0, "tenants");
 }
 var tenantsExport = {
   createTenant,

package/tenants.mjs

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

package/themes.d.mts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * 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.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;