@qlik/api 2.4.1 → 2.5.0

package/ui-config.d.ts

@@ -1,6 +1,4 @@
-import { ApiCallOptions } from "./invoke-fetch-types.js";
-import "./chunks/invoke-fetch-DFc3yzaj.js";
-
+import { b as ApiCallOptions } from "./chunks/auth-types-DVvka7Hz.js";
 //#region src/public/rest/ui-config.d.ts
 type BulkCreatePinnedLinkItemPayload = CreatePinnedLinkConfigPayload & {
   links: CreatePinnedLinkPayload[];

package/ui-config.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-2KfyI2qM.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
+import "./chunks/public-runtime-modules-mBjjPn7I.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DxtIsSVQ.js";
 
 //#region src/public/rest/ui-config.ts
 /**

package/users.d.ts

@@ -1,6 +1,4 @@
-import { ApiCallOptions } from "./invoke-fetch-types.js";
-import "./chunks/invoke-fetch-DFc3yzaj.js";
-
+import { b as ApiCallOptions } from "./chunks/auth-types-DVvka7Hz.js";
 //#region src/public/rest/users.d.ts
 /**
  * An array of group references.

package/users.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-2KfyI2qM.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
+import "./chunks/public-runtime-modules-mBjjPn7I.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DxtIsSVQ.js";
 
 //#region src/public/rest/users.ts
 /**

package/web-integrations.d.ts

@@ -1,6 +1,4 @@
-import { ApiCallOptions } from "./invoke-fetch-types.js";
-import "./chunks/invoke-fetch-DFc3yzaj.js";
-
+import { b as ApiCallOptions } from "./chunks/auth-types-DVvka7Hz.js";
 //#region src/public/rest/web-integrations.d.ts
 /**
  * An error object describing the error.

package/web-integrations.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-2KfyI2qM.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
+import "./chunks/public-runtime-modules-mBjjPn7I.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DxtIsSVQ.js";
 
 //#region src/public/rest/web-integrations.ts
 /**

package/web-notifications.d.ts

@@ -1,6 +1,4 @@
-import { ApiCallOptions } from "./invoke-fetch-types.js";
-import "./chunks/invoke-fetch-DFc3yzaj.js";
-
+import { b as ApiCallOptions } from "./chunks/auth-types-DVvka7Hz.js";
 //#region src/public/rest/web-notifications.d.ts
 /**
  * An error object.

package/web-notifications.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-2KfyI2qM.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
+import "./chunks/public-runtime-modules-mBjjPn7I.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DxtIsSVQ.js";
 
 //#region src/public/rest/web-notifications.ts
 /**

package/webhooks.d.ts

@@ -1,17 +1,15 @@
-import { ApiCallOptions } from "./invoke-fetch-types.js";
-import "./chunks/invoke-fetch-DFc3yzaj.js";
-
+import { b as ApiCallOptions } from "./chunks/auth-types-DVvka7Hz.js";
 //#region src/public/rest/webhooks.d.ts
 type Delivery = {
   /** The name of the triggering event-type. */eventType: string; /** The delivery's unique identifier. */
   id: string; /** Request details for the delivery. */
   request?: {
-    /** The sent body/payload of the delivery. */body?: unknown; /** Headers sent for this delivery, values of encryptedHeaders are omitted as such "**OMITTED**". */
+    /** The sent body/payload of the delivery. */body?: unknown; /** Headers sent for this delivery, values of encryptedHeaders are omitted as such "**OMITTED**". Maximum size: 2048 bytes for non-encrypted headers + 2048 bytes for encrypted headers. */
     headers?: Record<string, string>; /** URL used for this delivery. */
     url?: string;
   }; /** Response details for the delivery. */
   response?: {
-    /** The received body of the delivery. */body?: string; /** Headers received for this delivery, values of encryptedHeaders are omitted as such "**OMITTED**". */
+    /** The received body of the delivery. */body?: string; /** Headers received for this delivery, values of encryptedHeaders are omitted as such "**OMITTED**". Maximum size: 2048 bytes for non-encrypted headers + 2048 bytes for encrypted headers. */
     headers?: Record<string, string>; /** The HTTP status code of the response. */
     statusCode?: number;
   }; /** The status of delivery. */
@@ -57,7 +55,7 @@ type WebhookBase = {
   readonly disabledReason?: string; /** The unique code for the reason. */
   readonly disabledReasonCode?: string; /** If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled. */
   enableCloudEventDelivery?: boolean; /** Whether the webhook is active and sending requests. */
-  enabled?: boolean; /** These headers are persisted encrypted and decrypted to be sent as normal headers in post request (webhook delivery), in case of URL change these headers will need to be re-entered. Note: duplicate headers are not allowed and are case-insensitive. */
+  enabled?: boolean; /** These headers are persisted encrypted and decrypted to be sent as normal headers in post request (webhook delivery), in case of URL change these headers will need to be re-entered. Note: duplicate headers are not allowed and are case-insensitive. Maximum size: 2048 bytes for encrypted headers. */
   encryptedHeaders?: Record<string, string>; /** Types of events for which the webhook should trigger. Retrieve available types from `/v1/webhooks/event-types`. */
   eventTypes?: string[];
   /** Filter that should match for a webhook to be triggered.
@@ -66,7 +64,7 @@ type WebhookBase = {
    * Supported logical operators are 'and' and 'or'.
    * Note that attribute values must be valid JSON strings, hence they're enclosed with double quotes.
    * For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation. */
-  filter?: string; /** Additional headers in the post request (webhook delivery). Note: duplicate headers are not allowed and are case-insensitive. */
+  filter?: string; /** Additional headers in the post request (webhook delivery). Note: duplicate headers are not allowed and are case-insensitive. Maximum size: 2048 bytes for non-encrypted headers. */
   headers?: Record<string, string>; /** The webhook's unique identifier. */
   readonly id?: string; /** Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator. */
   level?: "tenant" | "user"; /** The name for the webhook. */
@@ -107,7 +105,7 @@ type WebhookResponseBase = {
   readonly disabledReason?: string; /** The unique code for the reason. */
   readonly disabledReasonCode?: string; /** If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled. */
   enableCloudEventDelivery?: boolean; /** Whether the webhook is active and sending requests. */
-  enabled?: boolean; /** Additional encrypted headers in the post request. */
+  enabled?: boolean; /** Additional encrypted headers in the post request. Maximum size: 2048 bytes for encrypted headers. */
   encryptedHeaders?: string[]; /** Types of events for which the webhook should trigger. Retrieve available types from `/v1/webhooks/event-types`. */
   eventTypes?: string[];
   /** Filter that should match for a webhook to be triggered.
@@ -116,7 +114,7 @@ type WebhookResponseBase = {
    * Supported logical operators are 'and' and 'or'.
    * Note that attribute values must be valid JSON strings, hence they're enclosed with double quotes.
    * For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation. */
-  filter?: string; /** Additional headers in the post request. */
+  filter?: string; /** Additional headers in the post request. Maximum size: 2048 bytes for non-encrypted headers. */
   headers?: Record<string, string>; /** The webhook's unique identifier. */
   readonly id?: string; /** Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator. */
   level?: "tenant" | "user"; /** The name for the webhook. */

package/webhooks.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-2KfyI2qM.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
+import "./chunks/public-runtime-modules-mBjjPn7I.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DxtIsSVQ.js";
 
 //#region src/public/rest/webhooks.ts
 /**

package/workflows/automation-connections.d.ts

@@ -0,0 +1,317 @@
+import { b as ApiCallOptions } from "../chunks/auth-types-DVvka7Hz.js";
+declare namespace automation_connections_d_exports {
+  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 };
+}
+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. */connected?: boolean; /** The connection status of the automation connection. When true, the automation connection is connected. */
+  is_connected?: 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 the requesting user has access to.
+ *
+ * @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 | 409 | 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 workflows/automation-connections api requests.
+ */
+declare function clearCache(): void;
+type AutomationConnectionsAPI = {
+  /**
+   * Retrieves a list of automation connections the requesting user has access to.
+   *
+   * @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, automation_connections_d_exports as t, updateAutomationConnection };

package/workflows/automation-connections.js

@@ -0,0 +1,164 @@
+import { t as __exportAll } from "../chunks/chunk-BdHzlgOL.js";
+import "../chunks/public-runtime-modules-mBjjPn7I.js";
+import { n as invokeFetch, t as clearApiCache } from "../chunks/invoke-fetch-DxtIsSVQ.js";
+
+//#region src/public/rest/workflows/automation-connections.ts
+var automation_connections_exports = /* @__PURE__ */ __exportAll({
+	changeOwnerAutomationConnection: () => changeOwnerAutomationConnection,
+	changeSpaceAutomationConnection: () => changeSpaceAutomationConnection,
+	checkAutomationConnection: () => checkAutomationConnection,
+	clearCache: () => clearCache,
+	createAutomationConnection: () => createAutomationConnection,
+	default: () => automationConnectionsExport,
+	deleteAutomationConnection: () => deleteAutomationConnection,
+	getAutomationConnection: () => getAutomationConnection,
+	getAutomationConnections: () => getAutomationConnections,
+	updateAutomationConnection: () => updateAutomationConnection
+});
+/**
+* Retrieves a list of automation connections the requesting user has access to.
+*
+* @param query an object with query parameters
+* @throws GetAutomationConnectionsHttpError
+*/
+async function getAutomationConnections(query, options) {
+	return invokeFetch("workflows/automation-connections", {
+		method: "get",
+		pathTemplate: "/api/workflows/automation-connections",
+		query,
+		options
+	});
+}
+/**
+* Creates a new connection object from an automation connector.
+*
+* @param body an object with the body content
+* @throws CreateAutomationConnectionHttpError
+*/
+async function createAutomationConnection(body, options) {
+	return invokeFetch("workflows/automation-connections", {
+		method: "post",
+		pathTemplate: "/api/workflows/automation-connections",
+		body,
+		contentType: "application/json",
+		options
+	});
+}
+/**
+* Deletes the specified automation connection.
+*
+* @param id The unique identifier for the automation connection.
+* @param query an object with query parameters
+* @throws DeleteAutomationConnectionHttpError
+*/
+async function deleteAutomationConnection(id, query, options) {
+	return invokeFetch("workflows/automation-connections", {
+		method: "delete",
+		pathTemplate: "/api/workflows/automation-connections/{id}",
+		pathVariables: { id },
+		query,
+		options
+	});
+}
+/**
+* Returns details about the specified automation connection.
+*
+* @param id The unique identifier for the automation connection.
+* @throws GetAutomationConnectionHttpError
+*/
+async function getAutomationConnection(id, options) {
+	return invokeFetch("workflows/automation-connections", {
+		method: "get",
+		pathTemplate: "/api/workflows/automation-connections/{id}",
+		pathVariables: { id },
+		options
+	});
+}
+/**
+* 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
+*/
+async function updateAutomationConnection(id, body, options) {
+	return invokeFetch("workflows/automation-connections", {
+		method: "put",
+		pathTemplate: "/api/workflows/automation-connections/{id}",
+		pathVariables: { id },
+		body,
+		contentType: "application/json",
+		options
+	});
+}
+/**
+* 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
+*/
+async function changeOwnerAutomationConnection(id, body, options) {
+	return invokeFetch("workflows/automation-connections", {
+		method: "post",
+		pathTemplate: "/api/workflows/automation-connections/{id}/actions/change-owner",
+		pathVariables: { id },
+		body,
+		contentType: "application/json",
+		options
+	});
+}
+/**
+* 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
+*/
+async function changeSpaceAutomationConnection(id, body, options) {
+	return invokeFetch("workflows/automation-connections", {
+		method: "post",
+		pathTemplate: "/api/workflows/automation-connections/{id}/actions/change-space",
+		pathVariables: { id },
+		body,
+		contentType: "application/json",
+		options
+	});
+}
+/**
+* Tries to validate and checks the connection status of an automation connection.
+*
+* @param id The unique identifier for the automation connection.
+* @throws CheckAutomationConnectionHttpError
+*/
+async function checkAutomationConnection(id, options) {
+	return invokeFetch("workflows/automation-connections", {
+		method: "post",
+		pathTemplate: "/api/workflows/automation-connections/{id}/actions/check",
+		pathVariables: { id },
+		options
+	});
+}
+/**
+* Clears the cache for workflows/automation-connections api requests.
+*/
+function clearCache() {
+	return clearApiCache("workflows/automation-connections");
+}
+/**
+* Functions for the automation-connections api
+*/
+const automationConnectionsExport = {
+	getAutomationConnections,
+	createAutomationConnection,
+	deleteAutomationConnection,
+	getAutomationConnection,
+	updateAutomationConnection,
+	changeOwnerAutomationConnection,
+	changeSpaceAutomationConnection,
+	checkAutomationConnection,
+	clearCache
+};
+
+//#endregion
+export { changeOwnerAutomationConnection, changeSpaceAutomationConnection, checkAutomationConnection, clearCache, createAutomationConnection, automationConnectionsExport as default, deleteAutomationConnection, getAutomationConnection, getAutomationConnections, automation_connections_exports as t, updateAutomationConnection };