@qlik/api 2.4.0 → 2.5.0

package/automations.d.ts

@@ -1,33 +1,30 @@
-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/automations.d.ts
 type AutomationDetailRequestObject = {
   description?: string; /** Maximum number of concurrent runs allowed for this automation. The maximum value is defined in automations settings. */
   maxConcurrentRuns?: number;
   name?: string;
   schedules?: ScheduleRequestObject[];
-  spaceId?: string;
-  state?: "available" | "unavailable" | "disabled"; /** The workspace generated by the Qlik Automate editor. */
+  spaceId?: string; /** The workspace generated by the Qlik Automate editor. */
   workspace?: unknown;
 };
 type AutomationDetailResponseObject = {
-  /** A list of connectors that were detected the workspace. This includes Connectors present in blocks which are not connected to other blocks. Order of guids is not guaranteed. */readonly connectorIds?: string[];
-  readonly createdAt?: string;
-  description?: string; /** A list of endpoints that were detected inside the workspace. This includes Endpoints present in blocks which are not connected to other blocks. Order of guids is not guaranteed. */
-  readonly endpointIds?: string[];
+  /** A list of connectors that were detected in the workspace. This includes connectors present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. */readonly connectorIds?: string[];
+  readonly createdAt?: string; /** The description of the automation. */
+  description?: string; /** A list of endpoints that were detected in the workspace. This includes endpoints present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. */
+  readonly endpointIds?: string[]; /** Execution token required to authorize the execution of the automation. */
   readonly executionToken?: string;
   readonly id?: string;
-  lastRun?: RunDetailResponseObject;
-  readonly lastRunAt?: string;
+  lastRun?: RunDetailResponseObject; /** The date and time when the last automation run was finished. */
+  readonly lastRunAt?: string; /** The status of the last run of the automation. */
   readonly lastRunStatus?: "failed" | "finished" | "finished with warnings" | "must stop" | "not started" | "paused" | "running" | "starting" | "stopped" | "exceeded limit"; /** Maximum number of concurrent runs allowed for this automation. */
-  readonly maxConcurrentRuns?: number;
-  name?: string;
-  readonly ownerId?: string;
+  readonly maxConcurrentRuns?: number; /** The name of the automation. */
+  name?: string; /** The unique identifier of the owner of the automation. */
+  readonly ownerId?: string; /** Defines how the automation run is started. */
   readonly runMode?: "manual" | "scheduled" | "triggered" | "webhook";
-  schedules?: ScheduleResponseObject[]; /** A list of snippets that were detected inside the workspace. This includes snippet blocks that are not connected to other blocks. Order of guids is not guaranteed. */
-  readonly snippetIds?: string[];
-  readonly spaceId?: string;
+  schedules?: ScheduleResponseObject[]; /** A list of snippets that were detected in the workspace. This includes snippet blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. */
+  readonly snippetIds?: string[]; /** The unique identifier of the space that contains the automation. */
+  readonly spaceId?: string; /** The state of the automation. */
   state?: "available" | "unavailable" | "disabled";
   readonly updatedAt?: string; /** The workspace generated by the Qlik Automate editor. */
   workspace?: unknown;
@@ -44,29 +41,28 @@ type AutomationList = {
   links?: Links;
 };
 type AutomationListObject = {
-  /** A list of connectors that were detected the workspace. This includes Connectors present in blocks which are not connected to other blocks. Order of guids is not guaranteed. */readonly connectorIds?: string[];
-  readonly createdAt?: string;
-  description?: string; /** Duration of the last run, indicated in seconds. Calculated from start and stop times */
-  readonly duration?: number; /** A list of endpoints that were detected inside the workspace. This includes Endpoints present in blocks which are not connected to other blocks. Order of guids is not guaranteed. */
+  /** A list of connectors that were detected in the workspace. This includes connectors present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. */readonly connectorIds?: string[];
+  readonly createdAt?: string; /** The description of the automation. */
+  description?: string; /** Duration of the last run, indicated in seconds. Calculated from start and stop times. */
+  readonly duration?: number; /** A list of endpoints that were detected in the workspace. This includes endpoints present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. */
   readonly endpointIds?: string[];
-  readonly executionToken?: string;
+  readonly executionToken?: string; /** The unique identifier for the automation. */
   readonly id?: string;
-  lastRun?: RunDetailResponseObject;
-  readonly lastRunAt?: string;
+  lastRun?: RunDetailResponseObject; /** The date and time when the last automation run was finished. */
+  readonly lastRunAt?: string; /** The status of the last run of the automation. */
   readonly lastRunStatus?: "failed" | "finished" | "finished with warnings" | "must stop" | "not started" | "paused" | "running" | "starting" | "stopped" | "exceeded limit"; /** Maximum number of concurrent runs allowed for automation. */
-  readonly maxConcurrentRuns?: number;
-  name?: string;
-  readonly ownerId?: string;
-  readonly runMode?: "manual" | "scheduled" | "triggered" | "webhook"; /** A list of snippets that were detected inside the workspace. This includes snippet blocks that are not connected to other blocks. Order of guids is not guaranteed. */
-  readonly snippetIds?: string[];
-  readonly spaceId?: string;
+  readonly maxConcurrentRuns?: number; /** The name of the automation. */
+  name?: string; /** The unique identifier of the owner of the automation. */
+  readonly ownerId?: string; /** Defines how the automation run is started. */
+  readonly runMode?: "manual" | "scheduled" | "triggered" | "webhook"; /** A list of snippets that were detected in the workspace. This includes snippet blocks that are not connected to other blocks. Order of GUIDs is not guaranteed. */
+  readonly snippetIds?: string[]; /** The unique identifier of the space that contains the automation. */
+  readonly spaceId?: string; /** The state of the automation. */
   state?: "available" | "unavailable" | "disabled";
   readonly updatedAt?: string; /** The workspace contains the JSON representation of the used blocks */
   readonly workspace?: unknown;
 };
 type AutomationUsageObject = {
-  /** Duration of the last run, indicated in seconds. Calculated from start and stop times */duration?: number; /** The unique identifier for the automation. */
-  guid?: string; /** The name for the automation. */
+  /** The unique identifier for the automation. */guid?: string; /** The name for the automation. */
   name?: string; /** The unique identifier for the user who owns the automation */
   ownerId?: string;
 };
@@ -91,17 +87,18 @@ type RunDetailRequestObject = {
   readonly id?: string;
 };
 type RunDetailResponseObject = {
-  /** The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items). */context?: "test_run" | "editor" | "detail" | "api_sync" | "api_async" | "webhook" | "lookup";
-  readonly createdAt?: string;
-  error?: unknown;
-  readonly executedById?: string;
-  readonly id?: string;
-  readonly isArchived?: boolean;
+  /** Indicates if this automation run is archived. */readonly archived?: boolean; /** The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items). */
+  context?: "test_run" | "editor" | "detail" | "api_sync" | "api_async" | "webhook" | "lookup";
+  readonly createdAt?: string; /** List of errors that occurred during the automation run. */
+  error?: unknown[]; /** The unique identifier of the user who executed the automation run. */
+  readonly executedById?: string; /** The unique identifier of the run. */
+  readonly id?: string; /** Indicates if this automation run is archived. */
+  readonly isArchived?: boolean; /** Indicates if this automation run is a test run. */
   readonly isTestRun?: boolean;
   metrics?: {
     /** List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks */blocks?: {
       /** API calls to external resources made by the current block. */apiCalls?: number; /** Unique identifier for the connector used within the block of the execution. */
-      connectorId?: string; /** Unique identifier for the snippet block used within the execution. */
+      connectorId?: string; /** Unique identifier for the endpoint block used within the execution. */
       endpointId?: string; /** Total amount of received bytes sent by the current block. */
       rxBytes: number; /** Unique identifier for the snippet block used within the execution. */
       snippetId?: string; /** Total amount of sent bytes sent by the current block. */
@@ -109,17 +106,18 @@ type RunDetailResponseObject = {
       type: "snippetBlock" | "endpointBlock";
     }[];
     network?: {
-      /** The number of received bytes. */rxBytes?: number; /** The number of received bytes. */
+      /** The number of received bytes. */rxBytes?: number; /** The number of sent bytes. */
       txBytes?: number;
     }; /** The number of API calls made. */
     totalApiCalls?: number;
-  };
-  readonly ownerId?: string;
-  readonly scheduledStartTime?: string;
-  readonly spaceId?: string;
-  readonly startTime?: string;
-  status?: "failed" | "finished" | "finished with warnings" | "must stop" | "not started" | "running" | "starting" | "stopped" | "exceeded limit" | "queued";
-  readonly stopTime?: string;
+  }; /** The unique identifier of the owner of the automation run. */
+  readonly ownerId?: string; /** The date and time at which the automation run is scheduled to start. */
+  readonly scheduledStartTime?: string; /** The unique identifier of the space in which the automation run is created. */
+  readonly spaceId?: string; /** The date and time at which the automation run started. */
+  readonly startTime?: string; /** The current status of the automation run. */
+  status?: "failed" | "finished" | "finished with warnings" | "must stop" | "not started" | "running" | "starting" | "stopped" | "exceeded limit" | "queued"; /** The date and time at which the automation run stopped. */
+  readonly stopTime?: string; /** Indicates if this automation run is a test run. */
+  readonly testRun?: boolean; /** The title of the automation run. */
   title?: string;
   readonly updatedAt?: string;
 };
@@ -128,20 +126,22 @@ type RunList = {
   links?: Links;
 };
 type RunListObject = {
+  /** Indicates if this automation run is archived. */readonly archived?: boolean; /** The context set by the source that triggers the automation. */
   context?: "test_run" | "editor" | "detail" | "api_sync" | "api_async" | "webhook" | "lookup";
   readonly createdAt?: string; /** Duration of the run, indicated in seconds. Calculated from start and stop times */
-  readonly duration?: number;
-  error?: unknown;
+  readonly duration?: number; /** List of errors that occurred during the automation run. */
+  error?: unknown[]; /** The unique identifier of the user who executed the automation run. */
   readonly executedById?: string;
-  readonly id?: string;
-  readonly isArchived?: boolean;
-  readonly isTestRun?: boolean;
-  readonly ownerId?: string;
-  readonly scheduledStartTime?: string;
-  readonly spaceId?: string;
-  readonly startTime?: string;
-  status?: "failed" | "finished" | "finished with warnings" | "must stop" | "not started" | "running" | "starting" | "stopped" | "exceeded limit" | "queued";
-  readonly stopTime?: string;
+  readonly id?: string; /** Indicates if this automation run is archived. */
+  readonly isArchived?: boolean; /** Indicates if this automation run is a test run. */
+  readonly isTestRun?: boolean; /** The unique identifier of the owner of the automation run. */
+  readonly ownerId?: string; /** The date and time at which the automation run is scheduled to start. */
+  readonly scheduledStartTime?: string; /** The unique identifier of the space in which the automation run is created. */
+  readonly spaceId?: string; /** The date and time at which the automation run started. */
+  readonly startTime?: string; /** The current status of the automation run. */
+  status?: "failed" | "finished" | "finished with warnings" | "must stop" | "not started" | "running" | "starting" | "stopped" | "exceeded limit" | "queued"; /** The date and time at which the automation run stopped. */
+  readonly stopTime?: string; /** Indicates if this automation run is a test run. */
+  readonly testRun?: boolean; /** The title of the automation run. */
   title?: string;
   readonly updatedAt?: string;
 };
@@ -161,7 +161,6 @@ type ScheduleResponseObject = {
 };
 type UsageList = {
   data?: UsageObject[];
-  links?: Links;
 };
 type UsageObject = {
   automation?: AutomationUsageObject; /** The date for the metric */
@@ -171,24 +170,15 @@ type UsageObject = {
 };
 /**
  * Retrieves a list of the automations that the requesting user has access to.
- * @example
- * getAutomations(
- *   {
- *     fields: "lastRun,lastRunStatus,runMode,createdAt,updatedAt"
- *   }
- * )
  *
  * @param query an object with query parameters
  * @throws GetAutomationsHttpError
  */
 declare function getAutomations(query: {
-  /** Allows to select the actual fields to be returned. When no fields are defined, all are returned. */fields?: string; /** Allowed filters: name, runMode, lastRunStatus, ownerId, spaceId */
-  filter?: string; /** The number of automations to retrieve. */
+  /** Allowed filters: `name`, `runMode`, `lastRunStatus`, `ownerId`, `spaceId`. */filter?: string; /** The number of automations to retrieve. */
   limit?: number; /** When true, list all automations. 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)
-   * The `duration` option is deprecated and will be removed in a future release. */
-  sort?: "id" | "name" | "runMode" | "state" | "createdAt" | "updatedAt" | "lastRunAt" | "lastRunStatus" | "duration" | "+id" | "+name" | "+runMode" | "+state" | "+createdAt" | "+updatedAt" | "+lastRunAt" | "+lastRunStatus" | "-id" | "-name" | "-runMode" | "-state" | "-createdAt" | "-updatedAt" | "-lastRunAt" | "-lastRunStatus" | "+duration" | "-duration" | "maxConcurrentRuns" | "+maxConcurrentRuns" | "-maxConcurrentRuns";
+  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" | "runMode" | "state" | "createdAt" | "updatedAt" | "lastRunAt" | "lastRunStatus" | "+id" | "+name" | "+runMode" | "+state" | "+createdAt" | "+updatedAt" | "+lastRunAt" | "+lastRunStatus" | "-id" | "-name" | "-runMode" | "-state" | "-createdAt" | "-updatedAt" | "-lastRunAt" | "-lastRunStatus" | "maxConcurrentRuns" | "+maxConcurrentRuns" | "-maxConcurrentRuns";
 }, options?: ApiCallOptions): Promise<GetAutomationsHttpResponse>;
 type GetAutomationsHttpResponse = {
   data: AutomationList;
@@ -203,7 +193,7 @@ type GetAutomationsHttpError = {
   status: 400 | 401 | 403 | 500 | 503;
 };
 /**
- * Creates a new automation. The requesting user must be assigned the `AutomationCreator` role.
+ * Creates a new automation. The requesting user must be assigned the `AutomationCreator` role or have at least one of the following scopes: `automations`, `admin.automations`, `automations.private` or `automations.shared`.
  *
  * @param body an object with the body content
  * @throws CreateAutomationHttpError
@@ -220,7 +210,7 @@ type CreateAutomationHttpError = {
   status: 400 | 401 | 403 | 500 | 503;
 };
 /**
- * Retrieves paginated usage metrics for automations. The requesting user must be assigned the `TenantAdmin` role.
+ * Retrieves paginated usage metrics for automations. The requesting user must be assigned the `TenantAdmin` or `AnalyticsAdmin` role.
  *
  * @param query an object with query parameters
  * @throws GetAutomationsUsageMetricsHttpError
@@ -228,7 +218,7 @@ type CreateAutomationHttpError = {
 declare function getAutomationsUsageMetrics(query: {
   /** If specified, result will be broken apart for each automation */breakdownBy?: string;
   /** Indicates how the metrics should be filtered using a SCIM-style expression. Available parameters:
-   * - name (specify one or more enums to return specific metrics. Supported enum values: `runs`, `scheduledRun`, `triggeredRun`, `webhookRuns`, `duration`, `bandwidthIn`, `bandwidthOut`)
+   * - name (specify one or more enums to return specific metrics. Supported enum values: `runs`, `scheduledRuns`, `triggeredRuns`, `webhookRuns`, `duration`, `bandwidthIn`, `bandwidthOut`)
    * - date (return a metric for a specific date or range of dates, e.g. "2025-08-01") */
   filter: string;
 }, options?: ApiCallOptions): Promise<GetAutomationsUsageMetricsHttpResponse>;
@@ -236,8 +226,6 @@ type GetAutomationsUsageMetricsHttpResponse = {
   data: UsageList;
   headers: Headers;
   status: 200;
-  prev?: (options?: ApiCallOptions) => Promise<GetAutomationsUsageMetricsHttpResponse>;
-  next?: (options?: ApiCallOptions) => Promise<GetAutomationsUsageMetricsHttpResponse>;
 };
 type GetAutomationsUsageMetricsHttpError = {
   data: ErrorResponse;
@@ -245,7 +233,10 @@ type GetAutomationsUsageMetricsHttpError = {
   status: 400 | 401 | 403 | 500 | 503;
 };
 /**
- * Deletes an automation. The requesting user must be the owner of the automation, or be assigned the `TenantAdmin` role.
+ * Deletes an automation. The requesting user must meet at least one of the following conditions:
+ * - be the owner of the automation
+ * - be assigned one of the following roles: `AnalyticsAdmin`, `TenantAdmin`
+ * - have at least one of the following scopes: `admin.automations`, `admin.automations:strict`, `automations.private`, or `automations.shared`
  *
  * @param id The unique identifier for the automation.
  * @throws DeleteAutomationHttpError
@@ -262,15 +253,13 @@ type DeleteAutomationHttpError = {
   status: 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retrieves the full definition of an automation. The requesting user must be the owner of the automation.
+ * Retrieves the full definition of an automation. The requesting user must be the owner of the automation and either be assigned one of the roles: `AutomationsCreator`, `TenantAdmin` or have at least one of the following scopes (depending on whether the automation is in a private or shared space): `automations`, `automations.private` or `automations.shared`.
  *
  * @param id The unique identifier for the automation.
  * @param query an object with query parameters
  * @throws GetAutomationWithQueryHttpError
  */
-declare function getAutomationWithQuery(id: string, query: {
-  /** Allows to select the actual fields to be returned. Where the default is all fields */fields?: string;
-}, options?: ApiCallOptions): Promise<GetAutomationWithQueryHttpResponse>;
+declare function getAutomationWithQuery(id: string, query: Record<string, unknown>, options?: ApiCallOptions): Promise<GetAutomationWithQueryHttpResponse>;
 type GetAutomationWithQueryHttpResponse = {
   data: AutomationDetailResponseObject;
   headers: Headers;
@@ -282,7 +271,7 @@ type GetAutomationWithQueryHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retrieves the full definition of an automation. The requesting user must be the owner of the automation.
+ * Retrieves the full definition of an automation. The requesting user must be the owner of the automation and either be assigned one of the roles: `AutomationsCreator`, `TenantAdmin` or have at least one of the following scopes (depending on whether the automation is in a private or shared space): `automations`, `automations.private` or `automations.shared`.
  *
  * @param id The unique identifier for the automation.
  * @throws GetAutomationHttpError
@@ -299,7 +288,7 @@ type GetAutomationHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Updates the full definition of an automation. The requesting user must be the owner of the automation.
+ * Updates the full definition of an automation. The requesting user must be the owner of the automation and either be assigned the `AutomationCreator` role or have at least one of the following scopes: `automations`, `admin.automations`, `automations.private` or `automations.shared`.
  *
  * @param id The unique identifier for the automation.
  * @param body an object with the body content
@@ -317,7 +306,7 @@ type UpdateAutomationHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner.
+ * Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. The requesting user must be assigned one of the following roles: `TenantAdmin`, `AnalyticsAdmin` or have at least one of the following scopes: `admin.automations`, `admin.automations:strict`.
  *
  * @param id The unique identifier for the automation.
  * @param body an object with the body content
@@ -357,7 +346,7 @@ type ChangeSpaceAutomationHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Duplicates an existing automation. The requesting user must be the owner of the automation.
+ * Duplicates an existing automation.
  *
  * @param id The unique identifier for the automation.
  * @param body an object with the body content
@@ -379,7 +368,10 @@ type CopyAutomationHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Disables an automation so that it cannot be run. The requesting user must be the owner of the automation, or be assigned the `TenantAdmin` role.
+ * Disables an automation so that it cannot be run. To disable an automation, the requesting user must meet at least one of the following conditions:
+ * - be the owner of the automation
+ * - be assigned one of the following roles: `TenantAdmin`, `AnalyticsAdmin`
+ * - have at least one of the following scopes: `admin.automations`, `admin.automations:strict`, `automations.private`, or `automations.shared`
  *
  * @param id The unique identifier for the automation.
  * @throws DisableAutomationHttpError
@@ -396,7 +388,10 @@ type DisableAutomationHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Enables an automation so that it can be run. The requesting user must be the owner of the automation, or be assigned the `TenantAdmin` role.
+ * Enables an automation so that it can be run. To enable an automation, the requesting user must meet at least one of the following conditions:
+ * - be the owner of the automation
+ * - be assigned one of the following roles: `AnalyticsAdmin`, `TenantAdmin`
+ * - have at least one of the following scopes: `admin.automations`, `admin.automations:strict`, `automations.private`, or `automations.shared`
  *
  * @param id The unique identifier for the automation.
  * @throws EnableAutomationHttpError
@@ -413,7 +408,7 @@ type EnableAutomationHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner.
+ * Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. The requesting user must be assigned one of the following roles: `TenantAdmin`, `AnalyticsAdmin` or have at least one of the following scopes: `admin.automations`, `admin.automations:strict`.
  *
  * @param id The unique identifier for the automation.
  * @param body an object with the body content
@@ -433,16 +428,15 @@ type MoveAutomationHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the `TenantAdmin` role.
+ * Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the one of roles: `TenantAdmin`, `AnalyticsAdmin`. Alternatively, the user must have at least one of the following scopes: `admin.automation-runs`, `automation-runs.private`, or `automation-runs.shared`.
  *
  * @param id The unique identifier for the automation.
  * @param query an object with query parameters
  * @throws GetAutomationRunsHttpError
  */
 declare function getAutomationRuns(id: string, query: {
-  /** Allows to select the actual fields to be returned. Where the default is all fields */fields?: string; /** Allowed filters: status, context, startTime and title, spaceId, ownerId, executedById */
-  filter?: string; /** The number of runs to retrieve. */
-  limit?: number; /** The field to sort by, with +- prefix indicating sort order. (?query=-startTime => sort on the startTime field using descending order) */
+  /** Allowed filters: `status`, `context`, `startTime`, `title`, `spaceId`, `ownerId`, `executedById`, `billable`. */filter?: string; /** The number of runs to retrieve. */
+  limit?: number; /** The field to sort by, with +- prefix indicating sort order. (`?query=-startTime` => sort on the `startTime` field using descending order). */
   sort?: "id" | "status" | "startTime" | "-id" | "-status" | "-startTime" | "+id" | "+status" | "+startTime";
 }, options?: ApiCallOptions): Promise<GetAutomationRunsHttpResponse>;
 type GetAutomationRunsHttpResponse = {
@@ -458,7 +452,9 @@ type GetAutomationRunsHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Creates a runs for a specific automation. The requesting user must be the owner of the automation.
+ * Creates a run for a specific automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+ * - Private space: be the owner of the automation and have the `automations.private` scope
+ * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
  *
  * @param id The unique identifier for the automation.
  * @param body an object with the body content
@@ -476,16 +472,16 @@ type QueueAutomationRunHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retrieves a specific run for an automation. The requesting user must be the owner of the automation.
+ * Retrieves a specific run for an automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+ * - Private space: be the owner of the automation and have the `automations.private` scope
+ * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
  *
  * @param id The unique identifier for the automation.
  * @param runId The unique identifier for the run.
  * @param query an object with query parameters
  * @throws GetAutomationRunWithQueryHttpError
  */
-declare function getAutomationRunWithQuery(id: string, runId: string, query: {
-  /** Allows to select the actual fields to be returned. Where the default is all fields */fields?: string;
-}, options?: ApiCallOptions): Promise<GetAutomationRunWithQueryHttpResponse>;
+declare function getAutomationRunWithQuery(id: string, runId: string, query: Record<string, unknown>, options?: ApiCallOptions): Promise<GetAutomationRunWithQueryHttpResponse>;
 type GetAutomationRunWithQueryHttpResponse = {
   data: RunDetailResponseObject;
   headers: Headers;
@@ -497,7 +493,9 @@ type GetAutomationRunWithQueryHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retrieves a specific run for an automation. The requesting user must be the owner of the automation.
+ * Retrieves a specific run for an automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+ * - Private space: be the owner of the automation and have the `automations.private` scope
+ * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
  *
  * @param id The unique identifier for the automation.
  * @param runId The unique identifier for the run.
@@ -515,7 +513,9 @@ type GetAutomationRunHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retrieves the URL for the debug log of a specific automation run. The requesting user must be the owner of the automation.
+ * Retrieves the URL for the debug log of a specific automation run. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+ * - Private space: be the owner of the automation and have the `automations.private` scope
+ * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
  *
  * @param id The unique identifier for the automation.
  * @param runId The unique identifier for the run.
@@ -535,7 +535,9 @@ type GetAutomationRunDetailsHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retries a specific run by creating a new run using the same inputs. The requesting user must be the owner of the automation.
+ * Retries a specific run by creating a new run using the same inputs. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+ * - Private space: be the owner of the automation and have the `automations.private` scope
+ * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
  *
  * @param id The unique identifier for the automation.
  * @param runId The unique identifier for the run.
@@ -553,7 +555,9 @@ type RetryAutomationRunHttpError = {
   status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Forcefully stops an automation run immediately. The requesting user must be the owner of the automation.
+ * Forcefully stops an automation run immediately. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+ * - Private space: be the owner of the automation and have the `automations.private` scope
+ * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
  *
  * @param id The unique identifier for the automation.
  * @param runId The unique identifier for the run.
@@ -577,40 +581,37 @@ declare function clearCache(): void;
 type AutomationsAPI = {
   /**
    * Retrieves a list of the automations that the requesting user has access to.
-   * @example
-   * getAutomations(
-   *   {
-   *     fields: "lastRun,lastRunStatus,runMode,createdAt,updatedAt"
-   *   }
-   * )
    *
    * @param query an object with query parameters
    * @throws GetAutomationsHttpError
    */
   getAutomations: typeof getAutomations;
   /**
-   * Creates a new automation. The requesting user must be assigned the `AutomationCreator` role.
+   * Creates a new automation. The requesting user must be assigned the `AutomationCreator` role or have at least one of the following scopes: `automations`, `admin.automations`, `automations.private` or `automations.shared`.
    *
    * @param body an object with the body content
    * @throws CreateAutomationHttpError
    */
   createAutomation: typeof createAutomation;
   /**
-   * Retrieves paginated usage metrics for automations. The requesting user must be assigned the `TenantAdmin` role.
+   * Retrieves paginated usage metrics for automations. The requesting user must be assigned the `TenantAdmin` or `AnalyticsAdmin` role.
    *
    * @param query an object with query parameters
    * @throws GetAutomationsUsageMetricsHttpError
    */
   getAutomationsUsageMetrics: typeof getAutomationsUsageMetrics;
   /**
-   * Deletes an automation. The requesting user must be the owner of the automation, or be assigned the `TenantAdmin` role.
+   * Deletes an automation. The requesting user must meet at least one of the following conditions:
+   * - be the owner of the automation
+   * - be assigned one of the following roles: `AnalyticsAdmin`, `TenantAdmin`
+   * - have at least one of the following scopes: `admin.automations`, `admin.automations:strict`, `automations.private`, or `automations.shared`
    *
    * @param id The unique identifier for the automation.
    * @throws DeleteAutomationHttpError
    */
   deleteAutomation: typeof deleteAutomation;
   /**
-   * Retrieves the full definition of an automation. The requesting user must be the owner of the automation.
+   * Retrieves the full definition of an automation. The requesting user must be the owner of the automation and either be assigned one of the roles: `AutomationsCreator`, `TenantAdmin` or have at least one of the following scopes (depending on whether the automation is in a private or shared space): `automations`, `automations.private` or `automations.shared`.
    *
    * @param id The unique identifier for the automation.
    * @param query an object with query parameters
@@ -618,14 +619,14 @@ type AutomationsAPI = {
    */
   getAutomationWithQuery: typeof getAutomationWithQuery;
   /**
-   * Retrieves the full definition of an automation. The requesting user must be the owner of the automation.
+   * Retrieves the full definition of an automation. The requesting user must be the owner of the automation and either be assigned one of the roles: `AutomationsCreator`, `TenantAdmin` or have at least one of the following scopes (depending on whether the automation is in a private or shared space): `automations`, `automations.private` or `automations.shared`.
    *
    * @param id The unique identifier for the automation.
    * @throws GetAutomationHttpError
    */
   getAutomation: typeof getAutomation;
   /**
-   * Updates the full definition of an automation. The requesting user must be the owner of the automation.
+   * Updates the full definition of an automation. The requesting user must be the owner of the automation and either be assigned the `AutomationCreator` role or have at least one of the following scopes: `automations`, `admin.automations`, `automations.private` or `automations.shared`.
    *
    * @param id The unique identifier for the automation.
    * @param body an object with the body content
@@ -633,7 +634,7 @@ type AutomationsAPI = {
    */
   updateAutomation: typeof updateAutomation;
   /**
-   * Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner.
+   * Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. The requesting user must be assigned one of the following roles: `TenantAdmin`, `AnalyticsAdmin` or have at least one of the following scopes: `admin.automations`, `admin.automations:strict`.
    *
    * @param id The unique identifier for the automation.
    * @param body an object with the body content
@@ -649,7 +650,7 @@ type AutomationsAPI = {
    */
   changeSpaceAutomation: typeof changeSpaceAutomation;
   /**
-   * Duplicates an existing automation. The requesting user must be the owner of the automation.
+   * Duplicates an existing automation.
    *
    * @param id The unique identifier for the automation.
    * @param body an object with the body content
@@ -657,21 +658,27 @@ type AutomationsAPI = {
    */
   copyAutomation: typeof copyAutomation;
   /**
-   * Disables an automation so that it cannot be run. The requesting user must be the owner of the automation, or be assigned the `TenantAdmin` role.
+   * Disables an automation so that it cannot be run. To disable an automation, the requesting user must meet at least one of the following conditions:
+   * - be the owner of the automation
+   * - be assigned one of the following roles: `TenantAdmin`, `AnalyticsAdmin`
+   * - have at least one of the following scopes: `admin.automations`, `admin.automations:strict`, `automations.private`, or `automations.shared`
    *
    * @param id The unique identifier for the automation.
    * @throws DisableAutomationHttpError
    */
   disableAutomation: typeof disableAutomation;
   /**
-   * Enables an automation so that it can be run. The requesting user must be the owner of the automation, or be assigned the `TenantAdmin` role.
+   * Enables an automation so that it can be run. To enable an automation, the requesting user must meet at least one of the following conditions:
+   * - be the owner of the automation
+   * - be assigned one of the following roles: `AnalyticsAdmin`, `TenantAdmin`
+   * - have at least one of the following scopes: `admin.automations`, `admin.automations:strict`, `automations.private`, or `automations.shared`
    *
    * @param id The unique identifier for the automation.
    * @throws EnableAutomationHttpError
    */
   enableAutomation: typeof enableAutomation;
   /**
-   * Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner.
+   * Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. The requesting user must be assigned one of the following roles: `TenantAdmin`, `AnalyticsAdmin` or have at least one of the following scopes: `admin.automations`, `admin.automations:strict`.
    *
    * @param id The unique identifier for the automation.
    * @param body an object with the body content
@@ -679,7 +686,7 @@ type AutomationsAPI = {
    */
   moveAutomation: typeof moveAutomation;
   /**
-   * Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the `TenantAdmin` role.
+   * Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the one of roles: `TenantAdmin`, `AnalyticsAdmin`. Alternatively, the user must have at least one of the following scopes: `admin.automation-runs`, `automation-runs.private`, or `automation-runs.shared`.
    *
    * @param id The unique identifier for the automation.
    * @param query an object with query parameters
@@ -687,7 +694,9 @@ type AutomationsAPI = {
    */
   getAutomationRuns: typeof getAutomationRuns;
   /**
-   * Creates a runs for a specific automation. The requesting user must be the owner of the automation.
+   * Creates a run for a specific automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+   * - Private space: be the owner of the automation and have the `automations.private` scope
+   * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
    *
    * @param id The unique identifier for the automation.
    * @param body an object with the body content
@@ -695,7 +704,9 @@ type AutomationsAPI = {
    */
   queueAutomationRun: typeof queueAutomationRun;
   /**
-   * Retrieves a specific run for an automation. The requesting user must be the owner of the automation.
+   * Retrieves a specific run for an automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+   * - Private space: be the owner of the automation and have the `automations.private` scope
+   * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
    *
    * @param id The unique identifier for the automation.
    * @param runId The unique identifier for the run.
@@ -704,7 +715,9 @@ type AutomationsAPI = {
    */
   getAutomationRunWithQuery: typeof getAutomationRunWithQuery;
   /**
-   * Retrieves a specific run for an automation. The requesting user must be the owner of the automation.
+   * Retrieves a specific run for an automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+   * - Private space: be the owner of the automation and have the `automations.private` scope
+   * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
    *
    * @param id The unique identifier for the automation.
    * @param runId The unique identifier for the run.
@@ -712,7 +725,9 @@ type AutomationsAPI = {
    */
   getAutomationRun: typeof getAutomationRun;
   /**
-   * Retrieves the URL for the debug log of a specific automation run. The requesting user must be the owner of the automation.
+   * Retrieves the URL for the debug log of a specific automation run. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+   * - Private space: be the owner of the automation and have the `automations.private` scope
+   * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
    *
    * @param id The unique identifier for the automation.
    * @param runId The unique identifier for the run.
@@ -720,7 +735,9 @@ type AutomationsAPI = {
    */
   getAutomationRunDetails: typeof getAutomationRunDetails;
   /**
-   * Retries a specific run by creating a new run using the same inputs. The requesting user must be the owner of the automation.
+   * Retries a specific run by creating a new run using the same inputs. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+   * - Private space: be the owner of the automation and have the `automations.private` scope
+   * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
    *
    * @param id The unique identifier for the automation.
    * @param runId The unique identifier for the run.
@@ -728,7 +745,9 @@ type AutomationsAPI = {
    */
   retryAutomationRun: typeof retryAutomationRun;
   /**
-   * Forcefully stops an automation run immediately. The requesting user must be the owner of the automation.
+   * Forcefully stops an automation run immediately. Depending on the space the automation belongs to, the requesting user must meet the following requirement:
+   * - Private space: be the owner of the automation and have the `automations.private` scope
+   * - Shared space: be editor or operator in shared space and have `automations.shared` scope.
    *
    * @param id The unique identifier for the automation.
    * @param runId The unique identifier for the run.