@qlik/api 1.31.0 → 1.32.0

package/data-alerts.js

@@ -0,0 +1,155 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
+import "./chunks/2ZQ3ZX7F.js";
+
+// src/public/rest/data-alerts.ts
+var getDataAlerts = async (query, options) => invokeFetch("data-alerts", {
+  method: "get",
+  pathTemplate: "/api/v1/data-alerts",
+  query,
+  options
+});
+var createDataAlert = async (body, options) => invokeFetch("data-alerts", {
+  method: "post",
+  pathTemplate: "/api/v1/data-alerts",
+  body,
+  contentType: "application/json",
+  options
+});
+var triggerDataAlerts = async (body, options) => invokeFetch("data-alerts", {
+  method: "post",
+  pathTemplate: "/api/v1/data-alerts/actions/trigger",
+  body,
+  contentType: "application/json",
+  options
+});
+var validateDataAlerts = async (body, options) => invokeFetch("data-alerts", {
+  method: "post",
+  pathTemplate: "/api/v1/data-alerts/actions/validate",
+  body,
+  contentType: "application/json",
+  options
+});
+var getDataAlertsSettings = async (options) => invokeFetch("data-alerts", {
+  method: "get",
+  pathTemplate: "/api/v1/data-alerts/settings",
+  options
+});
+var setDataAlertsSettings = async (body, options) => invokeFetch("data-alerts", {
+  method: "put",
+  pathTemplate: "/api/v1/data-alerts/settings",
+  body,
+  contentType: "application/json",
+  options
+});
+var deleteDataAlert = async (alertId, options) => invokeFetch("data-alerts", {
+  method: "delete",
+  pathTemplate: "/api/v1/data-alerts/{alertId}",
+  pathVariables: { alertId },
+  options
+});
+var getDataAlert = async (alertId, options) => invokeFetch("data-alerts", {
+  method: "get",
+  pathTemplate: "/api/v1/data-alerts/{alertId}",
+  pathVariables: { alertId },
+  options
+});
+var patchDataAlert = async (alertId, body, options) => invokeFetch("data-alerts", {
+  method: "patch",
+  pathTemplate: "/api/v1/data-alerts/{alertId}",
+  pathVariables: { alertId },
+  body,
+  contentType: "application/json",
+  options
+});
+var getDataAlertCondition = async (alertId, options) => invokeFetch("data-alerts", {
+  method: "get",
+  pathTemplate: "/api/v1/data-alerts/{alertId}/condition",
+  pathVariables: { alertId },
+  options
+});
+var deleteDataAlertExecution = async (alertId, executionId, options) => invokeFetch("data-alerts", {
+  method: "delete",
+  pathTemplate: "/api/v1/data-alerts/{alertId}/executions/{executionId}",
+  pathVariables: { alertId, executionId },
+  options
+});
+var getDataAlertExecution = async (alertId, executionId, options) => invokeFetch("data-alerts", {
+  method: "get",
+  pathTemplate: "/api/v1/data-alerts/{alertId}/executions/{executionId}",
+  pathVariables: { alertId, executionId },
+  options
+});
+var getDataAlertRecipientStats = async (alertId, query, options) => invokeFetch("data-alerts", {
+  method: "get",
+  pathTemplate: "/api/v1/data-alerts/{alertId}/recipient-stats",
+  pathVariables: { alertId },
+  query,
+  options
+});
+var getDataAlertExecutions = async (taskId, query, options) => invokeFetch("data-alerts", {
+  method: "get",
+  pathTemplate: "/api/v1/data-alerts/{taskId}/executions",
+  pathVariables: { taskId },
+  query,
+  options
+});
+var getDataAlertExecutionsStats = async (taskId, query, options) => invokeFetch("data-alerts", {
+  method: "get",
+  pathTemplate: "/api/v1/data-alerts/{taskId}/executions/stats",
+  pathVariables: { taskId },
+  query,
+  options
+});
+var getDataAlertExecutionEvaluations = async (taskId, executionId, options) => invokeFetch("data-alerts", {
+  method: "get",
+  pathTemplate: "/api/v1/data-alerts/{taskId}/executions/{executionId}/evaluations",
+  pathVariables: { taskId, executionId },
+  options
+});
+function clearCache() {
+  return clearApiCache("data-alerts");
+}
+var dataAlertsExport = {
+  getDataAlerts,
+  createDataAlert,
+  triggerDataAlerts,
+  validateDataAlerts,
+  getDataAlertsSettings,
+  setDataAlertsSettings,
+  deleteDataAlert,
+  getDataAlert,
+  patchDataAlert,
+  getDataAlertCondition,
+  deleteDataAlertExecution,
+  getDataAlertExecution,
+  getDataAlertRecipientStats,
+  getDataAlertExecutions,
+  getDataAlertExecutionsStats,
+  getDataAlertExecutionEvaluations,
+  clearCache
+};
+var data_alerts_default = dataAlertsExport;
+export {
+  clearCache,
+  createDataAlert,
+  data_alerts_default as default,
+  deleteDataAlert,
+  deleteDataAlertExecution,
+  getDataAlert,
+  getDataAlertCondition,
+  getDataAlertExecution,
+  getDataAlertExecutionEvaluations,
+  getDataAlertExecutions,
+  getDataAlertExecutionsStats,
+  getDataAlertRecipientStats,
+  getDataAlerts,
+  getDataAlertsSettings,
+  patchDataAlert,
+  setDataAlertsSettings,
+  triggerDataAlerts,
+  validateDataAlerts
+};

package/data-assets.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/data-assets.ts

package/data-connections.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/data-connections.ts

package/data-credentials.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/data-credentials.ts

package/data-files.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/data-files.ts

package/data-qualities.d.ts

@@ -0,0 +1,175 @@
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
+
+/**
+ * The ID of the computation
+ */
+type ComputationResponse = {
+    computationId: string;
+};
+type ComputationStatusResponse = {
+    status: ExecutionStatus;
+};
+/**
+ * The ID of the connection
+ */
+type ConnectionIdType = string;
+/**
+ * Represents a data quality computation request. The `connectionId` attribute is optional for file-based datasets. If no sampling parameters (`executionMode`, `sampleMode`, `sampleSize`) are provided, the following default configuration is used: - `executionMode: PULLUP` - `sampleMode: ABSOLUTE` - `sampleSize: 1000`
+ * @example
+ * {
+ *   connectionId: "2b855c3d-426c-4aac-90cf-0edf9fc294d3",
+ *   datasetId: "669144f5aa2d642638ef1dd0"
+ * }
+ */
+type DataQualityComputationRequest = {
+    /** The ID of the connection */
+    connectionId?: ConnectionIdType;
+    /** The ID of the dataset */
+    datasetId?: DatasetIdType;
+} & SamplingConfiguration;
+/**
+ * The ID of the dataset
+ */
+type DatasetIdType = string;
+type DatasetQualityGlobalResultsResponse = {
+    /** The ID of the dataset */
+    datasetId: string;
+    qualities: QualitiesGlobalResultsResponse[];
+};
+type Error = {
+    code?: string;
+    detail?: string;
+    status?: string;
+    title?: string;
+};
+type ErrorResponse = {
+    errors?: Error[];
+    traceId?: string;
+};
+type ExecutionStatus = "PROFILE_REQUESTED" | "PROFILE_FAILED" | "REQUESTED" | "SUBMITTED" | "SUCCEEDED" | "FAILED";
+type QualitiesGlobalResultsResponse = {
+    /** The ID of the connection */
+    connectionId: string;
+    quality: QualityGlobalResultsResponse;
+};
+type QualityGlobalResultsResponse = {
+    /** Number of empty sample cells */
+    empty: number;
+    /** Number of invalid sample cells */
+    invalid: number;
+    /** Total number of cells in the sample */
+    total: number;
+    updatedAt: string;
+    /** Number of valid sample cells */
+    valid: number;
+};
+type SamplingConfiguration = {
+    /** Specifies where the data quality computation takes place. In PUSHDOWN mode, it runs within the Cloud Data Warehouse (e.g., Snowflake, Databricks), whereas in PULLUP mode, it runs in Qlik Cloud. */
+    executionMode?: "PUSHDOWN" | "PULLUP";
+    /** Specifies how the dataset is sampled. ABSOLUTE represents a fixed number of rows, while RELATIVE refers to a percentage of the total dataset rows. */
+    sampleMode?: "ABSOLUTE" | "RELATIVE";
+    /** The actual value of the selected sampling method size (either a fixed number for ABSOLUTE mode or a percentage for RELATIVE mode). */
+    sampleSize?: number;
+};
+/**
+ * Triggers the computation of data quality.
+ *
+ * @param body an object with the body content
+ * @throws TriggerDataQualitiesComputationHttpError
+ */
+declare const triggerDataQualitiesComputation: (body: DataQualityComputationRequest, options?: ApiCallOptions) => Promise<TriggerDataQualitiesComputationHttpResponse>;
+type TriggerDataQualitiesComputationHttpResponse = {
+    data: ComputationResponse;
+    headers: Headers;
+    status: 202;
+};
+type TriggerDataQualitiesComputationHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 500 | 503;
+};
+/**
+ * Returns the execution status of a data quality computation.
+ * @example
+ * getDataQualitiesComputation(
+ *   "4db06daa-3117-412e-8fb4-b29c937f9a0e"
+ * )
+ *
+ * @param computationId The ID of the computation
+ * @throws GetDataQualitiesComputationHttpError
+ */
+declare const getDataQualitiesComputation: (computationId: string, options?: ApiCallOptions) => Promise<GetDataQualitiesComputationHttpResponse>;
+type GetDataQualitiesComputationHttpResponse = {
+    data: ComputationStatusResponse;
+    headers: Headers;
+    status: 200;
+};
+type GetDataQualitiesComputationHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 500 | 503;
+};
+/**
+ * Returns the global data results for a dataset, including counts of total, valid, invalid, and empty sample cells.
+ *
+ * @param query an object with query parameters
+ * @throws GetDataQualitiesGlobalResultsHttpError
+ */
+declare const getDataQualitiesGlobalResults: (query: {
+    /** The connection ID */
+    connectionId?: ConnectionIdType;
+    /** The ID of the dataset */
+    datasetId: DatasetIdType;
+}, options?: ApiCallOptions) => Promise<GetDataQualitiesGlobalResultsHttpResponse>;
+type GetDataQualitiesGlobalResultsHttpResponse = {
+    data: DatasetQualityGlobalResultsResponse;
+    headers: Headers;
+    status: 200;
+};
+type GetDataQualitiesGlobalResultsHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 500 | 503;
+};
+/**
+ * Clears the cache for data-qualities api requests.
+ */
+declare function clearCache(): void;
+interface DataQualitiesAPI {
+    /**
+     * Triggers the computation of data quality.
+     *
+     * @param body an object with the body content
+     * @throws TriggerDataQualitiesComputationHttpError
+     */
+    triggerDataQualitiesComputation: typeof triggerDataQualitiesComputation;
+    /**
+     * Returns the execution status of a data quality computation.
+     * @example
+     * getDataQualitiesComputation(
+     *   "4db06daa-3117-412e-8fb4-b29c937f9a0e"
+     * )
+     *
+     * @param computationId The ID of the computation
+     * @throws GetDataQualitiesComputationHttpError
+     */
+    getDataQualitiesComputation: typeof getDataQualitiesComputation;
+    /**
+     * Returns the global data results for a dataset, including counts of total, valid, invalid, and empty sample cells.
+     *
+     * @param query an object with query parameters
+     * @throws GetDataQualitiesGlobalResultsHttpError
+     */
+    getDataQualitiesGlobalResults: typeof getDataQualitiesGlobalResults;
+    /**
+     * Clears the cache for data-qualities api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the data-qualities api
+ */
+declare const dataQualitiesExport: DataQualitiesAPI;
+
+export { type ComputationResponse, type ComputationStatusResponse, type ConnectionIdType, type DataQualitiesAPI, type DataQualityComputationRequest, type DatasetIdType, type DatasetQualityGlobalResultsResponse, type Error, type ErrorResponse, type ExecutionStatus, type GetDataQualitiesComputationHttpError, type GetDataQualitiesComputationHttpResponse, type GetDataQualitiesGlobalResultsHttpError, type GetDataQualitiesGlobalResultsHttpResponse, type QualitiesGlobalResultsResponse, type QualityGlobalResultsResponse, type SamplingConfiguration, type TriggerDataQualitiesComputationHttpError, type TriggerDataQualitiesComputationHttpResponse, clearCache, dataQualitiesExport as default, getDataQualitiesComputation, getDataQualitiesGlobalResults, triggerDataQualitiesComputation };

package/data-qualities.js

@@ -0,0 +1,44 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
+import "./chunks/2ZQ3ZX7F.js";
+
+// src/public/rest/data-qualities.ts
+var triggerDataQualitiesComputation = async (body, options) => invokeFetch("data-qualities", {
+  method: "post",
+  pathTemplate: "/api/v1/data-qualities/computations",
+  body,
+  contentType: "application/json",
+  options
+});
+var getDataQualitiesComputation = async (computationId, options) => invokeFetch("data-qualities", {
+  method: "get",
+  pathTemplate: "/api/v1/data-qualities/computations/{computationId}",
+  pathVariables: { computationId },
+  options
+});
+var getDataQualitiesGlobalResults = async (query, options) => invokeFetch("data-qualities", {
+  method: "get",
+  pathTemplate: "/api/v1/data-qualities/global-results",
+  query,
+  options
+});
+function clearCache() {
+  return clearApiCache("data-qualities");
+}
+var dataQualitiesExport = {
+  triggerDataQualitiesComputation,
+  getDataQualitiesComputation,
+  getDataQualitiesGlobalResults,
+  clearCache
+};
+var data_qualities_default = dataQualitiesExport;
+export {
+  clearCache,
+  data_qualities_default as default,
+  getDataQualitiesComputation,
+  getDataQualitiesGlobalResults,
+  triggerDataQualitiesComputation
+};