@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.
@@ -32,6 +32,10 @@ export interface AFM {
32
32
  * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
33
33
  */
34
34
  'auxMeasures'?: Array<MeasureItem>;
35
+ /**
36
+ * (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric\'s MAQL definition without modifying the stored definition.
37
+ */
38
+ 'measureDefinitionOverrides'?: Array<MetricDefinitionOverride>;
35
39
  }
36
40
  /**
37
41
  * A datetime filter specifying exact from and to values.
@@ -606,10 +610,12 @@ export interface DashboardDateFilterDateFilter {
606
610
  'dataSet'?: IdentifierRef;
607
611
  'attribute'?: IdentifierRef;
608
612
  'boundedFilter'?: RelativeBoundedDateFilter;
613
+ 'emptyValueHandling'?: DashboardDateFilterDateFilterEmptyValueHandlingEnum;
609
614
  'localIdentifier'?: string;
610
615
  }
611
616
  export type DashboardDateFilterDateFilterTypeEnum = 'relative' | 'absolute';
612
617
  export type DashboardDateFilterDateFilterGranularityEnum = 'ALL_TIME_GRANULARITY' | 'GDC.time.year' | 'GDC.time.week_us' | 'GDC.time.week_in_year' | 'GDC.time.week_in_quarter' | 'GDC.time.week' | 'GDC.time.euweek_in_year' | 'GDC.time.euweek_in_quarter' | 'GDC.time.quarter' | 'GDC.time.quarter_in_year' | 'GDC.time.month' | 'GDC.time.month_in_quarter' | 'GDC.time.month_in_year' | 'GDC.time.day_in_year' | 'GDC.time.day_in_quarter' | 'GDC.time.day_in_month' | 'GDC.time.day_in_week' | 'GDC.time.day_in_euweek' | 'GDC.time.date' | 'GDC.time.hour' | 'GDC.time.hour_in_day' | 'GDC.time.minute' | 'GDC.time.minute_in_hour' | 'GDC.time.fiscal_month' | 'GDC.time.fiscal_quarter' | 'GDC.time.fiscal_year';
618
+ export type DashboardDateFilterDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
613
619
  /**
614
620
  * @type DashboardDateFilterDateFilterFrom
615
621
  */
@@ -3294,19 +3300,9 @@ export interface JsonApiAttributeHierarchyIn {
3294
3300
  * API identifier of an object
3295
3301
  */
3296
3302
  'id': string;
3297
- 'attributes'?: JsonApiAttributeHierarchyInAttributes;
3303
+ 'attributes'?: JsonApiAttributeHierarchyPatchAttributes;
3298
3304
  }
3299
3305
  export type JsonApiAttributeHierarchyInTypeEnum = 'attributeHierarchy';
3300
- export interface JsonApiAttributeHierarchyInAttributes {
3301
- 'title'?: string;
3302
- 'description'?: string;
3303
- 'tags'?: Array<string>;
3304
- 'areRelationsValid'?: boolean;
3305
- /**
3306
- * Free-form JSON content. Maximum supported length is 15000 characters.
3307
- */
3308
- 'content'?: object;
3309
- }
3310
3306
  export interface JsonApiAttributeHierarchyInDocument {
3311
3307
  'data': JsonApiAttributeHierarchyIn;
3312
3308
  }
@@ -3409,9 +3405,19 @@ export interface JsonApiAttributeHierarchyPatch {
3409
3405
  * API identifier of an object
3410
3406
  */
3411
3407
  'id': string;
3412
- 'attributes'?: JsonApiAttributeHierarchyInAttributes;
3408
+ 'attributes'?: JsonApiAttributeHierarchyPatchAttributes;
3413
3409
  }
3414
3410
  export type JsonApiAttributeHierarchyPatchTypeEnum = 'attributeHierarchy';
3411
+ export interface JsonApiAttributeHierarchyPatchAttributes {
3412
+ 'title'?: string;
3413
+ 'description'?: string;
3414
+ 'tags'?: Array<string>;
3415
+ 'areRelationsValid'?: boolean;
3416
+ /**
3417
+ * Free-form JSON content. Maximum supported length is 15000 characters.
3418
+ */
3419
+ 'content'?: object;
3420
+ }
3415
3421
  export interface JsonApiAttributeHierarchyPatchDocument {
3416
3422
  'data': JsonApiAttributeHierarchyPatch;
3417
3423
  }
@@ -3551,52 +3557,13 @@ export interface JsonApiAutomationIn {
3551
3557
  * API identifier of an object
3552
3558
  */
3553
3559
  'id': string;
3554
- 'attributes'?: JsonApiAutomationInAttributes;
3555
- 'relationships'?: JsonApiAutomationInRelationships;
3560
+ 'attributes'?: JsonApiAutomationPatchAttributes;
3561
+ 'relationships'?: JsonApiAutomationPatchRelationships;
3556
3562
  }
3557
3563
  export type JsonApiAutomationInTypeEnum = 'automation';
3558
- export interface JsonApiAutomationInAttributes {
3559
- 'title'?: string;
3560
- 'description'?: string;
3561
- 'tags'?: Array<string>;
3562
- 'areRelationsValid'?: boolean;
3563
- /**
3564
- * Additional details to be included in the automated message.
3565
- */
3566
- 'details'?: object;
3567
- 'metadata'?: JsonApiAutomationOutAttributesMetadata | null;
3568
- /**
3569
- * Current state of the automation.
3570
- */
3571
- 'state'?: JsonApiAutomationInAttributesStateEnum;
3572
- /**
3573
- * Specify automation evaluation mode.
3574
- */
3575
- 'evaluationMode'?: JsonApiAutomationInAttributesEvaluationModeEnum;
3576
- 'schedule'?: JsonApiAutomationOutAttributesSchedule;
3577
- 'alert'?: JsonApiAutomationOutAttributesAlert;
3578
- 'tabularExports'?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
3579
- 'visualExports'?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
3580
- 'imageExports'?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
3581
- 'rawExports'?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
3582
- 'slidesExports'?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
3583
- 'dashboardTabularExports'?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
3584
- /**
3585
- * External recipients of the automation action results.
3586
- */
3587
- 'externalRecipients'?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
3588
- }
3589
- export type JsonApiAutomationInAttributesStateEnum = 'ACTIVE' | 'PAUSED';
3590
- export type JsonApiAutomationInAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
3591
3564
  export interface JsonApiAutomationInDocument {
3592
3565
  'data': JsonApiAutomationIn;
3593
3566
  }
3594
- export interface JsonApiAutomationInRelationships {
3595
- 'notificationChannel'?: JsonApiAutomationOutRelationshipsNotificationChannel;
3596
- 'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
3597
- 'exportDefinitions'?: JsonApiAutomationOutRelationshipsExportDefinitions;
3598
- 'recipients'?: JsonApiAutomationOutRelationshipsRecipients;
3599
- }
3600
3567
  /**
3601
3568
  * The \\\"type\\\" and \\\"id\\\" to non-empty members.
3602
3569
  */
@@ -3808,13 +3775,52 @@ export interface JsonApiAutomationPatch {
3808
3775
  * API identifier of an object
3809
3776
  */
3810
3777
  'id': string;
3811
- 'attributes'?: JsonApiAutomationInAttributes;
3812
- 'relationships'?: JsonApiAutomationInRelationships;
3778
+ 'attributes'?: JsonApiAutomationPatchAttributes;
3779
+ 'relationships'?: JsonApiAutomationPatchRelationships;
3813
3780
  }
3814
3781
  export type JsonApiAutomationPatchTypeEnum = 'automation';
3782
+ export interface JsonApiAutomationPatchAttributes {
3783
+ 'title'?: string;
3784
+ 'description'?: string;
3785
+ 'tags'?: Array<string>;
3786
+ 'areRelationsValid'?: boolean;
3787
+ /**
3788
+ * Additional details to be included in the automated message.
3789
+ */
3790
+ 'details'?: object;
3791
+ 'metadata'?: JsonApiAutomationOutAttributesMetadata | null;
3792
+ /**
3793
+ * Current state of the automation.
3794
+ */
3795
+ 'state'?: JsonApiAutomationPatchAttributesStateEnum;
3796
+ /**
3797
+ * Specify automation evaluation mode.
3798
+ */
3799
+ 'evaluationMode'?: JsonApiAutomationPatchAttributesEvaluationModeEnum;
3800
+ 'schedule'?: JsonApiAutomationOutAttributesSchedule;
3801
+ 'alert'?: JsonApiAutomationOutAttributesAlert;
3802
+ 'tabularExports'?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
3803
+ 'visualExports'?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
3804
+ 'imageExports'?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
3805
+ 'rawExports'?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
3806
+ 'slidesExports'?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
3807
+ 'dashboardTabularExports'?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
3808
+ /**
3809
+ * External recipients of the automation action results.
3810
+ */
3811
+ 'externalRecipients'?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
3812
+ }
3813
+ export type JsonApiAutomationPatchAttributesStateEnum = 'ACTIVE' | 'PAUSED';
3814
+ export type JsonApiAutomationPatchAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
3815
3815
  export interface JsonApiAutomationPatchDocument {
3816
3816
  'data': JsonApiAutomationPatch;
3817
3817
  }
3818
+ export interface JsonApiAutomationPatchRelationships {
3819
+ 'notificationChannel'?: JsonApiAutomationOutRelationshipsNotificationChannel;
3820
+ 'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
3821
+ 'exportDefinitions'?: JsonApiAutomationOutRelationshipsExportDefinitions;
3822
+ 'recipients'?: JsonApiAutomationOutRelationshipsRecipients;
3823
+ }
3818
3824
  /**
3819
3825
  * The \\\"type\\\" and \\\"id\\\" to non-empty members.
3820
3826
  */
@@ -3893,16 +3899,9 @@ export interface JsonApiColorPaletteIn {
3893
3899
  * API identifier of an object
3894
3900
  */
3895
3901
  'id': string;
3896
- 'attributes': JsonApiColorPaletteInAttributes;
3902
+ 'attributes': JsonApiColorPaletteOutAttributes;
3897
3903
  }
3898
3904
  export type JsonApiColorPaletteInTypeEnum = 'colorPalette';
3899
- export interface JsonApiColorPaletteInAttributes {
3900
- 'name': string;
3901
- /**
3902
- * Free-form JSON content. Maximum supported length is 15000 characters.
3903
- */
3904
- 'content': object;
3905
- }
3906
3905
  export interface JsonApiColorPaletteInDocument {
3907
3906
  'data': JsonApiColorPaletteIn;
3908
3907
  }
@@ -3918,9 +3917,16 @@ export interface JsonApiColorPaletteOut {
3918
3917
  * API identifier of an object
3919
3918
  */
3920
3919
  'id': string;
3921
- 'attributes': JsonApiColorPaletteInAttributes;
3920
+ 'attributes': JsonApiColorPaletteOutAttributes;
3922
3921
  }
3923
3922
  export type JsonApiColorPaletteOutTypeEnum = 'colorPalette';
3923
+ export interface JsonApiColorPaletteOutAttributes {
3924
+ 'name': string;
3925
+ /**
3926
+ * Free-form JSON content. Maximum supported length is 15000 characters.
3927
+ */
3928
+ 'content': object;
3929
+ }
3924
3930
  export interface JsonApiColorPaletteOutDocument {
3925
3931
  'data': JsonApiColorPaletteOut;
3926
3932
  'links'?: ObjectLinks;
@@ -3942,7 +3948,7 @@ export interface JsonApiColorPaletteOutWithLinks {
3942
3948
  * API identifier of an object
3943
3949
  */
3944
3950
  'id': string;
3945
- 'attributes': JsonApiColorPaletteInAttributes;
3951
+ 'attributes': JsonApiColorPaletteOutAttributes;
3946
3952
  'links'?: ObjectLinks;
3947
3953
  }
3948
3954
  export type JsonApiColorPaletteOutWithLinksTypeEnum = 'colorPalette';
@@ -3983,16 +3989,9 @@ export interface JsonApiCookieSecurityConfigurationIn {
3983
3989
  * API identifier of an object
3984
3990
  */
3985
3991
  'id': string;
3986
- 'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
3992
+ 'attributes'?: JsonApiCookieSecurityConfigurationPatchAttributes;
3987
3993
  }
3988
3994
  export type JsonApiCookieSecurityConfigurationInTypeEnum = 'cookieSecurityConfiguration';
3989
- export interface JsonApiCookieSecurityConfigurationInAttributes {
3990
- 'lastRotation'?: string;
3991
- /**
3992
- * Length of interval between automatic rotations expressed in format of ISO 8601 duration
3993
- */
3994
- 'rotationInterval'?: string;
3995
- }
3996
3995
  export interface JsonApiCookieSecurityConfigurationInDocument {
3997
3996
  'data': JsonApiCookieSecurityConfigurationIn;
3998
3997
  }
@@ -4008,7 +4007,7 @@ export interface JsonApiCookieSecurityConfigurationOut {
4008
4007
  * API identifier of an object
4009
4008
  */
4010
4009
  'id': string;
4011
- 'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
4010
+ 'attributes'?: JsonApiCookieSecurityConfigurationPatchAttributes;
4012
4011
  }
4013
4012
  export type JsonApiCookieSecurityConfigurationOutTypeEnum = 'cookieSecurityConfiguration';
4014
4013
  export interface JsonApiCookieSecurityConfigurationOutDocument {
@@ -4027,9 +4026,16 @@ export interface JsonApiCookieSecurityConfigurationPatch {
4027
4026
  * API identifier of an object
4028
4027
  */
4029
4028
  'id': string;
4030
- 'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
4029
+ 'attributes'?: JsonApiCookieSecurityConfigurationPatchAttributes;
4031
4030
  }
4032
4031
  export type JsonApiCookieSecurityConfigurationPatchTypeEnum = 'cookieSecurityConfiguration';
4032
+ export interface JsonApiCookieSecurityConfigurationPatchAttributes {
4033
+ 'lastRotation'?: string;
4034
+ /**
4035
+ * Length of interval between automatic rotations expressed in format of ISO 8601 duration
4036
+ */
4037
+ 'rotationInterval'?: string;
4038
+ }
4033
4039
  export interface JsonApiCookieSecurityConfigurationPatchDocument {
4034
4040
  'data': JsonApiCookieSecurityConfigurationPatch;
4035
4041
  }
@@ -4045,12 +4051,9 @@ export interface JsonApiCspDirectiveIn {
4045
4051
  * API identifier of an object
4046
4052
  */
4047
4053
  'id': string;
4048
- 'attributes': JsonApiCspDirectiveInAttributes;
4054
+ 'attributes': JsonApiCspDirectiveOutAttributes;
4049
4055
  }
4050
4056
  export type JsonApiCspDirectiveInTypeEnum = 'cspDirective';
4051
- export interface JsonApiCspDirectiveInAttributes {
4052
- 'sources': Array<string>;
4053
- }
4054
4057
  export interface JsonApiCspDirectiveInDocument {
4055
4058
  'data': JsonApiCspDirectiveIn;
4056
4059
  }
@@ -4066,9 +4069,12 @@ export interface JsonApiCspDirectiveOut {
4066
4069
  * API identifier of an object
4067
4070
  */
4068
4071
  'id': string;
4069
- 'attributes': JsonApiCspDirectiveInAttributes;
4072
+ 'attributes': JsonApiCspDirectiveOutAttributes;
4070
4073
  }
4071
4074
  export type JsonApiCspDirectiveOutTypeEnum = 'cspDirective';
4075
+ export interface JsonApiCspDirectiveOutAttributes {
4076
+ 'sources': Array<string>;
4077
+ }
4072
4078
  export interface JsonApiCspDirectiveOutDocument {
4073
4079
  'data': JsonApiCspDirectiveOut;
4074
4080
  'links'?: ObjectLinks;
@@ -4090,7 +4096,7 @@ export interface JsonApiCspDirectiveOutWithLinks {
4090
4096
  * API identifier of an object
4091
4097
  */
4092
4098
  'id': string;
4093
- 'attributes': JsonApiCspDirectiveInAttributes;
4099
+ 'attributes': JsonApiCspDirectiveOutAttributes;
4094
4100
  'links'?: ObjectLinks;
4095
4101
  }
4096
4102
  export type JsonApiCspDirectiveOutWithLinksTypeEnum = 'cspDirective';
@@ -4237,13 +4243,9 @@ export interface JsonApiCustomGeoCollectionIn {
4237
4243
  * API identifier of an object
4238
4244
  */
4239
4245
  'id': string;
4240
- 'attributes'?: JsonApiCustomGeoCollectionInAttributes;
4246
+ 'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
4241
4247
  }
4242
4248
  export type JsonApiCustomGeoCollectionInTypeEnum = 'customGeoCollection';
4243
- export interface JsonApiCustomGeoCollectionInAttributes {
4244
- 'name'?: string | null;
4245
- 'description'?: string | null;
4246
- }
4247
4249
  export interface JsonApiCustomGeoCollectionInDocument {
4248
4250
  'data': JsonApiCustomGeoCollectionIn;
4249
4251
  }
@@ -4259,7 +4261,7 @@ export interface JsonApiCustomGeoCollectionOut {
4259
4261
  * API identifier of an object
4260
4262
  */
4261
4263
  'id': string;
4262
- 'attributes'?: JsonApiCustomGeoCollectionInAttributes;
4264
+ 'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
4263
4265
  }
4264
4266
  export type JsonApiCustomGeoCollectionOutTypeEnum = 'customGeoCollection';
4265
4267
  export interface JsonApiCustomGeoCollectionOutDocument {
@@ -4283,7 +4285,7 @@ export interface JsonApiCustomGeoCollectionOutWithLinks {
4283
4285
  * API identifier of an object
4284
4286
  */
4285
4287
  'id': string;
4286
- 'attributes'?: JsonApiCustomGeoCollectionInAttributes;
4288
+ 'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
4287
4289
  'links'?: ObjectLinks;
4288
4290
  }
4289
4291
  export type JsonApiCustomGeoCollectionOutWithLinksTypeEnum = 'customGeoCollection';
@@ -4299,9 +4301,13 @@ export interface JsonApiCustomGeoCollectionPatch {
4299
4301
  * API identifier of an object
4300
4302
  */
4301
4303
  'id': string;
4302
- 'attributes'?: JsonApiCustomGeoCollectionInAttributes;
4304
+ 'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
4303
4305
  }
4304
4306
  export type JsonApiCustomGeoCollectionPatchTypeEnum = 'customGeoCollection';
4307
+ export interface JsonApiCustomGeoCollectionPatchAttributes {
4308
+ 'name'?: string | null;
4309
+ 'description'?: string | null;
4310
+ }
4305
4311
  export interface JsonApiCustomGeoCollectionPatchDocument {
4306
4312
  'data': JsonApiCustomGeoCollectionPatch;
4307
4313
  }
@@ -4317,7 +4323,7 @@ export interface JsonApiDashboardPluginIn {
4317
4323
  * API identifier of an object
4318
4324
  */
4319
4325
  'id': string;
4320
- 'attributes'?: JsonApiDashboardPluginPostOptionalIdAttributes;
4326
+ 'attributes'?: JsonApiDashboardPluginPatchAttributes;
4321
4327
  }
4322
4328
  export type JsonApiDashboardPluginInTypeEnum = 'dashboardPlugin';
4323
4329
  export interface JsonApiDashboardPluginInDocument {
@@ -4417,9 +4423,19 @@ export interface JsonApiDashboardPluginPatch {
4417
4423
  * API identifier of an object
4418
4424
  */
4419
4425
  'id': string;
4420
- 'attributes'?: JsonApiDashboardPluginPostOptionalIdAttributes;
4426
+ 'attributes'?: JsonApiDashboardPluginPatchAttributes;
4421
4427
  }
4422
4428
  export type JsonApiDashboardPluginPatchTypeEnum = 'dashboardPlugin';
4429
+ export interface JsonApiDashboardPluginPatchAttributes {
4430
+ 'title'?: string;
4431
+ 'description'?: string;
4432
+ 'tags'?: Array<string>;
4433
+ 'areRelationsValid'?: boolean;
4434
+ /**
4435
+ * Free-form JSON content. Maximum supported length is 250000 characters.
4436
+ */
4437
+ 'content'?: object;
4438
+ }
4423
4439
  export interface JsonApiDashboardPluginPatchDocument {
4424
4440
  'data': JsonApiDashboardPluginPatch;
4425
4441
  }
@@ -4435,19 +4451,9 @@ export interface JsonApiDashboardPluginPostOptionalId {
4435
4451
  * API identifier of an object
4436
4452
  */
4437
4453
  'id'?: string;
4438
- 'attributes'?: JsonApiDashboardPluginPostOptionalIdAttributes;
4454
+ 'attributes'?: JsonApiDashboardPluginPatchAttributes;
4439
4455
  }
4440
4456
  export type JsonApiDashboardPluginPostOptionalIdTypeEnum = 'dashboardPlugin';
4441
- export interface JsonApiDashboardPluginPostOptionalIdAttributes {
4442
- 'title'?: string;
4443
- 'description'?: string;
4444
- 'tags'?: Array<string>;
4445
- 'areRelationsValid'?: boolean;
4446
- /**
4447
- * Free-form JSON content. Maximum supported length is 250000 characters.
4448
- */
4449
- 'content'?: object;
4450
- }
4451
4457
  export interface JsonApiDashboardPluginPostOptionalIdDocument {
4452
4458
  'data': JsonApiDashboardPluginPostOptionalId;
4453
4459
  }
@@ -4562,7 +4568,7 @@ export interface JsonApiDataSourceInAttributes {
4562
4568
  /**
4563
4569
  * Additional parameters to be used when connecting to the database providing the data for the data source.
4564
4570
  */
4565
- 'parameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
4571
+ 'parameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
4566
4572
  /**
4567
4573
  * Determines how the results coming from a particular datasource should be cached.
4568
4574
  */
@@ -4574,10 +4580,6 @@ export interface JsonApiDataSourceInAttributes {
4574
4580
  }
4575
4581
  export 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';
4576
4582
  export type JsonApiDataSourceInAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
4577
- export interface JsonApiDataSourceInAttributesParametersInner {
4578
- 'name': string;
4579
- 'value': string;
4580
- }
4581
4583
  export interface JsonApiDataSourceInDocument {
4582
4584
  'data': JsonApiDataSourceIn;
4583
4585
  }
@@ -4625,11 +4627,11 @@ export interface JsonApiDataSourceOutAttributes {
4625
4627
  /**
4626
4628
  * Additional parameters to be used when connecting to the database providing the data for the data source.
4627
4629
  */
4628
- 'parameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
4630
+ 'parameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
4629
4631
  /**
4630
4632
  * Decoded parameters to be used when connecting to the database providing the data for the data source.
4631
4633
  */
4632
- 'decodedParameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
4634
+ 'decodedParameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
4633
4635
  /**
4634
4636
  * Determines how the results coming from a particular datasource should be cached.
4635
4637
  */
@@ -4742,7 +4744,7 @@ export interface JsonApiDataSourcePatchAttributes {
4742
4744
  /**
4743
4745
  * Additional parameters to be used when connecting to the database providing the data for the data source.
4744
4746
  */
4745
- 'parameters'?: Array<JsonApiDataSourceInAttributesParametersInner> | null;
4747
+ 'parameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
4746
4748
  /**
4747
4749
  * Determines how the results coming from a particular datasource should be cached.
4748
4750
  */
@@ -4754,6 +4756,10 @@ export interface JsonApiDataSourcePatchAttributes {
4754
4756
  }
4755
4757
  export 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';
4756
4758
  export type JsonApiDataSourcePatchAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
4759
+ export interface JsonApiDataSourcePatchAttributesParametersInner {
4760
+ 'name': string;
4761
+ 'value': string;
4762
+ }
4757
4763
  export interface JsonApiDataSourcePatchDocument {
4758
4764
  'data': JsonApiDataSourcePatch;
4759
4765
  }
@@ -4996,8 +5002,8 @@ export interface JsonApiExportDefinitionIn {
4996
5002
  * API identifier of an object
4997
5003
  */
4998
5004
  'id': string;
4999
- 'attributes'?: JsonApiExportDefinitionPostOptionalIdAttributes;
5000
- 'relationships'?: JsonApiExportDefinitionPostOptionalIdRelationships;
5005
+ 'attributes'?: JsonApiExportDefinitionPatchAttributes;
5006
+ 'relationships'?: JsonApiExportDefinitionPatchRelationships;
5001
5007
  }
5002
5008
  export type JsonApiExportDefinitionInTypeEnum = 'exportDefinition';
5003
5009
  export interface JsonApiExportDefinitionInDocument {
@@ -5115,13 +5121,24 @@ export interface JsonApiExportDefinitionPatch {
5115
5121
  * API identifier of an object
5116
5122
  */
5117
5123
  'id': string;
5118
- 'attributes'?: JsonApiExportDefinitionPostOptionalIdAttributes;
5119
- 'relationships'?: JsonApiExportDefinitionPostOptionalIdRelationships;
5124
+ 'attributes'?: JsonApiExportDefinitionPatchAttributes;
5125
+ 'relationships'?: JsonApiExportDefinitionPatchRelationships;
5120
5126
  }
5121
5127
  export type JsonApiExportDefinitionPatchTypeEnum = 'exportDefinition';
5128
+ export interface JsonApiExportDefinitionPatchAttributes {
5129
+ 'title'?: string;
5130
+ 'description'?: string;
5131
+ 'tags'?: Array<string>;
5132
+ 'requestPayload'?: JsonApiExportDefinitionOutAttributesRequestPayload;
5133
+ 'areRelationsValid'?: boolean;
5134
+ }
5122
5135
  export interface JsonApiExportDefinitionPatchDocument {
5123
5136
  'data': JsonApiExportDefinitionPatch;
5124
5137
  }
5138
+ export interface JsonApiExportDefinitionPatchRelationships {
5139
+ 'visualizationObject'?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
5140
+ 'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
5141
+ }
5125
5142
  /**
5126
5143
  * JSON:API representation of exportDefinition entity.
5127
5144
  */
@@ -5134,24 +5151,13 @@ export interface JsonApiExportDefinitionPostOptionalId {
5134
5151
  * API identifier of an object
5135
5152
  */
5136
5153
  'id'?: string;
5137
- 'attributes'?: JsonApiExportDefinitionPostOptionalIdAttributes;
5138
- 'relationships'?: JsonApiExportDefinitionPostOptionalIdRelationships;
5154
+ 'attributes'?: JsonApiExportDefinitionPatchAttributes;
5155
+ 'relationships'?: JsonApiExportDefinitionPatchRelationships;
5139
5156
  }
5140
5157
  export type JsonApiExportDefinitionPostOptionalIdTypeEnum = 'exportDefinition';
5141
- export interface JsonApiExportDefinitionPostOptionalIdAttributes {
5142
- 'title'?: string;
5143
- 'description'?: string;
5144
- 'tags'?: Array<string>;
5145
- 'requestPayload'?: JsonApiExportDefinitionOutAttributesRequestPayload;
5146
- 'areRelationsValid'?: boolean;
5147
- }
5148
5158
  export interface JsonApiExportDefinitionPostOptionalIdDocument {
5149
5159
  'data': JsonApiExportDefinitionPostOptionalId;
5150
5160
  }
5151
- export interface JsonApiExportDefinitionPostOptionalIdRelationships {
5152
- 'visualizationObject'?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
5153
- 'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
5154
- }
5155
5161
  /**
5156
5162
  * JSON:API representation of exportTemplate entity.
5157
5163
  */
@@ -5164,42 +5170,9 @@ export interface JsonApiExportTemplateIn {
5164
5170
  * API identifier of an object
5165
5171
  */
5166
5172
  'id': string;
5167
- 'attributes': JsonApiExportTemplateInAttributes;
5173
+ 'attributes': JsonApiExportTemplateOutAttributes;
5168
5174
  }
5169
5175
  export type JsonApiExportTemplateInTypeEnum = 'exportTemplate';
5170
- export interface JsonApiExportTemplateInAttributes {
5171
- /**
5172
- * User-facing name of the Slides template.
5173
- */
5174
- 'name': string;
5175
- 'dashboardSlidesTemplate'?: JsonApiExportTemplateInAttributesDashboardSlidesTemplate | null;
5176
- 'widgetSlidesTemplate'?: JsonApiExportTemplateInAttributesWidgetSlidesTemplate | null;
5177
- }
5178
- /**
5179
- * Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
5180
- */
5181
- export interface JsonApiExportTemplateInAttributesDashboardSlidesTemplate {
5182
- /**
5183
- * Export types this template applies to.
5184
- */
5185
- 'appliedOn': Array<JsonApiExportTemplateInAttributesDashboardSlidesTemplateAppliedOnEnum>;
5186
- 'coverSlide'?: CoverSlideTemplate | null;
5187
- 'introSlide'?: IntroSlideTemplate | null;
5188
- 'sectionSlide'?: SectionSlideTemplate | null;
5189
- 'contentSlide'?: ContentSlideTemplate | null;
5190
- }
5191
- export type JsonApiExportTemplateInAttributesDashboardSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
5192
- /**
5193
- * Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
5194
- */
5195
- export interface JsonApiExportTemplateInAttributesWidgetSlidesTemplate {
5196
- /**
5197
- * Export types this template applies to.
5198
- */
5199
- 'appliedOn': Array<JsonApiExportTemplateInAttributesWidgetSlidesTemplateAppliedOnEnum>;
5200
- 'contentSlide'?: ContentSlideTemplate | null;
5201
- }
5202
- export type JsonApiExportTemplateInAttributesWidgetSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
5203
5176
  export interface JsonApiExportTemplateInDocument {
5204
5177
  'data': JsonApiExportTemplateIn;
5205
5178
  }
@@ -5215,9 +5188,17 @@ export interface JsonApiExportTemplateOut {
5215
5188
  * API identifier of an object
5216
5189
  */
5217
5190
  'id': string;
5218
- 'attributes': JsonApiExportTemplateInAttributes;
5191
+ 'attributes': JsonApiExportTemplateOutAttributes;
5219
5192
  }
5220
5193
  export type JsonApiExportTemplateOutTypeEnum = 'exportTemplate';
5194
+ export interface JsonApiExportTemplateOutAttributes {
5195
+ /**
5196
+ * User-facing name of the Slides template.
5197
+ */
5198
+ 'name': string;
5199
+ 'dashboardSlidesTemplate'?: JsonApiExportTemplatePatchAttributesDashboardSlidesTemplate | null;
5200
+ 'widgetSlidesTemplate'?: JsonApiExportTemplatePatchAttributesWidgetSlidesTemplate | null;
5201
+ }
5221
5202
  export interface JsonApiExportTemplateOutDocument {
5222
5203
  'data': JsonApiExportTemplateOut;
5223
5204
  'links'?: ObjectLinks;
@@ -5239,7 +5220,7 @@ export interface JsonApiExportTemplateOutWithLinks {
5239
5220
  * API identifier of an object
5240
5221
  */
5241
5222
  'id': string;
5242
- 'attributes': JsonApiExportTemplateInAttributes;
5223
+ 'attributes': JsonApiExportTemplateOutAttributes;
5243
5224
  'links'?: ObjectLinks;
5244
5225
  }
5245
5226
  export type JsonApiExportTemplateOutWithLinksTypeEnum = 'exportTemplate';
@@ -5263,9 +5244,34 @@ export interface JsonApiExportTemplatePatchAttributes {
5263
5244
  * User-facing name of the Slides template.
5264
5245
  */
5265
5246
  'name'?: string;
5266
- 'dashboardSlidesTemplate'?: JsonApiExportTemplateInAttributesDashboardSlidesTemplate | null;
5267
- 'widgetSlidesTemplate'?: JsonApiExportTemplateInAttributesWidgetSlidesTemplate | null;
5247
+ 'dashboardSlidesTemplate'?: JsonApiExportTemplatePatchAttributesDashboardSlidesTemplate | null;
5248
+ 'widgetSlidesTemplate'?: JsonApiExportTemplatePatchAttributesWidgetSlidesTemplate | null;
5249
+ }
5250
+ /**
5251
+ * Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
5252
+ */
5253
+ export interface JsonApiExportTemplatePatchAttributesDashboardSlidesTemplate {
5254
+ /**
5255
+ * Export types this template applies to.
5256
+ */
5257
+ 'appliedOn': Array<JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum>;
5258
+ 'coverSlide'?: CoverSlideTemplate | null;
5259
+ 'introSlide'?: IntroSlideTemplate | null;
5260
+ 'sectionSlide'?: SectionSlideTemplate | null;
5261
+ 'contentSlide'?: ContentSlideTemplate | null;
5262
+ }
5263
+ export type JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
5264
+ /**
5265
+ * Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
5266
+ */
5267
+ export interface JsonApiExportTemplatePatchAttributesWidgetSlidesTemplate {
5268
+ /**
5269
+ * Export types this template applies to.
5270
+ */
5271
+ 'appliedOn': Array<JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum>;
5272
+ 'contentSlide'?: ContentSlideTemplate | null;
5268
5273
  }
5274
+ export type JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
5269
5275
  export interface JsonApiExportTemplatePatchDocument {
5270
5276
  'data': JsonApiExportTemplatePatch;
5271
5277
  }
@@ -5281,7 +5287,7 @@ export interface JsonApiExportTemplatePostOptionalId {
5281
5287
  * API identifier of an object
5282
5288
  */
5283
5289
  'id'?: string;
5284
- 'attributes': JsonApiExportTemplateInAttributes;
5290
+ 'attributes': JsonApiExportTemplateOutAttributes;
5285
5291
  }
5286
5292
  export type JsonApiExportTemplatePostOptionalIdTypeEnum = 'exportTemplate';
5287
5293
  export interface JsonApiExportTemplatePostOptionalIdDocument {
@@ -5662,10 +5668,36 @@ export interface JsonApiIdentityProviderIn {
5662
5668
  * API identifier of an object
5663
5669
  */
5664
5670
  'id': string;
5665
- 'attributes'?: JsonApiIdentityProviderInAttributes;
5671
+ 'attributes'?: JsonApiIdentityProviderPatchAttributes;
5666
5672
  }
5667
5673
  export type JsonApiIdentityProviderInTypeEnum = 'identityProvider';
5668
- export interface JsonApiIdentityProviderInAttributes {
5674
+ export interface JsonApiIdentityProviderInDocument {
5675
+ 'data': JsonApiIdentityProviderIn;
5676
+ }
5677
+ /**
5678
+ * The \\\"type\\\" and \\\"id\\\" to non-empty members.
5679
+ */
5680
+ export interface JsonApiIdentityProviderLinkage {
5681
+ 'id': string;
5682
+ 'type': JsonApiIdentityProviderLinkageTypeEnum;
5683
+ }
5684
+ export type JsonApiIdentityProviderLinkageTypeEnum = 'identityProvider';
5685
+ /**
5686
+ * JSON:API representation of identityProvider entity.
5687
+ */
5688
+ export interface JsonApiIdentityProviderOut {
5689
+ /**
5690
+ * Object type
5691
+ */
5692
+ 'type': JsonApiIdentityProviderOutTypeEnum;
5693
+ /**
5694
+ * API identifier of an object
5695
+ */
5696
+ 'id': string;
5697
+ 'attributes'?: JsonApiIdentityProviderOutAttributes;
5698
+ }
5699
+ export type JsonApiIdentityProviderOutTypeEnum = 'identityProvider';
5700
+ export interface JsonApiIdentityProviderOutAttributes {
5669
5701
  /**
5670
5702
  * 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.
5671
5703
  */
@@ -5676,18 +5708,10 @@ export interface JsonApiIdentityProviderInAttributes {
5676
5708
  'customClaimMapping'?: {
5677
5709
  [key: string]: string;
5678
5710
  };
5679
- /**
5680
- * 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.
5681
- */
5682
- 'samlMetadata'?: string;
5683
5711
  /**
5684
5712
  * The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
5685
5713
  */
5686
5714
  'oauthClientId'?: string;
5687
- /**
5688
- * The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
5689
- */
5690
- 'oauthClientSecret'?: string;
5691
5715
  /**
5692
5716
  * The location of your OIDC provider. This field is mandatory for OIDC IdP.
5693
5717
  */
@@ -5713,36 +5737,50 @@ export interface JsonApiIdentityProviderInAttributes {
5713
5737
  /**
5714
5738
  * 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.
5715
5739
  */
5716
- 'idpType'?: JsonApiIdentityProviderInAttributesIdpTypeEnum;
5740
+ 'idpType'?: JsonApiIdentityProviderOutAttributesIdpTypeEnum;
5717
5741
  }
5718
- export type JsonApiIdentityProviderInAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
5719
- export interface JsonApiIdentityProviderInDocument {
5720
- 'data': JsonApiIdentityProviderIn;
5742
+ export type JsonApiIdentityProviderOutAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
5743
+ export interface JsonApiIdentityProviderOutDocument {
5744
+ 'data': JsonApiIdentityProviderOut;
5745
+ 'links'?: ObjectLinks;
5721
5746
  }
5722
5747
  /**
5723
- * The \\\"type\\\" and \\\"id\\\" to non-empty members.
5748
+ * A JSON:API document with a list of resources
5724
5749
  */
5725
- export interface JsonApiIdentityProviderLinkage {
5726
- 'id': string;
5727
- 'type': JsonApiIdentityProviderLinkageTypeEnum;
5750
+ export interface JsonApiIdentityProviderOutList {
5751
+ 'data': Array<JsonApiIdentityProviderOutWithLinks>;
5752
+ 'links'?: ListLinks;
5753
+ 'meta'?: JsonApiAggregatedFactOutListMeta;
5728
5754
  }
5729
- export type JsonApiIdentityProviderLinkageTypeEnum = 'identityProvider';
5755
+ export interface JsonApiIdentityProviderOutWithLinks {
5756
+ /**
5757
+ * Object type
5758
+ */
5759
+ 'type': JsonApiIdentityProviderOutWithLinksTypeEnum;
5760
+ /**
5761
+ * API identifier of an object
5762
+ */
5763
+ 'id': string;
5764
+ 'attributes'?: JsonApiIdentityProviderOutAttributes;
5765
+ 'links'?: ObjectLinks;
5766
+ }
5767
+ export type JsonApiIdentityProviderOutWithLinksTypeEnum = 'identityProvider';
5730
5768
  /**
5731
- * JSON:API representation of identityProvider entity.
5769
+ * JSON:API representation of patching identityProvider entity.
5732
5770
  */
5733
- export interface JsonApiIdentityProviderOut {
5771
+ export interface JsonApiIdentityProviderPatch {
5734
5772
  /**
5735
5773
  * Object type
5736
5774
  */
5737
- 'type': JsonApiIdentityProviderOutTypeEnum;
5775
+ 'type': JsonApiIdentityProviderPatchTypeEnum;
5738
5776
  /**
5739
5777
  * API identifier of an object
5740
5778
  */
5741
5779
  'id': string;
5742
- 'attributes'?: JsonApiIdentityProviderOutAttributes;
5780
+ 'attributes'?: JsonApiIdentityProviderPatchAttributes;
5743
5781
  }
5744
- export type JsonApiIdentityProviderOutTypeEnum = 'identityProvider';
5745
- export interface JsonApiIdentityProviderOutAttributes {
5782
+ export type JsonApiIdentityProviderPatchTypeEnum = 'identityProvider';
5783
+ export interface JsonApiIdentityProviderPatchAttributes {
5746
5784
  /**
5747
5785
  * 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.
5748
5786
  */
@@ -5753,10 +5791,18 @@ export interface JsonApiIdentityProviderOutAttributes {
5753
5791
  'customClaimMapping'?: {
5754
5792
  [key: string]: string;
5755
5793
  };
5794
+ /**
5795
+ * 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.
5796
+ */
5797
+ 'samlMetadata'?: string;
5756
5798
  /**
5757
5799
  * The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
5758
5800
  */
5759
5801
  'oauthClientId'?: string;
5802
+ /**
5803
+ * The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
5804
+ */
5805
+ 'oauthClientSecret'?: string;
5760
5806
  /**
5761
5807
  * The location of your OIDC provider. This field is mandatory for OIDC IdP.
5762
5808
  */
@@ -5782,49 +5828,9 @@ export interface JsonApiIdentityProviderOutAttributes {
5782
5828
  /**
5783
5829
  * 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.
5784
5830
  */
5785
- 'idpType'?: JsonApiIdentityProviderOutAttributesIdpTypeEnum;
5786
- }
5787
- export type JsonApiIdentityProviderOutAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
5788
- export interface JsonApiIdentityProviderOutDocument {
5789
- 'data': JsonApiIdentityProviderOut;
5790
- 'links'?: ObjectLinks;
5791
- }
5792
- /**
5793
- * A JSON:API document with a list of resources
5794
- */
5795
- export interface JsonApiIdentityProviderOutList {
5796
- 'data': Array<JsonApiIdentityProviderOutWithLinks>;
5797
- 'links'?: ListLinks;
5798
- 'meta'?: JsonApiAggregatedFactOutListMeta;
5799
- }
5800
- export interface JsonApiIdentityProviderOutWithLinks {
5801
- /**
5802
- * Object type
5803
- */
5804
- 'type': JsonApiIdentityProviderOutWithLinksTypeEnum;
5805
- /**
5806
- * API identifier of an object
5807
- */
5808
- 'id': string;
5809
- 'attributes'?: JsonApiIdentityProviderOutAttributes;
5810
- 'links'?: ObjectLinks;
5831
+ 'idpType'?: JsonApiIdentityProviderPatchAttributesIdpTypeEnum;
5811
5832
  }
5812
- export type JsonApiIdentityProviderOutWithLinksTypeEnum = 'identityProvider';
5813
- /**
5814
- * JSON:API representation of patching identityProvider entity.
5815
- */
5816
- export interface JsonApiIdentityProviderPatch {
5817
- /**
5818
- * Object type
5819
- */
5820
- 'type': JsonApiIdentityProviderPatchTypeEnum;
5821
- /**
5822
- * API identifier of an object
5823
- */
5824
- 'id': string;
5825
- 'attributes'?: JsonApiIdentityProviderInAttributes;
5826
- }
5827
- export type JsonApiIdentityProviderPatchTypeEnum = 'identityProvider';
5833
+ export type JsonApiIdentityProviderPatchAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
5828
5834
  export interface JsonApiIdentityProviderPatchDocument {
5829
5835
  'data': JsonApiIdentityProviderPatch;
5830
5836
  }
@@ -5840,12 +5846,9 @@ export interface JsonApiJwkIn {
5840
5846
  * API identifier of an object
5841
5847
  */
5842
5848
  'id': string;
5843
- 'attributes'?: JsonApiJwkInAttributes;
5849
+ 'attributes'?: JsonApiJwkPatchAttributes;
5844
5850
  }
5845
5851
  export type JsonApiJwkInTypeEnum = 'jwk';
5846
- export interface JsonApiJwkInAttributes {
5847
- 'content'?: RsaSpecification;
5848
- }
5849
5852
  export interface JsonApiJwkInDocument {
5850
5853
  'data': JsonApiJwkIn;
5851
5854
  }
@@ -5861,7 +5864,7 @@ export interface JsonApiJwkOut {
5861
5864
  * API identifier of an object
5862
5865
  */
5863
5866
  'id': string;
5864
- 'attributes'?: JsonApiJwkInAttributes;
5867
+ 'attributes'?: JsonApiJwkPatchAttributes;
5865
5868
  }
5866
5869
  export type JsonApiJwkOutTypeEnum = 'jwk';
5867
5870
  export interface JsonApiJwkOutDocument {
@@ -5885,7 +5888,7 @@ export interface JsonApiJwkOutWithLinks {
5885
5888
  * API identifier of an object
5886
5889
  */
5887
5890
  'id': string;
5888
- 'attributes'?: JsonApiJwkInAttributes;
5891
+ 'attributes'?: JsonApiJwkPatchAttributes;
5889
5892
  'links'?: ObjectLinks;
5890
5893
  }
5891
5894
  export type JsonApiJwkOutWithLinksTypeEnum = 'jwk';
@@ -5901,9 +5904,12 @@ export interface JsonApiJwkPatch {
5901
5904
  * API identifier of an object
5902
5905
  */
5903
5906
  'id': string;
5904
- 'attributes'?: JsonApiJwkInAttributes;
5907
+ 'attributes'?: JsonApiJwkPatchAttributes;
5905
5908
  }
5906
5909
  export type JsonApiJwkPatchTypeEnum = 'jwk';
5910
+ export interface JsonApiJwkPatchAttributes {
5911
+ 'content'?: RsaSpecification;
5912
+ }
5907
5913
  export interface JsonApiJwkPatchDocument {
5908
5914
  'data': JsonApiJwkPatch;
5909
5915
  }
@@ -6507,40 +6513,9 @@ export interface JsonApiLlmProviderIn {
6507
6513
  * API identifier of an object
6508
6514
  */
6509
6515
  'id': string;
6510
- 'attributes': JsonApiLlmProviderInAttributes;
6516
+ 'attributes': JsonApiLlmProviderOutAttributes;
6511
6517
  }
6512
6518
  export type JsonApiLlmProviderInTypeEnum = 'llmProvider';
6513
- export interface JsonApiLlmProviderInAttributes {
6514
- 'name'?: string | null;
6515
- /**
6516
- * Description of the LLM Provider.
6517
- */
6518
- 'description'?: string | null;
6519
- 'providerConfig': JsonApiLlmProviderInAttributesProviderConfig;
6520
- /**
6521
- * List of LLM models available for this provider.
6522
- */
6523
- 'models': Array<JsonApiLlmProviderInAttributesModelsInner> | null;
6524
- }
6525
- /**
6526
- * LLM Model configuration (id, family) within a provider.
6527
- */
6528
- export interface JsonApiLlmProviderInAttributesModelsInner {
6529
- /**
6530
- * Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
6531
- */
6532
- 'id': string;
6533
- /**
6534
- * Family of LLM models.
6535
- */
6536
- 'family': JsonApiLlmProviderInAttributesModelsInnerFamilyEnum;
6537
- }
6538
- export type JsonApiLlmProviderInAttributesModelsInnerFamilyEnum = 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE';
6539
- /**
6540
- * @type JsonApiLlmProviderInAttributesProviderConfig
6541
- * Provider-specific configuration including authentication.
6542
- */
6543
- export type JsonApiLlmProviderInAttributesProviderConfig = AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
6544
6519
  export interface JsonApiLlmProviderInDocument {
6545
6520
  'data': JsonApiLlmProviderIn;
6546
6521
  }
@@ -6556,9 +6531,21 @@ export interface JsonApiLlmProviderOut {
6556
6531
  * API identifier of an object
6557
6532
  */
6558
6533
  'id': string;
6559
- 'attributes': JsonApiLlmProviderInAttributes;
6534
+ 'attributes': JsonApiLlmProviderOutAttributes;
6560
6535
  }
6561
6536
  export type JsonApiLlmProviderOutTypeEnum = 'llmProvider';
6537
+ export interface JsonApiLlmProviderOutAttributes {
6538
+ 'name'?: string | null;
6539
+ /**
6540
+ * Description of the LLM Provider.
6541
+ */
6542
+ 'description'?: string | null;
6543
+ 'providerConfig': JsonApiLlmProviderPatchAttributesProviderConfig;
6544
+ /**
6545
+ * List of LLM models available for this provider.
6546
+ */
6547
+ 'models': Array<JsonApiLlmProviderPatchAttributesModelsInner> | null;
6548
+ }
6562
6549
  export interface JsonApiLlmProviderOutDocument {
6563
6550
  'data': JsonApiLlmProviderOut;
6564
6551
  'links'?: ObjectLinks;
@@ -6580,7 +6567,7 @@ export interface JsonApiLlmProviderOutWithLinks {
6580
6567
  * API identifier of an object
6581
6568
  */
6582
6569
  'id': string;
6583
- 'attributes': JsonApiLlmProviderInAttributes;
6570
+ 'attributes': JsonApiLlmProviderOutAttributes;
6584
6571
  'links'?: ObjectLinks;
6585
6572
  }
6586
6573
  export type JsonApiLlmProviderOutWithLinksTypeEnum = 'llmProvider';
@@ -6605,12 +6592,31 @@ export interface JsonApiLlmProviderPatchAttributes {
6605
6592
  * Description of the LLM Provider.
6606
6593
  */
6607
6594
  'description'?: string | null;
6608
- 'providerConfig'?: JsonApiLlmProviderInAttributesProviderConfig;
6595
+ 'providerConfig'?: JsonApiLlmProviderPatchAttributesProviderConfig;
6609
6596
  /**
6610
6597
  * List of LLM models available for this provider.
6611
6598
  */
6612
- 'models'?: Array<JsonApiLlmProviderInAttributesModelsInner> | null;
6599
+ 'models'?: Array<JsonApiLlmProviderPatchAttributesModelsInner> | null;
6600
+ }
6601
+ /**
6602
+ * LLM Model configuration (id, family) within a provider.
6603
+ */
6604
+ export interface JsonApiLlmProviderPatchAttributesModelsInner {
6605
+ /**
6606
+ * Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
6607
+ */
6608
+ 'id': string;
6609
+ /**
6610
+ * Family of LLM models.
6611
+ */
6612
+ 'family': JsonApiLlmProviderPatchAttributesModelsInnerFamilyEnum;
6613
6613
  }
6614
+ export type JsonApiLlmProviderPatchAttributesModelsInnerFamilyEnum = 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE';
6615
+ /**
6616
+ * @type JsonApiLlmProviderPatchAttributesProviderConfig
6617
+ * Provider-specific configuration including authentication.
6618
+ */
6619
+ export type JsonApiLlmProviderPatchAttributesProviderConfig = AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
6614
6620
  export interface JsonApiLlmProviderPatchDocument {
6615
6621
  'data': JsonApiLlmProviderPatch;
6616
6622
  }
@@ -7038,42 +7044,9 @@ export interface JsonApiNotificationChannelIn {
7038
7044
  * API identifier of an object
7039
7045
  */
7040
7046
  'id': string;
7041
- 'attributes'?: JsonApiNotificationChannelInAttributes;
7047
+ 'attributes'?: JsonApiNotificationChannelPatchAttributes;
7042
7048
  }
7043
7049
  export type JsonApiNotificationChannelInTypeEnum = 'notificationChannel';
7044
- export interface JsonApiNotificationChannelInAttributes {
7045
- 'name'?: string | null;
7046
- 'description'?: string | null;
7047
- 'destination'?: JsonApiNotificationChannelInAttributesDestination;
7048
- /**
7049
- * 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}
7050
- */
7051
- 'customDashboardUrl'?: string;
7052
- /**
7053
- * 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
7054
- */
7055
- 'dashboardLinkVisibility'?: JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum;
7056
- /**
7057
- * 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}}
7058
- */
7059
- 'notificationSource'?: string;
7060
- /**
7061
- * 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
7062
- */
7063
- 'allowedRecipients'?: JsonApiNotificationChannelInAttributesAllowedRecipientsEnum;
7064
- /**
7065
- * 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
7066
- */
7067
- 'inPlatformNotification'?: JsonApiNotificationChannelInAttributesInPlatformNotificationEnum;
7068
- }
7069
- export type JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
7070
- export type JsonApiNotificationChannelInAttributesAllowedRecipientsEnum = 'CREATOR' | 'INTERNAL' | 'EXTERNAL';
7071
- export type JsonApiNotificationChannelInAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
7072
- /**
7073
- * @type JsonApiNotificationChannelInAttributesDestination
7074
- * The destination where the notifications are to be sent.
7075
- */
7076
- export type JsonApiNotificationChannelInAttributesDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
7077
7050
  export interface JsonApiNotificationChannelInDocument {
7078
7051
  'data': JsonApiNotificationChannelIn;
7079
7052
  }
@@ -7103,7 +7076,7 @@ export type JsonApiNotificationChannelOutTypeEnum = 'notificationChannel';
7103
7076
  export interface JsonApiNotificationChannelOutAttributes {
7104
7077
  'name'?: string | null;
7105
7078
  'description'?: string | null;
7106
- 'destination'?: JsonApiNotificationChannelInAttributesDestination;
7079
+ 'destination'?: JsonApiNotificationChannelPatchAttributesDestination;
7107
7080
  'destinationType'?: JsonApiNotificationChannelOutAttributesDestinationTypeEnum | null;
7108
7081
  /**
7109
7082
  * 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}
@@ -7167,9 +7140,42 @@ export interface JsonApiNotificationChannelPatch {
7167
7140
  * API identifier of an object
7168
7141
  */
7169
7142
  'id': string;
7170
- 'attributes'?: JsonApiNotificationChannelInAttributes;
7143
+ 'attributes'?: JsonApiNotificationChannelPatchAttributes;
7171
7144
  }
7172
7145
  export type JsonApiNotificationChannelPatchTypeEnum = 'notificationChannel';
7146
+ export interface JsonApiNotificationChannelPatchAttributes {
7147
+ 'name'?: string | null;
7148
+ 'description'?: string | null;
7149
+ 'destination'?: JsonApiNotificationChannelPatchAttributesDestination;
7150
+ /**
7151
+ * 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}
7152
+ */
7153
+ 'customDashboardUrl'?: string;
7154
+ /**
7155
+ * 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
7156
+ */
7157
+ 'dashboardLinkVisibility'?: JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum;
7158
+ /**
7159
+ * 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}}
7160
+ */
7161
+ 'notificationSource'?: string;
7162
+ /**
7163
+ * 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
7164
+ */
7165
+ 'allowedRecipients'?: JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum;
7166
+ /**
7167
+ * 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
7168
+ */
7169
+ 'inPlatformNotification'?: JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum;
7170
+ }
7171
+ export type JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
7172
+ export type JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum = 'CREATOR' | 'INTERNAL' | 'EXTERNAL';
7173
+ export type JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
7174
+ /**
7175
+ * @type JsonApiNotificationChannelPatchAttributesDestination
7176
+ * The destination where the notifications are to be sent.
7177
+ */
7178
+ export type JsonApiNotificationChannelPatchAttributesDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
7173
7179
  export interface JsonApiNotificationChannelPatchDocument {
7174
7180
  'data': JsonApiNotificationChannelPatch;
7175
7181
  }
@@ -7185,7 +7191,7 @@ export interface JsonApiNotificationChannelPostOptionalId {
7185
7191
  * API identifier of an object
7186
7192
  */
7187
7193
  'id'?: string;
7188
- 'attributes'?: JsonApiNotificationChannelInAttributes;
7194
+ 'attributes'?: JsonApiNotificationChannelPatchAttributes;
7189
7195
  }
7190
7196
  export type JsonApiNotificationChannelPostOptionalIdTypeEnum = 'notificationChannel';
7191
7197
  export interface JsonApiNotificationChannelPostOptionalIdDocument {
@@ -7203,33 +7209,13 @@ export interface JsonApiOrganizationIn {
7203
7209
  * API identifier of an object
7204
7210
  */
7205
7211
  'id': string;
7206
- 'attributes'?: JsonApiOrganizationInAttributes;
7207
- 'relationships'?: JsonApiOrganizationInRelationships;
7212
+ 'attributes'?: JsonApiOrganizationPatchAttributes;
7213
+ 'relationships'?: JsonApiOrganizationPatchRelationships;
7208
7214
  }
7209
7215
  export type JsonApiOrganizationInTypeEnum = 'organization';
7210
- export interface JsonApiOrganizationInAttributes {
7211
- 'name'?: string | null;
7212
- 'hostname'?: string;
7213
- 'allowedOrigins'?: Array<string>;
7214
- /**
7215
- * The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
7216
- * @deprecated
7217
- */
7218
- 'earlyAccess'?: string | null;
7219
- /**
7220
- * The early access feature identifiers. They are used to enable experimental features.
7221
- */
7222
- 'earlyAccessValues'?: Array<string> | null;
7223
- }
7224
7216
  export interface JsonApiOrganizationInDocument {
7225
7217
  'data': JsonApiOrganizationIn;
7226
7218
  }
7227
- export interface JsonApiOrganizationInRelationships {
7228
- 'identityProvider'?: JsonApiOrganizationInRelationshipsIdentityProvider;
7229
- }
7230
- export interface JsonApiOrganizationInRelationshipsIdentityProvider {
7231
- 'data': JsonApiIdentityProviderLinkage | null;
7232
- }
7233
7219
  /**
7234
7220
  * JSON:API representation of organization entity.
7235
7221
  */
@@ -7297,7 +7283,7 @@ export type JsonApiOrganizationOutMetaPermissionsEnum = 'MANAGE' | 'SELF_CREATE_
7297
7283
  export interface JsonApiOrganizationOutRelationships {
7298
7284
  'bootstrapUser'?: JsonApiOrganizationOutRelationshipsBootstrapUser;
7299
7285
  'bootstrapUserGroup'?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
7300
- 'identityProvider'?: JsonApiOrganizationInRelationshipsIdentityProvider;
7286
+ 'identityProvider'?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
7301
7287
  }
7302
7288
  export interface JsonApiOrganizationOutRelationshipsBootstrapUser {
7303
7289
  'data': JsonApiUserLinkage | null;
@@ -7317,13 +7303,33 @@ export interface JsonApiOrganizationPatch {
7317
7303
  * API identifier of an object
7318
7304
  */
7319
7305
  'id': string;
7320
- 'attributes'?: JsonApiOrganizationInAttributes;
7321
- 'relationships'?: JsonApiOrganizationInRelationships;
7306
+ 'attributes'?: JsonApiOrganizationPatchAttributes;
7307
+ 'relationships'?: JsonApiOrganizationPatchRelationships;
7322
7308
  }
7323
7309
  export type JsonApiOrganizationPatchTypeEnum = 'organization';
7310
+ export interface JsonApiOrganizationPatchAttributes {
7311
+ 'name'?: string | null;
7312
+ 'hostname'?: string;
7313
+ 'allowedOrigins'?: Array<string>;
7314
+ /**
7315
+ * The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
7316
+ * @deprecated
7317
+ */
7318
+ 'earlyAccess'?: string | null;
7319
+ /**
7320
+ * The early access feature identifiers. They are used to enable experimental features.
7321
+ */
7322
+ 'earlyAccessValues'?: Array<string> | null;
7323
+ }
7324
7324
  export interface JsonApiOrganizationPatchDocument {
7325
7325
  'data': JsonApiOrganizationPatch;
7326
7326
  }
7327
+ export interface JsonApiOrganizationPatchRelationships {
7328
+ 'identityProvider'?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
7329
+ }
7330
+ export interface JsonApiOrganizationPatchRelationshipsIdentityProvider {
7331
+ 'data': JsonApiIdentityProviderLinkage | null;
7332
+ }
7327
7333
  /**
7328
7334
  * JSON:API representation of organizationSetting entity.
7329
7335
  */
@@ -7336,17 +7342,9 @@ export interface JsonApiOrganizationSettingIn {
7336
7342
  * API identifier of an object
7337
7343
  */
7338
7344
  'id': string;
7339
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
7345
+ 'attributes'?: JsonApiUserSettingInAttributes;
7340
7346
  }
7341
7347
  export type JsonApiOrganizationSettingInTypeEnum = 'organizationSetting';
7342
- export interface JsonApiOrganizationSettingInAttributes {
7343
- /**
7344
- * Free-form JSON content. Maximum supported length is 15000 characters.
7345
- */
7346
- 'content'?: object;
7347
- 'type'?: JsonApiOrganizationSettingInAttributesTypeEnum;
7348
- }
7349
- export 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';
7350
7348
  export interface JsonApiOrganizationSettingInDocument {
7351
7349
  'data': JsonApiOrganizationSettingIn;
7352
7350
  }
@@ -7362,7 +7360,7 @@ export interface JsonApiOrganizationSettingOut {
7362
7360
  * API identifier of an object
7363
7361
  */
7364
7362
  'id': string;
7365
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
7363
+ 'attributes'?: JsonApiUserSettingInAttributes;
7366
7364
  }
7367
7365
  export type JsonApiOrganizationSettingOutTypeEnum = 'organizationSetting';
7368
7366
  export interface JsonApiOrganizationSettingOutDocument {
@@ -7386,7 +7384,7 @@ export interface JsonApiOrganizationSettingOutWithLinks {
7386
7384
  * API identifier of an object
7387
7385
  */
7388
7386
  'id': string;
7389
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
7387
+ 'attributes'?: JsonApiUserSettingInAttributes;
7390
7388
  'links'?: ObjectLinks;
7391
7389
  }
7392
7390
  export type JsonApiOrganizationSettingOutWithLinksTypeEnum = 'organizationSetting';
@@ -7402,7 +7400,7 @@ export interface JsonApiOrganizationSettingPatch {
7402
7400
  * API identifier of an object
7403
7401
  */
7404
7402
  'id': string;
7405
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
7403
+ 'attributes'?: JsonApiUserSettingInAttributes;
7406
7404
  }
7407
7405
  export type JsonApiOrganizationSettingPatchTypeEnum = 'organizationSetting';
7408
7406
  export interface JsonApiOrganizationSettingPatchDocument {
@@ -7420,7 +7418,7 @@ export interface JsonApiThemeIn {
7420
7418
  * API identifier of an object
7421
7419
  */
7422
7420
  'id': string;
7423
- 'attributes': JsonApiColorPaletteInAttributes;
7421
+ 'attributes': JsonApiColorPaletteOutAttributes;
7424
7422
  }
7425
7423
  export type JsonApiThemeInTypeEnum = 'theme';
7426
7424
  export interface JsonApiThemeInDocument {
@@ -7438,7 +7436,7 @@ export interface JsonApiThemeOut {
7438
7436
  * API identifier of an object
7439
7437
  */
7440
7438
  'id': string;
7441
- 'attributes': JsonApiColorPaletteInAttributes;
7439
+ 'attributes': JsonApiColorPaletteOutAttributes;
7442
7440
  }
7443
7441
  export type JsonApiThemeOutTypeEnum = 'theme';
7444
7442
  export interface JsonApiThemeOutDocument {
@@ -7462,7 +7460,7 @@ export interface JsonApiThemeOutWithLinks {
7462
7460
  * API identifier of an object
7463
7461
  */
7464
7462
  'id': string;
7465
- 'attributes': JsonApiColorPaletteInAttributes;
7463
+ 'attributes': JsonApiColorPaletteOutAttributes;
7466
7464
  'links'?: ObjectLinks;
7467
7465
  }
7468
7466
  export type JsonApiThemeOutWithLinksTypeEnum = 'theme';
@@ -7497,7 +7495,7 @@ export interface JsonApiUserDataFilterIn {
7497
7495
  */
7498
7496
  'id': string;
7499
7497
  'attributes': JsonApiUserDataFilterOutAttributes;
7500
- 'relationships'?: JsonApiUserDataFilterPostOptionalIdRelationships;
7498
+ 'relationships'?: JsonApiUserDataFilterPatchRelationships;
7501
7499
  }
7502
7500
  export type JsonApiUserDataFilterInTypeEnum = 'userDataFilter';
7503
7501
  export interface JsonApiUserDataFilterInDocument {
@@ -7588,7 +7586,7 @@ export interface JsonApiUserDataFilterPatch {
7588
7586
  */
7589
7587
  'id': string;
7590
7588
  'attributes': JsonApiUserDataFilterPatchAttributes;
7591
- 'relationships'?: JsonApiUserDataFilterPostOptionalIdRelationships;
7589
+ 'relationships'?: JsonApiUserDataFilterPatchRelationships;
7592
7590
  }
7593
7591
  export type JsonApiUserDataFilterPatchTypeEnum = 'userDataFilter';
7594
7592
  export interface JsonApiUserDataFilterPatchAttributes {
@@ -7601,6 +7599,10 @@ export interface JsonApiUserDataFilterPatchAttributes {
7601
7599
  export interface JsonApiUserDataFilterPatchDocument {
7602
7600
  'data': JsonApiUserDataFilterPatch;
7603
7601
  }
7602
+ export interface JsonApiUserDataFilterPatchRelationships {
7603
+ 'user'?: JsonApiOrganizationOutRelationshipsBootstrapUser;
7604
+ 'userGroup'?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
7605
+ }
7604
7606
  /**
7605
7607
  * JSON:API representation of userDataFilter entity.
7606
7608
  */
@@ -7614,16 +7616,12 @@ export interface JsonApiUserDataFilterPostOptionalId {
7614
7616
  */
7615
7617
  'id'?: string;
7616
7618
  'attributes': JsonApiUserDataFilterOutAttributes;
7617
- 'relationships'?: JsonApiUserDataFilterPostOptionalIdRelationships;
7619
+ 'relationships'?: JsonApiUserDataFilterPatchRelationships;
7618
7620
  }
7619
7621
  export type JsonApiUserDataFilterPostOptionalIdTypeEnum = 'userDataFilter';
7620
7622
  export interface JsonApiUserDataFilterPostOptionalIdDocument {
7621
7623
  'data': JsonApiUserDataFilterPostOptionalId;
7622
7624
  }
7623
- export interface JsonApiUserDataFilterPostOptionalIdRelationships {
7624
- 'user'?: JsonApiOrganizationOutRelationshipsBootstrapUser;
7625
- 'userGroup'?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
7626
- }
7627
7625
  /**
7628
7626
  * JSON:API representation of userGroup entity.
7629
7627
  */
@@ -7902,9 +7900,17 @@ export interface JsonApiUserSettingIn {
7902
7900
  * API identifier of an object
7903
7901
  */
7904
7902
  'id': string;
7905
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
7903
+ 'attributes'?: JsonApiUserSettingInAttributes;
7906
7904
  }
7907
7905
  export type JsonApiUserSettingInTypeEnum = 'userSetting';
7906
+ export interface JsonApiUserSettingInAttributes {
7907
+ /**
7908
+ * Free-form JSON content. Maximum supported length is 15000 characters.
7909
+ */
7910
+ 'content'?: object;
7911
+ 'type'?: JsonApiUserSettingInAttributesTypeEnum;
7912
+ }
7913
+ export 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';
7908
7914
  export interface JsonApiUserSettingInDocument {
7909
7915
  'data': JsonApiUserSettingIn;
7910
7916
  }
@@ -7920,7 +7926,7 @@ export interface JsonApiUserSettingOut {
7920
7926
  * API identifier of an object
7921
7927
  */
7922
7928
  'id': string;
7923
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
7929
+ 'attributes'?: JsonApiUserSettingInAttributes;
7924
7930
  }
7925
7931
  export type JsonApiUserSettingOutTypeEnum = 'userSetting';
7926
7932
  export interface JsonApiUserSettingOutDocument {
@@ -7944,7 +7950,7 @@ export interface JsonApiUserSettingOutWithLinks {
7944
7950
  * API identifier of an object
7945
7951
  */
7946
7952
  'id': string;
7947
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
7953
+ 'attributes'?: JsonApiUserSettingInAttributes;
7948
7954
  'links'?: ObjectLinks;
7949
7955
  }
7950
7956
  export type JsonApiUserSettingOutWithLinksTypeEnum = 'userSetting';
@@ -8209,7 +8215,7 @@ export interface JsonApiWorkspaceAutomationOutList {
8209
8215
  'included'?: Array<JsonApiWorkspaceAutomationOutIncludes>;
8210
8216
  }
8211
8217
  export interface JsonApiWorkspaceAutomationOutRelationships {
8212
- 'workspace'?: JsonApiWorkspaceInRelationshipsParent;
8218
+ 'workspace'?: JsonApiWorkspacePatchRelationshipsParent;
8213
8219
  'notificationChannel'?: JsonApiAutomationOutRelationshipsNotificationChannel;
8214
8220
  'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
8215
8221
  'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
@@ -8465,51 +8471,13 @@ export interface JsonApiWorkspaceIn {
8465
8471
  * API identifier of an object
8466
8472
  */
8467
8473
  'id': string;
8468
- 'attributes'?: JsonApiWorkspaceInAttributes;
8469
- 'relationships'?: JsonApiWorkspaceInRelationships;
8474
+ 'attributes'?: JsonApiWorkspacePatchAttributes;
8475
+ 'relationships'?: JsonApiWorkspacePatchRelationships;
8470
8476
  }
8471
8477
  export type JsonApiWorkspaceInTypeEnum = 'workspace';
8472
- export interface JsonApiWorkspaceInAttributes {
8473
- 'name'?: string | null;
8474
- /**
8475
- * The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
8476
- * @deprecated
8477
- */
8478
- 'earlyAccess'?: string | null;
8479
- /**
8480
- * The early access feature identifiers. They are used to enable experimental features.
8481
- */
8482
- 'earlyAccessValues'?: Array<string> | null;
8483
- 'description'?: string | null;
8484
- /**
8485
- * Custom prefix of entity identifiers in workspace
8486
- */
8487
- 'prefix'?: string | null;
8488
- 'cacheExtraLimit'?: number;
8489
- 'dataSource'?: JsonApiWorkspaceInAttributesDataSource;
8490
- }
8491
- /**
8492
- * 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.
8493
- */
8494
- export interface JsonApiWorkspaceInAttributesDataSource {
8495
- /**
8496
- * The ID of the used data source.
8497
- */
8498
- 'id': string;
8499
- /**
8500
- * The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
8501
- */
8502
- 'schemaPath'?: Array<string>;
8503
- }
8504
8478
  export interface JsonApiWorkspaceInDocument {
8505
8479
  'data': JsonApiWorkspaceIn;
8506
8480
  }
8507
- export interface JsonApiWorkspaceInRelationships {
8508
- 'parent'?: JsonApiWorkspaceInRelationshipsParent;
8509
- }
8510
- export interface JsonApiWorkspaceInRelationshipsParent {
8511
- 'data': JsonApiWorkspaceLinkage | null;
8512
- }
8513
8481
  /**
8514
8482
  * The \\\"type\\\" and \\\"id\\\" to non-empty members.
8515
8483
  */
@@ -8531,8 +8499,8 @@ export interface JsonApiWorkspaceOut {
8531
8499
  */
8532
8500
  'id': string;
8533
8501
  'meta'?: JsonApiWorkspaceOutMeta;
8534
- 'attributes'?: JsonApiWorkspaceInAttributes;
8535
- 'relationships'?: JsonApiWorkspaceInRelationships;
8502
+ 'attributes'?: JsonApiWorkspacePatchAttributes;
8503
+ 'relationships'?: JsonApiWorkspacePatchRelationships;
8536
8504
  }
8537
8505
  export type JsonApiWorkspaceOutTypeEnum = 'workspace';
8538
8506
  export interface JsonApiWorkspaceOutDocument {
@@ -8601,8 +8569,8 @@ export interface JsonApiWorkspaceOutWithLinks {
8601
8569
  */
8602
8570
  'id': string;
8603
8571
  'meta'?: JsonApiWorkspaceOutMeta;
8604
- 'attributes'?: JsonApiWorkspaceInAttributes;
8605
- 'relationships'?: JsonApiWorkspaceInRelationships;
8572
+ 'attributes'?: JsonApiWorkspacePatchAttributes;
8573
+ 'relationships'?: JsonApiWorkspacePatchRelationships;
8606
8574
  'links'?: ObjectLinks;
8607
8575
  }
8608
8576
  export type JsonApiWorkspaceOutWithLinksTypeEnum = 'workspace';
@@ -8618,13 +8586,51 @@ export interface JsonApiWorkspacePatch {
8618
8586
  * API identifier of an object
8619
8587
  */
8620
8588
  'id': string;
8621
- 'attributes'?: JsonApiWorkspaceInAttributes;
8622
- 'relationships'?: JsonApiWorkspaceInRelationships;
8589
+ 'attributes'?: JsonApiWorkspacePatchAttributes;
8590
+ 'relationships'?: JsonApiWorkspacePatchRelationships;
8623
8591
  }
8624
8592
  export type JsonApiWorkspacePatchTypeEnum = 'workspace';
8593
+ export interface JsonApiWorkspacePatchAttributes {
8594
+ 'name'?: string | null;
8595
+ /**
8596
+ * The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
8597
+ * @deprecated
8598
+ */
8599
+ 'earlyAccess'?: string | null;
8600
+ /**
8601
+ * The early access feature identifiers. They are used to enable experimental features.
8602
+ */
8603
+ 'earlyAccessValues'?: Array<string> | null;
8604
+ 'description'?: string | null;
8605
+ /**
8606
+ * Custom prefix of entity identifiers in workspace
8607
+ */
8608
+ 'prefix'?: string | null;
8609
+ 'cacheExtraLimit'?: number;
8610
+ 'dataSource'?: JsonApiWorkspacePatchAttributesDataSource;
8611
+ }
8612
+ /**
8613
+ * 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.
8614
+ */
8615
+ export interface JsonApiWorkspacePatchAttributesDataSource {
8616
+ /**
8617
+ * The ID of the used data source.
8618
+ */
8619
+ 'id': string;
8620
+ /**
8621
+ * The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
8622
+ */
8623
+ 'schemaPath'?: Array<string>;
8624
+ }
8625
8625
  export interface JsonApiWorkspacePatchDocument {
8626
8626
  'data': JsonApiWorkspacePatch;
8627
8627
  }
8628
+ export interface JsonApiWorkspacePatchRelationships {
8629
+ 'parent'?: JsonApiWorkspacePatchRelationshipsParent;
8630
+ }
8631
+ export interface JsonApiWorkspacePatchRelationshipsParent {
8632
+ 'data': JsonApiWorkspaceLinkage | null;
8633
+ }
8628
8634
  /**
8629
8635
  * JSON:API representation of workspaceSetting entity.
8630
8636
  */
@@ -8637,7 +8643,7 @@ export interface JsonApiWorkspaceSettingIn {
8637
8643
  * API identifier of an object
8638
8644
  */
8639
8645
  'id': string;
8640
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
8646
+ 'attributes'?: JsonApiUserSettingInAttributes;
8641
8647
  }
8642
8648
  export type JsonApiWorkspaceSettingInTypeEnum = 'workspaceSetting';
8643
8649
  export interface JsonApiWorkspaceSettingInDocument {
@@ -8656,7 +8662,7 @@ export interface JsonApiWorkspaceSettingOut {
8656
8662
  */
8657
8663
  'id': string;
8658
8664
  'meta'?: JsonApiDatasetOutMeta;
8659
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
8665
+ 'attributes'?: JsonApiUserSettingInAttributes;
8660
8666
  }
8661
8667
  export type JsonApiWorkspaceSettingOutTypeEnum = 'workspaceSetting';
8662
8668
  export interface JsonApiWorkspaceSettingOutDocument {
@@ -8681,7 +8687,7 @@ export interface JsonApiWorkspaceSettingOutWithLinks {
8681
8687
  */
8682
8688
  'id': string;
8683
8689
  'meta'?: JsonApiDatasetOutMeta;
8684
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
8690
+ 'attributes'?: JsonApiUserSettingInAttributes;
8685
8691
  'links'?: ObjectLinks;
8686
8692
  }
8687
8693
  export type JsonApiWorkspaceSettingOutWithLinksTypeEnum = 'workspaceSetting';
@@ -8697,7 +8703,7 @@ export interface JsonApiWorkspaceSettingPatch {
8697
8703
  * API identifier of an object
8698
8704
  */
8699
8705
  'id': string;
8700
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
8706
+ 'attributes'?: JsonApiUserSettingInAttributes;
8701
8707
  }
8702
8708
  export type JsonApiWorkspaceSettingPatchTypeEnum = 'workspaceSetting';
8703
8709
  export interface JsonApiWorkspaceSettingPatchDocument {
@@ -8715,7 +8721,7 @@ export interface JsonApiWorkspaceSettingPostOptionalId {
8715
8721
  * API identifier of an object
8716
8722
  */
8717
8723
  'id'?: string;
8718
- 'attributes'?: JsonApiOrganizationSettingInAttributes;
8724
+ 'attributes'?: JsonApiUserSettingInAttributes;
8719
8725
  }
8720
8726
  export type JsonApiWorkspaceSettingPostOptionalIdTypeEnum = 'workspaceSetting';
8721
8727
  export interface JsonApiWorkspaceSettingPostOptionalIdDocument {
@@ -8825,6 +8831,13 @@ export type MeasureValueCondition = ComparisonCondition | RangeCondition;
8825
8831
  * Abstract filter definition type filtering by the value of the metric.
8826
8832
  */
8827
8833
  export type MeasureValueFilter = ComparisonMeasureValueFilter | CompoundMeasureValueFilter | RangeMeasureValueFilter;
8834
+ /**
8835
+ * (EXPERIMENTAL) Override for a catalog metric definition.
8836
+ */
8837
+ export interface MetricDefinitionOverride {
8838
+ 'item': AfmObjectIdentifierCore;
8839
+ 'definition': InlineMeasureDefinition;
8840
+ }
8828
8841
  export interface ModelFile {
8829
8842
  'skeleton'?: Skeleton;
8830
8843
  'any'?: Array<object>;