@qlik/api 2.3.0 → 2.4.0

package/themes.d.ts

@@ -1,73 +1,49 @@
-import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions, DownloadableBlob } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
 
 //#region src/public/rest/themes.d.ts
 /**
  * An error object.
  */
 type Error = {
-  /** Object containing meta data regarding an error. It does not necessarily contain all the properties. */
-  meta?: Meta;
-  /** Optional JSON patch object pointing to an invalid property. */
-  source?: unknown;
-  /** The HTTP status code. */
-  status?: number;
-  /** Title of the HTTP status code. */
-  title: string;
-  /** The active traceId. */
+  /** Object containing meta data regarding an error. It does not necessarily contain all the properties. */meta?: Meta; /** Optional JSON patch object pointing to an invalid property. */
+  source?: unknown; /** The HTTP status code. */
+  status?: number; /** Title of the HTTP status code. */
+  title: string; /** The active traceId. */
   traceId?: 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;
-  /** Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created. */
-  resourceName?: string;
-  /** Full stack trace of the error that was raised. */
+  /** A more detailed message explaining the error. */message?: string; /** Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created. */
+  resourceName?: string; /** Full stack trace of the error that was raised. */
   stack?: string;
 };
 /**
  * The theme model.
  */
 type Theme = {
-  /** Author of the theme. */
-  author?: string;
-  readonly createdAt?: string;
-  /** Map of dependencies describing version of the component it requires. */
-  dependencies?: unknown;
-  /** Description of the theme. */
-  description?: string;
-  /** The file that was uploaded with the theme. */
-  file?: unknown;
-  /** Home page of the theme. */
-  homepage?: string;
-  /** Icon to show in the client. */
+  /** Author of the theme. */author?: string;
+  readonly createdAt?: string; /** Map of dependencies describing version of the component it requires. */
+  dependencies?: unknown; /** Description of the theme. */
+  description?: string; /** The file that was uploaded with the theme. */
+  file?: unknown; /** Home page of the theme. */
+  homepage?: string; /** Icon to show in the client. */
   icon?: string;
-  readonly id?: string;
-  /** Keywords for the theme. */
-  keywords?: string;
-  /** Under which license this theme is published. */
-  license?: string;
-  /** The display name of this theme. */
-  name?: string;
-  /** The name of the qext file that was uploaded with this theme. */
-  qextFilename?: string;
-  /** The version from the qext file that was uploaded with this extension. */
-  qextVersion?: string;
-  /** Link to the theme source code. */
-  repository?: string;
-  /** Supplier of the theme. */
-  supplier?: string;
-  /** List of tags. */
+  readonly id?: string; /** Keywords for the theme. */
+  keywords?: string; /** Under which license this theme is published. */
+  license?: string; /** The display name of this theme. */
+  name?: string; /** The name of the qext file that was uploaded with this theme. */
+  qextFilename?: string; /** The version from the qext file that was uploaded with this extension. */
+  qextVersion?: string; /** Link to the theme source code. */
+  repository?: string; /** Supplier of the theme. */
+  supplier?: string; /** List of tags. */
   tags?: string[];
-  readonly tenantId?: string;
-  /** The type of this theme (visualization, etc.). */
+  readonly tenantId?: string; /** The type of this theme (visualization, etc.). */
   type?: string;
   readonly updateAt?: string;
-  readonly userId?: string;
-  /** Version of the theme. */
+  readonly userId?: string; /** Version of the theme. */
   version?: string;
 };
 type Themes = {
@@ -96,9 +72,7 @@ type GetThemesHttpError = {
  * @throws UploadThemeHttpError
  */
 declare function uploadTheme(body: {
-  /** The theme model. */
-  data?: Theme;
-  /** Theme archive. */
+  /** The theme model. */data?: Theme; /** Theme archive. */
   file?: BodyInit;
 }, options?: ApiCallOptions): Promise<UploadThemeHttpResponse>;
 type UploadThemeHttpResponse = {
@@ -153,9 +127,7 @@ type GetThemeHttpError = {
  * @throws PatchThemeHttpError
  */
 declare function patchTheme(id: string, body: {
-  /** The theme model. */
-  data?: Theme;
-  /** Theme archive. */
+  /** The theme model. */data?: Theme; /** Theme archive. */
   file?: BodyInit;
 }, options?: ApiCallOptions): Promise<PatchThemeHttpResponse>;
 type PatchThemeHttpResponse = {
@@ -176,7 +148,7 @@ type PatchThemeHttpError = {
  */
 declare function downloadTheme(id: string, options?: ApiCallOptions): Promise<DownloadThemeHttpResponse>;
 type DownloadThemeHttpResponse = {
-  data: void;
+  data: DownloadableBlob;
   headers: Headers;
   status: 200;
 };

package/themes.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-QhLPeQr5.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/themes.ts
 /**
@@ -125,7 +125,6 @@ const themesExport = {
 	downloadFileFromTheme,
 	clearCache
 };
-var themes_default = themesExport;
 
 //#endregion
-export { clearCache, themes_default as default, deleteTheme, downloadFileFromTheme, downloadTheme, getTheme, getThemes, patchTheme, uploadTheme };
+export { clearCache, themesExport as default, deleteTheme, downloadFileFromTheme, downloadTheme, getTheme, getThemes, patchTheme, uploadTheme };

package/transports.d.ts

@@ -1,12 +1,10 @@
-import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
 
 //#region src/public/rest/transports.d.ts
 type DeleteConfigNotFoundError = {
   errors?: {
-    /** The error code. */
-    code: string;
-    /** Summary of the problem */
+    /** The error code. */code: string; /** Summary of the problem */
     title: string;
   }[];
 };
@@ -14,9 +12,7 @@ type DeleteConfigNotFoundError = {
  * An error object.
  */
 type ErrorPublic = {
-  /** The error code. */
-  code: string;
-  /** Summary of the problem. */
+  /** The error code. */code: string; /** Summary of the problem. */
   title: string;
 };
 type ErrorsPublic = {
@@ -24,53 +20,39 @@ type ErrorsPublic = {
 };
 type SendTestMailConfigNotFoundError = {
   errors?: {
-    /** The error code. */
-    code: string;
-    /** Summary of the problem */
+    /** The error code. */code: string; /** Summary of the problem */
     title: string;
   }[];
 };
 type TenantAdminError = {
   errors?: {
-    /** The error code. */
-    code: string;
-    /** Summary of the problem */
+    /** The error code. */code: string; /** Summary of the problem */
     title: string;
   }[];
 };
 type UpdateEmailConfigError = {
   errors?: {
-    /** The error code. */
-    code: string;
-    /** Summary of the problem */
+    /** The error code. */code: string; /** Summary of the problem */
     title: string;
   }[];
 };
 type VerifyConnectionConfigNotFoundError = {
   errors?: {
-    /** The error code. */
-    code: string;
-    /** Summary of the problem */
+    /** The error code. */code: string; /** Summary of the problem */
     title: string;
   }[];
 };
 type Email = {
-  /** email body */
-  body?: string;
-  /** email recipient (email address) */
-  recipient?: string;
-  /** email subject */
+  /** email body */body?: string; /** email recipient (email address) */
+  recipient?: string; /** 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";
-  /** The path for the given resource field to patch. */
-  path: "/username" | "/serverAddress" | "/serverPort" | "/securityType" | "/emailAddress" | "/emailPassword";
-  /** The value to be used for this operation. */
+  /** The operation to be performed. */op: "replace, remove, add"; /** The path for the given resource field to patch. */
+  path: "/username" | "/serverAddress" | "/serverPort" | "/securityType" | "/emailAddress" | "/emailPassword"; /** The value to be used for this operation. */
   value: string;
 };
 /**
@@ -84,117 +66,75 @@ type EmailConfigFieldPatch = {
  */
 type EmailConfigPatch = EmailConfigFieldPatch[];
 type GetBasicAuthConfig = {
-  /** The email address that should appear in From field when sending emails with this account */
-  emailAddress?: string;
-  /** The selected SMTP security mechanism. Could be either 'none', 'StartTLS' or 'SSL/TLS' */
-  securityType?: string;
-  /** The name that should appear in From field when sending emails with this account */
-  senderName?: string;
-  /** domain name or IP address of SMTP server */
-  serverAddress?: string;
-  /** smtp server port */
-  serverPort?: number;
-  /** user name used for SMTP login */
+  /** The email address that should appear in From field when sending emails with this account */emailAddress?: string; /** The selected SMTP security mechanism. Could be either 'none', 'StartTLS' or 'SSL/TLS' */
+  securityType?: string; /** The name that should appear in From field when sending emails with this account */
+  senderName?: string; /** domain name or IP address of SMTP server */
+  serverAddress?: string; /** smtp server port */
+  serverPort?: number; /** user name used for SMTP login */
   username?: string;
 };
 type GetEmailConfig = {
-  /** Number of authentication failures */
-  authFailures?: number;
-  /** used for SMTP authentication */
-  emailAddress?: string;
-  /** Indicates error with this email configuration. OK means that no error is indicated. Possible values are OK, CONFIG_NOT_SET, INCOMPLETE_CONFIG, INVALID_CREDENTIALS, PROVIDER_ERROR */
-  errorCode?: string;
-  /** Is the configuration valid */
+  /** Number of authentication failures */authFailures?: number; /** used for SMTP authentication */
+  emailAddress?: string; /** Indicates error with this email configuration. OK means that no error is indicated. Possible values are OK, CONFIG_NOT_SET, INCOMPLETE_CONFIG, INVALID_CREDENTIALS, PROVIDER_ERROR */
+  errorCode?: string; /** Is the configuration valid */
   isValid?: boolean;
-  lastUpdated?: string;
-  /** Last modification time. Formatted as a ISO 8601 string. */
-  modificationTime?: string;
-  /** Indicates if password is defined for this smtp config. The password itself is not returned! */
+  lastUpdated?: string; /** Last modification time. Formatted as a ISO 8601 string. */
+  modificationTime?: string; /** Indicates if password is defined for this smtp config. The password itself is not returned! */
   passwordExists?: boolean;
-  providerConfig?: GetMicrosoft365Config | GetBasicAuthConfig;
-  /** one of none, StartTLS or SSL/TLS */
-  securityType?: string;
-  /** domain name or IP address of SMTP server */
-  serverAddress?: string;
-  /** smtp server listening port */
-  serverPort?: number;
-  /** Name of the service provider for authentication */
-  serviceProvider?: "Microsoft365" | "BasicAuth";
-  /** Contains statusCode and statusReason */
-  status?: SmtpConfigStatus;
-  /** The tenant Id */
-  tenantId?: string;
-  /** user name */
+  providerConfig?: GetMicrosoft365Config | GetBasicAuthConfig; /** one of none, StartTLS or SSL/TLS */
+  securityType?: string; /** domain name or IP address of SMTP server */
+  serverAddress?: string; /** smtp server listening port */
+  serverPort?: number; /** Name of the service provider for authentication */
+  serviceProvider?: "Microsoft365" | "BasicAuth"; /** Contains statusCode and statusReason */
+  status?: SmtpConfigStatus; /** The tenant Id */
+  tenantId?: string; /** user name */
   username?: string;
 };
 type GetMicrosoft365Config = {
-  /** Microsoft365 client identifier */
-  clientId?: string;
-  /** The email address that should appear in From field when sending emails with this account */
-  emailAddress?: string;
-  /** Microsoft365 tenant identifier */
+  /** Microsoft365 client identifier */clientId?: string; /** The email address that should appear in From field when sending emails with this account */
+  emailAddress?: string; /** Microsoft365 tenant identifier */
   providerTenantId?: string;
 };
 /**
  * SMTP basic authentication configuration. Provides server address, credentials, and sender information for standard SMTP email delivery.
  */
 type PutBasicAuthConfig = {
-  /** The email address that should appear in From field when sending emails with this account */
-  emailAddress?: string;
-  /** password for SMTP basic authentication */
-  emailPassword?: string;
-  /** SMTP security mechanism to use. Could be either 'none', 'StartTLS' or 'SSL/TLS' */
-  securityType?: string;
-  /** The name that should appear in From field when sending emails with this account */
-  senderName?: string;
-  /** domain name or IP address of SMTP server */
-  serverAddress?: string;
-  /** smtp server port */
-  serverPort?: number;
-  /** user name used for SMTP login */
+  /** The email address that should appear in From field when sending emails with this account */emailAddress?: string; /** password for SMTP basic authentication */
+  emailPassword?: string; /** SMTP security mechanism to use. Could be either 'none', 'StartTLS' or 'SSL/TLS' */
+  securityType?: string; /** The name that should appear in From field when sending emails with this account */
+  senderName?: string; /** domain name or IP address of SMTP server */
+  serverAddress?: string; /** smtp server port */
+  serverPort?: number; /** user name used for SMTP login */
   username?: string;
 };
 type PutEmailConfig = {
-  providerConfig?: PutMicrosoft365Config | PutBasicAuthConfig;
-  /** Name of the service provider for authentication */
+  providerConfig?: PutMicrosoft365Config | PutBasicAuthConfig; /** Name of the service provider for authentication */
   serviceProvider?: "Microsoft365" | "BasicAuth";
 };
 /**
  * Microsoft 365 authentication configuration. Provides OAuth credentials and tenant information for Microsoft 365 email delivery.
  */
 type PutMicrosoft365Config = {
-  /** Microsoft365 client identifier */
-  clientId?: string;
-  /** secret to authenticate the Microsoft365 account */
-  clientSecret?: string;
-  /** The email address that should appear in From field when sending emails with this account */
-  emailAddress?: string;
-  /** Microsoft365 tenant identifier */
+  /** Microsoft365 client identifier */clientId?: string; /** secret to authenticate the Microsoft365 account */
+  clientSecret?: string; /** The email address that should appear in From field when sending emails with this account */
+  emailAddress?: string; /** Microsoft365 tenant identifier */
   providerTenantId?: string;
 };
 type SmtpCheck = {
-  /** Indicates error with this email configuration. OK means that no error is indicated. Possible values are OK, CONFIG_NOT_SET, INCOMPLETE_CONFIG, INVALID_CREDENTIALS, PROVIDER_ERROR */
-  errorCode?: string;
-  /** true if smtp config is correct and complete. Will return false if smtp-config does not exist at all */
+  /** Indicates error with this email configuration. OK means that no error is indicated. Possible values are OK, CONFIG_NOT_SET, INCOMPLETE_CONFIG, INVALID_CREDENTIALS, PROVIDER_ERROR */errorCode?: string; /** 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;
-  /** Status reason */
+  /** Status code */statusCode?: number; /** Status reason */
   statusReason?: string;
 };
 type SmtpResult = {
-  /** could not resolve domain name, connection refused, connection timed out, SSL mismatch */
-  connectionFailed?: boolean;
-  /** error message from SMTP middleware .. a bit technical but could be useful to administrator */
-  message?: string;
-  /** smtp result code string from the SMTP server. eg. "250 2.6.0" */
-  smtpResponseCode?: number;
-  /** was SMTP operation successful or not. Other fields herein provide more detail */
+  /** could not resolve domain name, connection refused, connection timed out, SSL mismatch */connectionFailed?: boolean; /** error message from SMTP middleware .. a bit technical but could be useful to administrator */
+  message?: string; /** smtp result code string from the SMTP server. eg. "250 2.6.0" */
+  smtpResponseCode?: number; /** was SMTP operation successful or not. Other fields herein provide more detail */
   success?: boolean;
 };
 /**

package/transports.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-QhLPeQr5.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/transports.ts
 /**
@@ -116,7 +116,6 @@ const transportsExport = {
 	verifyEmailConfigConnection,
 	clearCache
 };
-var transports_default = transportsExport;
 
 //#endregion
-export { clearCache, transports_default as default, deleteEmailConfig, getEmailConfig, patchEmailConfig, sendTestEmail, updateEmailConfig, validateEmailConfig, verifyEmailConfigConnection };
+export { clearCache, transportsExport as default, deleteEmailConfig, getEmailConfig, patchEmailConfig, sendTestEmail, updateEmailConfig, validateEmailConfig, verifyEmailConfigConnection };

package/ui-config.d.ts

@@ -1,26 +1,20 @@
-import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.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`. */
+  /** 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. */
+  /** 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. */
+  /** Error code. */readonly code?: number; /** Error cause. */
   readonly message?: string;
 };
 type ErrorResponse403 = {
@@ -33,21 +27,18 @@ type ErrorResponse403 = {
 };
 type JSONPatchPinnedLinkPayload = {
   op: "replace";
-  path: "/name" | "/link";
-  /** The value to be used for this operation. */
+  path: "/name" | "/link"; /** The value to be used for this operation. */
   value: string;
 }[];
 type PinnedLink = {
-  /** Date string */
-  createdAt: string;
+  /** Date string */createdAt: string;
   createdBy: string;
   id: string;
   link: string;
   name: string;
   scope: "user" | "tenant";
   tenantId: string;
-  type: "custom-link";
-  /** Date string */
+  type: "custom-link"; /** Date string */
   updatedAt?: string;
   updatedBy?: string;
 };

package/ui-config.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-QhLPeQr5.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/ui-config.ts
 /**
@@ -120,7 +120,6 @@ const uiConfigExport = {
 	patchUiConfigPinnedLink,
 	clearCache
 };
-var ui_config_default = uiConfigExport;
 
 //#endregion
-export { clearCache, createUiConfigPinnedLink, createUiConfigPinnedLinks, ui_config_default as default, deleteAllUiConfigPinnedLinks, deleteUiConfigPinnedLink, getUiConfigPinnedLink, getUiConfigPinnedLinks, patchUiConfigPinnedLink };
+export { clearCache, createUiConfigPinnedLink, createUiConfigPinnedLinks, uiConfigExport as default, deleteAllUiConfigPinnedLinks, deleteUiConfigPinnedLink, getUiConfigPinnedLink, getUiConfigPinnedLinks, patchUiConfigPinnedLink };