@qlik/api 2.2.0 → 2.3.0

package/automation-connections.d.ts

@@ -1,4 +1,367 @@
-import "./chunks/auth-types-E99tzdN0.js";
-import "./chunks/invoke-fetch-CbU2Dgqr.js";
-import { A as Links, B as deleteAutomationConnection, C as DeleteAutomationConnectionHttpResponse, D as GetAutomationConnectionHttpResponse, E as GetAutomationConnectionHttpError, F as changeOwnerAutomationConnection, H as getAutomationConnections, I as changeSpaceAutomationConnection, L as checkAutomationConnection, M as UpdateAutomationConnectionHttpError, N as UpdateAutomationConnectionHttpResponse, O as GetAutomationConnectionsHttpError, P as automationConnectionsExport, R as clearCache, S as DeleteAutomationConnectionHttpError, T as ErrorResponse, U as updateAutomationConnection, V as getAutomationConnection, _ as ChangeSpaceAutomationConnectionHttpResponse, a as AutomationConnectionDetailObject, b as CreateAutomationConnectionHttpError, c as AutomationConnectionParamOptionObject, d as AutomationConnectionsAPI, f as AutomationConnectionsList, g as ChangeSpaceAutomationConnectionHttpError, h as ChangeOwnerAutomationConnectionHttpResponse, i as AutomationConnectionCreationObject, j as PaginationLink, k as GetAutomationConnectionsHttpResponse, l as AutomationConnectionParamPutObject, m as ChangeOwnerAutomationConnectionHttpError, n as AutomationConnectionChangeSpaceObject, o as AutomationConnectionParamCreateObject, p as AutomationConnectionsListObject, r as AutomationConnectionCheckObject, s as AutomationConnectionParamObject, t as AutomationConnectionChangeOwnerObject, u as AutomationConnectionPutRequestObject, v as CheckAutomationConnectionHttpError, w as Error, x as CreateAutomationConnectionHttpResponse, y as CheckAutomationConnectionHttpResponse, z as createAutomationConnection } from "./chunks/automation-connections-k2G_n9rj.js";
+import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
+import "./chunks/invoke-fetch-C1Z0RJYU.js";
+
+//#region src/public/rest/automation-connections.d.ts
+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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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;
+type 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;
+//#endregion
 export { AutomationConnectionChangeOwnerObject, AutomationConnectionChangeSpaceObject, AutomationConnectionCheckObject, AutomationConnectionCreationObject, AutomationConnectionDetailObject, AutomationConnectionParamCreateObject, AutomationConnectionParamObject, AutomationConnectionParamOptionObject, AutomationConnectionParamPutObject, AutomationConnectionPutRequestObject, AutomationConnectionsAPI, AutomationConnectionsList, AutomationConnectionsListObject, ChangeOwnerAutomationConnectionHttpError, ChangeOwnerAutomationConnectionHttpResponse, ChangeSpaceAutomationConnectionHttpError, ChangeSpaceAutomationConnectionHttpResponse, CheckAutomationConnectionHttpError, CheckAutomationConnectionHttpResponse, CreateAutomationConnectionHttpError, CreateAutomationConnectionHttpResponse, DeleteAutomationConnectionHttpError, DeleteAutomationConnectionHttpResponse, Error, ErrorResponse, GetAutomationConnectionHttpError, GetAutomationConnectionHttpResponse, GetAutomationConnectionsHttpError, GetAutomationConnectionsHttpResponse, Links, PaginationLink, UpdateAutomationConnectionHttpError, UpdateAutomationConnectionHttpResponse, changeOwnerAutomationConnection, changeSpaceAutomationConnection, checkAutomationConnection, clearCache, createAutomationConnection, automationConnectionsExport as default, deleteAutomationConnection, getAutomationConnection, getAutomationConnections, updateAutomationConnection };

package/automation-connections.js

@@ -1,6 +1,5 @@
-import "./chunks/utils-BnC4lrlq.js";
-import "./chunks/public-runtime-modules-Dwjzb3l8.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
+import "./chunks/public-runtime-modules-QhLPeQr5.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
 
 //#region src/public/rest/automation-connections.ts
 /**

package/automation-connectors.d.ts

@@ -1,4 +1,85 @@
-import "./chunks/auth-types-E99tzdN0.js";
-import "./chunks/invoke-fetch-CbU2Dgqr.js";
-import { a as ErrorResponse, c as Links, d as clearCache, f as getAutomationConnectors, i as Error, l as PaginationLink, n as AutomationConnectorsList, o as GetAutomationConnectorsHttpError, r as AutomationConnectorsListObject, s as GetAutomationConnectorsHttpResponse, t as AutomationConnectorsAPI, u as automationConnectorsExport } from "./chunks/automation-connectors-J5OE-1P0.js";
+import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
+import "./chunks/invoke-fetch-C1Z0RJYU.js";
+
+//#region src/public/rest/automation-connectors.d.ts
+type AutomationConnectorsList = {
+  data?: AutomationConnectorsListObject[];
+  links?: Links;
+};
+type AutomationConnectorsListObject = {
+  /** Indicates if the connector is billable. */
+  billable?: boolean;
+  readonly id?: string;
+  /** The name of an automation connector. */
+  name?: 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 connectors.
+ *
+ * @param query an object with query parameters
+ * @throws GetAutomationConnectorsHttpError
+ */
+declare function getAutomationConnectors(query: {
+  /** Filters the result based on the specified criteria: name. */
+  filter?: string;
+  /** The number of automation connectors to retrieve. */
+  limit?: number;
+  /** The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order) */
+  sort?: "name" | "+name" | "-name";
+}, options?: ApiCallOptions): Promise<GetAutomationConnectorsHttpResponse>;
+type GetAutomationConnectorsHttpResponse = {
+  data: AutomationConnectorsList;
+  headers: Headers;
+  status: 200;
+  prev?: (options?: ApiCallOptions) => Promise<GetAutomationConnectorsHttpResponse>;
+  next?: (options?: ApiCallOptions) => Promise<GetAutomationConnectorsHttpResponse>;
+};
+type GetAutomationConnectorsHttpError = {
+  data: ErrorResponse;
+  headers: Headers;
+  status: 400 | 401 | 403 | 500 | 503;
+};
+/**
+ * Clears the cache for automation-connectors api requests.
+ */
+declare function clearCache(): void;
+type AutomationConnectorsAPI = {
+  /**
+   * Retrieves a list of automation connectors.
+   *
+   * @param query an object with query parameters
+   * @throws GetAutomationConnectorsHttpError
+   */
+  getAutomationConnectors: typeof getAutomationConnectors;
+  /**
+   * Clears the cache for automation-connectors api requests.
+   */
+  clearCache: typeof clearCache;
+};
+/**
+ * Functions for the automation-connectors api
+ */
+declare const automationConnectorsExport: AutomationConnectorsAPI;
+//#endregion
 export { AutomationConnectorsAPI, AutomationConnectorsList, AutomationConnectorsListObject, Error, ErrorResponse, GetAutomationConnectorsHttpError, GetAutomationConnectorsHttpResponse, Links, PaginationLink, clearCache, automationConnectorsExport as default, getAutomationConnectors };

package/automation-connectors.js

@@ -1,6 +1,5 @@
-import "./chunks/utils-BnC4lrlq.js";
-import "./chunks/public-runtime-modules-Dwjzb3l8.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
+import "./chunks/public-runtime-modules-QhLPeQr5.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
 
 //#region src/public/rest/automation-connectors.ts
 /**