@qlik/api 2.2.0 → 2.3.0

package/chunks/themes-v9NbhiBo.d.ts

@@ -1,269 +0,0 @@
-import { y as ApiCallOptions } from "./auth-types-E99tzdN0.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;
-};
-/**
- * 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. */
-  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. */
-  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. */
-  tags?: string[];
-  readonly tenantId?: string;
-  /** The type of this theme (visualization, etc.). */
-  type?: string;
-  readonly updateAt?: string;
-  readonly userId?: string;
-  /** Version of the theme. */
-  version?: string;
-};
-type Themes = {
-  data: Theme[];
-};
-/**
- * Lists all imported themes in the tenant.
- *
- * @throws GetThemesHttpError
- */
-declare function getThemes(options?: ApiCallOptions): Promise<GetThemesHttpResponse>;
-type GetThemesHttpResponse = {
-  data: Themes;
-  headers: Headers;
-  status: 200;
-};
-type GetThemesHttpError = {
-  data: unknown;
-  headers: Headers;
-  status: number;
-};
-/**
- * Creates a new theme. Accepts either provided file or data object. The name of the new theme must be different to any existing themes.
- *
- * @param body an object with the body content
- * @throws UploadThemeHttpError
- */
-declare function uploadTheme(body: {
-  /** The theme model. */
-  data?: Theme;
-  /** Theme archive. */
-  file?: BodyInit;
-}, options?: ApiCallOptions): Promise<UploadThemeHttpResponse>;
-type UploadThemeHttpResponse = {
-  data: Theme;
-  headers: Headers;
-  status: 201;
-};
-type UploadThemeHttpError = {
-  data: Error;
-  headers: Headers;
-  status: number;
-};
-/**
- * Deletes a specific theme matching either theme ID or theme name.
- *
- * @param id Theme identifier or its qextFilename.
- * @throws DeleteThemeHttpError
- */
-declare function deleteTheme(id: string, options?: ApiCallOptions): Promise<DeleteThemeHttpResponse>;
-type DeleteThemeHttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 204;
-};
-type DeleteThemeHttpError = {
-  data: Error;
-  headers: Headers;
-  status: 403 | 404 | 410;
-};
-/**
- * Returns a specific theme matching either theme ID or theme name.
- *
- * @param id Theme identifier or its qextFilename
- * @throws GetThemeHttpError
- */
-declare function getTheme(id: string, options?: ApiCallOptions): Promise<GetThemeHttpResponse>;
-type GetThemeHttpResponse = {
-  data: Theme;
-  headers: Headers;
-  status: 200;
-};
-type GetThemeHttpError = {
-  data: Error;
-  headers: Headers;
-  status: 403 | 404 | 410;
-};
-/**
- * Updates a specific theme matching either theme ID or theme name. Accepts either provided file or data object.
- *
- * @param id Theme identifier or its qextFilename.
- * @param body an object with the body content
- * @throws PatchThemeHttpError
- */
-declare function patchTheme(id: string, body: {
-  /** The theme model. */
-  data?: Theme;
-  /** Theme archive. */
-  file?: BodyInit;
-}, options?: ApiCallOptions): Promise<PatchThemeHttpResponse>;
-type PatchThemeHttpResponse = {
-  data: Themes;
-  headers: Headers;
-  status: 200;
-};
-type PatchThemeHttpError = {
-  data: Error;
-  headers: Headers;
-  status: number;
-};
-/**
- * Downloads all files in the theme matching either theme ID or theme name as a `.zip` archive.
- *
- * @param id Theme identifier or its qextFilename
- * @throws DownloadThemeHttpError
- */
-declare function downloadTheme(id: string, options?: ApiCallOptions): Promise<DownloadThemeHttpResponse>;
-type DownloadThemeHttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 200;
-};
-type DownloadThemeHttpError = {
-  data: Error;
-  headers: Headers;
-  status: 403 | 404 | 410;
-};
-/**
- * Downloads a file from the theme matching either theme ID or theme name, identified by the file path within the imported extension.
- *
- * @param id Theme identifier or its qextFilename.
- * @param filepath Path to the file location within the specified theme archive. Folders separated with forward slashes.
- * @throws DownloadFileFromThemeHttpError
- */
-declare function downloadFileFromTheme(id: string, filepath: string, options?: ApiCallOptions): Promise<DownloadFileFromThemeHttpResponse>;
-type DownloadFileFromThemeHttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 200;
-};
-type DownloadFileFromThemeHttpError = {
-  data: Error;
-  headers: Headers;
-  status: 403 | 404 | 410;
-};
-/**
- * Clears the cache for themes api requests.
- */
-declare function clearCache(): void;
-type ThemesAPI = {
-  /**
-   * Lists all imported themes in the tenant.
-   *
-   * @throws GetThemesHttpError
-   */
-  getThemes: typeof getThemes;
-  /**
-   * Creates a new theme. Accepts either provided file or data object. The name of the new theme must be different to any existing themes.
-   *
-   * @param body an object with the body content
-   * @throws UploadThemeHttpError
-   */
-  uploadTheme: typeof uploadTheme;
-  /**
-   * Deletes a specific theme matching either theme ID or theme name.
-   *
-   * @param id Theme identifier or its qextFilename.
-   * @throws DeleteThemeHttpError
-   */
-  deleteTheme: typeof deleteTheme;
-  /**
-   * Returns a specific theme matching either theme ID or theme name.
-   *
-   * @param id Theme identifier or its qextFilename
-   * @throws GetThemeHttpError
-   */
-  getTheme: typeof getTheme;
-  /**
-   * Updates a specific theme matching either theme ID or theme name. Accepts either provided file or data object.
-   *
-   * @param id Theme identifier or its qextFilename.
-   * @param body an object with the body content
-   * @throws PatchThemeHttpError
-   */
-  patchTheme: typeof patchTheme;
-  /**
-   * Downloads all files in the theme matching either theme ID or theme name as a `.zip` archive.
-   *
-   * @param id Theme identifier or its qextFilename
-   * @throws DownloadThemeHttpError
-   */
-  downloadTheme: typeof downloadTheme;
-  /**
-   * Downloads a file from the theme matching either theme ID or theme name, identified by the file path within the imported extension.
-   *
-   * @param id Theme identifier or its qextFilename.
-   * @param filepath Path to the file location within the specified theme archive. Folders separated with forward slashes.
-   * @throws DownloadFileFromThemeHttpError
-   */
-  downloadFileFromTheme: typeof downloadFileFromTheme;
-  /**
-   * Clears the cache for themes api requests.
-   */
-  clearCache: typeof clearCache;
-};
-/**
- * Functions for the themes api
- */
-declare const themesExport: ThemesAPI;
-//#endregion
-export { downloadTheme as C, themesExport as D, patchTheme as E, uploadTheme as O, downloadFileFromTheme as S, getThemes as T, ThemesAPI as _, DownloadThemeHttpError as a, clearCache as b, GetThemeHttpError as c, GetThemesHttpResponse as d, Meta as f, Themes as g, Theme as h, DownloadFileFromThemeHttpResponse as i, GetThemeHttpResponse as l, PatchThemeHttpResponse as m, DeleteThemeHttpResponse as n, DownloadThemeHttpResponse as o, PatchThemeHttpError as p, DownloadFileFromThemeHttpError as r, Error as s, DeleteThemeHttpError as t, GetThemesHttpError as u, UploadThemeHttpError as v, getTheme as w, deleteTheme as x, UploadThemeHttpResponse as y };

package/chunks/transports-CqEiFxD3.d.ts

@@ -1,362 +0,0 @@
-import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
-
-//#region src/public/rest/transports.d.ts
-type DeleteConfigNotFoundError = {
-  errors?: {
-    /** The error code. */
-    code: string;
-    /** Summary of the problem */
-    title: string;
-  }[];
-};
-/**
- * An error object.
- */
-type ErrorPublic = {
-  /** The error code. */
-  code: string;
-  /** Summary of the problem. */
-  title: string;
-};
-type ErrorsPublic = {
-  errors?: ErrorPublic[];
-};
-type SendTestMailConfigNotFoundError = {
-  errors?: {
-    /** The error code. */
-    code: string;
-    /** Summary of the problem */
-    title: string;
-  }[];
-};
-type TenantAdminError = {
-  errors?: {
-    /** The error code. */
-    code: string;
-    /** Summary of the problem */
-    title: string;
-  }[];
-};
-type UpdateEmailConfigError = {
-  errors?: {
-    /** The error code. */
-    code: string;
-    /** Summary of the problem */
-    title: string;
-  }[];
-};
-type VerifyConnectionConfigNotFoundError = {
-  errors?: {
-    /** 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 */
-  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. */
-  value: string;
-};
-/**
- * @example
- * [
- *   {
- *     path: "/username",
- *     value: "New name"
- *   }
- * ]
- */
-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 */
-  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 */
-  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! */
-  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 */
-  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 */
-  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 */
-  isValid?: boolean;
-};
-/**
- * Contains statusCode and statusReason
- */
-type SmtpConfigStatus = {
-  /** 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 */
-  success?: boolean;
-};
-/**
- * Deletes the email configuration for the tenant.
- *
- * @throws DeleteEmailConfigHttpError
- */
-declare function deleteEmailConfig(options?: ApiCallOptions): Promise<DeleteEmailConfigHttpResponse>;
-type DeleteEmailConfigHttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 204;
-};
-type DeleteEmailConfigHttpError = DeleteEmailConfig403HttpError | DeleteEmailConfig404HttpError | DeleteEmailConfigdefaultHttpError;
-type DeleteEmailConfig403HttpError = {
-  data: TenantAdminError;
-  headers: Headers;
-  status: 403;
-};
-type DeleteEmailConfig404HttpError = {
-  data: DeleteConfigNotFoundError;
-  headers: Headers;
-  status: 404;
-};
-type DeleteEmailConfigdefaultHttpError = {
-  data: ErrorsPublic;
-  headers: Headers;
-  status: "default";
-};
-/**
- * Returns the current email configuration and configuration status for the tenant.
- *
- * @throws GetEmailConfigHttpError
- */
-declare function getEmailConfig(options?: ApiCallOptions): Promise<GetEmailConfigHttpResponse>;
-type GetEmailConfigHttpResponse = {
-  data: GetEmailConfig;
-  headers: Headers;
-  status: 200;
-};
-type GetEmailConfigHttpError = GetEmailConfig403HttpError | GetEmailConfigdefaultHttpError;
-type GetEmailConfig403HttpError = {
-  data: TenantAdminError;
-  headers: Headers;
-  status: 403;
-};
-type GetEmailConfigdefaultHttpError = {
-  data: ErrorsPublic;
-  headers: Headers;
-  status: "default";
-};
-/**
- * @deprecated
- *
- * Patch the email configuration for the tenant.
- *
- * @param body an object with the body content
- * @throws PatchEmailConfigHttpError
- */
-declare function patchEmailConfig(body: EmailConfigPatch, options?: ApiCallOptions): Promise<PatchEmailConfigHttpResponse>;
-type PatchEmailConfigHttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 204;
-};
-type PatchEmailConfigHttpError = PatchEmailConfig400HttpError | PatchEmailConfig403HttpError | PatchEmailConfigdefaultHttpError;
-type PatchEmailConfig400HttpError = {
-  data: UpdateEmailConfigError;
-  headers: Headers;
-  status: 400;
-};
-type PatchEmailConfig403HttpError = {
-  data: TenantAdminError;
-  headers: Headers;
-  status: 403;
-};
-type PatchEmailConfigdefaultHttpError = {
-  data: ErrorsPublic;
-  headers: Headers;
-  status: "default";
-};
-/**
- * Attempts to sends a test email using the active configuration, with the supplied email info (subject, body, recipient).
- *
- * @param body an object with the body content
- * @throws SendTestEmailHttpError
- */
-declare function sendTestEmail(body: Email, options?: ApiCallOptions): Promise<SendTestEmailHttpResponse>;
-type SendTestEmailHttpResponse = {
-  data: SmtpResult;
-  headers: Headers;
-  status: 200;
-};
-type SendTestEmailHttpError = SendTestEmail403HttpError | SendTestEmail404HttpError | SendTestEmaildefaultHttpError;
-type SendTestEmail403HttpError = {
-  data: TenantAdminError;
-  headers: Headers;
-  status: 403;
-};
-type SendTestEmail404HttpError = {
-  data: SendTestMailConfigNotFoundError;
-  headers: Headers;
-  status: 404;
-};
-type SendTestEmaildefaultHttpError = {
-  data: ErrorsPublic;
-  headers: Headers;
-  status: "default";
-};
-/**
- * Returns the current isValid value for the email configuration for the tenant. Does not attempt to connect to a server to verify the connection or send a test email. Will return false if no email configuration exists.
- *
- * @throws ValidateEmailConfigHttpError
- */
-declare function validateEmailConfig(options?: ApiCallOptions): Promise<ValidateEmailConfigHttpResponse>;
-type ValidateEmailConfigHttpResponse = {
-  data: SmtpCheck;
-  headers: Headers;
-  status: 200;
-};
-type ValidateEmailConfigHttpError = {
-  data: ErrorsPublic;
-  headers: Headers;
-  status: number;
-};
-/**
- * Attempts to verify connection to email server using a low-level protocol handshake to confirm the server is reachable and the credentials are valid, without sending a test email.
- *
- * @throws VerifyEmailConfigConnectionHttpError
- */
-declare function verifyEmailConfigConnection(options?: ApiCallOptions): Promise<VerifyEmailConfigConnectionHttpResponse>;
-type VerifyEmailConfigConnectionHttpResponse = {
-  data: SmtpResult;
-  headers: Headers;
-  status: 200;
-};
-type VerifyEmailConfigConnectionHttpError = VerifyEmailConfigConnection404HttpError | VerifyEmailConfigConnectiondefaultHttpError;
-type VerifyEmailConfigConnection404HttpError = {
-  data: VerifyConnectionConfigNotFoundError;
-  headers: Headers;
-  status: 404;
-};
-type VerifyEmailConfigConnectiondefaultHttpError = {
-  data: ErrorsPublic;
-  headers: Headers;
-  status: "default";
-};
-/**
- * Clears the cache for transports api requests.
- */
-declare function clearCache(): void;
-type TransportsAPI = {
-  /**
-   * Deletes the email configuration for the tenant.
-   *
-   * @throws DeleteEmailConfigHttpError
-   */
-  deleteEmailConfig: typeof deleteEmailConfig;
-  /**
-   * Returns the current email configuration and configuration status for the tenant.
-   *
-   * @throws GetEmailConfigHttpError
-   */
-  getEmailConfig: typeof getEmailConfig;
-  /**
-   * @deprecated
-   *
-   * Patch the email configuration for the tenant.
-   *
-   * @param body an object with the body content
-   * @throws PatchEmailConfigHttpError
-   */
-  patchEmailConfig: typeof patchEmailConfig;
-  /**
-   * Attempts to sends a test email using the active configuration, with the supplied email info (subject, body, recipient).
-   *
-   * @param body an object with the body content
-   * @throws SendTestEmailHttpError
-   */
-  sendTestEmail: typeof sendTestEmail;
-  /**
-   * Returns the current isValid value for the email configuration for the tenant. Does not attempt to connect to a server to verify the connection or send a test email. Will return false if no email configuration exists.
-   *
-   * @throws ValidateEmailConfigHttpError
-   */
-  validateEmailConfig: typeof validateEmailConfig;
-  /**
-   * Attempts to verify connection to email server using a low-level protocol handshake to confirm the server is reachable and the credentials are valid, without sending a test email.
-   *
-   * @throws VerifyEmailConfigConnectionHttpError
-   */
-  verifyEmailConfigConnection: typeof verifyEmailConfigConnection;
-  /**
-   * Clears the cache for transports api requests.
-   */
-  clearCache: typeof clearCache;
-};
-/**
- * Functions for the transports api
- */
-declare const transportsExport: TransportsAPI;
-//#endregion
-export { SmtpCheck as A, VerifyEmailConfigConnectionHttpError as B, PatchEmailConfigdefaultHttpError as C, SendTestEmailHttpResponse as D, SendTestEmailHttpError as E, UpdateEmailConfigError as F, getEmailConfig as G, VerifyEmailConfigConnectiondefaultHttpError as H, ValidateEmailConfigHttpError as I, transportsExport as J, patchEmailConfig as K, ValidateEmailConfigHttpResponse as L, SmtpResult as M, TenantAdminError as N, SendTestEmaildefaultHttpError as O, TransportsAPI as P, VerifyConnectionConfigNotFoundError as R, PatchEmailConfigHttpResponse as S, SendTestEmail404HttpError as T, clearCache as U, VerifyEmailConfigConnectionHttpResponse as V, deleteEmailConfig as W, verifyEmailConfigConnection as X, validateEmailConfig as Y, GetEmailConfigdefaultHttpError as _, DeleteEmailConfigHttpResponse as a, PatchEmailConfig403HttpError as b, EmailConfigFieldPatch as c, ErrorsPublic as d, GetBasicAuthConfig as f, GetEmailConfigHttpResponse as g, GetEmailConfigHttpError as h, DeleteEmailConfigHttpError as i, SmtpConfigStatus as j, SendTestMailConfigNotFoundError as k, EmailConfigPatch as l, GetEmailConfig403HttpError as m, DeleteEmailConfig403HttpError as n, DeleteEmailConfigdefaultHttpError as o, GetEmailConfig as p, sendTestEmail as q, DeleteEmailConfig404HttpError as r, Email as s, DeleteConfigNotFoundError as t, ErrorPublic as u, GetMicrosoft365Config as v, SendTestEmail403HttpError as w, PatchEmailConfigHttpError as x, PatchEmailConfig400HttpError as y, VerifyEmailConfigConnection404HttpError as z };