@qlik/api 2.4.1 → 2.5.0

package/automations.js

@@ -1,15 +1,9 @@
-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/automations.ts
 /**
 * 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
@@ -23,7 +17,7 @@ async function getAutomations(query, options) {
 	});
 }
 /**
-* 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
@@ -38,7 +32,7 @@ async function createAutomation(body, options) {
 	});
 }
 /**
-* 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
@@ -52,7 +46,10 @@ async function getAutomationsUsageMetrics(query, options) {
 	});
 }
 /**
-* 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
@@ -66,7 +63,7 @@ async function deleteAutomation(id, options) {
 	});
 }
 /**
-* 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
@@ -82,7 +79,7 @@ async function getAutomationWithQuery(id, query, options) {
 	});
 }
 /**
-* 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
@@ -96,7 +93,7 @@ async function getAutomation(id, options) {
 	});
 }
 /**
-* 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
@@ -113,7 +110,7 @@ async function updateAutomation(id, body, options) {
 	});
 }
 /**
-* 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
@@ -147,7 +144,7 @@ async function changeSpaceAutomation(id, body, options) {
 	});
 }
 /**
-* 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
@@ -164,7 +161,10 @@ async function copyAutomation(id, body, options) {
 	});
 }
 /**
-* 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
@@ -178,7 +178,10 @@ async function disableAutomation(id, options) {
 	});
 }
 /**
-* 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
@@ -192,7 +195,7 @@ async function enableAutomation(id, options) {
 	});
 }
 /**
-* 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
@@ -209,7 +212,7 @@ async function moveAutomation(id, body, options) {
 	});
 }
 /**
-* 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
@@ -225,7 +228,9 @@ async function getAutomationRuns(id, query, options) {
 	});
 }
 /**
-* 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
@@ -242,7 +247,9 @@ async function queueAutomationRun(id, body, options) {
 	});
 }
 /**
-* 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.
@@ -262,7 +269,9 @@ async function getAutomationRunWithQuery(id, runId, query, options) {
 	});
 }
 /**
-* 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.
@@ -280,7 +289,9 @@ async function getAutomationRun(id, runId, options) {
 	});
 }
 /**
-* 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.
@@ -298,7 +309,9 @@ async function getAutomationRunDetails(id, runId, options) {
 	});
 }
 /**
-* 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.
@@ -316,7 +329,9 @@ async function retryAutomationRun(id, runId, options) {
 	});
 }
 /**
-* 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.

package/automl-deployments.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/automl-deployments.d.ts
 type AppErrorResponse = {
   errors?: Error[];

package/automl-deployments.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/automl-deployments.ts
 /**

package/automl-predictions.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/automl-predictions.d.ts
 type AppErrorResponse = {
   errors?: Error[];

package/automl-predictions.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/automl-predictions.ts
 /**

package/banners.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/banners.d.ts
 type BannerResponse = {
   readonly createdAt: string; /** userId of the user who created the banner */

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

package/brands.d.ts

@@ -1,6 +1,4 @@
-import { ApiCallOptions, DownloadableBlob } from "./invoke-fetch-types.js";
-import "./chunks/invoke-fetch-DFc3yzaj.js";
-
+import { C as DownloadableBlob, b as ApiCallOptions } from "./chunks/auth-types-DVvka7Hz.js";
 //#region src/public/rest/brands.d.ts
 /**
  * A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.

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

package/chunks/{auth-B8lJw7rm.js → auth-Cfg2Smt8.js}

@@ -1,4 +1,4 @@
-import { C as AuthorizationError, E as UnexpectedAuthTypeError, S as unregisterHostConfig, T as InvalidHostConfigError, _ as registerHostConfig, a as getRestCallAuthParams, b as toValidLocationUrl, c as handleAuthenticationError, d as logout, f as normalizeHostConfig, g as registerAuthModule, h as onPageRedirectStarted, i as getDefaultHostConfig, l as isHostCrossOrigin, m as onPageRedirectRequested, n as determineAuthType, o as getWebResourceAuthParams, p as onFatalAuthError, r as getAccessToken, s as getWebSocketAuthParams, u as isWindows, v as serializeHostConfig, w as InvalidAuthTypeError, x as toValidWebsocketLocationUrl, y as setDefaultHostConfig } from "./boot-interceptors-DqRxTczb.js";
+import { A as InvalidHostConfigError, C as serializeHostConfig, D as unregisterHostConfig, E as toValidWebsocketLocationUrl, O as AuthorizationError, S as registerHostConfig, T as toValidLocationUrl, _ as normalizeHostConfig, b as onPageRedirectStarted, c as getAccessToken, d as getWebResourceAuthParams, f as getWebSocketAuthParams, g as logout, h as isWindows, j as UnexpectedAuthTypeError, k as InvalidAuthTypeError, l as getDefaultHostConfig, m as isHostCrossOrigin, p as handleAuthenticationError, s as determineAuthType, u as getRestCallAuthParams, v as onFatalAuthError, w as setDefaultHostConfig, x as registerAuthModule, y as onPageRedirectRequested } from "./interceptors-DMiDeqEz.js";
 
 //#region src/auth/auth.ts
 /**