@qlik/api 1.30.0 → 1.32.0

package/automation-connections.d.ts

@@ -0,0 +1,366 @@
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
+
+type AutomationConnectionChangeOwnerObject = {
+    /** The unique identifier of the new owner. */
+    userId?: string;
+};
+type AutomationConnectionChangeSpaceObject = {
+    /** The unique identifier of the new space. */
+    spaceId?: string;
+};
+type AutomationConnectionCheckObject = {
+    /** The connection status of the automation connection. When true, the automation connection is connected. */
+    isConnected?: boolean;
+};
+type AutomationConnectionCreationObject = {
+    /** The unique identifier of the connector from which the automation connection is created. */
+    connectorId: string;
+    /** The name of the created automation connection. */
+    name?: string;
+    params?: AutomationConnectionParamCreateObject[];
+    /** The unique identifier of the space in which the automation connection is created. */
+    spaceId?: string;
+};
+type AutomationConnectionDetailObject = {
+    /** The unique identifier of the automation connector. */
+    connectorId?: string;
+    /** The timestamp when the automation connection was created. */
+    createdAt?: string;
+    /** This contains the error message if a connection is being created with an issue. */
+    error?: unknown;
+    /** The unique identifier of the automation connection. */
+    id?: string;
+    /** The connection status of the automation connection. When true, the automation connection is connected. */
+    isConnected?: boolean;
+    /** The name of the automation connection. */
+    name?: string;
+    /** The name of the OAuth account associated with the automation connection. */
+    oauthAccountName?: string;
+    /** The unique identifier of the owner of the automation connection. */
+    ownerId?: string;
+    params?: AutomationConnectionParamObject[];
+    /** The redirect of the OAuth account. */
+    redirect?: string;
+    /** The space ID of the automation connection. */
+    spaceId?: string;
+    /** The timestamp when the automation connection was updated. */
+    updatedAt?: string;
+};
+type AutomationConnectionParamCreateObject = {
+    /** The name of the automation connection parameter. */
+    name?: string;
+    /** The value of the automation connection parameter option. */
+    value?: string;
+};
+type AutomationConnectionParamObject = {
+    /** The documentation of the automation connection parameter. */
+    documentation?: string;
+    /** The example value of the automation connection parameter. */
+    exampleValue?: string;
+    /** The field type of the automation connection parameter. */
+    fieldType?: string;
+    /** The unique identifier of the automation connection parameter. */
+    id?: string;
+    /** When true, the parameter is optional. */
+    isOptional?: boolean;
+    /** The metadata of the automation connection parameter. */
+    meta?: unknown[];
+    /** The name of the automation connection parameter. */
+    name?: string;
+    /** The order that the automation connection configuration fields should be displayed in. */
+    order?: number;
+    paramOptions?: AutomationConnectionParamOptionObject[];
+    /** The value of the automation connection parameter. */
+    value?: string;
+};
+type AutomationConnectionParamOptionObject = {
+    /** The unique identifier of the automation connection parameter option. */
+    id?: string;
+    /** The value of the automation connection parameter option. */
+    value?: string;
+};
+type AutomationConnectionParamPutObject = {
+    /** The unique identifier of the automation connection parameter option. */
+    id?: string;
+    /** The value of the automation connection parameter option. */
+    value?: string;
+};
+type AutomationConnectionPutRequestObject = {
+    /** The new name of the automation connection to be renamed to. */
+    name?: string;
+    params?: AutomationConnectionParamPutObject[];
+};
+type AutomationConnectionsList = {
+    data?: AutomationConnectionsListObject[];
+    links?: Links;
+};
+type AutomationConnectionsListObject = {
+    /** The unique identifier of the connector the automation connection is created from. */
+    connectorId?: string;
+    /** The timestamp when the automation connection is created. */
+    createdAt?: string;
+    /** The unique identifier of an automation connection. */
+    id?: string;
+    /** Returns true if the automtion connection is connected. */
+    isConnected?: boolean;
+    /** The name of an automation connection. */
+    name?: string;
+    /** The unique identifier of the owner of the automation connection. */
+    ownerId?: string;
+    /** The space ID of the automation connection. */
+    spaceId?: string;
+    /** The timestamp when the automation connection is updated. */
+    updatedAt?: string;
+};
+type Error = {
+    /** The unique code for the error */
+    code: string;
+    /** May be used to provide additional details */
+    detail?: string;
+    /** A summary of what went wrong */
+    title: string;
+};
+type ErrorResponse = {
+    errors?: Error[];
+    /** A way to trace the source of the error. */
+    traceId?: string;
+};
+type Links = {
+    next?: PaginationLink;
+    prev?: PaginationLink;
+};
+type PaginationLink = {
+    /** The URL to a resource request */
+    href?: string;
+};
+/**
+ * Retrieves a list of automation connections
+ *
+ * @param query an object with query parameters
+ * @throws GetAutomationConnectionsHttpError
+ */
+declare const getAutomationConnections: (query: {
+    /** Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId. */
+    filter?: string;
+    /** The number of automation connections to retrieve. */
+    limit?: number;
+    /** When true, list all connections. Restricted to tenant admins and analytics admins. */
+    listAll?: boolean;
+    /** The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order) */
+    sort?: "id" | "name" | "createdAt" | "updatedAt" | "+id" | "+name" | "+createdAt" | "+updatedAt" | "-id" | "-name" | "-createdAt" | "-updatedAt";
+}, options?: ApiCallOptions) => Promise<GetAutomationConnectionsHttpResponse>;
+type GetAutomationConnectionsHttpResponse = {
+    data: AutomationConnectionsList;
+    headers: Headers;
+    status: 200;
+    prev?: (options?: ApiCallOptions) => Promise<GetAutomationConnectionsHttpResponse>;
+    next?: (options?: ApiCallOptions) => Promise<GetAutomationConnectionsHttpResponse>;
+};
+type GetAutomationConnectionsHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 500 | 503;
+};
+/**
+ * Creates a new connection object from an automation connector.
+ *
+ * @param body an object with the body content
+ * @throws CreateAutomationConnectionHttpError
+ */
+declare const createAutomationConnection: (body: AutomationConnectionCreationObject, options?: ApiCallOptions) => Promise<CreateAutomationConnectionHttpResponse>;
+type CreateAutomationConnectionHttpResponse = {
+    data: AutomationConnectionDetailObject;
+    headers: Headers;
+    status: 201;
+};
+type CreateAutomationConnectionHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 500 | 503;
+};
+/**
+ * Deletes the specified automation connection.
+ *
+ * @param id The unique identifier for the automation connection.
+ * @param query an object with query parameters
+ * @throws DeleteAutomationConnectionHttpError
+ */
+declare const deleteAutomationConnection: (id: string, query: {
+    /** When true, the automation connection will be deleted regardless of its usage by any automations. */
+    forced?: boolean;
+}, options?: ApiCallOptions) => Promise<DeleteAutomationConnectionHttpResponse>;
+type DeleteAutomationConnectionHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: 204;
+};
+type DeleteAutomationConnectionHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 500 | 503;
+};
+/**
+ * Returns details about the specified automation connection.
+ *
+ * @param id The unique identifier for the automation connection.
+ * @throws GetAutomationConnectionHttpError
+ */
+declare const getAutomationConnection: (id: string, options?: ApiCallOptions) => Promise<GetAutomationConnectionHttpResponse>;
+type GetAutomationConnectionHttpResponse = {
+    data: AutomationConnectionDetailObject;
+    headers: Headers;
+    status: 200;
+};
+type GetAutomationConnectionHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 500 | 503;
+};
+/**
+ * Updates the specified properties of an automation connection.
+ *
+ * @param id The unique identifier for the automation connection.
+ * @param body an object with the body content
+ * @throws UpdateAutomationConnectionHttpError
+ */
+declare const updateAutomationConnection: (id: string, body: AutomationConnectionPutRequestObject, options?: ApiCallOptions) => Promise<UpdateAutomationConnectionHttpResponse>;
+type UpdateAutomationConnectionHttpResponse = {
+    data: AutomationConnectionDetailObject;
+    headers: Headers;
+    status: 200;
+};
+type UpdateAutomationConnectionHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 500 | 503;
+};
+/**
+ * Changes the owner of an automation connection by specifying a new owner.
+ *
+ * @param id The unique identifier for the automation connection.
+ * @param body an object with the body content
+ * @throws ChangeOwnerAutomationConnectionHttpError
+ */
+declare const changeOwnerAutomationConnection: (id: string, body: AutomationConnectionChangeOwnerObject, options?: ApiCallOptions) => Promise<ChangeOwnerAutomationConnectionHttpResponse>;
+type ChangeOwnerAutomationConnectionHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: 204;
+};
+type ChangeOwnerAutomationConnectionHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 500 | 503;
+};
+/**
+ * Changes the space of an automation connection by specifying a new space.
+ *
+ * @param id The unique identifier for the automation connection.
+ * @param body an object with the body content
+ * @throws ChangeSpaceAutomationConnectionHttpError
+ */
+declare const changeSpaceAutomationConnection: (id: string, body: AutomationConnectionChangeSpaceObject, options?: ApiCallOptions) => Promise<ChangeSpaceAutomationConnectionHttpResponse>;
+type ChangeSpaceAutomationConnectionHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: 204;
+};
+type ChangeSpaceAutomationConnectionHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 500 | 503;
+};
+/**
+ * Tries to validate and checks the connection status of an automation connection.
+ *
+ * @param id The unique identifier for the automation connection.
+ * @throws CheckAutomationConnectionHttpError
+ */
+declare const checkAutomationConnection: (id: string, options?: ApiCallOptions) => Promise<CheckAutomationConnectionHttpResponse>;
+type CheckAutomationConnectionHttpResponse = {
+    data: AutomationConnectionCheckObject;
+    headers: Headers;
+    status: 200;
+};
+type CheckAutomationConnectionHttpError = {
+    data: ErrorResponse;
+    headers: Headers;
+    status: 400 | 401 | 403 | 404 | 500 | 503;
+};
+/**
+ * Clears the cache for automation-connections api requests.
+ */
+declare function clearCache(): void;
+interface AutomationConnectionsAPI {
+    /**
+     * Retrieves a list of automation connections
+     *
+     * @param query an object with query parameters
+     * @throws GetAutomationConnectionsHttpError
+     */
+    getAutomationConnections: typeof getAutomationConnections;
+    /**
+     * Creates a new connection object from an automation connector.
+     *
+     * @param body an object with the body content
+     * @throws CreateAutomationConnectionHttpError
+     */
+    createAutomationConnection: typeof createAutomationConnection;
+    /**
+     * Deletes the specified automation connection.
+     *
+     * @param id The unique identifier for the automation connection.
+     * @param query an object with query parameters
+     * @throws DeleteAutomationConnectionHttpError
+     */
+    deleteAutomationConnection: typeof deleteAutomationConnection;
+    /**
+     * Returns details about the specified automation connection.
+     *
+     * @param id The unique identifier for the automation connection.
+     * @throws GetAutomationConnectionHttpError
+     */
+    getAutomationConnection: typeof getAutomationConnection;
+    /**
+     * Updates the specified properties of an automation connection.
+     *
+     * @param id The unique identifier for the automation connection.
+     * @param body an object with the body content
+     * @throws UpdateAutomationConnectionHttpError
+     */
+    updateAutomationConnection: typeof updateAutomationConnection;
+    /**
+     * Changes the owner of an automation connection by specifying a new owner.
+     *
+     * @param id The unique identifier for the automation connection.
+     * @param body an object with the body content
+     * @throws ChangeOwnerAutomationConnectionHttpError
+     */
+    changeOwnerAutomationConnection: typeof changeOwnerAutomationConnection;
+    /**
+     * Changes the space of an automation connection by specifying a new space.
+     *
+     * @param id The unique identifier for the automation connection.
+     * @param body an object with the body content
+     * @throws ChangeSpaceAutomationConnectionHttpError
+     */
+    changeSpaceAutomationConnection: typeof changeSpaceAutomationConnection;
+    /**
+     * Tries to validate and checks the connection status of an automation connection.
+     *
+     * @param id The unique identifier for the automation connection.
+     * @throws CheckAutomationConnectionHttpError
+     */
+    checkAutomationConnection: typeof checkAutomationConnection;
+    /**
+     * Clears the cache for automation-connections api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the automation-connections api
+ */
+declare const automationConnectionsExport: AutomationConnectionsAPI;
+
+export { type AutomationConnectionChangeOwnerObject, type AutomationConnectionChangeSpaceObject, type AutomationConnectionCheckObject, type AutomationConnectionCreationObject, type AutomationConnectionDetailObject, type AutomationConnectionParamCreateObject, type AutomationConnectionParamObject, type AutomationConnectionParamOptionObject, type AutomationConnectionParamPutObject, type AutomationConnectionPutRequestObject, type AutomationConnectionsAPI, type AutomationConnectionsList, type AutomationConnectionsListObject, type ChangeOwnerAutomationConnectionHttpError, type ChangeOwnerAutomationConnectionHttpResponse, type ChangeSpaceAutomationConnectionHttpError, type ChangeSpaceAutomationConnectionHttpResponse, type CheckAutomationConnectionHttpError, type CheckAutomationConnectionHttpResponse, type CreateAutomationConnectionHttpError, type CreateAutomationConnectionHttpResponse, type DeleteAutomationConnectionHttpError, type DeleteAutomationConnectionHttpResponse, type Error, type ErrorResponse, type GetAutomationConnectionHttpError, type GetAutomationConnectionHttpResponse, type GetAutomationConnectionsHttpError, type GetAutomationConnectionsHttpResponse, type Links, type PaginationLink, type UpdateAutomationConnectionHttpError, type UpdateAutomationConnectionHttpResponse, changeOwnerAutomationConnection, changeSpaceAutomationConnection, checkAutomationConnection, clearCache, createAutomationConnection, automationConnectionsExport as default, deleteAutomationConnection, getAutomationConnection, getAutomationConnections, updateAutomationConnection };

package/automation-connections.js

@@ -0,0 +1,91 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
+import "./chunks/2ZQ3ZX7F.js";
+
+// src/public/rest/automation-connections.ts
+var getAutomationConnections = async (query, options) => invokeFetch("automation-connections", {
+  method: "get",
+  pathTemplate: "/api/v1/automation-connections",
+  query,
+  options
+});
+var createAutomationConnection = async (body, options) => invokeFetch("automation-connections", {
+  method: "post",
+  pathTemplate: "/api/v1/automation-connections",
+  body,
+  contentType: "application/json",
+  options
+});
+var deleteAutomationConnection = async (id, query, options) => invokeFetch("automation-connections", {
+  method: "delete",
+  pathTemplate: "/api/v1/automation-connections/{id}",
+  pathVariables: { id },
+  query,
+  options
+});
+var getAutomationConnection = async (id, options) => invokeFetch("automation-connections", {
+  method: "get",
+  pathTemplate: "/api/v1/automation-connections/{id}",
+  pathVariables: { id },
+  options
+});
+var updateAutomationConnection = async (id, body, options) => invokeFetch("automation-connections", {
+  method: "put",
+  pathTemplate: "/api/v1/automation-connections/{id}",
+  pathVariables: { id },
+  body,
+  contentType: "application/json",
+  options
+});
+var changeOwnerAutomationConnection = async (id, body, options) => invokeFetch("automation-connections", {
+  method: "post",
+  pathTemplate: "/api/v1/automation-connections/{id}/actions/change-owner",
+  pathVariables: { id },
+  body,
+  contentType: "application/json",
+  options
+});
+var changeSpaceAutomationConnection = async (id, body, options) => invokeFetch("automation-connections", {
+  method: "post",
+  pathTemplate: "/api/v1/automation-connections/{id}/actions/change-space",
+  pathVariables: { id },
+  body,
+  contentType: "application/json",
+  options
+});
+var checkAutomationConnection = async (id, options) => invokeFetch("automation-connections", {
+  method: "post",
+  pathTemplate: "/api/v1/automation-connections/{id}/actions/check",
+  pathVariables: { id },
+  options
+});
+function clearCache() {
+  return clearApiCache("automation-connections");
+}
+var automationConnectionsExport = {
+  getAutomationConnections,
+  createAutomationConnection,
+  deleteAutomationConnection,
+  getAutomationConnection,
+  updateAutomationConnection,
+  changeOwnerAutomationConnection,
+  changeSpaceAutomationConnection,
+  checkAutomationConnection,
+  clearCache
+};
+var automation_connections_default = automationConnectionsExport;
+export {
+  changeOwnerAutomationConnection,
+  changeSpaceAutomationConnection,
+  checkAutomationConnection,
+  clearCache,
+  createAutomationConnection,
+  automation_connections_default as default,
+  deleteAutomationConnection,
+  getAutomationConnection,
+  getAutomationConnections,
+  updateAutomationConnection
+};

package/automations.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 type AutomationDetailRequestObject = {
     description?: string;

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

package/automl-deployments.d.ts

@@ -0,0 +1,97 @@
+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;
+};
+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 const 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,27 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/VVD2DPKQ.js";
+import "./chunks/LTNGXTXG.js";
+import "./chunks/2ZQ3ZX7F.js";
+
+// src/public/rest/automl-deployments.ts
+var createAutomlDeploymentRealtimePrediction = async (deploymentId, query, body, options) => 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
+};