@qlik/api 1.31.0 → 1.33.0

package/automations.js

@@ -1,131 +1,167 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/YKZ2QYHN.js";
-import "./chunks/DLKLPD7T.js";
-import "./chunks/2ZQ3ZX7F.js";
+} from "./chunks/LIEZG7IM.js";
+import "./chunks/GPRUNZV4.js";
+import "./chunks/7MMXU6EL.js";
 
 // src/public/rest/automations.ts
-var getAutomations = async (query, options) => invokeFetch("automations", {
-  method: "get",
-  pathTemplate: "/api/v1/automations",
-  query,
-  options
-});
-var createAutomation = async (body, options) => invokeFetch("automations", {
-  method: "post",
-  pathTemplate: "/api/v1/automations",
-  body,
-  contentType: "application/json",
-  options
-});
-var getAutomationsUsageMetrics = async (query, options) => invokeFetch("automations", {
-  method: "get",
-  pathTemplate: "/api/v1/automations/usage",
-  query,
-  options
-});
-var deleteAutomation = async (id, options) => invokeFetch("automations", {
-  method: "delete",
-  pathTemplate: "/api/v1/automations/{id}",
-  pathVariables: { id },
-  options
-});
-var getAutomationWithQuery = async (id, query, options) => invokeFetch("automations", {
-  method: "get",
-  pathTemplate: "/api/v1/automations/{id}",
-  pathVariables: { id },
-  query,
-  options
-});
-var getAutomation = async (id, options) => invokeFetch("automations", {
-  method: "get",
-  pathTemplate: "/api/v1/automations/{id}",
-  pathVariables: { id },
-  options
-});
-var updateAutomation = async (id, body, options) => invokeFetch("automations", {
-  method: "put",
-  pathTemplate: "/api/v1/automations/{id}",
-  pathVariables: { id },
-  body,
-  contentType: "application/json",
-  options
-});
-var copyAutomation = async (id, body, options) => invokeFetch("automations", {
-  method: "post",
-  pathTemplate: "/api/v1/automations/{id}/actions/copy",
-  pathVariables: { id },
-  body,
-  contentType: "application/json",
-  options
-});
-var disableAutomation = async (id, options) => invokeFetch("automations", {
-  method: "post",
-  pathTemplate: "/api/v1/automations/{id}/actions/disable",
-  pathVariables: { id },
-  options
-});
-var enableAutomation = async (id, options) => invokeFetch("automations", {
-  method: "post",
-  pathTemplate: "/api/v1/automations/{id}/actions/enable",
-  pathVariables: { id },
-  options
-});
-var moveAutomation = async (id, body, options) => invokeFetch("automations", {
-  method: "post",
-  pathTemplate: "/api/v1/automations/{id}/actions/move",
-  pathVariables: { id },
-  body,
-  contentType: "application/json",
-  options
-});
-var getAutomationRuns = async (id, query, options) => invokeFetch("automations", {
-  method: "get",
-  pathTemplate: "/api/v1/automations/{id}/runs",
-  pathVariables: { id },
-  query,
-  options
-});
-var queueAutomationRun = async (id, body, options) => invokeFetch("automations", {
-  method: "post",
-  pathTemplate: "/api/v1/automations/{id}/runs",
-  pathVariables: { id },
-  body,
-  contentType: "application/json",
-  options
-});
-var getAutomationRunWithQuery = async (id, runId, query, options) => invokeFetch("automations", {
-  method: "get",
-  pathTemplate: "/api/v1/automations/{id}/runs/{runId}",
-  pathVariables: { id, runId },
-  query,
-  options
-});
-var getAutomationRun = async (id, runId, options) => invokeFetch("automations", {
-  method: "get",
-  pathTemplate: "/api/v1/automations/{id}/runs/{runId}",
-  pathVariables: { id, runId },
-  options
-});
-var getAutomationRunDetails = async (id, runId, options) => invokeFetch("automations", {
-  method: "post",
-  pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/export",
-  pathVariables: { id, runId },
-  options
-});
-var retryAutomationRun = async (id, runId, options) => invokeFetch("automations", {
-  method: "post",
-  pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/retry",
-  pathVariables: { id, runId },
-  options
-});
-var stopAutomationRun = async (id, runId, options) => invokeFetch("automations", {
-  method: "post",
-  pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/stop",
-  pathVariables: { id, runId },
-  options
-});
+async function getAutomations(query, options) {
+  return invokeFetch("automations", {
+    method: "get",
+    pathTemplate: "/api/v1/automations",
+    query,
+    options
+  });
+}
+async function createAutomation(body, options) {
+  return invokeFetch("automations", {
+    method: "post",
+    pathTemplate: "/api/v1/automations",
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function getAutomationsUsageMetrics(query, options) {
+  return invokeFetch("automations", {
+    method: "get",
+    pathTemplate: "/api/v1/automations/usage",
+    query,
+    options
+  });
+}
+async function deleteAutomation(id, options) {
+  return invokeFetch("automations", {
+    method: "delete",
+    pathTemplate: "/api/v1/automations/{id}",
+    pathVariables: { id },
+    options
+  });
+}
+async function getAutomationWithQuery(id, query, options) {
+  return invokeFetch("automations", {
+    method: "get",
+    pathTemplate: "/api/v1/automations/{id}",
+    pathVariables: { id },
+    query,
+    options
+  });
+}
+async function getAutomation(id, options) {
+  return invokeFetch("automations", {
+    method: "get",
+    pathTemplate: "/api/v1/automations/{id}",
+    pathVariables: { id },
+    options
+  });
+}
+async function updateAutomation(id, body, options) {
+  return invokeFetch("automations", {
+    method: "put",
+    pathTemplate: "/api/v1/automations/{id}",
+    pathVariables: { id },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function copyAutomation(id, body, options) {
+  return invokeFetch("automations", {
+    method: "post",
+    pathTemplate: "/api/v1/automations/{id}/actions/copy",
+    pathVariables: { id },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function disableAutomation(id, options) {
+  return invokeFetch("automations", {
+    method: "post",
+    pathTemplate: "/api/v1/automations/{id}/actions/disable",
+    pathVariables: { id },
+    options
+  });
+}
+async function enableAutomation(id, options) {
+  return invokeFetch("automations", {
+    method: "post",
+    pathTemplate: "/api/v1/automations/{id}/actions/enable",
+    pathVariables: { id },
+    options
+  });
+}
+async function moveAutomation(id, body, options) {
+  return invokeFetch("automations", {
+    method: "post",
+    pathTemplate: "/api/v1/automations/{id}/actions/move",
+    pathVariables: { id },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function getAutomationRuns(id, query, options) {
+  return invokeFetch("automations", {
+    method: "get",
+    pathTemplate: "/api/v1/automations/{id}/runs",
+    pathVariables: { id },
+    query,
+    options
+  });
+}
+async function queueAutomationRun(id, body, options) {
+  return invokeFetch("automations", {
+    method: "post",
+    pathTemplate: "/api/v1/automations/{id}/runs",
+    pathVariables: { id },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function getAutomationRunWithQuery(id, runId, query, options) {
+  return invokeFetch("automations", {
+    method: "get",
+    pathTemplate: "/api/v1/automations/{id}/runs/{runId}",
+    pathVariables: { id, runId },
+    query,
+    options
+  });
+}
+async function getAutomationRun(id, runId, options) {
+  return invokeFetch("automations", {
+    method: "get",
+    pathTemplate: "/api/v1/automations/{id}/runs/{runId}",
+    pathVariables: { id, runId },
+    options
+  });
+}
+async function getAutomationRunDetails(id, runId, options) {
+  return invokeFetch("automations", {
+    method: "post",
+    pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/export",
+    pathVariables: { id, runId },
+    options
+  });
+}
+async function retryAutomationRun(id, runId, options) {
+  return invokeFetch("automations", {
+    method: "post",
+    pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/retry",
+    pathVariables: { id, runId },
+    options
+  });
+}
+async function stopAutomationRun(id, runId, options) {
+  return invokeFetch("automations", {
+    method: "post",
+    pathTemplate: "/api/v1/automations/{id}/runs/{runId}/actions/stop",
+    pathVariables: { id, runId },
+    options
+  });
+}
 function clearCache() {
   return clearApiCache("automations");
 }

package/automl-deployments.d.ts

@@ -0,0 +1,97 @@
+import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
+import './auth-types-Cj5bM3Yk.js';
+
+type AppErrorResponse = {
+    errors?: Error[];
+};
+type Error = {
+    /** The argument */
+    argument?: string;
+    /** The unique code for the error */
+    code: string;
+    /** The unique id of the error instance */
+    errorId?: string;
+    /** The issue code */
+    issue?: string;
+    meta?: {
+        /** The argument */
+        argument?: string;
+        /** Extra details for what may have caused the error */
+        details?: string;
+        /** The unique id of the error instance */
+        errorId?: string;
+        /** The resource type that the error occurred on */
+        resource?: string;
+        /** The resource id that the error occurred on */
+        resourceId?: string;
+    };
+    /** The resource type that the error occurred on */
+    resource?: string;
+    /** The resource id that the error occurred on */
+    resourceId?: string;
+    /** A summary of what went wrong */
+    title?: string;
+};
+type RealTimePredictionInputSchema = {
+    /** The name of a feature in the dataset. */
+    name?: string;
+};
+type RealtimePredictionInput = {
+    /** The rows of the dataset to produce predictions from. Date features must be in ISO 8601 format. */
+    rows?: string[][];
+    /** The schema of the input dataset. */
+    schema?: RealTimePredictionInputSchema[];
+};
+/**
+ * Generates predictions in a synchronous request and response.
+ *
+ * @param deploymentId The ID of the ML deployed model that will be employed to produce predictions.
+ * @param query an object with query parameters
+ * @param body an object with the body content
+ * @throws CreateAutomlDeploymentRealtimePredictionHttpError
+ */
+declare function createAutomlDeploymentRealtimePrediction(deploymentId: string, query: {
+    /** If true, will include a column with the reason why a prediction was not produced. */
+    includeNotPredictedReason?: boolean;
+    /** If true, the shapley values will be included in the response. */
+    includeShap?: boolean;
+    /** If true, the source data will be included in the response */
+    includeSource?: boolean;
+    /** The name of the feature in the source data to use as an index in the response data. The column will be included with its original name and values. This is intended to allow the caller to join results with source data. */
+    index?: string;
+}, body: RealtimePredictionInput, options?: ApiCallOptions): Promise<CreateAutomlDeploymentRealtimePredictionHttpResponse>;
+type CreateAutomlDeploymentRealtimePredictionHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: 200;
+};
+type CreateAutomlDeploymentRealtimePredictionHttpError = {
+    data: AppErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 409 | 503;
+};
+/**
+ * Clears the cache for automl-deployments api requests.
+ */
+declare function clearCache(): void;
+interface AutomlDeploymentsAPI {
+    /**
+     * Generates predictions in a synchronous request and response.
+     *
+     * @param deploymentId The ID of the ML deployed model that will be employed to produce predictions.
+     * @param query an object with query parameters
+     * @param body an object with the body content
+     * @throws CreateAutomlDeploymentRealtimePredictionHttpError
+     */
+    createAutomlDeploymentRealtimePrediction: typeof createAutomlDeploymentRealtimePrediction;
+    /**
+     * Clears the cache for automl-deployments api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the automl-deployments api
+ */
+declare const automlDeploymentsExport: AutomlDeploymentsAPI;
+
+export { type AppErrorResponse, type AutomlDeploymentsAPI, type CreateAutomlDeploymentRealtimePredictionHttpError, type CreateAutomlDeploymentRealtimePredictionHttpResponse, type Error, type RealTimePredictionInputSchema, type RealtimePredictionInput, clearCache, createAutomlDeploymentRealtimePrediction, automlDeploymentsExport as default };

package/automl-deployments.js

@@ -0,0 +1,29 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/LIEZG7IM.js";
+import "./chunks/GPRUNZV4.js";
+import "./chunks/7MMXU6EL.js";
+
+// src/public/rest/automl-deployments.ts
+async function createAutomlDeploymentRealtimePrediction(deploymentId, query, body, options) {
+  return invokeFetch("automl-deployments", {
+    method: "post",
+    pathTemplate: "/api/v1/automl-deployments/{deploymentId}/realtime-predictions",
+    pathVariables: { deploymentId },
+    query,
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+function clearCache() {
+  return clearApiCache("automl-deployments");
+}
+var automlDeploymentsExport = { createAutomlDeploymentRealtimePrediction, clearCache };
+var automl_deployments_default = automlDeploymentsExport;
+export {
+  clearCache,
+  createAutomlDeploymentRealtimePrediction,
+  automl_deployments_default as default
+};

package/automl-predictions.d.ts

@@ -0,0 +1,214 @@
+import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
+import './auth-types-Cj5bM3Yk.js';
+
+type AppErrorResponse = {
+    errors?: Error[];
+};
+type Error = {
+    /** The argument */
+    argument?: string;
+    /** The unique code for the error */
+    code: string;
+    /** The unique id of the error instance */
+    errorId?: string;
+    /** The issue code */
+    issue?: string;
+    meta?: {
+        /** The argument */
+        argument?: string;
+        /** Extra details for what may have caused the error */
+        details?: string;
+        /** The unique id of the error instance */
+        errorId?: string;
+        /** The resource type that the error occurred on */
+        resource?: string;
+        /** The resource id that the error occurred on */
+        resourceId?: string;
+    };
+    /** The resource type that the error occurred on */
+    resource?: string;
+    /** The resource id that the error occurred on */
+    resourceId?: string;
+    /** A summary of what went wrong */
+    title?: string;
+};
+/**
+ * Returns a file containing the shapley values in coordinate form that are associated with a prediction ID.
+ *
+ * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+ * @param query an object with query parameters
+ * @throws GetAutomlPredictionCoordinateShapHttpError
+ */
+declare function getAutomlPredictionCoordinateShap(predictionId: string, query: {
+    refId?: string;
+}, options?: ApiCallOptions): Promise<GetAutomlPredictionCoordinateShapHttpResponse>;
+type GetAutomlPredictionCoordinateShapHttpResponse = {
+    data: string;
+    headers: Headers;
+    status: 200;
+};
+type GetAutomlPredictionCoordinateShapHttpError = {
+    data: AppErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 409 | 503;
+};
+/**
+ * Retrieve jobs that are associated with a prediction. Job with correlation type `prediction`.
+ *
+ * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+ * @throws CreateAutomlPredictionJobHttpError
+ */
+declare function createAutomlPredictionJob(predictionId: string, options?: ApiCallOptions): Promise<CreateAutomlPredictionJobHttpResponse>;
+type CreateAutomlPredictionJobHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: 200;
+};
+type CreateAutomlPredictionJobHttpError = {
+    data: AppErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 409 | 503;
+};
+/**
+ * Returns a file containing any rows in a prediction operation where a prediction was unable to be produced.
+ *
+ * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+ * @param query an object with query parameters
+ * @throws GetAutomlPredictionNotPredictedReasonsHttpError
+ */
+declare function getAutomlPredictionNotPredictedReasons(predictionId: string, query: {
+    refId?: string;
+}, options?: ApiCallOptions): Promise<GetAutomlPredictionNotPredictedReasonsHttpResponse>;
+type GetAutomlPredictionNotPredictedReasonsHttpResponse = {
+    data: string;
+    headers: Headers;
+    status: 200;
+};
+type GetAutomlPredictionNotPredictedReasonsHttpError = {
+    data: AppErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 409 | 503;
+};
+/**
+ * Returns a file containing the predicted values that are associated with a prediction ID.
+ *
+ * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+ * @param query an object with query parameters
+ * @throws GetAutomlPredictionPredictionsHttpError
+ */
+declare function getAutomlPredictionPredictions(predictionId: string, query: {
+    refId?: string;
+}, options?: ApiCallOptions): Promise<GetAutomlPredictionPredictionsHttpResponse>;
+type GetAutomlPredictionPredictionsHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: 200;
+};
+type GetAutomlPredictionPredictionsHttpError = {
+    data: AppErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 409 | 503;
+};
+/**
+ * Returns a file containing the shapley values that are associated with a prediction ID.
+ *
+ * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+ * @param query an object with query parameters
+ * @throws GetAutomlPredictionShapHttpError
+ */
+declare function getAutomlPredictionShap(predictionId: string, query: {
+    refId?: string;
+}, options?: ApiCallOptions): Promise<GetAutomlPredictionShapHttpResponse>;
+type GetAutomlPredictionShapHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: 200;
+};
+type GetAutomlPredictionShapHttpError = {
+    data: AppErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 409 | 503;
+};
+/**
+ * Returns a file containing the source values and an index field that are associated with a prediction ID.
+ *
+ * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+ * @param query an object with query parameters
+ * @throws GetAutomlPredictionSourceHttpError
+ */
+declare function getAutomlPredictionSource(predictionId: string, query: {
+    refId?: string;
+}, options?: ApiCallOptions): Promise<GetAutomlPredictionSourceHttpResponse>;
+type GetAutomlPredictionSourceHttpResponse = {
+    data: string;
+    headers: Headers;
+    status: 200;
+};
+type GetAutomlPredictionSourceHttpError = {
+    data: AppErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 409 | 503;
+};
+/**
+ * Clears the cache for automl-predictions api requests.
+ */
+declare function clearCache(): void;
+interface AutomlPredictionsAPI {
+    /**
+     * Returns a file containing the shapley values in coordinate form that are associated with a prediction ID.
+     *
+     * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+     * @param query an object with query parameters
+     * @throws GetAutomlPredictionCoordinateShapHttpError
+     */
+    getAutomlPredictionCoordinateShap: typeof getAutomlPredictionCoordinateShap;
+    /**
+     * Retrieve jobs that are associated with a prediction. Job with correlation type `prediction`.
+     *
+     * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+     * @throws CreateAutomlPredictionJobHttpError
+     */
+    createAutomlPredictionJob: typeof createAutomlPredictionJob;
+    /**
+     * Returns a file containing any rows in a prediction operation where a prediction was unable to be produced.
+     *
+     * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+     * @param query an object with query parameters
+     * @throws GetAutomlPredictionNotPredictedReasonsHttpError
+     */
+    getAutomlPredictionNotPredictedReasons: typeof getAutomlPredictionNotPredictedReasons;
+    /**
+     * Returns a file containing the predicted values that are associated with a prediction ID.
+     *
+     * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+     * @param query an object with query parameters
+     * @throws GetAutomlPredictionPredictionsHttpError
+     */
+    getAutomlPredictionPredictions: typeof getAutomlPredictionPredictions;
+    /**
+     * Returns a file containing the shapley values that are associated with a prediction ID.
+     *
+     * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+     * @param query an object with query parameters
+     * @throws GetAutomlPredictionShapHttpError
+     */
+    getAutomlPredictionShap: typeof getAutomlPredictionShap;
+    /**
+     * Returns a file containing the source values and an index field that are associated with a prediction ID.
+     *
+     * @param predictionId The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.
+     * @param query an object with query parameters
+     * @throws GetAutomlPredictionSourceHttpError
+     */
+    getAutomlPredictionSource: typeof getAutomlPredictionSource;
+    /**
+     * Clears the cache for automl-predictions api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the automl-predictions api
+ */
+declare const automlPredictionsExport: AutomlPredictionsAPI;
+
+export { type AppErrorResponse, type AutomlPredictionsAPI, type CreateAutomlPredictionJobHttpError, type CreateAutomlPredictionJobHttpResponse, type Error, type GetAutomlPredictionCoordinateShapHttpError, type GetAutomlPredictionCoordinateShapHttpResponse, type GetAutomlPredictionNotPredictedReasonsHttpError, type GetAutomlPredictionNotPredictedReasonsHttpResponse, type GetAutomlPredictionPredictionsHttpError, type GetAutomlPredictionPredictionsHttpResponse, type GetAutomlPredictionShapHttpError, type GetAutomlPredictionShapHttpResponse, type GetAutomlPredictionSourceHttpError, type GetAutomlPredictionSourceHttpResponse, clearCache, createAutomlPredictionJob, automlPredictionsExport as default, getAutomlPredictionCoordinateShap, getAutomlPredictionNotPredictedReasons, getAutomlPredictionPredictions, getAutomlPredictionShap, getAutomlPredictionSource };