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

package/esm/v1/metadata.d.ts

@@ -1130,11 +1130,11 @@ export type Tags36 = string[];
 export type Metadata30 = Metadata31 & Metadata32;
 export type Metadata32 = Report;
 /**
- * A unique identifier of the report.
+ * A unique identifier of the document.
  */
 export type Id45 = string;
 /**
- * A list of strings - metadata tags of this report.
+ * A list of strings - metadata tags of this document.
  */
 export type Tags37 = string[];
 /**
@@ -1166,7 +1166,7 @@ export type ReportBackgroundImage = ReportBackgroundImage1 | ReportBackgroundIma
  */
 export 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.
  */
 export type Id48 = string;
 /**
@@ -1179,7 +1179,7 @@ export type ReportContentAlignment = "start" | "center" | "end";
  */
 export 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.
  */
 export type ReportSlotPlaceholder1 = boolean;
 /**
@@ -1211,7 +1211,7 @@ export type ReportLayoutNode3 = ReportLayoutRow;
  */
 export type ReportLayoutNode4 = ReportVisualizationSlot;
 /**
- * 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.
  */
 export type Id50 = string;
 /**
@@ -1272,11 +1272,11 @@ export type Id51 = string;
 export type Metadata33 = Metadata34 & Metadata35;
 export type Metadata35 = ReportTemplate;
 /**
- * A unique identifier of the report template.
+ * A unique identifier of the document template.
  */
 export type Id52 = string;
 /**
- * A list of strings - metadata tags of this report template.
+ * A list of strings - metadata tags of this document template.
  */
 export type Tags38 = string[];
 /**
@@ -1285,11 +1285,11 @@ export type Tags38 = string[];
 export type Metadata36 = Metadata37 & Metadata38;
 export type Metadata38 = ReportPageLayout;
 /**
- * A unique identifier of the report page layout.
+ * A unique identifier of the document page layout.
  */
 export type Id53 = string;
 /**
- * A list of strings - metadata tags of this report page layout.
+ * A list of strings - metadata tags of this document page layout.
  */
 export type Tags39 = string[];
 /**
@@ -3114,6 +3114,10 @@ export 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;
@@ -3529,6 +3533,10 @@ export 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;
@@ -3865,6 +3873,10 @@ export 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;
@@ -4201,6 +4213,10 @@ export 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;
@@ -4537,6 +4553,10 @@ export 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;
@@ -4873,6 +4893,10 @@ export 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;
@@ -5209,6 +5233,10 @@ export 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;
@@ -5541,6 +5569,10 @@ export 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;
@@ -5873,6 +5905,10 @@ export 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;
@@ -6205,6 +6241,10 @@ export 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;
@@ -6537,6 +6577,10 @@ export 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;
@@ -6869,6 +6913,10 @@ export 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;
@@ -7209,6 +7257,10 @@ export 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;
@@ -7541,6 +7593,10 @@ export 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;
@@ -7873,6 +7929,10 @@ export 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;
@@ -8207,6 +8267,10 @@ export 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;
@@ -8541,6 +8605,10 @@ export 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;
@@ -8873,6 +8941,10 @@ export 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;
@@ -9205,6 +9277,10 @@ export 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;
@@ -9541,6 +9617,10 @@ export 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;
@@ -9850,6 +9930,10 @@ export 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;
@@ -10186,6 +10270,10 @@ export 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;
@@ -10526,6 +10614,10 @@ export 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;
@@ -10858,6 +10950,10 @@ export 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;
@@ -11129,22 +11225,22 @@ export interface Report {
     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[];
     /**
@@ -11159,15 +11255,15 @@ export interface Report {
     };
 }
 /**
- * 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.
  */
 export 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;
 }
@@ -11239,7 +11335,7 @@ export 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;
 }
@@ -11296,18 +11392,18 @@ export 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;
 }
 /**
- * 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.
  */
 export interface DashboardFilters2 {
     /**
@@ -11340,7 +11436,7 @@ export interface ReportHeadingSlot {
  */
 export 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;
     /**
@@ -11412,7 +11508,7 @@ export interface ReportBoxStyle2 {
     padding?: number;
 }
 /**
- * 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.
  */
 export interface DashboardFilters3 {
     /**
@@ -11434,7 +11530,7 @@ export interface DashboardFilters3 {
     [k: string]: DashboardAbsoluteDateFilter | DashboardRelativeDateFilter | DashboardAttributeFilter | DashboardTextFilter | DashboardMetricValueFilter | DashboardFilterGroup;
 }
 /**
- * Report filters; pages and visualizations may extend or override them.
+ * Document filters; pages and visualizations may extend or override them.
  */
 export interface DashboardFilters4 {
     /**
@@ -11463,7 +11559,7 @@ export 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;
 }
@@ -11475,21 +11571,21 @@ export 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[];
     /**
@@ -11524,17 +11620,17 @@ export interface Metadata37 {
     [k: string]: unknown;
 }
 /**
- * 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.
  */
 export 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;
@@ -11559,7 +11655,7 @@ export interface ReportBoxStyle3 {
     padding?: number;
 }
 /**
- * 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.
  */
 export interface DashboardFilters6 {
     /**