@qlik/api 0.0.1

package/themes.d.mts

@@ -0,0 +1,235 @@
+import { A as ApiCallOptions } from './global.types-Eto4uYwy.mjs';
+import './auth-types-nnUcWhuU.mjs';
+
+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;
+};
+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;
+};
+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: unknown, 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: unknown, 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.d.ts

@@ -0,0 +1,235 @@
+import { A as ApiCallOptions } from './global.types-hIvp-WdX.js';
+import './auth-types-nnUcWhuU.js';
+
+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;
+};
+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;
+};
+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: unknown, 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: unknown, 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.js

@@ -0,0 +1,74 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkOULT3V2Ujs = require('./chunk-OULT3V2U.js');
+require('./chunk-ZT4C7KCQ.js');
+
+// src/public/rest/themes.ts
+var getThemes = async (options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "themes", {
+  method: "get",
+  pathTemplate: "/api/v1/themes",
+  options
+});
+var uploadTheme = async (body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "themes", {
+  method: "post",
+  pathTemplate: "/api/v1/themes",
+  body,
+  options
+});
+var deleteTheme = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "themes", {
+  method: "delete",
+  pathTemplate: "/api/v1/themes/{id}",
+  pathVariables: { id },
+  options
+});
+var getTheme = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "themes", {
+  method: "get",
+  pathTemplate: "/api/v1/themes/{id}",
+  pathVariables: { id },
+  options
+});
+var patchTheme = async (id, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "themes", {
+  method: "patch",
+  pathTemplate: "/api/v1/themes/{id}",
+  pathVariables: { id },
+  body,
+  options
+});
+var downloadTheme = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "themes", {
+  method: "get",
+  pathTemplate: "/api/v1/themes/{id}/file",
+  pathVariables: { id },
+  options
+});
+var downloadFileFromTheme = async (id, filepath, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "themes", {
+  method: "get",
+  pathTemplate: "/api/v1/themes/{id}/file/{filepath}",
+  pathVariables: { id, filepath },
+  options
+});
+function clearCache() {
+  return _chunkOULT3V2Ujs.clearApiCache.call(void 0, "themes");
+}
+var themesExport = {
+  getThemes,
+  uploadTheme,
+  deleteTheme,
+  getTheme,
+  patchTheme,
+  downloadTheme,
+  downloadFileFromTheme,
+  clearCache
+};
+var themes_default = themesExport;
+
+
+
+
+
+
+
+
+
+
+exports.clearCache = clearCache; exports.default = themes_default; exports.deleteTheme = deleteTheme; exports.downloadFileFromTheme = downloadFileFromTheme; exports.downloadTheme = downloadTheme; exports.getTheme = getTheme; exports.getThemes = getThemes; exports.patchTheme = patchTheme; exports.uploadTheme = uploadTheme;

package/themes.mjs

@@ -0,0 +1,74 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunk-3YE7EI7I.mjs";
+import "./chunk-WM7FQU2U.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,
+  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,
+  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
+};