@gooddata/sdk-code-schemas 11.62.0-alpha.0 → 11.62.0-alpha.2

package/esm/sdk-code-schemas.d.ts

@@ -1192,7 +1192,7 @@ declare interface DashboardFilters1 {
 }
 
 /**
- * Filters applied on top of the effective page and report filters. A filter targeting the same object replaces the inherited one.
+ * Filters applied on top of the effective page and document filters. A filter targeting the same object replaces the inherited one.
  */
 declare interface DashboardFilters2 {
     /**
@@ -1215,7 +1215,7 @@ declare interface DashboardFilters2 {
 }
 
 /**
- * Page filters, merged over the report's own. A filter targeting the same object replaces the inherited one; a visualization's own filters apply on top.
+ * Page filters, merged over the document's own. A filter targeting the same object replaces the inherited one; a visualization's own filters apply on top.
  */
 declare interface DashboardFilters3 {
     /**
@@ -1238,7 +1238,7 @@ declare interface DashboardFilters3 {
 }
 
 /**
- * Report filters; pages and visualizations may extend or override them.
+ * Document filters; pages and visualizations may extend or override them.
  */
 declare interface DashboardFilters4 {
     /**
@@ -1284,7 +1284,7 @@ declare interface DashboardFilters5 {
 }
 
 /**
- * Page filters, carried into the template and report content this page is copied into.
+ * Page filters, carried into the template and document content this page is copied into.
  */
 declare interface DashboardFilters6 {
     /**
@@ -2158,7 +2158,7 @@ declare type Id43 = string;
 declare type Id44 = string;
 
 /**
- * A unique identifier of the report.
+ * A unique identifier of the document.
  */
 declare type Id45 = string;
 
@@ -2173,7 +2173,7 @@ declare type Id46 = string;
 declare type Id47 = string;
 
 /**
- * An id for this area, unique within the page. It is what a report fills when it takes this page from a template, so an id written down here survives edits to the layout around it.
+ * An id for this area, unique within the page. It is what a document fills when it takes this page from a template, so an id written down here survives edits to the layout around it.
  */
 declare type Id48 = string;
 
@@ -2185,7 +2185,7 @@ declare type Id49 = string;
 declare type Id5 = string;
 
 /**
- * An id of the date dataset the report's period is applied to as an absolute date filter. Omitted leaves the backend date dataset resolution to decide.
+ * An id of the date dataset the document's period is applied to as an absolute date filter. Omitted leaves the backend date dataset resolution to decide.
  */
 declare type Id50 = string;
 
@@ -2195,12 +2195,12 @@ declare type Id50 = string;
 declare type Id51 = string;
 
 /**
- * A unique identifier of the report template.
+ * A unique identifier of the document template.
  */
 declare type Id52 = string;
 
 /**
- * A unique identifier of the report page layout.
+ * A unique identifier of the document page layout.
  */
 declare type Id53 = string;
 
@@ -5683,6 +5683,11 @@ export declare const metadata_v1: {
                             const: string;
                         })[];
                     };
+                    line_shape: {
+                        description: string;
+                        type: string;
+                        enum: string[];
+                    };
                     data_totals: {
                         oneOf: ({
                             const?: undefined;
@@ -12586,22 +12591,22 @@ declare interface Report_2 {
     id: Id45;
     type: "report";
     /**
-     * A human readable title for the report.
+     * A human readable title for the document.
      */
     title: string;
     /**
-     * An optional description of the report.
+     * An optional description of the document.
      */
     description?: string;
     tags?: Tags37;
     period: ReportPeriod;
     /**
-     * Ordered pages of the report. A page is a deep copy taken when it was added, and never changes with the page layout or template it came from.
+     * Ordered pages of the document. A page is a deep copy taken when it was added, and never changes with the page layout or template it came from.
      */
     pages: ReportPageBody[];
     filters?: DashboardFilters4;
     /**
-     * Custom variables the report's text can interpolate as \{name\}. Built-in variable names win a collision.
+     * Custom variables the document's text can interpolate as \{name\}. Built-in variable names win a collision.
      */
     variables?: ReportVariable[];
     /**
@@ -12870,17 +12875,17 @@ declare type ReportPageFormat = "widescreen" | "a4Portrait" | "letterPortrait";
 declare type ReportPageKind = "cover" | "section" | "content";
 
 /**
- * A reusable page. Its content fields are the same page body a report and a report template carry inline, so a field added to /gaac/reportPageBody belongs here too: JSON Schema cannot compose the two, because the page body closes itself to the entity's own id, title and tags.
+ * A reusable page. Its content fields are the same page body a document and a document template carry inline, so a field added to /gaac/reportPageBody belongs here too: JSON Schema cannot compose the two, because the page body closes itself to the entity's own id, title and tags.
  */
 declare interface ReportPageLayout {
     id: Id53;
     type: "report_page_layout";
     /**
-     * A human readable title for the report page layout.
+     * A human readable title for the document page layout.
      */
     title: string;
     /**
-     * An optional description of the report page layout.
+     * An optional description of the document page layout.
      */
     description?: string;
     tags?: Tags39;
@@ -12900,15 +12905,15 @@ declare interface ReportParagraphSlot {
 }
 
 /**
- * The finished period the report covers. It is not a filter: at execution time it materializes as an absolute date filter on each visualization's date dataset, at the lowest precedence, which a visualization opts out of with ignore_report_period.
+ * The finished period the document covers. It is not a filter: at execution time it materializes as an absolute date filter on each visualization's date dataset, at the lowest precedence, which a visualization opts out of with ignore_report_period.
  */
 declare interface ReportPeriod {
     /**
-     * Reported period start, ISO 8601 date (YYYY-MM-DD), inclusive.
+     * Start of the period the document covers, ISO 8601 date (YYYY-MM-DD), inclusive.
      */
     start: string;
     /**
-     * Reported period end, ISO 8601 date (YYYY-MM-DD), inclusive.
+     * End of the period the document covers, ISO 8601 date (YYYY-MM-DD), inclusive.
      */
     end: string;
 }
@@ -12919,7 +12924,7 @@ declare interface ReportPeriod {
 declare type ReportSlotPlaceholder = ReportSlotPlaceholder1 | ReportSlotPlaceholder2 | ReportSlotPlaceholder3;
 
 /**
- * True marks the slot required: the report is not complete until it is filled.
+ * True marks the slot required: the document is not complete until it is filled.
  */
 declare type ReportSlotPlaceholder1 = boolean;
 
@@ -12937,7 +12942,7 @@ declare interface ReportSlotPlaceholder3 {
      */
     hint?: string;
     /**
-     * When true, a report is not considered complete until this slot is filled.
+     * When true, a document is not considered complete until this slot is filled.
      */
     required?: boolean;
 }
@@ -12946,21 +12951,21 @@ declare interface ReportTemplate {
     id: Id52;
     type: "report_template";
     /**
-     * A human readable title for the report template.
+     * A human readable title for the document template.
      */
     title: string;
     /**
-     * An optional description of the report template.
+     * An optional description of the document template.
      */
     description?: string;
     tags?: Tags38;
     /**
-     * Ordered pages of the template. A report created from the template deep-copies them and keeps no reference back, so the report stays frozen while the template evolves.
+     * Ordered pages of the template. A document created from the template deep-copies them and keeps no reference back, so the document stays frozen while the template evolves.
      */
     pages: ReportPageBody[];
     filters?: DashboardFilters5;
     /**
-     * Custom variables the template's text can interpolate as \{name\}. A report created from it gives them values.
+     * Custom variables the template's text can interpolate as \{name\}. A document created from it gives them values.
      */
     variables?: ReportVariable[];
     /**
@@ -12984,7 +12989,7 @@ declare type ReportText1 = string;
  */
 declare interface ReportText2 {
     /**
-     * Markdown with \{variable\} placeholders. Alongside a prompt this is the materialized generation, stored so the report renders without re-invoking AI.
+     * Markdown with \{variable\} placeholders. Alongside a prompt this is the materialized generation, stored so the document renders without re-invoking AI.
      */
     text?: string;
     /**
@@ -13041,7 +13046,7 @@ declare interface ReportVariable {
     title?: string;
     description?: string;
     /**
-     * Value used when the report gives the variable none.
+     * Value used when the document gives the variable none.
      */
     default?: string;
 }
@@ -13069,12 +13074,12 @@ declare interface ReportVisualizationSlot {
     };
     date?: Id50;
     /**
-     * When true, the implicit date filter derived from the report's period is not applied here.
+     * When true, the implicit date filter derived from the document's period is not applied here.
      */
     ignore_report_period?: boolean;
     filters?: DashboardFilters2;
     /**
-     * A list of report and page filters ignored here.
+     * A list of document and page filters ignored here.
      */
     ignored_filters?: string[];
     placeholder?: ReportSlotPlaceholder;
@@ -13530,17 +13535,17 @@ declare type Tags35 = string[];
 declare type Tags36 = string[];
 
 /**
- * A list of strings - metadata tags of this report.
+ * A list of strings - metadata tags of this document.
  */
 declare type Tags37 = string[];
 
 /**
- * A list of strings - metadata tags of this report template.
+ * A list of strings - metadata tags of this document template.
  */
 declare type Tags38 = string[];
 
 /**
- * A list of strings - metadata tags of this report page layout.
+ * A list of strings - metadata tags of this document page layout.
  */
 declare type Tags39 = string[];
 
@@ -14398,6 +14403,10 @@ declare interface VisualisationConfig {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -14684,6 +14693,10 @@ declare interface VisualisationConfig1 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -14970,6 +14983,10 @@ declare interface VisualisationConfig10 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -15256,6 +15273,10 @@ declare interface VisualisationConfig11 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -15542,6 +15563,10 @@ declare interface VisualisationConfig12 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -15828,6 +15853,10 @@ declare interface VisualisationConfig13 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -16114,6 +16143,10 @@ declare interface VisualisationConfig14 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -16400,6 +16433,10 @@ declare interface VisualisationConfig15 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -16686,6 +16723,10 @@ declare interface VisualisationConfig16 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -16972,6 +17013,10 @@ declare interface VisualisationConfig17 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -17258,6 +17303,10 @@ declare interface VisualisationConfig18 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -17544,6 +17593,10 @@ declare interface VisualisationConfig19 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -17830,6 +17883,10 @@ declare interface VisualisationConfig2 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -18116,6 +18173,10 @@ declare interface VisualisationConfig20 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -18402,6 +18463,10 @@ declare interface VisualisationConfig21 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -18688,6 +18753,10 @@ declare interface VisualisationConfig22 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -18974,6 +19043,10 @@ declare interface VisualisationConfig23 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -19260,6 +19333,10 @@ declare interface VisualisationConfig3 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -19546,6 +19623,10 @@ declare interface VisualisationConfig4 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -19832,6 +19913,10 @@ declare interface VisualisationConfig5 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -20118,6 +20203,10 @@ declare interface VisualisationConfig6 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -20404,6 +20493,10 @@ declare interface VisualisationConfig7 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -20690,6 +20783,10 @@ declare interface VisualisationConfig8 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;
@@ -20976,6 +21073,10 @@ declare interface VisualisationConfig9 {
         [k: string]: unknown;
     };
     data_points?: boolean | "auto";
+    /**
+     * Line shape with regards to data points (i.e. line interpolation).
+     */
+    line_shape?: "linear" | "spline" | "stepped";
     data_totals?: boolean | "auto";
     orientation?: string;
     legend_enabled?: boolean;