@qlik/api 2.2.0 → 2.3.0

package/ui-config.d.ts

@@ -1,4 +1,275 @@
-import "./chunks/auth-types-E99tzdN0.js";
-import "./chunks/invoke-fetch-CbU2Dgqr.js";
-import { A as PatchUiConfigPinnedLinkHttpError, B as getUiConfigPinnedLink, C as GetUiConfigPinnedLinkHttpError, D as GetUiConfigPinnedLinksHttpResponse, E as GetUiConfigPinnedLinksHttpError, F as clearCache, H as patchUiConfigPinnedLink, I as createUiConfigPinnedLink, L as createUiConfigPinnedLinks, M as PatchUiConfigPinnedLinkdefaultHttpError, N as PinnedLink, O as JSONPatchPinnedLinkPayload, P as UiConfigAPI, R as deleteAllUiConfigPinnedLinks, S as GetUiConfigPinnedLink403HttpError, T as GetUiConfigPinnedLinkdefaultHttpError, U as uiConfigExport, V as getUiConfigPinnedLinks, _ as DeleteUiConfigPinnedLinkHttpError, a as CreateUiConfigPinnedLinkHttpError, b as Error, c as CreateUiConfigPinnedLinks403HttpError, d as CreateUiConfigPinnedLinksdefaultHttpError, f as DeleteAllUiConfigPinnedLinks403HttpError, g as DeleteUiConfigPinnedLink403HttpError, h as DeleteAllUiConfigPinnedLinksdefaultHttpError, i as CreateUiConfigPinnedLink403HttpError, j as PatchUiConfigPinnedLinkHttpResponse, k as PatchUiConfigPinnedLink403HttpError, l as CreateUiConfigPinnedLinksHttpError, m as DeleteAllUiConfigPinnedLinksHttpResponse, n as CreatePinnedLinkConfigPayload, o as CreateUiConfigPinnedLinkHttpResponse, p as DeleteAllUiConfigPinnedLinksHttpError, r as CreatePinnedLinkPayload, s as CreateUiConfigPinnedLinkdefaultHttpError, t as BulkCreatePinnedLinkItemPayload, u as CreateUiConfigPinnedLinksHttpResponse, v as DeleteUiConfigPinnedLinkHttpResponse, w as GetUiConfigPinnedLinkHttpResponse, x as ErrorResponse403, y as DeleteUiConfigPinnedLinkdefaultHttpError, z as deleteUiConfigPinnedLink } from "./chunks/ui-config-Crs0mVMp.js";
+import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
+import "./chunks/invoke-fetch-C1Z0RJYU.js";
+
+//#region src/public/rest/ui-config.d.ts
+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 function 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 function 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 function 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 function 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 function 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 function 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 function 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;
+type 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;
+//#endregion
 export { BulkCreatePinnedLinkItemPayload, CreatePinnedLinkConfigPayload, CreatePinnedLinkPayload, CreateUiConfigPinnedLink403HttpError, CreateUiConfigPinnedLinkHttpError, CreateUiConfigPinnedLinkHttpResponse, CreateUiConfigPinnedLinkdefaultHttpError, CreateUiConfigPinnedLinks403HttpError, CreateUiConfigPinnedLinksHttpError, CreateUiConfigPinnedLinksHttpResponse, CreateUiConfigPinnedLinksdefaultHttpError, DeleteAllUiConfigPinnedLinks403HttpError, DeleteAllUiConfigPinnedLinksHttpError, DeleteAllUiConfigPinnedLinksHttpResponse, DeleteAllUiConfigPinnedLinksdefaultHttpError, DeleteUiConfigPinnedLink403HttpError, DeleteUiConfigPinnedLinkHttpError, DeleteUiConfigPinnedLinkHttpResponse, DeleteUiConfigPinnedLinkdefaultHttpError, Error, ErrorResponse403, GetUiConfigPinnedLink403HttpError, GetUiConfigPinnedLinkHttpError, GetUiConfigPinnedLinkHttpResponse, GetUiConfigPinnedLinkdefaultHttpError, GetUiConfigPinnedLinksHttpError, GetUiConfigPinnedLinksHttpResponse, JSONPatchPinnedLinkPayload, PatchUiConfigPinnedLink403HttpError, PatchUiConfigPinnedLinkHttpError, PatchUiConfigPinnedLinkHttpResponse, PatchUiConfigPinnedLinkdefaultHttpError, PinnedLink, UiConfigAPI, clearCache, createUiConfigPinnedLink, createUiConfigPinnedLinks, uiConfigExport as default, deleteAllUiConfigPinnedLinks, deleteUiConfigPinnedLink, getUiConfigPinnedLink, getUiConfigPinnedLinks, patchUiConfigPinnedLink };

package/ui-config.js

@@ -1,6 +1,5 @@
-import "./chunks/utils-BnC4lrlq.js";
-import "./chunks/public-runtime-modules-Dwjzb3l8.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
+import "./chunks/public-runtime-modules-QhLPeQr5.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
 
 //#region src/public/rest/ui-config.ts
 /**