@gooddata/api-client-tiger 11.23.0-alpha.0 → 11.23.0-alpha.2
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.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +887 -812
- package/esm/endpoints/actions/index.d.ts +1 -1
- package/esm/endpoints/actions/index.d.ts.map +1 -1
- package/esm/endpoints/actions/index.js +1 -1
- package/esm/endpoints/actions/index.js.map +1 -1
- package/esm/generated/afm-rest-api/api.d.ts +117 -1
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +55 -0
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +748 -748
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/result-json-api/api.d.ts +14 -14
- package/esm/generated/result-json-api/api.js +10 -10
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js.map +1 -1
- package/package.json +5 -5
|
@@ -1974,7 +1974,7 @@ declare interface ActionsApiCreatedByRequest {
|
|
|
1974
1974
|
*/
|
|
1975
1975
|
declare interface ActionsApiCustomGeoCollectionStagingUploadRequest {
|
|
1976
1976
|
/**
|
|
1977
|
-
* The geo collection file to upload. Supported formats: GeoParquet (.parquet), GeoJSON (.geojson, .json).
|
|
1977
|
+
* The geo collection file to upload. Supported formats: GeoParquet (.parquet), GeoJSON (.geojson, .json), ESRI Shapefile (.zip).
|
|
1978
1978
|
* @type {File}
|
|
1979
1979
|
* @memberof ActionsApiCustomGeoCollectionStagingUpload
|
|
1980
1980
|
*/
|
|
@@ -8147,6 +8147,18 @@ export declare interface AnomalyDetection {
|
|
|
8147
8147
|
'dataset': AfmObjectIdentifierDataset;
|
|
8148
8148
|
}
|
|
8149
8149
|
|
|
8150
|
+
/**
|
|
8151
|
+
* Anomaly detection configuration.
|
|
8152
|
+
*/
|
|
8153
|
+
export declare interface AnomalyDetectionConfig {
|
|
8154
|
+
/**
|
|
8155
|
+
* Outlier sensitivity level.
|
|
8156
|
+
*/
|
|
8157
|
+
'sensitivity': AnomalyDetectionConfigSensitivityEnum;
|
|
8158
|
+
}
|
|
8159
|
+
|
|
8160
|
+
export declare type AnomalyDetectionConfigSensitivityEnum = 'LOW' | 'MEDIUM' | 'HIGH';
|
|
8161
|
+
|
|
8150
8162
|
export declare type AnomalyDetectionGranularityEnum = 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
|
|
8151
8163
|
|
|
8152
8164
|
export declare interface AnomalyDetectionRequest {
|
|
@@ -14492,6 +14504,20 @@ export declare interface ChatUsageResponse {
|
|
|
14492
14504
|
'timeWindowHours': number;
|
|
14493
14505
|
}
|
|
14494
14506
|
|
|
14507
|
+
/**
|
|
14508
|
+
* Clustering configuration.
|
|
14509
|
+
*/
|
|
14510
|
+
export declare interface ClusteringConfig {
|
|
14511
|
+
/**
|
|
14512
|
+
* Number of clusters to create
|
|
14513
|
+
*/
|
|
14514
|
+
'numberOfClusters': number;
|
|
14515
|
+
/**
|
|
14516
|
+
* Clustering algorithm threshold
|
|
14517
|
+
*/
|
|
14518
|
+
'threshold': number;
|
|
14519
|
+
}
|
|
14520
|
+
|
|
14495
14521
|
export declare interface ClusteringRequest {
|
|
14496
14522
|
/**
|
|
14497
14523
|
* Number of clusters to create
|
|
@@ -15098,7 +15124,7 @@ export declare interface CreatedVisualizations {
|
|
|
15098
15124
|
'suggestions': Array<ChatSuggestion>;
|
|
15099
15125
|
}
|
|
15100
15126
|
|
|
15101
|
-
export declare type CreatedVisualizationVisualizationTypeEnum = 'TABLE' | 'HEADLINE' | 'BAR' | 'LINE' | 'PIE' | 'COLUMN';
|
|
15127
|
+
export declare type CreatedVisualizationVisualizationTypeEnum = 'TABLE' | 'HEADLINE' | 'BAR' | 'LINE' | 'PIE' | 'COLUMN' | 'SCATTER';
|
|
15102
15128
|
|
|
15103
15129
|
/**
|
|
15104
15130
|
* CSPDirectivesApi - object-oriented interface
|
|
@@ -45204,7 +45230,7 @@ export declare interface FilterViewsApiUpdateEntityFilterViewsRequest {
|
|
|
45204
45230
|
/**
|
|
45205
45231
|
* Forecast configuration.
|
|
45206
45232
|
*/
|
|
45207
|
-
declare interface ForecastConfig {
|
|
45233
|
+
export declare interface ForecastConfig {
|
|
45208
45234
|
/**
|
|
45209
45235
|
* Number of future periods that should be forecasted
|
|
45210
45236
|
*/
|
|
@@ -48369,7 +48395,7 @@ export declare interface JsonApiAggregatedFactOut {
|
|
|
48369
48395
|
* API identifier of an object
|
|
48370
48396
|
*/
|
|
48371
48397
|
'id': string;
|
|
48372
|
-
'meta'?:
|
|
48398
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
48373
48399
|
'attributes': JsonApiAggregatedFactOutAttributes;
|
|
48374
48400
|
'relationships'?: JsonApiAggregatedFactOutRelationships;
|
|
48375
48401
|
}
|
|
@@ -48409,19 +48435,15 @@ export declare type JsonApiAggregatedFactOutIncludes = JsonApiDatasetOutWithLink
|
|
|
48409
48435
|
export declare interface JsonApiAggregatedFactOutList {
|
|
48410
48436
|
'data': Array<JsonApiAggregatedFactOutWithLinks>;
|
|
48411
48437
|
'links'?: ListLinks;
|
|
48412
|
-
'meta'?:
|
|
48438
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
48413
48439
|
/**
|
|
48414
48440
|
* Included resources
|
|
48415
48441
|
*/
|
|
48416
48442
|
'included'?: Array<JsonApiAggregatedFactOutIncludes>;
|
|
48417
48443
|
}
|
|
48418
48444
|
|
|
48419
|
-
export declare interface JsonApiAggregatedFactOutListMeta {
|
|
48420
|
-
'page'?: PageMetadata;
|
|
48421
|
-
}
|
|
48422
|
-
|
|
48423
48445
|
export declare interface JsonApiAggregatedFactOutRelationships {
|
|
48424
|
-
'dataset'?:
|
|
48446
|
+
'dataset'?: JsonApiAttributeOutRelationshipsDataset;
|
|
48425
48447
|
'sourceFact'?: JsonApiAggregatedFactOutRelationshipsSourceFact;
|
|
48426
48448
|
}
|
|
48427
48449
|
|
|
@@ -48440,7 +48462,7 @@ export declare interface JsonApiAggregatedFactOutWithLinks {
|
|
|
48440
48462
|
* API identifier of an object
|
|
48441
48463
|
*/
|
|
48442
48464
|
'id': string;
|
|
48443
|
-
'meta'?:
|
|
48465
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
48444
48466
|
'attributes': JsonApiAggregatedFactOutAttributes;
|
|
48445
48467
|
'relationships'?: JsonApiAggregatedFactOutRelationships;
|
|
48446
48468
|
'links'?: ObjectLinks;
|
|
@@ -48460,7 +48482,22 @@ export declare interface JsonApiAnalyticalDashboardIn {
|
|
|
48460
48482
|
* API identifier of an object
|
|
48461
48483
|
*/
|
|
48462
48484
|
'id': string;
|
|
48463
|
-
'attributes':
|
|
48485
|
+
'attributes': JsonApiAnalyticalDashboardInAttributes;
|
|
48486
|
+
}
|
|
48487
|
+
|
|
48488
|
+
export declare interface JsonApiAnalyticalDashboardInAttributes {
|
|
48489
|
+
'title'?: string;
|
|
48490
|
+
'description'?: string;
|
|
48491
|
+
'tags'?: Array<string>;
|
|
48492
|
+
'areRelationsValid'?: boolean;
|
|
48493
|
+
/**
|
|
48494
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
48495
|
+
*/
|
|
48496
|
+
'content': object;
|
|
48497
|
+
/**
|
|
48498
|
+
* AI-generated summary of the dashboard content
|
|
48499
|
+
*/
|
|
48500
|
+
'summary'?: string;
|
|
48464
48501
|
}
|
|
48465
48502
|
|
|
48466
48503
|
export declare interface JsonApiAnalyticalDashboardInDocument {
|
|
@@ -48553,7 +48590,7 @@ export declare type JsonApiAnalyticalDashboardOutIncludes = JsonApiAnalyticalDas
|
|
|
48553
48590
|
export declare interface JsonApiAnalyticalDashboardOutList {
|
|
48554
48591
|
'data': Array<JsonApiAnalyticalDashboardOutWithLinks>;
|
|
48555
48592
|
'links'?: ListLinks;
|
|
48556
|
-
'meta'?:
|
|
48593
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
48557
48594
|
/**
|
|
48558
48595
|
* Included resources
|
|
48559
48596
|
*/
|
|
@@ -48565,7 +48602,7 @@ export declare interface JsonApiAnalyticalDashboardOutMeta {
|
|
|
48565
48602
|
* List of valid permissions for a logged-in user.
|
|
48566
48603
|
*/
|
|
48567
48604
|
'permissions'?: Array<JsonApiAnalyticalDashboardOutMetaPermissionsEnum>;
|
|
48568
|
-
'origin'?:
|
|
48605
|
+
'origin'?: JsonApiVisualizationObjectOutMetaOrigin;
|
|
48569
48606
|
'accessInfo'?: JsonApiAnalyticalDashboardOutMetaAccessInfo;
|
|
48570
48607
|
}
|
|
48571
48608
|
|
|
@@ -48586,7 +48623,7 @@ export declare interface JsonApiAnalyticalDashboardOutRelationships {
|
|
|
48586
48623
|
'analyticalDashboards'?: JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards;
|
|
48587
48624
|
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
48588
48625
|
'metrics'?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
48589
|
-
'datasets'?:
|
|
48626
|
+
'datasets'?: JsonApiVisualizationObjectOutRelationshipsDatasets;
|
|
48590
48627
|
'filterContexts'?: JsonApiAnalyticalDashboardOutRelationshipsFilterContexts;
|
|
48591
48628
|
'dashboardPlugins'?: JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins;
|
|
48592
48629
|
}
|
|
@@ -48686,22 +48723,7 @@ export declare interface JsonApiAnalyticalDashboardPostOptionalId {
|
|
|
48686
48723
|
* API identifier of an object
|
|
48687
48724
|
*/
|
|
48688
48725
|
'id'?: string;
|
|
48689
|
-
'attributes':
|
|
48690
|
-
}
|
|
48691
|
-
|
|
48692
|
-
export declare interface JsonApiAnalyticalDashboardPostOptionalIdAttributes {
|
|
48693
|
-
'title'?: string;
|
|
48694
|
-
'description'?: string;
|
|
48695
|
-
'tags'?: Array<string>;
|
|
48696
|
-
'areRelationsValid'?: boolean;
|
|
48697
|
-
/**
|
|
48698
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
48699
|
-
*/
|
|
48700
|
-
'content': object;
|
|
48701
|
-
/**
|
|
48702
|
-
* AI-generated summary of the dashboard content
|
|
48703
|
-
*/
|
|
48704
|
-
'summary'?: string;
|
|
48726
|
+
'attributes': JsonApiAnalyticalDashboardInAttributes;
|
|
48705
48727
|
}
|
|
48706
48728
|
|
|
48707
48729
|
export declare interface JsonApiAnalyticalDashboardPostOptionalIdDocument {
|
|
@@ -48763,7 +48785,11 @@ export declare interface JsonApiApiTokenOutDocument {
|
|
|
48763
48785
|
export declare interface JsonApiApiTokenOutList {
|
|
48764
48786
|
'data': Array<JsonApiApiTokenOutWithLinks>;
|
|
48765
48787
|
'links'?: ListLinks;
|
|
48766
|
-
'meta'?:
|
|
48788
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
48789
|
+
}
|
|
48790
|
+
|
|
48791
|
+
export declare interface JsonApiApiTokenOutListMeta {
|
|
48792
|
+
'page'?: PageMetadata;
|
|
48767
48793
|
}
|
|
48768
48794
|
|
|
48769
48795
|
export declare type JsonApiApiTokenOutTypeEnum = 'apiToken';
|
|
@@ -48826,7 +48852,7 @@ export declare interface JsonApiAttributeHierarchyOut {
|
|
|
48826
48852
|
* API identifier of an object
|
|
48827
48853
|
*/
|
|
48828
48854
|
'id': string;
|
|
48829
|
-
'meta'?:
|
|
48855
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
48830
48856
|
'attributes'?: JsonApiAttributeHierarchyOutAttributes;
|
|
48831
48857
|
'relationships'?: JsonApiAttributeHierarchyOutRelationships;
|
|
48832
48858
|
}
|
|
@@ -48870,7 +48896,7 @@ export declare type JsonApiAttributeHierarchyOutIncludes = JsonApiAttributeOutWi
|
|
|
48870
48896
|
export declare interface JsonApiAttributeHierarchyOutList {
|
|
48871
48897
|
'data': Array<JsonApiAttributeHierarchyOutWithLinks>;
|
|
48872
48898
|
'links'?: ListLinks;
|
|
48873
|
-
'meta'?:
|
|
48899
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
48874
48900
|
/**
|
|
48875
48901
|
* Included resources
|
|
48876
48902
|
*/
|
|
@@ -48880,7 +48906,7 @@ export declare interface JsonApiAttributeHierarchyOutList {
|
|
|
48880
48906
|
export declare interface JsonApiAttributeHierarchyOutRelationships {
|
|
48881
48907
|
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
48882
48908
|
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
48883
|
-
'attributes'?:
|
|
48909
|
+
'attributes'?: JsonApiVisualizationObjectOutRelationshipsAttributes;
|
|
48884
48910
|
}
|
|
48885
48911
|
|
|
48886
48912
|
export declare type JsonApiAttributeHierarchyOutTypeEnum = 'attributeHierarchy';
|
|
@@ -48894,7 +48920,7 @@ export declare interface JsonApiAttributeHierarchyOutWithLinks {
|
|
|
48894
48920
|
* API identifier of an object
|
|
48895
48921
|
*/
|
|
48896
48922
|
'id': string;
|
|
48897
|
-
'meta'?:
|
|
48923
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
48898
48924
|
'attributes'?: JsonApiAttributeHierarchyOutAttributes;
|
|
48899
48925
|
'relationships'?: JsonApiAttributeHierarchyOutRelationships;
|
|
48900
48926
|
'links'?: ObjectLinks;
|
|
@@ -48956,7 +48982,7 @@ export declare interface JsonApiAttributeOut {
|
|
|
48956
48982
|
* API identifier of an object
|
|
48957
48983
|
*/
|
|
48958
48984
|
'id': string;
|
|
48959
|
-
'meta'?:
|
|
48985
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
48960
48986
|
'attributes'?: JsonApiAttributeOutAttributes;
|
|
48961
48987
|
'relationships'?: JsonApiAttributeOutRelationships;
|
|
48962
48988
|
}
|
|
@@ -49003,7 +49029,7 @@ export declare type JsonApiAttributeOutIncludes = JsonApiAttributeHierarchyOutWi
|
|
|
49003
49029
|
export declare interface JsonApiAttributeOutList {
|
|
49004
49030
|
'data': Array<JsonApiAttributeOutWithLinks>;
|
|
49005
49031
|
'links'?: ListLinks;
|
|
49006
|
-
'meta'?:
|
|
49032
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
49007
49033
|
/**
|
|
49008
49034
|
* Included resources
|
|
49009
49035
|
*/
|
|
@@ -49011,7 +49037,7 @@ export declare interface JsonApiAttributeOutList {
|
|
|
49011
49037
|
}
|
|
49012
49038
|
|
|
49013
49039
|
export declare interface JsonApiAttributeOutRelationships {
|
|
49014
|
-
'dataset'?:
|
|
49040
|
+
'dataset'?: JsonApiAttributeOutRelationshipsDataset;
|
|
49015
49041
|
'defaultView'?: JsonApiAttributeOutRelationshipsDefaultView;
|
|
49016
49042
|
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
49017
49043
|
'attributeHierarchies'?: JsonApiAttributeOutRelationshipsAttributeHierarchies;
|
|
@@ -49024,6 +49050,10 @@ export declare interface JsonApiAttributeOutRelationshipsAttributeHierarchies {
|
|
|
49024
49050
|
'data': Array<JsonApiAttributeHierarchyLinkage>;
|
|
49025
49051
|
}
|
|
49026
49052
|
|
|
49053
|
+
export declare interface JsonApiAttributeOutRelationshipsDataset {
|
|
49054
|
+
'data': JsonApiDatasetLinkage | null;
|
|
49055
|
+
}
|
|
49056
|
+
|
|
49027
49057
|
export declare interface JsonApiAttributeOutRelationshipsDefaultView {
|
|
49028
49058
|
'data': JsonApiLabelLinkage | null;
|
|
49029
49059
|
}
|
|
@@ -49039,7 +49069,7 @@ export declare interface JsonApiAttributeOutWithLinks {
|
|
|
49039
49069
|
* API identifier of an object
|
|
49040
49070
|
*/
|
|
49041
49071
|
'id': string;
|
|
49042
|
-
'meta'?:
|
|
49072
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
49043
49073
|
'attributes'?: JsonApiAttributeOutAttributes;
|
|
49044
49074
|
'relationships'?: JsonApiAttributeOutRelationships;
|
|
49045
49075
|
'links'?: ObjectLinks;
|
|
@@ -49123,7 +49153,7 @@ export declare interface JsonApiAutomationOut {
|
|
|
49123
49153
|
* API identifier of an object
|
|
49124
49154
|
*/
|
|
49125
49155
|
'id': string;
|
|
49126
|
-
'meta'?:
|
|
49156
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
49127
49157
|
'attributes'?: JsonApiAutomationOutAttributes;
|
|
49128
49158
|
'relationships'?: JsonApiAutomationOutRelationships;
|
|
49129
49159
|
}
|
|
@@ -49137,7 +49167,7 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
49137
49167
|
* Additional details to be included in the automated message.
|
|
49138
49168
|
*/
|
|
49139
49169
|
'details'?: object;
|
|
49140
|
-
'metadata'?:
|
|
49170
|
+
'metadata'?: JsonApiAutomationPatchAttributesMetadata | null;
|
|
49141
49171
|
/**
|
|
49142
49172
|
* Current state of the automation.
|
|
49143
49173
|
*/
|
|
@@ -49146,18 +49176,18 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
49146
49176
|
* Specify automation evaluation mode.
|
|
49147
49177
|
*/
|
|
49148
49178
|
'evaluationMode'?: JsonApiAutomationOutAttributesEvaluationModeEnum;
|
|
49149
|
-
'schedule'?:
|
|
49150
|
-
'alert'?:
|
|
49151
|
-
'tabularExports'?: Array<
|
|
49152
|
-
'visualExports'?: Array<
|
|
49153
|
-
'imageExports'?: Array<
|
|
49154
|
-
'rawExports'?: Array<
|
|
49155
|
-
'slidesExports'?: Array<
|
|
49156
|
-
'dashboardTabularExports'?: Array<
|
|
49179
|
+
'schedule'?: JsonApiAutomationPatchAttributesSchedule;
|
|
49180
|
+
'alert'?: JsonApiAutomationPatchAttributesAlert;
|
|
49181
|
+
'tabularExports'?: Array<JsonApiAutomationPatchAttributesTabularExportsInner>;
|
|
49182
|
+
'visualExports'?: Array<JsonApiAutomationPatchAttributesVisualExportsInner>;
|
|
49183
|
+
'imageExports'?: Array<JsonApiAutomationPatchAttributesImageExportsInner>;
|
|
49184
|
+
'rawExports'?: Array<JsonApiAutomationPatchAttributesRawExportsInner>;
|
|
49185
|
+
'slidesExports'?: Array<JsonApiAutomationPatchAttributesSlidesExportsInner>;
|
|
49186
|
+
'dashboardTabularExports'?: Array<JsonApiAutomationPatchAttributesDashboardTabularExportsInner>;
|
|
49157
49187
|
/**
|
|
49158
49188
|
* External recipients of the automation action results.
|
|
49159
49189
|
*/
|
|
49160
|
-
'externalRecipients'?: Array<
|
|
49190
|
+
'externalRecipients'?: Array<JsonApiAutomationPatchAttributesExternalRecipientsInner>;
|
|
49161
49191
|
/**
|
|
49162
49192
|
* Time of the entity creation.
|
|
49163
49193
|
*/
|
|
@@ -49168,86 +49198,10 @@ export declare interface JsonApiAutomationOutAttributes {
|
|
|
49168
49198
|
'modifiedAt'?: string | null;
|
|
49169
49199
|
}
|
|
49170
49200
|
|
|
49171
|
-
export declare interface JsonApiAutomationOutAttributesAlert {
|
|
49172
|
-
'execution': AlertAfm;
|
|
49173
|
-
'condition': AlertCondition;
|
|
49174
|
-
/**
|
|
49175
|
-
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.
|
|
49176
|
-
*/
|
|
49177
|
-
'trigger'?: JsonApiAutomationOutAttributesAlertTriggerEnum;
|
|
49178
|
-
/**
|
|
49179
|
-
* Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.
|
|
49180
|
-
*/
|
|
49181
|
-
'interval'?: JsonApiAutomationOutAttributesAlertIntervalEnum;
|
|
49182
|
-
}
|
|
49183
|
-
|
|
49184
|
-
export declare type JsonApiAutomationOutAttributesAlertIntervalEnum = 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
|
|
49185
|
-
|
|
49186
|
-
export declare type JsonApiAutomationOutAttributesAlertTriggerEnum = 'ALWAYS' | 'ONCE' | 'ONCE_PER_INTERVAL';
|
|
49187
|
-
|
|
49188
|
-
export declare interface JsonApiAutomationOutAttributesDashboardTabularExportsInner {
|
|
49189
|
-
'requestPayload': DashboardTabularExportRequestV2;
|
|
49190
|
-
}
|
|
49191
|
-
|
|
49192
49201
|
export declare type JsonApiAutomationOutAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
|
|
49193
49202
|
|
|
49194
|
-
export declare interface JsonApiAutomationOutAttributesExternalRecipientsInner {
|
|
49195
|
-
/**
|
|
49196
|
-
* E-mail address to send notifications from.
|
|
49197
|
-
*/
|
|
49198
|
-
'email': string;
|
|
49199
|
-
}
|
|
49200
|
-
|
|
49201
|
-
export declare interface JsonApiAutomationOutAttributesImageExportsInner {
|
|
49202
|
-
'requestPayload': ImageExportRequest;
|
|
49203
|
-
}
|
|
49204
|
-
|
|
49205
|
-
/**
|
|
49206
|
-
* Additional information for the automation.
|
|
49207
|
-
*/
|
|
49208
|
-
export declare interface JsonApiAutomationOutAttributesMetadata {
|
|
49209
|
-
[key: string]: any;
|
|
49210
|
-
'widget'?: string;
|
|
49211
|
-
'visibleFilters'?: Array<VisibleFilter>;
|
|
49212
|
-
}
|
|
49213
|
-
|
|
49214
|
-
export declare interface JsonApiAutomationOutAttributesRawExportsInner {
|
|
49215
|
-
'requestPayload': RawExportAutomationRequest;
|
|
49216
|
-
}
|
|
49217
|
-
|
|
49218
|
-
export declare interface JsonApiAutomationOutAttributesSchedule {
|
|
49219
|
-
/**
|
|
49220
|
-
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
49221
|
-
*/
|
|
49222
|
-
'cron': string;
|
|
49223
|
-
/**
|
|
49224
|
-
* Human-readable description of the cron expression.
|
|
49225
|
-
*/
|
|
49226
|
-
'cronDescription'?: string;
|
|
49227
|
-
/**
|
|
49228
|
-
* Timezone in which the schedule is defined.
|
|
49229
|
-
*/
|
|
49230
|
-
'timezone': string;
|
|
49231
|
-
/**
|
|
49232
|
-
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
49233
|
-
*/
|
|
49234
|
-
'firstRun'?: string;
|
|
49235
|
-
}
|
|
49236
|
-
|
|
49237
|
-
export declare interface JsonApiAutomationOutAttributesSlidesExportsInner {
|
|
49238
|
-
'requestPayload': SlidesExportRequest;
|
|
49239
|
-
}
|
|
49240
|
-
|
|
49241
49203
|
export declare type JsonApiAutomationOutAttributesStateEnum = 'ACTIVE' | 'PAUSED';
|
|
49242
49204
|
|
|
49243
|
-
export declare interface JsonApiAutomationOutAttributesTabularExportsInner {
|
|
49244
|
-
'requestPayload': TabularExportRequest;
|
|
49245
|
-
}
|
|
49246
|
-
|
|
49247
|
-
export declare interface JsonApiAutomationOutAttributesVisualExportsInner {
|
|
49248
|
-
'requestPayload': VisualExportRequest;
|
|
49249
|
-
}
|
|
49250
|
-
|
|
49251
49205
|
export declare interface JsonApiAutomationOutDocument {
|
|
49252
49206
|
'data': JsonApiAutomationOut;
|
|
49253
49207
|
'links'?: ObjectLinks;
|
|
@@ -49268,7 +49222,7 @@ export declare type JsonApiAutomationOutIncludes = JsonApiAnalyticalDashboardOut
|
|
|
49268
49222
|
export declare interface JsonApiAutomationOutList {
|
|
49269
49223
|
'data': Array<JsonApiAutomationOutWithLinks>;
|
|
49270
49224
|
'links'?: ListLinks;
|
|
49271
|
-
'meta'?:
|
|
49225
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
49272
49226
|
/**
|
|
49273
49227
|
* Included resources
|
|
49274
49228
|
*/
|
|
@@ -49276,12 +49230,12 @@ export declare interface JsonApiAutomationOutList {
|
|
|
49276
49230
|
}
|
|
49277
49231
|
|
|
49278
49232
|
export declare interface JsonApiAutomationOutRelationships {
|
|
49279
|
-
'notificationChannel'?:
|
|
49280
|
-
'analyticalDashboard'?:
|
|
49233
|
+
'notificationChannel'?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
49234
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
49281
49235
|
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
49282
49236
|
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
49283
|
-
'exportDefinitions'?:
|
|
49284
|
-
'recipients'?:
|
|
49237
|
+
'exportDefinitions'?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
49238
|
+
'recipients'?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
49285
49239
|
'automationResults'?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
49286
49240
|
}
|
|
49287
49241
|
|
|
@@ -49292,24 +49246,6 @@ export declare interface JsonApiAutomationOutRelationshipsAutomationResults {
|
|
|
49292
49246
|
'data': Array<JsonApiAutomationResultLinkage>;
|
|
49293
49247
|
}
|
|
49294
49248
|
|
|
49295
|
-
export declare interface JsonApiAutomationOutRelationshipsExportDefinitions {
|
|
49296
|
-
/**
|
|
49297
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
49298
|
-
*/
|
|
49299
|
-
'data': Array<JsonApiExportDefinitionLinkage>;
|
|
49300
|
-
}
|
|
49301
|
-
|
|
49302
|
-
export declare interface JsonApiAutomationOutRelationshipsNotificationChannel {
|
|
49303
|
-
'data': JsonApiNotificationChannelLinkage | null;
|
|
49304
|
-
}
|
|
49305
|
-
|
|
49306
|
-
export declare interface JsonApiAutomationOutRelationshipsRecipients {
|
|
49307
|
-
/**
|
|
49308
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
49309
|
-
*/
|
|
49310
|
-
'data': Array<JsonApiUserLinkage>;
|
|
49311
|
-
}
|
|
49312
|
-
|
|
49313
49249
|
export declare type JsonApiAutomationOutTypeEnum = 'automation';
|
|
49314
49250
|
|
|
49315
49251
|
export declare interface JsonApiAutomationOutWithLinks {
|
|
@@ -49321,7 +49257,7 @@ export declare interface JsonApiAutomationOutWithLinks {
|
|
|
49321
49257
|
* API identifier of an object
|
|
49322
49258
|
*/
|
|
49323
49259
|
'id': string;
|
|
49324
|
-
'meta'?:
|
|
49260
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
49325
49261
|
'attributes'?: JsonApiAutomationOutAttributes;
|
|
49326
49262
|
'relationships'?: JsonApiAutomationOutRelationships;
|
|
49327
49263
|
'links'?: ObjectLinks;
|
|
@@ -49354,7 +49290,7 @@ export declare interface JsonApiAutomationPatchAttributes {
|
|
|
49354
49290
|
* Additional details to be included in the automated message.
|
|
49355
49291
|
*/
|
|
49356
49292
|
'details'?: object;
|
|
49357
|
-
'metadata'?:
|
|
49293
|
+
'metadata'?: JsonApiAutomationPatchAttributesMetadata | null;
|
|
49358
49294
|
/**
|
|
49359
49295
|
* Current state of the automation.
|
|
49360
49296
|
*/
|
|
@@ -49363,33 +49299,131 @@ export declare interface JsonApiAutomationPatchAttributes {
|
|
|
49363
49299
|
* Specify automation evaluation mode.
|
|
49364
49300
|
*/
|
|
49365
49301
|
'evaluationMode'?: JsonApiAutomationPatchAttributesEvaluationModeEnum;
|
|
49366
|
-
'schedule'?:
|
|
49367
|
-
'alert'?:
|
|
49368
|
-
'tabularExports'?: Array<
|
|
49369
|
-
'visualExports'?: Array<
|
|
49370
|
-
'imageExports'?: Array<
|
|
49371
|
-
'rawExports'?: Array<
|
|
49372
|
-
'slidesExports'?: Array<
|
|
49373
|
-
'dashboardTabularExports'?: Array<
|
|
49302
|
+
'schedule'?: JsonApiAutomationPatchAttributesSchedule;
|
|
49303
|
+
'alert'?: JsonApiAutomationPatchAttributesAlert;
|
|
49304
|
+
'tabularExports'?: Array<JsonApiAutomationPatchAttributesTabularExportsInner>;
|
|
49305
|
+
'visualExports'?: Array<JsonApiAutomationPatchAttributesVisualExportsInner>;
|
|
49306
|
+
'imageExports'?: Array<JsonApiAutomationPatchAttributesImageExportsInner>;
|
|
49307
|
+
'rawExports'?: Array<JsonApiAutomationPatchAttributesRawExportsInner>;
|
|
49308
|
+
'slidesExports'?: Array<JsonApiAutomationPatchAttributesSlidesExportsInner>;
|
|
49309
|
+
'dashboardTabularExports'?: Array<JsonApiAutomationPatchAttributesDashboardTabularExportsInner>;
|
|
49374
49310
|
/**
|
|
49375
49311
|
* External recipients of the automation action results.
|
|
49376
49312
|
*/
|
|
49377
|
-
'externalRecipients'?: Array<
|
|
49313
|
+
'externalRecipients'?: Array<JsonApiAutomationPatchAttributesExternalRecipientsInner>;
|
|
49314
|
+
}
|
|
49315
|
+
|
|
49316
|
+
export declare interface JsonApiAutomationPatchAttributesAlert {
|
|
49317
|
+
'execution': AlertAfm;
|
|
49318
|
+
'condition': AlertCondition;
|
|
49319
|
+
/**
|
|
49320
|
+
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.
|
|
49321
|
+
*/
|
|
49322
|
+
'trigger'?: JsonApiAutomationPatchAttributesAlertTriggerEnum;
|
|
49323
|
+
/**
|
|
49324
|
+
* Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.
|
|
49325
|
+
*/
|
|
49326
|
+
'interval'?: JsonApiAutomationPatchAttributesAlertIntervalEnum;
|
|
49327
|
+
}
|
|
49328
|
+
|
|
49329
|
+
export declare type JsonApiAutomationPatchAttributesAlertIntervalEnum = 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
|
|
49330
|
+
|
|
49331
|
+
export declare type JsonApiAutomationPatchAttributesAlertTriggerEnum = 'ALWAYS' | 'ONCE' | 'ONCE_PER_INTERVAL';
|
|
49332
|
+
|
|
49333
|
+
export declare interface JsonApiAutomationPatchAttributesDashboardTabularExportsInner {
|
|
49334
|
+
'requestPayload': DashboardTabularExportRequestV2;
|
|
49378
49335
|
}
|
|
49379
49336
|
|
|
49380
49337
|
export declare type JsonApiAutomationPatchAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
|
|
49381
49338
|
|
|
49339
|
+
export declare interface JsonApiAutomationPatchAttributesExternalRecipientsInner {
|
|
49340
|
+
/**
|
|
49341
|
+
* E-mail address to send notifications from.
|
|
49342
|
+
*/
|
|
49343
|
+
'email': string;
|
|
49344
|
+
}
|
|
49345
|
+
|
|
49346
|
+
export declare interface JsonApiAutomationPatchAttributesImageExportsInner {
|
|
49347
|
+
'requestPayload': ImageExportRequest;
|
|
49348
|
+
}
|
|
49349
|
+
|
|
49350
|
+
/**
|
|
49351
|
+
* Additional information for the automation.
|
|
49352
|
+
*/
|
|
49353
|
+
export declare interface JsonApiAutomationPatchAttributesMetadata {
|
|
49354
|
+
[key: string]: any;
|
|
49355
|
+
'widget'?: string;
|
|
49356
|
+
'visibleFilters'?: Array<VisibleFilter>;
|
|
49357
|
+
}
|
|
49358
|
+
|
|
49359
|
+
export declare interface JsonApiAutomationPatchAttributesRawExportsInner {
|
|
49360
|
+
'requestPayload': RawExportAutomationRequest;
|
|
49361
|
+
}
|
|
49362
|
+
|
|
49363
|
+
export declare interface JsonApiAutomationPatchAttributesSchedule {
|
|
49364
|
+
/**
|
|
49365
|
+
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
49366
|
+
*/
|
|
49367
|
+
'cron': string;
|
|
49368
|
+
/**
|
|
49369
|
+
* Human-readable description of the cron expression.
|
|
49370
|
+
*/
|
|
49371
|
+
'cronDescription'?: string;
|
|
49372
|
+
/**
|
|
49373
|
+
* Timezone in which the schedule is defined.
|
|
49374
|
+
*/
|
|
49375
|
+
'timezone': string;
|
|
49376
|
+
/**
|
|
49377
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
49378
|
+
*/
|
|
49379
|
+
'firstRun'?: string;
|
|
49380
|
+
}
|
|
49381
|
+
|
|
49382
|
+
export declare interface JsonApiAutomationPatchAttributesSlidesExportsInner {
|
|
49383
|
+
'requestPayload': SlidesExportRequest;
|
|
49384
|
+
}
|
|
49385
|
+
|
|
49382
49386
|
export declare type JsonApiAutomationPatchAttributesStateEnum = 'ACTIVE' | 'PAUSED';
|
|
49383
49387
|
|
|
49388
|
+
export declare interface JsonApiAutomationPatchAttributesTabularExportsInner {
|
|
49389
|
+
'requestPayload': TabularExportRequest;
|
|
49390
|
+
}
|
|
49391
|
+
|
|
49392
|
+
export declare interface JsonApiAutomationPatchAttributesVisualExportsInner {
|
|
49393
|
+
'requestPayload': VisualExportRequest;
|
|
49394
|
+
}
|
|
49395
|
+
|
|
49384
49396
|
export declare interface JsonApiAutomationPatchDocument {
|
|
49385
49397
|
'data': JsonApiAutomationPatch;
|
|
49386
49398
|
}
|
|
49387
49399
|
|
|
49388
49400
|
export declare interface JsonApiAutomationPatchRelationships {
|
|
49389
|
-
'notificationChannel'?:
|
|
49390
|
-
'analyticalDashboard'?:
|
|
49391
|
-
'exportDefinitions'?:
|
|
49392
|
-
'recipients'?:
|
|
49401
|
+
'notificationChannel'?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
49402
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
49403
|
+
'exportDefinitions'?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
49404
|
+
'recipients'?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
49405
|
+
}
|
|
49406
|
+
|
|
49407
|
+
export declare interface JsonApiAutomationPatchRelationshipsAnalyticalDashboard {
|
|
49408
|
+
'data': JsonApiAnalyticalDashboardLinkage | null;
|
|
49409
|
+
}
|
|
49410
|
+
|
|
49411
|
+
export declare interface JsonApiAutomationPatchRelationshipsExportDefinitions {
|
|
49412
|
+
/**
|
|
49413
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
49414
|
+
*/
|
|
49415
|
+
'data': Array<JsonApiExportDefinitionLinkage>;
|
|
49416
|
+
}
|
|
49417
|
+
|
|
49418
|
+
export declare interface JsonApiAutomationPatchRelationshipsNotificationChannel {
|
|
49419
|
+
'data': JsonApiNotificationChannelLinkage | null;
|
|
49420
|
+
}
|
|
49421
|
+
|
|
49422
|
+
export declare interface JsonApiAutomationPatchRelationshipsRecipients {
|
|
49423
|
+
/**
|
|
49424
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
49425
|
+
*/
|
|
49426
|
+
'data': Array<JsonApiUserLinkage>;
|
|
49393
49427
|
}
|
|
49394
49428
|
|
|
49395
49429
|
export declare type JsonApiAutomationPatchTypeEnum = 'automation';
|
|
@@ -49441,7 +49475,7 @@ export declare type JsonApiAutomationResultOutAttributesStatusEnum = 'SUCCESS' |
|
|
|
49441
49475
|
export declare interface JsonApiAutomationResultOutList {
|
|
49442
49476
|
'data': Array<JsonApiAutomationResultOutWithLinks>;
|
|
49443
49477
|
'links'?: ListLinks;
|
|
49444
|
-
'meta'?:
|
|
49478
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
49445
49479
|
/**
|
|
49446
49480
|
* Included resources
|
|
49447
49481
|
*/
|
|
@@ -49525,7 +49559,7 @@ export declare interface JsonApiColorPaletteOutDocument {
|
|
|
49525
49559
|
export declare interface JsonApiColorPaletteOutList {
|
|
49526
49560
|
'data': Array<JsonApiColorPaletteOutWithLinks>;
|
|
49527
49561
|
'links'?: ListLinks;
|
|
49528
|
-
'meta'?:
|
|
49562
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
49529
49563
|
}
|
|
49530
49564
|
|
|
49531
49565
|
export declare type JsonApiColorPaletteOutTypeEnum = 'colorPalette';
|
|
@@ -49586,7 +49620,7 @@ export declare interface JsonApiCookieSecurityConfigurationIn {
|
|
|
49586
49620
|
* API identifier of an object
|
|
49587
49621
|
*/
|
|
49588
49622
|
'id': string;
|
|
49589
|
-
'attributes'?:
|
|
49623
|
+
'attributes'?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
49590
49624
|
}
|
|
49591
49625
|
|
|
49592
49626
|
export declare interface JsonApiCookieSecurityConfigurationInDocument {
|
|
@@ -49607,7 +49641,15 @@ export declare interface JsonApiCookieSecurityConfigurationOut {
|
|
|
49607
49641
|
* API identifier of an object
|
|
49608
49642
|
*/
|
|
49609
49643
|
'id': string;
|
|
49610
|
-
'attributes'?:
|
|
49644
|
+
'attributes'?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
49645
|
+
}
|
|
49646
|
+
|
|
49647
|
+
export declare interface JsonApiCookieSecurityConfigurationOutAttributes {
|
|
49648
|
+
'lastRotation'?: string;
|
|
49649
|
+
/**
|
|
49650
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
49651
|
+
*/
|
|
49652
|
+
'rotationInterval'?: string;
|
|
49611
49653
|
}
|
|
49612
49654
|
|
|
49613
49655
|
export declare interface JsonApiCookieSecurityConfigurationOutDocument {
|
|
@@ -49629,15 +49671,7 @@ export declare interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
49629
49671
|
* API identifier of an object
|
|
49630
49672
|
*/
|
|
49631
49673
|
'id': string;
|
|
49632
|
-
'attributes'?:
|
|
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;
|
|
49674
|
+
'attributes'?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
49641
49675
|
}
|
|
49642
49676
|
|
|
49643
49677
|
export declare interface JsonApiCookieSecurityConfigurationPatchDocument {
|
|
@@ -49697,7 +49731,7 @@ export declare interface JsonApiCspDirectiveOutDocument {
|
|
|
49697
49731
|
export declare interface JsonApiCspDirectiveOutList {
|
|
49698
49732
|
'data': Array<JsonApiCspDirectiveOutWithLinks>;
|
|
49699
49733
|
'links'?: ListLinks;
|
|
49700
|
-
'meta'?:
|
|
49734
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
49701
49735
|
}
|
|
49702
49736
|
|
|
49703
49737
|
export declare type JsonApiCspDirectiveOutTypeEnum = 'cspDirective';
|
|
@@ -49775,7 +49809,7 @@ export declare interface JsonApiCustomApplicationSettingOut {
|
|
|
49775
49809
|
* API identifier of an object
|
|
49776
49810
|
*/
|
|
49777
49811
|
'id': string;
|
|
49778
|
-
'meta'?:
|
|
49812
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
49779
49813
|
'attributes': JsonApiCustomApplicationSettingOutAttributes;
|
|
49780
49814
|
}
|
|
49781
49815
|
|
|
@@ -49798,7 +49832,7 @@ export declare interface JsonApiCustomApplicationSettingOutDocument {
|
|
|
49798
49832
|
export declare interface JsonApiCustomApplicationSettingOutList {
|
|
49799
49833
|
'data': Array<JsonApiCustomApplicationSettingOutWithLinks>;
|
|
49800
49834
|
'links'?: ListLinks;
|
|
49801
|
-
'meta'?:
|
|
49835
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
49802
49836
|
}
|
|
49803
49837
|
|
|
49804
49838
|
export declare type JsonApiCustomApplicationSettingOutTypeEnum = 'customApplicationSetting';
|
|
@@ -49812,7 +49846,7 @@ export declare interface JsonApiCustomApplicationSettingOutWithLinks {
|
|
|
49812
49846
|
* API identifier of an object
|
|
49813
49847
|
*/
|
|
49814
49848
|
'id': string;
|
|
49815
|
-
'meta'?:
|
|
49849
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
49816
49850
|
'attributes': JsonApiCustomApplicationSettingOutAttributes;
|
|
49817
49851
|
'links'?: ObjectLinks;
|
|
49818
49852
|
}
|
|
@@ -49881,7 +49915,7 @@ export declare interface JsonApiCustomGeoCollectionIn {
|
|
|
49881
49915
|
* API identifier of an object
|
|
49882
49916
|
*/
|
|
49883
49917
|
'id': string;
|
|
49884
|
-
'attributes'?:
|
|
49918
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
49885
49919
|
}
|
|
49886
49920
|
|
|
49887
49921
|
export declare interface JsonApiCustomGeoCollectionInDocument {
|
|
@@ -49902,7 +49936,12 @@ export declare interface JsonApiCustomGeoCollectionOut {
|
|
|
49902
49936
|
* API identifier of an object
|
|
49903
49937
|
*/
|
|
49904
49938
|
'id': string;
|
|
49905
|
-
'attributes'?:
|
|
49939
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
49940
|
+
}
|
|
49941
|
+
|
|
49942
|
+
export declare interface JsonApiCustomGeoCollectionOutAttributes {
|
|
49943
|
+
'name'?: string | null;
|
|
49944
|
+
'description'?: string | null;
|
|
49906
49945
|
}
|
|
49907
49946
|
|
|
49908
49947
|
export declare interface JsonApiCustomGeoCollectionOutDocument {
|
|
@@ -49916,7 +49955,7 @@ export declare interface JsonApiCustomGeoCollectionOutDocument {
|
|
|
49916
49955
|
export declare interface JsonApiCustomGeoCollectionOutList {
|
|
49917
49956
|
'data': Array<JsonApiCustomGeoCollectionOutWithLinks>;
|
|
49918
49957
|
'links'?: ListLinks;
|
|
49919
|
-
'meta'?:
|
|
49958
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
49920
49959
|
}
|
|
49921
49960
|
|
|
49922
49961
|
export declare type JsonApiCustomGeoCollectionOutTypeEnum = 'customGeoCollection';
|
|
@@ -49930,7 +49969,7 @@ export declare interface JsonApiCustomGeoCollectionOutWithLinks {
|
|
|
49930
49969
|
* API identifier of an object
|
|
49931
49970
|
*/
|
|
49932
49971
|
'id': string;
|
|
49933
|
-
'attributes'?:
|
|
49972
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
49934
49973
|
'links'?: ObjectLinks;
|
|
49935
49974
|
}
|
|
49936
49975
|
|
|
@@ -49948,12 +49987,7 @@ export declare interface JsonApiCustomGeoCollectionPatch {
|
|
|
49948
49987
|
* API identifier of an object
|
|
49949
49988
|
*/
|
|
49950
49989
|
'id': string;
|
|
49951
|
-
'attributes'?:
|
|
49952
|
-
}
|
|
49953
|
-
|
|
49954
|
-
export declare interface JsonApiCustomGeoCollectionPatchAttributes {
|
|
49955
|
-
'name'?: string | null;
|
|
49956
|
-
'description'?: string | null;
|
|
49990
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
49957
49991
|
}
|
|
49958
49992
|
|
|
49959
49993
|
export declare interface JsonApiCustomGeoCollectionPatchDocument {
|
|
@@ -50005,7 +50039,7 @@ export declare interface JsonApiDashboardPluginOut {
|
|
|
50005
50039
|
* API identifier of an object
|
|
50006
50040
|
*/
|
|
50007
50041
|
'id': string;
|
|
50008
|
-
'meta'?:
|
|
50042
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
50009
50043
|
'attributes'?: JsonApiDashboardPluginOutAttributes;
|
|
50010
50044
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
50011
50045
|
}
|
|
@@ -50044,7 +50078,7 @@ export declare interface JsonApiDashboardPluginOutDocument {
|
|
|
50044
50078
|
export declare interface JsonApiDashboardPluginOutList {
|
|
50045
50079
|
'data': Array<JsonApiDashboardPluginOutWithLinks>;
|
|
50046
50080
|
'links'?: ListLinks;
|
|
50047
|
-
'meta'?:
|
|
50081
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
50048
50082
|
/**
|
|
50049
50083
|
* Included resources
|
|
50050
50084
|
*/
|
|
@@ -50067,7 +50101,7 @@ export declare interface JsonApiDashboardPluginOutWithLinks {
|
|
|
50067
50101
|
* API identifier of an object
|
|
50068
50102
|
*/
|
|
50069
50103
|
'id': string;
|
|
50070
|
-
'meta'?:
|
|
50104
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
50071
50105
|
'attributes'?: JsonApiDashboardPluginOutAttributes;
|
|
50072
50106
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
50073
50107
|
'links'?: ObjectLinks;
|
|
@@ -50150,7 +50184,7 @@ export declare interface JsonApiDatasetOut {
|
|
|
50150
50184
|
* API identifier of an object
|
|
50151
50185
|
*/
|
|
50152
50186
|
'id': string;
|
|
50153
|
-
'meta'?:
|
|
50187
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
50154
50188
|
'attributes': JsonApiDatasetOutAttributes;
|
|
50155
50189
|
'relationships'?: JsonApiDatasetOutRelationships;
|
|
50156
50190
|
}
|
|
@@ -50236,35 +50270,18 @@ export declare type JsonApiDatasetOutIncludes = JsonApiAggregatedFactOutWithLink
|
|
|
50236
50270
|
export declare interface JsonApiDatasetOutList {
|
|
50237
50271
|
'data': Array<JsonApiDatasetOutWithLinks>;
|
|
50238
50272
|
'links'?: ListLinks;
|
|
50239
|
-
'meta'?:
|
|
50273
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
50240
50274
|
/**
|
|
50241
50275
|
* Included resources
|
|
50242
50276
|
*/
|
|
50243
50277
|
'included'?: Array<JsonApiDatasetOutIncludes>;
|
|
50244
50278
|
}
|
|
50245
50279
|
|
|
50246
|
-
export declare interface JsonApiDatasetOutMeta {
|
|
50247
|
-
'origin'?: JsonApiDatasetOutMetaOrigin;
|
|
50248
|
-
}
|
|
50249
|
-
|
|
50250
|
-
export declare interface JsonApiDatasetOutMetaOrigin {
|
|
50251
|
-
/**
|
|
50252
|
-
* defines type of the origin of the entity
|
|
50253
|
-
*/
|
|
50254
|
-
'originType': JsonApiDatasetOutMetaOriginOriginTypeEnum;
|
|
50255
|
-
/**
|
|
50256
|
-
* defines id of the workspace where the entity comes from
|
|
50257
|
-
*/
|
|
50258
|
-
'originId': string;
|
|
50259
|
-
}
|
|
50260
|
-
|
|
50261
|
-
export declare type JsonApiDatasetOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
50262
|
-
|
|
50263
50280
|
export declare interface JsonApiDatasetOutRelationships {
|
|
50264
|
-
'attributes'?:
|
|
50265
|
-
'facts'?:
|
|
50281
|
+
'attributes'?: JsonApiVisualizationObjectOutRelationshipsAttributes;
|
|
50282
|
+
'facts'?: JsonApiVisualizationObjectOutRelationshipsFacts;
|
|
50266
50283
|
'aggregatedFacts'?: JsonApiDatasetOutRelationshipsAggregatedFacts;
|
|
50267
|
-
'references'?:
|
|
50284
|
+
'references'?: JsonApiVisualizationObjectOutRelationshipsDatasets;
|
|
50268
50285
|
'workspaceDataFilters'?: JsonApiDatasetOutRelationshipsWorkspaceDataFilters;
|
|
50269
50286
|
}
|
|
50270
50287
|
|
|
@@ -50275,27 +50292,6 @@ export declare interface JsonApiDatasetOutRelationshipsAggregatedFacts {
|
|
|
50275
50292
|
'data': Array<JsonApiAggregatedFactLinkage>;
|
|
50276
50293
|
}
|
|
50277
50294
|
|
|
50278
|
-
export declare interface JsonApiDatasetOutRelationshipsAttributes {
|
|
50279
|
-
/**
|
|
50280
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
50281
|
-
*/
|
|
50282
|
-
'data': Array<JsonApiAttributeLinkage>;
|
|
50283
|
-
}
|
|
50284
|
-
|
|
50285
|
-
export declare interface JsonApiDatasetOutRelationshipsFacts {
|
|
50286
|
-
/**
|
|
50287
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
50288
|
-
*/
|
|
50289
|
-
'data': Array<JsonApiFactLinkage>;
|
|
50290
|
-
}
|
|
50291
|
-
|
|
50292
|
-
export declare interface JsonApiDatasetOutRelationshipsReferences {
|
|
50293
|
-
/**
|
|
50294
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
50295
|
-
*/
|
|
50296
|
-
'data': Array<JsonApiDatasetLinkage>;
|
|
50297
|
-
}
|
|
50298
|
-
|
|
50299
50295
|
export declare interface JsonApiDatasetOutRelationshipsWorkspaceDataFilters {
|
|
50300
50296
|
/**
|
|
50301
50297
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -50314,7 +50310,7 @@ export declare interface JsonApiDatasetOutWithLinks {
|
|
|
50314
50310
|
* API identifier of an object
|
|
50315
50311
|
*/
|
|
50316
50312
|
'id': string;
|
|
50317
|
-
'meta'?:
|
|
50313
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
50318
50314
|
'attributes': JsonApiDatasetOutAttributes;
|
|
50319
50315
|
'relationships'?: JsonApiDatasetOutRelationships;
|
|
50320
50316
|
'links'?: ObjectLinks;
|
|
@@ -50355,7 +50351,7 @@ export declare interface JsonApiDataSourceIdentifierOut {
|
|
|
50355
50351
|
* API identifier of an object
|
|
50356
50352
|
*/
|
|
50357
50353
|
'id': string;
|
|
50358
|
-
'meta'?:
|
|
50354
|
+
'meta'?: JsonApiDataSourceIdentifierOutMeta;
|
|
50359
50355
|
'attributes': JsonApiDataSourceIdentifierOutAttributes;
|
|
50360
50356
|
}
|
|
50361
50357
|
|
|
@@ -50378,9 +50374,18 @@ export declare interface JsonApiDataSourceIdentifierOutDocument {
|
|
|
50378
50374
|
export declare interface JsonApiDataSourceIdentifierOutList {
|
|
50379
50375
|
'data': Array<JsonApiDataSourceIdentifierOutWithLinks>;
|
|
50380
50376
|
'links'?: ListLinks;
|
|
50381
|
-
'meta'?:
|
|
50377
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
50382
50378
|
}
|
|
50383
50379
|
|
|
50380
|
+
export declare interface JsonApiDataSourceIdentifierOutMeta {
|
|
50381
|
+
/**
|
|
50382
|
+
* List of valid permissions for a logged-in user.
|
|
50383
|
+
*/
|
|
50384
|
+
'permissions'?: Array<JsonApiDataSourceIdentifierOutMetaPermissionsEnum>;
|
|
50385
|
+
}
|
|
50386
|
+
|
|
50387
|
+
export declare type JsonApiDataSourceIdentifierOutMetaPermissionsEnum = 'MANAGE' | 'USE';
|
|
50388
|
+
|
|
50384
50389
|
export declare type JsonApiDataSourceIdentifierOutTypeEnum = 'dataSourceIdentifier';
|
|
50385
50390
|
|
|
50386
50391
|
export declare interface JsonApiDataSourceIdentifierOutWithLinks {
|
|
@@ -50392,7 +50397,7 @@ export declare interface JsonApiDataSourceIdentifierOutWithLinks {
|
|
|
50392
50397
|
* API identifier of an object
|
|
50393
50398
|
*/
|
|
50394
50399
|
'id': string;
|
|
50395
|
-
'meta'?:
|
|
50400
|
+
'meta'?: JsonApiDataSourceIdentifierOutMeta;
|
|
50396
50401
|
'attributes': JsonApiDataSourceIdentifierOutAttributes;
|
|
50397
50402
|
'links'?: ObjectLinks;
|
|
50398
50403
|
}
|
|
@@ -50462,7 +50467,7 @@ export declare interface JsonApiDataSourceInAttributes {
|
|
|
50462
50467
|
/**
|
|
50463
50468
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
50464
50469
|
*/
|
|
50465
|
-
'parameters'?: Array<
|
|
50470
|
+
'parameters'?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
50466
50471
|
/**
|
|
50467
50472
|
* Determines how the results coming from a particular datasource should be cached.
|
|
50468
50473
|
*/
|
|
@@ -50495,7 +50500,7 @@ export declare interface JsonApiDataSourceOut {
|
|
|
50495
50500
|
* API identifier of an object
|
|
50496
50501
|
*/
|
|
50497
50502
|
'id': string;
|
|
50498
|
-
'meta'?:
|
|
50503
|
+
'meta'?: JsonApiDataSourceIdentifierOutMeta;
|
|
50499
50504
|
'attributes': JsonApiDataSourceOutAttributes;
|
|
50500
50505
|
}
|
|
50501
50506
|
|
|
@@ -50527,11 +50532,11 @@ export declare interface JsonApiDataSourceOutAttributes {
|
|
|
50527
50532
|
/**
|
|
50528
50533
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
50529
50534
|
*/
|
|
50530
|
-
'parameters'?: Array<
|
|
50535
|
+
'parameters'?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
50531
50536
|
/**
|
|
50532
50537
|
* Decoded parameters to be used when connecting to the database providing the data for the data source.
|
|
50533
50538
|
*/
|
|
50534
|
-
'decodedParameters'?: Array<
|
|
50539
|
+
'decodedParameters'?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
50535
50540
|
/**
|
|
50536
50541
|
* Determines how the results coming from a particular datasource should be cached.
|
|
50537
50542
|
*/
|
|
@@ -50550,6 +50555,11 @@ export declare type JsonApiDataSourceOutAttributesAuthenticationTypeEnum = 'USER
|
|
|
50550
50555
|
|
|
50551
50556
|
export declare type JsonApiDataSourceOutAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
50552
50557
|
|
|
50558
|
+
export declare interface JsonApiDataSourceOutAttributesParametersInner {
|
|
50559
|
+
'name': string;
|
|
50560
|
+
'value': string;
|
|
50561
|
+
}
|
|
50562
|
+
|
|
50553
50563
|
export declare type JsonApiDataSourceOutAttributesTypeEnum = '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';
|
|
50554
50564
|
|
|
50555
50565
|
export declare interface JsonApiDataSourceOutDocument {
|
|
@@ -50563,18 +50573,9 @@ export declare interface JsonApiDataSourceOutDocument {
|
|
|
50563
50573
|
export declare interface JsonApiDataSourceOutList {
|
|
50564
50574
|
'data': Array<JsonApiDataSourceOutWithLinks>;
|
|
50565
50575
|
'links'?: ListLinks;
|
|
50566
|
-
'meta'?:
|
|
50567
|
-
}
|
|
50568
|
-
|
|
50569
|
-
export declare interface JsonApiDataSourceOutMeta {
|
|
50570
|
-
/**
|
|
50571
|
-
* List of valid permissions for a logged-in user.
|
|
50572
|
-
*/
|
|
50573
|
-
'permissions'?: Array<JsonApiDataSourceOutMetaPermissionsEnum>;
|
|
50576
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
50574
50577
|
}
|
|
50575
50578
|
|
|
50576
|
-
export declare type JsonApiDataSourceOutMetaPermissionsEnum = 'MANAGE' | 'USE';
|
|
50577
|
-
|
|
50578
50579
|
export declare type JsonApiDataSourceOutTypeEnum = 'dataSource';
|
|
50579
50580
|
|
|
50580
50581
|
export declare interface JsonApiDataSourceOutWithLinks {
|
|
@@ -50586,7 +50587,7 @@ export declare interface JsonApiDataSourceOutWithLinks {
|
|
|
50586
50587
|
* API identifier of an object
|
|
50587
50588
|
*/
|
|
50588
50589
|
'id': string;
|
|
50589
|
-
'meta'?:
|
|
50590
|
+
'meta'?: JsonApiDataSourceIdentifierOutMeta;
|
|
50590
50591
|
'attributes': JsonApiDataSourceOutAttributes;
|
|
50591
50592
|
'links'?: ObjectLinks;
|
|
50592
50593
|
}
|
|
@@ -50656,7 +50657,7 @@ export declare interface JsonApiDataSourcePatchAttributes {
|
|
|
50656
50657
|
/**
|
|
50657
50658
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
50658
50659
|
*/
|
|
50659
|
-
'parameters'?: Array<
|
|
50660
|
+
'parameters'?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
50660
50661
|
/**
|
|
50661
50662
|
* Determines how the results coming from a particular datasource should be cached.
|
|
50662
50663
|
*/
|
|
@@ -50669,11 +50670,6 @@ export declare interface JsonApiDataSourcePatchAttributes {
|
|
|
50669
50670
|
|
|
50670
50671
|
export declare type JsonApiDataSourcePatchAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
50671
50672
|
|
|
50672
|
-
export declare interface JsonApiDataSourcePatchAttributesParametersInner {
|
|
50673
|
-
'name': string;
|
|
50674
|
-
'value': string;
|
|
50675
|
-
}
|
|
50676
|
-
|
|
50677
50673
|
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';
|
|
50678
50674
|
|
|
50679
50675
|
export declare interface JsonApiDataSourcePatchDocument {
|
|
@@ -50713,7 +50709,7 @@ export declare interface JsonApiEntitlementOutDocument {
|
|
|
50713
50709
|
export declare interface JsonApiEntitlementOutList {
|
|
50714
50710
|
'data': Array<JsonApiEntitlementOutWithLinks>;
|
|
50715
50711
|
'links'?: ListLinks;
|
|
50716
|
-
'meta'?:
|
|
50712
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
50717
50713
|
}
|
|
50718
50714
|
|
|
50719
50715
|
export declare type JsonApiEntitlementOutTypeEnum = 'entitlement';
|
|
@@ -50777,7 +50773,7 @@ export declare interface JsonApiExportDefinitionOut {
|
|
|
50777
50773
|
* API identifier of an object
|
|
50778
50774
|
*/
|
|
50779
50775
|
'id': string;
|
|
50780
|
-
'meta'?:
|
|
50776
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
50781
50777
|
'attributes'?: JsonApiExportDefinitionOutAttributes;
|
|
50782
50778
|
'relationships'?: JsonApiExportDefinitionOutRelationships;
|
|
50783
50779
|
}
|
|
@@ -50824,7 +50820,7 @@ export declare type JsonApiExportDefinitionOutIncludes = JsonApiAnalyticalDashbo
|
|
|
50824
50820
|
export declare interface JsonApiExportDefinitionOutList {
|
|
50825
50821
|
'data': Array<JsonApiExportDefinitionOutWithLinks>;
|
|
50826
50822
|
'links'?: ListLinks;
|
|
50827
|
-
'meta'?:
|
|
50823
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
50828
50824
|
/**
|
|
50829
50825
|
* Included resources
|
|
50830
50826
|
*/
|
|
@@ -50833,16 +50829,12 @@ export declare interface JsonApiExportDefinitionOutList {
|
|
|
50833
50829
|
|
|
50834
50830
|
export declare interface JsonApiExportDefinitionOutRelationships {
|
|
50835
50831
|
'visualizationObject'?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
50836
|
-
'analyticalDashboard'?:
|
|
50832
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
50837
50833
|
'automation'?: JsonApiExportDefinitionOutRelationshipsAutomation;
|
|
50838
50834
|
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
50839
50835
|
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
50840
50836
|
}
|
|
50841
50837
|
|
|
50842
|
-
export declare interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard {
|
|
50843
|
-
'data': JsonApiAnalyticalDashboardLinkage | null;
|
|
50844
|
-
}
|
|
50845
|
-
|
|
50846
50838
|
export declare interface JsonApiExportDefinitionOutRelationshipsAutomation {
|
|
50847
50839
|
'data': JsonApiAutomationLinkage | null;
|
|
50848
50840
|
}
|
|
@@ -50862,7 +50854,7 @@ export declare interface JsonApiExportDefinitionOutWithLinks {
|
|
|
50862
50854
|
* API identifier of an object
|
|
50863
50855
|
*/
|
|
50864
50856
|
'id': string;
|
|
50865
|
-
'meta'?:
|
|
50857
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
50866
50858
|
'attributes'?: JsonApiExportDefinitionOutAttributes;
|
|
50867
50859
|
'relationships'?: JsonApiExportDefinitionOutRelationships;
|
|
50868
50860
|
'links'?: ObjectLinks;
|
|
@@ -50900,7 +50892,7 @@ export declare interface JsonApiExportDefinitionPatchDocument {
|
|
|
50900
50892
|
|
|
50901
50893
|
export declare interface JsonApiExportDefinitionPatchRelationships {
|
|
50902
50894
|
'visualizationObject'?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
50903
|
-
'analyticalDashboard'?:
|
|
50895
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
50904
50896
|
}
|
|
50905
50897
|
|
|
50906
50898
|
export declare type JsonApiExportDefinitionPatchTypeEnum = 'exportDefinition';
|
|
@@ -50968,10 +50960,39 @@ export declare interface JsonApiExportTemplateOutAttributes {
|
|
|
50968
50960
|
* User-facing name of the Slides template.
|
|
50969
50961
|
*/
|
|
50970
50962
|
'name': string;
|
|
50971
|
-
'dashboardSlidesTemplate'?:
|
|
50972
|
-
'widgetSlidesTemplate'?:
|
|
50963
|
+
'dashboardSlidesTemplate'?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
50964
|
+
'widgetSlidesTemplate'?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
50973
50965
|
}
|
|
50974
50966
|
|
|
50967
|
+
/**
|
|
50968
|
+
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
50969
|
+
*/
|
|
50970
|
+
export declare interface JsonApiExportTemplateOutAttributesDashboardSlidesTemplate {
|
|
50971
|
+
/**
|
|
50972
|
+
* Export types this template applies to.
|
|
50973
|
+
*/
|
|
50974
|
+
'appliedOn': Array<JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
50975
|
+
'coverSlide'?: CoverSlideTemplate | null;
|
|
50976
|
+
'introSlide'?: IntroSlideTemplate | null;
|
|
50977
|
+
'sectionSlide'?: SectionSlideTemplate | null;
|
|
50978
|
+
'contentSlide'?: ContentSlideTemplate | null;
|
|
50979
|
+
}
|
|
50980
|
+
|
|
50981
|
+
export declare type JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
50982
|
+
|
|
50983
|
+
/**
|
|
50984
|
+
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
50985
|
+
*/
|
|
50986
|
+
export declare interface JsonApiExportTemplateOutAttributesWidgetSlidesTemplate {
|
|
50987
|
+
/**
|
|
50988
|
+
* Export types this template applies to.
|
|
50989
|
+
*/
|
|
50990
|
+
'appliedOn': Array<JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
50991
|
+
'contentSlide'?: ContentSlideTemplate | null;
|
|
50992
|
+
}
|
|
50993
|
+
|
|
50994
|
+
export declare type JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
50995
|
+
|
|
50975
50996
|
export declare interface JsonApiExportTemplateOutDocument {
|
|
50976
50997
|
'data': JsonApiExportTemplateOut;
|
|
50977
50998
|
'links'?: ObjectLinks;
|
|
@@ -50983,7 +51004,7 @@ export declare interface JsonApiExportTemplateOutDocument {
|
|
|
50983
51004
|
export declare interface JsonApiExportTemplateOutList {
|
|
50984
51005
|
'data': Array<JsonApiExportTemplateOutWithLinks>;
|
|
50985
51006
|
'links'?: ListLinks;
|
|
50986
|
-
'meta'?:
|
|
51007
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
50987
51008
|
}
|
|
50988
51009
|
|
|
50989
51010
|
export declare type JsonApiExportTemplateOutTypeEnum = 'exportTemplate';
|
|
@@ -51023,39 +51044,10 @@ export declare interface JsonApiExportTemplatePatchAttributes {
|
|
|
51023
51044
|
* User-facing name of the Slides template.
|
|
51024
51045
|
*/
|
|
51025
51046
|
'name'?: string;
|
|
51026
|
-
'dashboardSlidesTemplate'?:
|
|
51027
|
-
'widgetSlidesTemplate'?:
|
|
51047
|
+
'dashboardSlidesTemplate'?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
51048
|
+
'widgetSlidesTemplate'?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
51028
51049
|
}
|
|
51029
51050
|
|
|
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
|
-
|
|
51059
51051
|
export declare interface JsonApiExportTemplatePatchDocument {
|
|
51060
51052
|
'data': JsonApiExportTemplatePatch;
|
|
51061
51053
|
}
|
|
@@ -51105,7 +51097,7 @@ export declare interface JsonApiFactOut {
|
|
|
51105
51097
|
* API identifier of an object
|
|
51106
51098
|
*/
|
|
51107
51099
|
'id': string;
|
|
51108
|
-
'meta'?:
|
|
51100
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
51109
51101
|
'attributes'?: JsonApiFactOutAttributes;
|
|
51110
51102
|
'relationships'?: JsonApiFactOutRelationships;
|
|
51111
51103
|
}
|
|
@@ -51139,7 +51131,7 @@ export declare interface JsonApiFactOutDocument {
|
|
|
51139
51131
|
export declare interface JsonApiFactOutList {
|
|
51140
51132
|
'data': Array<JsonApiFactOutWithLinks>;
|
|
51141
51133
|
'links'?: ListLinks;
|
|
51142
|
-
'meta'?:
|
|
51134
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
51143
51135
|
/**
|
|
51144
51136
|
* Included resources
|
|
51145
51137
|
*/
|
|
@@ -51147,11 +51139,7 @@ export declare interface JsonApiFactOutList {
|
|
|
51147
51139
|
}
|
|
51148
51140
|
|
|
51149
51141
|
export declare interface JsonApiFactOutRelationships {
|
|
51150
|
-
'dataset'?:
|
|
51151
|
-
}
|
|
51152
|
-
|
|
51153
|
-
export declare interface JsonApiFactOutRelationshipsDataset {
|
|
51154
|
-
'data': JsonApiDatasetLinkage | null;
|
|
51142
|
+
'dataset'?: JsonApiAttributeOutRelationshipsDataset;
|
|
51155
51143
|
}
|
|
51156
51144
|
|
|
51157
51145
|
export declare type JsonApiFactOutTypeEnum = 'fact';
|
|
@@ -51165,7 +51153,7 @@ export declare interface JsonApiFactOutWithLinks {
|
|
|
51165
51153
|
* API identifier of an object
|
|
51166
51154
|
*/
|
|
51167
51155
|
'id': string;
|
|
51168
|
-
'meta'?:
|
|
51156
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
51169
51157
|
'attributes'?: JsonApiFactOutAttributes;
|
|
51170
51158
|
'relationships'?: JsonApiFactOutRelationships;
|
|
51171
51159
|
'links'?: ObjectLinks;
|
|
@@ -51237,7 +51225,7 @@ export declare interface JsonApiFilterContextOut {
|
|
|
51237
51225
|
* API identifier of an object
|
|
51238
51226
|
*/
|
|
51239
51227
|
'id': string;
|
|
51240
|
-
'meta'?:
|
|
51228
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
51241
51229
|
'attributes': JsonApiFilterContextOutAttributes;
|
|
51242
51230
|
'relationships'?: JsonApiFilterContextOutRelationships;
|
|
51243
51231
|
}
|
|
@@ -51273,7 +51261,7 @@ export declare type JsonApiFilterContextOutIncludes = JsonApiAttributeOutWithLin
|
|
|
51273
51261
|
export declare interface JsonApiFilterContextOutList {
|
|
51274
51262
|
'data': Array<JsonApiFilterContextOutWithLinks>;
|
|
51275
51263
|
'links'?: ListLinks;
|
|
51276
|
-
'meta'?:
|
|
51264
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
51277
51265
|
/**
|
|
51278
51266
|
* Included resources
|
|
51279
51267
|
*/
|
|
@@ -51281,8 +51269,8 @@ export declare interface JsonApiFilterContextOutList {
|
|
|
51281
51269
|
}
|
|
51282
51270
|
|
|
51283
51271
|
export declare interface JsonApiFilterContextOutRelationships {
|
|
51284
|
-
'attributes'?:
|
|
51285
|
-
'datasets'?:
|
|
51272
|
+
'attributes'?: JsonApiVisualizationObjectOutRelationshipsAttributes;
|
|
51273
|
+
'datasets'?: JsonApiVisualizationObjectOutRelationshipsDatasets;
|
|
51286
51274
|
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
51287
51275
|
}
|
|
51288
51276
|
|
|
@@ -51297,7 +51285,7 @@ export declare interface JsonApiFilterContextOutWithLinks {
|
|
|
51297
51285
|
* API identifier of an object
|
|
51298
51286
|
*/
|
|
51299
51287
|
'id': string;
|
|
51300
|
-
'meta'?:
|
|
51288
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
51301
51289
|
'attributes': JsonApiFilterContextOutAttributes;
|
|
51302
51290
|
'relationships'?: JsonApiFilterContextOutRelationships;
|
|
51303
51291
|
'links'?: ObjectLinks;
|
|
@@ -51371,7 +51359,7 @@ export declare interface JsonApiFilterViewIn {
|
|
|
51371
51359
|
*/
|
|
51372
51360
|
'id': string;
|
|
51373
51361
|
'attributes': JsonApiFilterViewOutAttributes;
|
|
51374
|
-
'relationships'?:
|
|
51362
|
+
'relationships'?: JsonApiFilterViewPatchRelationships;
|
|
51375
51363
|
}
|
|
51376
51364
|
|
|
51377
51365
|
export declare interface JsonApiFilterViewInDocument {
|
|
@@ -51393,7 +51381,7 @@ export declare interface JsonApiFilterViewOut {
|
|
|
51393
51381
|
*/
|
|
51394
51382
|
'id': string;
|
|
51395
51383
|
'attributes': JsonApiFilterViewOutAttributes;
|
|
51396
|
-
'relationships'?:
|
|
51384
|
+
'relationships'?: JsonApiFilterViewPatchRelationships;
|
|
51397
51385
|
}
|
|
51398
51386
|
|
|
51399
51387
|
export declare interface JsonApiFilterViewOutAttributes {
|
|
@@ -51431,18 +51419,13 @@ export declare type JsonApiFilterViewOutIncludes = JsonApiAnalyticalDashboardOut
|
|
|
51431
51419
|
export declare interface JsonApiFilterViewOutList {
|
|
51432
51420
|
'data': Array<JsonApiFilterViewOutWithLinks>;
|
|
51433
51421
|
'links'?: ListLinks;
|
|
51434
|
-
'meta'?:
|
|
51422
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
51435
51423
|
/**
|
|
51436
51424
|
* Included resources
|
|
51437
51425
|
*/
|
|
51438
51426
|
'included'?: Array<JsonApiFilterViewOutIncludes>;
|
|
51439
51427
|
}
|
|
51440
51428
|
|
|
51441
|
-
export declare interface JsonApiFilterViewOutRelationships {
|
|
51442
|
-
'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
51443
|
-
'user'?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
51444
|
-
}
|
|
51445
|
-
|
|
51446
51429
|
export declare type JsonApiFilterViewOutTypeEnum = 'filterView';
|
|
51447
51430
|
|
|
51448
51431
|
export declare interface JsonApiFilterViewOutWithLinks {
|
|
@@ -51455,7 +51438,7 @@ export declare interface JsonApiFilterViewOutWithLinks {
|
|
|
51455
51438
|
*/
|
|
51456
51439
|
'id': string;
|
|
51457
51440
|
'attributes': JsonApiFilterViewOutAttributes;
|
|
51458
|
-
'relationships'?:
|
|
51441
|
+
'relationships'?: JsonApiFilterViewPatchRelationships;
|
|
51459
51442
|
'links'?: ObjectLinks;
|
|
51460
51443
|
}
|
|
51461
51444
|
|
|
@@ -51474,7 +51457,7 @@ export declare interface JsonApiFilterViewPatch {
|
|
|
51474
51457
|
*/
|
|
51475
51458
|
'id': string;
|
|
51476
51459
|
'attributes': JsonApiFilterViewPatchAttributes;
|
|
51477
|
-
'relationships'?:
|
|
51460
|
+
'relationships'?: JsonApiFilterViewPatchRelationships;
|
|
51478
51461
|
}
|
|
51479
51462
|
|
|
51480
51463
|
export declare interface JsonApiFilterViewPatchAttributes {
|
|
@@ -51496,6 +51479,15 @@ export declare interface JsonApiFilterViewPatchDocument {
|
|
|
51496
51479
|
'data': JsonApiFilterViewPatch;
|
|
51497
51480
|
}
|
|
51498
51481
|
|
|
51482
|
+
export declare interface JsonApiFilterViewPatchRelationships {
|
|
51483
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
51484
|
+
'user'?: JsonApiFilterViewPatchRelationshipsUser;
|
|
51485
|
+
}
|
|
51486
|
+
|
|
51487
|
+
export declare interface JsonApiFilterViewPatchRelationshipsUser {
|
|
51488
|
+
'data': JsonApiUserLinkage | null;
|
|
51489
|
+
}
|
|
51490
|
+
|
|
51499
51491
|
export declare type JsonApiFilterViewPatchTypeEnum = 'filterView';
|
|
51500
51492
|
|
|
51501
51493
|
/**
|
|
@@ -51519,9 +51511,62 @@ export declare interface JsonApiIdentityProviderIn {
|
|
|
51519
51511
|
* API identifier of an object
|
|
51520
51512
|
*/
|
|
51521
51513
|
'id': string;
|
|
51522
|
-
'attributes'?:
|
|
51514
|
+
'attributes'?: JsonApiIdentityProviderInAttributes;
|
|
51515
|
+
}
|
|
51516
|
+
|
|
51517
|
+
export declare interface JsonApiIdentityProviderInAttributes {
|
|
51518
|
+
/**
|
|
51519
|
+
* 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.
|
|
51520
|
+
*/
|
|
51521
|
+
'identifiers'?: Array<string>;
|
|
51522
|
+
/**
|
|
51523
|
+
* 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.
|
|
51524
|
+
*/
|
|
51525
|
+
'customClaimMapping'?: {
|
|
51526
|
+
[key: string]: string;
|
|
51527
|
+
};
|
|
51528
|
+
/**
|
|
51529
|
+
* 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.
|
|
51530
|
+
*/
|
|
51531
|
+
'samlMetadata'?: string;
|
|
51532
|
+
/**
|
|
51533
|
+
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
51534
|
+
*/
|
|
51535
|
+
'oauthClientId'?: string;
|
|
51536
|
+
/**
|
|
51537
|
+
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
51538
|
+
*/
|
|
51539
|
+
'oauthClientSecret'?: string;
|
|
51540
|
+
/**
|
|
51541
|
+
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
51542
|
+
*/
|
|
51543
|
+
'oauthIssuerLocation'?: string;
|
|
51544
|
+
/**
|
|
51545
|
+
* 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.
|
|
51546
|
+
*/
|
|
51547
|
+
'oauthIssuerId'?: string;
|
|
51548
|
+
/**
|
|
51549
|
+
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
51550
|
+
*/
|
|
51551
|
+
'oauthSubjectIdClaim'?: string;
|
|
51552
|
+
/**
|
|
51553
|
+
* 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.
|
|
51554
|
+
*/
|
|
51555
|
+
'oauthCustomAuthAttributes'?: {
|
|
51556
|
+
[key: string]: string;
|
|
51557
|
+
};
|
|
51558
|
+
/**
|
|
51559
|
+
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
51560
|
+
*/
|
|
51561
|
+
'oauthCustomScopes'?: Array<string> | null;
|
|
51562
|
+
/**
|
|
51563
|
+
* 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.
|
|
51564
|
+
*/
|
|
51565
|
+
'idpType'?: JsonApiIdentityProviderInAttributesIdpTypeEnum;
|
|
51523
51566
|
}
|
|
51524
51567
|
|
|
51568
|
+
export declare type JsonApiIdentityProviderInAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
|
|
51569
|
+
|
|
51525
51570
|
export declare interface JsonApiIdentityProviderInDocument {
|
|
51526
51571
|
'data': JsonApiIdentityProviderIn;
|
|
51527
51572
|
}
|
|
@@ -51609,7 +51654,7 @@ export declare interface JsonApiIdentityProviderOutDocument {
|
|
|
51609
51654
|
export declare interface JsonApiIdentityProviderOutList {
|
|
51610
51655
|
'data': Array<JsonApiIdentityProviderOutWithLinks>;
|
|
51611
51656
|
'links'?: ListLinks;
|
|
51612
|
-
'meta'?:
|
|
51657
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
51613
51658
|
}
|
|
51614
51659
|
|
|
51615
51660
|
export declare type JsonApiIdentityProviderOutTypeEnum = 'identityProvider';
|
|
@@ -51641,62 +51686,9 @@ export declare interface JsonApiIdentityProviderPatch {
|
|
|
51641
51686
|
* API identifier of an object
|
|
51642
51687
|
*/
|
|
51643
51688
|
'id': string;
|
|
51644
|
-
'attributes'?:
|
|
51689
|
+
'attributes'?: JsonApiIdentityProviderInAttributes;
|
|
51645
51690
|
}
|
|
51646
51691
|
|
|
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;
|
|
51696
|
-
}
|
|
51697
|
-
|
|
51698
|
-
export declare type JsonApiIdentityProviderPatchAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
|
|
51699
|
-
|
|
51700
51692
|
export declare interface JsonApiIdentityProviderPatchDocument {
|
|
51701
51693
|
'data': JsonApiIdentityProviderPatch;
|
|
51702
51694
|
}
|
|
@@ -51715,7 +51707,7 @@ export declare interface JsonApiJwkIn {
|
|
|
51715
51707
|
* API identifier of an object
|
|
51716
51708
|
*/
|
|
51717
51709
|
'id': string;
|
|
51718
|
-
'attributes'?:
|
|
51710
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
51719
51711
|
}
|
|
51720
51712
|
|
|
51721
51713
|
export declare interface JsonApiJwkInDocument {
|
|
@@ -51736,7 +51728,11 @@ export declare interface JsonApiJwkOut {
|
|
|
51736
51728
|
* API identifier of an object
|
|
51737
51729
|
*/
|
|
51738
51730
|
'id': string;
|
|
51739
|
-
'attributes'?:
|
|
51731
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
51732
|
+
}
|
|
51733
|
+
|
|
51734
|
+
export declare interface JsonApiJwkOutAttributes {
|
|
51735
|
+
'content'?: RsaSpecification;
|
|
51740
51736
|
}
|
|
51741
51737
|
|
|
51742
51738
|
export declare interface JsonApiJwkOutDocument {
|
|
@@ -51750,7 +51746,7 @@ export declare interface JsonApiJwkOutDocument {
|
|
|
51750
51746
|
export declare interface JsonApiJwkOutList {
|
|
51751
51747
|
'data': Array<JsonApiJwkOutWithLinks>;
|
|
51752
51748
|
'links'?: ListLinks;
|
|
51753
|
-
'meta'?:
|
|
51749
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
51754
51750
|
}
|
|
51755
51751
|
|
|
51756
51752
|
export declare type JsonApiJwkOutTypeEnum = 'jwk';
|
|
@@ -51764,7 +51760,7 @@ export declare interface JsonApiJwkOutWithLinks {
|
|
|
51764
51760
|
* API identifier of an object
|
|
51765
51761
|
*/
|
|
51766
51762
|
'id': string;
|
|
51767
|
-
'attributes'?:
|
|
51763
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
51768
51764
|
'links'?: ObjectLinks;
|
|
51769
51765
|
}
|
|
51770
51766
|
|
|
@@ -51782,11 +51778,7 @@ export declare interface JsonApiJwkPatch {
|
|
|
51782
51778
|
* API identifier of an object
|
|
51783
51779
|
*/
|
|
51784
51780
|
'id': string;
|
|
51785
|
-
'attributes'?:
|
|
51786
|
-
}
|
|
51787
|
-
|
|
51788
|
-
export declare interface JsonApiJwkPatchAttributes {
|
|
51789
|
-
'content'?: RsaSpecification;
|
|
51781
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
51790
51782
|
}
|
|
51791
51783
|
|
|
51792
51784
|
export declare interface JsonApiJwkPatchDocument {
|
|
@@ -51807,14 +51799,88 @@ export declare interface JsonApiKnowledgeRecommendationIn {
|
|
|
51807
51799
|
* API identifier of an object
|
|
51808
51800
|
*/
|
|
51809
51801
|
'id': string;
|
|
51810
|
-
'attributes':
|
|
51811
|
-
'relationships':
|
|
51802
|
+
'attributes': JsonApiKnowledgeRecommendationInAttributes;
|
|
51803
|
+
'relationships': JsonApiKnowledgeRecommendationInRelationships;
|
|
51812
51804
|
}
|
|
51813
51805
|
|
|
51806
|
+
export declare interface JsonApiKnowledgeRecommendationInAttributes {
|
|
51807
|
+
/**
|
|
51808
|
+
* Human-readable title for the recommendation, e.g. \'Revenue decreased vs last month\'
|
|
51809
|
+
*/
|
|
51810
|
+
'title': string;
|
|
51811
|
+
/**
|
|
51812
|
+
* Description of the recommendation
|
|
51813
|
+
*/
|
|
51814
|
+
'description'?: string;
|
|
51815
|
+
'tags'?: Array<string>;
|
|
51816
|
+
'areRelationsValid'?: boolean;
|
|
51817
|
+
/**
|
|
51818
|
+
* Human-readable title of the metric (denormalized for display)
|
|
51819
|
+
*/
|
|
51820
|
+
'metricTitle'?: string;
|
|
51821
|
+
/**
|
|
51822
|
+
* Direction of the metric change
|
|
51823
|
+
*/
|
|
51824
|
+
'direction': JsonApiKnowledgeRecommendationInAttributesDirectionEnum;
|
|
51825
|
+
/**
|
|
51826
|
+
* Time period for comparison
|
|
51827
|
+
*/
|
|
51828
|
+
'comparisonType': JsonApiKnowledgeRecommendationInAttributesComparisonTypeEnum;
|
|
51829
|
+
/**
|
|
51830
|
+
* ID of the widget where the anomaly was detected
|
|
51831
|
+
*/
|
|
51832
|
+
'widgetId'?: string;
|
|
51833
|
+
/**
|
|
51834
|
+
* Name of the widget where the anomaly was detected
|
|
51835
|
+
*/
|
|
51836
|
+
'widgetName'?: string;
|
|
51837
|
+
/**
|
|
51838
|
+
* Confidence score (0.0 to 1.0)
|
|
51839
|
+
*/
|
|
51840
|
+
'confidence'?: any;
|
|
51841
|
+
/**
|
|
51842
|
+
* Structured recommendations data as JSON
|
|
51843
|
+
*/
|
|
51844
|
+
'recommendations'?: object;
|
|
51845
|
+
/**
|
|
51846
|
+
* Number of source documents used for generation
|
|
51847
|
+
*/
|
|
51848
|
+
'sourceCount'?: number;
|
|
51849
|
+
/**
|
|
51850
|
+
* Reference time period for comparison (e.g., \'2023-06\' or \'Jun 2023\')
|
|
51851
|
+
*/
|
|
51852
|
+
'referencePeriod'?: string;
|
|
51853
|
+
/**
|
|
51854
|
+
* Analyzed time period (e.g., \'2023-07\' or \'July 2023\')
|
|
51855
|
+
*/
|
|
51856
|
+
'analyzedPeriod'?: string;
|
|
51857
|
+
/**
|
|
51858
|
+
* Metric value in the reference period
|
|
51859
|
+
*/
|
|
51860
|
+
'referenceValue'?: any;
|
|
51861
|
+
/**
|
|
51862
|
+
* Metric value in the analyzed period (the observed value that triggered the anomaly)
|
|
51863
|
+
*/
|
|
51864
|
+
'analyzedValue'?: any;
|
|
51865
|
+
/**
|
|
51866
|
+
* Human-readable title of the analytical dashboard (denormalized for display)
|
|
51867
|
+
*/
|
|
51868
|
+
'analyticalDashboardTitle'?: string;
|
|
51869
|
+
}
|
|
51870
|
+
|
|
51871
|
+
export declare type JsonApiKnowledgeRecommendationInAttributesComparisonTypeEnum = 'MONTH' | 'QUARTER' | 'YEAR';
|
|
51872
|
+
|
|
51873
|
+
export declare type JsonApiKnowledgeRecommendationInAttributesDirectionEnum = 'INCREASED' | 'DECREASED';
|
|
51874
|
+
|
|
51814
51875
|
export declare interface JsonApiKnowledgeRecommendationInDocument {
|
|
51815
51876
|
'data': JsonApiKnowledgeRecommendationIn;
|
|
51816
51877
|
}
|
|
51817
51878
|
|
|
51879
|
+
export declare interface JsonApiKnowledgeRecommendationInRelationships {
|
|
51880
|
+
'metric': JsonApiKnowledgeRecommendationPatchRelationshipsMetric;
|
|
51881
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
51882
|
+
}
|
|
51883
|
+
|
|
51818
51884
|
export declare type JsonApiKnowledgeRecommendationInTypeEnum = 'knowledgeRecommendation';
|
|
51819
51885
|
|
|
51820
51886
|
/**
|
|
@@ -51829,9 +51895,9 @@ export declare interface JsonApiKnowledgeRecommendationOut {
|
|
|
51829
51895
|
* API identifier of an object
|
|
51830
51896
|
*/
|
|
51831
51897
|
'id': string;
|
|
51832
|
-
'meta'?:
|
|
51898
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
51833
51899
|
'attributes': JsonApiKnowledgeRecommendationOutAttributes;
|
|
51834
|
-
'relationships'?:
|
|
51900
|
+
'relationships'?: JsonApiKnowledgeRecommendationPatchRelationships;
|
|
51835
51901
|
}
|
|
51836
51902
|
|
|
51837
51903
|
export declare interface JsonApiKnowledgeRecommendationOutAttributes {
|
|
@@ -51924,22 +51990,13 @@ export declare type JsonApiKnowledgeRecommendationOutIncludes = JsonApiAnalytica
|
|
|
51924
51990
|
export declare interface JsonApiKnowledgeRecommendationOutList {
|
|
51925
51991
|
'data': Array<JsonApiKnowledgeRecommendationOutWithLinks>;
|
|
51926
51992
|
'links'?: ListLinks;
|
|
51927
|
-
'meta'?:
|
|
51993
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
51928
51994
|
/**
|
|
51929
51995
|
* Included resources
|
|
51930
51996
|
*/
|
|
51931
51997
|
'included'?: Array<JsonApiKnowledgeRecommendationOutIncludes>;
|
|
51932
51998
|
}
|
|
51933
51999
|
|
|
51934
|
-
export declare interface JsonApiKnowledgeRecommendationOutRelationships {
|
|
51935
|
-
'metric'?: JsonApiKnowledgeRecommendationOutRelationshipsMetric;
|
|
51936
|
-
'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
51937
|
-
}
|
|
51938
|
-
|
|
51939
|
-
export declare interface JsonApiKnowledgeRecommendationOutRelationshipsMetric {
|
|
51940
|
-
'data': JsonApiMetricLinkage | null;
|
|
51941
|
-
}
|
|
51942
|
-
|
|
51943
52000
|
export declare type JsonApiKnowledgeRecommendationOutTypeEnum = 'knowledgeRecommendation';
|
|
51944
52001
|
|
|
51945
52002
|
export declare interface JsonApiKnowledgeRecommendationOutWithLinks {
|
|
@@ -51951,9 +52008,9 @@ export declare interface JsonApiKnowledgeRecommendationOutWithLinks {
|
|
|
51951
52008
|
* API identifier of an object
|
|
51952
52009
|
*/
|
|
51953
52010
|
'id': string;
|
|
51954
|
-
'meta'?:
|
|
52011
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
51955
52012
|
'attributes': JsonApiKnowledgeRecommendationOutAttributes;
|
|
51956
|
-
'relationships'?:
|
|
52013
|
+
'relationships'?: JsonApiKnowledgeRecommendationPatchRelationships;
|
|
51957
52014
|
'links'?: ObjectLinks;
|
|
51958
52015
|
}
|
|
51959
52016
|
|
|
@@ -51972,7 +52029,7 @@ export declare interface JsonApiKnowledgeRecommendationPatch {
|
|
|
51972
52029
|
*/
|
|
51973
52030
|
'id': string;
|
|
51974
52031
|
'attributes': JsonApiKnowledgeRecommendationPatchAttributes;
|
|
51975
|
-
'relationships':
|
|
52032
|
+
'relationships': JsonApiKnowledgeRecommendationPatchRelationships;
|
|
51976
52033
|
}
|
|
51977
52034
|
|
|
51978
52035
|
export declare interface JsonApiKnowledgeRecommendationPatchAttributes {
|
|
@@ -52048,6 +52105,15 @@ export declare interface JsonApiKnowledgeRecommendationPatchDocument {
|
|
|
52048
52105
|
'data': JsonApiKnowledgeRecommendationPatch;
|
|
52049
52106
|
}
|
|
52050
52107
|
|
|
52108
|
+
export declare interface JsonApiKnowledgeRecommendationPatchRelationships {
|
|
52109
|
+
'metric'?: JsonApiKnowledgeRecommendationPatchRelationshipsMetric;
|
|
52110
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
52111
|
+
}
|
|
52112
|
+
|
|
52113
|
+
export declare interface JsonApiKnowledgeRecommendationPatchRelationshipsMetric {
|
|
52114
|
+
'data': JsonApiMetricLinkage | null;
|
|
52115
|
+
}
|
|
52116
|
+
|
|
52051
52117
|
export declare type JsonApiKnowledgeRecommendationPatchTypeEnum = 'knowledgeRecommendation';
|
|
52052
52118
|
|
|
52053
52119
|
/**
|
|
@@ -52062,88 +52128,14 @@ export declare interface JsonApiKnowledgeRecommendationPostOptionalId {
|
|
|
52062
52128
|
* API identifier of an object
|
|
52063
52129
|
*/
|
|
52064
52130
|
'id'?: string;
|
|
52065
|
-
'attributes':
|
|
52066
|
-
'relationships':
|
|
52131
|
+
'attributes': JsonApiKnowledgeRecommendationInAttributes;
|
|
52132
|
+
'relationships': JsonApiKnowledgeRecommendationInRelationships;
|
|
52067
52133
|
}
|
|
52068
52134
|
|
|
52069
|
-
export declare interface JsonApiKnowledgeRecommendationPostOptionalIdAttributes {
|
|
52070
|
-
/**
|
|
52071
|
-
* Human-readable title for the recommendation, e.g. \'Revenue decreased vs last month\'
|
|
52072
|
-
*/
|
|
52073
|
-
'title': string;
|
|
52074
|
-
/**
|
|
52075
|
-
* Description of the recommendation
|
|
52076
|
-
*/
|
|
52077
|
-
'description'?: string;
|
|
52078
|
-
'tags'?: Array<string>;
|
|
52079
|
-
'areRelationsValid'?: boolean;
|
|
52080
|
-
/**
|
|
52081
|
-
* Human-readable title of the metric (denormalized for display)
|
|
52082
|
-
*/
|
|
52083
|
-
'metricTitle'?: string;
|
|
52084
|
-
/**
|
|
52085
|
-
* Direction of the metric change
|
|
52086
|
-
*/
|
|
52087
|
-
'direction': JsonApiKnowledgeRecommendationPostOptionalIdAttributesDirectionEnum;
|
|
52088
|
-
/**
|
|
52089
|
-
* Time period for comparison
|
|
52090
|
-
*/
|
|
52091
|
-
'comparisonType': JsonApiKnowledgeRecommendationPostOptionalIdAttributesComparisonTypeEnum;
|
|
52092
|
-
/**
|
|
52093
|
-
* ID of the widget where the anomaly was detected
|
|
52094
|
-
*/
|
|
52095
|
-
'widgetId'?: string;
|
|
52096
|
-
/**
|
|
52097
|
-
* Name of the widget where the anomaly was detected
|
|
52098
|
-
*/
|
|
52099
|
-
'widgetName'?: string;
|
|
52100
|
-
/**
|
|
52101
|
-
* Confidence score (0.0 to 1.0)
|
|
52102
|
-
*/
|
|
52103
|
-
'confidence'?: any;
|
|
52104
|
-
/**
|
|
52105
|
-
* Structured recommendations data as JSON
|
|
52106
|
-
*/
|
|
52107
|
-
'recommendations'?: object;
|
|
52108
|
-
/**
|
|
52109
|
-
* Number of source documents used for generation
|
|
52110
|
-
*/
|
|
52111
|
-
'sourceCount'?: number;
|
|
52112
|
-
/**
|
|
52113
|
-
* Reference time period for comparison (e.g., \'2023-06\' or \'Jun 2023\')
|
|
52114
|
-
*/
|
|
52115
|
-
'referencePeriod'?: string;
|
|
52116
|
-
/**
|
|
52117
|
-
* Analyzed time period (e.g., \'2023-07\' or \'July 2023\')
|
|
52118
|
-
*/
|
|
52119
|
-
'analyzedPeriod'?: string;
|
|
52120
|
-
/**
|
|
52121
|
-
* Metric value in the reference period
|
|
52122
|
-
*/
|
|
52123
|
-
'referenceValue'?: any;
|
|
52124
|
-
/**
|
|
52125
|
-
* Metric value in the analyzed period (the observed value that triggered the anomaly)
|
|
52126
|
-
*/
|
|
52127
|
-
'analyzedValue'?: any;
|
|
52128
|
-
/**
|
|
52129
|
-
* Human-readable title of the analytical dashboard (denormalized for display)
|
|
52130
|
-
*/
|
|
52131
|
-
'analyticalDashboardTitle'?: string;
|
|
52132
|
-
}
|
|
52133
|
-
|
|
52134
|
-
export declare type JsonApiKnowledgeRecommendationPostOptionalIdAttributesComparisonTypeEnum = 'MONTH' | 'QUARTER' | 'YEAR';
|
|
52135
|
-
|
|
52136
|
-
export declare type JsonApiKnowledgeRecommendationPostOptionalIdAttributesDirectionEnum = 'INCREASED' | 'DECREASED';
|
|
52137
|
-
|
|
52138
52135
|
export declare interface JsonApiKnowledgeRecommendationPostOptionalIdDocument {
|
|
52139
52136
|
'data': JsonApiKnowledgeRecommendationPostOptionalId;
|
|
52140
52137
|
}
|
|
52141
52138
|
|
|
52142
|
-
export declare interface JsonApiKnowledgeRecommendationPostOptionalIdRelationships {
|
|
52143
|
-
'metric': JsonApiKnowledgeRecommendationOutRelationshipsMetric;
|
|
52144
|
-
'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
52145
|
-
}
|
|
52146
|
-
|
|
52147
52139
|
export declare type JsonApiKnowledgeRecommendationPostOptionalIdTypeEnum = 'knowledgeRecommendation';
|
|
52148
52140
|
|
|
52149
52141
|
/**
|
|
@@ -52168,7 +52160,7 @@ export declare interface JsonApiLabelOut {
|
|
|
52168
52160
|
* API identifier of an object
|
|
52169
52161
|
*/
|
|
52170
52162
|
'id': string;
|
|
52171
|
-
'meta'?:
|
|
52163
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
52172
52164
|
'attributes'?: JsonApiLabelOutAttributes;
|
|
52173
52165
|
'relationships'?: JsonApiLabelOutRelationships;
|
|
52174
52166
|
}
|
|
@@ -52221,7 +52213,7 @@ export declare interface JsonApiLabelOutDocument {
|
|
|
52221
52213
|
export declare interface JsonApiLabelOutList {
|
|
52222
52214
|
'data': Array<JsonApiLabelOutWithLinks>;
|
|
52223
52215
|
'links'?: ListLinks;
|
|
52224
|
-
'meta'?:
|
|
52216
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
52225
52217
|
/**
|
|
52226
52218
|
* Included resources
|
|
52227
52219
|
*/
|
|
@@ -52247,7 +52239,7 @@ export declare interface JsonApiLabelOutWithLinks {
|
|
|
52247
52239
|
* API identifier of an object
|
|
52248
52240
|
*/
|
|
52249
52241
|
'id': string;
|
|
52250
|
-
'meta'?:
|
|
52242
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
52251
52243
|
'attributes'?: JsonApiLabelOutAttributes;
|
|
52252
52244
|
'relationships'?: JsonApiLabelOutRelationships;
|
|
52253
52245
|
'links'?: ObjectLinks;
|
|
@@ -52377,7 +52369,7 @@ export declare interface JsonApiLlmEndpointOutDocument {
|
|
|
52377
52369
|
export declare interface JsonApiLlmEndpointOutList {
|
|
52378
52370
|
'data': Array<JsonApiLlmEndpointOutWithLinks>;
|
|
52379
52371
|
'links'?: ListLinks;
|
|
52380
|
-
'meta'?:
|
|
52372
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
52381
52373
|
}
|
|
52382
52374
|
|
|
52383
52375
|
export declare type JsonApiLlmEndpointOutTypeEnum = 'llmEndpoint';
|
|
@@ -52489,13 +52481,35 @@ export declare interface JsonApiLlmProviderOutAttributes {
|
|
|
52489
52481
|
* Description of the LLM Provider.
|
|
52490
52482
|
*/
|
|
52491
52483
|
'description'?: string | null;
|
|
52492
|
-
'providerConfig':
|
|
52484
|
+
'providerConfig': JsonApiLlmProviderOutAttributesProviderConfig;
|
|
52493
52485
|
/**
|
|
52494
52486
|
* List of LLM models available for this provider.
|
|
52495
52487
|
*/
|
|
52496
|
-
'models': Array<
|
|
52488
|
+
'models': Array<JsonApiLlmProviderOutAttributesModelsInner> | null;
|
|
52489
|
+
}
|
|
52490
|
+
|
|
52491
|
+
/**
|
|
52492
|
+
* LLM Model configuration (id, family) within a provider.
|
|
52493
|
+
*/
|
|
52494
|
+
export declare interface JsonApiLlmProviderOutAttributesModelsInner {
|
|
52495
|
+
/**
|
|
52496
|
+
* Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
|
|
52497
|
+
*/
|
|
52498
|
+
'id': string;
|
|
52499
|
+
/**
|
|
52500
|
+
* Family of LLM models.
|
|
52501
|
+
*/
|
|
52502
|
+
'family': JsonApiLlmProviderOutAttributesModelsInnerFamilyEnum;
|
|
52497
52503
|
}
|
|
52498
52504
|
|
|
52505
|
+
export declare type JsonApiLlmProviderOutAttributesModelsInnerFamilyEnum = 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE';
|
|
52506
|
+
|
|
52507
|
+
/**
|
|
52508
|
+
* @type JsonApiLlmProviderOutAttributesProviderConfig
|
|
52509
|
+
* Provider-specific configuration including authentication.
|
|
52510
|
+
*/
|
|
52511
|
+
export declare type JsonApiLlmProviderOutAttributesProviderConfig = AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
52512
|
+
|
|
52499
52513
|
export declare interface JsonApiLlmProviderOutDocument {
|
|
52500
52514
|
'data': JsonApiLlmProviderOut;
|
|
52501
52515
|
'links'?: ObjectLinks;
|
|
@@ -52507,7 +52521,7 @@ export declare interface JsonApiLlmProviderOutDocument {
|
|
|
52507
52521
|
export declare interface JsonApiLlmProviderOutList {
|
|
52508
52522
|
'data': Array<JsonApiLlmProviderOutWithLinks>;
|
|
52509
52523
|
'links'?: ListLinks;
|
|
52510
|
-
'meta'?:
|
|
52524
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
52511
52525
|
}
|
|
52512
52526
|
|
|
52513
52527
|
export declare type JsonApiLlmProviderOutTypeEnum = 'llmProvider';
|
|
@@ -52548,35 +52562,13 @@ export declare interface JsonApiLlmProviderPatchAttributes {
|
|
|
52548
52562
|
* Description of the LLM Provider.
|
|
52549
52563
|
*/
|
|
52550
52564
|
'description'?: string | null;
|
|
52551
|
-
'providerConfig'?:
|
|
52565
|
+
'providerConfig'?: JsonApiLlmProviderOutAttributesProviderConfig;
|
|
52552
52566
|
/**
|
|
52553
52567
|
* List of LLM models available for this provider.
|
|
52554
52568
|
*/
|
|
52555
|
-
'models'?: Array<
|
|
52556
|
-
}
|
|
52557
|
-
|
|
52558
|
-
/**
|
|
52559
|
-
* LLM Model configuration (id, family) within a provider.
|
|
52560
|
-
*/
|
|
52561
|
-
export declare interface JsonApiLlmProviderPatchAttributesModelsInner {
|
|
52562
|
-
/**
|
|
52563
|
-
* Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
|
|
52564
|
-
*/
|
|
52565
|
-
'id': string;
|
|
52566
|
-
/**
|
|
52567
|
-
* Family of LLM models.
|
|
52568
|
-
*/
|
|
52569
|
-
'family': JsonApiLlmProviderPatchAttributesModelsInnerFamilyEnum;
|
|
52569
|
+
'models'?: Array<JsonApiLlmProviderOutAttributesModelsInner> | null;
|
|
52570
52570
|
}
|
|
52571
52571
|
|
|
52572
|
-
export declare type JsonApiLlmProviderPatchAttributesModelsInnerFamilyEnum = 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE';
|
|
52573
|
-
|
|
52574
|
-
/**
|
|
52575
|
-
* @type JsonApiLlmProviderPatchAttributesProviderConfig
|
|
52576
|
-
* Provider-specific configuration including authentication.
|
|
52577
|
-
*/
|
|
52578
|
-
export declare type JsonApiLlmProviderPatchAttributesProviderConfig = AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
52579
|
-
|
|
52580
52572
|
export declare interface JsonApiLlmProviderPatchDocument {
|
|
52581
52573
|
'data': JsonApiLlmProviderPatch;
|
|
52582
52574
|
}
|
|
@@ -52595,9 +52587,34 @@ export declare interface JsonApiMemoryItemIn {
|
|
|
52595
52587
|
* API identifier of an object
|
|
52596
52588
|
*/
|
|
52597
52589
|
'id': string;
|
|
52598
|
-
'attributes':
|
|
52590
|
+
'attributes': JsonApiMemoryItemInAttributes;
|
|
52591
|
+
}
|
|
52592
|
+
|
|
52593
|
+
export declare interface JsonApiMemoryItemInAttributes {
|
|
52594
|
+
'title'?: string;
|
|
52595
|
+
'description'?: string;
|
|
52596
|
+
'tags'?: Array<string>;
|
|
52597
|
+
'areRelationsValid'?: boolean;
|
|
52598
|
+
/**
|
|
52599
|
+
* Strategy defining when the memory item should be applied
|
|
52600
|
+
*/
|
|
52601
|
+
'strategy': JsonApiMemoryItemInAttributesStrategyEnum;
|
|
52602
|
+
/**
|
|
52603
|
+
* The text that will be injected into the system prompt
|
|
52604
|
+
*/
|
|
52605
|
+
'instruction': string;
|
|
52606
|
+
/**
|
|
52607
|
+
* Set of unique strings used for semantic similarity filtering
|
|
52608
|
+
*/
|
|
52609
|
+
'keywords'?: Array<string>;
|
|
52610
|
+
/**
|
|
52611
|
+
* Whether memory item is disabled
|
|
52612
|
+
*/
|
|
52613
|
+
'isDisabled'?: boolean;
|
|
52599
52614
|
}
|
|
52600
52615
|
|
|
52616
|
+
export declare type JsonApiMemoryItemInAttributesStrategyEnum = 'ALWAYS' | 'AUTO';
|
|
52617
|
+
|
|
52601
52618
|
export declare interface JsonApiMemoryItemInDocument {
|
|
52602
52619
|
'data': JsonApiMemoryItemIn;
|
|
52603
52620
|
}
|
|
@@ -52616,7 +52633,7 @@ export declare interface JsonApiMemoryItemOut {
|
|
|
52616
52633
|
* API identifier of an object
|
|
52617
52634
|
*/
|
|
52618
52635
|
'id': string;
|
|
52619
|
-
'meta'?:
|
|
52636
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
52620
52637
|
'attributes': JsonApiMemoryItemOutAttributes;
|
|
52621
52638
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
52622
52639
|
}
|
|
@@ -52669,7 +52686,7 @@ export declare interface JsonApiMemoryItemOutDocument {
|
|
|
52669
52686
|
export declare interface JsonApiMemoryItemOutList {
|
|
52670
52687
|
'data': Array<JsonApiMemoryItemOutWithLinks>;
|
|
52671
52688
|
'links'?: ListLinks;
|
|
52672
|
-
'meta'?:
|
|
52689
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
52673
52690
|
/**
|
|
52674
52691
|
* Included resources
|
|
52675
52692
|
*/
|
|
@@ -52687,7 +52704,7 @@ export declare interface JsonApiMemoryItemOutWithLinks {
|
|
|
52687
52704
|
* API identifier of an object
|
|
52688
52705
|
*/
|
|
52689
52706
|
'id': string;
|
|
52690
|
-
'meta'?:
|
|
52707
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
52691
52708
|
'attributes': JsonApiMemoryItemOutAttributes;
|
|
52692
52709
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
52693
52710
|
'links'?: ObjectLinks;
|
|
@@ -52753,34 +52770,9 @@ export declare interface JsonApiMemoryItemPostOptionalId {
|
|
|
52753
52770
|
* API identifier of an object
|
|
52754
52771
|
*/
|
|
52755
52772
|
'id'?: string;
|
|
52756
|
-
'attributes':
|
|
52757
|
-
}
|
|
52758
|
-
|
|
52759
|
-
export declare interface JsonApiMemoryItemPostOptionalIdAttributes {
|
|
52760
|
-
'title'?: string;
|
|
52761
|
-
'description'?: string;
|
|
52762
|
-
'tags'?: Array<string>;
|
|
52763
|
-
'areRelationsValid'?: boolean;
|
|
52764
|
-
/**
|
|
52765
|
-
* Strategy defining when the memory item should be applied
|
|
52766
|
-
*/
|
|
52767
|
-
'strategy': JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum;
|
|
52768
|
-
/**
|
|
52769
|
-
* The text that will be injected into the system prompt
|
|
52770
|
-
*/
|
|
52771
|
-
'instruction': string;
|
|
52772
|
-
/**
|
|
52773
|
-
* Set of unique strings used for semantic similarity filtering
|
|
52774
|
-
*/
|
|
52775
|
-
'keywords'?: Array<string>;
|
|
52776
|
-
/**
|
|
52777
|
-
* Whether memory item is disabled
|
|
52778
|
-
*/
|
|
52779
|
-
'isDisabled'?: boolean;
|
|
52773
|
+
'attributes': JsonApiMemoryItemInAttributes;
|
|
52780
52774
|
}
|
|
52781
52775
|
|
|
52782
|
-
export declare type JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum = 'ALWAYS' | 'AUTO';
|
|
52783
|
-
|
|
52784
52776
|
export declare interface JsonApiMemoryItemPostOptionalIdDocument {
|
|
52785
52777
|
'data': JsonApiMemoryItemPostOptionalId;
|
|
52786
52778
|
}
|
|
@@ -52799,7 +52791,17 @@ export declare interface JsonApiMetricIn {
|
|
|
52799
52791
|
* API identifier of an object
|
|
52800
52792
|
*/
|
|
52801
52793
|
'id': string;
|
|
52802
|
-
'attributes':
|
|
52794
|
+
'attributes': JsonApiMetricInAttributes;
|
|
52795
|
+
}
|
|
52796
|
+
|
|
52797
|
+
export declare interface JsonApiMetricInAttributes {
|
|
52798
|
+
'title'?: string;
|
|
52799
|
+
'description'?: string;
|
|
52800
|
+
'tags'?: Array<string>;
|
|
52801
|
+
'areRelationsValid'?: boolean;
|
|
52802
|
+
'content': JsonApiMetricOutAttributesContent;
|
|
52803
|
+
'isHidden'?: boolean;
|
|
52804
|
+
'isHiddenFromKda'?: boolean;
|
|
52803
52805
|
}
|
|
52804
52806
|
|
|
52805
52807
|
export declare interface JsonApiMetricInDocument {
|
|
@@ -52830,7 +52832,7 @@ export declare interface JsonApiMetricOut {
|
|
|
52830
52832
|
* API identifier of an object
|
|
52831
52833
|
*/
|
|
52832
52834
|
'id': string;
|
|
52833
|
-
'meta'?:
|
|
52835
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
52834
52836
|
'attributes': JsonApiMetricOutAttributes;
|
|
52835
52837
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
52836
52838
|
}
|
|
@@ -52901,7 +52903,7 @@ export declare type JsonApiMetricOutIncludes = JsonApiAttributeOutWithLinks | Js
|
|
|
52901
52903
|
export declare interface JsonApiMetricOutList {
|
|
52902
52904
|
'data': Array<JsonApiMetricOutWithLinks>;
|
|
52903
52905
|
'links'?: ListLinks;
|
|
52904
|
-
'meta'?:
|
|
52906
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
52905
52907
|
/**
|
|
52906
52908
|
* Included resources
|
|
52907
52909
|
*/
|
|
@@ -52919,7 +52921,7 @@ export declare interface JsonApiMetricOutWithLinks {
|
|
|
52919
52921
|
* API identifier of an object
|
|
52920
52922
|
*/
|
|
52921
52923
|
'id': string;
|
|
52922
|
-
'meta'?:
|
|
52924
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
52923
52925
|
'attributes': JsonApiMetricOutAttributes;
|
|
52924
52926
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
52925
52927
|
'links'?: ObjectLinks;
|
|
@@ -52970,17 +52972,7 @@ export declare interface JsonApiMetricPostOptionalId {
|
|
|
52970
52972
|
* API identifier of an object
|
|
52971
52973
|
*/
|
|
52972
52974
|
'id'?: string;
|
|
52973
|
-
'attributes':
|
|
52974
|
-
}
|
|
52975
|
-
|
|
52976
|
-
export declare interface JsonApiMetricPostOptionalIdAttributes {
|
|
52977
|
-
'title'?: string;
|
|
52978
|
-
'description'?: string;
|
|
52979
|
-
'tags'?: Array<string>;
|
|
52980
|
-
'areRelationsValid'?: boolean;
|
|
52981
|
-
'content': JsonApiMetricOutAttributesContent;
|
|
52982
|
-
'isHidden'?: boolean;
|
|
52983
|
-
'isHiddenFromKda'?: boolean;
|
|
52975
|
+
'attributes': JsonApiMetricInAttributes;
|
|
52984
52976
|
}
|
|
52985
52977
|
|
|
52986
52978
|
export declare interface JsonApiMetricPostOptionalIdDocument {
|
|
@@ -53029,7 +53021,7 @@ export declare interface JsonApiNotificationChannelIdentifierOutDocument {
|
|
|
53029
53021
|
export declare interface JsonApiNotificationChannelIdentifierOutList {
|
|
53030
53022
|
'data': Array<JsonApiNotificationChannelIdentifierOutWithLinks>;
|
|
53031
53023
|
'links'?: ListLinks;
|
|
53032
|
-
'meta'?:
|
|
53024
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
53033
53025
|
}
|
|
53034
53026
|
|
|
53035
53027
|
export declare type JsonApiNotificationChannelIdentifierOutTypeEnum = 'notificationChannelIdentifier';
|
|
@@ -53061,9 +53053,41 @@ export declare interface JsonApiNotificationChannelIn {
|
|
|
53061
53053
|
* API identifier of an object
|
|
53062
53054
|
*/
|
|
53063
53055
|
'id': string;
|
|
53064
|
-
'attributes'?:
|
|
53056
|
+
'attributes'?: JsonApiNotificationChannelInAttributes;
|
|
53065
53057
|
}
|
|
53066
53058
|
|
|
53059
|
+
export declare interface JsonApiNotificationChannelInAttributes {
|
|
53060
|
+
'name'?: string | null;
|
|
53061
|
+
'description'?: string | null;
|
|
53062
|
+
'destination'?: JsonApiNotificationChannelOutAttributesDestination;
|
|
53063
|
+
/**
|
|
53064
|
+
* 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}
|
|
53065
|
+
*/
|
|
53066
|
+
'customDashboardUrl'?: string;
|
|
53067
|
+
/**
|
|
53068
|
+
* 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
|
|
53069
|
+
*/
|
|
53070
|
+
'dashboardLinkVisibility'?: JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum;
|
|
53071
|
+
/**
|
|
53072
|
+
* 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}}
|
|
53073
|
+
*/
|
|
53074
|
+
'notificationSource'?: string;
|
|
53075
|
+
/**
|
|
53076
|
+
* 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
|
|
53077
|
+
*/
|
|
53078
|
+
'allowedRecipients'?: JsonApiNotificationChannelInAttributesAllowedRecipientsEnum;
|
|
53079
|
+
/**
|
|
53080
|
+
* 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
|
|
53081
|
+
*/
|
|
53082
|
+
'inPlatformNotification'?: JsonApiNotificationChannelInAttributesInPlatformNotificationEnum;
|
|
53083
|
+
}
|
|
53084
|
+
|
|
53085
|
+
export declare type JsonApiNotificationChannelInAttributesAllowedRecipientsEnum = 'CREATOR' | 'INTERNAL' | 'EXTERNAL';
|
|
53086
|
+
|
|
53087
|
+
export declare type JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
|
|
53088
|
+
|
|
53089
|
+
export declare type JsonApiNotificationChannelInAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
|
|
53090
|
+
|
|
53067
53091
|
export declare interface JsonApiNotificationChannelInDocument {
|
|
53068
53092
|
'data': JsonApiNotificationChannelIn;
|
|
53069
53093
|
}
|
|
@@ -53098,7 +53122,7 @@ export declare interface JsonApiNotificationChannelOut {
|
|
|
53098
53122
|
export declare interface JsonApiNotificationChannelOutAttributes {
|
|
53099
53123
|
'name'?: string | null;
|
|
53100
53124
|
'description'?: string | null;
|
|
53101
|
-
'destination'?:
|
|
53125
|
+
'destination'?: JsonApiNotificationChannelOutAttributesDestination;
|
|
53102
53126
|
'destinationType'?: JsonApiNotificationChannelOutAttributesDestinationTypeEnum | null;
|
|
53103
53127
|
/**
|
|
53104
53128
|
* 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}
|
|
@@ -53126,6 +53150,12 @@ export declare type JsonApiNotificationChannelOutAttributesAllowedRecipientsEnum
|
|
|
53126
53150
|
|
|
53127
53151
|
export declare type JsonApiNotificationChannelOutAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
|
|
53128
53152
|
|
|
53153
|
+
/**
|
|
53154
|
+
* @type JsonApiNotificationChannelOutAttributesDestination
|
|
53155
|
+
* The destination where the notifications are to be sent.
|
|
53156
|
+
*/
|
|
53157
|
+
export declare type JsonApiNotificationChannelOutAttributesDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
53158
|
+
|
|
53129
53159
|
export declare type JsonApiNotificationChannelOutAttributesDestinationTypeEnum = 'WEBHOOK' | 'SMTP' | 'DEFAULT_SMTP' | 'IN_PLATFORM';
|
|
53130
53160
|
|
|
53131
53161
|
export declare type JsonApiNotificationChannelOutAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
|
|
@@ -53141,7 +53171,7 @@ export declare interface JsonApiNotificationChannelOutDocument {
|
|
|
53141
53171
|
export declare interface JsonApiNotificationChannelOutList {
|
|
53142
53172
|
'data': Array<JsonApiNotificationChannelOutWithLinks>;
|
|
53143
53173
|
'links'?: ListLinks;
|
|
53144
|
-
'meta'?:
|
|
53174
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
53145
53175
|
}
|
|
53146
53176
|
|
|
53147
53177
|
export declare type JsonApiNotificationChannelOutTypeEnum = 'notificationChannel';
|
|
@@ -53173,47 +53203,9 @@ export declare interface JsonApiNotificationChannelPatch {
|
|
|
53173
53203
|
* API identifier of an object
|
|
53174
53204
|
*/
|
|
53175
53205
|
'id': string;
|
|
53176
|
-
'attributes'?:
|
|
53206
|
+
'attributes'?: JsonApiNotificationChannelInAttributes;
|
|
53177
53207
|
}
|
|
53178
53208
|
|
|
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
|
-
|
|
53217
53209
|
export declare interface JsonApiNotificationChannelPatchDocument {
|
|
53218
53210
|
'data': JsonApiNotificationChannelPatch;
|
|
53219
53211
|
}
|
|
@@ -53232,7 +53224,7 @@ export declare interface JsonApiNotificationChannelPostOptionalId {
|
|
|
53232
53224
|
* API identifier of an object
|
|
53233
53225
|
*/
|
|
53234
53226
|
'id'?: string;
|
|
53235
|
-
'attributes'?:
|
|
53227
|
+
'attributes'?: JsonApiNotificationChannelInAttributes;
|
|
53236
53228
|
}
|
|
53237
53229
|
|
|
53238
53230
|
export declare interface JsonApiNotificationChannelPostOptionalIdDocument {
|
|
@@ -53253,14 +53245,33 @@ export declare interface JsonApiOrganizationIn {
|
|
|
53253
53245
|
* API identifier of an object
|
|
53254
53246
|
*/
|
|
53255
53247
|
'id': string;
|
|
53256
|
-
'attributes'?:
|
|
53257
|
-
'relationships'?:
|
|
53248
|
+
'attributes'?: JsonApiOrganizationInAttributes;
|
|
53249
|
+
'relationships'?: JsonApiOrganizationInRelationships;
|
|
53250
|
+
}
|
|
53251
|
+
|
|
53252
|
+
export declare interface JsonApiOrganizationInAttributes {
|
|
53253
|
+
'name'?: string | null;
|
|
53254
|
+
'hostname'?: string;
|
|
53255
|
+
'allowedOrigins'?: Array<string>;
|
|
53256
|
+
/**
|
|
53257
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
53258
|
+
* @deprecated
|
|
53259
|
+
*/
|
|
53260
|
+
'earlyAccess'?: string | null;
|
|
53261
|
+
/**
|
|
53262
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
53263
|
+
*/
|
|
53264
|
+
'earlyAccessValues'?: Array<string> | null;
|
|
53258
53265
|
}
|
|
53259
53266
|
|
|
53260
53267
|
export declare interface JsonApiOrganizationInDocument {
|
|
53261
53268
|
'data': JsonApiOrganizationIn;
|
|
53262
53269
|
}
|
|
53263
53270
|
|
|
53271
|
+
export declare interface JsonApiOrganizationInRelationships {
|
|
53272
|
+
'identityProvider'?: JsonApiOrganizationOutRelationshipsIdentityProvider;
|
|
53273
|
+
}
|
|
53274
|
+
|
|
53264
53275
|
export declare type JsonApiOrganizationInTypeEnum = 'organization';
|
|
53265
53276
|
|
|
53266
53277
|
/**
|
|
@@ -53335,17 +53346,13 @@ export declare interface JsonApiOrganizationOutMeta {
|
|
|
53335
53346
|
export declare type JsonApiOrganizationOutMetaPermissionsEnum = 'MANAGE' | 'SELF_CREATE_TOKEN' | 'BASE_UI_ACCESS';
|
|
53336
53347
|
|
|
53337
53348
|
export declare interface JsonApiOrganizationOutRelationships {
|
|
53338
|
-
'bootstrapUser'?:
|
|
53339
|
-
'bootstrapUserGroup'?:
|
|
53340
|
-
'identityProvider'?:
|
|
53341
|
-
}
|
|
53342
|
-
|
|
53343
|
-
export declare interface JsonApiOrganizationOutRelationshipsBootstrapUser {
|
|
53344
|
-
'data': JsonApiUserLinkage | null;
|
|
53349
|
+
'bootstrapUser'?: JsonApiFilterViewPatchRelationshipsUser;
|
|
53350
|
+
'bootstrapUserGroup'?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
53351
|
+
'identityProvider'?: JsonApiOrganizationOutRelationshipsIdentityProvider;
|
|
53345
53352
|
}
|
|
53346
53353
|
|
|
53347
|
-
export declare interface
|
|
53348
|
-
'data':
|
|
53354
|
+
export declare interface JsonApiOrganizationOutRelationshipsIdentityProvider {
|
|
53355
|
+
'data': JsonApiIdentityProviderLinkage | null;
|
|
53349
53356
|
}
|
|
53350
53357
|
|
|
53351
53358
|
export declare type JsonApiOrganizationOutTypeEnum = 'organization';
|
|
@@ -53362,37 +53369,14 @@ export declare interface JsonApiOrganizationPatch {
|
|
|
53362
53369
|
* API identifier of an object
|
|
53363
53370
|
*/
|
|
53364
53371
|
'id': string;
|
|
53365
|
-
'attributes'?:
|
|
53366
|
-
'relationships'?:
|
|
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;
|
|
53372
|
+
'attributes'?: JsonApiOrganizationInAttributes;
|
|
53373
|
+
'relationships'?: JsonApiOrganizationInRelationships;
|
|
53382
53374
|
}
|
|
53383
53375
|
|
|
53384
53376
|
export declare interface JsonApiOrganizationPatchDocument {
|
|
53385
53377
|
'data': JsonApiOrganizationPatch;
|
|
53386
53378
|
}
|
|
53387
53379
|
|
|
53388
|
-
export declare interface JsonApiOrganizationPatchRelationships {
|
|
53389
|
-
'identityProvider'?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
53390
|
-
}
|
|
53391
|
-
|
|
53392
|
-
export declare interface JsonApiOrganizationPatchRelationshipsIdentityProvider {
|
|
53393
|
-
'data': JsonApiIdentityProviderLinkage | null;
|
|
53394
|
-
}
|
|
53395
|
-
|
|
53396
53380
|
export declare type JsonApiOrganizationPatchTypeEnum = 'organization';
|
|
53397
53381
|
|
|
53398
53382
|
/**
|
|
@@ -53407,7 +53391,7 @@ export declare interface JsonApiOrganizationSettingIn {
|
|
|
53407
53391
|
* API identifier of an object
|
|
53408
53392
|
*/
|
|
53409
53393
|
'id': string;
|
|
53410
|
-
'attributes'?:
|
|
53394
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
53411
53395
|
}
|
|
53412
53396
|
|
|
53413
53397
|
export declare interface JsonApiOrganizationSettingInDocument {
|
|
@@ -53428,9 +53412,19 @@ export declare interface JsonApiOrganizationSettingOut {
|
|
|
53428
53412
|
* API identifier of an object
|
|
53429
53413
|
*/
|
|
53430
53414
|
'id': string;
|
|
53431
|
-
'attributes'?:
|
|
53415
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
53432
53416
|
}
|
|
53433
53417
|
|
|
53418
|
+
export declare interface JsonApiOrganizationSettingOutAttributes {
|
|
53419
|
+
/**
|
|
53420
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
53421
|
+
*/
|
|
53422
|
+
'content'?: object;
|
|
53423
|
+
'type'?: JsonApiOrganizationSettingOutAttributesTypeEnum;
|
|
53424
|
+
}
|
|
53425
|
+
|
|
53426
|
+
export declare type JsonApiOrganizationSettingOutAttributesTypeEnum = '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';
|
|
53427
|
+
|
|
53434
53428
|
export declare interface JsonApiOrganizationSettingOutDocument {
|
|
53435
53429
|
'data': JsonApiOrganizationSettingOut;
|
|
53436
53430
|
'links'?: ObjectLinks;
|
|
@@ -53442,7 +53436,7 @@ export declare interface JsonApiOrganizationSettingOutDocument {
|
|
|
53442
53436
|
export declare interface JsonApiOrganizationSettingOutList {
|
|
53443
53437
|
'data': Array<JsonApiOrganizationSettingOutWithLinks>;
|
|
53444
53438
|
'links'?: ListLinks;
|
|
53445
|
-
'meta'?:
|
|
53439
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
53446
53440
|
}
|
|
53447
53441
|
|
|
53448
53442
|
export declare type JsonApiOrganizationSettingOutTypeEnum = 'organizationSetting';
|
|
@@ -53456,7 +53450,7 @@ export declare interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
53456
53450
|
* API identifier of an object
|
|
53457
53451
|
*/
|
|
53458
53452
|
'id': string;
|
|
53459
|
-
'attributes'?:
|
|
53453
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
53460
53454
|
'links'?: ObjectLinks;
|
|
53461
53455
|
}
|
|
53462
53456
|
|
|
@@ -53474,7 +53468,7 @@ export declare interface JsonApiOrganizationSettingPatch {
|
|
|
53474
53468
|
* API identifier of an object
|
|
53475
53469
|
*/
|
|
53476
53470
|
'id': string;
|
|
53477
|
-
'attributes'?:
|
|
53471
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
53478
53472
|
}
|
|
53479
53473
|
|
|
53480
53474
|
export declare interface JsonApiOrganizationSettingPatchDocument {
|
|
@@ -53530,7 +53524,7 @@ export declare interface JsonApiThemeOutDocument {
|
|
|
53530
53524
|
export declare interface JsonApiThemeOutList {
|
|
53531
53525
|
'data': Array<JsonApiThemeOutWithLinks>;
|
|
53532
53526
|
'links'?: ListLinks;
|
|
53533
|
-
'meta'?:
|
|
53527
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
53534
53528
|
}
|
|
53535
53529
|
|
|
53536
53530
|
export declare type JsonApiThemeOutTypeEnum = 'theme';
|
|
@@ -53605,7 +53599,7 @@ export declare interface JsonApiUserDataFilterOut {
|
|
|
53605
53599
|
* API identifier of an object
|
|
53606
53600
|
*/
|
|
53607
53601
|
'id': string;
|
|
53608
|
-
'meta'?:
|
|
53602
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
53609
53603
|
'attributes': JsonApiUserDataFilterOutAttributes;
|
|
53610
53604
|
'relationships'?: JsonApiUserDataFilterOutRelationships;
|
|
53611
53605
|
}
|
|
@@ -53638,7 +53632,7 @@ export declare type JsonApiUserDataFilterOutIncludes = JsonApiAttributeOutWithLi
|
|
|
53638
53632
|
export declare interface JsonApiUserDataFilterOutList {
|
|
53639
53633
|
'data': Array<JsonApiUserDataFilterOutWithLinks>;
|
|
53640
53634
|
'links'?: ListLinks;
|
|
53641
|
-
'meta'?:
|
|
53635
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
53642
53636
|
/**
|
|
53643
53637
|
* Included resources
|
|
53644
53638
|
*/
|
|
@@ -53646,13 +53640,13 @@ export declare interface JsonApiUserDataFilterOutList {
|
|
|
53646
53640
|
}
|
|
53647
53641
|
|
|
53648
53642
|
export declare interface JsonApiUserDataFilterOutRelationships {
|
|
53649
|
-
'user'?:
|
|
53650
|
-
'userGroup'?:
|
|
53651
|
-
'facts'?:
|
|
53652
|
-
'attributes'?:
|
|
53643
|
+
'user'?: JsonApiFilterViewPatchRelationshipsUser;
|
|
53644
|
+
'userGroup'?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
53645
|
+
'facts'?: JsonApiVisualizationObjectOutRelationshipsFacts;
|
|
53646
|
+
'attributes'?: JsonApiVisualizationObjectOutRelationshipsAttributes;
|
|
53653
53647
|
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
53654
53648
|
'metrics'?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
53655
|
-
'datasets'?:
|
|
53649
|
+
'datasets'?: JsonApiVisualizationObjectOutRelationshipsDatasets;
|
|
53656
53650
|
}
|
|
53657
53651
|
|
|
53658
53652
|
export declare type JsonApiUserDataFilterOutTypeEnum = 'userDataFilter';
|
|
@@ -53666,7 +53660,7 @@ export declare interface JsonApiUserDataFilterOutWithLinks {
|
|
|
53666
53660
|
* API identifier of an object
|
|
53667
53661
|
*/
|
|
53668
53662
|
'id': string;
|
|
53669
|
-
'meta'?:
|
|
53663
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
53670
53664
|
'attributes': JsonApiUserDataFilterOutAttributes;
|
|
53671
53665
|
'relationships'?: JsonApiUserDataFilterOutRelationships;
|
|
53672
53666
|
'links'?: ObjectLinks;
|
|
@@ -53703,8 +53697,12 @@ export declare interface JsonApiUserDataFilterPatchDocument {
|
|
|
53703
53697
|
}
|
|
53704
53698
|
|
|
53705
53699
|
export declare interface JsonApiUserDataFilterPatchRelationships {
|
|
53706
|
-
'user'?:
|
|
53707
|
-
'userGroup'?:
|
|
53700
|
+
'user'?: JsonApiFilterViewPatchRelationshipsUser;
|
|
53701
|
+
'userGroup'?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
53702
|
+
}
|
|
53703
|
+
|
|
53704
|
+
export declare interface JsonApiUserDataFilterPatchRelationshipsUserGroup {
|
|
53705
|
+
'data': JsonApiUserGroupLinkage | null;
|
|
53708
53706
|
}
|
|
53709
53707
|
|
|
53710
53708
|
export declare type JsonApiUserDataFilterPatchTypeEnum = 'userDataFilter';
|
|
@@ -53798,7 +53796,7 @@ export declare interface JsonApiUserGroupOutDocument {
|
|
|
53798
53796
|
export declare interface JsonApiUserGroupOutList {
|
|
53799
53797
|
'data': Array<JsonApiUserGroupOutWithLinks>;
|
|
53800
53798
|
'links'?: ListLinks;
|
|
53801
|
-
'meta'?:
|
|
53799
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
53802
53800
|
/**
|
|
53803
53801
|
* Included resources
|
|
53804
53802
|
*/
|
|
@@ -53806,7 +53804,14 @@ export declare interface JsonApiUserGroupOutList {
|
|
|
53806
53804
|
}
|
|
53807
53805
|
|
|
53808
53806
|
export declare interface JsonApiUserGroupOutRelationships {
|
|
53809
|
-
'parents'?:
|
|
53807
|
+
'parents'?: JsonApiUserGroupOutRelationshipsParents;
|
|
53808
|
+
}
|
|
53809
|
+
|
|
53810
|
+
export declare interface JsonApiUserGroupOutRelationshipsParents {
|
|
53811
|
+
/**
|
|
53812
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
53813
|
+
*/
|
|
53814
|
+
'data': Array<JsonApiUserGroupLinkage>;
|
|
53810
53815
|
}
|
|
53811
53816
|
|
|
53812
53817
|
export declare type JsonApiUserGroupOutTypeEnum = 'userGroup';
|
|
@@ -53891,7 +53896,7 @@ export declare interface JsonApiUserIdentifierOutDocument {
|
|
|
53891
53896
|
export declare interface JsonApiUserIdentifierOutList {
|
|
53892
53897
|
'data': Array<JsonApiUserIdentifierOutWithLinks>;
|
|
53893
53898
|
'links'?: ListLinks;
|
|
53894
|
-
'meta'?:
|
|
53899
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
53895
53900
|
}
|
|
53896
53901
|
|
|
53897
53902
|
export declare type JsonApiUserIdentifierOutTypeEnum = 'userIdentifier';
|
|
@@ -53981,7 +53986,7 @@ export declare interface JsonApiUserOutDocument {
|
|
|
53981
53986
|
export declare interface JsonApiUserOutList {
|
|
53982
53987
|
'data': Array<JsonApiUserOutWithLinks>;
|
|
53983
53988
|
'links'?: ListLinks;
|
|
53984
|
-
'meta'?:
|
|
53989
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
53985
53990
|
/**
|
|
53986
53991
|
* Included resources
|
|
53987
53992
|
*/
|
|
@@ -53989,14 +53994,7 @@ export declare interface JsonApiUserOutList {
|
|
|
53989
53994
|
}
|
|
53990
53995
|
|
|
53991
53996
|
export declare interface JsonApiUserOutRelationships {
|
|
53992
|
-
'userGroups'?:
|
|
53993
|
-
}
|
|
53994
|
-
|
|
53995
|
-
export declare interface JsonApiUserOutRelationshipsUserGroups {
|
|
53996
|
-
/**
|
|
53997
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
53998
|
-
*/
|
|
53999
|
-
'data': Array<JsonApiUserGroupLinkage>;
|
|
53997
|
+
'userGroups'?: JsonApiUserGroupOutRelationshipsParents;
|
|
54000
53998
|
}
|
|
54001
53999
|
|
|
54002
54000
|
export declare type JsonApiUserOutTypeEnum = 'user';
|
|
@@ -54051,19 +54049,9 @@ export declare interface JsonApiUserSettingIn {
|
|
|
54051
54049
|
* API identifier of an object
|
|
54052
54050
|
*/
|
|
54053
54051
|
'id': string;
|
|
54054
|
-
'attributes'?:
|
|
54052
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
54055
54053
|
}
|
|
54056
54054
|
|
|
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
|
-
|
|
54067
54055
|
export declare interface JsonApiUserSettingInDocument {
|
|
54068
54056
|
'data': JsonApiUserSettingIn;
|
|
54069
54057
|
}
|
|
@@ -54082,7 +54070,7 @@ export declare interface JsonApiUserSettingOut {
|
|
|
54082
54070
|
* API identifier of an object
|
|
54083
54071
|
*/
|
|
54084
54072
|
'id': string;
|
|
54085
|
-
'attributes'?:
|
|
54073
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
54086
54074
|
}
|
|
54087
54075
|
|
|
54088
54076
|
export declare interface JsonApiUserSettingOutDocument {
|
|
@@ -54096,7 +54084,7 @@ export declare interface JsonApiUserSettingOutDocument {
|
|
|
54096
54084
|
export declare interface JsonApiUserSettingOutList {
|
|
54097
54085
|
'data': Array<JsonApiUserSettingOutWithLinks>;
|
|
54098
54086
|
'links'?: ListLinks;
|
|
54099
|
-
'meta'?:
|
|
54087
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
54100
54088
|
}
|
|
54101
54089
|
|
|
54102
54090
|
export declare type JsonApiUserSettingOutTypeEnum = 'userSetting';
|
|
@@ -54110,7 +54098,7 @@ export declare interface JsonApiUserSettingOutWithLinks {
|
|
|
54110
54098
|
* API identifier of an object
|
|
54111
54099
|
*/
|
|
54112
54100
|
'id': string;
|
|
54113
|
-
'attributes'?:
|
|
54101
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
54114
54102
|
'links'?: ObjectLinks;
|
|
54115
54103
|
}
|
|
54116
54104
|
|
|
@@ -54128,7 +54116,19 @@ export declare interface JsonApiVisualizationObjectIn {
|
|
|
54128
54116
|
* API identifier of an object
|
|
54129
54117
|
*/
|
|
54130
54118
|
'id': string;
|
|
54131
|
-
'attributes':
|
|
54119
|
+
'attributes': JsonApiVisualizationObjectInAttributes;
|
|
54120
|
+
}
|
|
54121
|
+
|
|
54122
|
+
export declare interface JsonApiVisualizationObjectInAttributes {
|
|
54123
|
+
'title'?: string;
|
|
54124
|
+
'description'?: string;
|
|
54125
|
+
'tags'?: Array<string>;
|
|
54126
|
+
'areRelationsValid'?: boolean;
|
|
54127
|
+
/**
|
|
54128
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
54129
|
+
*/
|
|
54130
|
+
'content': object;
|
|
54131
|
+
'isHidden'?: boolean;
|
|
54132
54132
|
}
|
|
54133
54133
|
|
|
54134
54134
|
export declare interface JsonApiVisualizationObjectInDocument {
|
|
@@ -54159,7 +54159,7 @@ export declare interface JsonApiVisualizationObjectOut {
|
|
|
54159
54159
|
* API identifier of an object
|
|
54160
54160
|
*/
|
|
54161
54161
|
'id': string;
|
|
54162
|
-
'meta'?:
|
|
54162
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
54163
54163
|
'attributes': JsonApiVisualizationObjectOutAttributes;
|
|
54164
54164
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
54165
54165
|
}
|
|
@@ -54213,28 +54213,66 @@ export declare interface JsonApiVisualizationObjectOutDocument {
|
|
|
54213
54213
|
export declare interface JsonApiVisualizationObjectOutList {
|
|
54214
54214
|
'data': Array<JsonApiVisualizationObjectOutWithLinks>;
|
|
54215
54215
|
'links'?: ListLinks;
|
|
54216
|
-
'meta'?:
|
|
54216
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
54217
54217
|
/**
|
|
54218
54218
|
* Included resources
|
|
54219
54219
|
*/
|
|
54220
54220
|
'included'?: Array<JsonApiMetricOutIncludes>;
|
|
54221
54221
|
}
|
|
54222
54222
|
|
|
54223
|
+
export declare interface JsonApiVisualizationObjectOutMeta {
|
|
54224
|
+
'origin'?: JsonApiVisualizationObjectOutMetaOrigin;
|
|
54225
|
+
}
|
|
54226
|
+
|
|
54227
|
+
export declare interface JsonApiVisualizationObjectOutMetaOrigin {
|
|
54228
|
+
/**
|
|
54229
|
+
* defines type of the origin of the entity
|
|
54230
|
+
*/
|
|
54231
|
+
'originType': JsonApiVisualizationObjectOutMetaOriginOriginTypeEnum;
|
|
54232
|
+
/**
|
|
54233
|
+
* defines id of the workspace where the entity comes from
|
|
54234
|
+
*/
|
|
54235
|
+
'originId': string;
|
|
54236
|
+
}
|
|
54237
|
+
|
|
54238
|
+
export declare type JsonApiVisualizationObjectOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
54239
|
+
|
|
54223
54240
|
export declare interface JsonApiVisualizationObjectOutRelationships {
|
|
54224
54241
|
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
54225
54242
|
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
54226
54243
|
'certifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
54227
|
-
'facts'?:
|
|
54228
|
-
'attributes'?:
|
|
54244
|
+
'facts'?: JsonApiVisualizationObjectOutRelationshipsFacts;
|
|
54245
|
+
'attributes'?: JsonApiVisualizationObjectOutRelationshipsAttributes;
|
|
54229
54246
|
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
54230
54247
|
'metrics'?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
54231
|
-
'datasets'?:
|
|
54248
|
+
'datasets'?: JsonApiVisualizationObjectOutRelationshipsDatasets;
|
|
54249
|
+
}
|
|
54250
|
+
|
|
54251
|
+
export declare interface JsonApiVisualizationObjectOutRelationshipsAttributes {
|
|
54252
|
+
/**
|
|
54253
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
54254
|
+
*/
|
|
54255
|
+
'data': Array<JsonApiAttributeLinkage>;
|
|
54232
54256
|
}
|
|
54233
54257
|
|
|
54234
54258
|
export declare interface JsonApiVisualizationObjectOutRelationshipsCreatedBy {
|
|
54235
54259
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
54236
54260
|
}
|
|
54237
54261
|
|
|
54262
|
+
export declare interface JsonApiVisualizationObjectOutRelationshipsDatasets {
|
|
54263
|
+
/**
|
|
54264
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
54265
|
+
*/
|
|
54266
|
+
'data': Array<JsonApiDatasetLinkage>;
|
|
54267
|
+
}
|
|
54268
|
+
|
|
54269
|
+
export declare interface JsonApiVisualizationObjectOutRelationshipsFacts {
|
|
54270
|
+
/**
|
|
54271
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
54272
|
+
*/
|
|
54273
|
+
'data': Array<JsonApiFactLinkage>;
|
|
54274
|
+
}
|
|
54275
|
+
|
|
54238
54276
|
export declare interface JsonApiVisualizationObjectOutRelationshipsLabels {
|
|
54239
54277
|
/**
|
|
54240
54278
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -54260,7 +54298,7 @@ export declare interface JsonApiVisualizationObjectOutWithLinks {
|
|
|
54260
54298
|
* API identifier of an object
|
|
54261
54299
|
*/
|
|
54262
54300
|
'id': string;
|
|
54263
|
-
'meta'?:
|
|
54301
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
54264
54302
|
'attributes': JsonApiVisualizationObjectOutAttributes;
|
|
54265
54303
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
54266
54304
|
'links'?: ObjectLinks;
|
|
@@ -54313,19 +54351,7 @@ export declare interface JsonApiVisualizationObjectPostOptionalId {
|
|
|
54313
54351
|
* API identifier of an object
|
|
54314
54352
|
*/
|
|
54315
54353
|
'id'?: string;
|
|
54316
|
-
'attributes':
|
|
54317
|
-
}
|
|
54318
|
-
|
|
54319
|
-
export declare interface JsonApiVisualizationObjectPostOptionalIdAttributes {
|
|
54320
|
-
'title'?: string;
|
|
54321
|
-
'description'?: string;
|
|
54322
|
-
'tags'?: Array<string>;
|
|
54323
|
-
'areRelationsValid'?: boolean;
|
|
54324
|
-
/**
|
|
54325
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
54326
|
-
*/
|
|
54327
|
-
'content': object;
|
|
54328
|
-
'isHidden'?: boolean;
|
|
54354
|
+
'attributes': JsonApiVisualizationObjectInAttributes;
|
|
54329
54355
|
}
|
|
54330
54356
|
|
|
54331
54357
|
export declare interface JsonApiVisualizationObjectPostOptionalIdDocument {
|
|
@@ -54359,7 +54385,7 @@ export declare interface JsonApiWorkspaceAutomationOutAttributes {
|
|
|
54359
54385
|
* Additional details to be included in the automated message.
|
|
54360
54386
|
*/
|
|
54361
54387
|
'details'?: object;
|
|
54362
|
-
'metadata'?:
|
|
54388
|
+
'metadata'?: JsonApiAutomationPatchAttributesMetadata | null;
|
|
54363
54389
|
/**
|
|
54364
54390
|
* Current state of the automation.
|
|
54365
54391
|
*/
|
|
@@ -54368,18 +54394,18 @@ export declare interface JsonApiWorkspaceAutomationOutAttributes {
|
|
|
54368
54394
|
* Specify automation evaluation mode.
|
|
54369
54395
|
*/
|
|
54370
54396
|
'evaluationMode'?: JsonApiWorkspaceAutomationOutAttributesEvaluationModeEnum;
|
|
54371
|
-
'schedule'?:
|
|
54372
|
-
'alert'?:
|
|
54373
|
-
'tabularExports'?: Array<
|
|
54374
|
-
'visualExports'?: Array<
|
|
54375
|
-
'imageExports'?: Array<
|
|
54376
|
-
'rawExports'?: Array<
|
|
54377
|
-
'slidesExports'?: Array<
|
|
54378
|
-
'dashboardTabularExports'?: Array<
|
|
54397
|
+
'schedule'?: JsonApiAutomationPatchAttributesSchedule;
|
|
54398
|
+
'alert'?: JsonApiAutomationPatchAttributesAlert;
|
|
54399
|
+
'tabularExports'?: Array<JsonApiAutomationPatchAttributesTabularExportsInner>;
|
|
54400
|
+
'visualExports'?: Array<JsonApiAutomationPatchAttributesVisualExportsInner>;
|
|
54401
|
+
'imageExports'?: Array<JsonApiAutomationPatchAttributesImageExportsInner>;
|
|
54402
|
+
'rawExports'?: Array<JsonApiAutomationPatchAttributesRawExportsInner>;
|
|
54403
|
+
'slidesExports'?: Array<JsonApiAutomationPatchAttributesSlidesExportsInner>;
|
|
54404
|
+
'dashboardTabularExports'?: Array<JsonApiAutomationPatchAttributesDashboardTabularExportsInner>;
|
|
54379
54405
|
/**
|
|
54380
54406
|
* External recipients of the automation action results.
|
|
54381
54407
|
*/
|
|
54382
|
-
'externalRecipients'?: Array<
|
|
54408
|
+
'externalRecipients'?: Array<JsonApiAutomationPatchAttributesExternalRecipientsInner>;
|
|
54383
54409
|
'createdAt'?: string;
|
|
54384
54410
|
'modifiedAt'?: string;
|
|
54385
54411
|
}
|
|
@@ -54399,7 +54425,7 @@ export declare type JsonApiWorkspaceAutomationOutIncludes = JsonApiAnalyticalDas
|
|
|
54399
54425
|
export declare interface JsonApiWorkspaceAutomationOutList {
|
|
54400
54426
|
'data': Array<JsonApiWorkspaceAutomationOutWithLinks>;
|
|
54401
54427
|
'links'?: ListLinks;
|
|
54402
|
-
'meta'?:
|
|
54428
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
54403
54429
|
/**
|
|
54404
54430
|
* Included resources
|
|
54405
54431
|
*/
|
|
@@ -54407,13 +54433,13 @@ export declare interface JsonApiWorkspaceAutomationOutList {
|
|
|
54407
54433
|
}
|
|
54408
54434
|
|
|
54409
54435
|
export declare interface JsonApiWorkspaceAutomationOutRelationships {
|
|
54410
|
-
'workspace'?:
|
|
54411
|
-
'notificationChannel'?:
|
|
54412
|
-
'analyticalDashboard'?:
|
|
54436
|
+
'workspace'?: JsonApiWorkspaceOutRelationshipsParent;
|
|
54437
|
+
'notificationChannel'?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
54438
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
54413
54439
|
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
54414
54440
|
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
54415
|
-
'exportDefinitions'?:
|
|
54416
|
-
'recipients'?:
|
|
54441
|
+
'exportDefinitions'?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
54442
|
+
'recipients'?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
54417
54443
|
'automationResults'?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
54418
54444
|
}
|
|
54419
54445
|
|
|
@@ -54479,7 +54505,7 @@ export declare interface JsonApiWorkspaceDataFilterOut {
|
|
|
54479
54505
|
* API identifier of an object
|
|
54480
54506
|
*/
|
|
54481
54507
|
'id': string;
|
|
54482
|
-
'meta'?:
|
|
54508
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
54483
54509
|
'attributes'?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
54484
54510
|
'relationships'?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
54485
54511
|
}
|
|
@@ -54505,7 +54531,7 @@ export declare interface JsonApiWorkspaceDataFilterOutDocument {
|
|
|
54505
54531
|
export declare interface JsonApiWorkspaceDataFilterOutList {
|
|
54506
54532
|
'data': Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
54507
54533
|
'links'?: ListLinks;
|
|
54508
|
-
'meta'?:
|
|
54534
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
54509
54535
|
/**
|
|
54510
54536
|
* Included resources
|
|
54511
54537
|
*/
|
|
@@ -54534,7 +54560,7 @@ export declare interface JsonApiWorkspaceDataFilterOutWithLinks {
|
|
|
54534
54560
|
* API identifier of an object
|
|
54535
54561
|
*/
|
|
54536
54562
|
'id': string;
|
|
54537
|
-
'meta'?:
|
|
54563
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
54538
54564
|
'attributes'?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
54539
54565
|
'relationships'?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
54540
54566
|
'links'?: ObjectLinks;
|
|
@@ -54576,8 +54602,8 @@ export declare interface JsonApiWorkspaceDataFilterSettingIn {
|
|
|
54576
54602
|
* API identifier of an object
|
|
54577
54603
|
*/
|
|
54578
54604
|
'id': string;
|
|
54579
|
-
'attributes'?:
|
|
54580
|
-
'relationships'?:
|
|
54605
|
+
'attributes'?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
54606
|
+
'relationships'?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
54581
54607
|
}
|
|
54582
54608
|
|
|
54583
54609
|
export declare interface JsonApiWorkspaceDataFilterSettingInDocument {
|
|
@@ -54608,15 +54634,9 @@ export declare interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
54608
54634
|
* API identifier of an object
|
|
54609
54635
|
*/
|
|
54610
54636
|
'id': string;
|
|
54611
|
-
'meta'?:
|
|
54612
|
-
'attributes'?:
|
|
54613
|
-
'relationships'?:
|
|
54614
|
-
}
|
|
54615
|
-
|
|
54616
|
-
export declare interface JsonApiWorkspaceDataFilterSettingOutAttributes {
|
|
54617
|
-
'title'?: string;
|
|
54618
|
-
'description'?: string;
|
|
54619
|
-
'filterValues'?: Array<string>;
|
|
54637
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
54638
|
+
'attributes'?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
54639
|
+
'relationships'?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
54620
54640
|
}
|
|
54621
54641
|
|
|
54622
54642
|
export declare interface JsonApiWorkspaceDataFilterSettingOutDocument {
|
|
@@ -54634,21 +54654,13 @@ export declare interface JsonApiWorkspaceDataFilterSettingOutDocument {
|
|
|
54634
54654
|
export declare interface JsonApiWorkspaceDataFilterSettingOutList {
|
|
54635
54655
|
'data': Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>;
|
|
54636
54656
|
'links'?: ListLinks;
|
|
54637
|
-
'meta'?:
|
|
54657
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
54638
54658
|
/**
|
|
54639
54659
|
* Included resources
|
|
54640
54660
|
*/
|
|
54641
54661
|
'included'?: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
54642
54662
|
}
|
|
54643
54663
|
|
|
54644
|
-
export declare interface JsonApiWorkspaceDataFilterSettingOutRelationships {
|
|
54645
|
-
'workspaceDataFilter'?: JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter;
|
|
54646
|
-
}
|
|
54647
|
-
|
|
54648
|
-
export declare interface JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter {
|
|
54649
|
-
'data': JsonApiWorkspaceDataFilterLinkage | null;
|
|
54650
|
-
}
|
|
54651
|
-
|
|
54652
54664
|
export declare type JsonApiWorkspaceDataFilterSettingOutTypeEnum = 'workspaceDataFilterSetting';
|
|
54653
54665
|
|
|
54654
54666
|
export declare interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
@@ -54660,9 +54672,9 @@ export declare interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
54660
54672
|
* API identifier of an object
|
|
54661
54673
|
*/
|
|
54662
54674
|
'id': string;
|
|
54663
|
-
'meta'?:
|
|
54664
|
-
'attributes'?:
|
|
54665
|
-
'relationships'?:
|
|
54675
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
54676
|
+
'attributes'?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
54677
|
+
'relationships'?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
54666
54678
|
'links'?: ObjectLinks;
|
|
54667
54679
|
}
|
|
54668
54680
|
|
|
@@ -54680,14 +54692,28 @@ export declare interface JsonApiWorkspaceDataFilterSettingPatch {
|
|
|
54680
54692
|
* API identifier of an object
|
|
54681
54693
|
*/
|
|
54682
54694
|
'id': string;
|
|
54683
|
-
'attributes'?:
|
|
54684
|
-
'relationships'?:
|
|
54695
|
+
'attributes'?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
54696
|
+
'relationships'?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
54697
|
+
}
|
|
54698
|
+
|
|
54699
|
+
export declare interface JsonApiWorkspaceDataFilterSettingPatchAttributes {
|
|
54700
|
+
'title'?: string;
|
|
54701
|
+
'description'?: string;
|
|
54702
|
+
'filterValues'?: Array<string>;
|
|
54685
54703
|
}
|
|
54686
54704
|
|
|
54687
54705
|
export declare interface JsonApiWorkspaceDataFilterSettingPatchDocument {
|
|
54688
54706
|
'data': JsonApiWorkspaceDataFilterSettingPatch;
|
|
54689
54707
|
}
|
|
54690
54708
|
|
|
54709
|
+
export declare interface JsonApiWorkspaceDataFilterSettingPatchRelationships {
|
|
54710
|
+
'workspaceDataFilter'?: JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter;
|
|
54711
|
+
}
|
|
54712
|
+
|
|
54713
|
+
export declare interface JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter {
|
|
54714
|
+
'data': JsonApiWorkspaceDataFilterLinkage | null;
|
|
54715
|
+
}
|
|
54716
|
+
|
|
54691
54717
|
export declare type JsonApiWorkspaceDataFilterSettingPatchTypeEnum = 'workspaceDataFilterSetting';
|
|
54692
54718
|
|
|
54693
54719
|
/**
|
|
@@ -54702,8 +54728,8 @@ export declare interface JsonApiWorkspaceIn {
|
|
|
54702
54728
|
* API identifier of an object
|
|
54703
54729
|
*/
|
|
54704
54730
|
'id': string;
|
|
54705
|
-
'attributes'?:
|
|
54706
|
-
'relationships'?:
|
|
54731
|
+
'attributes'?: JsonApiWorkspaceOutAttributes;
|
|
54732
|
+
'relationships'?: JsonApiWorkspaceOutRelationships;
|
|
54707
54733
|
}
|
|
54708
54734
|
|
|
54709
54735
|
export declare interface JsonApiWorkspaceInDocument {
|
|
@@ -54735,8 +54761,42 @@ export declare interface JsonApiWorkspaceOut {
|
|
|
54735
54761
|
*/
|
|
54736
54762
|
'id': string;
|
|
54737
54763
|
'meta'?: JsonApiWorkspaceOutMeta;
|
|
54738
|
-
'attributes'?:
|
|
54739
|
-
'relationships'?:
|
|
54764
|
+
'attributes'?: JsonApiWorkspaceOutAttributes;
|
|
54765
|
+
'relationships'?: JsonApiWorkspaceOutRelationships;
|
|
54766
|
+
}
|
|
54767
|
+
|
|
54768
|
+
export declare interface JsonApiWorkspaceOutAttributes {
|
|
54769
|
+
'name'?: string | null;
|
|
54770
|
+
/**
|
|
54771
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
54772
|
+
* @deprecated
|
|
54773
|
+
*/
|
|
54774
|
+
'earlyAccess'?: string | null;
|
|
54775
|
+
/**
|
|
54776
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
54777
|
+
*/
|
|
54778
|
+
'earlyAccessValues'?: Array<string> | null;
|
|
54779
|
+
'description'?: string | null;
|
|
54780
|
+
/**
|
|
54781
|
+
* Custom prefix of entity identifiers in workspace
|
|
54782
|
+
*/
|
|
54783
|
+
'prefix'?: string | null;
|
|
54784
|
+
'cacheExtraLimit'?: number;
|
|
54785
|
+
'dataSource'?: JsonApiWorkspaceOutAttributesDataSource;
|
|
54786
|
+
}
|
|
54787
|
+
|
|
54788
|
+
/**
|
|
54789
|
+
* 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.
|
|
54790
|
+
*/
|
|
54791
|
+
export declare interface JsonApiWorkspaceOutAttributesDataSource {
|
|
54792
|
+
/**
|
|
54793
|
+
* The ID of the used data source.
|
|
54794
|
+
*/
|
|
54795
|
+
'id': string;
|
|
54796
|
+
/**
|
|
54797
|
+
* The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
|
|
54798
|
+
*/
|
|
54799
|
+
'schemaPath'?: Array<string>;
|
|
54740
54800
|
}
|
|
54741
54801
|
|
|
54742
54802
|
export declare interface JsonApiWorkspaceOutDocument {
|
|
@@ -54754,7 +54814,7 @@ export declare interface JsonApiWorkspaceOutDocument {
|
|
|
54754
54814
|
export declare interface JsonApiWorkspaceOutList {
|
|
54755
54815
|
'data': Array<JsonApiWorkspaceOutWithLinks>;
|
|
54756
54816
|
'links'?: ListLinks;
|
|
54757
|
-
'meta'?:
|
|
54817
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
54758
54818
|
/**
|
|
54759
54819
|
* Included resources
|
|
54760
54820
|
*/
|
|
@@ -54802,6 +54862,14 @@ export declare interface JsonApiWorkspaceOutMetaHierarchy {
|
|
|
54802
54862
|
|
|
54803
54863
|
export declare type JsonApiWorkspaceOutMetaPermissionsEnum = 'MANAGE' | 'ANALYZE' | 'EXPORT' | 'EXPORT_TABULAR' | 'EXPORT_PDF' | 'CREATE_AUTOMATION' | 'USE_AI_ASSISTANT' | 'WRITE_KNOWLEDGE_DOCUMENTS' | 'READ_KNOWLEDGE_DOCUMENTS' | 'CREATE_FILTER_VIEW' | 'VIEW';
|
|
54804
54864
|
|
|
54865
|
+
export declare interface JsonApiWorkspaceOutRelationships {
|
|
54866
|
+
'parent'?: JsonApiWorkspaceOutRelationshipsParent;
|
|
54867
|
+
}
|
|
54868
|
+
|
|
54869
|
+
export declare interface JsonApiWorkspaceOutRelationshipsParent {
|
|
54870
|
+
'data': JsonApiWorkspaceLinkage | null;
|
|
54871
|
+
}
|
|
54872
|
+
|
|
54805
54873
|
export declare type JsonApiWorkspaceOutTypeEnum = 'workspace';
|
|
54806
54874
|
|
|
54807
54875
|
export declare interface JsonApiWorkspaceOutWithLinks {
|
|
@@ -54814,8 +54882,8 @@ export declare interface JsonApiWorkspaceOutWithLinks {
|
|
|
54814
54882
|
*/
|
|
54815
54883
|
'id': string;
|
|
54816
54884
|
'meta'?: JsonApiWorkspaceOutMeta;
|
|
54817
|
-
'attributes'?:
|
|
54818
|
-
'relationships'?:
|
|
54885
|
+
'attributes'?: JsonApiWorkspaceOutAttributes;
|
|
54886
|
+
'relationships'?: JsonApiWorkspaceOutRelationships;
|
|
54819
54887
|
'links'?: ObjectLinks;
|
|
54820
54888
|
}
|
|
54821
54889
|
|
|
@@ -54833,56 +54901,14 @@ export declare interface JsonApiWorkspacePatch {
|
|
|
54833
54901
|
* API identifier of an object
|
|
54834
54902
|
*/
|
|
54835
54903
|
'id': string;
|
|
54836
|
-
'attributes'?:
|
|
54837
|
-
'relationships'?:
|
|
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>;
|
|
54904
|
+
'attributes'?: JsonApiWorkspaceOutAttributes;
|
|
54905
|
+
'relationships'?: JsonApiWorkspaceOutRelationships;
|
|
54872
54906
|
}
|
|
54873
54907
|
|
|
54874
54908
|
export declare interface JsonApiWorkspacePatchDocument {
|
|
54875
54909
|
'data': JsonApiWorkspacePatch;
|
|
54876
54910
|
}
|
|
54877
54911
|
|
|
54878
|
-
export declare interface JsonApiWorkspacePatchRelationships {
|
|
54879
|
-
'parent'?: JsonApiWorkspacePatchRelationshipsParent;
|
|
54880
|
-
}
|
|
54881
|
-
|
|
54882
|
-
export declare interface JsonApiWorkspacePatchRelationshipsParent {
|
|
54883
|
-
'data': JsonApiWorkspaceLinkage | null;
|
|
54884
|
-
}
|
|
54885
|
-
|
|
54886
54912
|
export declare type JsonApiWorkspacePatchTypeEnum = 'workspace';
|
|
54887
54913
|
|
|
54888
54914
|
/**
|
|
@@ -54897,7 +54923,7 @@ export declare interface JsonApiWorkspaceSettingIn {
|
|
|
54897
54923
|
* API identifier of an object
|
|
54898
54924
|
*/
|
|
54899
54925
|
'id': string;
|
|
54900
|
-
'attributes'?:
|
|
54926
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
54901
54927
|
}
|
|
54902
54928
|
|
|
54903
54929
|
export declare interface JsonApiWorkspaceSettingInDocument {
|
|
@@ -54918,8 +54944,8 @@ export declare interface JsonApiWorkspaceSettingOut {
|
|
|
54918
54944
|
* API identifier of an object
|
|
54919
54945
|
*/
|
|
54920
54946
|
'id': string;
|
|
54921
|
-
'meta'?:
|
|
54922
|
-
'attributes'?:
|
|
54947
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
54948
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
54923
54949
|
}
|
|
54924
54950
|
|
|
54925
54951
|
export declare interface JsonApiWorkspaceSettingOutDocument {
|
|
@@ -54933,7 +54959,7 @@ export declare interface JsonApiWorkspaceSettingOutDocument {
|
|
|
54933
54959
|
export declare interface JsonApiWorkspaceSettingOutList {
|
|
54934
54960
|
'data': Array<JsonApiWorkspaceSettingOutWithLinks>;
|
|
54935
54961
|
'links'?: ListLinks;
|
|
54936
|
-
'meta'?:
|
|
54962
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
54937
54963
|
}
|
|
54938
54964
|
|
|
54939
54965
|
export declare type JsonApiWorkspaceSettingOutTypeEnum = 'workspaceSetting';
|
|
@@ -54947,8 +54973,8 @@ export declare interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
54947
54973
|
* API identifier of an object
|
|
54948
54974
|
*/
|
|
54949
54975
|
'id': string;
|
|
54950
|
-
'meta'?:
|
|
54951
|
-
'attributes'?:
|
|
54976
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
54977
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
54952
54978
|
'links'?: ObjectLinks;
|
|
54953
54979
|
}
|
|
54954
54980
|
|
|
@@ -54966,7 +54992,7 @@ export declare interface JsonApiWorkspaceSettingPatch {
|
|
|
54966
54992
|
* API identifier of an object
|
|
54967
54993
|
*/
|
|
54968
54994
|
'id': string;
|
|
54969
|
-
'attributes'?:
|
|
54995
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
54970
54996
|
}
|
|
54971
54997
|
|
|
54972
54998
|
export declare interface JsonApiWorkspaceSettingPatchDocument {
|
|
@@ -54987,7 +55013,7 @@ export declare interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
54987
55013
|
* API identifier of an object
|
|
54988
55014
|
*/
|
|
54989
55015
|
'id'?: string;
|
|
54990
|
-
'attributes'?:
|
|
55016
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
54991
55017
|
}
|
|
54992
55018
|
|
|
54993
55019
|
export declare interface JsonApiWorkspaceSettingPostOptionalIdDocument {
|
|
@@ -72310,7 +72336,7 @@ export declare interface ResultActionsApiInterface {
|
|
|
72310
72336
|
*/
|
|
72311
72337
|
collectCacheUsage(options?: AxiosRequestConfig): AxiosPromise<CacheUsageData>;
|
|
72312
72338
|
/**
|
|
72313
|
-
* Converts a geo file from the staging area to GeoParquet format. Supported source formats: GeoJSON (.geojson, .json). If the source file is already in GeoParquet format, the same location is returned without conversion.
|
|
72339
|
+
* Converts a geo file from the staging area to GeoParquet format. Supported source formats: GeoJSON (.geojson, .json), ESRI Shapefile (.zip). If the source file is already in GeoParquet format, the same location is returned without conversion.
|
|
72314
72340
|
* @summary Convert a geo file to GeoParquet format
|
|
72315
72341
|
* @param {ActionsApiConvertGeoFileRequest} requestParameters Request parameters.
|
|
72316
72342
|
* @param {*} [options] Override http request option.
|
|
@@ -72319,7 +72345,7 @@ export declare interface ResultActionsApiInterface {
|
|
|
72319
72345
|
*/
|
|
72320
72346
|
convertGeoFile(requestParameters: ActionsApiConvertGeoFileRequest, options?: AxiosRequestConfig): AxiosPromise<ConvertGeoFileResponse>;
|
|
72321
72347
|
/**
|
|
72322
|
-
* Provides a location for uploading staging files for custom geo collections. Supported file types: GeoParquet (.parquet), GeoJSON (.geojson, .json).
|
|
72348
|
+
* Provides a location for uploading staging files for custom geo collections. Supported file types: GeoParquet (.parquet), GeoJSON (.geojson, .json), ESRI Shapefile (.zip). Maximum file size: 100 MB.
|
|
72323
72349
|
* @summary Upload a geo collection file to the staging area
|
|
72324
72350
|
* @param {ActionsApiCustomGeoCollectionStagingUploadRequest} requestParameters Request parameters.
|
|
72325
72351
|
* @param {*} [options] Override http request option.
|
|
@@ -72346,7 +72372,7 @@ export declare interface ResultActionsApiInterface {
|
|
|
72346
72372
|
*/
|
|
72347
72373
|
importCsv(requestParameters: ActionsApiImportCsvRequest, options?: AxiosRequestConfig): AxiosPromise<Array<ImportCsvResponse>>;
|
|
72348
72374
|
/**
|
|
72349
|
-
* Import a geo collection file from the staging area to be available for use.
|
|
72375
|
+
* Import a geo collection file from the staging area to be available for use. The file must be in GeoParquet format (use the convert endpoint first for other formats). Validates file size (max 100 MB), organization storage quota (max 1 GB total), and GeoParquet schema (requires id, geometry, and bbox columns).
|
|
72350
72376
|
* @summary Import custom geo collection
|
|
72351
72377
|
* @param {ActionsApiImportCustomGeoCollectionRequest} requestParameters Request parameters.
|
|
72352
72378
|
* @param {*} [options] Override http request option.
|
|
@@ -78277,6 +78303,9 @@ export declare interface VisualExportRequest {
|
|
|
78277
78303
|
*/
|
|
78278
78304
|
export declare interface VisualizationConfig {
|
|
78279
78305
|
'forecast'?: ForecastConfig;
|
|
78306
|
+
'anomalyDetection'?: AnomalyDetectionConfig;
|
|
78307
|
+
'clustering'?: ClusteringConfig;
|
|
78308
|
+
'whatIf'?: WhatIfScenarioConfig;
|
|
78280
78309
|
}
|
|
78281
78310
|
|
|
78282
78311
|
/**
|
|
@@ -78932,6 +78961,52 @@ export declare interface Webhook {
|
|
|
78932
78961
|
|
|
78933
78962
|
export declare type WebhookTypeEnum = 'WEBHOOK';
|
|
78934
78963
|
|
|
78964
|
+
/**
|
|
78965
|
+
* Measure adjustments for this scenario
|
|
78966
|
+
*/
|
|
78967
|
+
export declare interface WhatIfMeasureAdjustmentConfig {
|
|
78968
|
+
/**
|
|
78969
|
+
* ID of the metric or fact to adjust
|
|
78970
|
+
*/
|
|
78971
|
+
'metricId': string;
|
|
78972
|
+
/**
|
|
78973
|
+
* Type: metric or fact
|
|
78974
|
+
*/
|
|
78975
|
+
'metricType': string;
|
|
78976
|
+
/**
|
|
78977
|
+
* Alternative MAQL expression for this scenario
|
|
78978
|
+
*/
|
|
78979
|
+
'scenarioMaql': string;
|
|
78980
|
+
}
|
|
78981
|
+
|
|
78982
|
+
/**
|
|
78983
|
+
* What-if scenario configuration.
|
|
78984
|
+
*/
|
|
78985
|
+
export declare interface WhatIfScenarioConfig {
|
|
78986
|
+
/**
|
|
78987
|
+
* Scenarios with alternative measure calculations
|
|
78988
|
+
*/
|
|
78989
|
+
'scenarios': Array<WhatIfScenarioItem>;
|
|
78990
|
+
/**
|
|
78991
|
+
* Whether baseline (unmodified) values are included
|
|
78992
|
+
*/
|
|
78993
|
+
'includeBaseline': boolean;
|
|
78994
|
+
}
|
|
78995
|
+
|
|
78996
|
+
/**
|
|
78997
|
+
* Scenarios with alternative measure calculations
|
|
78998
|
+
*/
|
|
78999
|
+
export declare interface WhatIfScenarioItem {
|
|
79000
|
+
/**
|
|
79001
|
+
* Human-readable scenario label
|
|
79002
|
+
*/
|
|
79003
|
+
'label': string;
|
|
79004
|
+
/**
|
|
79005
|
+
* Measure adjustments for this scenario
|
|
79006
|
+
*/
|
|
79007
|
+
'adjustments': Array<WhatIfMeasureAdjustmentConfig>;
|
|
79008
|
+
}
|
|
79009
|
+
|
|
78935
79010
|
/**
|
|
78936
79011
|
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
78937
79012
|
*/
|