@qlik/api 1.28.0 → 1.30.0

package/api-keys.d.ts

@@ -89,7 +89,27 @@ type ApiKeysConfig = {
     /** The expiry of the scim `externalClient` token in ISO8601 duration format, e.g. `P365D` for 365 days. Used during the creation of an `externalClient` API key for configuring a SCIM compatible Identity Provider. */
     scim_externalClient_expiry?: string;
 };
+/**
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/api_keys_enabled",
+ *     value: true
+ *   }
+ * ]
+ */
 type ApiKeysConfigPatchSchema = ApiKeyConfigPatch[];
+/**
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/description",
+ *     value: "my new description"
+ *   }
+ * ]
+ */
 type ApiKeysPatchSchema = ApiKeyPatch[];
 /**
  * An error object.

package/api-keys.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/api-keys.ts

package/apps.d.ts

@@ -526,6 +526,48 @@ type FilterListItem = {
     readonly ownerId?: string;
     readonly updatedAt?: string;
 };
+/**
+ * @example
+ * {
+ *   description: "this is a filter sample",
+ *   filterType: "REP",
+ *   filterV1_0: {
+ *     fieldsByState: {
+ *       "$": [
+ *         {
+ *           name: "Country",
+ *           overrideValues: false,
+ *           selectExcluded: false,
+ *           values: [
+ *             {
+ *               valueAsText: "1-Argentina",
+ *               valueType: "string"
+ *             },
+ *             {
+ *               valueAsText: "4-Brazil",
+ *               valueType: "string"
+ *             }
+ *           ]
+ *         },
+ *         {
+ *           name: "Order number",
+ *           overrideValues: false,
+ *           selectExcluded: false,
+ *           values: [
+ *             {
+ *               valueAsNumber: 61300,
+ *               valueAsText: "61300",
+ *               valueType: "number"
+ *             }
+ *           ]
+ *         }
+ *       ]
+ *     }
+ *   },
+ *   filterVersion: "filter-1.0",
+ *   name: "Filter sample"
+ * }
+ */
 type FilterRequest = {
     /** The App ID. */
     appId?: string;
@@ -540,9 +582,45 @@ type FilterRequest = {
     ownerId?: string;
 };
 type FilterType = "REP" | "SUB";
+/**
+ * @example
+ * {
+ *   fieldsByState: {
+ *     "$": [
+ *       {
+ *         name: "Country",
+ *         overrideValues: false,
+ *         selectExcluded: false,
+ *         values: [
+ *           {
+ *             valueAsText: "1-Argentina",
+ *             valueType: "string"
+ *           },
+ *           {
+ *             valueAsText: "4-Brazil",
+ *             valueType: "string"
+ *           }
+ *         ]
+ *       },
+ *       {
+ *         name: "Order number",
+ *         overrideValues: false,
+ *         selectExcluded: false,
+ *         values: [
+ *           {
+ *             valueAsNumber: 61300,
+ *             valueAsText: "61300",
+ *             valueType: "number"
+ *           }
+ *         ]
+ *       }
+ *     ]
+ *   }
+ * }
+ */
 type FilterV10 = {
     /** Map of fields to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000. */
-    fieldsByState?: unknown;
+    fieldsByState?: Record<string, FilterField[]>;
     /** The filter variables. */
     variables?: FilterVariable[];
 };
@@ -610,6 +688,20 @@ type Links = {
     prev?: Href;
     self?: Href;
 };
+/**
+ * @example
+ * {
+ *   next: {
+ *     href: "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
+ *   },
+ *   prev: {
+ *     href: "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
+ *   },
+ *   self: {
+ *     href: "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
+ *   }
+ * }
+ */
 type LinksResponse = {
     next: LinkResponse;
     prev: LinkResponse;
@@ -1075,10 +1167,11 @@ type Evaluation = {
     appName?: string;
     details?: {
         concurrentReload?: boolean;
+        /** @deprecated */
         dedicated?: boolean;
         engineHasCache?: boolean;
         errors?: string[];
-        objectMetrics?: unknown;
+        objectMetrics?: Record<string, Resultentry>;
         warnings?: string[];
     };
     ended?: string;
@@ -1269,6 +1362,11 @@ type GetAppEvaluationComparisonHttpError = {
 };
 /**
  * Accepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.
+ * @example
+ * getAppEvaluationComparisonXml(
+ *   "abcdefghijklmnopq",
+ *   "abcdefghijklmnopq"
+ * )
  *
  * @param baseid Id of the baseline evaluation
  * @param comparisonid Id of the comparison evaluation
@@ -1310,6 +1408,10 @@ type GetAppEvaluationHttpError = {
 };
 /**
  * Find and download an evaluation log by a specific evaluation id.
+ * @example
+ * getAppEvaluationXml(
+ *   "abcdefghijklmnopq"
+ * )
  *
  * @param id Id of the desired evaluation.
  * @throws GetAppEvaluationXmlHttpError
@@ -1815,7 +1917,7 @@ declare const getAppReportFilters: (appId: string, query: {
      * (name co "query1" or description co "query2") and ownerId eq "123" */
     filter?: string;
     /** The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark. */
-    filterTypes?: ("REP" | "SUB")[];
+    filterTypes: ("REP" | "SUB")[];
     /** Limit the returned result set */
     limit?: number;
     /** If present, the cursor that starts the page of data that is returned. */
@@ -1862,7 +1964,7 @@ type CreateAppReportFilterHttpError = {
  */
 declare const countAppReportFilters: (appId: string, query: {
     /** The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark. */
-    filterTypes?: ("REP" | "SUB")[];
+    filterTypes: ("REP" | "SUB")[];
 }, options?: ApiCallOptions) => Promise<CountAppReportFiltersHttpResponse>;
 type CountAppReportFiltersHttpResponse = {
     data: FiltersCount;
@@ -2108,6 +2210,10 @@ type GetAppEvaluationsHttpError = {
 };
 /**
  * Queue an app evaluation by its app guid.
+ * @example
+ * queueAppEvaluation(
+ *   "abcdefghijklmnopq"
+ * )
  *
  * @param guid Guid of the app.
  * @throws QueueAppEvaluationHttpError
@@ -2146,6 +2252,11 @@ interface AppsAPI {
     getAppEvaluationComparison: typeof getAppEvaluationComparison;
     /**
      * Accepts two evaluation ids and downloads a log, in XML format, denoting the differences between the two.
+     * @example
+     * getAppEvaluationComparisonXml(
+     *   "abcdefghijklmnopq",
+     *   "abcdefghijklmnopq"
+     * )
      *
      * @param baseid Id of the baseline evaluation
      * @param comparisonid Id of the comparison evaluation
@@ -2162,6 +2273,10 @@ interface AppsAPI {
     getAppEvaluation: typeof getAppEvaluation;
     /**
      * Find and download an evaluation log by a specific evaluation id.
+     * @example
+     * getAppEvaluationXml(
+     *   "abcdefghijklmnopq"
+     * )
      *
      * @param id Id of the desired evaluation.
      * @throws GetAppEvaluationXmlHttpError
@@ -2484,6 +2599,10 @@ interface AppsAPI {
     getAppEvaluations: typeof getAppEvaluations;
     /**
      * Queue an app evaluation by its app guid.
+     * @example
+     * queueAppEvaluation(
+     *   "abcdefghijklmnopq"
+     * )
      *
      * @param guid Guid of the app.
      * @throws QueueAppEvaluationHttpError

package/apps.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/apps.ts

package/audits.d.ts

@@ -156,7 +156,7 @@ type GetAuditsHttpError = {
  */
 declare const getArchivedAudits: (query: {
     /** Date to be used as filter and criteria during extraction. */
-    date?: string;
+    date: string;
 }, options?: ApiCallOptions) => Promise<GetArchivedAuditsHttpResponse>;
 type GetArchivedAuditsHttpResponse = {
     data: GetArchiveResult;

package/audits.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/audits.ts

package/auth.js

@@ -4,8 +4,8 @@ import {
   logout,
   registerAuthModule,
   setDefaultHostConfig
-} from "./chunks/KYCIMQ4L.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/QK4TMJ64.js";
+import "./chunks/TXC5XORK.js";
 export {
   auth_default as default,
   getAccessToken,

package/automations.d.ts

@@ -188,7 +188,13 @@ type UsageObject = {
     value: number;
 };
 /**
- * Retrieves a list of automations
+ * 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
@@ -216,7 +222,7 @@ type GetAutomationsHttpError = {
     status: 400 | 401 | 403 | 500 | 503;
 };
 /**
- * Create an automation
+ * Creates a new automation. The requesting user must be assigned the `AutomationCreator` role.
  *
  * @param body an object with the body content
  * @throws CreateAutomationHttpError
@@ -233,7 +239,7 @@ type CreateAutomationHttpError = {
     status: 400 | 401 | 403 | 500 | 503;
 };
 /**
- * Retrieves all automation usage for a tenant
+ * Retrieves paginated usage metrics for automations. The requesting user must be assigned the `TenantAdmin` role.
  *
  * @param query an object with query parameters
  * @throws GetAutomationsUsageMetricsHttpError
@@ -242,7 +248,7 @@ declare const getAutomationsUsageMetrics: (query: {
     /** If specified, result will be broken apart for each automation */
     breakdownBy?: string;
     /** Indicates how the metrics should be filtered */
-    filter?: string;
+    filter: string;
 }, options?: ApiCallOptions) => Promise<GetAutomationsUsageMetricsHttpResponse>;
 type GetAutomationsUsageMetricsHttpResponse = {
     data: UsageList;
@@ -257,7 +263,7 @@ type GetAutomationsUsageMetricsHttpError = {
     status: 400 | 401 | 403 | 500 | 503;
 };
 /**
- * Delete an automation
+ * Deletes an automation. The requesting user must be the owner of the automation, or be assigned the `TenantAdmin` role.
  *
  * @param id The unique identifier for the automation.
  * @throws DeleteAutomationHttpError
@@ -274,7 +280,7 @@ type DeleteAutomationHttpError = {
     status: 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retrieves an automation
+ * Retrieves the full definition of an automation. The requesting user must be the owner of the automation.
  *
  * @param id The unique identifier for the automation.
  * @param query an object with query parameters
@@ -295,7 +301,7 @@ type GetAutomationWithQueryHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retrieves an automation
+ * Retrieves the full definition of an automation. The requesting user must be the owner of the automation.
  *
  * @param id The unique identifier for the automation.
  * @throws GetAutomationHttpError
@@ -312,7 +318,7 @@ type GetAutomationHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Update an automation
+ * Updates the full definition of an automation. The requesting user must be the owner of the automation.
  *
  * @param id The unique identifier for the automation.
  * @param body an object with the body content
@@ -330,7 +336,7 @@ type UpdateAutomationHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Copy an automation.
+ * Duplicates an existing automation. The requesting user must be the owner of the automation.
  *
  * @param id The unique identifier for the automation.
  * @param body an object with the body content
@@ -354,7 +360,7 @@ type CopyAutomationHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Disables an automation.
+ * 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.
  *
  * @param id The unique identifier for the automation.
  * @throws DisableAutomationHttpError
@@ -371,7 +377,7 @@ type DisableAutomationHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Enable an automation.
+ * 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.
  *
  * @param id The unique identifier for the automation.
  * @throws EnableAutomationHttpError
@@ -388,7 +394,7 @@ type EnableAutomationHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * This step will remove the history and change logs of this automation. All linked connections used inside an automation will be detached.
+ * 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.
  *
  * @param id The unique identifier for the automation.
  * @param body an object with the body content
@@ -408,7 +414,7 @@ type MoveAutomationHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retrieves a list of runs for a specific automation.
+ * 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.
  *
  * @param id The unique identifier for the automation.
  * @param query an object with query parameters
@@ -437,7 +443,7 @@ type GetAutomationRunsHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Create a run
+ * Creates a runs for a specific automation. The requesting user must be the owner of the automation.
  *
  * @param id The unique identifier for the automation.
  * @param body an object with the body content
@@ -455,7 +461,7 @@ type QueueAutomationRunHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retrieves a run
+ * Retrieves a specific run for an automation. The requesting user must be the owner of the automation.
  *
  * @param id The unique identifier for the automation.
  * @param runId The unique identifier for the run.
@@ -477,7 +483,7 @@ type GetAutomationRunWithQueryHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Retrieves a run
+ * Retrieves a specific run for an automation. The requesting user must be the owner of the automation.
  *
  * @param id The unique identifier for the automation.
  * @param runId The unique identifier for the run.
@@ -495,7 +501,7 @@ type GetAutomationRunHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Creates a temporary pre-signed AWS S3 URL to download the raw logs of a completed run. This URL is valid for 5 minutes.
+ * Retrieves the URL for the debug log of a specific automation run. The requesting user must be the owner of the automation.
  *
  * @param id The unique identifier for the automation.
  * @param runId The unique identifier for the run.
@@ -515,7 +521,7 @@ type GetAutomationRunDetailsHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * This action allows you to retry a specific run by creating a new run using the same inputs.
+ * Retries a specific run by creating a new run using the same inputs. The requesting user must be the owner of the automation.
  *
  * @param id The unique identifier for the automation.
  * @param runId The unique identifier for the run.
@@ -533,7 +539,7 @@ type RetryAutomationRunHttpError = {
     status: 400 | 401 | 403 | 404 | 500 | 503;
 };
 /**
- * Force a run to be stopped immediately.
+ * Forcefully stops an automation run immediately. The requesting user must be the owner of the automation.
  *
  * @param id The unique identifier for the automation.
  * @param runId The unique identifier for the run.
@@ -556,35 +562,41 @@ type StopAutomationRunHttpError = {
 declare function clearCache(): void;
 interface AutomationsAPI {
     /**
-     * Retrieves a list of automations
+     * 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;
     /**
-     * Create an automation
+     * Creates a new automation. The requesting user must be assigned the `AutomationCreator` role.
      *
      * @param body an object with the body content
      * @throws CreateAutomationHttpError
      */
     createAutomation: typeof createAutomation;
     /**
-     * Retrieves all automation usage for a tenant
+     * Retrieves paginated usage metrics for automations. The requesting user must be assigned the `TenantAdmin` role.
      *
      * @param query an object with query parameters
      * @throws GetAutomationsUsageMetricsHttpError
      */
     getAutomationsUsageMetrics: typeof getAutomationsUsageMetrics;
     /**
-     * Delete an automation
+     * Deletes an automation. The requesting user must be the owner of the automation, or be assigned the `TenantAdmin` role.
      *
      * @param id The unique identifier for the automation.
      * @throws DeleteAutomationHttpError
      */
     deleteAutomation: typeof deleteAutomation;
     /**
-     * Retrieves an automation
+     * Retrieves the full definition of an automation. The requesting user must be the owner of the automation.
      *
      * @param id The unique identifier for the automation.
      * @param query an object with query parameters
@@ -592,14 +604,14 @@ interface AutomationsAPI {
      */
     getAutomationWithQuery: typeof getAutomationWithQuery;
     /**
-     * Retrieves an automation
+     * Retrieves the full definition of an automation. The requesting user must be the owner of the automation.
      *
      * @param id The unique identifier for the automation.
      * @throws GetAutomationHttpError
      */
     getAutomation: typeof getAutomation;
     /**
-     * Update an automation
+     * Updates the full definition of an automation. The requesting user must be the owner of the automation.
      *
      * @param id The unique identifier for the automation.
      * @param body an object with the body content
@@ -607,7 +619,7 @@ interface AutomationsAPI {
      */
     updateAutomation: typeof updateAutomation;
     /**
-     * Copy an automation.
+     * Duplicates an existing automation. The requesting user must be the owner of the automation.
      *
      * @param id The unique identifier for the automation.
      * @param body an object with the body content
@@ -615,21 +627,21 @@ interface AutomationsAPI {
      */
     copyAutomation: typeof copyAutomation;
     /**
-     * Disables an automation.
+     * 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.
      *
      * @param id The unique identifier for the automation.
      * @throws DisableAutomationHttpError
      */
     disableAutomation: typeof disableAutomation;
     /**
-     * Enable an automation.
+     * 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.
      *
      * @param id The unique identifier for the automation.
      * @throws EnableAutomationHttpError
      */
     enableAutomation: typeof enableAutomation;
     /**
-     * This step will remove the history and change logs of this automation. All linked connections used inside an automation will be detached.
+     * 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.
      *
      * @param id The unique identifier for the automation.
      * @param body an object with the body content
@@ -637,7 +649,7 @@ interface AutomationsAPI {
      */
     moveAutomation: typeof moveAutomation;
     /**
-     * Retrieves a list of runs for a specific automation.
+     * 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.
      *
      * @param id The unique identifier for the automation.
      * @param query an object with query parameters
@@ -645,7 +657,7 @@ interface AutomationsAPI {
      */
     getAutomationRuns: typeof getAutomationRuns;
     /**
-     * Create a run
+     * Creates a runs for a specific automation. The requesting user must be the owner of the automation.
      *
      * @param id The unique identifier for the automation.
      * @param body an object with the body content
@@ -653,7 +665,7 @@ interface AutomationsAPI {
      */
     queueAutomationRun: typeof queueAutomationRun;
     /**
-     * Retrieves a run
+     * Retrieves a specific run for an automation. The requesting user must be the owner of the automation.
      *
      * @param id The unique identifier for the automation.
      * @param runId The unique identifier for the run.
@@ -662,7 +674,7 @@ interface AutomationsAPI {
      */
     getAutomationRunWithQuery: typeof getAutomationRunWithQuery;
     /**
-     * Retrieves a run
+     * Retrieves a specific run for an automation. The requesting user must be the owner of the automation.
      *
      * @param id The unique identifier for the automation.
      * @param runId The unique identifier for the run.
@@ -670,7 +682,7 @@ interface AutomationsAPI {
      */
     getAutomationRun: typeof getAutomationRun;
     /**
-     * Creates a temporary pre-signed AWS S3 URL to download the raw logs of a completed run. This URL is valid for 5 minutes.
+     * Retrieves the URL for the debug log of a specific automation run. The requesting user must be the owner of the automation.
      *
      * @param id The unique identifier for the automation.
      * @param runId The unique identifier for the run.
@@ -678,7 +690,7 @@ interface AutomationsAPI {
      */
     getAutomationRunDetails: typeof getAutomationRunDetails;
     /**
-     * This action allows you to retry a specific run by creating a new run using the same inputs.
+     * Retries a specific run by creating a new run using the same inputs. The requesting user must be the owner of the automation.
      *
      * @param id The unique identifier for the automation.
      * @param runId The unique identifier for the run.
@@ -686,7 +698,7 @@ interface AutomationsAPI {
      */
     retryAutomationRun: typeof retryAutomationRun;
     /**
-     * Force a run to be stopped immediately.
+     * Forcefully stops an automation run immediately. The requesting user must be the owner of the automation.
      *
      * @param id The unique identifier for the automation.
      * @param runId The unique identifier for the run.

package/automations.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/automations.ts

package/brands.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/brands.ts