@gooddata/sdk-code-schemas 11.68.0-alpha.5 → 11.68.0-alpha.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -77,7 +77,7 @@ declare interface AreaChart {
77
77
  * Type of visualisation.
78
78
  */
79
79
  type: "area_chart";
80
- id: Id25;
80
+ id: Id27;
81
81
  /**
82
82
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
83
83
  */
@@ -279,7 +279,7 @@ declare interface AttributeFilter1 {
279
279
  }
280
280
 
281
281
  declare interface AttributeHierarchy {
282
- id: Id19;
282
+ id: Id21;
283
283
  type: "attribute_hierarchy";
284
284
  /**
285
285
  * An optional human readable title for the attribute hierarchy. Will be derived from id if not provided explicitly.
@@ -430,7 +430,7 @@ declare interface BarChart {
430
430
  * Type of visualisation.
431
431
  */
432
432
  type: "bar_chart";
433
- id: Id22;
433
+ id: Id24;
434
434
  /**
435
435
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
436
436
  */
@@ -498,7 +498,7 @@ declare interface BubbleChart {
498
498
  * Type of visualisation.
499
499
  */
500
500
  type: "bubble_chart";
501
- id: Id27;
501
+ id: Id29;
502
502
  /**
503
503
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
504
504
  */
@@ -564,7 +564,7 @@ declare interface BulletChart {
564
564
  * Type of visualisation.
565
565
  */
566
566
  type: "bullet_chart";
567
- id: Id34;
567
+ id: Id36;
568
568
  /**
569
569
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
570
570
  */
@@ -673,7 +673,7 @@ declare interface ColumnChart {
673
673
  * Type of visualisation.
674
674
  */
675
675
  type: "column_chart";
676
- id: Id23;
676
+ id: Id25;
677
677
  /**
678
678
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
679
679
  */
@@ -717,7 +717,7 @@ declare interface ComboChart {
717
717
  * Type of visualisation.
718
718
  */
719
719
  type: "combo_chart";
720
- id: Id39;
720
+ id: Id41;
721
721
  /**
722
722
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
723
723
  */
@@ -989,7 +989,7 @@ declare interface Dashboard {
989
989
  id: Id9;
990
990
  type: "dashboard";
991
991
  /**
992
- * Dashboard model version. "2" (default if omitted) — legacy shape: root-level sections/filters are also mirrored into a default tab, producing a declarative model with duplicated content for backward compatibility with older SDK readers. "3" — clean shape: tabs are the sole source of layout and filters; root sections/filters in YAML are still allowed as an authoring shortcut but are wrapped into a single synthetic tab without duplication. Use "3" for new dashboards; "2" exists to keep existing files round-trippable.
992
+ * Dashboard model version. "2" (default if omitted) — legacy shape: root-level sections/filters/parameters are also mirrored into a default tab, producing a declarative model with duplicated content for backward compatibility with older SDK readers. "3" — clean shape: tabs are the sole source of layout, filters and parameters; root sections/filters/parameters in YAML are still allowed as an authoring shortcut but are wrapped into a single synthetic tab without duplication. Use "3" for new dashboards; "2" exists to keep existing files round-trippable.
993
993
  */
994
994
  version?: "2" | "3";
995
995
  /**
@@ -1043,8 +1043,9 @@ declare interface Dashboard {
1043
1043
  [k: string]: unknown;
1044
1044
  } | unknown[] | string | number | boolean | null;
1045
1045
  } | Id16)[];
1046
+ parameters?: DashboardParameters;
1046
1047
  /**
1047
- * A list of tabs in this dashboard. Each tab has its own layout, filters, and filter configurations. Mutually exclusive with sections and filters at dashboard level.
1048
+ * A list of tabs in this dashboard. Each tab has its own layout, filters, parameters, and filter configurations. Mutually exclusive with sections, filters and parameters at dashboard level.
1048
1049
  */
1049
1050
  tabs?: Tab[];
1050
1051
  /**
@@ -1494,6 +1495,31 @@ declare interface DashboardMetricValueFilter {
1494
1495
  [k: string]: unknown;
1495
1496
  }
1496
1497
 
1498
+ /**
1499
+ * A parameter shown in the filter bar: its value must have the parameter's type.
1500
+ */
1501
+ declare type DashboardParameter = DashboardParameter1 | DashboardParameter2;
1502
+
1503
+ /**
1504
+ * A parameter shown in the filter bar: its value must have the parameter's type.
1505
+ */
1506
+ declare type DashboardParameter1 = StringDashboardParameter;
1507
+
1508
+ /**
1509
+ * A parameter shown in the filter bar: its value must have the parameter's type.
1510
+ */
1511
+ declare type DashboardParameter2 = NumberDashboardParameter;
1512
+
1513
+ /**
1514
+ * Parameters shown in the filter bar of this dashboard.
1515
+ */
1516
+ declare type DashboardParameters = DashboardParameter[];
1517
+
1518
+ /**
1519
+ * Parameters shown in the filter bar of this tab.
1520
+ */
1521
+ declare type DashboardParameters1 = DashboardParameter[];
1522
+
1497
1523
  /**
1498
1524
  * A dashboard relative date filter
1499
1525
  */
@@ -1683,7 +1709,7 @@ declare interface DependencyWheelChart {
1683
1709
  * Type of visualisation.
1684
1710
  */
1685
1711
  type: "dependency_wheel_chart";
1686
- id: Id36;
1712
+ id: Id38;
1687
1713
  /**
1688
1714
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
1689
1715
  */
@@ -1918,7 +1944,7 @@ declare interface FunnelChart {
1918
1944
  * Type of visualisation.
1919
1945
  */
1920
1946
  type: "funnel_chart";
1921
- id: Id32;
1947
+ id: Id34;
1922
1948
  /**
1923
1949
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
1924
1950
  */
@@ -1960,7 +1986,7 @@ declare interface GeoAreaChart {
1960
1986
  * Type of visualisation.
1961
1987
  */
1962
1988
  type: "geo_area_chart";
1963
- id: Id42;
1989
+ id: Id44;
1964
1990
  /**
1965
1991
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
1966
1992
  */
@@ -2020,7 +2046,7 @@ declare interface GeoChart {
2020
2046
  * Type of visualisation.
2021
2047
  */
2022
2048
  type: "geo_chart";
2023
- id: Id40;
2049
+ id: Id42;
2024
2050
  /**
2025
2051
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
2026
2052
  */
@@ -2064,7 +2090,7 @@ declare interface HeadlineChart {
2064
2090
  * Type of visualisation.
2065
2091
  */
2066
2092
  type: "headline_chart";
2067
- id: Id38;
2093
+ id: Id40;
2068
2094
  /**
2069
2095
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
2070
2096
  */
@@ -2104,7 +2130,7 @@ declare interface HeatmapChart {
2104
2130
  * Type of visualisation.
2105
2131
  */
2106
2132
  type: "heatmap_chart";
2107
- id: Id33;
2133
+ id: Id35;
2108
2134
  /**
2109
2135
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
2110
2136
  */
@@ -2190,17 +2216,17 @@ declare type Id15 = string;
2190
2216
  declare type Id16 = string;
2191
2217
 
2192
2218
  /**
2193
- * A unique identifier of the tab.
2219
+ * An identifier of the parameter.
2194
2220
  */
2195
2221
  declare type Id17 = string;
2196
2222
 
2197
2223
  /**
2198
- * A unique identifier of the plugin.
2224
+ * An identifier of the parameter.
2199
2225
  */
2200
2226
  declare type Id18 = string;
2201
2227
 
2202
2228
  /**
2203
- * A unique identifier of the attribute hierarchy.
2229
+ * A unique identifier of the tab.
2204
2230
  */
2205
2231
  declare type Id19 = string;
2206
2232
 
@@ -2210,17 +2236,17 @@ declare type Id19 = string;
2210
2236
  declare type Id2 = string;
2211
2237
 
2212
2238
  /**
2213
- * A unique identifier of the parameter.
2239
+ * A unique identifier of the plugin.
2214
2240
  */
2215
2241
  declare type Id20 = string;
2216
2242
 
2217
2243
  /**
2218
- * A unique identifier of the visualisation.
2244
+ * A unique identifier of the attribute hierarchy.
2219
2245
  */
2220
2246
  declare type Id21 = string;
2221
2247
 
2222
2248
  /**
2223
- * A unique identifier of the visualisation.
2249
+ * A unique identifier of the parameter.
2224
2250
  */
2225
2251
  declare type Id22 = string;
2226
2252
 
@@ -2322,7 +2348,7 @@ declare type Id4 = string;
2322
2348
  declare type Id40 = string;
2323
2349
 
2324
2350
  /**
2325
- * A unique identifier of the visualization data layer.
2351
+ * A unique identifier of the visualisation.
2326
2352
  */
2327
2353
  declare type Id41 = string;
2328
2354
 
@@ -2332,7 +2358,7 @@ declare type Id41 = string;
2332
2358
  declare type Id42 = string;
2333
2359
 
2334
2360
  /**
2335
- * A unique identifier of the visualisation.
2361
+ * A unique identifier of the visualization data layer.
2336
2362
  */
2337
2363
  declare type Id43 = string;
2338
2364
 
@@ -2342,34 +2368,34 @@ declare type Id43 = string;
2342
2368
  declare type Id44 = string;
2343
2369
 
2344
2370
  /**
2345
- * A unique identifier of the document.
2371
+ * A unique identifier of the visualisation.
2346
2372
  */
2347
2373
  declare type Id45 = string;
2348
2374
 
2349
2375
  /**
2350
- * An id for this page, unique within the document.
2376
+ * A unique identifier of the visualisation.
2351
2377
  */
2352
2378
  declare type Id46 = string;
2353
2379
 
2354
2380
  /**
2355
- * An id of an image already written down elsewhere on this page, drawn here as well.
2381
+ * A unique identifier of the document.
2356
2382
  */
2357
2383
  declare type Id47 = string;
2358
2384
 
2359
2385
  /**
2360
- * 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.
2386
+ * An id for this page, unique within the document.
2361
2387
  */
2362
2388
  declare type Id48 = string;
2363
2389
 
2364
2390
  /**
2365
- * Backend-managed asset rendered as the image. Mutually exclusive with url.
2391
+ * An id of an image already written down elsewhere on this page, drawn here as well.
2366
2392
  */
2367
2393
  declare type Id49 = string;
2368
2394
 
2369
2395
  declare type Id5 = string;
2370
2396
 
2371
2397
  /**
2372
- * 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.
2398
+ * 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.
2373
2399
  */
2374
2400
  declare type Id50 = string;
2375
2401
 
@@ -2379,25 +2405,35 @@ declare type Id50 = string;
2379
2405
  declare type Id51 = string;
2380
2406
 
2381
2407
  /**
2382
- * A unique identifier of the document template.
2408
+ * 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.
2383
2409
  */
2384
2410
  declare type Id52 = string;
2385
2411
 
2386
2412
  /**
2387
- * A unique identifier of the document page layout.
2413
+ * Backend-managed asset rendered as the image. Mutually exclusive with url.
2388
2414
  */
2389
2415
  declare type Id53 = string;
2390
2416
 
2391
2417
  /**
2392
- * An id of the visualization rendered here.
2418
+ * A unique identifier of the document template.
2393
2419
  */
2394
2420
  declare type Id54 = string;
2395
2421
 
2396
2422
  /**
2397
- * An id of the date dataset the document period applies to.
2423
+ * A unique identifier of the document page layout.
2398
2424
  */
2399
2425
  declare type Id55 = string;
2400
2426
 
2427
+ /**
2428
+ * An id of the visualization rendered here.
2429
+ */
2430
+ declare type Id56 = string;
2431
+
2432
+ /**
2433
+ * An id of the date dataset the document period applies to.
2434
+ */
2435
+ declare type Id57 = string;
2436
+
2401
2437
  /**
2402
2438
  * A unique identifier of the date instance.
2403
2439
  */
@@ -2792,7 +2828,7 @@ declare interface LineChart {
2792
2828
  * Type of visualisation.
2793
2829
  */
2794
2830
  type: "line_chart";
2795
- id: Id24;
2831
+ id: Id26;
2796
2832
  /**
2797
2833
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
2798
2834
  */
@@ -3706,6 +3742,10 @@ export declare const metadata_v1: {
3706
3742
  })[];
3707
3743
  };
3708
3744
  };
3745
+ parameters: {
3746
+ $ref: string;
3747
+ description: string;
3748
+ };
3709
3749
  tabs: {
3710
3750
  type: string;
3711
3751
  description: string;
@@ -10405,6 +10445,10 @@ export declare const metadata_v1: {
10405
10445
  })[];
10406
10446
  };
10407
10447
  };
10448
+ parameters: {
10449
+ $ref: string;
10450
+ description: string;
10451
+ };
10408
10452
  tabs: {
10409
10453
  type: string;
10410
10454
  description: string;
@@ -10474,6 +10518,50 @@ export declare const metadata_v1: {
10474
10518
  };
10475
10519
  required: string[];
10476
10520
  };
10521
+ dashboardParameters: {
10522
+ type: string;
10523
+ items: {
10524
+ title: string;
10525
+ description: string;
10526
+ allOf: {
10527
+ if: {
10528
+ properties: {
10529
+ type: {
10530
+ const: string;
10531
+ };
10532
+ };
10533
+ required: string[];
10534
+ };
10535
+ then: {
10536
+ $ref: string;
10537
+ };
10538
+ }[];
10539
+ properties: {
10540
+ id: {
10541
+ description: string;
10542
+ $semantic: {
10543
+ type: string;
10544
+ source: string;
10545
+ };
10546
+ };
10547
+ type: {
10548
+ type: string;
10549
+ enum: string[];
10550
+ description: string;
10551
+ };
10552
+ value: {
10553
+ description: string;
10554
+ };
10555
+ title: {
10556
+ description: string;
10557
+ };
10558
+ mode: {
10559
+ description: string;
10560
+ };
10561
+ };
10562
+ required: string[];
10563
+ };
10564
+ };
10477
10565
  tab: {
10478
10566
  type: string;
10479
10567
  additionalProperties: boolean;
@@ -10497,6 +10585,10 @@ export declare const metadata_v1: {
10497
10585
  type: string;
10498
10586
  };
10499
10587
  };
10588
+ parameters: {
10589
+ $ref: string;
10590
+ description: string;
10591
+ };
10500
10592
  sections: {
10501
10593
  type: string;
10502
10594
  description: string;
@@ -10507,6 +10599,64 @@ export declare const metadata_v1: {
10507
10599
  };
10508
10600
  required: string[];
10509
10601
  };
10602
+ stringDashboardParameter: {
10603
+ type: string;
10604
+ additionalProperties: boolean;
10605
+ properties: {
10606
+ id: {
10607
+ $ref: string;
10608
+ description: string;
10609
+ };
10610
+ type: {
10611
+ type: string;
10612
+ enum: string[];
10613
+ description: string;
10614
+ };
10615
+ value: {
10616
+ type: string;
10617
+ description: string;
10618
+ };
10619
+ title: {
10620
+ $ref: string;
10621
+ description: string;
10622
+ };
10623
+ mode: {
10624
+ type: string;
10625
+ enum: string[];
10626
+ description: string;
10627
+ };
10628
+ };
10629
+ required: string[];
10630
+ };
10631
+ numberDashboardParameter: {
10632
+ type: string;
10633
+ additionalProperties: boolean;
10634
+ properties: {
10635
+ id: {
10636
+ $ref: string;
10637
+ description: string;
10638
+ };
10639
+ type: {
10640
+ type: string;
10641
+ enum: string[];
10642
+ description: string;
10643
+ };
10644
+ value: {
10645
+ type: string;
10646
+ description: string;
10647
+ };
10648
+ title: {
10649
+ $ref: string;
10650
+ description: string;
10651
+ };
10652
+ mode: {
10653
+ type: string;
10654
+ enum: string[];
10655
+ description: string;
10656
+ };
10657
+ };
10658
+ required: string[];
10659
+ };
10510
10660
  timezoneId: {
10511
10661
  description: string;
10512
10662
  oneOf: ({
@@ -14330,6 +14480,26 @@ declare interface NormalDataset {
14330
14480
  dataset_type?: "standard" | "auxiliary";
14331
14481
  }
14332
14482
 
14483
+ declare interface NumberDashboardParameter {
14484
+ id: Id18;
14485
+ /**
14486
+ * The data type of the parameter. Must match the type in the parameter definition.
14487
+ */
14488
+ type: "NUMBER";
14489
+ /**
14490
+ * The value this dashboard uses instead of the parameter's default value.
14491
+ */
14492
+ value?: number;
14493
+ /**
14494
+ * The label shown in the filter bar instead of the parameter's title.
14495
+ */
14496
+ title?: string;
14497
+ /**
14498
+ * Setting parameter mode to readonly will disable the parameter. Setting it to hidden will hide the parameter from the dashboard. Setting it to active will enable the parameter.
14499
+ */
14500
+ mode?: "readonly" | "hidden" | "active";
14501
+ }
14502
+
14333
14503
  /**
14334
14504
  * Optional bounds the parameter value must satisfy.
14335
14505
  */
@@ -14357,7 +14527,7 @@ declare interface NumberParameterDefinition {
14357
14527
  }
14358
14528
 
14359
14529
  declare interface Parameter {
14360
- id: Id20;
14530
+ id: Id22;
14361
14531
  type: "parameter";
14362
14532
  /**
14363
14533
  * An optional human readable title for the parameter. Will be derived from id if not provided explicitly.
@@ -14412,7 +14582,7 @@ declare interface PieChart {
14412
14582
  * Type of visualisation.
14413
14583
  */
14414
14584
  type: "pie_chart";
14415
- id: Id28;
14585
+ id: Id30;
14416
14586
  /**
14417
14587
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
14418
14588
  */
@@ -14452,7 +14622,7 @@ declare interface PieChart1 {
14452
14622
  * Type of visualisation.
14453
14623
  */
14454
14624
  type: "donut_chart";
14455
- id: Id29;
14625
+ id: Id31;
14456
14626
  /**
14457
14627
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
14458
14628
  */
@@ -14488,7 +14658,7 @@ declare interface PieChart1 {
14488
14658
  }
14489
14659
 
14490
14660
  declare interface Plugin_2 {
14491
- id: Id18;
14661
+ id: Id20;
14492
14662
  type: "plugin";
14493
14663
  /**
14494
14664
  * An optional human readable title for the plugin. Will be derived from id if not provided explicitly.
@@ -15485,10 +15655,10 @@ declare interface PublisherVisualizationWidgetV2 {
15485
15655
  proportion?: PublisherPageProportionV2;
15486
15656
  placeholder?: PublisherWidgetPlaceholderV2;
15487
15657
  locked?: boolean;
15488
- visualization?: Id54;
15658
+ visualization?: Id56;
15489
15659
  title?: PublisherWidgetTitleV2;
15490
15660
  alt_text?: string;
15491
- date?: Id55;
15661
+ date?: Id57;
15492
15662
  /**
15493
15663
  * When true, the document period does not apply here.
15494
15664
  */
@@ -15526,7 +15696,7 @@ declare interface PyramidChart {
15526
15696
  * Type of visualisation.
15527
15697
  */
15528
15698
  type: "pyramid_chart";
15529
- id: Id31;
15699
+ id: Id33;
15530
15700
  /**
15531
15701
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
15532
15702
  */
@@ -15794,7 +15964,7 @@ declare interface RadarChart {
15794
15964
  * Type of visualisation.
15795
15965
  */
15796
15966
  type: "radar_chart";
15797
- id: Id44;
15967
+ id: Id46;
15798
15968
  /**
15799
15969
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
15800
15970
  */
@@ -15895,7 +16065,7 @@ declare interface RepeaterChart {
15895
16065
  * Type of visualisation.
15896
16066
  */
15897
16067
  type: "repeater_chart";
15898
- id: Id43;
16068
+ id: Id45;
15899
16069
  /**
15900
16070
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
15901
16071
  */
@@ -15939,7 +16109,7 @@ declare interface RepeaterChart {
15939
16109
  }
15940
16110
 
15941
16111
  declare interface Report_2 {
15942
- id: Id45;
16112
+ id: Id47;
15943
16113
  type: "report";
15944
16114
  /**
15945
16115
  * A human readable title for the document.
@@ -16003,19 +16173,19 @@ declare type ReportBackgroundImage = ReportBackgroundImage1 | ReportBackgroundIm
16003
16173
  * The image a box paints behind its content. It is drawn from a slot of its own, which is what keeps a backdrop fillable and gives it placeholder metadata, so it is written down with an id - or it names an image another box on the page already wrote down.
16004
16174
  */
16005
16175
  declare interface ReportBackgroundImage1 {
16006
- ref: Id47;
16176
+ ref: Id49;
16007
16177
  }
16008
16178
 
16009
16179
  /**
16010
16180
  * The image a box paints behind its content. It is drawn from a slot of its own, which is what keeps a backdrop fillable and gives it placeholder metadata, so it is written down with an id - or it names an image another box on the page already wrote down.
16011
16181
  */
16012
16182
  declare interface ReportBackgroundImage2 {
16013
- id: Id48;
16183
+ id: Id50;
16014
16184
  /**
16015
16185
  * Image URL, supporting \{variables\} - a logo uses \{logo\}. Mutually exclusive with asset.
16016
16186
  */
16017
16187
  url?: string;
16018
- asset?: Id49;
16188
+ asset?: Id51;
16019
16189
  alt_text?: string;
16020
16190
  /**
16021
16191
  * How the image fills its area: kept whole inside it, filling it and cropped to do so, or stretched to its shape. Defaults to contain.
@@ -16088,7 +16258,7 @@ declare interface ReportBoxStyle3 {
16088
16258
  declare type ReportContentAlignment = "start" | "center" | "end";
16089
16259
 
16090
16260
  declare interface ReportHeadingSlot {
16091
- id: Id48;
16261
+ id: Id50;
16092
16262
  weight?: ReportLayoutWeight;
16093
16263
  heading: ReportText;
16094
16264
  style?: ReportTextStyle;
@@ -16113,7 +16283,7 @@ declare interface ReportImage2 {
16113
16283
  * Image URL, supporting \{variables\} - a logo uses \{logo\}. Mutually exclusive with asset.
16114
16284
  */
16115
16285
  url?: string;
16116
- asset?: Id51;
16286
+ asset?: Id53;
16117
16287
  alt_text?: string;
16118
16288
  /**
16119
16289
  * How the image fills its area: kept whole inside it, filling it and cropped to do so, or stretched to its shape. Defaults to contain.
@@ -16124,7 +16294,7 @@ declare interface ReportImage2 {
16124
16294
  }
16125
16295
 
16126
16296
  declare interface ReportImageSlot {
16127
- id: Id48;
16297
+ id: Id50;
16128
16298
  weight?: ReportLayoutWeight;
16129
16299
  image: ReportImage;
16130
16300
  placeholder?: ReportSlotPlaceholder;
@@ -16207,7 +16377,7 @@ declare interface ReportLayoutRow {
16207
16377
  declare type ReportLayoutWeight = number;
16208
16378
 
16209
16379
  declare interface ReportPageBody {
16210
- id: Id46;
16380
+ id: Id48;
16211
16381
  kind?: ReportPageKind;
16212
16382
  format?: ReportPageFormat;
16213
16383
  style?: ReportBoxStyle;
@@ -16229,7 +16399,7 @@ declare type ReportPageKind = "cover" | "section" | "content";
16229
16399
  * 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.
16230
16400
  */
16231
16401
  declare interface ReportPageLayout {
16232
- id: Id53;
16402
+ id: Id55;
16233
16403
  type: "report_page_layout";
16234
16404
  /**
16235
16405
  * A human readable title for the document page layout.
@@ -16248,7 +16418,7 @@ declare interface ReportPageLayout {
16248
16418
  }
16249
16419
 
16250
16420
  declare interface ReportParagraphSlot {
16251
- id: Id48;
16421
+ id: Id50;
16252
16422
  weight?: ReportLayoutWeight;
16253
16423
  paragraph: ReportText3;
16254
16424
  style?: ReportTextStyle;
@@ -16299,7 +16469,7 @@ declare interface ReportSlotPlaceholder3 {
16299
16469
  }
16300
16470
 
16301
16471
  declare interface ReportTemplate {
16302
- id: Id52;
16472
+ id: Id54;
16303
16473
  type: "report_template";
16304
16474
  /**
16305
16475
  * A human readable title for the document template.
@@ -16403,7 +16573,7 @@ declare interface ReportVariable {
16403
16573
  }
16404
16574
 
16405
16575
  declare interface ReportVisualizationSlot {
16406
- id: Id48;
16576
+ id: Id50;
16407
16577
  weight?: ReportLayoutWeight;
16408
16578
  /**
16409
16579
  * An id of the visualization to be rendered in this area. Null leaves the area declared but empty, which renders a placeholder.
@@ -16423,7 +16593,7 @@ declare interface ReportVisualizationSlot {
16423
16593
  properties?: {
16424
16594
  [k: string]: unknown;
16425
16595
  };
16426
- date?: Id50;
16596
+ date?: Id52;
16427
16597
  /**
16428
16598
  * When true, the implicit date filter derived from the document's period is not applied here.
16429
16599
  */
@@ -16457,7 +16627,7 @@ declare interface SankeyChart {
16457
16627
  * Type of visualisation.
16458
16628
  */
16459
16629
  type: "sankey_chart";
16460
- id: Id37;
16630
+ id: Id39;
16461
16631
  /**
16462
16632
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
16463
16633
  */
@@ -16499,7 +16669,7 @@ declare interface ScatterChart {
16499
16669
  * Type of visualisation.
16500
16670
  */
16501
16671
  type: "scatter_chart";
16502
- id: Id26;
16672
+ id: Id28;
16503
16673
  /**
16504
16674
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
16505
16675
  */
@@ -16643,6 +16813,26 @@ declare interface State {
16643
16813
  exclude?: (string | number | boolean)[];
16644
16814
  }
16645
16815
 
16816
+ declare interface StringDashboardParameter {
16817
+ id: Id17;
16818
+ /**
16819
+ * The data type of the parameter. Must match the type in the parameter definition.
16820
+ */
16821
+ type: "STRING";
16822
+ /**
16823
+ * The value this dashboard uses instead of the parameter's default value.
16824
+ */
16825
+ value?: string;
16826
+ /**
16827
+ * The label shown in the filter bar instead of the parameter's title.
16828
+ */
16829
+ title?: string;
16830
+ /**
16831
+ * Setting parameter mode to readonly will disable the parameter. Setting it to hidden will hide the parameter from the dashboard. Setting it to active will enable the parameter.
16832
+ */
16833
+ mode?: "readonly" | "hidden" | "active";
16834
+ }
16835
+
16646
16836
  /**
16647
16837
  * Optional restrictions the parameter value must satisfy. Length bounds and 'allowedValues' are mutually exclusive.
16648
16838
  */
@@ -16676,12 +16866,13 @@ declare interface StringParameterDefinition {
16676
16866
  declare type StructuredField = AttributeFieldGuard | MetricFieldGuard | CalculatedMetricFieldGuard | InlineMetricFieldGuard | ArithmeticMetricFieldGuard | PoPMetricFieldGuard | PreviousPeriodMetricFieldGuard;
16677
16867
 
16678
16868
  declare interface Tab {
16679
- id: Id17;
16869
+ id: Id19;
16680
16870
  /**
16681
16871
  * Display title for the tab.
16682
16872
  */
16683
16873
  title: string;
16684
16874
  filters?: DashboardFilters1;
16875
+ parameters?: DashboardParameters1;
16685
16876
  /**
16686
16877
  * A list of sections in this tab.
16687
16878
  */
@@ -16693,7 +16884,7 @@ declare interface Table {
16693
16884
  * Type of visualisation.
16694
16885
  */
16695
16886
  type: "table";
16696
- id: Id21;
16887
+ id: Id23;
16697
16888
  /**
16698
16889
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
16699
16890
  */
@@ -17023,7 +17214,7 @@ declare interface TreemapChart {
17023
17214
  * Type of visualisation.
17024
17215
  */
17025
17216
  type: "treemap_chart";
17026
- id: Id30;
17217
+ id: Id32;
17027
17218
  /**
17028
17219
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
17029
17220
  */
@@ -17160,19 +17351,26 @@ export declare namespace v1 {
17160
17351
  DisplayAsLabelIdentifier3,
17161
17352
  Id15,
17162
17353
  Id16,
17354
+ DashboardParameter,
17355
+ DashboardParameter1,
17163
17356
  Id17,
17357
+ DashboardParameter2,
17358
+ Id18,
17359
+ DashboardParameters,
17360
+ Id19,
17361
+ DashboardParameters1,
17164
17362
  Metadata18,
17165
17363
  Metadata20,
17166
- Id18,
17364
+ Id20,
17167
17365
  Tags11,
17168
17366
  Metadata21,
17169
17367
  Metadata23,
17170
- Id19,
17368
+ Id21,
17171
17369
  Tags12,
17172
17370
  AttributeIdentifier6,
17173
17371
  Metadata24,
17174
17372
  Metadata26,
17175
- Id20,
17373
+ Id22,
17176
17374
  Tags13,
17177
17375
  ParameterDefinition,
17178
17376
  ParameterDefinition1,
@@ -17181,7 +17379,7 @@ export declare namespace v1 {
17181
17379
  Metadata29,
17182
17380
  Visualisation,
17183
17381
  Visualisation1,
17184
- Id21,
17382
+ Id23,
17185
17383
  Tags14,
17186
17384
  Field,
17187
17385
  AttributeIdentifier7,
@@ -17274,94 +17472,94 @@ export declare namespace v1 {
17274
17472
  Bucket,
17275
17473
  SimpleBucket,
17276
17474
  Visualisation2,
17277
- Id22,
17475
+ Id24,
17278
17476
  Tags15,
17279
17477
  Visualisation3,
17280
- Id23,
17478
+ Id25,
17281
17479
  Tags16,
17282
17480
  Visualisation4,
17283
- Id24,
17481
+ Id26,
17284
17482
  Tags17,
17285
17483
  Visualisation5,
17286
- Id25,
17484
+ Id27,
17287
17485
  Tags18,
17288
17486
  Visualisation6,
17289
- Id26,
17487
+ Id28,
17290
17488
  Tags19,
17291
17489
  EmptyBucket,
17292
17490
  Visualisation7,
17293
- Id27,
17491
+ Id29,
17294
17492
  Tags20,
17295
17493
  Visualisation8,
17296
- Id28,
17494
+ Id30,
17297
17495
  Tags21,
17298
17496
  Visualisation9,
17299
- Id29,
17497
+ Id31,
17300
17498
  Tags22,
17301
17499
  Visualisation10,
17302
- Id30,
17500
+ Id32,
17303
17501
  Tags23,
17304
17502
  Visualisation11,
17305
- Id31,
17503
+ Id33,
17306
17504
  Tags24,
17307
17505
  Visualisation12,
17308
- Id32,
17506
+ Id34,
17309
17507
  Tags25,
17310
17508
  Visualisation13,
17311
- Id33,
17509
+ Id35,
17312
17510
  Tags26,
17313
17511
  Visualisation14,
17314
- Id34,
17512
+ Id36,
17315
17513
  Tags27,
17316
17514
  Visualisation15,
17317
- Id35,
17515
+ Id37,
17318
17516
  Tags28,
17319
17517
  Visualisation16,
17320
- Id36,
17518
+ Id38,
17321
17519
  Tags29,
17322
17520
  Bucket1,
17323
17521
  Bucket2,
17324
17522
  Visualisation17,
17325
- Id37,
17523
+ Id39,
17326
17524
  Tags30,
17327
17525
  Bucket3,
17328
17526
  Bucket4,
17329
17527
  Visualisation18,
17330
- Id38,
17528
+ Id40,
17331
17529
  Tags31,
17332
17530
  Visualisation19,
17333
- Id39,
17531
+ Id41,
17334
17532
  Tags32,
17335
17533
  Visualisation20,
17336
- Id40,
17534
+ Id42,
17337
17535
  Tags33,
17338
17536
  PushpinLocationBucket,
17339
17537
  LayerItem,
17340
- Id41,
17538
+ Id43,
17341
17539
  LocationBucket,
17342
17540
  GeoAreaBucket,
17343
17541
  Visualisation21,
17344
- Id42,
17542
+ Id44,
17345
17543
  Tags34,
17346
17544
  Visualisation22,
17347
- Id43,
17545
+ Id45,
17348
17546
  Tags35,
17349
17547
  Visualisation23,
17350
- Id44,
17548
+ Id46,
17351
17549
  Tags36,
17352
17550
  Metadata30,
17353
17551
  Metadata32,
17354
- Id45,
17552
+ Id47,
17355
17553
  Tags37,
17356
- Id46,
17554
+ Id48,
17357
17555
  ReportPageKind,
17358
17556
  ReportPageFormat,
17359
17557
  ReportBackground,
17360
17558
  ReportBackground1,
17361
17559
  ReportBackgroundImage,
17362
- Id47,
17363
- Id48,
17364
17560
  Id49,
17561
+ Id50,
17562
+ Id51,
17365
17563
  ReportContentAlignment,
17366
17564
  ReportSlotPlaceholder,
17367
17565
  ReportSlotPlaceholder1,
@@ -17372,7 +17570,7 @@ export declare namespace v1 {
17372
17570
  ReportLayoutNode2,
17373
17571
  ReportLayoutNode3,
17374
17572
  ReportLayoutNode4,
17375
- Id50,
17573
+ Id52,
17376
17574
  ReportLayoutNode5,
17377
17575
  ReportText,
17378
17576
  ReportText1,
@@ -17385,14 +17583,14 @@ export declare namespace v1 {
17385
17583
  ReportLayoutNode7,
17386
17584
  ReportImage,
17387
17585
  ReportImage1,
17388
- Id51,
17586
+ Id53,
17389
17587
  Metadata33,
17390
17588
  Metadata35,
17391
- Id52,
17589
+ Id54,
17392
17590
  Tags38,
17393
17591
  Metadata36,
17394
17592
  Metadata38,
17395
- Id53,
17593
+ Id55,
17396
17594
  Tags39,
17397
17595
  ReportLayoutNode8,
17398
17596
  Metadata39,
@@ -17441,8 +17639,8 @@ export declare namespace v1 {
17441
17639
  PublisherPageNodeIdV25,
17442
17640
  PublisherLayoutNodeV27,
17443
17641
  PublisherPageNodeIdV26,
17444
- Id54,
17445
- Id55,
17642
+ Id56,
17643
+ Id57,
17446
17644
  PublisherLayoutNodeV28,
17447
17645
  PublisherPageNodeIdV27,
17448
17646
  PublisherPageNodeIdV28,
@@ -17504,6 +17702,8 @@ export declare namespace v1 {
17504
17702
  DashboardTextFilter2,
17505
17703
  DashboardMetricValueFilter,
17506
17704
  DashboardFilterGroup,
17705
+ StringDashboardParameter,
17706
+ NumberDashboardParameter,
17507
17707
  Tab,
17508
17708
  DashboardFilters1,
17509
17709
  Permission,
@@ -25069,7 +25269,7 @@ declare interface VisualisationWidget1 {
25069
25269
  }
25070
25270
 
25071
25271
  declare interface VisualizationDataLayer {
25072
- id: Id41;
25272
+ id: Id43;
25073
25273
  /**
25074
25274
  * An optional human readable title for the layer. Will be derived from id if not provided explicitly.
25075
25275
  */
@@ -25114,7 +25314,7 @@ declare interface WaterfallChart {
25114
25314
  * Type of visualisation.
25115
25315
  */
25116
25316
  type: "waterfall_chart";
25117
- id: Id35;
25317
+ id: Id37;
25118
25318
  /**
25119
25319
  * An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.
25120
25320
  */