@qlik/api 0.0.1

package/reloads.d.ts

@@ -0,0 +1,189 @@
+import { A as ApiCallOptions } from './global.types-hIvp-WdX.js';
+import './auth-types-nnUcWhuU.js';
+
+type Error = {
+    /** The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.  */
+    code: string;
+    detail?: string;
+    title: string;
+};
+type Errors = {
+    errors?: Error[];
+};
+type Href = {
+    href?: string;
+};
+type Partial = boolean;
+type Reload = {
+    /** The ID of the app. */
+    appId: string;
+    /** The time the reload job was created. */
+    creationTime: string;
+    /** The time the reload job finished. */
+    endTime?: string;
+    /** The timestamp returned from the Sense engine upon successful reload. */
+    engineTime?: string;
+    /** The ID of the reload. */
+    id: string;
+    links?: ReloadLinks;
+    /** The log describing the result of the latest reload execution from the request. */
+    log?: string;
+    /** The boolean value used to present the reload is partial or not. */
+    partial?: Partial;
+    /** The time the reload job was consumed from the queue. */
+    startTime?: string;
+    /** The status of the reload. There are seven statuses. `QUEUED`, `RELOADING`, `CANCELING` are the active statuses. `SUCCEEDED`, `FAILED`, `CANCELED`, `EXCEEDED_LIMIT` are the end statuses. */
+    status: Status;
+    /** The ID of the tenant who owns the reload. */
+    tenantId: string;
+    /** What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data. */
+    type: "hub" | "chronos" | "external" | "automations" | "data-refresh";
+    /** The ID of the user who created the reload. */
+    userId: string;
+};
+type ReloadLinks = {
+    self?: Href;
+};
+type ReloadRequest = {
+    /** The ID of the app to be reloaded. */
+    appId: string;
+    /** The boolean value used to present the reload is partial or not */
+    partial?: boolean;
+};
+type Reloads = {
+    data: Reload[];
+    links: ReloadsLinks;
+};
+type ReloadsLinks = ReloadLinks & {
+    next?: Href;
+    prev?: Href;
+};
+type Status = "QUEUED" | "RELOADING" | "CANCELING" | "SUCCEEDED" | "FAILED" | "CANCELED" | "EXCEEDED_LIMIT";
+/**
+ * Finds and returns the reloads that the user has access to.
+ * @param query an object with query parameters
+ * @throws GetReloadsHttpError
+ */
+declare const getReloads: (query: {
+    /** The UUID formatted string used to search for an app's reload history entries. TenantAdmin users may omit this parameter to list all reload history in the tenant. */
+    appId?: string;
+    /** SCIM filter expression used to search for reloads.
+    // The filter syntax is defined in RFC 7644 section 3.4.2.2
+    //
+    // Supported attributes:
+    // - status: see #schemas/Status
+    // - partial: see #schemas/Partial
+    //
+    // Supported operators:
+    // - eq
+    //  */
+    filter?: 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 boolean value used to include the log field or not, default is included, set log=false to exclude the log field. */
+    log?: boolean;
+    /** 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 reload 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<GetReloadsHttpResponse>;
+type GetReloadsHttpResponse = {
+    data: Reloads;
+    headers: Headers;
+    status: number;
+};
+type GetReloadsHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Reloads an app specified by an app ID.
+ * @param body an object with the body content
+ * @throws QueueReloadHttpError
+ */
+declare const queueReload: (body: ReloadRequest, options?: ApiCallOptions) => Promise<QueueReloadHttpResponse>;
+type QueueReloadHttpResponse = {
+    data: Reload;
+    headers: Headers;
+    status: number;
+};
+type QueueReloadHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Finds and returns a reload record
+ * @param reloadId The unique identifier of the reload.
+ * @throws GetReloadHttpError
+ */
+declare const getReload: (reloadId: string, options?: ApiCallOptions) => Promise<GetReloadHttpResponse>;
+type GetReloadHttpResponse = {
+    data: Reload;
+    headers: Headers;
+    status: number;
+};
+type GetReloadHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Cancels a reload that is in progress or has been queued
+ * @param reloadId The unique identifier of the reload.
+ * @throws CancelReloadHttpError
+ */
+declare const cancelReload: (reloadId: string, options?: ApiCallOptions) => Promise<CancelReloadHttpResponse>;
+type CancelReloadHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: number;
+};
+type CancelReloadHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Clears the cache for reloads api requests.
+ */
+declare function clearCache(): void;
+interface ReloadsAPI {
+    /**
+     * Finds and returns the reloads that the user has access to.
+     * @param query an object with query parameters
+     * @throws GetReloadsHttpError
+     */
+    getReloads: typeof getReloads;
+    /**
+     * Reloads an app specified by an app ID.
+     * @param body an object with the body content
+     * @throws QueueReloadHttpError
+     */
+    queueReload: typeof queueReload;
+    /**
+     * Finds and returns a reload record
+     * @param reloadId The unique identifier of the reload.
+     * @throws GetReloadHttpError
+     */
+    getReload: typeof getReload;
+    /**
+     * Cancels a reload that is in progress or has been queued
+     * @param reloadId The unique identifier of the reload.
+     * @throws CancelReloadHttpError
+     */
+    cancelReload: typeof cancelReload;
+    /**
+     * Clears the cache for reloads api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the reloads api
+ */
+declare const reloadsExport: ReloadsAPI;
+
+export { type CancelReloadHttpError, type CancelReloadHttpResponse, type Error, type Errors, type GetReloadHttpError, type GetReloadHttpResponse, type GetReloadsHttpError, type GetReloadsHttpResponse, type Href, type Partial, type QueueReloadHttpError, type QueueReloadHttpResponse, type Reload, type ReloadLinks, type ReloadRequest, type Reloads, type ReloadsAPI, type ReloadsLinks, type Status, cancelReload, clearCache, reloadsExport as default, getReload, getReloads, queueReload };

package/reloads.js

@@ -0,0 +1,44 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkOULT3V2Ujs = require('./chunk-OULT3V2U.js');
+require('./chunk-ZT4C7KCQ.js');
+
+// src/public/rest/reloads.ts
+var getReloads = async (query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "reloads", {
+  method: "get",
+  pathTemplate: "/api/v1/reloads",
+  query,
+  options
+});
+var queueReload = async (body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "reloads", {
+  method: "post",
+  pathTemplate: "/api/v1/reloads",
+  body,
+  options
+});
+var getReload = async (reloadId, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "reloads", {
+  method: "get",
+  pathTemplate: "/api/v1/reloads/{reloadId}",
+  pathVariables: { reloadId },
+  options
+});
+var cancelReload = async (reloadId, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "reloads", {
+  method: "post",
+  pathTemplate: "/api/v1/reloads/{reloadId}/actions/cancel",
+  pathVariables: { reloadId },
+  options
+});
+function clearCache() {
+  return _chunkOULT3V2Ujs.clearApiCache.call(void 0, "reloads");
+}
+var reloadsExport = { getReloads, queueReload, getReload, cancelReload, clearCache };
+var reloads_default = reloadsExport;
+
+
+
+
+
+
+
+exports.cancelReload = cancelReload; exports.clearCache = clearCache; exports.default = reloads_default; exports.getReload = getReload; exports.getReloads = getReloads; exports.queueReload = queueReload;

package/reloads.mjs

@@ -0,0 +1,44 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunk-3YE7EI7I.mjs";
+import "./chunk-WM7FQU2U.mjs";
+
+// src/public/rest/reloads.ts
+var getReloads = async (query, options) => invokeFetch("reloads", {
+  method: "get",
+  pathTemplate: "/api/v1/reloads",
+  query,
+  options
+});
+var queueReload = async (body, options) => invokeFetch("reloads", {
+  method: "post",
+  pathTemplate: "/api/v1/reloads",
+  body,
+  options
+});
+var getReload = async (reloadId, options) => invokeFetch("reloads", {
+  method: "get",
+  pathTemplate: "/api/v1/reloads/{reloadId}",
+  pathVariables: { reloadId },
+  options
+});
+var cancelReload = async (reloadId, options) => invokeFetch("reloads", {
+  method: "post",
+  pathTemplate: "/api/v1/reloads/{reloadId}/actions/cancel",
+  pathVariables: { reloadId },
+  options
+});
+function clearCache() {
+  return clearApiCache("reloads");
+}
+var reloadsExport = { getReloads, queueReload, getReload, cancelReload, clearCache };
+var reloads_default = reloadsExport;
+export {
+  cancelReload,
+  clearCache,
+  reloads_default as default,
+  getReload,
+  getReloads,
+  queueReload
+};

package/roles.d.mts

@@ -0,0 +1,150 @@
+import { A as ApiCallOptions } from './global.types-Eto4uYwy.mjs';
+import './auth-types-nnUcWhuU.mjs';
+
+type Error = {
+    /** The error code. */
+    code: string;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** Additional properties relating to the error. */
+    meta?: unknown;
+    /** References to the source of the error. */
+    source?: {
+        /** The URI query parameter that caused the error. */
+        parameter?: string;
+        /** A JSON Pointer to the property that caused the error. */
+        pointer?: string;
+    };
+    /** Summary of the problem. */
+    title: string;
+};
+type Errors = {
+    /** An array of errors related to the operation. */
+    errors?: Error[];
+    /** A unique identifier for tracing the error. */
+    traceId?: string;
+};
+type Links = {
+    /** Link to the next page of items */
+    next?: {
+        href: string;
+    };
+    /** Link to the previous page of items */
+    prev?: {
+        href: string;
+    };
+    /** Link to the current page of items */
+    self: {
+        href: string;
+    };
+};
+type ListRolesResult = {
+    /** An array of roles. */
+    data: Role[];
+    /** Contains pagination links */
+    links: Links;
+    /** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
+    totalResults?: number;
+};
+type Role = {
+    /** The timestamp for when the role was created. */
+    createdAt: string;
+    /** Descriptive text for the role. */
+    description: string;
+    /** The unique identifier for the role. */
+    readonly id: string;
+    /** The timestamp for when the role was last updated. */
+    lastUpdatedAt: string;
+    /** The level of access associated to the role. */
+    level?: "admin" | "user";
+    /** Contains links for the role. */
+    links: {
+        self: {
+            /** Link to the role. */
+            href: string;
+        };
+    };
+    /** The name of the role. */
+    name: string;
+    /** An array of permissions associated with the role. */
+    permissions?: string[];
+    /** The tenant unique identifier associated with the given Role. */
+    tenantId: string;
+    /** The type of role. */
+    type: "default";
+};
+/**
+ * Returns a list of roles using cursor-based pagination.
+ * @param query an object with query parameters
+ * @throws GetRolesHttpError
+ */
+declare const getRoles: (query: {
+    /** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax. All conditional statements within this query parameter are case insensitive. */
+    filter?: string;
+    /** The number of roles to retrieve. */
+    limit?: number;
+    /** The next page cursor. */
+    next?: string;
+    /** The previous page cursor. */
+    prev?: string;
+    /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
+    sort?: string;
+    /** Determines wether to return a count of the total records matched in the query. Defaults to false. */
+    totalResults?: boolean;
+}, options?: ApiCallOptions) => Promise<GetRolesHttpResponse>;
+type GetRolesHttpResponse = {
+    data: ListRolesResult;
+    headers: Headers;
+    status: number;
+    prev?: (options?: ApiCallOptions) => Promise<GetRolesHttpResponse>;
+    next?: (options?: ApiCallOptions) => Promise<GetRolesHttpResponse>;
+};
+type GetRolesHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Returns the requested role.
+ * @param id The role's unique identifier
+ * @throws GetRoleHttpError
+ */
+declare const getRole: (id: string, options?: ApiCallOptions) => Promise<GetRoleHttpResponse>;
+type GetRoleHttpResponse = {
+    data: Role;
+    headers: Headers;
+    status: number;
+};
+type GetRoleHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Clears the cache for roles api requests.
+ */
+declare function clearCache(): void;
+interface RolesAPI {
+    /**
+     * Returns a list of roles using cursor-based pagination.
+     * @param query an object with query parameters
+     * @throws GetRolesHttpError
+     */
+    getRoles: typeof getRoles;
+    /**
+     * Returns the requested role.
+     * @param id The role's unique identifier
+     * @throws GetRoleHttpError
+     */
+    getRole: typeof getRole;
+    /**
+     * Clears the cache for roles api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the roles api
+ */
+declare const rolesExport: RolesAPI;
+
+export { type Error, type Errors, type GetRoleHttpError, type GetRoleHttpResponse, type GetRolesHttpError, type GetRolesHttpResponse, type Links, type ListRolesResult, type Role, type RolesAPI, clearCache, rolesExport as default, getRole, getRoles };

package/roles.d.ts

@@ -0,0 +1,150 @@
+import { A as ApiCallOptions } from './global.types-hIvp-WdX.js';
+import './auth-types-nnUcWhuU.js';
+
+type Error = {
+    /** The error code. */
+    code: string;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** Additional properties relating to the error. */
+    meta?: unknown;
+    /** References to the source of the error. */
+    source?: {
+        /** The URI query parameter that caused the error. */
+        parameter?: string;
+        /** A JSON Pointer to the property that caused the error. */
+        pointer?: string;
+    };
+    /** Summary of the problem. */
+    title: string;
+};
+type Errors = {
+    /** An array of errors related to the operation. */
+    errors?: Error[];
+    /** A unique identifier for tracing the error. */
+    traceId?: string;
+};
+type Links = {
+    /** Link to the next page of items */
+    next?: {
+        href: string;
+    };
+    /** Link to the previous page of items */
+    prev?: {
+        href: string;
+    };
+    /** Link to the current page of items */
+    self: {
+        href: string;
+    };
+};
+type ListRolesResult = {
+    /** An array of roles. */
+    data: Role[];
+    /** Contains pagination links */
+    links: Links;
+    /** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
+    totalResults?: number;
+};
+type Role = {
+    /** The timestamp for when the role was created. */
+    createdAt: string;
+    /** Descriptive text for the role. */
+    description: string;
+    /** The unique identifier for the role. */
+    readonly id: string;
+    /** The timestamp for when the role was last updated. */
+    lastUpdatedAt: string;
+    /** The level of access associated to the role. */
+    level?: "admin" | "user";
+    /** Contains links for the role. */
+    links: {
+        self: {
+            /** Link to the role. */
+            href: string;
+        };
+    };
+    /** The name of the role. */
+    name: string;
+    /** An array of permissions associated with the role. */
+    permissions?: string[];
+    /** The tenant unique identifier associated with the given Role. */
+    tenantId: string;
+    /** The type of role. */
+    type: "default";
+};
+/**
+ * Returns a list of roles using cursor-based pagination.
+ * @param query an object with query parameters
+ * @throws GetRolesHttpError
+ */
+declare const getRoles: (query: {
+    /** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax. All conditional statements within this query parameter are case insensitive. */
+    filter?: string;
+    /** The number of roles to retrieve. */
+    limit?: number;
+    /** The next page cursor. */
+    next?: string;
+    /** The previous page cursor. */
+    prev?: string;
+    /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
+    sort?: string;
+    /** Determines wether to return a count of the total records matched in the query. Defaults to false. */
+    totalResults?: boolean;
+}, options?: ApiCallOptions) => Promise<GetRolesHttpResponse>;
+type GetRolesHttpResponse = {
+    data: ListRolesResult;
+    headers: Headers;
+    status: number;
+    prev?: (options?: ApiCallOptions) => Promise<GetRolesHttpResponse>;
+    next?: (options?: ApiCallOptions) => Promise<GetRolesHttpResponse>;
+};
+type GetRolesHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Returns the requested role.
+ * @param id The role's unique identifier
+ * @throws GetRoleHttpError
+ */
+declare const getRole: (id: string, options?: ApiCallOptions) => Promise<GetRoleHttpResponse>;
+type GetRoleHttpResponse = {
+    data: Role;
+    headers: Headers;
+    status: number;
+};
+type GetRoleHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Clears the cache for roles api requests.
+ */
+declare function clearCache(): void;
+interface RolesAPI {
+    /**
+     * Returns a list of roles using cursor-based pagination.
+     * @param query an object with query parameters
+     * @throws GetRolesHttpError
+     */
+    getRoles: typeof getRoles;
+    /**
+     * Returns the requested role.
+     * @param id The role's unique identifier
+     * @throws GetRoleHttpError
+     */
+    getRole: typeof getRole;
+    /**
+     * Clears the cache for roles api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the roles api
+ */
+declare const rolesExport: RolesAPI;
+
+export { type Error, type Errors, type GetRoleHttpError, type GetRoleHttpResponse, type GetRolesHttpError, type GetRolesHttpResponse, type Links, type ListRolesResult, type Role, type RolesAPI, clearCache, rolesExport as default, getRole, getRoles };

package/roles.js

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

package/roles.mjs

@@ -0,0 +1,30 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunk-3YE7EI7I.mjs";
+import "./chunk-WM7FQU2U.mjs";
+
+// src/public/rest/roles.ts
+var getRoles = async (query, options) => invokeFetch("roles", {
+  method: "get",
+  pathTemplate: "/api/v1/roles",
+  query,
+  options
+});
+var getRole = async (id, options) => invokeFetch("roles", {
+  method: "get",
+  pathTemplate: "/api/v1/roles/{id}",
+  pathVariables: { id },
+  options
+});
+function clearCache() {
+  return clearApiCache("roles");
+}
+var rolesExport = { getRoles, getRole, clearCache };
+var roles_default = rolesExport;
+export {
+  clearCache,
+  roles_default as default,
+  getRole,
+  getRoles
+};