@gooddata/api-client-tiger 11.22.0 → 11.23.0-alpha.1

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.
@@ -4882,6 +4882,10 @@ export declare interface AFM {
4882
4882
  * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
4883
4883
  */
4884
4884
  'auxMeasures'?: Array<MeasureItem>;
4885
+ /**
4886
+ * (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric\'s MAQL definition without modifying the stored definition.
4887
+ */
4888
+ 'measureDefinitionOverrides'?: Array<MetricDefinitionOverride>;
4885
4889
  }
4886
4890
 
4887
4891
  /**
@@ -5974,6 +5978,14 @@ export declare interface AfmMemoryItemUser {
5974
5978
  'lastname': string;
5975
5979
  }
5976
5980
 
5981
+ /**
5982
+ * (EXPERIMENTAL) Override for a catalog metric definition.
5983
+ */
5984
+ export declare interface AfmMetricDefinitionOverride {
5985
+ 'item': AfmModelObjectIdentifierCore;
5986
+ 'definition': AfmInlineMeasureDefinition;
5987
+ }
5988
+
5977
5989
  /**
5978
5990
  * Individual change analysis data item
5979
5991
  */
@@ -6044,6 +6056,10 @@ export declare interface AfmModel {
6044
6056
  * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
6045
6057
  */
6046
6058
  'auxMeasures'?: Array<AfmMeasureItem>;
6059
+ /**
6060
+ * (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric\'s MAQL definition without modifying the stored definition.
6061
+ */
6062
+ 'measureDefinitionOverrides'?: Array<AfmMetricDefinitionOverride>;
6047
6063
  }
6048
6064
 
6049
6065
  /**
@@ -10521,6 +10537,10 @@ export declare interface AutomationAFM {
10521
10537
  * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
10522
10538
  */
10523
10539
  'auxMeasures'?: Array<AutomationMeasureItem>;
10540
+ /**
10541
+ * (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric\'s MAQL definition without modifying the stored definition.
10542
+ */
10543
+ 'measureDefinitionOverrides'?: Array<AutomationMetricDefinitionOverride>;
10524
10544
  }
10525
10545
 
10526
10546
  /**
@@ -11136,9 +11156,12 @@ export declare interface AutomationDashboardDateFilterDateFilter {
11136
11156
  'dataSet'?: AutomationIdentifierRef;
11137
11157
  'attribute'?: AutomationIdentifierRef;
11138
11158
  'boundedFilter'?: AutomationRelativeBoundedDateFilter;
11159
+ 'emptyValueHandling'?: AutomationDashboardDateFilterDateFilterEmptyValueHandlingEnum;
11139
11160
  'localIdentifier'?: string;
11140
11161
  }
11141
11162
 
11163
+ declare type AutomationDashboardDateFilterDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
11164
+
11142
11165
  /**
11143
11166
  * @type AutomationDashboardDateFilterDateFilterFrom
11144
11167
  */
@@ -11517,6 +11540,14 @@ export declare interface AutomationMetadata {
11517
11540
  'visibleFilters'?: Array<VisibleFilter>;
11518
11541
  }
11519
11542
 
11543
+ /**
11544
+ * (EXPERIMENTAL) Override for a catalog metric definition.
11545
+ */
11546
+ declare interface AutomationMetricDefinitionOverride {
11547
+ 'item': AutomationAfmObjectIdentifierCore;
11548
+ 'definition': AutomationInlineMeasureDefinition;
11549
+ }
11550
+
11520
11551
  export declare interface AutomationMetricRecord {
11521
11552
  'value': number;
11522
11553
  'formattedValue'?: string;
@@ -15711,9 +15742,12 @@ export declare interface DashboardDateFilterDateFilter {
15711
15742
  'dataSet'?: IdentifierRef;
15712
15743
  'attribute'?: IdentifierRef;
15713
15744
  'boundedFilter'?: RelativeBoundedDateFilter;
15745
+ 'emptyValueHandling'?: DashboardDateFilterDateFilterEmptyValueHandlingEnum;
15714
15746
  'localIdentifier'?: string;
15715
15747
  }
15716
15748
 
15749
+ export declare type DashboardDateFilterDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
15750
+
15717
15751
  /**
15718
15752
  * @type DashboardDateFilterDateFilterFrom
15719
15753
  */
@@ -41004,6 +41038,10 @@ export declare interface ExportAFM {
41004
41038
  * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
41005
41039
  */
41006
41040
  'auxMeasures'?: Array<ExportMeasureItem>;
41041
+ /**
41042
+ * (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric\'s MAQL definition without modifying the stored definition.
41043
+ */
41044
+ 'measureDefinitionOverrides'?: Array<ExportMetricDefinitionOverride>;
41007
41045
  }
41008
41046
 
41009
41047
  /**
@@ -41424,9 +41462,12 @@ export declare interface ExportDashboardDateFilterDateFilter {
41424
41462
  'dataSet'?: ExportIdentifierRef;
41425
41463
  'attribute'?: ExportIdentifierRef;
41426
41464
  'boundedFilter'?: ExportRelativeBoundedDateFilter;
41465
+ 'emptyValueHandling'?: ExportDashboardDateFilterDateFilterEmptyValueHandlingEnum;
41427
41466
  'localIdentifier'?: string;
41428
41467
  }
41429
41468
 
41469
+ export declare type ExportDashboardDateFilterDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
41470
+
41430
41471
  /**
41431
41472
  * @type ExportDashboardDateFilterDateFilterFrom
41432
41473
  */
@@ -42276,6 +42317,14 @@ export declare type ExportMeasureValueCondition = ExportComparisonCondition | Ex
42276
42317
  */
42277
42318
  export declare type ExportMeasureValueFilter = ExportComparisonMeasureValueFilter | ExportCompoundMeasureValueFilter | ExportRangeMeasureValueFilter;
42278
42319
 
42320
+ /**
42321
+ * (EXPERIMENTAL) Override for a catalog metric definition.
42322
+ */
42323
+ export declare interface ExportMetricDefinitionOverride {
42324
+ 'item': ExportAfmObjectIdentifierCore;
42325
+ 'definition': ExportInlineMeasureDefinition;
42326
+ }
42327
+
42279
42328
  /**
42280
42329
  * Filter able to limit element values by label and related selected negated elements.
42281
42330
  */
@@ -48746,18 +48795,7 @@ export declare interface JsonApiAttributeHierarchyIn {
48746
48795
  * API identifier of an object
48747
48796
  */
48748
48797
  'id': string;
48749
- 'attributes'?: JsonApiAttributeHierarchyInAttributes;
48750
- }
48751
-
48752
- export declare interface JsonApiAttributeHierarchyInAttributes {
48753
- 'title'?: string;
48754
- 'description'?: string;
48755
- 'tags'?: Array<string>;
48756
- 'areRelationsValid'?: boolean;
48757
- /**
48758
- * Free-form JSON content. Maximum supported length is 15000 characters.
48759
- */
48760
- 'content'?: object;
48798
+ 'attributes'?: JsonApiAttributeHierarchyPatchAttributes;
48761
48799
  }
48762
48800
 
48763
48801
  export declare interface JsonApiAttributeHierarchyInDocument {
@@ -48876,7 +48914,18 @@ export declare interface JsonApiAttributeHierarchyPatch {
48876
48914
  * API identifier of an object
48877
48915
  */
48878
48916
  'id': string;
48879
- 'attributes'?: JsonApiAttributeHierarchyInAttributes;
48917
+ 'attributes'?: JsonApiAttributeHierarchyPatchAttributes;
48918
+ }
48919
+
48920
+ export declare interface JsonApiAttributeHierarchyPatchAttributes {
48921
+ 'title'?: string;
48922
+ 'description'?: string;
48923
+ 'tags'?: Array<string>;
48924
+ 'areRelationsValid'?: boolean;
48925
+ /**
48926
+ * Free-form JSON content. Maximum supported length is 15000 characters.
48927
+ */
48928
+ 'content'?: object;
48880
48929
  }
48881
48930
 
48882
48931
  export declare interface JsonApiAttributeHierarchyPatchDocument {
@@ -49042,57 +49091,14 @@ export declare interface JsonApiAutomationIn {
49042
49091
  * API identifier of an object
49043
49092
  */
49044
49093
  'id': string;
49045
- 'attributes'?: JsonApiAutomationInAttributes;
49046
- 'relationships'?: JsonApiAutomationInRelationships;
49094
+ 'attributes'?: JsonApiAutomationPatchAttributes;
49095
+ 'relationships'?: JsonApiAutomationPatchRelationships;
49047
49096
  }
49048
49097
 
49049
- export declare interface JsonApiAutomationInAttributes {
49050
- 'title'?: string;
49051
- 'description'?: string;
49052
- 'tags'?: Array<string>;
49053
- 'areRelationsValid'?: boolean;
49054
- /**
49055
- * Additional details to be included in the automated message.
49056
- */
49057
- 'details'?: object;
49058
- 'metadata'?: JsonApiAutomationOutAttributesMetadata | null;
49059
- /**
49060
- * Current state of the automation.
49061
- */
49062
- 'state'?: JsonApiAutomationInAttributesStateEnum;
49063
- /**
49064
- * Specify automation evaluation mode.
49065
- */
49066
- 'evaluationMode'?: JsonApiAutomationInAttributesEvaluationModeEnum;
49067
- 'schedule'?: JsonApiAutomationOutAttributesSchedule;
49068
- 'alert'?: JsonApiAutomationOutAttributesAlert;
49069
- 'tabularExports'?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
49070
- 'visualExports'?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
49071
- 'imageExports'?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
49072
- 'rawExports'?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
49073
- 'slidesExports'?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
49074
- 'dashboardTabularExports'?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
49075
- /**
49076
- * External recipients of the automation action results.
49077
- */
49078
- 'externalRecipients'?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
49079
- }
49080
-
49081
- export declare type JsonApiAutomationInAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
49082
-
49083
- export declare type JsonApiAutomationInAttributesStateEnum = 'ACTIVE' | 'PAUSED';
49084
-
49085
49098
  export declare interface JsonApiAutomationInDocument {
49086
49099
  'data': JsonApiAutomationIn;
49087
49100
  }
49088
49101
 
49089
- export declare interface JsonApiAutomationInRelationships {
49090
- 'notificationChannel'?: JsonApiAutomationOutRelationshipsNotificationChannel;
49091
- 'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
49092
- 'exportDefinitions'?: JsonApiAutomationOutRelationshipsExportDefinitions;
49093
- 'recipients'?: JsonApiAutomationOutRelationshipsRecipients;
49094
- }
49095
-
49096
49102
  export declare type JsonApiAutomationInTypeEnum = 'automation';
49097
49103
 
49098
49104
  /**
@@ -49335,14 +49341,57 @@ export declare interface JsonApiAutomationPatch {
49335
49341
  * API identifier of an object
49336
49342
  */
49337
49343
  'id': string;
49338
- 'attributes'?: JsonApiAutomationInAttributes;
49339
- 'relationships'?: JsonApiAutomationInRelationships;
49344
+ 'attributes'?: JsonApiAutomationPatchAttributes;
49345
+ 'relationships'?: JsonApiAutomationPatchRelationships;
49346
+ }
49347
+
49348
+ export declare interface JsonApiAutomationPatchAttributes {
49349
+ 'title'?: string;
49350
+ 'description'?: string;
49351
+ 'tags'?: Array<string>;
49352
+ 'areRelationsValid'?: boolean;
49353
+ /**
49354
+ * Additional details to be included in the automated message.
49355
+ */
49356
+ 'details'?: object;
49357
+ 'metadata'?: JsonApiAutomationOutAttributesMetadata | null;
49358
+ /**
49359
+ * Current state of the automation.
49360
+ */
49361
+ 'state'?: JsonApiAutomationPatchAttributesStateEnum;
49362
+ /**
49363
+ * Specify automation evaluation mode.
49364
+ */
49365
+ 'evaluationMode'?: JsonApiAutomationPatchAttributesEvaluationModeEnum;
49366
+ 'schedule'?: JsonApiAutomationOutAttributesSchedule;
49367
+ 'alert'?: JsonApiAutomationOutAttributesAlert;
49368
+ 'tabularExports'?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
49369
+ 'visualExports'?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
49370
+ 'imageExports'?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
49371
+ 'rawExports'?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
49372
+ 'slidesExports'?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
49373
+ 'dashboardTabularExports'?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
49374
+ /**
49375
+ * External recipients of the automation action results.
49376
+ */
49377
+ 'externalRecipients'?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
49340
49378
  }
49341
49379
 
49380
+ export declare type JsonApiAutomationPatchAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
49381
+
49382
+ export declare type JsonApiAutomationPatchAttributesStateEnum = 'ACTIVE' | 'PAUSED';
49383
+
49342
49384
  export declare interface JsonApiAutomationPatchDocument {
49343
49385
  'data': JsonApiAutomationPatch;
49344
49386
  }
49345
49387
 
49388
+ export declare interface JsonApiAutomationPatchRelationships {
49389
+ 'notificationChannel'?: JsonApiAutomationOutRelationshipsNotificationChannel;
49390
+ 'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
49391
+ 'exportDefinitions'?: JsonApiAutomationOutRelationshipsExportDefinitions;
49392
+ 'recipients'?: JsonApiAutomationOutRelationshipsRecipients;
49393
+ }
49394
+
49346
49395
  export declare type JsonApiAutomationPatchTypeEnum = 'automation';
49347
49396
 
49348
49397
  /**
@@ -49433,15 +49482,7 @@ export declare interface JsonApiColorPaletteIn {
49433
49482
  * API identifier of an object
49434
49483
  */
49435
49484
  'id': string;
49436
- 'attributes': JsonApiColorPaletteInAttributes;
49437
- }
49438
-
49439
- export declare interface JsonApiColorPaletteInAttributes {
49440
- 'name': string;
49441
- /**
49442
- * Free-form JSON content. Maximum supported length is 15000 characters.
49443
- */
49444
- 'content': object;
49485
+ 'attributes': JsonApiColorPaletteOutAttributes;
49445
49486
  }
49446
49487
 
49447
49488
  export declare interface JsonApiColorPaletteInDocument {
@@ -49462,7 +49503,15 @@ export declare interface JsonApiColorPaletteOut {
49462
49503
  * API identifier of an object
49463
49504
  */
49464
49505
  'id': string;
49465
- 'attributes': JsonApiColorPaletteInAttributes;
49506
+ 'attributes': JsonApiColorPaletteOutAttributes;
49507
+ }
49508
+
49509
+ export declare interface JsonApiColorPaletteOutAttributes {
49510
+ 'name': string;
49511
+ /**
49512
+ * Free-form JSON content. Maximum supported length is 15000 characters.
49513
+ */
49514
+ 'content': object;
49466
49515
  }
49467
49516
 
49468
49517
  export declare interface JsonApiColorPaletteOutDocument {
@@ -49490,7 +49539,7 @@ export declare interface JsonApiColorPaletteOutWithLinks {
49490
49539
  * API identifier of an object
49491
49540
  */
49492
49541
  'id': string;
49493
- 'attributes': JsonApiColorPaletteInAttributes;
49542
+ 'attributes': JsonApiColorPaletteOutAttributes;
49494
49543
  'links'?: ObjectLinks;
49495
49544
  }
49496
49545
 
@@ -49537,15 +49586,7 @@ export declare interface JsonApiCookieSecurityConfigurationIn {
49537
49586
  * API identifier of an object
49538
49587
  */
49539
49588
  'id': string;
49540
- 'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
49541
- }
49542
-
49543
- export declare interface JsonApiCookieSecurityConfigurationInAttributes {
49544
- 'lastRotation'?: string;
49545
- /**
49546
- * Length of interval between automatic rotations expressed in format of ISO 8601 duration
49547
- */
49548
- 'rotationInterval'?: string;
49589
+ 'attributes'?: JsonApiCookieSecurityConfigurationPatchAttributes;
49549
49590
  }
49550
49591
 
49551
49592
  export declare interface JsonApiCookieSecurityConfigurationInDocument {
@@ -49566,7 +49607,7 @@ export declare interface JsonApiCookieSecurityConfigurationOut {
49566
49607
  * API identifier of an object
49567
49608
  */
49568
49609
  'id': string;
49569
- 'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
49610
+ 'attributes'?: JsonApiCookieSecurityConfigurationPatchAttributes;
49570
49611
  }
49571
49612
 
49572
49613
  export declare interface JsonApiCookieSecurityConfigurationOutDocument {
@@ -49588,7 +49629,15 @@ export declare interface JsonApiCookieSecurityConfigurationPatch {
49588
49629
  * API identifier of an object
49589
49630
  */
49590
49631
  'id': string;
49591
- 'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
49632
+ 'attributes'?: JsonApiCookieSecurityConfigurationPatchAttributes;
49633
+ }
49634
+
49635
+ export declare interface JsonApiCookieSecurityConfigurationPatchAttributes {
49636
+ 'lastRotation'?: string;
49637
+ /**
49638
+ * Length of interval between automatic rotations expressed in format of ISO 8601 duration
49639
+ */
49640
+ 'rotationInterval'?: string;
49592
49641
  }
49593
49642
 
49594
49643
  export declare interface JsonApiCookieSecurityConfigurationPatchDocument {
@@ -49609,11 +49658,7 @@ export declare interface JsonApiCspDirectiveIn {
49609
49658
  * API identifier of an object
49610
49659
  */
49611
49660
  'id': string;
49612
- 'attributes': JsonApiCspDirectiveInAttributes;
49613
- }
49614
-
49615
- export declare interface JsonApiCspDirectiveInAttributes {
49616
- 'sources': Array<string>;
49661
+ 'attributes': JsonApiCspDirectiveOutAttributes;
49617
49662
  }
49618
49663
 
49619
49664
  export declare interface JsonApiCspDirectiveInDocument {
@@ -49634,7 +49679,11 @@ export declare interface JsonApiCspDirectiveOut {
49634
49679
  * API identifier of an object
49635
49680
  */
49636
49681
  'id': string;
49637
- 'attributes': JsonApiCspDirectiveInAttributes;
49682
+ 'attributes': JsonApiCspDirectiveOutAttributes;
49683
+ }
49684
+
49685
+ export declare interface JsonApiCspDirectiveOutAttributes {
49686
+ 'sources': Array<string>;
49638
49687
  }
49639
49688
 
49640
49689
  export declare interface JsonApiCspDirectiveOutDocument {
@@ -49662,7 +49711,7 @@ export declare interface JsonApiCspDirectiveOutWithLinks {
49662
49711
  * API identifier of an object
49663
49712
  */
49664
49713
  'id': string;
49665
- 'attributes': JsonApiCspDirectiveInAttributes;
49714
+ 'attributes': JsonApiCspDirectiveOutAttributes;
49666
49715
  'links'?: ObjectLinks;
49667
49716
  }
49668
49717
 
@@ -49832,12 +49881,7 @@ export declare interface JsonApiCustomGeoCollectionIn {
49832
49881
  * API identifier of an object
49833
49882
  */
49834
49883
  'id': string;
49835
- 'attributes'?: JsonApiCustomGeoCollectionInAttributes;
49836
- }
49837
-
49838
- export declare interface JsonApiCustomGeoCollectionInAttributes {
49839
- 'name'?: string | null;
49840
- 'description'?: string | null;
49884
+ 'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
49841
49885
  }
49842
49886
 
49843
49887
  export declare interface JsonApiCustomGeoCollectionInDocument {
@@ -49858,7 +49902,7 @@ export declare interface JsonApiCustomGeoCollectionOut {
49858
49902
  * API identifier of an object
49859
49903
  */
49860
49904
  'id': string;
49861
- 'attributes'?: JsonApiCustomGeoCollectionInAttributes;
49905
+ 'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
49862
49906
  }
49863
49907
 
49864
49908
  export declare interface JsonApiCustomGeoCollectionOutDocument {
@@ -49886,7 +49930,7 @@ export declare interface JsonApiCustomGeoCollectionOutWithLinks {
49886
49930
  * API identifier of an object
49887
49931
  */
49888
49932
  'id': string;
49889
- 'attributes'?: JsonApiCustomGeoCollectionInAttributes;
49933
+ 'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
49890
49934
  'links'?: ObjectLinks;
49891
49935
  }
49892
49936
 
@@ -49904,7 +49948,12 @@ export declare interface JsonApiCustomGeoCollectionPatch {
49904
49948
  * API identifier of an object
49905
49949
  */
49906
49950
  'id': string;
49907
- 'attributes'?: JsonApiCustomGeoCollectionInAttributes;
49951
+ 'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
49952
+ }
49953
+
49954
+ export declare interface JsonApiCustomGeoCollectionPatchAttributes {
49955
+ 'name'?: string | null;
49956
+ 'description'?: string | null;
49908
49957
  }
49909
49958
 
49910
49959
  export declare interface JsonApiCustomGeoCollectionPatchDocument {
@@ -49925,7 +49974,7 @@ export declare interface JsonApiDashboardPluginIn {
49925
49974
  * API identifier of an object
49926
49975
  */
49927
49976
  'id': string;
49928
- 'attributes'?: JsonApiDashboardPluginPostOptionalIdAttributes;
49977
+ 'attributes'?: JsonApiDashboardPluginPatchAttributes;
49929
49978
  }
49930
49979
 
49931
49980
  export declare interface JsonApiDashboardPluginInDocument {
@@ -50038,7 +50087,18 @@ export declare interface JsonApiDashboardPluginPatch {
50038
50087
  * API identifier of an object
50039
50088
  */
50040
50089
  'id': string;
50041
- 'attributes'?: JsonApiDashboardPluginPostOptionalIdAttributes;
50090
+ 'attributes'?: JsonApiDashboardPluginPatchAttributes;
50091
+ }
50092
+
50093
+ export declare interface JsonApiDashboardPluginPatchAttributes {
50094
+ 'title'?: string;
50095
+ 'description'?: string;
50096
+ 'tags'?: Array<string>;
50097
+ 'areRelationsValid'?: boolean;
50098
+ /**
50099
+ * Free-form JSON content. Maximum supported length is 250000 characters.
50100
+ */
50101
+ 'content'?: object;
50042
50102
  }
50043
50103
 
50044
50104
  export declare interface JsonApiDashboardPluginPatchDocument {
@@ -50059,18 +50119,7 @@ export declare interface JsonApiDashboardPluginPostOptionalId {
50059
50119
  * API identifier of an object
50060
50120
  */
50061
50121
  'id'?: string;
50062
- 'attributes'?: JsonApiDashboardPluginPostOptionalIdAttributes;
50063
- }
50064
-
50065
- export declare interface JsonApiDashboardPluginPostOptionalIdAttributes {
50066
- 'title'?: string;
50067
- 'description'?: string;
50068
- 'tags'?: Array<string>;
50069
- 'areRelationsValid'?: boolean;
50070
- /**
50071
- * Free-form JSON content. Maximum supported length is 250000 characters.
50072
- */
50073
- 'content'?: object;
50122
+ 'attributes'?: JsonApiDashboardPluginPatchAttributes;
50074
50123
  }
50075
50124
 
50076
50125
  export declare interface JsonApiDashboardPluginPostOptionalIdDocument {
@@ -50413,7 +50462,7 @@ export declare interface JsonApiDataSourceInAttributes {
50413
50462
  /**
50414
50463
  * Additional parameters to be used when connecting to the database providing the data for the data source.
50415
50464
  */
50416
- 'parameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
50465
+ 'parameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
50417
50466
  /**
50418
50467
  * Determines how the results coming from a particular datasource should be cached.
50419
50468
  */
@@ -50426,11 +50475,6 @@ export declare interface JsonApiDataSourceInAttributes {
50426
50475
 
50427
50476
  export declare type JsonApiDataSourceInAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
50428
50477
 
50429
- export declare interface JsonApiDataSourceInAttributesParametersInner {
50430
- 'name': string;
50431
- 'value': string;
50432
- }
50433
-
50434
50478
  export declare type JsonApiDataSourceInAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'DRILL' | 'GREENPLUM' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE';
50435
50479
 
50436
50480
  export declare interface JsonApiDataSourceInDocument {
@@ -50483,11 +50527,11 @@ export declare interface JsonApiDataSourceOutAttributes {
50483
50527
  /**
50484
50528
  * Additional parameters to be used when connecting to the database providing the data for the data source.
50485
50529
  */
50486
- 'parameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
50530
+ 'parameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
50487
50531
  /**
50488
50532
  * Decoded parameters to be used when connecting to the database providing the data for the data source.
50489
50533
  */
50490
- 'decodedParameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
50534
+ 'decodedParameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
50491
50535
  /**
50492
50536
  * Determines how the results coming from a particular datasource should be cached.
50493
50537
  */
@@ -50612,7 +50656,7 @@ export declare interface JsonApiDataSourcePatchAttributes {
50612
50656
  /**
50613
50657
  * Additional parameters to be used when connecting to the database providing the data for the data source.
50614
50658
  */
50615
- 'parameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
50659
+ 'parameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
50616
50660
  /**
50617
50661
  * Determines how the results coming from a particular datasource should be cached.
50618
50662
  */
@@ -50625,6 +50669,11 @@ export declare interface JsonApiDataSourcePatchAttributes {
50625
50669
 
50626
50670
  export declare type JsonApiDataSourcePatchAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
50627
50671
 
50672
+ export declare interface JsonApiDataSourcePatchAttributesParametersInner {
50673
+ 'name': string;
50674
+ 'value': string;
50675
+ }
50676
+
50628
50677
  export declare type JsonApiDataSourcePatchAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'DRILL' | 'GREENPLUM' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE';
50629
50678
 
50630
50679
  export declare interface JsonApiDataSourcePatchDocument {
@@ -50696,8 +50745,8 @@ export declare interface JsonApiExportDefinitionIn {
50696
50745
  * API identifier of an object
50697
50746
  */
50698
50747
  'id': string;
50699
- 'attributes'?: JsonApiExportDefinitionPostOptionalIdAttributes;
50700
- 'relationships'?: JsonApiExportDefinitionPostOptionalIdRelationships;
50748
+ 'attributes'?: JsonApiExportDefinitionPatchAttributes;
50749
+ 'relationships'?: JsonApiExportDefinitionPatchRelationships;
50701
50750
  }
50702
50751
 
50703
50752
  export declare interface JsonApiExportDefinitionInDocument {
@@ -50833,14 +50882,27 @@ export declare interface JsonApiExportDefinitionPatch {
50833
50882
  * API identifier of an object
50834
50883
  */
50835
50884
  'id': string;
50836
- 'attributes'?: JsonApiExportDefinitionPostOptionalIdAttributes;
50837
- 'relationships'?: JsonApiExportDefinitionPostOptionalIdRelationships;
50885
+ 'attributes'?: JsonApiExportDefinitionPatchAttributes;
50886
+ 'relationships'?: JsonApiExportDefinitionPatchRelationships;
50887
+ }
50888
+
50889
+ export declare interface JsonApiExportDefinitionPatchAttributes {
50890
+ 'title'?: string;
50891
+ 'description'?: string;
50892
+ 'tags'?: Array<string>;
50893
+ 'requestPayload'?: JsonApiExportDefinitionOutAttributesRequestPayload;
50894
+ 'areRelationsValid'?: boolean;
50838
50895
  }
50839
50896
 
50840
50897
  export declare interface JsonApiExportDefinitionPatchDocument {
50841
50898
  'data': JsonApiExportDefinitionPatch;
50842
50899
  }
50843
50900
 
50901
+ export declare interface JsonApiExportDefinitionPatchRelationships {
50902
+ 'visualizationObject'?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
50903
+ 'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
50904
+ }
50905
+
50844
50906
  export declare type JsonApiExportDefinitionPatchTypeEnum = 'exportDefinition';
50845
50907
 
50846
50908
  /**
@@ -50855,27 +50917,14 @@ export declare interface JsonApiExportDefinitionPostOptionalId {
50855
50917
  * API identifier of an object
50856
50918
  */
50857
50919
  'id'?: string;
50858
- 'attributes'?: JsonApiExportDefinitionPostOptionalIdAttributes;
50859
- 'relationships'?: JsonApiExportDefinitionPostOptionalIdRelationships;
50860
- }
50861
-
50862
- export declare interface JsonApiExportDefinitionPostOptionalIdAttributes {
50863
- 'title'?: string;
50864
- 'description'?: string;
50865
- 'tags'?: Array<string>;
50866
- 'requestPayload'?: JsonApiExportDefinitionOutAttributesRequestPayload;
50867
- 'areRelationsValid'?: boolean;
50920
+ 'attributes'?: JsonApiExportDefinitionPatchAttributes;
50921
+ 'relationships'?: JsonApiExportDefinitionPatchRelationships;
50868
50922
  }
50869
50923
 
50870
50924
  export declare interface JsonApiExportDefinitionPostOptionalIdDocument {
50871
50925
  'data': JsonApiExportDefinitionPostOptionalId;
50872
50926
  }
50873
50927
 
50874
- export declare interface JsonApiExportDefinitionPostOptionalIdRelationships {
50875
- 'visualizationObject'?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
50876
- 'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
50877
- }
50878
-
50879
50928
  export declare type JsonApiExportDefinitionPostOptionalIdTypeEnum = 'exportDefinition';
50880
50929
 
50881
50930
  /**
@@ -50890,47 +50939,9 @@ export declare interface JsonApiExportTemplateIn {
50890
50939
  * API identifier of an object
50891
50940
  */
50892
50941
  'id': string;
50893
- 'attributes': JsonApiExportTemplateInAttributes;
50894
- }
50895
-
50896
- export declare interface JsonApiExportTemplateInAttributes {
50897
- /**
50898
- * User-facing name of the Slides template.
50899
- */
50900
- 'name': string;
50901
- 'dashboardSlidesTemplate'?: JsonApiExportTemplateInAttributesDashboardSlidesTemplate | null;
50902
- 'widgetSlidesTemplate'?: JsonApiExportTemplateInAttributesWidgetSlidesTemplate | null;
50903
- }
50904
-
50905
- /**
50906
- * Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
50907
- */
50908
- export declare interface JsonApiExportTemplateInAttributesDashboardSlidesTemplate {
50909
- /**
50910
- * Export types this template applies to.
50911
- */
50912
- 'appliedOn': Array<JsonApiExportTemplateInAttributesDashboardSlidesTemplateAppliedOnEnum>;
50913
- 'coverSlide'?: CoverSlideTemplate | null;
50914
- 'introSlide'?: IntroSlideTemplate | null;
50915
- 'sectionSlide'?: SectionSlideTemplate | null;
50916
- 'contentSlide'?: ContentSlideTemplate | null;
50942
+ 'attributes': JsonApiExportTemplateOutAttributes;
50917
50943
  }
50918
50944
 
50919
- export declare type JsonApiExportTemplateInAttributesDashboardSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
50920
-
50921
- /**
50922
- * Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
50923
- */
50924
- export declare interface JsonApiExportTemplateInAttributesWidgetSlidesTemplate {
50925
- /**
50926
- * Export types this template applies to.
50927
- */
50928
- 'appliedOn': Array<JsonApiExportTemplateInAttributesWidgetSlidesTemplateAppliedOnEnum>;
50929
- 'contentSlide'?: ContentSlideTemplate | null;
50930
- }
50931
-
50932
- export declare type JsonApiExportTemplateInAttributesWidgetSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
50933
-
50934
50945
  export declare interface JsonApiExportTemplateInDocument {
50935
50946
  'data': JsonApiExportTemplateIn;
50936
50947
  }
@@ -50949,7 +50960,16 @@ export declare interface JsonApiExportTemplateOut {
50949
50960
  * API identifier of an object
50950
50961
  */
50951
50962
  'id': string;
50952
- 'attributes': JsonApiExportTemplateInAttributes;
50963
+ 'attributes': JsonApiExportTemplateOutAttributes;
50964
+ }
50965
+
50966
+ export declare interface JsonApiExportTemplateOutAttributes {
50967
+ /**
50968
+ * User-facing name of the Slides template.
50969
+ */
50970
+ 'name': string;
50971
+ 'dashboardSlidesTemplate'?: JsonApiExportTemplatePatchAttributesDashboardSlidesTemplate | null;
50972
+ 'widgetSlidesTemplate'?: JsonApiExportTemplatePatchAttributesWidgetSlidesTemplate | null;
50953
50973
  }
50954
50974
 
50955
50975
  export declare interface JsonApiExportTemplateOutDocument {
@@ -50977,7 +50997,7 @@ export declare interface JsonApiExportTemplateOutWithLinks {
50977
50997
  * API identifier of an object
50978
50998
  */
50979
50999
  'id': string;
50980
- 'attributes': JsonApiExportTemplateInAttributes;
51000
+ 'attributes': JsonApiExportTemplateOutAttributes;
50981
51001
  'links'?: ObjectLinks;
50982
51002
  }
50983
51003
 
@@ -51003,10 +51023,39 @@ export declare interface JsonApiExportTemplatePatchAttributes {
51003
51023
  * User-facing name of the Slides template.
51004
51024
  */
51005
51025
  'name'?: string;
51006
- 'dashboardSlidesTemplate'?: JsonApiExportTemplateInAttributesDashboardSlidesTemplate | null;
51007
- 'widgetSlidesTemplate'?: JsonApiExportTemplateInAttributesWidgetSlidesTemplate | null;
51026
+ 'dashboardSlidesTemplate'?: JsonApiExportTemplatePatchAttributesDashboardSlidesTemplate | null;
51027
+ 'widgetSlidesTemplate'?: JsonApiExportTemplatePatchAttributesWidgetSlidesTemplate | null;
51008
51028
  }
51009
51029
 
51030
+ /**
51031
+ * Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
51032
+ */
51033
+ export declare interface JsonApiExportTemplatePatchAttributesDashboardSlidesTemplate {
51034
+ /**
51035
+ * Export types this template applies to.
51036
+ */
51037
+ 'appliedOn': Array<JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum>;
51038
+ 'coverSlide'?: CoverSlideTemplate | null;
51039
+ 'introSlide'?: IntroSlideTemplate | null;
51040
+ 'sectionSlide'?: SectionSlideTemplate | null;
51041
+ 'contentSlide'?: ContentSlideTemplate | null;
51042
+ }
51043
+
51044
+ export declare type JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
51045
+
51046
+ /**
51047
+ * Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
51048
+ */
51049
+ export declare interface JsonApiExportTemplatePatchAttributesWidgetSlidesTemplate {
51050
+ /**
51051
+ * Export types this template applies to.
51052
+ */
51053
+ 'appliedOn': Array<JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum>;
51054
+ 'contentSlide'?: ContentSlideTemplate | null;
51055
+ }
51056
+
51057
+ export declare type JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
51058
+
51010
51059
  export declare interface JsonApiExportTemplatePatchDocument {
51011
51060
  'data': JsonApiExportTemplatePatch;
51012
51061
  }
@@ -51025,7 +51074,7 @@ export declare interface JsonApiExportTemplatePostOptionalId {
51025
51074
  * API identifier of an object
51026
51075
  */
51027
51076
  'id'?: string;
51028
- 'attributes': JsonApiExportTemplateInAttributes;
51077
+ 'attributes': JsonApiExportTemplateOutAttributes;
51029
51078
  }
51030
51079
 
51031
51080
  export declare interface JsonApiExportTemplatePostOptionalIdDocument {
@@ -51470,62 +51519,9 @@ export declare interface JsonApiIdentityProviderIn {
51470
51519
  * API identifier of an object
51471
51520
  */
51472
51521
  'id': string;
51473
- 'attributes'?: JsonApiIdentityProviderInAttributes;
51522
+ 'attributes'?: JsonApiIdentityProviderPatchAttributes;
51474
51523
  }
51475
51524
 
51476
- export declare interface JsonApiIdentityProviderInAttributes {
51477
- /**
51478
- * List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
51479
- */
51480
- 'identifiers'?: Array<string>;
51481
- /**
51482
- * Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.
51483
- */
51484
- 'customClaimMapping'?: {
51485
- [key: string]: string;
51486
- };
51487
- /**
51488
- * Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer\'s name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.
51489
- */
51490
- 'samlMetadata'?: string;
51491
- /**
51492
- * The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
51493
- */
51494
- 'oauthClientId'?: string;
51495
- /**
51496
- * The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
51497
- */
51498
- 'oauthClientSecret'?: string;
51499
- /**
51500
- * The location of your OIDC provider. This field is mandatory for OIDC IdP.
51501
- */
51502
- 'oauthIssuerLocation'?: string;
51503
- /**
51504
- * Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
51505
- */
51506
- 'oauthIssuerId'?: string;
51507
- /**
51508
- * Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
51509
- */
51510
- 'oauthSubjectIdClaim'?: string;
51511
- /**
51512
- * Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
51513
- */
51514
- 'oauthCustomAuthAttributes'?: {
51515
- [key: string]: string;
51516
- };
51517
- /**
51518
- * List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
51519
- */
51520
- 'oauthCustomScopes'?: Array<string> | null;
51521
- /**
51522
- * Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer\'s own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
51523
- */
51524
- 'idpType'?: JsonApiIdentityProviderInAttributesIdpTypeEnum;
51525
- }
51526
-
51527
- export declare type JsonApiIdentityProviderInAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
51528
-
51529
51525
  export declare interface JsonApiIdentityProviderInDocument {
51530
51526
  'data': JsonApiIdentityProviderIn;
51531
51527
  }
@@ -51645,9 +51641,62 @@ export declare interface JsonApiIdentityProviderPatch {
51645
51641
  * API identifier of an object
51646
51642
  */
51647
51643
  'id': string;
51648
- 'attributes'?: JsonApiIdentityProviderInAttributes;
51644
+ 'attributes'?: JsonApiIdentityProviderPatchAttributes;
51645
+ }
51646
+
51647
+ export declare interface JsonApiIdentityProviderPatchAttributes {
51648
+ /**
51649
+ * List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
51650
+ */
51651
+ 'identifiers'?: Array<string>;
51652
+ /**
51653
+ * Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.
51654
+ */
51655
+ 'customClaimMapping'?: {
51656
+ [key: string]: string;
51657
+ };
51658
+ /**
51659
+ * Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer\'s name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.
51660
+ */
51661
+ 'samlMetadata'?: string;
51662
+ /**
51663
+ * The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
51664
+ */
51665
+ 'oauthClientId'?: string;
51666
+ /**
51667
+ * The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
51668
+ */
51669
+ 'oauthClientSecret'?: string;
51670
+ /**
51671
+ * The location of your OIDC provider. This field is mandatory for OIDC IdP.
51672
+ */
51673
+ 'oauthIssuerLocation'?: string;
51674
+ /**
51675
+ * Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
51676
+ */
51677
+ 'oauthIssuerId'?: string;
51678
+ /**
51679
+ * Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
51680
+ */
51681
+ 'oauthSubjectIdClaim'?: string;
51682
+ /**
51683
+ * Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
51684
+ */
51685
+ 'oauthCustomAuthAttributes'?: {
51686
+ [key: string]: string;
51687
+ };
51688
+ /**
51689
+ * List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
51690
+ */
51691
+ 'oauthCustomScopes'?: Array<string> | null;
51692
+ /**
51693
+ * Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer\'s own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
51694
+ */
51695
+ 'idpType'?: JsonApiIdentityProviderPatchAttributesIdpTypeEnum;
51649
51696
  }
51650
51697
 
51698
+ export declare type JsonApiIdentityProviderPatchAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
51699
+
51651
51700
  export declare interface JsonApiIdentityProviderPatchDocument {
51652
51701
  'data': JsonApiIdentityProviderPatch;
51653
51702
  }
@@ -51666,11 +51715,7 @@ export declare interface JsonApiJwkIn {
51666
51715
  * API identifier of an object
51667
51716
  */
51668
51717
  'id': string;
51669
- 'attributes'?: JsonApiJwkInAttributes;
51670
- }
51671
-
51672
- export declare interface JsonApiJwkInAttributes {
51673
- 'content'?: RsaSpecification;
51718
+ 'attributes'?: JsonApiJwkPatchAttributes;
51674
51719
  }
51675
51720
 
51676
51721
  export declare interface JsonApiJwkInDocument {
@@ -51691,7 +51736,7 @@ export declare interface JsonApiJwkOut {
51691
51736
  * API identifier of an object
51692
51737
  */
51693
51738
  'id': string;
51694
- 'attributes'?: JsonApiJwkInAttributes;
51739
+ 'attributes'?: JsonApiJwkPatchAttributes;
51695
51740
  }
51696
51741
 
51697
51742
  export declare interface JsonApiJwkOutDocument {
@@ -51719,7 +51764,7 @@ export declare interface JsonApiJwkOutWithLinks {
51719
51764
  * API identifier of an object
51720
51765
  */
51721
51766
  'id': string;
51722
- 'attributes'?: JsonApiJwkInAttributes;
51767
+ 'attributes'?: JsonApiJwkPatchAttributes;
51723
51768
  'links'?: ObjectLinks;
51724
51769
  }
51725
51770
 
@@ -51737,7 +51782,11 @@ export declare interface JsonApiJwkPatch {
51737
51782
  * API identifier of an object
51738
51783
  */
51739
51784
  'id': string;
51740
- 'attributes'?: JsonApiJwkInAttributes;
51785
+ 'attributes'?: JsonApiJwkPatchAttributes;
51786
+ }
51787
+
51788
+ export declare interface JsonApiJwkPatchAttributes {
51789
+ 'content'?: RsaSpecification;
51741
51790
  }
51742
51791
 
51743
51792
  export declare interface JsonApiJwkPatchDocument {
@@ -52410,26 +52459,106 @@ export declare interface JsonApiLlmProviderIn {
52410
52459
  * API identifier of an object
52411
52460
  */
52412
52461
  'id': string;
52413
- 'attributes': JsonApiLlmProviderInAttributes;
52462
+ 'attributes': JsonApiLlmProviderOutAttributes;
52463
+ }
52464
+
52465
+ export declare interface JsonApiLlmProviderInDocument {
52466
+ 'data': JsonApiLlmProviderIn;
52467
+ }
52468
+
52469
+ export declare type JsonApiLlmProviderInTypeEnum = 'llmProvider';
52470
+
52471
+ /**
52472
+ * LLM Provider configuration for connecting to LLM services.
52473
+ */
52474
+ export declare interface JsonApiLlmProviderOut {
52475
+ /**
52476
+ * Object type
52477
+ */
52478
+ 'type': JsonApiLlmProviderOutTypeEnum;
52479
+ /**
52480
+ * API identifier of an object
52481
+ */
52482
+ 'id': string;
52483
+ 'attributes': JsonApiLlmProviderOutAttributes;
52414
52484
  }
52415
52485
 
52416
- export declare interface JsonApiLlmProviderInAttributes {
52486
+ export declare interface JsonApiLlmProviderOutAttributes {
52487
+ 'name'?: string | null;
52488
+ /**
52489
+ * Description of the LLM Provider.
52490
+ */
52491
+ 'description'?: string | null;
52492
+ 'providerConfig': JsonApiLlmProviderPatchAttributesProviderConfig;
52493
+ /**
52494
+ * List of LLM models available for this provider.
52495
+ */
52496
+ 'models': Array<JsonApiLlmProviderPatchAttributesModelsInner> | null;
52497
+ }
52498
+
52499
+ export declare interface JsonApiLlmProviderOutDocument {
52500
+ 'data': JsonApiLlmProviderOut;
52501
+ 'links'?: ObjectLinks;
52502
+ }
52503
+
52504
+ /**
52505
+ * A JSON:API document with a list of resources
52506
+ */
52507
+ export declare interface JsonApiLlmProviderOutList {
52508
+ 'data': Array<JsonApiLlmProviderOutWithLinks>;
52509
+ 'links'?: ListLinks;
52510
+ 'meta'?: JsonApiAggregatedFactOutListMeta;
52511
+ }
52512
+
52513
+ export declare type JsonApiLlmProviderOutTypeEnum = 'llmProvider';
52514
+
52515
+ export declare interface JsonApiLlmProviderOutWithLinks {
52516
+ /**
52517
+ * Object type
52518
+ */
52519
+ 'type': JsonApiLlmProviderOutWithLinksTypeEnum;
52520
+ /**
52521
+ * API identifier of an object
52522
+ */
52523
+ 'id': string;
52524
+ 'attributes': JsonApiLlmProviderOutAttributes;
52525
+ 'links'?: ObjectLinks;
52526
+ }
52527
+
52528
+ export declare type JsonApiLlmProviderOutWithLinksTypeEnum = 'llmProvider';
52529
+
52530
+ /**
52531
+ * LLM Provider configuration for connecting to LLM services.
52532
+ */
52533
+ export declare interface JsonApiLlmProviderPatch {
52534
+ /**
52535
+ * Object type
52536
+ */
52537
+ 'type': JsonApiLlmProviderPatchTypeEnum;
52538
+ /**
52539
+ * API identifier of an object
52540
+ */
52541
+ 'id': string;
52542
+ 'attributes': JsonApiLlmProviderPatchAttributes;
52543
+ }
52544
+
52545
+ export declare interface JsonApiLlmProviderPatchAttributes {
52417
52546
  'name'?: string | null;
52418
52547
  /**
52419
52548
  * Description of the LLM Provider.
52420
52549
  */
52421
52550
  'description'?: string | null;
52422
- 'providerConfig': JsonApiLlmProviderInAttributesProviderConfig;
52551
+ 'providerConfig'?: JsonApiLlmProviderPatchAttributesProviderConfig;
52423
52552
  /**
52424
52553
  * List of LLM models available for this provider.
52425
52554
  */
52426
- 'models': Array<JsonApiLlmProviderInAttributesModelsInner> | null;
52555
+ 'models'?: Array<JsonApiLlmProviderPatchAttributesModelsInner> | null;
52427
52556
  }
52428
52557
 
52429
52558
  /**
52430
52559
  * LLM Model configuration (id, family) within a provider.
52431
52560
  */
52432
- export declare interface JsonApiLlmProviderInAttributesModelsInner {
52561
+ export declare interface JsonApiLlmProviderPatchAttributesModelsInner {
52433
52562
  /**
52434
52563
  * Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
52435
52564
  */
@@ -52437,96 +52566,16 @@ export declare interface JsonApiLlmProviderInAttributesModelsInner {
52437
52566
  /**
52438
52567
  * Family of LLM models.
52439
52568
  */
52440
- 'family': JsonApiLlmProviderInAttributesModelsInnerFamilyEnum;
52569
+ 'family': JsonApiLlmProviderPatchAttributesModelsInnerFamilyEnum;
52441
52570
  }
52442
52571
 
52443
- export declare type JsonApiLlmProviderInAttributesModelsInnerFamilyEnum = 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE';
52572
+ export declare type JsonApiLlmProviderPatchAttributesModelsInnerFamilyEnum = 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE';
52444
52573
 
52445
52574
  /**
52446
- * @type JsonApiLlmProviderInAttributesProviderConfig
52575
+ * @type JsonApiLlmProviderPatchAttributesProviderConfig
52447
52576
  * Provider-specific configuration including authentication.
52448
52577
  */
52449
- export declare type JsonApiLlmProviderInAttributesProviderConfig = AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
52450
-
52451
- export declare interface JsonApiLlmProviderInDocument {
52452
- 'data': JsonApiLlmProviderIn;
52453
- }
52454
-
52455
- export declare type JsonApiLlmProviderInTypeEnum = 'llmProvider';
52456
-
52457
- /**
52458
- * LLM Provider configuration for connecting to LLM services.
52459
- */
52460
- export declare interface JsonApiLlmProviderOut {
52461
- /**
52462
- * Object type
52463
- */
52464
- 'type': JsonApiLlmProviderOutTypeEnum;
52465
- /**
52466
- * API identifier of an object
52467
- */
52468
- 'id': string;
52469
- 'attributes': JsonApiLlmProviderInAttributes;
52470
- }
52471
-
52472
- export declare interface JsonApiLlmProviderOutDocument {
52473
- 'data': JsonApiLlmProviderOut;
52474
- 'links'?: ObjectLinks;
52475
- }
52476
-
52477
- /**
52478
- * A JSON:API document with a list of resources
52479
- */
52480
- export declare interface JsonApiLlmProviderOutList {
52481
- 'data': Array<JsonApiLlmProviderOutWithLinks>;
52482
- 'links'?: ListLinks;
52483
- 'meta'?: JsonApiAggregatedFactOutListMeta;
52484
- }
52485
-
52486
- export declare type JsonApiLlmProviderOutTypeEnum = 'llmProvider';
52487
-
52488
- export declare interface JsonApiLlmProviderOutWithLinks {
52489
- /**
52490
- * Object type
52491
- */
52492
- 'type': JsonApiLlmProviderOutWithLinksTypeEnum;
52493
- /**
52494
- * API identifier of an object
52495
- */
52496
- 'id': string;
52497
- 'attributes': JsonApiLlmProviderInAttributes;
52498
- 'links'?: ObjectLinks;
52499
- }
52500
-
52501
- export declare type JsonApiLlmProviderOutWithLinksTypeEnum = 'llmProvider';
52502
-
52503
- /**
52504
- * LLM Provider configuration for connecting to LLM services.
52505
- */
52506
- export declare interface JsonApiLlmProviderPatch {
52507
- /**
52508
- * Object type
52509
- */
52510
- 'type': JsonApiLlmProviderPatchTypeEnum;
52511
- /**
52512
- * API identifier of an object
52513
- */
52514
- 'id': string;
52515
- 'attributes': JsonApiLlmProviderPatchAttributes;
52516
- }
52517
-
52518
- export declare interface JsonApiLlmProviderPatchAttributes {
52519
- 'name'?: string | null;
52520
- /**
52521
- * Description of the LLM Provider.
52522
- */
52523
- 'description'?: string | null;
52524
- 'providerConfig'?: JsonApiLlmProviderInAttributesProviderConfig;
52525
- /**
52526
- * List of LLM models available for this provider.
52527
- */
52528
- 'models'?: Array<JsonApiLlmProviderInAttributesModelsInner> | null;
52529
- }
52578
+ export declare type JsonApiLlmProviderPatchAttributesProviderConfig = AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
52530
52579
 
52531
52580
  export declare interface JsonApiLlmProviderPatchDocument {
52532
52581
  'data': JsonApiLlmProviderPatch;
@@ -53012,47 +53061,9 @@ export declare interface JsonApiNotificationChannelIn {
53012
53061
  * API identifier of an object
53013
53062
  */
53014
53063
  'id': string;
53015
- 'attributes'?: JsonApiNotificationChannelInAttributes;
53016
- }
53017
-
53018
- export declare interface JsonApiNotificationChannelInAttributes {
53019
- 'name'?: string | null;
53020
- 'description'?: string | null;
53021
- 'destination'?: JsonApiNotificationChannelInAttributesDestination;
53022
- /**
53023
- * Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
53024
- */
53025
- 'customDashboardUrl'?: string;
53026
- /**
53027
- * Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
53028
- */
53029
- 'dashboardLinkVisibility'?: JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum;
53030
- /**
53031
- * Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
53032
- */
53033
- 'notificationSource'?: string;
53034
- /**
53035
- * Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
53036
- */
53037
- 'allowedRecipients'?: JsonApiNotificationChannelInAttributesAllowedRecipientsEnum;
53038
- /**
53039
- * In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
53040
- */
53041
- 'inPlatformNotification'?: JsonApiNotificationChannelInAttributesInPlatformNotificationEnum;
53064
+ 'attributes'?: JsonApiNotificationChannelPatchAttributes;
53042
53065
  }
53043
53066
 
53044
- export declare type JsonApiNotificationChannelInAttributesAllowedRecipientsEnum = 'CREATOR' | 'INTERNAL' | 'EXTERNAL';
53045
-
53046
- export declare type JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
53047
-
53048
- /**
53049
- * @type JsonApiNotificationChannelInAttributesDestination
53050
- * The destination where the notifications are to be sent.
53051
- */
53052
- export declare type JsonApiNotificationChannelInAttributesDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
53053
-
53054
- export declare type JsonApiNotificationChannelInAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
53055
-
53056
53067
  export declare interface JsonApiNotificationChannelInDocument {
53057
53068
  'data': JsonApiNotificationChannelIn;
53058
53069
  }
@@ -53087,7 +53098,7 @@ export declare interface JsonApiNotificationChannelOut {
53087
53098
  export declare interface JsonApiNotificationChannelOutAttributes {
53088
53099
  'name'?: string | null;
53089
53100
  'description'?: string | null;
53090
- 'destination'?: JsonApiNotificationChannelInAttributesDestination;
53101
+ 'destination'?: JsonApiNotificationChannelPatchAttributesDestination;
53091
53102
  'destinationType'?: JsonApiNotificationChannelOutAttributesDestinationTypeEnum | null;
53092
53103
  /**
53093
53104
  * Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
@@ -53162,9 +53173,47 @@ export declare interface JsonApiNotificationChannelPatch {
53162
53173
  * API identifier of an object
53163
53174
  */
53164
53175
  'id': string;
53165
- 'attributes'?: JsonApiNotificationChannelInAttributes;
53176
+ 'attributes'?: JsonApiNotificationChannelPatchAttributes;
53166
53177
  }
53167
53178
 
53179
+ export declare interface JsonApiNotificationChannelPatchAttributes {
53180
+ 'name'?: string | null;
53181
+ 'description'?: string | null;
53182
+ 'destination'?: JsonApiNotificationChannelPatchAttributesDestination;
53183
+ /**
53184
+ * Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
53185
+ */
53186
+ 'customDashboardUrl'?: string;
53187
+ /**
53188
+ * Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
53189
+ */
53190
+ 'dashboardLinkVisibility'?: JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum;
53191
+ /**
53192
+ * Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
53193
+ */
53194
+ 'notificationSource'?: string;
53195
+ /**
53196
+ * Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
53197
+ */
53198
+ 'allowedRecipients'?: JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum;
53199
+ /**
53200
+ * In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
53201
+ */
53202
+ 'inPlatformNotification'?: JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum;
53203
+ }
53204
+
53205
+ export declare type JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum = 'CREATOR' | 'INTERNAL' | 'EXTERNAL';
53206
+
53207
+ export declare type JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
53208
+
53209
+ /**
53210
+ * @type JsonApiNotificationChannelPatchAttributesDestination
53211
+ * The destination where the notifications are to be sent.
53212
+ */
53213
+ export declare type JsonApiNotificationChannelPatchAttributesDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
53214
+
53215
+ export declare type JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
53216
+
53168
53217
  export declare interface JsonApiNotificationChannelPatchDocument {
53169
53218
  'data': JsonApiNotificationChannelPatch;
53170
53219
  }
@@ -53183,7 +53232,7 @@ export declare interface JsonApiNotificationChannelPostOptionalId {
53183
53232
  * API identifier of an object
53184
53233
  */
53185
53234
  'id'?: string;
53186
- 'attributes'?: JsonApiNotificationChannelInAttributes;
53235
+ 'attributes'?: JsonApiNotificationChannelPatchAttributes;
53187
53236
  }
53188
53237
 
53189
53238
  export declare interface JsonApiNotificationChannelPostOptionalIdDocument {
@@ -53204,37 +53253,14 @@ export declare interface JsonApiOrganizationIn {
53204
53253
  * API identifier of an object
53205
53254
  */
53206
53255
  'id': string;
53207
- 'attributes'?: JsonApiOrganizationInAttributes;
53208
- 'relationships'?: JsonApiOrganizationInRelationships;
53209
- }
53210
-
53211
- export declare interface JsonApiOrganizationInAttributes {
53212
- 'name'?: string | null;
53213
- 'hostname'?: string;
53214
- 'allowedOrigins'?: Array<string>;
53215
- /**
53216
- * The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
53217
- * @deprecated
53218
- */
53219
- 'earlyAccess'?: string | null;
53220
- /**
53221
- * The early access feature identifiers. They are used to enable experimental features.
53222
- */
53223
- 'earlyAccessValues'?: Array<string> | null;
53256
+ 'attributes'?: JsonApiOrganizationPatchAttributes;
53257
+ 'relationships'?: JsonApiOrganizationPatchRelationships;
53224
53258
  }
53225
53259
 
53226
53260
  export declare interface JsonApiOrganizationInDocument {
53227
53261
  'data': JsonApiOrganizationIn;
53228
53262
  }
53229
53263
 
53230
- export declare interface JsonApiOrganizationInRelationships {
53231
- 'identityProvider'?: JsonApiOrganizationInRelationshipsIdentityProvider;
53232
- }
53233
-
53234
- export declare interface JsonApiOrganizationInRelationshipsIdentityProvider {
53235
- 'data': JsonApiIdentityProviderLinkage | null;
53236
- }
53237
-
53238
53264
  export declare type JsonApiOrganizationInTypeEnum = 'organization';
53239
53265
 
53240
53266
  /**
@@ -53311,7 +53337,7 @@ export declare type JsonApiOrganizationOutMetaPermissionsEnum = 'MANAGE' | 'SELF
53311
53337
  export declare interface JsonApiOrganizationOutRelationships {
53312
53338
  'bootstrapUser'?: JsonApiOrganizationOutRelationshipsBootstrapUser;
53313
53339
  'bootstrapUserGroup'?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
53314
- 'identityProvider'?: JsonApiOrganizationInRelationshipsIdentityProvider;
53340
+ 'identityProvider'?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
53315
53341
  }
53316
53342
 
53317
53343
  export declare interface JsonApiOrganizationOutRelationshipsBootstrapUser {
@@ -53336,14 +53362,37 @@ export declare interface JsonApiOrganizationPatch {
53336
53362
  * API identifier of an object
53337
53363
  */
53338
53364
  'id': string;
53339
- 'attributes'?: JsonApiOrganizationInAttributes;
53340
- 'relationships'?: JsonApiOrganizationInRelationships;
53365
+ 'attributes'?: JsonApiOrganizationPatchAttributes;
53366
+ 'relationships'?: JsonApiOrganizationPatchRelationships;
53367
+ }
53368
+
53369
+ export declare interface JsonApiOrganizationPatchAttributes {
53370
+ 'name'?: string | null;
53371
+ 'hostname'?: string;
53372
+ 'allowedOrigins'?: Array<string>;
53373
+ /**
53374
+ * The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
53375
+ * @deprecated
53376
+ */
53377
+ 'earlyAccess'?: string | null;
53378
+ /**
53379
+ * The early access feature identifiers. They are used to enable experimental features.
53380
+ */
53381
+ 'earlyAccessValues'?: Array<string> | null;
53341
53382
  }
53342
53383
 
53343
53384
  export declare interface JsonApiOrganizationPatchDocument {
53344
53385
  'data': JsonApiOrganizationPatch;
53345
53386
  }
53346
53387
 
53388
+ export declare interface JsonApiOrganizationPatchRelationships {
53389
+ 'identityProvider'?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
53390
+ }
53391
+
53392
+ export declare interface JsonApiOrganizationPatchRelationshipsIdentityProvider {
53393
+ 'data': JsonApiIdentityProviderLinkage | null;
53394
+ }
53395
+
53347
53396
  export declare type JsonApiOrganizationPatchTypeEnum = 'organization';
53348
53397
 
53349
53398
  /**
@@ -53358,19 +53407,9 @@ export declare interface JsonApiOrganizationSettingIn {
53358
53407
  * API identifier of an object
53359
53408
  */
53360
53409
  'id': string;
53361
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
53410
+ 'attributes'?: JsonApiUserSettingInAttributes;
53362
53411
  }
53363
53412
 
53364
- export declare interface JsonApiOrganizationSettingInAttributes {
53365
- /**
53366
- * Free-form JSON content. Maximum supported length is 15000 characters.
53367
- */
53368
- 'content'?: object;
53369
- 'type'?: JsonApiOrganizationSettingInAttributesTypeEnum;
53370
- }
53371
-
53372
- export declare type JsonApiOrganizationSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS';
53373
-
53374
53413
  export declare interface JsonApiOrganizationSettingInDocument {
53375
53414
  'data': JsonApiOrganizationSettingIn;
53376
53415
  }
@@ -53389,7 +53428,7 @@ export declare interface JsonApiOrganizationSettingOut {
53389
53428
  * API identifier of an object
53390
53429
  */
53391
53430
  'id': string;
53392
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
53431
+ 'attributes'?: JsonApiUserSettingInAttributes;
53393
53432
  }
53394
53433
 
53395
53434
  export declare interface JsonApiOrganizationSettingOutDocument {
@@ -53417,7 +53456,7 @@ export declare interface JsonApiOrganizationSettingOutWithLinks {
53417
53456
  * API identifier of an object
53418
53457
  */
53419
53458
  'id': string;
53420
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
53459
+ 'attributes'?: JsonApiUserSettingInAttributes;
53421
53460
  'links'?: ObjectLinks;
53422
53461
  }
53423
53462
 
@@ -53435,7 +53474,7 @@ export declare interface JsonApiOrganizationSettingPatch {
53435
53474
  * API identifier of an object
53436
53475
  */
53437
53476
  'id': string;
53438
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
53477
+ 'attributes'?: JsonApiUserSettingInAttributes;
53439
53478
  }
53440
53479
 
53441
53480
  export declare interface JsonApiOrganizationSettingPatchDocument {
@@ -53456,7 +53495,7 @@ export declare interface JsonApiThemeIn {
53456
53495
  * API identifier of an object
53457
53496
  */
53458
53497
  'id': string;
53459
- 'attributes': JsonApiColorPaletteInAttributes;
53498
+ 'attributes': JsonApiColorPaletteOutAttributes;
53460
53499
  }
53461
53500
 
53462
53501
  export declare interface JsonApiThemeInDocument {
@@ -53477,7 +53516,7 @@ export declare interface JsonApiThemeOut {
53477
53516
  * API identifier of an object
53478
53517
  */
53479
53518
  'id': string;
53480
- 'attributes': JsonApiColorPaletteInAttributes;
53519
+ 'attributes': JsonApiColorPaletteOutAttributes;
53481
53520
  }
53482
53521
 
53483
53522
  export declare interface JsonApiThemeOutDocument {
@@ -53505,7 +53544,7 @@ export declare interface JsonApiThemeOutWithLinks {
53505
53544
  * API identifier of an object
53506
53545
  */
53507
53546
  'id': string;
53508
- 'attributes': JsonApiColorPaletteInAttributes;
53547
+ 'attributes': JsonApiColorPaletteOutAttributes;
53509
53548
  'links'?: ObjectLinks;
53510
53549
  }
53511
53550
 
@@ -53545,7 +53584,7 @@ export declare interface JsonApiUserDataFilterIn {
53545
53584
  */
53546
53585
  'id': string;
53547
53586
  'attributes': JsonApiUserDataFilterOutAttributes;
53548
- 'relationships'?: JsonApiUserDataFilterPostOptionalIdRelationships;
53587
+ 'relationships'?: JsonApiUserDataFilterPatchRelationships;
53549
53588
  }
53550
53589
 
53551
53590
  export declare interface JsonApiUserDataFilterInDocument {
@@ -53648,7 +53687,7 @@ export declare interface JsonApiUserDataFilterPatch {
53648
53687
  */
53649
53688
  'id': string;
53650
53689
  'attributes': JsonApiUserDataFilterPatchAttributes;
53651
- 'relationships'?: JsonApiUserDataFilterPostOptionalIdRelationships;
53690
+ 'relationships'?: JsonApiUserDataFilterPatchRelationships;
53652
53691
  }
53653
53692
 
53654
53693
  export declare interface JsonApiUserDataFilterPatchAttributes {
@@ -53663,6 +53702,11 @@ export declare interface JsonApiUserDataFilterPatchDocument {
53663
53702
  'data': JsonApiUserDataFilterPatch;
53664
53703
  }
53665
53704
 
53705
+ export declare interface JsonApiUserDataFilterPatchRelationships {
53706
+ 'user'?: JsonApiOrganizationOutRelationshipsBootstrapUser;
53707
+ 'userGroup'?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
53708
+ }
53709
+
53666
53710
  export declare type JsonApiUserDataFilterPatchTypeEnum = 'userDataFilter';
53667
53711
 
53668
53712
  /**
@@ -53678,18 +53722,13 @@ export declare interface JsonApiUserDataFilterPostOptionalId {
53678
53722
  */
53679
53723
  'id'?: string;
53680
53724
  'attributes': JsonApiUserDataFilterOutAttributes;
53681
- 'relationships'?: JsonApiUserDataFilterPostOptionalIdRelationships;
53725
+ 'relationships'?: JsonApiUserDataFilterPatchRelationships;
53682
53726
  }
53683
53727
 
53684
53728
  export declare interface JsonApiUserDataFilterPostOptionalIdDocument {
53685
53729
  'data': JsonApiUserDataFilterPostOptionalId;
53686
53730
  }
53687
53731
 
53688
- export declare interface JsonApiUserDataFilterPostOptionalIdRelationships {
53689
- 'user'?: JsonApiOrganizationOutRelationshipsBootstrapUser;
53690
- 'userGroup'?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
53691
- }
53692
-
53693
53732
  export declare type JsonApiUserDataFilterPostOptionalIdTypeEnum = 'userDataFilter';
53694
53733
 
53695
53734
  /**
@@ -54012,9 +54051,19 @@ export declare interface JsonApiUserSettingIn {
54012
54051
  * API identifier of an object
54013
54052
  */
54014
54053
  'id': string;
54015
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
54054
+ 'attributes'?: JsonApiUserSettingInAttributes;
54016
54055
  }
54017
54056
 
54057
+ export declare interface JsonApiUserSettingInAttributes {
54058
+ /**
54059
+ * Free-form JSON content. Maximum supported length is 15000 characters.
54060
+ */
54061
+ 'content'?: object;
54062
+ 'type'?: JsonApiUserSettingInAttributesTypeEnum;
54063
+ }
54064
+
54065
+ export declare type JsonApiUserSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS';
54066
+
54018
54067
  export declare interface JsonApiUserSettingInDocument {
54019
54068
  'data': JsonApiUserSettingIn;
54020
54069
  }
@@ -54033,7 +54082,7 @@ export declare interface JsonApiUserSettingOut {
54033
54082
  * API identifier of an object
54034
54083
  */
54035
54084
  'id': string;
54036
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
54085
+ 'attributes'?: JsonApiUserSettingInAttributes;
54037
54086
  }
54038
54087
 
54039
54088
  export declare interface JsonApiUserSettingOutDocument {
@@ -54061,7 +54110,7 @@ export declare interface JsonApiUserSettingOutWithLinks {
54061
54110
  * API identifier of an object
54062
54111
  */
54063
54112
  'id': string;
54064
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
54113
+ 'attributes'?: JsonApiUserSettingInAttributes;
54065
54114
  'links'?: ObjectLinks;
54066
54115
  }
54067
54116
 
@@ -54358,7 +54407,7 @@ export declare interface JsonApiWorkspaceAutomationOutList {
54358
54407
  }
54359
54408
 
54360
54409
  export declare interface JsonApiWorkspaceAutomationOutRelationships {
54361
- 'workspace'?: JsonApiWorkspaceInRelationshipsParent;
54410
+ 'workspace'?: JsonApiWorkspacePatchRelationshipsParent;
54362
54411
  'notificationChannel'?: JsonApiAutomationOutRelationshipsNotificationChannel;
54363
54412
  'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
54364
54413
  'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
@@ -54653,56 +54702,14 @@ export declare interface JsonApiWorkspaceIn {
54653
54702
  * API identifier of an object
54654
54703
  */
54655
54704
  'id': string;
54656
- 'attributes'?: JsonApiWorkspaceInAttributes;
54657
- 'relationships'?: JsonApiWorkspaceInRelationships;
54658
- }
54659
-
54660
- export declare interface JsonApiWorkspaceInAttributes {
54661
- 'name'?: string | null;
54662
- /**
54663
- * The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
54664
- * @deprecated
54665
- */
54666
- 'earlyAccess'?: string | null;
54667
- /**
54668
- * The early access feature identifiers. They are used to enable experimental features.
54669
- */
54670
- 'earlyAccessValues'?: Array<string> | null;
54671
- 'description'?: string | null;
54672
- /**
54673
- * Custom prefix of entity identifiers in workspace
54674
- */
54675
- 'prefix'?: string | null;
54676
- 'cacheExtraLimit'?: number;
54677
- 'dataSource'?: JsonApiWorkspaceInAttributesDataSource;
54678
- }
54679
-
54680
- /**
54681
- * The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.
54682
- */
54683
- export declare interface JsonApiWorkspaceInAttributesDataSource {
54684
- /**
54685
- * The ID of the used data source.
54686
- */
54687
- 'id': string;
54688
- /**
54689
- * The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
54690
- */
54691
- 'schemaPath'?: Array<string>;
54705
+ 'attributes'?: JsonApiWorkspacePatchAttributes;
54706
+ 'relationships'?: JsonApiWorkspacePatchRelationships;
54692
54707
  }
54693
54708
 
54694
54709
  export declare interface JsonApiWorkspaceInDocument {
54695
54710
  'data': JsonApiWorkspaceIn;
54696
54711
  }
54697
54712
 
54698
- export declare interface JsonApiWorkspaceInRelationships {
54699
- 'parent'?: JsonApiWorkspaceInRelationshipsParent;
54700
- }
54701
-
54702
- export declare interface JsonApiWorkspaceInRelationshipsParent {
54703
- 'data': JsonApiWorkspaceLinkage | null;
54704
- }
54705
-
54706
54713
  export declare type JsonApiWorkspaceInTypeEnum = 'workspace';
54707
54714
 
54708
54715
  /**
@@ -54728,8 +54735,8 @@ export declare interface JsonApiWorkspaceOut {
54728
54735
  */
54729
54736
  'id': string;
54730
54737
  'meta'?: JsonApiWorkspaceOutMeta;
54731
- 'attributes'?: JsonApiWorkspaceInAttributes;
54732
- 'relationships'?: JsonApiWorkspaceInRelationships;
54738
+ 'attributes'?: JsonApiWorkspacePatchAttributes;
54739
+ 'relationships'?: JsonApiWorkspacePatchRelationships;
54733
54740
  }
54734
54741
 
54735
54742
  export declare interface JsonApiWorkspaceOutDocument {
@@ -54807,8 +54814,8 @@ export declare interface JsonApiWorkspaceOutWithLinks {
54807
54814
  */
54808
54815
  'id': string;
54809
54816
  'meta'?: JsonApiWorkspaceOutMeta;
54810
- 'attributes'?: JsonApiWorkspaceInAttributes;
54811
- 'relationships'?: JsonApiWorkspaceInRelationships;
54817
+ 'attributes'?: JsonApiWorkspacePatchAttributes;
54818
+ 'relationships'?: JsonApiWorkspacePatchRelationships;
54812
54819
  'links'?: ObjectLinks;
54813
54820
  }
54814
54821
 
@@ -54826,14 +54833,56 @@ export declare interface JsonApiWorkspacePatch {
54826
54833
  * API identifier of an object
54827
54834
  */
54828
54835
  'id': string;
54829
- 'attributes'?: JsonApiWorkspaceInAttributes;
54830
- 'relationships'?: JsonApiWorkspaceInRelationships;
54836
+ 'attributes'?: JsonApiWorkspacePatchAttributes;
54837
+ 'relationships'?: JsonApiWorkspacePatchRelationships;
54838
+ }
54839
+
54840
+ export declare interface JsonApiWorkspacePatchAttributes {
54841
+ 'name'?: string | null;
54842
+ /**
54843
+ * The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
54844
+ * @deprecated
54845
+ */
54846
+ 'earlyAccess'?: string | null;
54847
+ /**
54848
+ * The early access feature identifiers. They are used to enable experimental features.
54849
+ */
54850
+ 'earlyAccessValues'?: Array<string> | null;
54851
+ 'description'?: string | null;
54852
+ /**
54853
+ * Custom prefix of entity identifiers in workspace
54854
+ */
54855
+ 'prefix'?: string | null;
54856
+ 'cacheExtraLimit'?: number;
54857
+ 'dataSource'?: JsonApiWorkspacePatchAttributesDataSource;
54858
+ }
54859
+
54860
+ /**
54861
+ * The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.
54862
+ */
54863
+ export declare interface JsonApiWorkspacePatchAttributesDataSource {
54864
+ /**
54865
+ * The ID of the used data source.
54866
+ */
54867
+ 'id': string;
54868
+ /**
54869
+ * The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
54870
+ */
54871
+ 'schemaPath'?: Array<string>;
54831
54872
  }
54832
54873
 
54833
54874
  export declare interface JsonApiWorkspacePatchDocument {
54834
54875
  'data': JsonApiWorkspacePatch;
54835
54876
  }
54836
54877
 
54878
+ export declare interface JsonApiWorkspacePatchRelationships {
54879
+ 'parent'?: JsonApiWorkspacePatchRelationshipsParent;
54880
+ }
54881
+
54882
+ export declare interface JsonApiWorkspacePatchRelationshipsParent {
54883
+ 'data': JsonApiWorkspaceLinkage | null;
54884
+ }
54885
+
54837
54886
  export declare type JsonApiWorkspacePatchTypeEnum = 'workspace';
54838
54887
 
54839
54888
  /**
@@ -54848,7 +54897,7 @@ export declare interface JsonApiWorkspaceSettingIn {
54848
54897
  * API identifier of an object
54849
54898
  */
54850
54899
  'id': string;
54851
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
54900
+ 'attributes'?: JsonApiUserSettingInAttributes;
54852
54901
  }
54853
54902
 
54854
54903
  export declare interface JsonApiWorkspaceSettingInDocument {
@@ -54870,7 +54919,7 @@ export declare interface JsonApiWorkspaceSettingOut {
54870
54919
  */
54871
54920
  'id': string;
54872
54921
  'meta'?: JsonApiDatasetOutMeta;
54873
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
54922
+ 'attributes'?: JsonApiUserSettingInAttributes;
54874
54923
  }
54875
54924
 
54876
54925
  export declare interface JsonApiWorkspaceSettingOutDocument {
@@ -54899,7 +54948,7 @@ export declare interface JsonApiWorkspaceSettingOutWithLinks {
54899
54948
  */
54900
54949
  'id': string;
54901
54950
  'meta'?: JsonApiDatasetOutMeta;
54902
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
54951
+ 'attributes'?: JsonApiUserSettingInAttributes;
54903
54952
  'links'?: ObjectLinks;
54904
54953
  }
54905
54954
 
@@ -54917,7 +54966,7 @@ export declare interface JsonApiWorkspaceSettingPatch {
54917
54966
  * API identifier of an object
54918
54967
  */
54919
54968
  'id': string;
54920
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
54969
+ 'attributes'?: JsonApiUserSettingInAttributes;
54921
54970
  }
54922
54971
 
54923
54972
  export declare interface JsonApiWorkspaceSettingPatchDocument {
@@ -54938,7 +54987,7 @@ export declare interface JsonApiWorkspaceSettingPostOptionalId {
54938
54987
  * API identifier of an object
54939
54988
  */
54940
54989
  'id'?: string;
54941
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
54990
+ 'attributes'?: JsonApiUserSettingInAttributes;
54942
54991
  }
54943
54992
 
54944
54993
  export declare interface JsonApiWorkspaceSettingPostOptionalIdDocument {
@@ -59959,6 +60008,14 @@ export declare interface Metric {
59959
60008
 
59960
60009
  export declare type MetricAggFunctionEnum = 'COUNT' | 'SUM' | 'MIN' | 'MAX' | 'AVG' | 'MEDIAN';
59961
60010
 
60011
+ /**
60012
+ * (EXPERIMENTAL) Override for a catalog metric definition.
60013
+ */
60014
+ export declare interface MetricDefinitionOverride {
60015
+ 'item': AfmObjectIdentifierCore;
60016
+ 'definition': InlineMeasureDefinition;
60017
+ }
60018
+
59962
60019
  /**
59963
60020
  * MetricsApi - object-oriented interface
59964
60021
  * @export