@qlik/api 0.0.16 → 0.1.0

package/themes.d.mts

@@ -1,268 +0,0 @@
-import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
-import './auth-types-nnUcWhuU.mjs';
-
-/**
- * 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 themes.
- *
- * @throws GetThemesHttpError
- */
-declare const getThemes: (options?: ApiCallOptions) => Promise<GetThemesHttpResponse>;
-type GetThemesHttpResponse = {
-    data: Themes;
-    headers: Headers;
-    status: number;
-};
-type GetThemesHttpError = {
-    data: unknown;
-    headers: Headers;
-    status: number;
-};
-/**
- * Creates a new theme. If a file is provided, the data field is not required.
- *
- * @param body an object with the body content
- * @throws UploadThemeHttpError
- */
-declare const uploadTheme: (body: {
-    /** The theme model. */
-    data?: Theme;
-    /** Theme archive. */
-    file?: BodyInit;
-}, options?: ApiCallOptions) => Promise<UploadThemeHttpResponse>;
-type UploadThemeHttpResponse = {
-    data: Theme;
-    headers: Headers;
-    status: number;
-};
-type UploadThemeHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Deletes a specific theme.
- *
- * @param id Theme identifier or its qextFilename.
- * @throws DeleteThemeHttpError
- */
-declare const deleteTheme: (id: string, options?: ApiCallOptions) => Promise<DeleteThemeHttpResponse>;
-type DeleteThemeHttpResponse = {
-    data: void;
-    headers: Headers;
-    status: number;
-};
-type DeleteThemeHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Returns a specific theme.
- *
- * @param id Theme identifier or its qextFilename
- * @throws GetThemeHttpError
- */
-declare const getTheme: (id: string, options?: ApiCallOptions) => Promise<GetThemeHttpResponse>;
-type GetThemeHttpResponse = {
-    data: Theme;
-    headers: Headers;
-    status: number;
-};
-type GetThemeHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Updates a specific theme with provided data. If a file is provided, the data field is not required.
- *
- * @param id Theme identifier or its qextFilename.
- * @param body an object with the body content
- * @throws PatchThemeHttpError
- */
-declare const patchTheme: (id: string, body: {
-    /** The theme model. */
-    data?: Theme;
-    /** Theme archive. */
-    file?: BodyInit;
-}, options?: ApiCallOptions) => Promise<PatchThemeHttpResponse>;
-type PatchThemeHttpResponse = {
-    data: Themes;
-    headers: Headers;
-    status: number;
-};
-type PatchThemeHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Downloads the theme as an archive.
- *
- * @param id Theme identifier or its qextFilename
- * @throws DownloadThemeHttpError
- */
-declare const downloadTheme: (id: string, options?: ApiCallOptions) => Promise<DownloadThemeHttpResponse>;
-type DownloadThemeHttpResponse = {
-    data: void;
-    headers: Headers;
-    status: number;
-};
-type DownloadThemeHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Downloads a file from the theme archive.
- *
- * @param id Theme identifier or its qextFilename.
- * @param filepath Path to the file archive for the specified theme archive. Folders separated with forward slashes.
- * @throws DownloadFileFromThemeHttpError
- */
-declare const downloadFileFromTheme: (id: string, filepath: string, options?: ApiCallOptions) => Promise<DownloadFileFromThemeHttpResponse>;
-type DownloadFileFromThemeHttpResponse = {
-    data: void;
-    headers: Headers;
-    status: number;
-};
-type DownloadFileFromThemeHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Clears the cache for themes api requests.
- */
-declare function clearCache(): void;
-interface ThemesAPI {
-    /**
-     * Lists all themes.
-     *
-     * @throws GetThemesHttpError
-     */
-    getThemes: typeof getThemes;
-    /**
-     * Creates a new theme. If a file is provided, the data field is not required.
-     *
-     * @param body an object with the body content
-     * @throws UploadThemeHttpError
-     */
-    uploadTheme: typeof uploadTheme;
-    /**
-     * Deletes a specific theme.
-     *
-     * @param id Theme identifier or its qextFilename.
-     * @throws DeleteThemeHttpError
-     */
-    deleteTheme: typeof deleteTheme;
-    /**
-     * Returns a specific theme.
-     *
-     * @param id Theme identifier or its qextFilename
-     * @throws GetThemeHttpError
-     */
-    getTheme: typeof getTheme;
-    /**
-     * Updates a specific theme with provided data. If a file is provided, the data field is not required.
-     *
-     * @param id Theme identifier or its qextFilename.
-     * @param body an object with the body content
-     * @throws PatchThemeHttpError
-     */
-    patchTheme: typeof patchTheme;
-    /**
-     * Downloads the theme as an archive.
-     *
-     * @param id Theme identifier or its qextFilename
-     * @throws DownloadThemeHttpError
-     */
-    downloadTheme: typeof downloadTheme;
-    /**
-     * Downloads a file from the theme archive.
-     *
-     * @param id Theme identifier or its qextFilename.
-     * @param filepath Path to the file archive for 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;
-
-export { type DeleteThemeHttpError, type DeleteThemeHttpResponse, type DownloadFileFromThemeHttpError, type DownloadFileFromThemeHttpResponse, type DownloadThemeHttpError, type DownloadThemeHttpResponse, type Error, type GetThemeHttpError, type GetThemeHttpResponse, type GetThemesHttpError, type GetThemesHttpResponse, type Meta, type PatchThemeHttpError, type PatchThemeHttpResponse, type Theme, type Themes, type ThemesAPI, type UploadThemeHttpError, type UploadThemeHttpResponse, clearCache, themesExport as default, deleteTheme, downloadFileFromTheme, downloadTheme, getTheme, getThemes, patchTheme, uploadTheme };

package/themes.mjs

@@ -1,77 +0,0 @@
-import {
-  clearApiCache,
-  invokeFetch
-} from "./chunks/3YV6X7S6.mjs";
-import "./chunks/EHAANYDL.mjs";
-import "./chunks/VSY5YIQY.mjs";
-
-// src/public/rest/themes.ts
-var getThemes = async (options) => invokeFetch("themes", {
-  method: "get",
-  pathTemplate: "/api/v1/themes",
-  options
-});
-var uploadTheme = async (body, options) => invokeFetch("themes", {
-  method: "post",
-  pathTemplate: "/api/v1/themes",
-  body,
-  contentType: "multipart/form-data",
-  options
-});
-var deleteTheme = async (id, options) => invokeFetch("themes", {
-  method: "delete",
-  pathTemplate: "/api/v1/themes/{id}",
-  pathVariables: { id },
-  options
-});
-var getTheme = async (id, options) => invokeFetch("themes", {
-  method: "get",
-  pathTemplate: "/api/v1/themes/{id}",
-  pathVariables: { id },
-  options
-});
-var patchTheme = async (id, body, options) => invokeFetch("themes", {
-  method: "patch",
-  pathTemplate: "/api/v1/themes/{id}",
-  pathVariables: { id },
-  body,
-  contentType: "multipart/form-data",
-  options
-});
-var downloadTheme = async (id, options) => invokeFetch("themes", {
-  method: "get",
-  pathTemplate: "/api/v1/themes/{id}/file",
-  pathVariables: { id },
-  options
-});
-var downloadFileFromTheme = async (id, filepath, options) => invokeFetch("themes", {
-  method: "get",
-  pathTemplate: "/api/v1/themes/{id}/file/{filepath}",
-  pathVariables: { id, filepath },
-  options
-});
-function clearCache() {
-  return clearApiCache("themes");
-}
-var themesExport = {
-  getThemes,
-  uploadTheme,
-  deleteTheme,
-  getTheme,
-  patchTheme,
-  downloadTheme,
-  downloadFileFromTheme,
-  clearCache
-};
-var themes_default = themesExport;
-export {
-  clearCache,
-  themes_default as default,
-  deleteTheme,
-  downloadFileFromTheme,
-  downloadTheme,
-  getTheme,
-  getThemes,
-  patchTheme,
-  uploadTheme
-};

package/transports.d.mts

@@ -1,319 +0,0 @@
-import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
-import './auth-types-nnUcWhuU.mjs';
-
-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 PatchEmailConfigError = {
-    errors?: {
-        /** The error code. */
-        code: string;
-        /** Summary of the problem */
-        title: string;
-    }[];
-};
-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 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;
-};
-type EmailConfigGet = {
-    /** Number of authentication failures */
-    authFailures?: number;
-    /** used for SMTP authentication */
-    emailAddress?: string;
-    /** Is the configuration valid */
-    isValid?: boolean;
-    /** 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;
-    /** 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;
-    /** Contains statusCode and statusReason */
-    status?: SmtpConfigStatus;
-    /** The tenant Id */
-    tenantId?: string;
-    /** user name */
-    username?: string;
-};
-type EmailConfigPatch = EmailConfigFieldPatch[];
-type SmtpCheck = {
-    /** 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 email configuration for a given tenant id (retrieved from JWT).
- *
- * @throws DeleteEmailConfigHttpError
- */
-declare const deleteEmailConfig: (options?: ApiCallOptions) => Promise<DeleteEmailConfigHttpResponse>;
-type DeleteEmailConfigHttpResponse = {
-    data: void;
-    headers: Headers;
-    status: number;
-};
-type DeleteEmailConfig403HttpError = {
-    data: TenantAdminError;
-    headers: Headers;
-    status: 403;
-};
-type DeleteEmailConfig404HttpError = {
-    data: DeleteConfigNotFoundError;
-    headers: Headers;
-    status: 404;
-};
-type DeleteEmailConfigDefaultHttpError = {
-    data: ErrorsPublic;
-    headers: Headers;
-    status: "default";
-};
-type DeleteEmailConfigHttpError = DeleteEmailConfig403HttpError | DeleteEmailConfig404HttpError | DeleteEmailConfigDefaultHttpError;
-/**
- * Returns the email configuration for a given tenant id (retrieved from JWT).
- *
- * @throws GetEmailConfigHttpError
- */
-declare const getEmailConfig: (options?: ApiCallOptions) => Promise<GetEmailConfigHttpResponse>;
-type GetEmailConfigHttpResponse = {
-    data: EmailConfigGet;
-    headers: Headers;
-    status: number;
-};
-type GetEmailConfig403HttpError = {
-    data: TenantAdminError;
-    headers: Headers;
-    status: 403;
-};
-type GetEmailConfigDefaultHttpError = {
-    data: ErrorsPublic;
-    headers: Headers;
-    status: "default";
-};
-type GetEmailConfigHttpError = GetEmailConfig403HttpError | GetEmailConfigDefaultHttpError;
-/**
- * Patch the email configuration for a given tenant id (retrieved from JWT).
- *
- * @param body an object with the body content
- * @throws PatchEmailConfigHttpError
- */
-declare const patchEmailConfig: (body: EmailConfigPatch, options?: ApiCallOptions) => Promise<PatchEmailConfigHttpResponse>;
-type PatchEmailConfigHttpResponse = {
-    data: void;
-    headers: Headers;
-    status: number;
-};
-type PatchEmailConfig400HttpError = {
-    data: PatchEmailConfigError;
-    headers: Headers;
-    status: 400;
-};
-type PatchEmailConfig403HttpError = {
-    data: TenantAdminError;
-    headers: Headers;
-    status: 403;
-};
-type PatchEmailConfigDefaultHttpError = {
-    data: ErrorsPublic;
-    headers: Headers;
-    status: "default";
-};
-type PatchEmailConfigHttpError = PatchEmailConfig400HttpError | PatchEmailConfig403HttpError | PatchEmailConfigDefaultHttpError;
-/**
- * Send a test mail with the supplied email info (subject, body, recipient). Email config from database is used for the connection.
- *
- * @param body an object with the body content
- * @throws SendTestEmailHttpError
- */
-declare const sendTestEmail: (body: Email, options?: ApiCallOptions) => Promise<SendTestEmailHttpResponse>;
-type SendTestEmailHttpResponse = {
-    data: SmtpResult;
-    headers: Headers;
-    status: number;
-};
-type SendTestEmail403HttpError = {
-    data: TenantAdminError;
-    headers: Headers;
-    status: 403;
-};
-type SendTestEmail404HttpError = {
-    data: SendTestMailConfigNotFoundError;
-    headers: Headers;
-    status: 404;
-};
-type SendTestEmailDefaultHttpError = {
-    data: ErrorsPublic;
-    headers: Headers;
-    status: "default";
-};
-type SendTestEmailHttpError = SendTestEmail403HttpError | SendTestEmail404HttpError | SendTestEmailDefaultHttpError;
-/**
- * Returns the isValid value for the email configuration for the tenant. Will return false if no email configuration exists.
- *
- * @throws ValidateEmailConfigHttpError
- */
-declare const validateEmailConfig: (options?: ApiCallOptions) => Promise<ValidateEmailConfigHttpResponse>;
-type ValidateEmailConfigHttpResponse = {
-    data: SmtpCheck;
-    headers: Headers;
-    status: number;
-};
-type ValidateEmailConfigHttpError = {
-    data: ErrorsPublic;
-    headers: Headers;
-    status: number;
-};
-/**
- * Verifies connection to email server for tenant provided via JWT
- *
- * @throws VerifyEmailConfigConnectionHttpError
- */
-declare const verifyEmailConfigConnection: (options?: ApiCallOptions) => Promise<VerifyEmailConfigConnectionHttpResponse>;
-type VerifyEmailConfigConnectionHttpResponse = {
-    data: SmtpResult;
-    headers: Headers;
-    status: number;
-};
-type VerifyEmailConfigConnection404HttpError = {
-    data: VerifyConnectionConfigNotFoundError;
-    headers: Headers;
-    status: 404;
-};
-type VerifyEmailConfigConnectionDefaultHttpError = {
-    data: ErrorsPublic;
-    headers: Headers;
-    status: "default";
-};
-type VerifyEmailConfigConnectionHttpError = VerifyEmailConfigConnection404HttpError | VerifyEmailConfigConnectionDefaultHttpError;
-/**
- * Clears the cache for transports api requests.
- */
-declare function clearCache(): void;
-interface TransportsAPI {
-    /**
-     * Deletes email configuration for a given tenant id (retrieved from JWT).
-     *
-     * @throws DeleteEmailConfigHttpError
-     */
-    deleteEmailConfig: typeof deleteEmailConfig;
-    /**
-     * Returns the email configuration for a given tenant id (retrieved from JWT).
-     *
-     * @throws GetEmailConfigHttpError
-     */
-    getEmailConfig: typeof getEmailConfig;
-    /**
-     * Patch the email configuration for a given tenant id (retrieved from JWT).
-     *
-     * @param body an object with the body content
-     * @throws PatchEmailConfigHttpError
-     */
-    patchEmailConfig: typeof patchEmailConfig;
-    /**
-     * Send a test mail with the supplied email info (subject, body, recipient). Email config from database is used for the connection.
-     *
-     * @param body an object with the body content
-     * @throws SendTestEmailHttpError
-     */
-    sendTestEmail: typeof sendTestEmail;
-    /**
-     * Returns the isValid value for the email configuration for the tenant. Will return false if no email configuration exists.
-     *
-     * @throws ValidateEmailConfigHttpError
-     */
-    validateEmailConfig: typeof validateEmailConfig;
-    /**
-     * Verifies connection to email server for tenant provided via JWT
-     *
-     * @throws VerifyEmailConfigConnectionHttpError
-     */
-    verifyEmailConfigConnection: typeof verifyEmailConfigConnection;
-    /**
-     * Clears the cache for transports api requests.
-     */
-    clearCache: typeof clearCache;
-}
-/**
- * Functions for the transports api
- */
-declare const transportsExport: TransportsAPI;
-
-export { type DeleteConfigNotFoundError, type DeleteEmailConfig403HttpError, type DeleteEmailConfig404HttpError, type DeleteEmailConfigDefaultHttpError, type DeleteEmailConfigHttpError, type DeleteEmailConfigHttpResponse, type Email, type EmailConfigFieldPatch, type EmailConfigGet, type EmailConfigPatch, type ErrorPublic, type ErrorsPublic, type GetEmailConfig403HttpError, type GetEmailConfigDefaultHttpError, type GetEmailConfigHttpError, type GetEmailConfigHttpResponse, type PatchEmailConfig400HttpError, type PatchEmailConfig403HttpError, type PatchEmailConfigDefaultHttpError, type PatchEmailConfigError, type PatchEmailConfigHttpError, type PatchEmailConfigHttpResponse, type SendTestEmail403HttpError, type SendTestEmail404HttpError, type SendTestEmailDefaultHttpError, type SendTestEmailHttpError, type SendTestEmailHttpResponse, type SendTestMailConfigNotFoundError, type SmtpCheck, type SmtpConfigStatus, type SmtpResult, type TenantAdminError, type TransportsAPI, type ValidateEmailConfigHttpError, type ValidateEmailConfigHttpResponse, type VerifyConnectionConfigNotFoundError, type VerifyEmailConfigConnection404HttpError, type VerifyEmailConfigConnectionDefaultHttpError, type VerifyEmailConfigConnectionHttpError, type VerifyEmailConfigConnectionHttpResponse, clearCache, transportsExport as default, deleteEmailConfig, getEmailConfig, patchEmailConfig, sendTestEmail, validateEmailConfig, verifyEmailConfigConnection };