@qlik/api 0.0.1

package/qix.js

@@ -0,0 +1,9 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunk4ES65KO3js = require('./chunk-4ES65KO3.js');
+require('./chunk-ZT4C7KCQ.js');
+
+
+
+exports.default = _chunk4ES65KO3js.qix_default; exports.openAppSession = _chunk4ES65KO3js.openAppSession;

package/qix.mjs

@@ -0,0 +1,9 @@
+import {
+  openAppSession,
+  qix_default
+} from "./chunk-CKPJE4IA.mjs";
+import "./chunk-WM7FQU2U.mjs";
+export {
+  qix_default as default,
+  openAppSession
+};

package/quotas.d.mts

@@ -0,0 +1,105 @@
+import { A as ApiCallOptions } from './global.types-Eto4uYwy.mjs';
+import './auth-types-nnUcWhuU.mjs';
+
+type Error = {
+    /** The error code. */
+    code: string;
+    /** Summary of the problem. */
+    title: string;
+};
+type ErrorResponse = {
+    errors?: Error[];
+};
+type GetQuotaByIdResult = {
+    /** Quota item. */
+    data: Quota[];
+};
+type GetQuotasResult = {
+    /** Array of quota items. */
+    data: Quota[];
+};
+type Quota = {
+    /** The attributes of the quota. */
+    attributes: {
+        /** The quota limit. If there is no quota limit, -1 is returned. */
+        quota: number;
+        /** The unit of the quota limit. For memory quotas, the unit is always "bytes". For other discrete units, the item counted is used as unit, for example "spaces". */
+        unit: string;
+        /** The current quota usage, if applicable. This attribute is only present if it is requested using the reportUsage query parameter. */
+        usage?: number;
+        /** The warning thresholds at which "close to quota" warnings can be issued when exceeded. If omitted, no warning threshold shall be used. Currently, the array will contain only one threshold value. In the future, this may be extended. The threshold is a number between 0 and 1, relating to the quota limit. For example, a value of 0.9 means that a warning should be issued when exceeding 90% of the quota limit. */
+        warningThresholds?: number[];
+    };
+    /** The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces". */
+    id: string;
+    /** The resource type of the quota item. Always equal to "quotas". */
+    type: string;
+};
+/**
+ * Returns all quota items for the tenant (provided in JWT).
+ * @param query an object with query parameters
+ * @throws GetQuotasHttpError
+ */
+declare const getQuotas: (query: {
+    /** The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (only limits returned). */
+    reportUsage?: boolean;
+}, options?: ApiCallOptions) => Promise<GetQuotasHttpResponse>;
+type GetQuotasHttpResponse = {
+    data: GetQuotasResult;
+    headers: Headers;
+    status: number;
+};
+type GetQuotasHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Returns a specific quota item for the tenant (provided in JWT).
+ * @param id The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".
+ * @param query an object with query parameters
+ * @throws GetQuotaHttpError
+ */
+declare const getQuota: (id: string, query: {
+    /** The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (usage not included). */
+    reportUsage?: boolean;
+}, options?: ApiCallOptions) => Promise<GetQuotaHttpResponse>;
+type GetQuotaHttpResponse = {
+    data: GetQuotaByIdResult;
+    headers: Headers;
+    status: number;
+};
+type GetQuotaHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Clears the cache for quotas api requests.
+ */
+declare function clearCache(): void;
+interface QuotasAPI {
+    /**
+     * Returns all quota items for the tenant (provided in JWT).
+     * @param query an object with query parameters
+     * @throws GetQuotasHttpError
+     */
+    getQuotas: typeof getQuotas;
+    /**
+     * Returns a specific quota item for the tenant (provided in JWT).
+     * @param id The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".
+     * @param query an object with query parameters
+     * @throws GetQuotaHttpError
+     */
+    getQuota: typeof getQuota;
+    /**
+     * Clears the cache for quotas api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the quotas api
+ */
+declare const quotasExport: QuotasAPI;
+
+export { type Error, type ErrorResponse, type GetQuotaByIdResult, type GetQuotaHttpError, type GetQuotaHttpResponse, type GetQuotasHttpError, type GetQuotasHttpResponse, type GetQuotasResult, type Quota, type QuotasAPI, clearCache, quotasExport as default, getQuota, getQuotas };

package/quotas.d.ts

@@ -0,0 +1,105 @@
+import { A as ApiCallOptions } from './global.types-hIvp-WdX.js';
+import './auth-types-nnUcWhuU.js';
+
+type Error = {
+    /** The error code. */
+    code: string;
+    /** Summary of the problem. */
+    title: string;
+};
+type ErrorResponse = {
+    errors?: Error[];
+};
+type GetQuotaByIdResult = {
+    /** Quota item. */
+    data: Quota[];
+};
+type GetQuotasResult = {
+    /** Array of quota items. */
+    data: Quota[];
+};
+type Quota = {
+    /** The attributes of the quota. */
+    attributes: {
+        /** The quota limit. If there is no quota limit, -1 is returned. */
+        quota: number;
+        /** The unit of the quota limit. For memory quotas, the unit is always "bytes". For other discrete units, the item counted is used as unit, for example "spaces". */
+        unit: string;
+        /** The current quota usage, if applicable. This attribute is only present if it is requested using the reportUsage query parameter. */
+        usage?: number;
+        /** The warning thresholds at which "close to quota" warnings can be issued when exceeded. If omitted, no warning threshold shall be used. Currently, the array will contain only one threshold value. In the future, this may be extended. The threshold is a number between 0 and 1, relating to the quota limit. For example, a value of 0.9 means that a warning should be issued when exceeding 90% of the quota limit. */
+        warningThresholds?: number[];
+    };
+    /** The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces". */
+    id: string;
+    /** The resource type of the quota item. Always equal to "quotas". */
+    type: string;
+};
+/**
+ * Returns all quota items for the tenant (provided in JWT).
+ * @param query an object with query parameters
+ * @throws GetQuotasHttpError
+ */
+declare const getQuotas: (query: {
+    /** The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (only limits returned). */
+    reportUsage?: boolean;
+}, options?: ApiCallOptions) => Promise<GetQuotasHttpResponse>;
+type GetQuotasHttpResponse = {
+    data: GetQuotasResult;
+    headers: Headers;
+    status: number;
+};
+type GetQuotasHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Returns a specific quota item for the tenant (provided in JWT).
+ * @param id The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".
+ * @param query an object with query parameters
+ * @throws GetQuotaHttpError
+ */
+declare const getQuota: (id: string, query: {
+    /** The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (usage not included). */
+    reportUsage?: boolean;
+}, options?: ApiCallOptions) => Promise<GetQuotaHttpResponse>;
+type GetQuotaHttpResponse = {
+    data: GetQuotaByIdResult;
+    headers: Headers;
+    status: number;
+};
+type GetQuotaHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Clears the cache for quotas api requests.
+ */
+declare function clearCache(): void;
+interface QuotasAPI {
+    /**
+     * Returns all quota items for the tenant (provided in JWT).
+     * @param query an object with query parameters
+     * @throws GetQuotasHttpError
+     */
+    getQuotas: typeof getQuotas;
+    /**
+     * Returns a specific quota item for the tenant (provided in JWT).
+     * @param id The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".
+     * @param query an object with query parameters
+     * @throws GetQuotaHttpError
+     */
+    getQuota: typeof getQuota;
+    /**
+     * Clears the cache for quotas api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the quotas api
+ */
+declare const quotasExport: QuotasAPI;
+
+export { type Error, type ErrorResponse, type GetQuotaByIdResult, type GetQuotaHttpError, type GetQuotaHttpResponse, type GetQuotasHttpError, type GetQuotasHttpResponse, type GetQuotasResult, type Quota, type QuotasAPI, clearCache, quotasExport as default, getQuota, getQuotas };

package/quotas.js

@@ -0,0 +1,31 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkOULT3V2Ujs = require('./chunk-OULT3V2U.js');
+require('./chunk-ZT4C7KCQ.js');
+
+// src/public/rest/quotas.ts
+var getQuotas = async (query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "quotas", {
+  method: "get",
+  pathTemplate: "/api/v1/quotas",
+  query,
+  options
+});
+var getQuota = async (id, query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "quotas", {
+  method: "get",
+  pathTemplate: "/api/v1/quotas/{id}",
+  pathVariables: { id },
+  query,
+  options
+});
+function clearCache() {
+  return _chunkOULT3V2Ujs.clearApiCache.call(void 0, "quotas");
+}
+var quotasExport = { getQuotas, getQuota, clearCache };
+var quotas_default = quotasExport;
+
+
+
+
+
+exports.clearCache = clearCache; exports.default = quotas_default; exports.getQuota = getQuota; exports.getQuotas = getQuotas;

package/quotas.mjs

@@ -0,0 +1,31 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunk-3YE7EI7I.mjs";
+import "./chunk-WM7FQU2U.mjs";
+
+// src/public/rest/quotas.ts
+var getQuotas = async (query, options) => invokeFetch("quotas", {
+  method: "get",
+  pathTemplate: "/api/v1/quotas",
+  query,
+  options
+});
+var getQuota = async (id, query, options) => invokeFetch("quotas", {
+  method: "get",
+  pathTemplate: "/api/v1/quotas/{id}",
+  pathVariables: { id },
+  query,
+  options
+});
+function clearCache() {
+  return clearApiCache("quotas");
+}
+var quotasExport = { getQuotas, getQuota, clearCache };
+var quotas_default = quotasExport;
+export {
+  clearCache,
+  quotas_default as default,
+  getQuota,
+  getQuotas
+};

package/reload-tasks.d.mts

@@ -0,0 +1,222 @@
+import { A as ApiCallOptions } from './global.types-Eto4uYwy.mjs';
+import './auth-types-nnUcWhuU.mjs';
+
+type Error = {
+    code: string;
+    detail?: string;
+    title: string;
+};
+type Errors = {
+    errors?: Error[];
+    traceId?: string;
+};
+type Href = {
+    href: string;
+};
+type PaginationLinks = SelfLink & {
+    next?: Href;
+    prev?: Href;
+};
+type PostTaskBody = TaskBase & {
+    /** Type of task being created - only contains the "scheduled_reload" value. Type value is not used for creating a schedule reload. It has been deprecated since 2022-04-05. */
+    type?: "scheduled_reload";
+};
+type PutTaskBody = TaskBase & {
+    /** Toggle for enabling and disabling the reload task */
+    state?: "Enabled" | "Disabled" | "Completed";
+};
+type SelfLink = {
+    self: Href;
+};
+type Task = TaskBase & {
+    /** The fortress ID of the application */
+    fortressId?: string;
+    /** The ID of the task. */
+    id: string;
+    /** The last time the task executed. */
+    lastExecutionTime?: string;
+    links: SelfLink;
+    /** The reason why the task was disabled. */
+    log?: string;
+    /** The next time the task will execute. */
+    nextExecutionTime?: string;
+    /** The space ID of the application */
+    spaceId?: string;
+    /** Toggle for enabling and disabling the reload task */
+    state: "Enabled" | "Disabled" | "Completed";
+    /** The ID of the tenant who owns the task. */
+    tenantId: string;
+    /** The ID of the user who owns the task. */
+    userId: string;
+};
+type TaskBase = {
+    /** The ID of the app. */
+    appId?: string;
+    /** A flag that indicates whether a reload is triggered when data of the app is changed */
+    autoReload?: boolean;
+    /** A flag that indicates whether it is a partial reload or not for the auto reload */
+    autoReloadPartial?: boolean;
+    /** The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. */
+    endDateTime?: string;
+    /** The task is partial reload or not */
+    partial?: boolean;
+    /** List of RECUR lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events */
+    recurrence?: string[];
+    /** The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set. */
+    startDateTime?: string;
+    /** The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. Europe/Zurich.) This field specifies the time zone in which the event start/end are expanded. If missing the start/end fields must specify a UTC offset in RFC3339 format. */
+    timeZone?: string;
+};
+type Tasks = {
+    data: Task[];
+    links: PaginationLinks;
+};
+/**
+ * Find and return the tasks that the user can access.
+ *
+ * @param query an object with query parameters
+ * @throws GetReloadTasksHttpError
+ */
+declare const getReloadTasks: (query: {
+    /** The case sensitive string used to search for a task by app ID. */
+    appId?: string;
+    /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
+    limit?: number;
+    /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
+    next?: string;
+    /** The boolean value used to search for a task is partial or not */
+    partial?: boolean;
+    /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
+    prev?: string;
+}, options?: ApiCallOptions) => Promise<GetReloadTasksHttpResponse>;
+type GetReloadTasksHttpResponse = {
+    data: Tasks;
+    headers: Headers;
+    status: number;
+};
+type GetReloadTasksHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Create a task for a specified app.
+ *
+ * @param body an object with the body content
+ * @throws CreateReloadTaskHttpError
+ */
+declare const createReloadTask: (body: PostTaskBody, options?: ApiCallOptions) => Promise<CreateReloadTaskHttpResponse>;
+type CreateReloadTaskHttpResponse = {
+    data: Task;
+    headers: Headers;
+    status: number;
+};
+type CreateReloadTaskHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Delete a task.
+ *
+ * @param taskId The unique identifier of the task.
+ * @throws DeleteReloadTaskHttpError
+ */
+declare const deleteReloadTask: (taskId: string, options?: ApiCallOptions) => Promise<DeleteReloadTaskHttpResponse>;
+type DeleteReloadTaskHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: number;
+};
+type DeleteReloadTaskHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Find and return a task.
+ *
+ * @param taskId The unique identifier of the task.
+ * @throws GetReloadTaskHttpError
+ */
+declare const getReloadTask: (taskId: string, options?: ApiCallOptions) => Promise<GetReloadTaskHttpResponse>;
+type GetReloadTaskHttpResponse = {
+    data: Task;
+    headers: Headers;
+    status: number;
+};
+type GetReloadTaskHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Update an existing task.
+ *
+ * @param taskId The unique identifier of the task.
+ * @param body an object with the body content
+ * @throws UpdateReloadTaskHttpError
+ */
+declare const updateReloadTask: (taskId: string, body: PutTaskBody, options?: ApiCallOptions) => Promise<UpdateReloadTaskHttpResponse>;
+type UpdateReloadTaskHttpResponse = {
+    data: Task;
+    headers: Headers;
+    status: number;
+};
+type UpdateReloadTaskHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Clears the cache for reload-tasks api requests.
+ */
+declare function clearCache(): void;
+interface ReloadTasksAPI {
+    /**
+     * Find and return the tasks that the user can access.
+     *
+     * @param query an object with query parameters
+     * @throws GetReloadTasksHttpError
+     */
+    getReloadTasks: typeof getReloadTasks;
+    /**
+     * Create a task for a specified app.
+     *
+     * @param body an object with the body content
+     * @throws CreateReloadTaskHttpError
+     */
+    createReloadTask: typeof createReloadTask;
+    /**
+     * Delete a task.
+     *
+     * @param taskId The unique identifier of the task.
+     * @throws DeleteReloadTaskHttpError
+     */
+    deleteReloadTask: typeof deleteReloadTask;
+    /**
+     * Find and return a task.
+     *
+     * @param taskId The unique identifier of the task.
+     * @throws GetReloadTaskHttpError
+     */
+    getReloadTask: typeof getReloadTask;
+    /**
+     * Update an existing task.
+     *
+     * @param taskId The unique identifier of the task.
+     * @param body an object with the body content
+     * @throws UpdateReloadTaskHttpError
+     */
+    updateReloadTask: typeof updateReloadTask;
+    /**
+     * Clears the cache for reload-tasks api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the reload-tasks api
+ */
+declare const reloadTasksExport: ReloadTasksAPI;
+
+export { type CreateReloadTaskHttpError, type CreateReloadTaskHttpResponse, type DeleteReloadTaskHttpError, type DeleteReloadTaskHttpResponse, type Error, type Errors, type GetReloadTaskHttpError, type GetReloadTaskHttpResponse, type GetReloadTasksHttpError, type GetReloadTasksHttpResponse, type Href, type PaginationLinks, type PostTaskBody, type PutTaskBody, type ReloadTasksAPI, type SelfLink, type Task, type TaskBase, type Tasks, type UpdateReloadTaskHttpError, type UpdateReloadTaskHttpResponse, clearCache, createReloadTask, reloadTasksExport as default, deleteReloadTask, getReloadTask, getReloadTasks, updateReloadTask };