@qlik/api 1.31.0 → 1.33.0

package/ml.js

@@ -0,0 +1,477 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/LIEZG7IM.js";
+import "./chunks/GPRUNZV4.js";
+import "./chunks/7MMXU6EL.js";
+
+// src/public/rest/ml.ts
+async function getMlDeployments(query, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/deployments",
+    query,
+    options
+  });
+}
+async function createMlDeployment(body, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/deployments",
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function deleteMlDeployment(deploymentId, options) {
+  return invokeFetch("ml", {
+    method: "delete",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}",
+    pathVariables: { deploymentId },
+    options
+  });
+}
+async function getMlDeployment(deploymentId, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}",
+    pathVariables: { deploymentId },
+    options
+  });
+}
+async function patchMlDeployment(deploymentId, body, options) {
+  return invokeFetch("ml", {
+    method: "patch",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}",
+    pathVariables: { deploymentId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function activateModelsMlDeployment(deploymentId, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/actions/activate-models",
+    pathVariables: { deploymentId },
+    options
+  });
+}
+async function deactivateModelsMlDeployment(deploymentId, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/actions/deactivate-models",
+    pathVariables: { deploymentId },
+    options
+  });
+}
+async function getMlDeploymentAliases(deploymentId, query, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases",
+    pathVariables: { deploymentId },
+    query,
+    options
+  });
+}
+async function createMlDeploymentAliase(deploymentId, body, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases",
+    pathVariables: { deploymentId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function deleteMlDeploymentAliase(deploymentId, aliasId, options) {
+  return invokeFetch("ml", {
+    method: "delete",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}",
+    pathVariables: { deploymentId, aliasId },
+    options
+  });
+}
+async function getMlDeploymentAliase(deploymentId, aliasId, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}",
+    pathVariables: { deploymentId, aliasId },
+    options
+  });
+}
+async function patchMlDeploymentAliase(deploymentId, aliasId, body, options) {
+  return invokeFetch("ml", {
+    method: "patch",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}",
+    pathVariables: { deploymentId, aliasId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function runMlDeploymentAliaseRealtimePredictions(deploymentId, aliasName, query, body, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/aliases/{aliasName}/realtime-predictions/actions/run",
+    pathVariables: { deploymentId, aliasName },
+    query,
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function getMlDeploymentBatchPredictions(deploymentId, query, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions",
+    pathVariables: { deploymentId },
+    query,
+    options
+  });
+}
+async function createMlDeploymentBatchPrediction(deploymentId, body, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions",
+    pathVariables: { deploymentId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function deleteMlDeploymentBatchPrediction(deploymentId, batchPredictionId, options) {
+  return invokeFetch("ml", {
+    method: "delete",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}",
+    pathVariables: { deploymentId, batchPredictionId },
+    options
+  });
+}
+async function getMlDeploymentBatchPrediction(deploymentId, batchPredictionId, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}",
+    pathVariables: { deploymentId, batchPredictionId },
+    options
+  });
+}
+async function patchMlDeploymentBatchPrediction(deploymentId, batchPredictionId, body, options) {
+  return invokeFetch("ml", {
+    method: "patch",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}",
+    pathVariables: { deploymentId, batchPredictionId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function predictMlDeploymentBatchPrediction(deploymentId, batchPredictionId, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/actions/predict",
+    pathVariables: { deploymentId, batchPredictionId },
+    options
+  });
+}
+async function deleteMlDeploymentBatchPredictionSchedule(deploymentId, batchPredictionId, options) {
+  return invokeFetch("ml", {
+    method: "delete",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule",
+    pathVariables: { deploymentId, batchPredictionId },
+    options
+  });
+}
+async function getMlDeploymentBatchPredictionSchedule(deploymentId, batchPredictionId, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule",
+    pathVariables: { deploymentId, batchPredictionId },
+    options
+  });
+}
+async function updateMlDeploymentBatchPredictionSchedule(deploymentId, batchPredictionId, body, options) {
+  return invokeFetch("ml", {
+    method: "patch",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule",
+    pathVariables: { deploymentId, batchPredictionId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function setMlDeploymentBatchPredictionSchedule(deploymentId, batchPredictionId, body, options) {
+  return invokeFetch("ml", {
+    method: "put",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule",
+    pathVariables: { deploymentId, batchPredictionId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function addMlDeploymentModels(deploymentId, body, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/models/actions/add",
+    pathVariables: { deploymentId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function removeMlDeploymentModels(deploymentId, body, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/models/actions/remove",
+    pathVariables: { deploymentId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function runMlDeploymentRealtimePredictions(deploymentId, query, body, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/deployments/{deploymentId}/realtime-predictions/actions/run",
+    pathVariables: { deploymentId },
+    query,
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function getMlExperiments(query, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/experiments",
+    query,
+    options
+  });
+}
+async function createMlExperiment(body, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/experiments",
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function deleteMlExperiment(experimentId, options) {
+  return invokeFetch("ml", {
+    method: "delete",
+    pathTemplate: "/api/v1/ml/experiments/{experimentId}",
+    pathVariables: { experimentId },
+    options
+  });
+}
+async function getMlExperiment(experimentId, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/experiments/{experimentId}",
+    pathVariables: { experimentId },
+    options
+  });
+}
+async function patchMlExperiment(experimentId, body, options) {
+  return invokeFetch("ml", {
+    method: "patch",
+    pathTemplate: "/api/v1/ml/experiments/{experimentId}",
+    pathVariables: { experimentId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function getMlExperimentModels(experimentId, query, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/experiments/{experimentId}/models",
+    pathVariables: { experimentId },
+    query,
+    options
+  });
+}
+async function getMlExperimentModel(experimentId, modelId, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/experiments/{experimentId}/models/{modelId}",
+    pathVariables: { experimentId, modelId },
+    options
+  });
+}
+async function getMlExperimentVersions(experimentId, query, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/experiments/{experimentId}/versions",
+    pathVariables: { experimentId },
+    query,
+    options
+  });
+}
+async function createMlExperimentVersion(experimentId, body, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/experiments/{experimentId}/versions",
+    pathVariables: { experimentId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function deleteMlExperimentVersion(experimentId, experimentVersionId, options) {
+  return invokeFetch("ml", {
+    method: "delete",
+    pathTemplate: "/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}",
+    pathVariables: { experimentId, experimentVersionId },
+    options
+  });
+}
+async function getMlExperimentVersion(experimentId, experimentVersionId, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}",
+    pathVariables: { experimentId, experimentVersionId },
+    options
+  });
+}
+async function patchMlExperimentVersion(experimentId, experimentVersionId, body, options) {
+  return invokeFetch("ml", {
+    method: "patch",
+    pathTemplate: "/api/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}",
+    pathVariables: { experimentId, experimentVersionId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function cancelMlJob(corrType, corrId, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/jobs/{corrType}/{corrId}/actions/cancel",
+    pathVariables: { corrType, corrId },
+    options
+  });
+}
+async function createMlProfileInsight(body, options) {
+  return invokeFetch("ml", {
+    method: "post",
+    pathTemplate: "/api/v1/ml/profile-insights",
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function getMlProfileInsightWithQuery(dataSetId, query, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/profile-insights/{dataSetId}",
+    pathVariables: { dataSetId },
+    query,
+    options
+  });
+}
+async function getMlProfileInsight(dataSetId, options) {
+  return invokeFetch("ml", {
+    method: "get",
+    pathTemplate: "/api/v1/ml/profile-insights/{dataSetId}",
+    pathVariables: { dataSetId },
+    options
+  });
+}
+function clearCache() {
+  return clearApiCache("ml");
+}
+var mlExport = {
+  getMlDeployments,
+  createMlDeployment,
+  deleteMlDeployment,
+  getMlDeployment,
+  patchMlDeployment,
+  activateModelsMlDeployment,
+  deactivateModelsMlDeployment,
+  getMlDeploymentAliases,
+  createMlDeploymentAliase,
+  deleteMlDeploymentAliase,
+  getMlDeploymentAliase,
+  patchMlDeploymentAliase,
+  runMlDeploymentAliaseRealtimePredictions,
+  getMlDeploymentBatchPredictions,
+  createMlDeploymentBatchPrediction,
+  deleteMlDeploymentBatchPrediction,
+  getMlDeploymentBatchPrediction,
+  patchMlDeploymentBatchPrediction,
+  predictMlDeploymentBatchPrediction,
+  deleteMlDeploymentBatchPredictionSchedule,
+  getMlDeploymentBatchPredictionSchedule,
+  updateMlDeploymentBatchPredictionSchedule,
+  setMlDeploymentBatchPredictionSchedule,
+  addMlDeploymentModels,
+  removeMlDeploymentModels,
+  runMlDeploymentRealtimePredictions,
+  getMlExperiments,
+  createMlExperiment,
+  deleteMlExperiment,
+  getMlExperiment,
+  patchMlExperiment,
+  getMlExperimentModels,
+  getMlExperimentModel,
+  getMlExperimentVersions,
+  createMlExperimentVersion,
+  deleteMlExperimentVersion,
+  getMlExperimentVersion,
+  patchMlExperimentVersion,
+  cancelMlJob,
+  createMlProfileInsight,
+  getMlProfileInsightWithQuery,
+  getMlProfileInsight,
+  clearCache
+};
+var ml_default = mlExport;
+export {
+  activateModelsMlDeployment,
+  addMlDeploymentModels,
+  cancelMlJob,
+  clearCache,
+  createMlDeployment,
+  createMlDeploymentAliase,
+  createMlDeploymentBatchPrediction,
+  createMlExperiment,
+  createMlExperimentVersion,
+  createMlProfileInsight,
+  deactivateModelsMlDeployment,
+  ml_default as default,
+  deleteMlDeployment,
+  deleteMlDeploymentAliase,
+  deleteMlDeploymentBatchPrediction,
+  deleteMlDeploymentBatchPredictionSchedule,
+  deleteMlExperiment,
+  deleteMlExperimentVersion,
+  getMlDeployment,
+  getMlDeploymentAliase,
+  getMlDeploymentAliases,
+  getMlDeploymentBatchPrediction,
+  getMlDeploymentBatchPredictionSchedule,
+  getMlDeploymentBatchPredictions,
+  getMlDeployments,
+  getMlExperiment,
+  getMlExperimentModel,
+  getMlExperimentModels,
+  getMlExperimentVersion,
+  getMlExperimentVersions,
+  getMlExperiments,
+  getMlProfileInsight,
+  getMlProfileInsightWithQuery,
+  patchMlDeployment,
+  patchMlDeploymentAliase,
+  patchMlDeploymentBatchPrediction,
+  patchMlExperiment,
+  patchMlExperimentVersion,
+  predictMlDeploymentBatchPrediction,
+  removeMlDeploymentModels,
+  runMlDeploymentAliaseRealtimePredictions,
+  runMlDeploymentRealtimePredictions,
+  setMlDeploymentBatchPredictionSchedule,
+  updateMlDeploymentBatchPredictionSchedule
+};

package/notes.d.ts

@@ -0,0 +1,110 @@
+import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
+import './auth-types-Cj5bM3Yk.js';
+
+/**
+ * The possible states for the status of notes configuration GET or POST operation
+ */
+type ConfigReasonCode = "deployment" | "toggle" | "license";
+type Error = {
+    /** Error code specific to notes broker service. */
+    readonly code?: string;
+    /** Error cause. */
+    readonly detail?: string;
+    /** Error title. */
+    readonly title?: string;
+};
+/**
+ * @example
+ * {
+ *   errors: [
+ *     {
+ *       code: "HTTP-123",
+ *       title: "short error message"
+ *     }
+ *   ],
+ *   traceId: "7326ce0d-1946-41d0-b890-609865cc42ea"
+ * }
+ */
+type Errors = {
+    errors?: Error[];
+    /** An optional traceId */
+    traceId?: string;
+};
+type NoteSettingsPutPayload = {
+    /** pass 'true' to enable the note toggle for the tenant, 'false' to disable the toggle (other values are ignore). */
+    toggledOn?: boolean;
+};
+type NoteSettingsPutResponse = {
+    /** 'true' if the note feature is enabled for this tenant and user otherwise 'false'. */
+    toggleOn?: boolean;
+};
+type NotesUserSettings = {
+    /** 'true' if the note feature is enabled for this tenant and user otherwise 'false'. */
+    available: boolean;
+    /** The timestamp for the last time this users notes settings were fetched from downstream services. */
+    lastFetch?: string;
+    /** The possible states for the status of notes configuration GET or POST operation */
+    reason?: ConfigReasonCode;
+};
+/**
+ * Get the enablement status of the notes feature set for this tenant and user.
+ *
+ * @throws GetNotesSettingsHttpError
+ */
+declare function getNotesSettings(options?: ApiCallOptions): Promise<GetNotesSettingsHttpResponse>;
+type GetNotesSettingsHttpResponse = {
+    data: NotesUserSettings;
+    headers: Headers;
+    status: 200;
+};
+type GetNotesSettingsHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * update the settings
+ *
+ * @param body an object with the body content
+ * @throws SetNotesSettingsHttpError
+ */
+declare function setNotesSettings(body: NoteSettingsPutPayload, options?: ApiCallOptions): Promise<SetNotesSettingsHttpResponse>;
+type SetNotesSettingsHttpResponse = {
+    data: NoteSettingsPutResponse;
+    headers: Headers;
+    status: 200;
+};
+type SetNotesSettingsHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Clears the cache for notes api requests.
+ */
+declare function clearCache(): void;
+interface NotesAPI {
+    /**
+     * Get the enablement status of the notes feature set for this tenant and user.
+     *
+     * @throws GetNotesSettingsHttpError
+     */
+    getNotesSettings: typeof getNotesSettings;
+    /**
+     * update the settings
+     *
+     * @param body an object with the body content
+     * @throws SetNotesSettingsHttpError
+     */
+    setNotesSettings: typeof setNotesSettings;
+    /**
+     * Clears the cache for notes api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the notes api
+ */
+declare const notesExport: NotesAPI;
+
+export { type ConfigReasonCode, type Error, type Errors, type GetNotesSettingsHttpError, type GetNotesSettingsHttpResponse, type NoteSettingsPutPayload, type NoteSettingsPutResponse, type NotesAPI, type NotesUserSettings, type SetNotesSettingsHttpError, type SetNotesSettingsHttpResponse, clearCache, notesExport as default, getNotesSettings, setNotesSettings };

package/notes.js

@@ -0,0 +1,35 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/LIEZG7IM.js";
+import "./chunks/GPRUNZV4.js";
+import "./chunks/7MMXU6EL.js";
+
+// src/public/rest/notes.ts
+async function getNotesSettings(options) {
+  return invokeFetch("notes", {
+    method: "get",
+    pathTemplate: "/api/v1/notes/settings",
+    options
+  });
+}
+async function setNotesSettings(body, options) {
+  return invokeFetch("notes", {
+    method: "put",
+    pathTemplate: "/api/v1/notes/settings",
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+function clearCache() {
+  return clearApiCache("notes");
+}
+var notesExport = { getNotesSettings, setNotesSettings, clearCache };
+var notes_default = notesExport;
+export {
+  clearCache,
+  notes_default as default,
+  getNotesSettings,
+  setNotesSettings
+};