@qlik/api 1.30.0 → 1.32.0

package/automl-predictions.d.ts

@@ -0,0 +1,214 @@
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.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 const 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 const 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 const 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 const 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 const 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 const 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 };

package/automl-predictions.js

@@ -0,0 +1,72 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
+import "./chunks/2ZQ3ZX7F.js";
+
+// src/public/rest/automl-predictions.ts
+var getAutomlPredictionCoordinateShap = async (predictionId, query, options) => invokeFetch("automl-predictions", {
+  method: "get",
+  pathTemplate: "/api/v1/automl-predictions/{predictionId}/coordinate-shap",
+  pathVariables: { predictionId },
+  query,
+  options
+});
+var createAutomlPredictionJob = async (predictionId, options) => invokeFetch("automl-predictions", {
+  method: "post",
+  pathTemplate: "/api/v1/automl-predictions/{predictionId}/jobs",
+  pathVariables: { predictionId },
+  options
+});
+var getAutomlPredictionNotPredictedReasons = async (predictionId, query, options) => invokeFetch("automl-predictions", {
+  method: "get",
+  pathTemplate: "/api/v1/automl-predictions/{predictionId}/not-predicted-reasons",
+  pathVariables: { predictionId },
+  query,
+  options
+});
+var getAutomlPredictionPredictions = async (predictionId, query, options) => invokeFetch("automl-predictions", {
+  method: "get",
+  pathTemplate: "/api/v1/automl-predictions/{predictionId}/predictions",
+  pathVariables: { predictionId },
+  query,
+  options
+});
+var getAutomlPredictionShap = async (predictionId, query, options) => invokeFetch("automl-predictions", {
+  method: "get",
+  pathTemplate: "/api/v1/automl-predictions/{predictionId}/shap",
+  pathVariables: { predictionId },
+  query,
+  options
+});
+var getAutomlPredictionSource = async (predictionId, query, options) => invokeFetch("automl-predictions", {
+  method: "get",
+  pathTemplate: "/api/v1/automl-predictions/{predictionId}/source",
+  pathVariables: { predictionId },
+  query,
+  options
+});
+function clearCache() {
+  return clearApiCache("automl-predictions");
+}
+var automlPredictionsExport = {
+  getAutomlPredictionCoordinateShap,
+  createAutomlPredictionJob,
+  getAutomlPredictionNotPredictedReasons,
+  getAutomlPredictionPredictions,
+  getAutomlPredictionShap,
+  getAutomlPredictionSource,
+  clearCache
+};
+var automl_predictions_default = automlPredictionsExport;
+export {
+  clearCache,
+  createAutomlPredictionJob,
+  automl_predictions_default as default,
+  getAutomlPredictionCoordinateShap,
+  getAutomlPredictionNotPredictedReasons,
+  getAutomlPredictionPredictions,
+  getAutomlPredictionShap,
+  getAutomlPredictionSource
+};

package/brands.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions, D as DownloadableBlob } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions, D as DownloadableBlob } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 /**
  * A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.

package/brands.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/brands.ts

package/chunks/{JIX6RMFP.js → 6ZONDHRN.js}

@@ -5,7 +5,7 @@ import {
   invokeFetch,
   invoke_fetch_default,
   parseFetchResponse
-} from "./G6QUM5WQ.js";
+} from "./FKDGGR2O.js";
 import "./3RGGGGAR.js";
 import "./2ZQ3ZX7F.js";
 export {

package/chunks/ETNHFALU.js

@@ -0,0 +1,61 @@
+// src/qix/session/websocket-errors.ts
+var closeCodeEngineTerminating = 4003;
+var closeCodeEngineProxyGeneric = 4200;
+var closeCodeClientTimeout = 4201;
+var closeCodeBadRequest = 4202;
+var closeCodePermissions = 4203;
+var closeCodeNotFound = 4204;
+var closeCodeTooManyRequests = 4205;
+var closeCodeNetwork = 4206;
+var closeCodeDependencyGeneric = 4210;
+var closeCodeDependencyUnavailable = 4211;
+var closeCodeEngineGeneric = 4220;
+var closeCodeEntitlement = 4230;
+var closeCodeNoEnginesAvailable = 4240;
+var CloseCodeSessionReservationMissing = 4222;
+var closeCodeMessages = {
+  1e3: "Connection closed normally.",
+  1001: "Going away.",
+  1002: "Protocol error.",
+  1003: "Unsupported data.",
+  1005: "No status received.",
+  1006: "Abnormal closure.",
+  1007: "Invalid frame payload data.",
+  1008: "Policy violation.",
+  1009: "Message too big.",
+  1010: "Mandatory extension missing.",
+  1011: "Server internal error.",
+  1012: "Service restart.",
+  1013: "Try again later.",
+  1014: "Bad gateway.",
+  1015: "TLS handshake failure.",
+  [closeCodeEngineTerminating]: "The engine is in terminating state",
+  [closeCodeEngineProxyGeneric]: "A problem occurred in engine-proxy",
+  [closeCodeClientTimeout]: "The client has closed the connection",
+  [closeCodeBadRequest]: "The provided request is invalid and/or malformed",
+  [closeCodePermissions]: "No permission to open the app",
+  [closeCodeNotFound]: "App not found",
+  [closeCodeTooManyRequests]: "Too many requests have been sent in a given amount of time",
+  [closeCodeNetwork]: "Networking issues",
+  [closeCodeDependencyGeneric]: "A problem occurred in a dependency of engine-proxy",
+  [closeCodeDependencyUnavailable]: "A dependency is unavailable and not serving any requests",
+  [closeCodeEngineGeneric]: "A problem occurred in an engine",
+  [closeCodeEntitlement]: "You are not entitled to perform that operation",
+  [closeCodeNoEnginesAvailable]: "There are currently no engines available",
+  [CloseCodeSessionReservationMissing]: "The reserved session is missing"
+};
+var uknownCloseErrorMessage = "websocket closed for unknown reason";
+function getHumanReadableSocketClosedErrorMessage(err, { appId, hostConfig }) {
+  const closeCode = err?.original?.code || err?.code;
+  const reason = err?.original?.reason || err?.reason;
+  const closeMessage = closeCode && closeCodeMessages[closeCode] || reason || err.message || uknownCloseErrorMessage;
+  if (hostConfig?.host) {
+    return `Failed to open app ${appId} on ${hostConfig?.host}: ${closeMessage}`;
+  } else {
+    return `Failed to open app ${appId}: ${closeMessage}`;
+  }
+}
+
+export {
+  getHumanReadableSocketClosedErrorMessage
+};