@qlik/api 1.31.0 → 1.32.0

package/conditions.js

@@ -0,0 +1,113 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
+import "./chunks/2ZQ3ZX7F.js";
+
+// src/public/rest/conditions.ts
+var createCondition = async (body, options) => invokeFetch("conditions", {
+  method: "post",
+  pathTemplate: "/api/v1/conditions",
+  body,
+  contentType: "application/json",
+  options
+});
+var createConditionPreview = async (body, options) => invokeFetch("conditions", {
+  method: "post",
+  pathTemplate: "/api/v1/conditions/previews",
+  body,
+  contentType: "application/json",
+  options
+});
+var getConditionPreview = async (id, options) => invokeFetch("conditions", {
+  method: "get",
+  pathTemplate: "/api/v1/conditions/previews/{id}",
+  pathVariables: { id },
+  options
+});
+var getConditionsSettings = async (options) => invokeFetch("conditions", {
+  method: "get",
+  pathTemplate: "/api/v1/conditions/settings",
+  options
+});
+var setConditionsSettings = async (body, options) => invokeFetch("conditions", {
+  method: "put",
+  pathTemplate: "/api/v1/conditions/settings",
+  body,
+  contentType: "application/json",
+  options
+});
+var deleteCondition = async (id, options) => invokeFetch("conditions", {
+  method: "delete",
+  pathTemplate: "/api/v1/conditions/{id}",
+  pathVariables: { id },
+  options
+});
+var getCondition = async (id, options) => invokeFetch("conditions", {
+  method: "get",
+  pathTemplate: "/api/v1/conditions/{id}",
+  pathVariables: { id },
+  options
+});
+var patchCondition = async (id, body, options) => invokeFetch("conditions", {
+  method: "patch",
+  pathTemplate: "/api/v1/conditions/{id}",
+  pathVariables: { id },
+  body,
+  contentType: "application/json",
+  options
+});
+var createConditionEvaluation = async (id, body, options) => invokeFetch("conditions", {
+  method: "post",
+  pathTemplate: "/api/v1/conditions/{id}/evaluations",
+  pathVariables: { id },
+  body,
+  contentType: "application/json",
+  options
+});
+var deleteConditionEvaluation = async (id, evaluationId, options) => invokeFetch("conditions", {
+  method: "delete",
+  pathTemplate: "/api/v1/conditions/{id}/evaluations/{evaluationId}",
+  pathVariables: { id, evaluationId },
+  options
+});
+var getConditionEvaluation = async (id, evaluationId, options) => invokeFetch("conditions", {
+  method: "get",
+  pathTemplate: "/api/v1/conditions/{id}/evaluations/{evaluationId}",
+  pathVariables: { id, evaluationId },
+  options
+});
+function clearCache() {
+  return clearApiCache("conditions");
+}
+var conditionsExport = {
+  createCondition,
+  createConditionPreview,
+  getConditionPreview,
+  getConditionsSettings,
+  setConditionsSettings,
+  deleteCondition,
+  getCondition,
+  patchCondition,
+  createConditionEvaluation,
+  deleteConditionEvaluation,
+  getConditionEvaluation,
+  clearCache
+};
+var conditions_default = conditionsExport;
+export {
+  clearCache,
+  createCondition,
+  createConditionEvaluation,
+  createConditionPreview,
+  conditions_default as default,
+  deleteCondition,
+  deleteConditionEvaluation,
+  getCondition,
+  getConditionEvaluation,
+  getConditionPreview,
+  getConditionsSettings,
+  patchCondition,
+  setConditionsSettings
+};

package/consumption.d.ts

@@ -0,0 +1,182 @@
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
+
+type Enforcement = {
+    /** Resource action type to be blocked */
+    actionToBlock?: string;
+    /** Resource type to be blocked */
+    resourceType?: string;
+};
+/**
+ * @example
+ * {
+ *   errors: [
+ *     {
+ *       code: "HTTP-123",
+ *       title: "short error message"
+ *     }
+ *   ],
+ *   traceId: "7975401f3954aa47"
+ * }
+ */
+type ErrorResponse = {
+    errors?: SingleErrorResponse[];
+    traceId?: string;
+};
+type ExecutionResponse = {
+    blocked?: boolean;
+    /** RFC3339 timestamp when a block event was last emitted for this execution. */
+    blockedEventTime?: string;
+    /** The capacity limit. */
+    capacityLimit?: number;
+    closeToOverage?: boolean;
+    /** The id of the consumption report */
+    consumptionReportId?: string;
+    /** The field to determine if a resource should be visible on the client. */
+    customerFacing?: boolean;
+    /** Contains a list of resources that are blocked when quota for this is reached. */
+    enforcement?: Enforcement[];
+    /** The global usage. */
+    globalUsage?: number;
+    /** The guardrail limit. */
+    guardrailLimit?: number;
+    /** The local usage. */
+    localUsage?: number;
+    overage?: boolean;
+    /** RFC3339 timestamp when a overage event was last emitted for this execution. */
+    overageEventTime?: string;
+    /** The end of the associated period. */
+    periodEnd?: string;
+    /** The start of the associated period. */
+    periodStart?: string;
+    periodType?: "day" | "month" | "year" | "" | "fixed" | "minute";
+    /** The resource action. */
+    resourceAction?: "report.generated" | "reload" | "scheduledReload" | "executed" | "aggregation" | "import" | "updated" | "deployed" | "3rd_party_executed" | "standard_executed";
+    /** The resource id. */
+    resourceId?: string;
+    /** The resource type. */
+    resourceType?: "app" | "automations" | "space" | "data.volume.consumption";
+    scope?: ("user" | "tenant" | "resourceId" | "resourceType" | "resourceAction")[];
+    /** The map to the resource scope. */
+    scopeMapping?: string;
+    segments?: Record<string, unknown>[];
+    /** The resource task description. */
+    taskDescription?: string;
+    /** The resource task name. */
+    taskName?: string;
+    /** The tenant id. */
+    tenantId?: string;
+    /** Unit of measurement for the resource consumption */
+    unit?: string;
+    /** The RFC3339 timestamp when the resource was updated. */
+    updateTime?: string;
+    /** The user id. */
+    userId?: string;
+};
+type ExecutionsByTenantList = StandardListResponseProps & {
+    closeToOverage?: boolean;
+    data?: ExecutionResponse[];
+    globalUsageAvailable?: boolean;
+    links?: ListLinks;
+    overage?: boolean;
+};
+type ListLinks = {
+    next?: Page;
+    prev?: Page;
+    /** Object with Href to a particular element or set of elements */
+    self?: Self;
+};
+type Page = {
+    /** URL to particular set of elements */
+    href?: string;
+    /** Page unique token */
+    token?: string;
+    /** Page type, can be next or prev */
+    type?: "prev" | "next";
+};
+/**
+ * Object with Href to a particular element or set of elements
+ */
+type Self = {
+    href?: string;
+};
+type SingleErrorResponse = {
+    /** Error code specific to usage-tracker. */
+    readonly code?: string;
+    /** Error cause. */
+    readonly detail?: string;
+    /** meta properties for an error. */
+    meta?: unknown;
+    /** Error title. */
+    readonly title?: string;
+};
+/**
+ * properties that should be added to every list response
+ */
+type StandardListResponseProps = {
+    /** count of entries on the currently shown page */
+    currentPageCount: number;
+    /** total count of entries in the collection as a whole */
+    totalCount: number;
+};
+/**
+ * Retrieves the list of executions on an specific tenant
+ *
+ * @param query an object with query parameters
+ * @throws GetConsumptionExecutionsHttpError
+ */
+declare const getConsumptionExecutions: (query: {
+    actionToBlock?: string;
+    /** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax.
+     *
+     * example `taskName eq "automation_run_ended" or taskName eq "report_triggered" or or taskName eq "dataVolumeAggregated"`
+     *
+     * The following fields are supported: `scope`, `resourcetype`, `resourceaction`, `resourceid`, `capacitylimit`,
+     * `localusage`, `globalusage`, `overage`, `blocked`, `periodstart`, `periodend`, `consumptionreportid`, `blockedeventtime`,
+     * `overageeventtime`, `taskname`, `taskdescription`, `userid`, `tenantid`, `customerfacing`, `actiontoblock` */
+    filter?: string;
+    /** Limit the returned result set */
+    limit?: number;
+    /** Offset for pagination - how many elements to skip */
+    offset?: number;
+    /** The cursor to the page of data. */
+    page?: string;
+    /** Specifies which periods to include regardless of the period type, start and end specified */
+    periodsToInclude?: ("current" | "previous")[];
+    sort?: ("periodstart" | "-periodstart" | "+periodstart" | "periodend" | "-periodend" | "+periodend")[];
+}, options?: ApiCallOptions) => Promise<GetConsumptionExecutionsHttpResponse>;
+type GetConsumptionExecutionsHttpResponse = {
+    data: ExecutionsByTenantList;
+    headers: Headers;
+    status: 200;
+    prev?: (options?: ApiCallOptions) => Promise<GetConsumptionExecutionsHttpResponse>;
+    next?: (options?: ApiCallOptions) => Promise<GetConsumptionExecutionsHttpResponse>;
+};
+type GetConsumptionExecutionsHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Clears the cache for consumption api requests.
+ */
+declare function clearCache(): void;
+interface ConsumptionAPI {
+    /**
+     * Retrieves the list of executions on an specific tenant
+     *
+     * @param query an object with query parameters
+     * @throws GetConsumptionExecutionsHttpError
+     */
+    getConsumptionExecutions: typeof getConsumptionExecutions;
+    /**
+     * Clears the cache for consumption api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the consumption api
+ */
+declare const consumptionExport: ConsumptionAPI;
+
+export { type ConsumptionAPI, type Enforcement, type ErrorResponse, type ExecutionResponse, type ExecutionsByTenantList, type GetConsumptionExecutionsHttpError, type GetConsumptionExecutionsHttpResponse, type ListLinks, type Page, type Self, type SingleErrorResponse, type StandardListResponseProps, clearCache, consumptionExport as default, getConsumptionExecutions };

package/consumption.js

@@ -0,0 +1,24 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
+import "./chunks/2ZQ3ZX7F.js";
+
+// src/public/rest/consumption.ts
+var getConsumptionExecutions = async (query, options) => invokeFetch("consumption", {
+  method: "get",
+  pathTemplate: "/api/v1/consumption/executions",
+  query,
+  options
+});
+function clearCache() {
+  return clearApiCache("consumption");
+}
+var consumptionExport = { getConsumptionExecutions, clearCache };
+var consumption_default = consumptionExport;
+export {
+  clearCache,
+  consumption_default as default,
+  getConsumptionExecutions
+};

package/csp-origins.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/YKZ2QYHN.js";
-import "./chunks/DLKLPD7T.js";
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/csp-origins.ts

package/csrf-token.d.ts

@@ -0,0 +1,62 @@
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
+
+/**
+ * An error object.
+ */
+type Error = {
+    /** The error code. */
+    code: string;
+    /** The detailed error message */
+    detail?: string;
+    /** Non-standard information about the error */
+    meta?: unknown;
+    /** The http status code. */
+    status?: string;
+    /** The error title. */
+    title: string;
+};
+/**
+ * A representation of the errors encountered from the HTTP request.
+ */
+type Errors = {
+    errors?: Error[];
+};
+/**
+ * Returns CSRF token via the qlik-csrf-token header.
+ *
+ * @throws GetCsrfTokenHttpError
+ */
+declare const getCsrfToken: (options?: ApiCallOptions) => Promise<GetCsrfTokenHttpResponse>;
+type GetCsrfTokenHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: 204;
+};
+type GetCsrfTokenHttpError = {
+    data: Errors & unknown;
+    headers: Headers;
+    status: 400 | 404;
+};
+/**
+ * Clears the cache for csrf-token api requests.
+ */
+declare function clearCache(): void;
+interface CsrfTokenAPI {
+    /**
+     * Returns CSRF token via the qlik-csrf-token header.
+     *
+     * @throws GetCsrfTokenHttpError
+     */
+    getCsrfToken: typeof getCsrfToken;
+    /**
+     * Clears the cache for csrf-token api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the csrf-token api
+ */
+declare const csrfTokenExport: CsrfTokenAPI;
+
+export { type CsrfTokenAPI, type Error, type Errors, type GetCsrfTokenHttpError, type GetCsrfTokenHttpResponse, clearCache, csrfTokenExport as default, getCsrfToken };

package/csrf-token.js

@@ -0,0 +1,23 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
+import "./chunks/2ZQ3ZX7F.js";
+
+// src/public/rest/csrf-token.ts
+var getCsrfToken = async (options) => invokeFetch("csrf-token", {
+  method: "get",
+  pathTemplate: "/api/v1/csrf-token",
+  options
+});
+function clearCache() {
+  return clearApiCache("csrf-token");
+}
+var csrfTokenExport = { getCsrfToken, clearCache };
+var csrf_token_default = csrfTokenExport;
+export {
+  clearCache,
+  csrf_token_default as default,
+  getCsrfToken
+};