@qlik/api 2.3.0 → 2.4.0

package/quotas.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-QhLPeQr5.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/quotas.ts
 /**
@@ -46,7 +46,6 @@ const quotasExport = {
 	getQuota,
 	clearCache
 };
-var quotas_default = quotasExport;
 
 //#endregion
-export { clearCache, quotas_default as default, getQuota, getQuotas };
+export { clearCache, quotasExport as default, getQuota, getQuotas };

package/reload-tasks.d.ts

@@ -1,5 +1,5 @@
-import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
 
 //#region src/public/rest/reload-tasks.d.ts
 type Error = {
@@ -42,55 +42,37 @@ type PostTaskBody = TaskBase & {
   type?: "scheduled_reload";
 };
 type PutTaskBody = TaskBase & {
-  /** Toggle for enabling and disabling the reload task */
-  state?: "Enabled" | "Disabled" | "Completed";
+  /** Toggle for enabling and disabling the reload task */state?: "Enabled" | "Disabled" | "Completed";
 };
 type SelfLink = {
   self: Href;
 };
 type Task = TaskBase & {
-  /** The reason why the task was disabled. */
-  disabledCode?: "MANUALLY" | "CONSECUTIVE-FAILURES" | "OWNER-DELETED" | "OWNER-DISABLED";
+  /** The reason why the task was disabled. */disabledCode?: "MANUALLY" | "CONSECUTIVE-FAILURES" | "OWNER-DELETED" | "OWNER-DISABLED";
   /** @deprecated
    * The fortress ID of the application */
-  fortressId?: string;
-  /** The ID of the task. */
-  id: string;
-  /** The last time the task executed. */
+  fortressId?: string; /** The ID of the task. */
+  id: string; /** The last time the task executed. */
   lastExecutionTime?: string;
   links: SelfLink;
   /** @deprecated
    * The reason why the task was disabled. */
-  log?: string;
-  /** A flag indicating whether the task has been migrated to the new scheduling service. */
-  migrated?: boolean;
-  /** The next time the task will execute. */
-  nextExecutionTime?: string;
-  /** The space ID of the application */
-  spaceId?: string;
-  /** Toggle for enabling and disabling the reload task */
-  state: "Enabled" | "Disabled" | "Completed";
-  /** The ID of the tenant who owns the task. */
-  tenantId: string;
-  /** The ID of the user who owns the task. */
+  log?: string; /** A flag indicating whether the task has been migrated to the new scheduling service. */
+  migrated?: boolean; /** The next time the task will execute. */
+  nextExecutionTime?: string; /** The space ID of the application */
+  spaceId?: string; /** Toggle for enabling and disabling the reload task */
+  state: "Enabled" | "Disabled" | "Completed"; /** The ID of the tenant who owns the task. */
+  tenantId: string; /** The ID of the user who owns the task. */
   userId: string;
 };
 type TaskBase = {
-  /** The ID of the app. */
-  appId?: string;
-  /** A flag that indicates whether a reload is triggered when data of the app is changed */
-  autoReload?: boolean;
-  /** A flag that indicates whether it is a partial reload or not for the auto reload */
-  autoReloadPartial?: boolean;
-  /** The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. */
-  endDateTime?: string;
-  /** The task is partial reload or not */
-  partial?: boolean;
-  /** List of RECUR lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events */
-  recurrence?: string[];
-  /** The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set. */
-  startDateTime?: string;
-  /** The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. Europe/Zurich.) This field specifies the time zone in which the event start/end are expanded. If missing the start/end fields must specify a UTC offset in RFC3339 format. */
+  /** The ID of the app. */appId?: string; /** A flag that indicates whether a reload is triggered when data of the app is changed */
+  autoReload?: boolean; /** A flag that indicates whether it is a partial reload or not for the auto reload */
+  autoReloadPartial?: boolean; /** The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. */
+  endDateTime?: string; /** The task is partial reload or not */
+  partial?: boolean; /** List of RECUR lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events */
+  recurrence?: string[]; /** The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set. */
+  startDateTime?: string; /** The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. Europe/Zurich.) This field specifies the time zone in which the event start/end are expanded. If missing the start/end fields must specify a UTC offset in RFC3339 format. */
   timeZone?: string;
 };
 type Tasks = {
@@ -104,15 +86,10 @@ type Tasks = {
  * @throws GetReloadTasksHttpError
  */
 declare function getReloadTasks(query: {
-  /** The case sensitive string used to search for a task by app ID. */
-  appId?: string;
-  /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
-  limit?: number;
-  /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
-  next?: string;
-  /** The boolean value used to search for a task is partial or not */
-  partial?: boolean;
-  /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
+  /** The case sensitive string used to search for a task by app ID. */appId?: string; /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
+  limit?: number; /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
+  next?: string; /** The boolean value used to search for a task is partial or not */
+  partial?: boolean; /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
   prev?: string;
 }, options?: ApiCallOptions): Promise<GetReloadTasksHttpResponse>;
 type GetReloadTasksHttpResponse = {

package/reload-tasks.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-QhLPeQr5.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/reload-tasks.ts
 /**
@@ -93,7 +93,6 @@ const reloadTasksExport = {
 	updateReloadTask,
 	clearCache
 };
-var reload_tasks_default = reloadTasksExport;
 
 //#endregion
-export { clearCache, createReloadTask, reload_tasks_default as default, deleteReloadTask, getReloadTask, getReloadTasks, updateReloadTask };
+export { clearCache, createReloadTask, reloadTasksExport as default, deleteReloadTask, getReloadTask, getReloadTasks, updateReloadTask };

package/reloads.d.ts

@@ -1,10 +1,9 @@
-import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
 
 //#region src/public/rest/reloads.d.ts
 type Error = {
-  /** The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.  */
-  code: string;
+  /** The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.  */code: string;
   detail?: string;
   title: string;
 };
@@ -38,49 +37,30 @@ type Href = {
  */
 type Partial = boolean;
 type Reload = {
-  /** The ID of the app. */
-  appId: string;
-  /** The time the reload job was created. */
-  creationTime: string;
-  /** The time the reload job finished. */
-  endTime?: string;
-  /** The timestamp returned from the Sense engine upon successful reload. */
-  engineTime?: string;
-  /** The error code when the status is FAILED. */
-  errorCode?: string;
-  /** The error message when the status is FAILED. */
-  errorMessage?: string;
-  /** The ID of the reload. */
+  /** The ID of the app. */appId: string; /** The time the reload job was created. */
+  creationTime: string; /** The time the reload job finished. */
+  endTime?: string; /** The timestamp returned from the Sense engine upon successful reload. */
+  engineTime?: string; /** The error code when the status is FAILED. */
+  errorCode?: string; /** The error message when the status is FAILED. */
+  errorMessage?: string; /** The ID of the reload. */
   id: string;
-  links?: ReloadLinks;
-  /** The log describing the result of the latest reload execution from the request. */
-  log?: string;
-  /** The boolean value used to present the reload is partial or not. */
-  partial?: Partial;
-  /** The time the reload job was consumed from the queue. */
-  startTime?: string;
-  /** The status of the reload. There are seven statuses. `QUEUED`, `RELOADING`, `CANCELING` are the active statuses. `SUCCEEDED`, `FAILED`, `CANCELED`, `EXCEEDED_LIMIT` are the end statuses. */
-  status: Status;
-  /** The ID of the tenant who owns the reload. */
-  tenantId: string;
-  /** What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data, choreographer = reload triggered by choreographer. */
-  type: Type;
-  /** The ID of the user who created the reload. */
-  userId: string;
-  /** The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1. */
+  links?: ReloadLinks; /** The log describing the result of the latest reload execution from the request. */
+  log?: string; /** The boolean value used to present the reload is partial or not. */
+  partial?: Partial; /** The time the reload job was consumed from the queue. */
+  startTime?: string; /** The status of the reload. There are seven statuses. `QUEUED`, `RELOADING`, `CANCELING` are the active statuses. `SUCCEEDED`, `FAILED`, `CANCELED`, `EXCEEDED_LIMIT` are the end statuses. */
+  status: Status; /** The ID of the tenant who owns the reload. */
+  tenantId: string; /** What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data, choreographer = reload triggered by choreographer. */
+  type: Type; /** The ID of the user who created the reload. */
+  userId: string; /** The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1. */
   weight?: Weight;
 };
 type ReloadLinks = {
   self?: Href;
 };
 type ReloadRequest = {
-  /** The ID of the app to be reloaded. */
-  appId: string;
-  /** The boolean value used to present the reload is partial or not */
-  partial?: boolean;
-  /** The variables to be used in the load script. Maximum of 20 variables allowed with a maximum length of 256 characters for each name/value. */
-  variables?: Record<string, string>;
-  /** The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1. */
+  /** The ID of the app to be reloaded. */appId: string; /** The boolean value used to present the reload is partial or not */
+  partial?: boolean; /** The variables to be used in the load script. Maximum of 20 variables allowed with a maximum length of 256 characters for each name/value. */
+  variables?: Record<string, string>; /** The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1. */
   weight?: Weight;
 };
 type Reloads = {
@@ -121,8 +101,7 @@ type Weight = number;
  * @throws GetReloadsHttpError
  */
 declare function getReloads(query: {
-  /** The UUID formatted string used to search for an app's reload history entries. TenantAdmin users may omit this parameter to list all reload history in the tenant. */
-  appId: string;
+  /** The UUID formatted string used to search for an app's reload history entries. TenantAdmin users may omit this parameter to list all reload history in the tenant. */appId: string;
   /** SCIM filter expression used to search for reloads.
    * The filter syntax is defined in RFC 7644 section 3.4.2.2
    *
@@ -133,16 +112,11 @@ declare function getReloads(query: {
    *
    * Supported operators:
    * - eq */
-  filter?: string;
-  /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
-  limit?: number;
-  /** The boolean value used to include the log field or not, set log=true to include the log field. */
-  log?: boolean;
-  /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
-  next?: string;
-  /** The boolean value used to search for a reload is partial or not. */
-  partial?: boolean;
-  /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
+  filter?: string; /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
+  limit?: number; /** The boolean value used to include the log field or not, set log=true to include the log field. */
+  log?: boolean; /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
+  next?: string; /** The boolean value used to search for a reload is partial or not. */
+  partial?: boolean; /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
   prev?: string;
 }, options?: ApiCallOptions): Promise<GetReloadsHttpResponse>;
 type GetReloadsHttpResponse = {

package/reloads.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-QhLPeQr5.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/reloads.ts
 /**
@@ -82,7 +82,6 @@ const reloadsExport = {
 	cancelReload,
 	clearCache
 };
-var reloads_default = reloadsExport;
 
 //#endregion
-export { cancelReload, clearCache, reloads_default as default, getReload, getReloads, queueReload };
+export { cancelReload, clearCache, reloadsExport as default, getReload, getReloads, queueReload };

package/report-templates.d.ts

@@ -1,37 +1,26 @@
-import { S as DownloadableBlob, y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions, DownloadableBlob } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
 
 //#region src/public/rest/report-templates.d.ts
 type CreateTemplateRequest = {
-  /** Template description */
-  description?: string;
-  /** Template name */
-  name: string;
-  /** Specifies the action to perform with the given source app id. Use "validate" to verify that the template source app matches the provided value. Use "replace" to migrate the template to a different app by replacing the source app id. */
-  sourceAppAction?: "validate" | "replace";
-  /** The ID of the app that this template is using as data source. The id stored in the template file metadata is used if no value is specified. */
-  sourceAppId?: string;
-  /** The ID of a previously uploaded temporary content file */
+  /** Template description */description?: string; /** Template name */
+  name: string; /** Specifies the action to perform with the given source app id. Use "validate" to verify that the template source app matches the provided value. Use "replace" to migrate the template to a different app by replacing the source app id. */
+  sourceAppAction?: "validate" | "replace"; /** The ID of the app that this template is using as data source. The id stored in the template file metadata is used if no value is specified. */
+  sourceAppId?: string; /** The ID of a previously uploaded temporary content file */
   temporaryContentId: string;
 };
 type ErrorResponseItem = {
-  /** The error code. */
-  code?: string;
-  /** A human-readable explanation specific to this occurrence of the problem. */
-  detail?: string;
-  /** Additional error metadata. */
-  meta?: unknown;
-  /** Summary of the problem. */
+  /** The error code. */code?: string; /** A human-readable explanation specific to this occurrence of the problem. */
+  detail?: string; /** Additional error metadata. */
+  meta?: unknown; /** Summary of the problem. */
   title?: string;
 };
 type ErrorResult = {
-  /** List of errors and their properties. */
-  errors?: ErrorResponseItem[];
+  /** List of errors and their properties. */errors?: ErrorResponseItem[];
   readonly statusCode?: number;
 };
 type GetTemplatesResponse = {
-  /** The current page data. */
-  data?: ReportTemplateResponse[];
+  /** The current page data. */data?: ReportTemplateResponse[];
   links?: PaginationLinks;
 };
 type Operation = {
@@ -41,8 +30,7 @@ type Operation = {
   value?: unknown;
 };
 type PaginationLink = {
-  /** The URL for the pagination link. */
-  href?: string;
+  /** The URL for the pagination link. */href?: string;
 };
 type PaginationLinks = {
   next?: PaginationLink;
@@ -50,37 +38,22 @@ type PaginationLinks = {
   self?: PaginationLink;
 };
 type ReportTemplateResponse = {
-  /** The date and time when the template was created. */
-  createdAt?: string;
-  /** The id of the user who created the template. */
-  createdBy?: string;
-  /** Template description */
-  description?: string;
-  /** The template ID */
-  id?: string;
-  /** The template metadata version */
-  metadataVersion?: number;
-  /** Template name */
-  name?: string;
-  /** The user that this template is scoped to. */
-  ownerId?: string;
-  /** The id of the app that this template is using as data source. */
-  sourceAppId?: string;
-  /** The name of the app that this template is using as data source. */
-  sourceAppName?: string;
-  /** The date and time when the template was last updated. */
-  updatedAt?: string;
-  /** The id of the user who last updated the template. */
+  /** The date and time when the template was created. */createdAt?: string; /** The id of the user who created the template. */
+  createdBy?: string; /** Template description */
+  description?: string; /** The template ID */
+  id?: string; /** The template metadata version */
+  metadataVersion?: number; /** Template name */
+  name?: string; /** The user that this template is scoped to. */
+  ownerId?: string; /** The id of the app that this template is using as data source. */
+  sourceAppId?: string; /** The name of the app that this template is using as data source. */
+  sourceAppName?: string; /** The date and time when the template was last updated. */
+  updatedAt?: string; /** The id of the user who last updated the template. */
   updatedBy?: string;
 };
 type UpdateTemplateRequest = {
-  /** Template description */
-  description?: string;
-  /** Template name */
-  name: string;
-  /** Specifies the action to perform with the new source app. Use "validate" to verify that the source app of the uploaded template matches the target app. Use "replace" to migrate the uploaded template to the target app by replacing the source app id. */
-  sourceAppAction?: "validate" | "replace";
-  /** The ID of a previously uploaded temporary content file */
+  /** Template description */description?: string; /** Template name */
+  name: string; /** Specifies the action to perform with the new source app. Use "validate" to verify that the source app of the uploaded template matches the target app. Use "replace" to migrate the uploaded template to the target app by replacing the source app id. */
+  sourceAppAction?: "validate" | "replace"; /** The ID of a previously uploaded temporary content file */
   temporaryContentId: string;
 };
 /**
@@ -90,17 +63,11 @@ type UpdateTemplateRequest = {
  * @throws GetReportTemplatesHttpError
  */
 declare function getReportTemplates(query: {
-  /** If present, restrict the number of returned items to this value. */
-  limit?: number;
-  /** Template name to search and filter for. Case-insensitive open search with wildcards both as prefix and suffix. */
-  name?: string;
-  /** Return the templates for the specified owner. */
-  ownerId?: string;
-  /** If present, skip this number of the returned values in the result set (facilitates paging). */
-  skip?: number;
-  /** Field to sort by. Prefix with +/- to indicate ascending/descending. By default, the sort order is ascending. */
-  sort?: ("name" | "+name" | "-name" | "createdAt" | "+createdAt" | "-createdAt" | "updatedAt" | "+updatedAt" | "-updatedAt" | "type" | "+type" | "-type")[];
-  /** Return the templates that are using the specified app as data source. */
+  /** If present, restrict the number of returned items to this value. */limit?: number; /** Template name to search and filter for. Case-insensitive open search with wildcards both as prefix and suffix. */
+  name?: string; /** Return the templates for the specified owner. */
+  ownerId?: string; /** If present, skip this number of the returned values in the result set (facilitates paging). */
+  skip?: number; /** Field to sort by. Prefix with +/- to indicate ascending/descending. By default, the sort order is ascending. */
+  sort?: ("name" | "+name" | "-name" | "createdAt" | "+createdAt" | "-createdAt" | "updatedAt" | "+updatedAt" | "-updatedAt" | "type" | "+type" | "-type")[]; /** Return the templates that are using the specified app as data source. */
   sourceAppId?: string;
 }, options?: ApiCallOptions): Promise<GetReportTemplatesHttpResponse>;
 type GetReportTemplatesHttpResponse = {

package/report-templates.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-QhLPeQr5.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/report-templates.ts
 /**
@@ -126,7 +126,6 @@ const reportTemplatesExport = {
 	downloadReportTemplate,
 	clearCache
 };
-var report_templates_default = reportTemplatesExport;
 
 //#endregion
-export { clearCache, createReportTemplate, report_templates_default as default, deleteReportTemplate, downloadReportTemplate, getReportTemplate, getReportTemplates, patchReportTemplate, updateReportTemplate };
+export { clearCache, createReportTemplate, reportTemplatesExport as default, deleteReportTemplate, downloadReportTemplate, getReportTemplate, getReportTemplates, patchReportTemplate, updateReportTemplate };