@qlik/api 1.30.0 → 1.32.0

package/tenants.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/tenants.ts

package/themes.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 /**
  * An error object.

package/themes.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/themes.ts

package/transports.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 type DeleteConfigNotFoundError = {
     errors?: {

package/transports.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/transports.ts

package/ui-config.d.ts

@@ -0,0 +1,274 @@
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
+
+type BulkCreatePinnedLinkItemPayload = CreatePinnedLinkConfigPayload & {
+    links: CreatePinnedLinkPayload[];
+};
+type CreatePinnedLinkConfigPayload = {
+    /** Specifies the scope of the link. Only supports `tenant`. */
+    scope: "tenant";
+    /** Specifies the type of the link. Only supports `custom-link`. */
+    type: "custom-link";
+};
+type CreatePinnedLinkPayload = {
+    /** The URL the user will be taken to when they click on the custom link. Must be https. */
+    link: string;
+    /** The title of the link, which will be shown in the navigation bar. Max length 50 characters. */
+    name: string;
+};
+type Error = {
+    /** Error code. */
+    readonly code?: number;
+    /** Error cause. */
+    readonly message?: string;
+};
+type ErrorResponse403 = {
+    errors?: {
+        code?: string;
+        detail?: string;
+        title?: string;
+    }[];
+    traceId?: string;
+};
+type JSONPatchPinnedLinkPayload = {
+    op: "replace";
+    path: "/name" | "/link";
+    /** The value to be used for this operation. */
+    value: string;
+}[];
+type PinnedLink = {
+    /** Date string */
+    createdAt: string;
+    createdBy: string;
+    id: string;
+    link: string;
+    name: string;
+    scope: "user" | "tenant";
+    tenantId: string;
+    type: "custom-link";
+    /** Date string */
+    updatedAt?: string;
+    updatedBy?: string;
+};
+/**
+ * Retrieves a list of all pinned links. All users can list pinned links. This endpoint does not support pagination as a tenant can have a maximum of 50 pinned links at one time.
+ *
+ * @throws GetUiConfigPinnedLinksHttpError
+ */
+declare const getUiConfigPinnedLinks: (options?: ApiCallOptions) => Promise<GetUiConfigPinnedLinksHttpResponse>;
+type GetUiConfigPinnedLinksHttpResponse = {
+    data: {
+        data?: PinnedLink[];
+    };
+    headers: Headers;
+    status: 200;
+};
+type GetUiConfigPinnedLinksHttpError = {
+    data: Error;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Creates a pinned link, which will appear below any existing pinned links in the tenant. Requires calling user to be assigned the `TenantAdmin` role. A tenant can have a maximum of 50 pinned links.
+ *
+ * @param body an object with the body content
+ * @throws CreateUiConfigPinnedLinkHttpError
+ */
+declare const createUiConfigPinnedLink: (body: CreatePinnedLinkPayload & CreatePinnedLinkConfigPayload, options?: ApiCallOptions) => Promise<CreateUiConfigPinnedLinkHttpResponse>;
+type CreateUiConfigPinnedLinkHttpResponse = {
+    data: PinnedLink;
+    headers: Headers;
+    status: 201;
+};
+type CreateUiConfigPinnedLinkHttpError = CreateUiConfigPinnedLink403HttpError | CreateUiConfigPinnedLinkdefaultHttpError;
+type CreateUiConfigPinnedLink403HttpError = {
+    data: ErrorResponse403;
+    headers: Headers;
+    status: 403;
+};
+type CreateUiConfigPinnedLinkdefaultHttpError = {
+    data: Error;
+    headers: Headers;
+    status: "default";
+};
+/**
+ * Creates one or more pinned links for navigation, an alternative method to multiple calls to `/ui-config/pinned-links`. Links are displayed below any existing pinned links, and will be added in the order sent in the request. Requires calling user to be assigned the `TenantAdmin` role. A tenant can have a maximum of 50 pinned links.
+ *
+ * @param body an object with the body content
+ * @throws CreateUiConfigPinnedLinksHttpError
+ */
+declare const createUiConfigPinnedLinks: (body: BulkCreatePinnedLinkItemPayload, options?: ApiCallOptions) => Promise<CreateUiConfigPinnedLinksHttpResponse>;
+type CreateUiConfigPinnedLinksHttpResponse = {
+    data: {
+        data?: PinnedLink[];
+    };
+    headers: Headers;
+    status: 200;
+};
+type CreateUiConfigPinnedLinksHttpError = CreateUiConfigPinnedLinks403HttpError | CreateUiConfigPinnedLinksdefaultHttpError;
+type CreateUiConfigPinnedLinks403HttpError = {
+    data: ErrorResponse403;
+    headers: Headers;
+    status: 403;
+};
+type CreateUiConfigPinnedLinksdefaultHttpError = {
+    data: Error;
+    headers: Headers;
+    status: "default";
+};
+/**
+ * Deletes all pinned links in the tenant. Requires calling user to be assigned the `TenantAdmin` role.
+ *
+ * @throws DeleteAllUiConfigPinnedLinksHttpError
+ */
+declare const deleteAllUiConfigPinnedLinks: (options?: ApiCallOptions) => Promise<DeleteAllUiConfigPinnedLinksHttpResponse>;
+type DeleteAllUiConfigPinnedLinksHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: 204;
+};
+type DeleteAllUiConfigPinnedLinksHttpError = DeleteAllUiConfigPinnedLinks403HttpError | DeleteAllUiConfigPinnedLinksdefaultHttpError;
+type DeleteAllUiConfigPinnedLinks403HttpError = {
+    data: ErrorResponse403;
+    headers: Headers;
+    status: 403;
+};
+type DeleteAllUiConfigPinnedLinksdefaultHttpError = {
+    data: Error;
+    headers: Headers;
+    status: "default";
+};
+/**
+ * Deletes a specific pinned link. Requires calling user to be assigned the `TenantAdmin` role.
+ *
+ * @param id The pinned link identifier.
+ * @throws DeleteUiConfigPinnedLinkHttpError
+ */
+declare const deleteUiConfigPinnedLink: (id: string, options?: ApiCallOptions) => Promise<DeleteUiConfigPinnedLinkHttpResponse>;
+type DeleteUiConfigPinnedLinkHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: 204;
+};
+type DeleteUiConfigPinnedLinkHttpError = DeleteUiConfigPinnedLink403HttpError | DeleteUiConfigPinnedLinkdefaultHttpError;
+type DeleteUiConfigPinnedLink403HttpError = {
+    data: ErrorResponse403;
+    headers: Headers;
+    status: 403;
+};
+type DeleteUiConfigPinnedLinkdefaultHttpError = {
+    data: Error;
+    headers: Headers;
+    status: "default";
+};
+/**
+ * Retrieves a specific pinned link.
+ *
+ * @param id The pinned link identifier.
+ * @throws GetUiConfigPinnedLinkHttpError
+ */
+declare const getUiConfigPinnedLink: (id: string, options?: ApiCallOptions) => Promise<GetUiConfigPinnedLinkHttpResponse>;
+type GetUiConfigPinnedLinkHttpResponse = {
+    data: PinnedLink;
+    headers: Headers;
+    status: 200;
+};
+type GetUiConfigPinnedLinkHttpError = GetUiConfigPinnedLink403HttpError | GetUiConfigPinnedLinkdefaultHttpError;
+type GetUiConfigPinnedLink403HttpError = {
+    data: ErrorResponse403;
+    headers: Headers;
+    status: 403;
+};
+type GetUiConfigPinnedLinkdefaultHttpError = {
+    data: Error;
+    headers: Headers;
+    status: "default";
+};
+/**
+ * Updates a specific pinned link with an array of JSON patches. Requires calling user to be assigned the `TenantAdmin` role.
+ *
+ * @param id The pinned link identifier.
+ * @param body an object with the body content
+ * @throws PatchUiConfigPinnedLinkHttpError
+ */
+declare const patchUiConfigPinnedLink: (id: string, body: JSONPatchPinnedLinkPayload, options?: ApiCallOptions) => Promise<PatchUiConfigPinnedLinkHttpResponse>;
+type PatchUiConfigPinnedLinkHttpResponse = {
+    data: PinnedLink;
+    headers: Headers;
+    status: 200;
+};
+type PatchUiConfigPinnedLinkHttpError = PatchUiConfigPinnedLink403HttpError | PatchUiConfigPinnedLinkdefaultHttpError;
+type PatchUiConfigPinnedLink403HttpError = {
+    data: ErrorResponse403;
+    headers: Headers;
+    status: 403;
+};
+type PatchUiConfigPinnedLinkdefaultHttpError = {
+    data: Error;
+    headers: Headers;
+    status: "default";
+};
+/**
+ * Clears the cache for ui-config api requests.
+ */
+declare function clearCache(): void;
+interface UiConfigAPI {
+    /**
+     * Retrieves a list of all pinned links. All users can list pinned links. This endpoint does not support pagination as a tenant can have a maximum of 50 pinned links at one time.
+     *
+     * @throws GetUiConfigPinnedLinksHttpError
+     */
+    getUiConfigPinnedLinks: typeof getUiConfigPinnedLinks;
+    /**
+     * Creates a pinned link, which will appear below any existing pinned links in the tenant. Requires calling user to be assigned the `TenantAdmin` role. A tenant can have a maximum of 50 pinned links.
+     *
+     * @param body an object with the body content
+     * @throws CreateUiConfigPinnedLinkHttpError
+     */
+    createUiConfigPinnedLink: typeof createUiConfigPinnedLink;
+    /**
+     * Creates one or more pinned links for navigation, an alternative method to multiple calls to `/ui-config/pinned-links`. Links are displayed below any existing pinned links, and will be added in the order sent in the request. Requires calling user to be assigned the `TenantAdmin` role. A tenant can have a maximum of 50 pinned links.
+     *
+     * @param body an object with the body content
+     * @throws CreateUiConfigPinnedLinksHttpError
+     */
+    createUiConfigPinnedLinks: typeof createUiConfigPinnedLinks;
+    /**
+     * Deletes all pinned links in the tenant. Requires calling user to be assigned the `TenantAdmin` role.
+     *
+     * @throws DeleteAllUiConfigPinnedLinksHttpError
+     */
+    deleteAllUiConfigPinnedLinks: typeof deleteAllUiConfigPinnedLinks;
+    /**
+     * Deletes a specific pinned link. Requires calling user to be assigned the `TenantAdmin` role.
+     *
+     * @param id The pinned link identifier.
+     * @throws DeleteUiConfigPinnedLinkHttpError
+     */
+    deleteUiConfigPinnedLink: typeof deleteUiConfigPinnedLink;
+    /**
+     * Retrieves a specific pinned link.
+     *
+     * @param id The pinned link identifier.
+     * @throws GetUiConfigPinnedLinkHttpError
+     */
+    getUiConfigPinnedLink: typeof getUiConfigPinnedLink;
+    /**
+     * Updates a specific pinned link with an array of JSON patches. Requires calling user to be assigned the `TenantAdmin` role.
+     *
+     * @param id The pinned link identifier.
+     * @param body an object with the body content
+     * @throws PatchUiConfigPinnedLinkHttpError
+     */
+    patchUiConfigPinnedLink: typeof patchUiConfigPinnedLink;
+    /**
+     * Clears the cache for ui-config api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the ui-config api
+ */
+declare const uiConfigExport: UiConfigAPI;
+
+export { type BulkCreatePinnedLinkItemPayload, type CreatePinnedLinkConfigPayload, type CreatePinnedLinkPayload, type CreateUiConfigPinnedLink403HttpError, type CreateUiConfigPinnedLinkHttpError, type CreateUiConfigPinnedLinkHttpResponse, type CreateUiConfigPinnedLinkdefaultHttpError, type CreateUiConfigPinnedLinks403HttpError, type CreateUiConfigPinnedLinksHttpError, type CreateUiConfigPinnedLinksHttpResponse, type CreateUiConfigPinnedLinksdefaultHttpError, type DeleteAllUiConfigPinnedLinks403HttpError, type DeleteAllUiConfigPinnedLinksHttpError, type DeleteAllUiConfigPinnedLinksHttpResponse, type DeleteAllUiConfigPinnedLinksdefaultHttpError, type DeleteUiConfigPinnedLink403HttpError, type DeleteUiConfigPinnedLinkHttpError, type DeleteUiConfigPinnedLinkHttpResponse, type DeleteUiConfigPinnedLinkdefaultHttpError, type Error, type ErrorResponse403, type GetUiConfigPinnedLink403HttpError, type GetUiConfigPinnedLinkHttpError, type GetUiConfigPinnedLinkHttpResponse, type GetUiConfigPinnedLinkdefaultHttpError, type GetUiConfigPinnedLinksHttpError, type GetUiConfigPinnedLinksHttpResponse, type JSONPatchPinnedLinkPayload, type PatchUiConfigPinnedLink403HttpError, type PatchUiConfigPinnedLinkHttpError, type PatchUiConfigPinnedLinkHttpResponse, type PatchUiConfigPinnedLinkdefaultHttpError, type PinnedLink, type UiConfigAPI, clearCache, createUiConfigPinnedLink, createUiConfigPinnedLinks, uiConfigExport as default, deleteAllUiConfigPinnedLinks, deleteUiConfigPinnedLink, getUiConfigPinnedLink, getUiConfigPinnedLinks, patchUiConfigPinnedLink };

package/ui-config.js

@@ -0,0 +1,77 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
+import "./chunks/2ZQ3ZX7F.js";
+
+// src/public/rest/ui-config.ts
+var getUiConfigPinnedLinks = async (options) => invokeFetch("ui-config", {
+  method: "get",
+  pathTemplate: "/api/v1/ui-config/pinned-links",
+  options
+});
+var createUiConfigPinnedLink = async (body, options) => invokeFetch("ui-config", {
+  method: "post",
+  pathTemplate: "/api/v1/ui-config/pinned-links",
+  body,
+  contentType: "application/json",
+  options
+});
+var createUiConfigPinnedLinks = async (body, options) => invokeFetch("ui-config", {
+  method: "post",
+  pathTemplate: "/api/v1/ui-config/pinned-links/actions/bulk-create-pinned-links",
+  body,
+  contentType: "application/json",
+  options
+});
+var deleteAllUiConfigPinnedLinks = async (options) => invokeFetch("ui-config", {
+  method: "post",
+  pathTemplate: "/api/v1/ui-config/pinned-links/actions/delete-all-pinned-links",
+  options
+});
+var deleteUiConfigPinnedLink = async (id, options) => invokeFetch("ui-config", {
+  method: "delete",
+  pathTemplate: "/api/v1/ui-config/pinned-links/{id}",
+  pathVariables: { id },
+  options
+});
+var getUiConfigPinnedLink = async (id, options) => invokeFetch("ui-config", {
+  method: "get",
+  pathTemplate: "/api/v1/ui-config/pinned-links/{id}",
+  pathVariables: { id },
+  options
+});
+var patchUiConfigPinnedLink = async (id, body, options) => invokeFetch("ui-config", {
+  method: "patch",
+  pathTemplate: "/api/v1/ui-config/pinned-links/{id}",
+  pathVariables: { id },
+  body,
+  contentType: "application/json",
+  options
+});
+function clearCache() {
+  return clearApiCache("ui-config");
+}
+var uiConfigExport = {
+  getUiConfigPinnedLinks,
+  createUiConfigPinnedLink,
+  createUiConfigPinnedLinks,
+  deleteAllUiConfigPinnedLinks,
+  deleteUiConfigPinnedLink,
+  getUiConfigPinnedLink,
+  patchUiConfigPinnedLink,
+  clearCache
+};
+var ui_config_default = uiConfigExport;
+export {
+  clearCache,
+  createUiConfigPinnedLink,
+  createUiConfigPinnedLinks,
+  ui_config_default as default,
+  deleteAllUiConfigPinnedLinks,
+  deleteUiConfigPinnedLink,
+  getUiConfigPinnedLink,
+  getUiConfigPinnedLinks,
+  patchUiConfigPinnedLink
+};

package/users.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 /**
  * An array of group references.

package/users.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/users.ts

package/web-integrations.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 /**
  * An error object describing the error.

package/web-integrations.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/web-integrations.ts

package/web-notifications.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 /**
  * An error object.

package/web-notifications.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/web-notifications.ts

package/webhooks.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 type Delivery = {
     /** The name of the triggering event-type */

package/webhooks.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/webhooks.ts