@qlik/api 0.0.8 → 0.0.10

package/audits.d.mts

@@ -1,7 +1,8 @@
-import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
+import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
 type ErrorResponse = {
+    /** @deprecated */
     error?: string;
     errors?: {
         code?: string;
@@ -10,6 +11,9 @@ type ErrorResponse = {
     }[];
     traceId?: string;
 };
+/**
+ * The availability of the properties depends on the event and the context it was triggered in.
+ */
 type EventExtensions = {
     /** Specifies the entity performing the action on behalf of another party listed as triggering the action. */
     actor?: {
@@ -57,6 +61,7 @@ type GetByIDResult = {
     userId?: string;
 };
 type GetLinks = {
+    /** @deprecated */
     Self?: Href;
     self?: Href;
 };
@@ -79,12 +84,20 @@ type GetSettingsResult = {
         EventTTL?: number;
     };
 };
+/**
+ * @deprecated
+ *
+ */
 type Href = {
+    /** @deprecated */
     Href?: string;
 };
 type ListLinks = {
+    /** @deprecated */
     Next?: Href;
+    /** @deprecated */
     Prev?: Href;
+    /** @deprecated */
     Self?: Href;
     next?: Href;
     prev?: Href;

package/audits.d.ts

@@ -1,7 +1,8 @@
-import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
+import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
 type ErrorResponse = {
+    /** @deprecated */
     error?: string;
     errors?: {
         code?: string;
@@ -10,6 +11,9 @@ type ErrorResponse = {
     }[];
     traceId?: string;
 };
+/**
+ * The availability of the properties depends on the event and the context it was triggered in.
+ */
 type EventExtensions = {
     /** Specifies the entity performing the action on behalf of another party listed as triggering the action. */
     actor?: {
@@ -57,6 +61,7 @@ type GetByIDResult = {
     userId?: string;
 };
 type GetLinks = {
+    /** @deprecated */
     Self?: Href;
     self?: Href;
 };
@@ -79,12 +84,20 @@ type GetSettingsResult = {
         EventTTL?: number;
     };
 };
+/**
+ * @deprecated
+ *
+ */
 type Href = {
+    /** @deprecated */
     Href?: string;
 };
 type ListLinks = {
+    /** @deprecated */
     Next?: Href;
+    /** @deprecated */
     Prev?: Href;
+    /** @deprecated */
     Self?: Href;
     next?: Href;
     prev?: Href;

package/audits.js

@@ -1,46 +1,46 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkEALMXU6Sjs = require('./chunk-EALMXU6S.js');
-require('./chunk-BRDPNGQ7.js');
-require('./chunk-P57PW2II.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
+require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/audits.ts
-var getAudits = async (query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "audits", {
+var getAudits = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "audits", {
   method: "get",
   pathTemplate: "/api/v1/audits",
   query,
   options
 });
-var getArchivedAudits = async (query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "audits", {
+var getArchivedAudits = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "audits", {
   method: "get",
   pathTemplate: "/api/v1/audits/archive",
   query,
   options
 });
-var getAuditsSettings = async (options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "audits", {
+var getAuditsSettings = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "audits", {
   method: "get",
   pathTemplate: "/api/v1/audits/settings",
   options
 });
-var getAuditSources = async (options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "audits", {
+var getAuditSources = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "audits", {
   method: "get",
   pathTemplate: "/api/v1/audits/sources",
   options
 });
-var getAuditTypes = async (options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "audits", {
+var getAuditTypes = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "audits", {
   method: "get",
   pathTemplate: "/api/v1/audits/types",
   options
 });
-var getAudit = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "audits", {
+var getAudit = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "audits", {
   method: "get",
   pathTemplate: "/api/v1/audits/{id}",
   pathVariables: { id },
   options
 });
 function clearCache() {
-  return _chunkEALMXU6Sjs.clearApiCache.call(void 0, "audits");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "audits");
 }
 var auditsExport = {
   getAudits,

package/audits.mjs

@@ -1,9 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunk-4MWB2T3C.mjs";
-import "./chunk-LLLEO6K6.mjs";
-import "./chunk-ZFXKCRJC.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
+import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/audits.ts
 var getAudits = async (query, options) => invokeFetch("audits", {

package/auth.js

@@ -3,12 +3,12 @@
 
 
 
-var _chunkRYBRKLOYjs = require('./chunk-RYBRKLOY.js');
-require('./chunk-BRDPNGQ7.js');
-require('./chunk-P57PW2II.js');
+var _ILOY5QEAjs = require('./chunks/ILOY5QEA.js');
+require('./chunks/FG5GDUSZ.js');
+require('./chunks/4HB3TAEO.js');
 
 
 
 
 
-exports.default = _chunkRYBRKLOYjs.auth_default; exports.logout = _chunkRYBRKLOYjs.logout; exports.registerAuthModule = _chunkRYBRKLOYjs.registerAuthModule; exports.setDefaultHostConfig = _chunkRYBRKLOYjs.setDefaultHostConfig;
+exports.default = _ILOY5QEAjs.auth_default; exports.logout = _ILOY5QEAjs.logout; exports.registerAuthModule = _ILOY5QEAjs.registerAuthModule; exports.setDefaultHostConfig = _ILOY5QEAjs.setDefaultHostConfig;

package/auth.mjs

@@ -3,9 +3,9 @@ import {
   logout,
   registerAuthModule,
   setDefaultHostConfig
-} from "./chunk-4R2XCEVK.mjs";
-import "./chunk-LLLEO6K6.mjs";
-import "./chunk-ZFXKCRJC.mjs";
+} from "./chunks/FUU5VIC4.mjs";
+import "./chunks/O5POHH2Q.mjs";
+import "./chunks/VSY5YIQY.mjs";
 export {
   auth_default as default,
   logout,

package/automations.d.mts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
+import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
 type AutomationDetailRequestObject = {
@@ -217,6 +217,8 @@ type CreateAutomationHttpError = {
     status: number;
 };
 /**
+ * @deprecated
+ *
  * Retrieves the automation settings.
  *
  * @throws GetAutomationsSettingsHttpError
@@ -233,6 +235,8 @@ type GetAutomationsSettingsHttpError = {
     status: number;
 };
 /**
+ * @deprecated
+ *
  * Update the automation settings.
  *
  * @param body an object with the body content
@@ -541,12 +545,16 @@ interface AutomationsAPI {
      */
     createAutomation: typeof createAutomation;
     /**
+     * @deprecated
+     *
      * Retrieves the automation settings.
      *
      * @throws GetAutomationsSettingsHttpError
      */
     getAutomationsSettings: typeof getAutomationsSettings;
     /**
+     * @deprecated
+     *
      * Update the automation settings.
      *
      * @param body an object with the body content

package/automations.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
+import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
 type AutomationDetailRequestObject = {
@@ -217,6 +217,8 @@ type CreateAutomationHttpError = {
     status: number;
 };
 /**
+ * @deprecated
+ *
  * Retrieves the automation settings.
  *
  * @throws GetAutomationsSettingsHttpError
@@ -233,6 +235,8 @@ type GetAutomationsSettingsHttpError = {
     status: number;
 };
 /**
+ * @deprecated
+ *
  * Update the automation settings.
  *
  * @param body an object with the body content
@@ -541,12 +545,16 @@ interface AutomationsAPI {
      */
     createAutomation: typeof createAutomation;
     /**
+     * @deprecated
+     *
      * Retrieves the automation settings.
      *
      * @throws GetAutomationsSettingsHttpError
      */
     getAutomationsSettings: typeof getAutomationsSettings;
     /**
+     * @deprecated
+     *
      * Update the automation settings.
      *
      * @param body an object with the body content

package/automations.js

@@ -1,55 +1,55 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkEALMXU6Sjs = require('./chunk-EALMXU6S.js');
-require('./chunk-BRDPNGQ7.js');
-require('./chunk-P57PW2II.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
+require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/automations.ts
-var getAutomations = async (query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var getAutomations = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "get",
   pathTemplate: "/api/v1/automations",
   query,
   options
 });
-var createAutomation = async (body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var createAutomation = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "post",
   pathTemplate: "/api/v1/automations",
   body,
   contentType: "application/json",
   options
 });
-var getAutomationsSettings = async (options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var getAutomationsSettings = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "get",
   pathTemplate: "/api/v1/automations/settings",
   options
 });
-var updateAutomationsSettings = async (body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var updateAutomationsSettings = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "put",
   pathTemplate: "/api/v1/automations/settings",
   body,
   contentType: "application/json",
   options
 });
-var getAutomationsUsageMetrics = async (query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var getAutomationsUsageMetrics = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "get",
   pathTemplate: "/api/v1/automations/usage",
   query,
   options
 });
-var deleteAutomation = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var deleteAutomation = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "delete",
   pathTemplate: "/api/v1/automations/{id}",
   pathVariables: { id },
   options
 });
-var getAutomation = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var getAutomation = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "get",
   pathTemplate: "/api/v1/automations/{id}",
   pathVariables: { id },
   options
 });
-var updateAutomation = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var updateAutomation = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "put",
   pathTemplate: "/api/v1/automations/{id}",
   pathVariables: { id },
@@ -57,7 +57,7 @@ var updateAutomation = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch
   contentType: "application/json",
   options
 });
-var copyAutomation = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var copyAutomation = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "post",
   pathTemplate: "/api/v1/automations/{id}/actions/copy",
   pathVariables: { id },
@@ -65,19 +65,19 @@ var copyAutomation = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.c
   contentType: "application/json",
   options
 });
-var disableAutomation = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var disableAutomation = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "post",
   pathTemplate: "/api/v1/automations/{id}/actions/disable",
   pathVariables: { id },
   options
 });
-var enableAutomation = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var enableAutomation = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "post",
   pathTemplate: "/api/v1/automations/{id}/actions/enable",
   pathVariables: { id },
   options
 });
-var moveAutomation = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var moveAutomation = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "post",
   pathTemplate: "/api/v1/automations/{id}/actions/move",
   pathVariables: { id },
@@ -85,14 +85,14 @@ var moveAutomation = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.c
   contentType: "application/json",
   options
 });
-var getAutomationRuns = async (id, query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var getAutomationRuns = async (id, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "get",
   pathTemplate: "/api/v1/automations/{id}/runs",
   pathVariables: { id },
   query,
   options
 });
-var queueAutomationRun = async (id, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var queueAutomationRun = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "post",
   pathTemplate: "/api/v1/automations/{id}/runs",
   pathVariables: { id },
@@ -100,32 +100,32 @@ var queueAutomationRun = async (id, body, options) => _chunkEALMXU6Sjs.invokeFet
   contentType: "application/json",
   options
 });
-var getAutomationRun = async (id, runId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var getAutomationRun = async (id, runId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "get",
   pathTemplate: "/api/v1/automations/{id}/runs/{runId}",
   pathVariables: { id, runId },
   options
 });
-var getAutomationRunDetails = async (id, runId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var getAutomationRunDetails = async (id, runId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "post",
   pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/export",
   pathVariables: { id, runId },
   options
 });
-var retryAutomationRun = async (id, runId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var retryAutomationRun = async (id, runId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "post",
   pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/retry",
   pathVariables: { id, runId },
   options
 });
-var stopAutomationRun = async (id, runId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "automations", {
+var stopAutomationRun = async (id, runId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "automations", {
   method: "post",
   pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/stop",
   pathVariables: { id, runId },
   options
 });
 function clearCache() {
-  return _chunkEALMXU6Sjs.clearApiCache.call(void 0, "automations");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "automations");
 }
 var automationsExport = {
   getAutomations,

package/automations.mjs

@@ -1,9 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunk-4MWB2T3C.mjs";
-import "./chunk-LLLEO6K6.mjs";
-import "./chunk-ZFXKCRJC.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
+import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/automations.ts
 var getAutomations = async (query, options) => invokeFetch("automations", {

package/brands.d.mts

@@ -1,6 +1,9 @@
-import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
+import { A as ApiCallOptions, D as DownloadableBlob } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.
+ */
 type Brand = {
     readonly active?: boolean;
     /** The UTC timestamp when the brand was created. */
@@ -17,12 +20,18 @@ type Brand = {
     /** ID of a user that last updated the brand. */
     readonly updatedBy?: string;
 };
+/**
+ * Represents one of the assets used as part of the brand. These include logos, favicons, and some styles.
+ */
 type BrandFile = {
     contentType?: string;
     eTag?: string;
     id?: "logo" | "favIcon" | "styles";
     path?: string;
 };
+/**
+ * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
+ */
 type BrandPatch = {
     /** The operation to be performed. */
     op: "add" | "remove" | "replace";
@@ -31,6 +40,9 @@ type BrandPatch = {
     /** The value to be used for this operation. */
     value?: string;
 };
+/**
+ * A collection of brands.
+ */
 type BrandsList = {
     data?: Brand[];
     links?: {
@@ -83,6 +95,9 @@ type Link = {
     /** URL of a resource request. */
     href: string;
 };
+/**
+ * Empty object inferring lack of active branding.
+ */
 type NoActiveBrand = unknown;
 /**
  * Lists all brand entries for a tenant
@@ -179,12 +194,12 @@ type CreateBrandHttpError = CreateBrand400HttpError | CreateBrand401HttpError |
  */
 declare const getActiveBrand: (options?: ApiCallOptions) => Promise<GetActiveBrandHttpResponse>;
 type GetActiveBrandHttpResponse = {
-    data: NoActiveBrand;
+    data: Brand | NoActiveBrand;
     headers: Headers;
     status: number;
 };
 type GetActiveBrandHttpError = {
-    data: void;
+    data: unknown;
     headers: Headers;
     status: number;
 };
@@ -429,7 +444,7 @@ type DeleteBrandFileHttpError = DeleteBrandFile400HttpError | DeleteBrandFile401
  */
 declare const getBrandFile: (brandId: string, brandFileId: string, options?: ApiCallOptions) => Promise<GetBrandFileHttpResponse>;
 type GetBrandFileHttpResponse = {
-    data: BodyInit;
+    data: DownloadableBlob;
     headers: Headers;
     status: number;
 };

package/brands.d.ts

@@ -1,6 +1,9 @@
-import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
+import { A as ApiCallOptions, D as DownloadableBlob } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
+/**
+ * A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.
+ */
 type Brand = {
     readonly active?: boolean;
     /** The UTC timestamp when the brand was created. */
@@ -17,12 +20,18 @@ type Brand = {
     /** ID of a user that last updated the brand. */
     readonly updatedBy?: string;
 };
+/**
+ * Represents one of the assets used as part of the brand. These include logos, favicons, and some styles.
+ */
 type BrandFile = {
     contentType?: string;
     eTag?: string;
     id?: "logo" | "favIcon" | "styles";
     path?: string;
 };
+/**
+ * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
+ */
 type BrandPatch = {
     /** The operation to be performed. */
     op: "add" | "remove" | "replace";
@@ -31,6 +40,9 @@ type BrandPatch = {
     /** The value to be used for this operation. */
     value?: string;
 };
+/**
+ * A collection of brands.
+ */
 type BrandsList = {
     data?: Brand[];
     links?: {
@@ -83,6 +95,9 @@ type Link = {
     /** URL of a resource request. */
     href: string;
 };
+/**
+ * Empty object inferring lack of active branding.
+ */
 type NoActiveBrand = unknown;
 /**
  * Lists all brand entries for a tenant
@@ -179,12 +194,12 @@ type CreateBrandHttpError = CreateBrand400HttpError | CreateBrand401HttpError |
  */
 declare const getActiveBrand: (options?: ApiCallOptions) => Promise<GetActiveBrandHttpResponse>;
 type GetActiveBrandHttpResponse = {
-    data: NoActiveBrand;
+    data: Brand | NoActiveBrand;
     headers: Headers;
     status: number;
 };
 type GetActiveBrandHttpError = {
-    data: void;
+    data: unknown;
     headers: Headers;
     status: number;
 };
@@ -429,7 +444,7 @@ type DeleteBrandFileHttpError = DeleteBrandFile400HttpError | DeleteBrandFile401
  */
 declare const getBrandFile: (brandId: string, brandFileId: string, options?: ApiCallOptions) => Promise<GetBrandFileHttpResponse>;
 type GetBrandFileHttpResponse = {
-    data: BodyInit;
+    data: DownloadableBlob;
     headers: Headers;
     status: number;
 };