@qlik/api 2.3.0 → 2.4.0

package/reports.d.ts

@@ -1,16 +1,13 @@
-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/reports.d.ts
 /**
  * Error in resource handling
  */
 type AppError = {
-  /** app id */
-  appId?: string;
-  /** The method that is failing. */
-  method?: string;
-  /** Parameters of method that fails. */
+  /** app id */appId?: string; /** The method that is failing. */
+  method?: string; /** Parameters of method that fails. */
   parameters?: Record<string, string>;
 };
 /**
@@ -21,31 +18,23 @@ type AppErrors = AppError[];
  * The callback to be performed once the report is done.
  */
 type CallBackAction = {
-  /** Http callback. The provided uri will be called once the report is done. */
-  httpRequest?: HttpRequest;
+  /** Http callback. The provided uri will be called once the report is done. */httpRequest?: HttpRequest;
 };
 type ChainableSelection = {
   persistentBookmark?: SensePersistentBookmark;
   selectionFilter?: SelectionFilter;
-  selectionType: ChainableSelectionType;
-  /** The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend. */
+  selectionType: ChainableSelectionType; /** The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend. */
   temporaryBookmarkV2?: SenseTemporaryBookmarkV2;
 };
 type ChainableSelectionType = "selectionFilter" | "persistentBookmark" | "temporaryBookmarkV2";
 type ComposableTemplate = {
-  /** Used to export a single visualization as pdf, pptx or png. */
-  senseImageTemplate?: SenseImageTemplate;
-  /** Used to export a sheet as pdf or pptx. */
-  senseSheetTemplate?: SenseSheetTemplate;
-  /** Template type and version using semantic versioning. It must have the following name convention, dashed-separated-template-name-MAJOR.MINOR */
+  /** Used to export a single visualization as pdf, pptx or png. */senseImageTemplate?: SenseImageTemplate; /** Used to export a sheet as pdf or pptx. */
+  senseSheetTemplate?: SenseSheetTemplate; /** Template type and version using semantic versioning. It must have the following name convention, dashed-separated-template-name-MAJOR.MINOR */
   type: "sense-image-1.0" | "sense-sheet-1.0";
 };
 type CycleOutput = {
-  /** Output to be used to export an excel template. */
-  excelOutput?: ExcelOutput;
-  /** not needed at initial phase */
-  namingPattern?: "fieldValueWithUnderscore";
-  /** Output to be used to export a single visualization, a sheet, Sense Excel template as pdf. For Sense Excel template (sense-excel-template-1.0) no properties are needed, any property specified has no effect. */
+  /** Output to be used to export an excel template. */excelOutput?: ExcelOutput; /** not needed at initial phase */
+  namingPattern?: "fieldValueWithUnderscore"; /** Output to be used to export a single visualization, a sheet, Sense Excel template as pdf. For Sense Excel template (sense-excel-template-1.0) no properties are needed, any property specified has no effect. */
   pdfOutput?: PdfOutput;
   type: "excel" | "pdf" | "html" | "powerpoint" | "word";
 };
@@ -53,8 +42,7 @@ type CycleOutput = {
  * Definitions of common properties that are shared between templates, e.g. selectionsByState can be the same for all templates within a composition of templates.
  */
 type Definitions = {
-  /** It maps an ID to a selectionsByState object. */
-  selectionsByState?: Record<string, Record<string, QSelection[]>>;
+  /** It maps an ID to a selectionsByState object. */selectionsByState?: Record<string, Record<string, QSelection[]>>;
 };
 /**
  * Properties of the document. In case of multiple composition, only properties specified in the composition output are taken and the ones specified in each output item are ignored.
@@ -65,22 +53,17 @@ type DocProperties = {
   title?: string;
 };
 type Error = {
-  /** Errors occured during report generation. */
-  errors?: ExportErrors;
+  /** Errors occured during report generation. */errors?: ExportErrors;
 };
 /**
  * Output to be used to export an excel template.
  */
 type ExcelOutput = {
-  /** The output format of the report to be produced. */
-  outFormat?: "xlsx";
+  /** The output format of the report to be produced. */outFormat?: "xlsx";
 };
 type ExportDataOptions = {
-  /** Show the Selections Applied to the Visualization in the artifact produced */
-  showSelections?: boolean;
-  /** Show Visualization Title, SubTitle, Footnote in the artifact produced */
-  showTitles?: boolean;
-  /** Show Visualization Totals in the artifact produced */
+  /** Show the Selections Applied to the Visualization in the artifact produced */showSelections?: boolean; /** Show Visualization Title, SubTitle, Footnote in the artifact produced */
+  showTitles?: boolean; /** Show Visualization Totals in the artifact produced */
   showTotals?: boolean;
 };
 /**
@@ -168,12 +151,9 @@ type ExportError = {
    * - "REP-503005" Engine unavailable, qix-sessions error no engines available.
    * - "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
    * - "REP-503060" Engine Service unavailable. */
-  code: string;
-  /** Optional. MAY be used to provide more concrete details. */
-  detail?: string;
-  /** Define the export error metadata. Each property is filled if it is related to the export error type. */
-  meta?: MetaExportError;
-  /** A summary in english explaining what went wrong. */
+  code: string; /** Optional. MAY be used to provide more concrete details. */
+  detail?: string; /** Define the export error metadata. Each property is filled if it is related to the export error type. */
+  meta?: MetaExportError; /** A summary in english explaining what went wrong. */
   title: string;
 };
 /**
@@ -185,18 +165,14 @@ type Float64 = number;
  * Http callback. The provided uri will be called once the report is done.
  */
 type HttpRequest = {
-  /** URI of the request. */
-  uri?: string;
+  /** URI of the request. */uri?: string;
 };
 /**
  * Output to be used to export a single visualization as image.
  */
 type ImageOutput = {
-  /** Image resolution in DPI (default 96 DPI). */
-  outDpi?: number;
-  /** The image format of the report to be produced. */
-  outFormat?: "png" | "jsondata";
-  /** The scale factor to be applied in image scaling. A zoom greater than 5 will not be applied to the device pixel ratio which will remain fixed at 5. */
+  /** Image resolution in DPI (default 96 DPI). */outDpi?: number; /** The image format of the report to be produced. */
+  outFormat?: "png" | "jsondata"; /** The scale factor to be applied in image scaling. A zoom greater than 5 will not be applied to the device pixel ratio which will remain fixed at 5. */
   outZoom?: number;
 };
 type LinkResponse = {
@@ -225,28 +201,22 @@ type LinksResponse = {
  * Define the request metadata. It includes priority, deadline and future settings on execution policy of the request.
  */
 type Meta = {
-  /** The maximum interval, starting from the time the API request is received, within which a report must be produced, past this interval the report generation fails. The default value is 10 minutes, the maximum allowed value is 4 hours. The recommended value for standard apps and exports (image, data, sheet) is 10 minutes, for larger apps or reports using composition or file based templates (Excel, PixelPerfect, HTML...) it should be set to 1 hour. */
-  exportDeadline?: string;
-  /** Time to live of the final result artifacts in ISO8601 duration format. After that duration the request and underlying output files will not be guaranteed to be available. Default is 1 hour. */
+  /** The maximum interval, starting from the time the API request is received, within which a report must be produced, past this interval the report generation fails. The default value is 10 minutes, the maximum allowed value is 4 hours. The recommended value for standard apps and exports (image, data, sheet) is 10 minutes, for larger apps or reports using composition or file based templates (Excel, PixelPerfect, HTML...) it should be set to 1 hour. */exportDeadline?: string; /** Time to live of the final result artifacts in ISO8601 duration format. After that duration the request and underlying output files will not be guaranteed to be available. Default is 1 hour. */
   outputTtl?: string;
 };
 /**
  * Define the export error metadata. Each property is filled if it is related to the export error type.
  */
 type MetaExportError = {
-  /** Errors occurring when dealing with the app. */
-  appErrors?: AppErrors;
-  /** Errors occurring in selections. */
+  /** Errors occurring when dealing with the app. */appErrors?: AppErrors; /** Errors occurring in selections. */
   selectionErrors?: SelectionErrors;
 };
 /**
  * Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.
  */
 type NxPatch = {
-  qOp: "add" | "remove" | "replace";
-  /** Path to the property to add, remove or replace. */
-  qPath: string;
-  /** Corresponds to the value of the property to add or to the new value of the property to update. */
+  qOp: "add" | "remove" | "replace"; /** Path to the property to add, remove or replace. */
+  qPath: string; /** Corresponds to the value of the property to add or to the new value of the property to update. */
   qValue?: string;
 };
 /**
@@ -270,22 +240,14 @@ type NxPatch = {
  * }
  */
 type OutputItem = {
-  /** The callback to be performed once the report is done. */
-  callBackAction?: CallBackAction;
-  cycleOutput?: CycleOutput;
-  /** Output to be used to export an excel template. */
-  excelOutput?: ExcelOutput;
-  /** Output to be used to export a single visualization as image. */
-  imageOutput?: ImageOutput;
-  /** The output identifier which uniquely identifies an output (PDF, image etc.) within the same request. It does not need to be a GUID. No spaces and colons are allowed in the outputId string. */
-  outputId: string;
-  /** Output to be used to export a composition of templates as pdf. */
-  pdfCompositionOutput?: PdfCompositionOutput;
-  /** Output to be used to export a single visualization, a sheet, Sense Excel template as pdf. For Sense Excel template (sense-excel-template-1.0) no properties are needed, any property specified has no effect. */
-  pdfOutput?: PdfOutput;
-  /** Output to be used to export a composition of templates as pptx. */
-  pptxCompositionOutput?: PptxCompositionOutput;
-  /** Output to be used to export a single visualization or a sheet as PowerPoint presentation. */
+  /** The callback to be performed once the report is done. */callBackAction?: CallBackAction;
+  cycleOutput?: CycleOutput; /** Output to be used to export an excel template. */
+  excelOutput?: ExcelOutput; /** Output to be used to export a single visualization as image. */
+  imageOutput?: ImageOutput; /** The output identifier which uniquely identifies an output (PDF, image etc.) within the same request. It does not need to be a GUID. No spaces and colons are allowed in the outputId string. */
+  outputId: string; /** Output to be used to export a composition of templates as pdf. */
+  pdfCompositionOutput?: PdfCompositionOutput; /** Output to be used to export a single visualization, a sheet, Sense Excel template as pdf. For Sense Excel template (sense-excel-template-1.0) no properties are needed, any property specified has no effect. */
+  pdfOutput?: PdfOutput; /** Output to be used to export a composition of templates as pptx. */
+  pptxCompositionOutput?: PptxCompositionOutput; /** Output to be used to export a single visualization or a sheet as PowerPoint presentation. */
   pptxOutput?: PptxOutput;
   /** The generated report type.
    *
@@ -312,21 +274,15 @@ type OutputItem = {
   type: "image" | "pdf" | "xlsx" | "jsondata" | "pdfcomposition" | "excel" | "pptx" | "pptxcomposition" | "csv" | "cycle" | "html" | "powerpoint" | "word";
 };
 type OutputList = {
-  /** a list of outputs containing all the report outputs */
-  data: OutputListItem[];
+  /** a list of outputs containing all the report outputs */data: OutputListItem[];
   links: LinksResponse;
 };
 type OutputListItem = {
-  cycleSelections?: QSelection[];
-  /** Errors occured during report generation. */
-  exportErrors?: ExportErrors;
-  /** Location to download the generated report file. */
-  location?: string;
-  /** The output ID */
-  readonly outputId?: string;
-  /** output size in bytes */
-  sizeBytes?: number;
-  /** Status of the requested report. */
+  cycleSelections?: QSelection[]; /** Errors occured during report generation. */
+  exportErrors?: ExportErrors; /** Location to download the generated report file. */
+  location?: string; /** The output ID */
+  readonly outputId?: string; /** output size in bytes */
+  sizeBytes?: number; /** Status of the requested report. */
   status?: "queued" | "processing" | "done" | "failed" | "aborted" | "aborting";
   traceId?: string;
 };
@@ -334,65 +290,48 @@ type OutputListItem = {
  * Output to be used to export a composition of templates as pdf.
  */
 type PdfCompositionOutput = {
-  /** The ordered list of PDF outputs, the number must match the composable templates. */
-  pdfOutputs?: PdfOutput[];
-  /** Properties of the document. In case of multiple composition, only properties specified in the composition output are taken and the ones specified in each output item are ignored. */
+  /** The ordered list of PDF outputs, the number must match the composable templates. */pdfOutputs?: PdfOutput[]; /** Properties of the document. In case of multiple composition, only properties specified in the composition output are taken and the ones specified in each output item are ignored. */
   properties?: DocProperties;
 };
 /**
  * Output to be used to export a single visualization, a sheet, Sense Excel template as pdf. For Sense Excel template (sense-excel-template-1.0) no properties are needed, any property specified has no effect.
  */
 type PdfOutput = {
-  /** Content alignment. */
-  align?: {
+  /** Content alignment. */align?: {
     horizontal?: "left" | "center" | "right";
     vertical?: "top" | "middle" | "bottom";
-  };
-  /** This value is used for rendered images only, set to a default of 300 dpi. */
-  imageRenderingDpi?: number;
-  /** P for portrait, L for landscape and A for auto-detect. Auto-detect sets the orientation depending on the content width and height proportions: if content width > height the orientation is automatically set to landscape, portrait otherwise. */
-  orientation?: "P" | "L" | "A";
-  /** Properties of the document. In case of multiple composition, only properties specified in the composition output are taken and the ones specified in each output item are ignored. */
-  properties?: DocProperties;
-  /** The area where the object (eg. sheet, chart) is printed. Required in case of "fit" resizeType. */
+  }; /** This value is used for rendered images only, set to a default of 300 dpi. */
+  imageRenderingDpi?: number; /** P for portrait, L for landscape and A for auto-detect. Auto-detect sets the orientation depending on the content width and height proportions: if content width > height the orientation is automatically set to landscape, portrait otherwise. */
+  orientation?: "P" | "L" | "A"; /** Properties of the document. In case of multiple composition, only properties specified in the composition output are taken and the ones specified in each output item are ignored. */
+  properties?: DocProperties; /** The area where the object (eg. sheet, chart) is printed. Required in case of "fit" resizeType. */
   resizeData?: {
-    /** The size of the area in the following format "{width}{cm|mm}x{height}{cm|mm}" (e.g. "297mmx210mm"). Please remember that PDF page orientation (landscape or portrait) should match the width and height set for this field (eg. A4 landscape is "297mmx210mm", A4 portrait is "210mmx287mm"). Note that the minimum printable area is 1.5cmx1.5cm (corresponding to 0.6x0.6 inches at 96 DPI). */
-    fit?: string;
+    /** The size of the area in the following format "{width}{cm|mm}x{height}{cm|mm}" (e.g. "297mmx210mm"). Please remember that PDF page orientation (landscape or portrait) should match the width and height set for this field (eg. A4 landscape is "297mmx210mm", A4 portrait is "210mmx287mm"). Note that the minimum printable area is 1.5cmx1.5cm (corresponding to 0.6x0.6 inches at 96 DPI). */fit?: string;
   };
   /** The type of resize to be performed:
    *   - none is used to export a visualization, sheet or story as is (e.g. normal size), regardless of its size. This may result in cropping.
    *   - autofit automatically fits the visualization, sheet or story into the output size (i.e. A4, A3 etc.). Any provided resizeData parameter will be ignored for this configuration.
    *   - fit fits the visualization, sheet or story into the area specified in resizeData. The content will be rescaled to fit in that area. */
-  resizeType?: "none" | "autofit" | "fit";
-  /** Size of the pdf page. */
+  resizeType?: "none" | "autofit" | "fit"; /** Size of the pdf page. */
   size?: "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | "Letter" | "Legal" | "Tabloid";
 };
 type PostReportsResponse = {
-  /** A message indicating the status of the request. */
-  message?: string;
-  /** The absolute URL to get the outputs of the report request. */
-  outputsUrl?: string;
-  /** The report request ID */
+  /** A message indicating the status of the request. */message?: string; /** The absolute URL to get the outputs of the report request. */
+  outputsUrl?: string; /** The report request ID */
   readonly requestId?: string;
 };
 /**
  * Output to be used to export a composition of templates as pptx.
  */
 type PptxCompositionOutput = {
-  /** Output to be used to export a single visualization or a sheet as PowerPoint presentation. */
-  pptxOutput?: PptxOutput;
+  /** Output to be used to export a single visualization or a sheet as PowerPoint presentation. */pptxOutput?: PptxOutput;
 };
 /**
  * Output to be used to export a single visualization or a sheet as PowerPoint presentation.
  */
 type PptxOutput = {
-  /** This value is used for rendered images only, set to a default of 300 dpi. */
-  imageRenderingDpi?: number;
-  /** L for landscape, P for portrait and A for auto-detect. Auto-detect sets landscape, the default PowerPoint orientation. */
-  orientation?: "L" | "P" | "A";
-  /** Properties of the document. In case of multiple composition, only properties specified in the composition output are taken and the ones specified in each output item are ignored. */
-  properties?: DocProperties;
-  /** The type of resize to be performed. Autofit automatically fits the visualization, sheet or story into the output size (i.e. Widescreen, OnScreen etc.). */
+  /** This value is used for rendered images only, set to a default of 300 dpi. */imageRenderingDpi?: number; /** L for landscape, P for portrait and A for auto-detect. Auto-detect sets landscape, the default PowerPoint orientation. */
+  orientation?: "L" | "P" | "A"; /** Properties of the document. In case of multiple composition, only properties specified in the composition output are taken and the ones specified in each output item are ignored. */
+  properties?: DocProperties; /** The type of resize to be performed. Autofit automatically fits the visualization, sheet or story into the output size (i.e. Widescreen, OnScreen etc.). */
   resizeType?: "autofit";
   /** Size of the PowerPoint slide:
    *   - Widescreen: 960x540
@@ -405,24 +344,17 @@ type PptxOutput = {
  * In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.
  */
 type QFieldValue = {
-  /** IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection. */
-  isNumeric?: boolean;
-  number?: Float64;
-  /** String value of the field value. */
+  /** IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection. */isNumeric?: boolean;
+  number?: Float64; /** String value of the field value. */
   text?: string;
 };
 type QSelection = {
-  /** Default value that QFieldValue isNumeric property takes if missing. */
-  defaultIsNumeric: boolean;
-  /** The name of the field to be selected. */
-  fieldName: string;
-  /** The values of the field to be selected. */
+  /** Default value that QFieldValue isNumeric property takes if missing. */defaultIsNumeric: boolean; /** The name of the field to be selected. */
+  fieldName: string; /** The values of the field to be selected. */
   values: QFieldValue[];
 };
 type Reason = {
-  /** Errors occured during report generation. */
-  exportErrors?: ExportErrors;
-  /** The output identifier which uniquely identifies an output (PDF, image etc.) within the same request. */
+  /** Errors occured during report generation. */exportErrors?: ExportErrors; /** The output identifier which uniquely identifies an output (PDF, image etc.) within the same request. */
   outputId?: string;
   traceId?: string;
 };
@@ -499,29 +431,18 @@ type Reason = {
  * }
  */
 type ReportRequest = {
-  /** Composition of senseSheetTemplate and/or senseImageTemplate templates. */
-  compositionTemplates?: ComposableTemplate[];
-  /** Definitions of common properties that are shared between templates, e.g. selectionsByState can be the same for all templates within a composition of templates. */
-  definitions?: Definitions;
-  /** Define the request metadata. It includes priority, deadline and future settings on execution policy of the request. */
+  /** Composition of senseSheetTemplate and/or senseImageTemplate templates. */compositionTemplates?: ComposableTemplate[]; /** Definitions of common properties that are shared between templates, e.g. selectionsByState can be the same for all templates within a composition of templates. */
+  definitions?: Definitions; /** Define the request metadata. It includes priority, deadline and future settings on execution policy of the request. */
   meta?: Meta;
-  output: OutputItem;
-  /** The callback to be performed once the report is done. */
+  output: OutputItem; /** The callback to be performed once the report is done. */
   requestCallBackAction?: CallBackAction;
-  senseDataTemplate?: SenseDataTemplate;
-  /** Used to produce reports from a template file. */
-  senseExcelTemplate?: SenseFileTemplate;
-  /** Used to produce reports from a template file. */
-  senseHtmlTemplate?: SenseFileTemplate;
-  /** Used to export a single visualization as pdf, pptx or png. */
-  senseImageTemplate?: SenseImageTemplate;
-  /** Used to produce reports from a template file. */
-  sensePixelPerfectTemplate?: SenseFileTemplate;
-  /** Used to produce reports from a template file. */
-  sensePowerPointTemplate?: SenseFileTemplate;
-  /** Used to export a sheet as pdf or pptx. */
-  senseSheetTemplate?: SenseSheetTemplate;
-  /** Used to produce reports from a template file. */
+  senseDataTemplate?: SenseDataTemplate; /** Used to produce reports from a template file. */
+  senseExcelTemplate?: SenseFileTemplate; /** Used to produce reports from a template file. */
+  senseHtmlTemplate?: SenseFileTemplate; /** Used to export a single visualization as pdf, pptx or png. */
+  senseImageTemplate?: SenseImageTemplate; /** Used to produce reports from a template file. */
+  sensePixelPerfectTemplate?: SenseFileTemplate; /** Used to produce reports from a template file. */
+  sensePowerPointTemplate?: SenseFileTemplate; /** Used to export a sheet as pdf or pptx. */
+  senseSheetTemplate?: SenseSheetTemplate; /** Used to produce reports from a template file. */
   senseWordTemplate?: SenseFileTemplate;
   /** Template type and version using semantic versioning. It must have the following name convention: dashed-separated-template-name-MAJOR.MINOR.
    * Please note that sense-powerpoint-template-1.0, sense-word-template-1.0, sense-story-x.0 and qv-data-x.0 are only for internal use.
@@ -574,28 +495,21 @@ type ReportRequest = {
 type ReportStatus = {
   /** @deprecated
    * Present when status is failed. Deprecated. Use /reports/{id}/outputs instead. */
-  reasons?: Reason[];
-  /** Errors occured during report generation. */
-  requestErrors?: ExportErrors;
-  /** Count how many times the resolution of this report was attempted. */
+  reasons?: Reason[]; /** Errors occured during report generation. */
+  requestErrors?: ExportErrors; /** Count how many times the resolution of this report was attempted. */
   resolutionAttempts?: number;
   /** @deprecated
    * Present when the status is "done". Deprecated. Use /reports/{id}/outputs instead. */
-  results?: Result[];
-  /** Status of the requested report. */
-  status: "queued" | "processing" | "done" | "failed" | "aborted" | "visiting" | "aborting";
-  /** Relative path to status location. */
+  results?: Result[]; /** Status of the requested report. */
+  status: "queued" | "processing" | "done" | "failed" | "aborted" | "visiting" | "aborting"; /** Relative path to status location. */
   statusLocation?: string;
 };
 /**
  * Result and info about the generated report.
  */
 type Result = {
-  /** Errors occured during report generation. */
-  exportErrors?: ExportErrors;
-  /** Location to download the generated report. */
-  location: string;
-  /** The output identifier which uniquely identifies an output (PDF, image etc.) within the same request. */
+  /** Errors occured during report generation. */exportErrors?: ExportErrors; /** Location to download the generated report. */
+  location: string; /** The output identifier which uniquely identifies an output (PDF, image etc.) within the same request. */
   outputId: string;
 };
 /**
@@ -606,16 +520,13 @@ type SelectionChain = ChainableSelection[];
  * Selection error related to a fieldName. The field name is missing or some of his selection values are missing or a state is missing
  */
 type SelectionError = {
-  /** Details about the field selection error. */
-  detail?: string;
-  errorType?: "fieldMissing" | "fieldValuesMissing" | "stateMissing" | "groupStateGroupMissing" | "groupStateGroupNotApplicable" | "groupStateFieldDefMissing";
-  /** The field name that is missing. */
+  /** Details about the field selection error. */detail?: string;
+  errorType?: "fieldMissing" | "fieldValuesMissing" | "stateMissing" | "groupStateGroupMissing" | "groupStateGroupNotApplicable" | "groupStateFieldDefMissing"; /** The field name that is missing. */
   fieldName?: string;
   /** @deprecated
    * Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case */
   isFieldNameMissing?: boolean;
-  missingValues?: QFieldValue[];
-  /** The state name that is missing. */
+  missingValues?: QFieldValue[]; /** The state name that is missing. */
   stateName?: string;
 };
 /**
@@ -623,27 +534,21 @@ type SelectionError = {
  */
 type SelectionErrors = SelectionError[];
 type SelectionFilter = {
-  /** A map for applying soft properties, aka patches, to specific visualization IDs within the sheet. */
-  patchesById?: Record<string, NxPatch[]>;
-  /** Map of selections 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. */
+  /** A map for applying soft properties, aka patches, to specific visualization IDs within the sheet. */patchesById?: Record<string, NxPatch[]>; /** Map of selections 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. */
   selectionsByState?: Record<string, QSelection[]>;
   variables?: unknown[];
 };
 type SelectionStrategy = "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
 type SenseDataTemplate = {
   appId: string;
-  exportOptions?: ExportDataOptions;
-  /** Sense visualization id. Visualizations created "on the fly" are not supported. */
+  exportOptions?: ExportDataOptions; /** Sense visualization id. Visualizations created "on the fly" are not supported. */
   id: string;
   patches?: NxPatch[];
-  persistentBookmark?: SensePersistentBookmark;
-  /** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
+  persistentBookmark?: SensePersistentBookmark; /** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
   reloadTimestampMatchType?: ReloadTimestampMatchType;
   selectionStrategy?: SelectionStrategy;
-  selectionType?: SenseSelectionType;
-  /** Map of selections 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. */
-  selectionsByState?: Record<string, QSelection[]>;
-  /** The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend. */
+  selectionType?: SenseSelectionType; /** Map of selections 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. */
+  selectionsByState?: Record<string, QSelection[]>; /** The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend. */
   temporaryBookmarkV2?: SenseTemporaryBookmarkV2;
   variables?: unknown[];
 };
@@ -651,15 +556,10 @@ type SenseDataTemplate = {
  * Used to produce reports from a template file.
  */
 type SenseFileTemplate = {
-  /** The values of the field to be selected. */
-  cycleFields?: string[];
-  /** A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. Currently only the "theme" and "language" properties are supported. */
-  jsOpts?: unknown;
-  /** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
-  reloadTimestampMatchType?: ReloadTimestampMatchType;
-  /** Array of ChainableSelection */
-  selectionChain?: SelectionChain;
-  /** The location of the report template. Currently it can be an absolute or relative URL to a persisted report template, or to a template file saved as temporary content, as in the following examples: - https://qlikcloud.com:443/api/v1/report-templates/223940f7-3170-46b7-91ea-e0c81230adf7 - https://qlikcloud.com:443/api/v1/temp-contents/653bb4acae966r0730da15fc */
+  /** The values of the field to be selected. */cycleFields?: string[]; /** A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. Currently only the "theme" and "language" properties are supported. */
+  jsOpts?: unknown; /** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
+  reloadTimestampMatchType?: ReloadTimestampMatchType; /** Array of ChainableSelection */
+  selectionChain?: SelectionChain; /** The location of the report template. Currently it can be an absolute or relative URL to a persisted report template, or to a template file saved as temporary content, as in the following examples: - https://qlikcloud.com:443/api/v1/report-templates/223940f7-3170-46b7-91ea-e0c81230adf7 - https://qlikcloud.com:443/api/v1/temp-contents/653bb4acae966r0730da15fc */
   templateLocation: TemplateLocation;
 };
 /**
@@ -667,22 +567,17 @@ type SenseFileTemplate = {
  */
 type SenseImageTemplate = {
   appId: string;
-  persistentBookmark?: SensePersistentBookmark;
-  /** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
+  persistentBookmark?: SensePersistentBookmark; /** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
   reloadTimestampMatchType?: ReloadTimestampMatchType;
   selectionStrategy?: SelectionStrategy;
-  selectionType?: SenseSelectionType;
-  /** Map of selections 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. */
-  selectionsByState?: Record<string, QSelection[]>;
-  /** The definition ID referring to a selectionsByState definition declared in definitions. */
-  selectionsByStateDef?: string;
-  /** The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend. */
+  selectionType?: SenseSelectionType; /** Map of selections 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. */
+  selectionsByState?: Record<string, QSelection[]>; /** The definition ID referring to a selectionsByState definition declared in definitions. */
+  selectionsByStateDef?: string; /** The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend. */
   temporaryBookmarkV2?: SenseTemporaryBookmarkV2;
   visualization: Visualization;
 };
 type SensePersistentBookmark = {
-  /** Sense Persistence Bookmark id. */
-  id: string;
+  /** Sense Persistence Bookmark id. */id: string;
 };
 type SenseSelectionType = "selectionsByState" | "temporaryBookmark" | "persistentBookmark" | "temporaryBookmarkV2";
 /**
@@ -690,64 +585,45 @@ type SenseSelectionType = "selectionsByState" | "temporaryBookmark" | "persisten
  */
 type SenseSheetTemplate = {
   appId: string;
-  persistentBookmark?: SensePersistentBookmark;
-  /** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
+  persistentBookmark?: SensePersistentBookmark; /** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
   reloadTimestampMatchType?: ReloadTimestampMatchType;
   selectionStrategy?: SelectionStrategy;
-  selectionType?: SenseSelectionType;
-  /** Map of selections 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. */
-  selectionsByState?: Record<string, QSelection[]>;
-  /** The definition ID referring to a selectionsByState definition declared in definitions. */
-  selectionsByStateDef?: string;
-  /** It refers to the Sense Sheet to be exported. Note that if widthPx and heightPx are not specified, default values will be applied depending on the actual size and layout properties of the Sense Sheet object. */
-  sheet: Sheet;
-  /** The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend. */
+  selectionType?: SenseSelectionType; /** Map of selections 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. */
+  selectionsByState?: Record<string, QSelection[]>; /** The definition ID referring to a selectionsByState definition declared in definitions. */
+  selectionsByStateDef?: string; /** It refers to the Sense Sheet to be exported. Note that if widthPx and heightPx are not specified, default values will be applied depending on the actual size and layout properties of the Sense Sheet object. */
+  sheet: Sheet; /** The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend. */
   temporaryBookmarkV2?: SenseTemporaryBookmarkV2;
 };
 /**
  * The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.
  */
 type SenseTemporaryBookmarkV2 = {
-  /** Sense Temporary Bookmark id. */
-  id: string;
+  /** Sense Temporary Bookmark id. */id: string;
 };
 /**
  * It refers to the Sense Sheet to be exported. Note that if widthPx and heightPx are not specified, default values will be applied depending on the actual size and layout properties of the Sense Sheet object.
  */
 type Sheet = {
-  /** The height of the sheet in pixels. Default value is: - 1120 pixels for responsive sheet - 1680 pixels for extended sheet - same height set in sheet properties for custom sheet */
-  heightPx?: number;
-  /** The id of the sheet. */
-  id: string;
-  /** A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. */
-  jsOpts?: unknown;
-  /** A map for applying jsOpts to specific visualization IDs within the sheet. */
-  jsOptsById?: Record<string, unknown>;
-  /** A map for applying soft properties, aka patches, to specific visualization IDs within the sheet. */
-  patchesById?: Record<string, NxPatch[]>;
-  /** The width of the sheet in pixels. Default value is: - 1680 pixels for responsive sheet - 1120 pixels for extended sheet - same width set in sheet properties for custom sheet */
+  /** The height of the sheet in pixels. Default value is: - 1120 pixels for responsive sheet - 1680 pixels for extended sheet - same height set in sheet properties for custom sheet */heightPx?: number; /** The id of the sheet. */
+  id: string; /** A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. */
+  jsOpts?: unknown; /** A map for applying jsOpts to specific visualization IDs within the sheet. */
+  jsOptsById?: Record<string, unknown>; /** A map for applying soft properties, aka patches, to specific visualization IDs within the sheet. */
+  patchesById?: Record<string, NxPatch[]>; /** The width of the sheet in pixels. Default value is: - 1680 pixels for responsive sheet - 1120 pixels for extended sheet - same width set in sheet properties for custom sheet */
   widthPx?: number;
 };
 /**
  * The location of the report template. Currently it can be an absolute or relative URL to a persisted report template, or to a template file saved as temporary content, as in the following examples: - https://qlikcloud.com:443/api/v1/report-templates/223940f7-3170-46b7-91ea-e0c81230adf7 - https://qlikcloud.com:443/api/v1/temp-contents/653bb4acae966r0730da15fc
  */
 type TemplateLocation = {
-  format?: "url";
-  /** The report template location path. */
+  format?: "url"; /** The report template location path. */
   path: string;
 };
 type Visualization = {
-  /** Height in pixels. */
-  heightPx: number;
-  /** The sense visualization id or json definition. */
-  id: string;
-  /** A JSON object that is passed as-is to the mashup page while rendering. */
-  jsOpts?: unknown;
-  /** Soft properties, aka patches, to be applied to the visualization. */
-  patches?: NxPatch[];
-  /** Choose visualization to export an image of a sense chart, sessionobject for a visualization to be created on-the-fly. An empty value leads to the type being inferred by its id. */
-  type?: "visualization" | "sessionobject";
-  /** Width in pixels. */
+  /** Height in pixels. */heightPx: number; /** The sense visualization id or json definition. */
+  id: string; /** A JSON object that is passed as-is to the mashup page while rendering. */
+  jsOpts?: unknown; /** Soft properties, aka patches, to be applied to the visualization. */
+  patches?: NxPatch[]; /** Choose visualization to export an image of a sense chart, sessionobject for a visualization to be created on-the-fly. An empty value leads to the type being inferred by its id. */
+  type?: "visualization" | "sessionobject"; /** Width in pixels. */
   widthPx: number;
 };
 /**
@@ -786,12 +662,9 @@ declare function getReportOutputs(id: string, query: {
    * The following fields support the `eq` (equals) operator: `outputId`
    * Example:
    * outputId eq "123" or outputId eq "321" */
-  filter?: string;
-  /** Limit the returned result set */
-  limit?: number;
-  /** If present, the cursor that starts the page of data that is returned. */
-  page?: string;
-  /** Sorting parameters */
+  filter?: string; /** Limit the returned result set */
+  limit?: number; /** If present, the cursor that starts the page of data that is returned. */
+  page?: string; /** Sorting parameters */
   sort?: ("+outputId" | "-outputId" | "+sizeBytes" | "-sizeBytes")[];
 }, options?: ApiCallOptions): Promise<GetReportOutputsHttpResponse>;
 type GetReportOutputsHttpResponse = {