@gooddata/api-client-tiger 11.21.0-alpha.0 → 11.21.0
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.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +907 -783
- package/esm/generated/afm-rest-api/api.d.ts +30 -2
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/api.d.ts +30 -2
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/api.d.ts +30 -2
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +678 -650
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/package.json +5 -5
|
@@ -222,7 +222,7 @@ export interface AttributeElementsByValue {
|
|
|
222
222
|
* @type AttributeFilter
|
|
223
223
|
* Abstract filter definition type attributes
|
|
224
224
|
*/
|
|
225
|
-
export type AttributeFilter = NegativeAttributeFilter | PositiveAttributeFilter;
|
|
225
|
+
export type AttributeFilter = MatchAttributeFilter | NegativeAttributeFilter | PositiveAttributeFilter;
|
|
226
226
|
export interface AttributeFilterByDate {
|
|
227
227
|
'filterLocalIdentifier': string;
|
|
228
228
|
'isCommonDate': boolean;
|
|
@@ -1063,7 +1063,7 @@ export interface DeclarativeCustomApplicationSetting {
|
|
|
1063
1063
|
*/
|
|
1064
1064
|
'id': string;
|
|
1065
1065
|
/**
|
|
1066
|
-
* Free-form JSON
|
|
1066
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
1067
1067
|
*/
|
|
1068
1068
|
'content': object | null;
|
|
1069
1069
|
/**
|
|
@@ -2521,7 +2521,7 @@ export type FactIdentifierTypeEnum = 'fact';
|
|
|
2521
2521
|
* @type FilterDefinition
|
|
2522
2522
|
* Abstract filter definition type
|
|
2523
2523
|
*/
|
|
2524
|
-
export type FilterDefinition = AbsoluteDateFilter | ComparisonMeasureValueFilter | CompoundMeasureValueFilter | InlineFilterDefinition | NegativeAttributeFilter | PositiveAttributeFilter | RangeMeasureValueFilter | RankingFilter | RelativeDateFilter;
|
|
2524
|
+
export type FilterDefinition = AbsoluteDateFilter | ComparisonMeasureValueFilter | CompoundMeasureValueFilter | InlineFilterDefinition | MatchAttributeFilter | NegativeAttributeFilter | PositiveAttributeFilter | RangeMeasureValueFilter | RankingFilter | RelativeDateFilter;
|
|
2525
2525
|
/**
|
|
2526
2526
|
* @type FilterDefinitionForSimpleMeasure
|
|
2527
2527
|
* Abstract filter definition type for simple metric.
|
|
@@ -2788,7 +2788,7 @@ export interface JsonApiAggregatedFactOut {
|
|
|
2788
2788
|
* API identifier of an object
|
|
2789
2789
|
*/
|
|
2790
2790
|
'id': string;
|
|
2791
|
-
'meta'?:
|
|
2791
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
2792
2792
|
'attributes': JsonApiAggregatedFactOutAttributes;
|
|
2793
2793
|
'relationships'?: JsonApiAggregatedFactOutRelationships;
|
|
2794
2794
|
}
|
|
@@ -2823,12 +2823,15 @@ export type JsonApiAggregatedFactOutIncludes = JsonApiDatasetOutWithLinks | Json
|
|
|
2823
2823
|
export interface JsonApiAggregatedFactOutList {
|
|
2824
2824
|
'data': Array<JsonApiAggregatedFactOutWithLinks>;
|
|
2825
2825
|
'links'?: ListLinks;
|
|
2826
|
-
'meta'?:
|
|
2826
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
2827
2827
|
/**
|
|
2828
2828
|
* Included resources
|
|
2829
2829
|
*/
|
|
2830
2830
|
'included'?: Array<JsonApiAggregatedFactOutIncludes>;
|
|
2831
2831
|
}
|
|
2832
|
+
export interface JsonApiAggregatedFactOutListMeta {
|
|
2833
|
+
'page'?: PageMetadata;
|
|
2834
|
+
}
|
|
2832
2835
|
export interface JsonApiAggregatedFactOutRelationships {
|
|
2833
2836
|
'dataset'?: JsonApiFactOutRelationshipsDataset;
|
|
2834
2837
|
'sourceFact'?: JsonApiAggregatedFactOutRelationshipsSourceFact;
|
|
@@ -2845,7 +2848,7 @@ export interface JsonApiAggregatedFactOutWithLinks {
|
|
|
2845
2848
|
* API identifier of an object
|
|
2846
2849
|
*/
|
|
2847
2850
|
'id': string;
|
|
2848
|
-
'meta'?:
|
|
2851
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
2849
2852
|
'attributes': JsonApiAggregatedFactOutAttributes;
|
|
2850
2853
|
'relationships'?: JsonApiAggregatedFactOutRelationships;
|
|
2851
2854
|
'links'?: ObjectLinks;
|
|
@@ -2934,7 +2937,7 @@ export type JsonApiAnalyticalDashboardOutIncludes = JsonApiAnalyticalDashboardOu
|
|
|
2934
2937
|
export interface JsonApiAnalyticalDashboardOutList {
|
|
2935
2938
|
'data': Array<JsonApiAnalyticalDashboardOutWithLinks>;
|
|
2936
2939
|
'links'?: ListLinks;
|
|
2937
|
-
'meta'?:
|
|
2940
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
2938
2941
|
/**
|
|
2939
2942
|
* Included resources
|
|
2940
2943
|
*/
|
|
@@ -2945,7 +2948,7 @@ export interface JsonApiAnalyticalDashboardOutMeta {
|
|
|
2945
2948
|
* List of valid permissions for a logged-in user.
|
|
2946
2949
|
*/
|
|
2947
2950
|
'permissions'?: Array<JsonApiAnalyticalDashboardOutMetaPermissionsEnum>;
|
|
2948
|
-
'origin'?:
|
|
2951
|
+
'origin'?: JsonApiDatasetOutMetaOrigin;
|
|
2949
2952
|
'accessInfo'?: JsonApiAnalyticalDashboardOutMetaAccessInfo;
|
|
2950
2953
|
}
|
|
2951
2954
|
export type JsonApiAnalyticalDashboardOutMetaPermissionsEnum = 'EDIT' | 'SHARE' | 'VIEW';
|
|
@@ -2955,25 +2958,14 @@ export interface JsonApiAnalyticalDashboardOutMetaAccessInfo {
|
|
|
2955
2958
|
*/
|
|
2956
2959
|
'private': boolean;
|
|
2957
2960
|
}
|
|
2958
|
-
export interface JsonApiAnalyticalDashboardOutMetaOrigin {
|
|
2959
|
-
/**
|
|
2960
|
-
* defines type of the origin of the entity
|
|
2961
|
-
*/
|
|
2962
|
-
'originType': JsonApiAnalyticalDashboardOutMetaOriginOriginTypeEnum;
|
|
2963
|
-
/**
|
|
2964
|
-
* defines id of the workspace where the entity comes from
|
|
2965
|
-
*/
|
|
2966
|
-
'originId': string;
|
|
2967
|
-
}
|
|
2968
|
-
export type JsonApiAnalyticalDashboardOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
2969
2961
|
export interface JsonApiAnalyticalDashboardOutRelationships {
|
|
2970
|
-
'createdBy'?:
|
|
2971
|
-
'modifiedBy'?:
|
|
2962
|
+
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
2963
|
+
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
2972
2964
|
'visualizationObjects'?: JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects;
|
|
2973
2965
|
'analyticalDashboards'?: JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards;
|
|
2974
|
-
'labels'?:
|
|
2975
|
-
'metrics'?:
|
|
2976
|
-
'datasets'?:
|
|
2966
|
+
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
2967
|
+
'metrics'?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
2968
|
+
'datasets'?: JsonApiDatasetOutRelationshipsReferences;
|
|
2977
2969
|
'filterContexts'?: JsonApiAnalyticalDashboardOutRelationshipsFilterContexts;
|
|
2978
2970
|
'dashboardPlugins'?: JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins;
|
|
2979
2971
|
}
|
|
@@ -2983,39 +2975,18 @@ export interface JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards
|
|
|
2983
2975
|
*/
|
|
2984
2976
|
'data': Array<JsonApiAnalyticalDashboardLinkage>;
|
|
2985
2977
|
}
|
|
2986
|
-
export interface JsonApiAnalyticalDashboardOutRelationshipsCreatedBy {
|
|
2987
|
-
'data': JsonApiUserIdentifierLinkage | null;
|
|
2988
|
-
}
|
|
2989
2978
|
export interface JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins {
|
|
2990
2979
|
/**
|
|
2991
2980
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
2992
2981
|
*/
|
|
2993
2982
|
'data': Array<JsonApiDashboardPluginLinkage>;
|
|
2994
2983
|
}
|
|
2995
|
-
export interface JsonApiAnalyticalDashboardOutRelationshipsDatasets {
|
|
2996
|
-
/**
|
|
2997
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
2998
|
-
*/
|
|
2999
|
-
'data': Array<JsonApiDatasetLinkage>;
|
|
3000
|
-
}
|
|
3001
2984
|
export interface JsonApiAnalyticalDashboardOutRelationshipsFilterContexts {
|
|
3002
2985
|
/**
|
|
3003
2986
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3004
2987
|
*/
|
|
3005
2988
|
'data': Array<JsonApiFilterContextLinkage>;
|
|
3006
2989
|
}
|
|
3007
|
-
export interface JsonApiAnalyticalDashboardOutRelationshipsLabels {
|
|
3008
|
-
/**
|
|
3009
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3010
|
-
*/
|
|
3011
|
-
'data': Array<JsonApiLabelLinkage>;
|
|
3012
|
-
}
|
|
3013
|
-
export interface JsonApiAnalyticalDashboardOutRelationshipsMetrics {
|
|
3014
|
-
/**
|
|
3015
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3016
|
-
*/
|
|
3017
|
-
'data': Array<JsonApiMetricLinkage>;
|
|
3018
|
-
}
|
|
3019
2990
|
export interface JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects {
|
|
3020
2991
|
/**
|
|
3021
2992
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -3149,7 +3120,7 @@ export interface JsonApiApiTokenOutDocument {
|
|
|
3149
3120
|
export interface JsonApiApiTokenOutList {
|
|
3150
3121
|
'data': Array<JsonApiApiTokenOutWithLinks>;
|
|
3151
3122
|
'links'?: ListLinks;
|
|
3152
|
-
'meta'?:
|
|
3123
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
3153
3124
|
}
|
|
3154
3125
|
export interface JsonApiApiTokenOutWithLinks {
|
|
3155
3126
|
/**
|
|
@@ -3176,19 +3147,9 @@ export interface JsonApiAttributeHierarchyIn {
|
|
|
3176
3147
|
* API identifier of an object
|
|
3177
3148
|
*/
|
|
3178
3149
|
'id': string;
|
|
3179
|
-
'attributes'?:
|
|
3150
|
+
'attributes'?: JsonApiAttributeHierarchyPatchAttributes;
|
|
3180
3151
|
}
|
|
3181
3152
|
export type JsonApiAttributeHierarchyInTypeEnum = 'attributeHierarchy';
|
|
3182
|
-
export interface JsonApiAttributeHierarchyInAttributes {
|
|
3183
|
-
'title'?: string;
|
|
3184
|
-
'description'?: string;
|
|
3185
|
-
'tags'?: Array<string>;
|
|
3186
|
-
'areRelationsValid'?: boolean;
|
|
3187
|
-
/**
|
|
3188
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
3189
|
-
*/
|
|
3190
|
-
'content'?: object;
|
|
3191
|
-
}
|
|
3192
3153
|
export interface JsonApiAttributeHierarchyInDocument {
|
|
3193
3154
|
'data': JsonApiAttributeHierarchyIn;
|
|
3194
3155
|
}
|
|
@@ -3212,7 +3173,7 @@ export interface JsonApiAttributeHierarchyOut {
|
|
|
3212
3173
|
* API identifier of an object
|
|
3213
3174
|
*/
|
|
3214
3175
|
'id': string;
|
|
3215
|
-
'meta'?:
|
|
3176
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
3216
3177
|
'attributes'?: JsonApiAttributeHierarchyOutAttributes;
|
|
3217
3178
|
'relationships'?: JsonApiAttributeHierarchyOutRelationships;
|
|
3218
3179
|
}
|
|
@@ -3253,15 +3214,15 @@ export type JsonApiAttributeHierarchyOutIncludes = JsonApiAttributeOutWithLinks
|
|
|
3253
3214
|
export interface JsonApiAttributeHierarchyOutList {
|
|
3254
3215
|
'data': Array<JsonApiAttributeHierarchyOutWithLinks>;
|
|
3255
3216
|
'links'?: ListLinks;
|
|
3256
|
-
'meta'?:
|
|
3217
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
3257
3218
|
/**
|
|
3258
3219
|
* Included resources
|
|
3259
3220
|
*/
|
|
3260
3221
|
'included'?: Array<JsonApiAttributeHierarchyOutIncludes>;
|
|
3261
3222
|
}
|
|
3262
3223
|
export interface JsonApiAttributeHierarchyOutRelationships {
|
|
3263
|
-
'createdBy'?:
|
|
3264
|
-
'modifiedBy'?:
|
|
3224
|
+
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3225
|
+
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3265
3226
|
'attributes'?: JsonApiDatasetOutRelationshipsAttributes;
|
|
3266
3227
|
}
|
|
3267
3228
|
export interface JsonApiAttributeHierarchyOutWithLinks {
|
|
@@ -3273,7 +3234,7 @@ export interface JsonApiAttributeHierarchyOutWithLinks {
|
|
|
3273
3234
|
* API identifier of an object
|
|
3274
3235
|
*/
|
|
3275
3236
|
'id': string;
|
|
3276
|
-
'meta'?:
|
|
3237
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
3277
3238
|
'attributes'?: JsonApiAttributeHierarchyOutAttributes;
|
|
3278
3239
|
'relationships'?: JsonApiAttributeHierarchyOutRelationships;
|
|
3279
3240
|
'links'?: ObjectLinks;
|
|
@@ -3291,9 +3252,19 @@ export interface JsonApiAttributeHierarchyPatch {
|
|
|
3291
3252
|
* API identifier of an object
|
|
3292
3253
|
*/
|
|
3293
3254
|
'id': string;
|
|
3294
|
-
'attributes'?:
|
|
3255
|
+
'attributes'?: JsonApiAttributeHierarchyPatchAttributes;
|
|
3295
3256
|
}
|
|
3296
3257
|
export type JsonApiAttributeHierarchyPatchTypeEnum = 'attributeHierarchy';
|
|
3258
|
+
export interface JsonApiAttributeHierarchyPatchAttributes {
|
|
3259
|
+
'title'?: string;
|
|
3260
|
+
'description'?: string;
|
|
3261
|
+
'tags'?: Array<string>;
|
|
3262
|
+
'areRelationsValid'?: boolean;
|
|
3263
|
+
/**
|
|
3264
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
3265
|
+
*/
|
|
3266
|
+
'content'?: object;
|
|
3267
|
+
}
|
|
3297
3268
|
export interface JsonApiAttributeHierarchyPatchDocument {
|
|
3298
3269
|
'data': JsonApiAttributeHierarchyPatch;
|
|
3299
3270
|
}
|
|
@@ -3317,7 +3288,7 @@ export interface JsonApiAttributeOut {
|
|
|
3317
3288
|
* API identifier of an object
|
|
3318
3289
|
*/
|
|
3319
3290
|
'id': string;
|
|
3320
|
-
'meta'?:
|
|
3291
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
3321
3292
|
'attributes'?: JsonApiAttributeOutAttributes;
|
|
3322
3293
|
'relationships'?: JsonApiAttributeOutRelationships;
|
|
3323
3294
|
}
|
|
@@ -3358,7 +3329,7 @@ export type JsonApiAttributeOutIncludes = JsonApiAttributeHierarchyOutWithLinks
|
|
|
3358
3329
|
export interface JsonApiAttributeOutList {
|
|
3359
3330
|
'data': Array<JsonApiAttributeOutWithLinks>;
|
|
3360
3331
|
'links'?: ListLinks;
|
|
3361
|
-
'meta'?:
|
|
3332
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
3362
3333
|
/**
|
|
3363
3334
|
* Included resources
|
|
3364
3335
|
*/
|
|
@@ -3367,7 +3338,7 @@ export interface JsonApiAttributeOutList {
|
|
|
3367
3338
|
export interface JsonApiAttributeOutRelationships {
|
|
3368
3339
|
'dataset'?: JsonApiFactOutRelationshipsDataset;
|
|
3369
3340
|
'defaultView'?: JsonApiAttributeOutRelationshipsDefaultView;
|
|
3370
|
-
'labels'?:
|
|
3341
|
+
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
3371
3342
|
'attributeHierarchies'?: JsonApiAttributeOutRelationshipsAttributeHierarchies;
|
|
3372
3343
|
}
|
|
3373
3344
|
export interface JsonApiAttributeOutRelationshipsAttributeHierarchies {
|
|
@@ -3388,7 +3359,7 @@ export interface JsonApiAttributeOutWithLinks {
|
|
|
3388
3359
|
* API identifier of an object
|
|
3389
3360
|
*/
|
|
3390
3361
|
'id': string;
|
|
3391
|
-
'meta'?:
|
|
3362
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
3392
3363
|
'attributes'?: JsonApiAttributeOutAttributes;
|
|
3393
3364
|
'relationships'?: JsonApiAttributeOutRelationships;
|
|
3394
3365
|
'links'?: ObjectLinks;
|
|
@@ -3433,52 +3404,13 @@ export interface JsonApiAutomationIn {
|
|
|
3433
3404
|
* API identifier of an object
|
|
3434
3405
|
*/
|
|
3435
3406
|
'id': string;
|
|
3436
|
-
'attributes'?:
|
|
3437
|
-
'relationships'?:
|
|
3407
|
+
'attributes'?: JsonApiAutomationPatchAttributes;
|
|
3408
|
+
'relationships'?: JsonApiAutomationPatchRelationships;
|
|
3438
3409
|
}
|
|
3439
3410
|
export type JsonApiAutomationInTypeEnum = 'automation';
|
|
3440
|
-
export interface JsonApiAutomationInAttributes {
|
|
3441
|
-
'title'?: string;
|
|
3442
|
-
'description'?: string;
|
|
3443
|
-
'tags'?: Array<string>;
|
|
3444
|
-
'areRelationsValid'?: boolean;
|
|
3445
|
-
/**
|
|
3446
|
-
* Additional details to be included in the automated message.
|
|
3447
|
-
*/
|
|
3448
|
-
'details'?: object;
|
|
3449
|
-
'metadata'?: JsonApiWorkspaceAutomationOutAttributesMetadata | null;
|
|
3450
|
-
/**
|
|
3451
|
-
* Current state of the automation.
|
|
3452
|
-
*/
|
|
3453
|
-
'state'?: JsonApiAutomationInAttributesStateEnum;
|
|
3454
|
-
/**
|
|
3455
|
-
* Specify automation evaluation mode.
|
|
3456
|
-
*/
|
|
3457
|
-
'evaluationMode'?: JsonApiAutomationInAttributesEvaluationModeEnum;
|
|
3458
|
-
'schedule'?: JsonApiWorkspaceAutomationOutAttributesSchedule;
|
|
3459
|
-
'alert'?: JsonApiWorkspaceAutomationOutAttributesAlert;
|
|
3460
|
-
'tabularExports'?: Array<JsonApiWorkspaceAutomationOutAttributesTabularExportsInner>;
|
|
3461
|
-
'visualExports'?: Array<JsonApiWorkspaceAutomationOutAttributesVisualExportsInner>;
|
|
3462
|
-
'imageExports'?: Array<JsonApiWorkspaceAutomationOutAttributesImageExportsInner>;
|
|
3463
|
-
'rawExports'?: Array<JsonApiWorkspaceAutomationOutAttributesRawExportsInner>;
|
|
3464
|
-
'slidesExports'?: Array<JsonApiWorkspaceAutomationOutAttributesSlidesExportsInner>;
|
|
3465
|
-
'dashboardTabularExports'?: Array<JsonApiWorkspaceAutomationOutAttributesDashboardTabularExportsInner>;
|
|
3466
|
-
/**
|
|
3467
|
-
* External recipients of the automation action results.
|
|
3468
|
-
*/
|
|
3469
|
-
'externalRecipients'?: Array<JsonApiWorkspaceAutomationOutAttributesExternalRecipientsInner>;
|
|
3470
|
-
}
|
|
3471
|
-
export type JsonApiAutomationInAttributesStateEnum = 'ACTIVE' | 'PAUSED';
|
|
3472
|
-
export type JsonApiAutomationInAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
|
|
3473
3411
|
export interface JsonApiAutomationInDocument {
|
|
3474
3412
|
'data': JsonApiAutomationIn;
|
|
3475
3413
|
}
|
|
3476
|
-
export interface JsonApiAutomationInRelationships {
|
|
3477
|
-
'notificationChannel'?: JsonApiWorkspaceAutomationOutRelationshipsNotificationChannel;
|
|
3478
|
-
'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
3479
|
-
'exportDefinitions'?: JsonApiWorkspaceAutomationOutRelationshipsExportDefinitions;
|
|
3480
|
-
'recipients'?: JsonApiWorkspaceAutomationOutRelationshipsRecipients;
|
|
3481
|
-
}
|
|
3482
3414
|
/**
|
|
3483
3415
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
3484
3416
|
*/
|
|
@@ -3499,7 +3431,7 @@ export interface JsonApiAutomationOut {
|
|
|
3499
3431
|
* API identifier of an object
|
|
3500
3432
|
*/
|
|
3501
3433
|
'id': string;
|
|
3502
|
-
'meta'?:
|
|
3434
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
3503
3435
|
'attributes'?: JsonApiAutomationOutAttributes;
|
|
3504
3436
|
'relationships'?: JsonApiAutomationOutRelationships;
|
|
3505
3437
|
}
|
|
@@ -3513,7 +3445,7 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
3513
3445
|
* Additional details to be included in the automated message.
|
|
3514
3446
|
*/
|
|
3515
3447
|
'details'?: object;
|
|
3516
|
-
'metadata'?:
|
|
3448
|
+
'metadata'?: JsonApiAutomationOutAttributesMetadata | null;
|
|
3517
3449
|
/**
|
|
3518
3450
|
* Current state of the automation.
|
|
3519
3451
|
*/
|
|
@@ -3522,18 +3454,18 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
3522
3454
|
* Specify automation evaluation mode.
|
|
3523
3455
|
*/
|
|
3524
3456
|
'evaluationMode'?: JsonApiAutomationOutAttributesEvaluationModeEnum;
|
|
3525
|
-
'schedule'?:
|
|
3526
|
-
'alert'?:
|
|
3527
|
-
'tabularExports'?: Array<
|
|
3528
|
-
'visualExports'?: Array<
|
|
3529
|
-
'imageExports'?: Array<
|
|
3530
|
-
'rawExports'?: Array<
|
|
3531
|
-
'slidesExports'?: Array<
|
|
3532
|
-
'dashboardTabularExports'?: Array<
|
|
3457
|
+
'schedule'?: JsonApiAutomationOutAttributesSchedule;
|
|
3458
|
+
'alert'?: JsonApiAutomationOutAttributesAlert;
|
|
3459
|
+
'tabularExports'?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
|
|
3460
|
+
'visualExports'?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
|
|
3461
|
+
'imageExports'?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
|
|
3462
|
+
'rawExports'?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
|
|
3463
|
+
'slidesExports'?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
|
|
3464
|
+
'dashboardTabularExports'?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
|
|
3533
3465
|
/**
|
|
3534
3466
|
* External recipients of the automation action results.
|
|
3535
3467
|
*/
|
|
3536
|
-
'externalRecipients'?: Array<
|
|
3468
|
+
'externalRecipients'?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
|
|
3537
3469
|
/**
|
|
3538
3470
|
* Time of the entity creation.
|
|
3539
3471
|
*/
|
|
@@ -3545,6 +3477,70 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
3545
3477
|
}
|
|
3546
3478
|
export type JsonApiAutomationOutAttributesStateEnum = 'ACTIVE' | 'PAUSED';
|
|
3547
3479
|
export type JsonApiAutomationOutAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
|
|
3480
|
+
export interface JsonApiAutomationOutAttributesAlert {
|
|
3481
|
+
'execution': AlertAfm;
|
|
3482
|
+
'condition': AlertCondition;
|
|
3483
|
+
/**
|
|
3484
|
+
* 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.
|
|
3485
|
+
*/
|
|
3486
|
+
'trigger'?: JsonApiAutomationOutAttributesAlertTriggerEnum;
|
|
3487
|
+
/**
|
|
3488
|
+
* Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.
|
|
3489
|
+
*/
|
|
3490
|
+
'interval'?: JsonApiAutomationOutAttributesAlertIntervalEnum;
|
|
3491
|
+
}
|
|
3492
|
+
export type JsonApiAutomationOutAttributesAlertTriggerEnum = 'ALWAYS' | 'ONCE' | 'ONCE_PER_INTERVAL';
|
|
3493
|
+
export type JsonApiAutomationOutAttributesAlertIntervalEnum = 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
|
|
3494
|
+
export interface JsonApiAutomationOutAttributesDashboardTabularExportsInner {
|
|
3495
|
+
'requestPayload': DashboardTabularExportRequestV2;
|
|
3496
|
+
}
|
|
3497
|
+
export interface JsonApiAutomationOutAttributesExternalRecipientsInner {
|
|
3498
|
+
/**
|
|
3499
|
+
* E-mail address to send notifications from.
|
|
3500
|
+
*/
|
|
3501
|
+
'email': string;
|
|
3502
|
+
}
|
|
3503
|
+
export interface JsonApiAutomationOutAttributesImageExportsInner {
|
|
3504
|
+
'requestPayload': ImageExportRequest;
|
|
3505
|
+
}
|
|
3506
|
+
/**
|
|
3507
|
+
* Additional information for the automation.
|
|
3508
|
+
*/
|
|
3509
|
+
export interface JsonApiAutomationOutAttributesMetadata {
|
|
3510
|
+
[key: string]: any;
|
|
3511
|
+
'widget'?: string;
|
|
3512
|
+
'visibleFilters'?: Array<VisibleFilter>;
|
|
3513
|
+
}
|
|
3514
|
+
export interface JsonApiAutomationOutAttributesRawExportsInner {
|
|
3515
|
+
'requestPayload': RawExportAutomationRequest;
|
|
3516
|
+
}
|
|
3517
|
+
export interface JsonApiAutomationOutAttributesSchedule {
|
|
3518
|
+
/**
|
|
3519
|
+
* 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.
|
|
3520
|
+
*/
|
|
3521
|
+
'cron': string;
|
|
3522
|
+
/**
|
|
3523
|
+
* Human-readable description of the cron expression.
|
|
3524
|
+
*/
|
|
3525
|
+
'cronDescription'?: string;
|
|
3526
|
+
/**
|
|
3527
|
+
* Timezone in which the schedule is defined.
|
|
3528
|
+
*/
|
|
3529
|
+
'timezone': string;
|
|
3530
|
+
/**
|
|
3531
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
3532
|
+
*/
|
|
3533
|
+
'firstRun'?: string;
|
|
3534
|
+
}
|
|
3535
|
+
export interface JsonApiAutomationOutAttributesSlidesExportsInner {
|
|
3536
|
+
'requestPayload': SlidesExportRequest;
|
|
3537
|
+
}
|
|
3538
|
+
export interface JsonApiAutomationOutAttributesTabularExportsInner {
|
|
3539
|
+
'requestPayload': TabularExportRequest;
|
|
3540
|
+
}
|
|
3541
|
+
export interface JsonApiAutomationOutAttributesVisualExportsInner {
|
|
3542
|
+
'requestPayload': VisualExportRequest;
|
|
3543
|
+
}
|
|
3548
3544
|
export interface JsonApiAutomationOutDocument {
|
|
3549
3545
|
'data': JsonApiAutomationOut;
|
|
3550
3546
|
'links'?: ObjectLinks;
|
|
@@ -3563,20 +3559,44 @@ export type JsonApiAutomationOutIncludes = JsonApiAnalyticalDashboardOutWithLink
|
|
|
3563
3559
|
export interface JsonApiAutomationOutList {
|
|
3564
3560
|
'data': Array<JsonApiAutomationOutWithLinks>;
|
|
3565
3561
|
'links'?: ListLinks;
|
|
3566
|
-
'meta'?:
|
|
3562
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
3567
3563
|
/**
|
|
3568
3564
|
* Included resources
|
|
3569
3565
|
*/
|
|
3570
3566
|
'included'?: Array<JsonApiAutomationOutIncludes>;
|
|
3571
3567
|
}
|
|
3572
3568
|
export interface JsonApiAutomationOutRelationships {
|
|
3573
|
-
'notificationChannel'?:
|
|
3574
|
-
'analyticalDashboard'?:
|
|
3575
|
-
'createdBy'?:
|
|
3576
|
-
'modifiedBy'?:
|
|
3577
|
-
'exportDefinitions'?:
|
|
3578
|
-
'recipients'?:
|
|
3579
|
-
'automationResults'?:
|
|
3569
|
+
'notificationChannel'?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
3570
|
+
'analyticalDashboard'?: JsonApiAutomationOutRelationshipsAnalyticalDashboard;
|
|
3571
|
+
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3572
|
+
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3573
|
+
'exportDefinitions'?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
3574
|
+
'recipients'?: JsonApiAutomationOutRelationshipsRecipients;
|
|
3575
|
+
'automationResults'?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
3576
|
+
}
|
|
3577
|
+
export interface JsonApiAutomationOutRelationshipsAnalyticalDashboard {
|
|
3578
|
+
'data': JsonApiAnalyticalDashboardLinkage | null;
|
|
3579
|
+
}
|
|
3580
|
+
export interface JsonApiAutomationOutRelationshipsAutomationResults {
|
|
3581
|
+
/**
|
|
3582
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3583
|
+
*/
|
|
3584
|
+
'data': Array<JsonApiAutomationResultLinkage>;
|
|
3585
|
+
}
|
|
3586
|
+
export interface JsonApiAutomationOutRelationshipsExportDefinitions {
|
|
3587
|
+
/**
|
|
3588
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3589
|
+
*/
|
|
3590
|
+
'data': Array<JsonApiExportDefinitionLinkage>;
|
|
3591
|
+
}
|
|
3592
|
+
export interface JsonApiAutomationOutRelationshipsNotificationChannel {
|
|
3593
|
+
'data': JsonApiNotificationChannelLinkage | null;
|
|
3594
|
+
}
|
|
3595
|
+
export interface JsonApiAutomationOutRelationshipsRecipients {
|
|
3596
|
+
/**
|
|
3597
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3598
|
+
*/
|
|
3599
|
+
'data': Array<JsonApiUserLinkage>;
|
|
3580
3600
|
}
|
|
3581
3601
|
export interface JsonApiAutomationOutWithLinks {
|
|
3582
3602
|
/**
|
|
@@ -3587,7 +3607,7 @@ export interface JsonApiAutomationOutWithLinks {
|
|
|
3587
3607
|
* API identifier of an object
|
|
3588
3608
|
*/
|
|
3589
3609
|
'id': string;
|
|
3590
|
-
'meta'?:
|
|
3610
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
3591
3611
|
'attributes'?: JsonApiAutomationOutAttributes;
|
|
3592
3612
|
'relationships'?: JsonApiAutomationOutRelationships;
|
|
3593
3613
|
'links'?: ObjectLinks;
|
|
@@ -3605,13 +3625,52 @@ export interface JsonApiAutomationPatch {
|
|
|
3605
3625
|
* API identifier of an object
|
|
3606
3626
|
*/
|
|
3607
3627
|
'id': string;
|
|
3608
|
-
'attributes'?:
|
|
3609
|
-
'relationships'?:
|
|
3628
|
+
'attributes'?: JsonApiAutomationPatchAttributes;
|
|
3629
|
+
'relationships'?: JsonApiAutomationPatchRelationships;
|
|
3610
3630
|
}
|
|
3611
3631
|
export type JsonApiAutomationPatchTypeEnum = 'automation';
|
|
3632
|
+
export interface JsonApiAutomationPatchAttributes {
|
|
3633
|
+
'title'?: string;
|
|
3634
|
+
'description'?: string;
|
|
3635
|
+
'tags'?: Array<string>;
|
|
3636
|
+
'areRelationsValid'?: boolean;
|
|
3637
|
+
/**
|
|
3638
|
+
* Additional details to be included in the automated message.
|
|
3639
|
+
*/
|
|
3640
|
+
'details'?: object;
|
|
3641
|
+
'metadata'?: JsonApiAutomationOutAttributesMetadata | null;
|
|
3642
|
+
/**
|
|
3643
|
+
* Current state of the automation.
|
|
3644
|
+
*/
|
|
3645
|
+
'state'?: JsonApiAutomationPatchAttributesStateEnum;
|
|
3646
|
+
/**
|
|
3647
|
+
* Specify automation evaluation mode.
|
|
3648
|
+
*/
|
|
3649
|
+
'evaluationMode'?: JsonApiAutomationPatchAttributesEvaluationModeEnum;
|
|
3650
|
+
'schedule'?: JsonApiAutomationOutAttributesSchedule;
|
|
3651
|
+
'alert'?: JsonApiAutomationOutAttributesAlert;
|
|
3652
|
+
'tabularExports'?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
|
|
3653
|
+
'visualExports'?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
|
|
3654
|
+
'imageExports'?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
|
|
3655
|
+
'rawExports'?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
|
|
3656
|
+
'slidesExports'?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
|
|
3657
|
+
'dashboardTabularExports'?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
|
|
3658
|
+
/**
|
|
3659
|
+
* External recipients of the automation action results.
|
|
3660
|
+
*/
|
|
3661
|
+
'externalRecipients'?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
|
|
3662
|
+
}
|
|
3663
|
+
export type JsonApiAutomationPatchAttributesStateEnum = 'ACTIVE' | 'PAUSED';
|
|
3664
|
+
export type JsonApiAutomationPatchAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
|
|
3612
3665
|
export interface JsonApiAutomationPatchDocument {
|
|
3613
3666
|
'data': JsonApiAutomationPatch;
|
|
3614
3667
|
}
|
|
3668
|
+
export interface JsonApiAutomationPatchRelationships {
|
|
3669
|
+
'notificationChannel'?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
3670
|
+
'analyticalDashboard'?: JsonApiAutomationOutRelationshipsAnalyticalDashboard;
|
|
3671
|
+
'exportDefinitions'?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
3672
|
+
'recipients'?: JsonApiAutomationOutRelationshipsRecipients;
|
|
3673
|
+
}
|
|
3615
3674
|
/**
|
|
3616
3675
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
3617
3676
|
*/
|
|
@@ -3655,14 +3714,17 @@ export type JsonApiAutomationResultOutAttributesStatusEnum = 'SUCCESS' | 'FAILED
|
|
|
3655
3714
|
export interface JsonApiAutomationResultOutList {
|
|
3656
3715
|
'data': Array<JsonApiAutomationResultOutWithLinks>;
|
|
3657
3716
|
'links'?: ListLinks;
|
|
3658
|
-
'meta'?:
|
|
3717
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
3659
3718
|
/**
|
|
3660
3719
|
* Included resources
|
|
3661
3720
|
*/
|
|
3662
3721
|
'included'?: Array<JsonApiAutomationOutWithLinks>;
|
|
3663
3722
|
}
|
|
3664
3723
|
export interface JsonApiAutomationResultOutRelationships {
|
|
3665
|
-
'automation'?:
|
|
3724
|
+
'automation'?: JsonApiAutomationResultOutRelationshipsAutomation;
|
|
3725
|
+
}
|
|
3726
|
+
export interface JsonApiAutomationResultOutRelationshipsAutomation {
|
|
3727
|
+
'data': JsonApiAutomationLinkage | null;
|
|
3666
3728
|
}
|
|
3667
3729
|
export interface JsonApiAutomationResultOutWithLinks {
|
|
3668
3730
|
/**
|
|
@@ -3690,16 +3752,9 @@ export interface JsonApiColorPaletteIn {
|
|
|
3690
3752
|
* API identifier of an object
|
|
3691
3753
|
*/
|
|
3692
3754
|
'id': string;
|
|
3693
|
-
'attributes':
|
|
3755
|
+
'attributes': JsonApiColorPaletteOutAttributes;
|
|
3694
3756
|
}
|
|
3695
3757
|
export type JsonApiColorPaletteInTypeEnum = 'colorPalette';
|
|
3696
|
-
export interface JsonApiColorPaletteInAttributes {
|
|
3697
|
-
'name': string;
|
|
3698
|
-
/**
|
|
3699
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
3700
|
-
*/
|
|
3701
|
-
'content': object;
|
|
3702
|
-
}
|
|
3703
3758
|
export interface JsonApiColorPaletteInDocument {
|
|
3704
3759
|
'data': JsonApiColorPaletteIn;
|
|
3705
3760
|
}
|
|
@@ -3715,9 +3770,16 @@ export interface JsonApiColorPaletteOut {
|
|
|
3715
3770
|
* API identifier of an object
|
|
3716
3771
|
*/
|
|
3717
3772
|
'id': string;
|
|
3718
|
-
'attributes':
|
|
3773
|
+
'attributes': JsonApiColorPaletteOutAttributes;
|
|
3719
3774
|
}
|
|
3720
3775
|
export type JsonApiColorPaletteOutTypeEnum = 'colorPalette';
|
|
3776
|
+
export interface JsonApiColorPaletteOutAttributes {
|
|
3777
|
+
'name': string;
|
|
3778
|
+
/**
|
|
3779
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
3780
|
+
*/
|
|
3781
|
+
'content': object;
|
|
3782
|
+
}
|
|
3721
3783
|
export interface JsonApiColorPaletteOutDocument {
|
|
3722
3784
|
'data': JsonApiColorPaletteOut;
|
|
3723
3785
|
'links'?: ObjectLinks;
|
|
@@ -3728,7 +3790,7 @@ export interface JsonApiColorPaletteOutDocument {
|
|
|
3728
3790
|
export interface JsonApiColorPaletteOutList {
|
|
3729
3791
|
'data': Array<JsonApiColorPaletteOutWithLinks>;
|
|
3730
3792
|
'links'?: ListLinks;
|
|
3731
|
-
'meta'?:
|
|
3793
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
3732
3794
|
}
|
|
3733
3795
|
export interface JsonApiColorPaletteOutWithLinks {
|
|
3734
3796
|
/**
|
|
@@ -3739,7 +3801,7 @@ export interface JsonApiColorPaletteOutWithLinks {
|
|
|
3739
3801
|
* API identifier of an object
|
|
3740
3802
|
*/
|
|
3741
3803
|
'id': string;
|
|
3742
|
-
'attributes':
|
|
3804
|
+
'attributes': JsonApiColorPaletteOutAttributes;
|
|
3743
3805
|
'links'?: ObjectLinks;
|
|
3744
3806
|
}
|
|
3745
3807
|
export type JsonApiColorPaletteOutWithLinksTypeEnum = 'colorPalette';
|
|
@@ -3780,9 +3842,16 @@ export interface JsonApiCookieSecurityConfigurationIn {
|
|
|
3780
3842
|
* API identifier of an object
|
|
3781
3843
|
*/
|
|
3782
3844
|
'id': string;
|
|
3783
|
-
'attributes'?:
|
|
3845
|
+
'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
3784
3846
|
}
|
|
3785
3847
|
export type JsonApiCookieSecurityConfigurationInTypeEnum = 'cookieSecurityConfiguration';
|
|
3848
|
+
export interface JsonApiCookieSecurityConfigurationInAttributes {
|
|
3849
|
+
'lastRotation'?: string;
|
|
3850
|
+
/**
|
|
3851
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
3852
|
+
*/
|
|
3853
|
+
'rotationInterval'?: string;
|
|
3854
|
+
}
|
|
3786
3855
|
export interface JsonApiCookieSecurityConfigurationInDocument {
|
|
3787
3856
|
'data': JsonApiCookieSecurityConfigurationIn;
|
|
3788
3857
|
}
|
|
@@ -3798,7 +3867,7 @@ export interface JsonApiCookieSecurityConfigurationOut {
|
|
|
3798
3867
|
* API identifier of an object
|
|
3799
3868
|
*/
|
|
3800
3869
|
'id': string;
|
|
3801
|
-
'attributes'?:
|
|
3870
|
+
'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
3802
3871
|
}
|
|
3803
3872
|
export type JsonApiCookieSecurityConfigurationOutTypeEnum = 'cookieSecurityConfiguration';
|
|
3804
3873
|
export interface JsonApiCookieSecurityConfigurationOutDocument {
|
|
@@ -3817,16 +3886,9 @@ export interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
3817
3886
|
* API identifier of an object
|
|
3818
3887
|
*/
|
|
3819
3888
|
'id': string;
|
|
3820
|
-
'attributes'?:
|
|
3889
|
+
'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
3821
3890
|
}
|
|
3822
3891
|
export type JsonApiCookieSecurityConfigurationPatchTypeEnum = 'cookieSecurityConfiguration';
|
|
3823
|
-
export interface JsonApiCookieSecurityConfigurationPatchAttributes {
|
|
3824
|
-
'lastRotation'?: string;
|
|
3825
|
-
/**
|
|
3826
|
-
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
3827
|
-
*/
|
|
3828
|
-
'rotationInterval'?: string;
|
|
3829
|
-
}
|
|
3830
3892
|
export interface JsonApiCookieSecurityConfigurationPatchDocument {
|
|
3831
3893
|
'data': JsonApiCookieSecurityConfigurationPatch;
|
|
3832
3894
|
}
|
|
@@ -3842,12 +3904,9 @@ export interface JsonApiCspDirectiveIn {
|
|
|
3842
3904
|
* API identifier of an object
|
|
3843
3905
|
*/
|
|
3844
3906
|
'id': string;
|
|
3845
|
-
'attributes':
|
|
3907
|
+
'attributes': JsonApiCspDirectiveOutAttributes;
|
|
3846
3908
|
}
|
|
3847
3909
|
export type JsonApiCspDirectiveInTypeEnum = 'cspDirective';
|
|
3848
|
-
export interface JsonApiCspDirectiveInAttributes {
|
|
3849
|
-
'sources': Array<string>;
|
|
3850
|
-
}
|
|
3851
3910
|
export interface JsonApiCspDirectiveInDocument {
|
|
3852
3911
|
'data': JsonApiCspDirectiveIn;
|
|
3853
3912
|
}
|
|
@@ -3863,9 +3922,12 @@ export interface JsonApiCspDirectiveOut {
|
|
|
3863
3922
|
* API identifier of an object
|
|
3864
3923
|
*/
|
|
3865
3924
|
'id': string;
|
|
3866
|
-
'attributes':
|
|
3925
|
+
'attributes': JsonApiCspDirectiveOutAttributes;
|
|
3867
3926
|
}
|
|
3868
3927
|
export type JsonApiCspDirectiveOutTypeEnum = 'cspDirective';
|
|
3928
|
+
export interface JsonApiCspDirectiveOutAttributes {
|
|
3929
|
+
'sources': Array<string>;
|
|
3930
|
+
}
|
|
3869
3931
|
export interface JsonApiCspDirectiveOutDocument {
|
|
3870
3932
|
'data': JsonApiCspDirectiveOut;
|
|
3871
3933
|
'links'?: ObjectLinks;
|
|
@@ -3876,7 +3938,7 @@ export interface JsonApiCspDirectiveOutDocument {
|
|
|
3876
3938
|
export interface JsonApiCspDirectiveOutList {
|
|
3877
3939
|
'data': Array<JsonApiCspDirectiveOutWithLinks>;
|
|
3878
3940
|
'links'?: ListLinks;
|
|
3879
|
-
'meta'?:
|
|
3941
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
3880
3942
|
}
|
|
3881
3943
|
export interface JsonApiCspDirectiveOutWithLinks {
|
|
3882
3944
|
/**
|
|
@@ -3887,7 +3949,7 @@ export interface JsonApiCspDirectiveOutWithLinks {
|
|
|
3887
3949
|
* API identifier of an object
|
|
3888
3950
|
*/
|
|
3889
3951
|
'id': string;
|
|
3890
|
-
'attributes':
|
|
3952
|
+
'attributes': JsonApiCspDirectiveOutAttributes;
|
|
3891
3953
|
'links'?: ObjectLinks;
|
|
3892
3954
|
}
|
|
3893
3955
|
export type JsonApiCspDirectiveOutWithLinksTypeEnum = 'cspDirective';
|
|
@@ -3942,14 +4004,14 @@ export interface JsonApiCustomApplicationSettingOut {
|
|
|
3942
4004
|
* API identifier of an object
|
|
3943
4005
|
*/
|
|
3944
4006
|
'id': string;
|
|
3945
|
-
'meta'?:
|
|
4007
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
3946
4008
|
'attributes': JsonApiCustomApplicationSettingOutAttributes;
|
|
3947
4009
|
}
|
|
3948
4010
|
export type JsonApiCustomApplicationSettingOutTypeEnum = 'customApplicationSetting';
|
|
3949
4011
|
export interface JsonApiCustomApplicationSettingOutAttributes {
|
|
3950
4012
|
'applicationName': string;
|
|
3951
4013
|
/**
|
|
3952
|
-
* Free-form JSON content. Maximum supported length is
|
|
4014
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
3953
4015
|
*/
|
|
3954
4016
|
'content': object;
|
|
3955
4017
|
}
|
|
@@ -3963,7 +4025,7 @@ export interface JsonApiCustomApplicationSettingOutDocument {
|
|
|
3963
4025
|
export interface JsonApiCustomApplicationSettingOutList {
|
|
3964
4026
|
'data': Array<JsonApiCustomApplicationSettingOutWithLinks>;
|
|
3965
4027
|
'links'?: ListLinks;
|
|
3966
|
-
'meta'?:
|
|
4028
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
3967
4029
|
}
|
|
3968
4030
|
export interface JsonApiCustomApplicationSettingOutWithLinks {
|
|
3969
4031
|
/**
|
|
@@ -3974,7 +4036,7 @@ export interface JsonApiCustomApplicationSettingOutWithLinks {
|
|
|
3974
4036
|
* API identifier of an object
|
|
3975
4037
|
*/
|
|
3976
4038
|
'id': string;
|
|
3977
|
-
'meta'?:
|
|
4039
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
3978
4040
|
'attributes': JsonApiCustomApplicationSettingOutAttributes;
|
|
3979
4041
|
'links'?: ObjectLinks;
|
|
3980
4042
|
}
|
|
@@ -3997,7 +4059,7 @@ export type JsonApiCustomApplicationSettingPatchTypeEnum = 'customApplicationSet
|
|
|
3997
4059
|
export interface JsonApiCustomApplicationSettingPatchAttributes {
|
|
3998
4060
|
'applicationName'?: string;
|
|
3999
4061
|
/**
|
|
4000
|
-
* Free-form JSON content. Maximum supported length is
|
|
4062
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
4001
4063
|
*/
|
|
4002
4064
|
'content'?: object;
|
|
4003
4065
|
}
|
|
@@ -4034,13 +4096,9 @@ export interface JsonApiCustomGeoCollectionIn {
|
|
|
4034
4096
|
* API identifier of an object
|
|
4035
4097
|
*/
|
|
4036
4098
|
'id': string;
|
|
4037
|
-
'attributes'?:
|
|
4099
|
+
'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
|
|
4038
4100
|
}
|
|
4039
4101
|
export type JsonApiCustomGeoCollectionInTypeEnum = 'customGeoCollection';
|
|
4040
|
-
export interface JsonApiCustomGeoCollectionInAttributes {
|
|
4041
|
-
'name'?: string | null;
|
|
4042
|
-
'description'?: string | null;
|
|
4043
|
-
}
|
|
4044
4102
|
export interface JsonApiCustomGeoCollectionInDocument {
|
|
4045
4103
|
'data': JsonApiCustomGeoCollectionIn;
|
|
4046
4104
|
}
|
|
@@ -4056,7 +4114,7 @@ export interface JsonApiCustomGeoCollectionOut {
|
|
|
4056
4114
|
* API identifier of an object
|
|
4057
4115
|
*/
|
|
4058
4116
|
'id': string;
|
|
4059
|
-
'attributes'?:
|
|
4117
|
+
'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
|
|
4060
4118
|
}
|
|
4061
4119
|
export type JsonApiCustomGeoCollectionOutTypeEnum = 'customGeoCollection';
|
|
4062
4120
|
export interface JsonApiCustomGeoCollectionOutDocument {
|
|
@@ -4069,7 +4127,7 @@ export interface JsonApiCustomGeoCollectionOutDocument {
|
|
|
4069
4127
|
export interface JsonApiCustomGeoCollectionOutList {
|
|
4070
4128
|
'data': Array<JsonApiCustomGeoCollectionOutWithLinks>;
|
|
4071
4129
|
'links'?: ListLinks;
|
|
4072
|
-
'meta'?:
|
|
4130
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
4073
4131
|
}
|
|
4074
4132
|
export interface JsonApiCustomGeoCollectionOutWithLinks {
|
|
4075
4133
|
/**
|
|
@@ -4080,7 +4138,7 @@ export interface JsonApiCustomGeoCollectionOutWithLinks {
|
|
|
4080
4138
|
* API identifier of an object
|
|
4081
4139
|
*/
|
|
4082
4140
|
'id': string;
|
|
4083
|
-
'attributes'?:
|
|
4141
|
+
'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
|
|
4084
4142
|
'links'?: ObjectLinks;
|
|
4085
4143
|
}
|
|
4086
4144
|
export type JsonApiCustomGeoCollectionOutWithLinksTypeEnum = 'customGeoCollection';
|
|
@@ -4096,9 +4154,13 @@ export interface JsonApiCustomGeoCollectionPatch {
|
|
|
4096
4154
|
* API identifier of an object
|
|
4097
4155
|
*/
|
|
4098
4156
|
'id': string;
|
|
4099
|
-
'attributes'?:
|
|
4157
|
+
'attributes'?: JsonApiCustomGeoCollectionPatchAttributes;
|
|
4100
4158
|
}
|
|
4101
4159
|
export type JsonApiCustomGeoCollectionPatchTypeEnum = 'customGeoCollection';
|
|
4160
|
+
export interface JsonApiCustomGeoCollectionPatchAttributes {
|
|
4161
|
+
'name'?: string | null;
|
|
4162
|
+
'description'?: string | null;
|
|
4163
|
+
}
|
|
4102
4164
|
export interface JsonApiCustomGeoCollectionPatchDocument {
|
|
4103
4165
|
'data': JsonApiCustomGeoCollectionPatch;
|
|
4104
4166
|
}
|
|
@@ -4114,7 +4176,7 @@ export interface JsonApiDashboardPluginIn {
|
|
|
4114
4176
|
* API identifier of an object
|
|
4115
4177
|
*/
|
|
4116
4178
|
'id': string;
|
|
4117
|
-
'attributes'?:
|
|
4179
|
+
'attributes'?: JsonApiDashboardPluginPatchAttributes;
|
|
4118
4180
|
}
|
|
4119
4181
|
export type JsonApiDashboardPluginInTypeEnum = 'dashboardPlugin';
|
|
4120
4182
|
export interface JsonApiDashboardPluginInDocument {
|
|
@@ -4140,7 +4202,7 @@ export interface JsonApiDashboardPluginOut {
|
|
|
4140
4202
|
* API identifier of an object
|
|
4141
4203
|
*/
|
|
4142
4204
|
'id': string;
|
|
4143
|
-
'meta'?:
|
|
4205
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
4144
4206
|
'attributes'?: JsonApiDashboardPluginOutAttributes;
|
|
4145
4207
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
4146
4208
|
}
|
|
@@ -4177,15 +4239,15 @@ export interface JsonApiDashboardPluginOutDocument {
|
|
|
4177
4239
|
export interface JsonApiDashboardPluginOutList {
|
|
4178
4240
|
'data': Array<JsonApiDashboardPluginOutWithLinks>;
|
|
4179
4241
|
'links'?: ListLinks;
|
|
4180
|
-
'meta'?:
|
|
4242
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
4181
4243
|
/**
|
|
4182
4244
|
* Included resources
|
|
4183
4245
|
*/
|
|
4184
4246
|
'included'?: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
4185
4247
|
}
|
|
4186
4248
|
export interface JsonApiDashboardPluginOutRelationships {
|
|
4187
|
-
'createdBy'?:
|
|
4188
|
-
'modifiedBy'?:
|
|
4249
|
+
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
4250
|
+
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
4189
4251
|
}
|
|
4190
4252
|
export interface JsonApiDashboardPluginOutWithLinks {
|
|
4191
4253
|
/**
|
|
@@ -4196,7 +4258,7 @@ export interface JsonApiDashboardPluginOutWithLinks {
|
|
|
4196
4258
|
* API identifier of an object
|
|
4197
4259
|
*/
|
|
4198
4260
|
'id': string;
|
|
4199
|
-
'meta'?:
|
|
4261
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
4200
4262
|
'attributes'?: JsonApiDashboardPluginOutAttributes;
|
|
4201
4263
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
4202
4264
|
'links'?: ObjectLinks;
|
|
@@ -4214,9 +4276,19 @@ export interface JsonApiDashboardPluginPatch {
|
|
|
4214
4276
|
* API identifier of an object
|
|
4215
4277
|
*/
|
|
4216
4278
|
'id': string;
|
|
4217
|
-
'attributes'?:
|
|
4279
|
+
'attributes'?: JsonApiDashboardPluginPatchAttributes;
|
|
4218
4280
|
}
|
|
4219
4281
|
export type JsonApiDashboardPluginPatchTypeEnum = 'dashboardPlugin';
|
|
4282
|
+
export interface JsonApiDashboardPluginPatchAttributes {
|
|
4283
|
+
'title'?: string;
|
|
4284
|
+
'description'?: string;
|
|
4285
|
+
'tags'?: Array<string>;
|
|
4286
|
+
'areRelationsValid'?: boolean;
|
|
4287
|
+
/**
|
|
4288
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
4289
|
+
*/
|
|
4290
|
+
'content'?: object;
|
|
4291
|
+
}
|
|
4220
4292
|
export interface JsonApiDashboardPluginPatchDocument {
|
|
4221
4293
|
'data': JsonApiDashboardPluginPatch;
|
|
4222
4294
|
}
|
|
@@ -4232,19 +4304,9 @@ export interface JsonApiDashboardPluginPostOptionalId {
|
|
|
4232
4304
|
* API identifier of an object
|
|
4233
4305
|
*/
|
|
4234
4306
|
'id'?: string;
|
|
4235
|
-
'attributes'?:
|
|
4307
|
+
'attributes'?: JsonApiDashboardPluginPatchAttributes;
|
|
4236
4308
|
}
|
|
4237
4309
|
export type JsonApiDashboardPluginPostOptionalIdTypeEnum = 'dashboardPlugin';
|
|
4238
|
-
export interface JsonApiDashboardPluginPostOptionalIdAttributes {
|
|
4239
|
-
'title'?: string;
|
|
4240
|
-
'description'?: string;
|
|
4241
|
-
'tags'?: Array<string>;
|
|
4242
|
-
'areRelationsValid'?: boolean;
|
|
4243
|
-
/**
|
|
4244
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
4245
|
-
*/
|
|
4246
|
-
'content'?: object;
|
|
4247
|
-
}
|
|
4248
4310
|
export interface JsonApiDashboardPluginPostOptionalIdDocument {
|
|
4249
4311
|
'data': JsonApiDashboardPluginPostOptionalId;
|
|
4250
4312
|
}
|
|
@@ -4280,7 +4342,7 @@ export interface JsonApiDataSourceIdentifierOutDocument {
|
|
|
4280
4342
|
export interface JsonApiDataSourceIdentifierOutList {
|
|
4281
4343
|
'data': Array<JsonApiDataSourceIdentifierOutWithLinks>;
|
|
4282
4344
|
'links'?: ListLinks;
|
|
4283
|
-
'meta'?:
|
|
4345
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
4284
4346
|
}
|
|
4285
4347
|
export interface JsonApiDataSourceIdentifierOutWithLinks {
|
|
4286
4348
|
/**
|
|
@@ -4359,7 +4421,7 @@ export interface JsonApiDataSourceInAttributes {
|
|
|
4359
4421
|
/**
|
|
4360
4422
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
4361
4423
|
*/
|
|
4362
|
-
'parameters'?: Array<
|
|
4424
|
+
'parameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
|
|
4363
4425
|
/**
|
|
4364
4426
|
* Determines how the results coming from a particular datasource should be cached.
|
|
4365
4427
|
*/
|
|
@@ -4371,10 +4433,6 @@ export interface JsonApiDataSourceInAttributes {
|
|
|
4371
4433
|
}
|
|
4372
4434
|
export type JsonApiDataSourceInAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'DRILL' | 'GREENPLUM' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE';
|
|
4373
4435
|
export type JsonApiDataSourceInAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
4374
|
-
export interface JsonApiDataSourceInAttributesParametersInner {
|
|
4375
|
-
'name': string;
|
|
4376
|
-
'value': string;
|
|
4377
|
-
}
|
|
4378
4436
|
export interface JsonApiDataSourceInDocument {
|
|
4379
4437
|
'data': JsonApiDataSourceIn;
|
|
4380
4438
|
}
|
|
@@ -4422,11 +4480,11 @@ export interface JsonApiDataSourceOutAttributes {
|
|
|
4422
4480
|
/**
|
|
4423
4481
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
4424
4482
|
*/
|
|
4425
|
-
'parameters'?: Array<
|
|
4483
|
+
'parameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
|
|
4426
4484
|
/**
|
|
4427
4485
|
* Decoded parameters to be used when connecting to the database providing the data for the data source.
|
|
4428
4486
|
*/
|
|
4429
|
-
'decodedParameters'?: Array<
|
|
4487
|
+
'decodedParameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
|
|
4430
4488
|
/**
|
|
4431
4489
|
* Determines how the results coming from a particular datasource should be cached.
|
|
4432
4490
|
*/
|
|
@@ -4453,7 +4511,7 @@ export interface JsonApiDataSourceOutDocument {
|
|
|
4453
4511
|
export interface JsonApiDataSourceOutList {
|
|
4454
4512
|
'data': Array<JsonApiDataSourceOutWithLinks>;
|
|
4455
4513
|
'links'?: ListLinks;
|
|
4456
|
-
'meta'?:
|
|
4514
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
4457
4515
|
}
|
|
4458
4516
|
export interface JsonApiDataSourceOutMeta {
|
|
4459
4517
|
/**
|
|
@@ -4539,7 +4597,7 @@ export interface JsonApiDataSourcePatchAttributes {
|
|
|
4539
4597
|
/**
|
|
4540
4598
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
4541
4599
|
*/
|
|
4542
|
-
'parameters'?: Array<
|
|
4600
|
+
'parameters'?: Array<JsonApiDataSourcePatchAttributesParametersInner> | null;
|
|
4543
4601
|
/**
|
|
4544
4602
|
* Determines how the results coming from a particular datasource should be cached.
|
|
4545
4603
|
*/
|
|
@@ -4551,6 +4609,10 @@ export interface JsonApiDataSourcePatchAttributes {
|
|
|
4551
4609
|
}
|
|
4552
4610
|
export type JsonApiDataSourcePatchAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'DRILL' | 'GREENPLUM' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE';
|
|
4553
4611
|
export type JsonApiDataSourcePatchAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
4612
|
+
export interface JsonApiDataSourcePatchAttributesParametersInner {
|
|
4613
|
+
'name': string;
|
|
4614
|
+
'value': string;
|
|
4615
|
+
}
|
|
4554
4616
|
export interface JsonApiDataSourcePatchDocument {
|
|
4555
4617
|
'data': JsonApiDataSourcePatch;
|
|
4556
4618
|
}
|
|
@@ -4574,7 +4636,7 @@ export interface JsonApiDatasetOut {
|
|
|
4574
4636
|
* API identifier of an object
|
|
4575
4637
|
*/
|
|
4576
4638
|
'id': string;
|
|
4577
|
-
'meta'?:
|
|
4639
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
4578
4640
|
'attributes': JsonApiDatasetOutAttributes;
|
|
4579
4641
|
'relationships'?: JsonApiDatasetOutRelationships;
|
|
4580
4642
|
}
|
|
@@ -4647,17 +4709,31 @@ export type JsonApiDatasetOutIncludes = JsonApiAggregatedFactOutWithLinks | Json
|
|
|
4647
4709
|
export interface JsonApiDatasetOutList {
|
|
4648
4710
|
'data': Array<JsonApiDatasetOutWithLinks>;
|
|
4649
4711
|
'links'?: ListLinks;
|
|
4650
|
-
'meta'?:
|
|
4712
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
4651
4713
|
/**
|
|
4652
4714
|
* Included resources
|
|
4653
4715
|
*/
|
|
4654
4716
|
'included'?: Array<JsonApiDatasetOutIncludes>;
|
|
4655
4717
|
}
|
|
4718
|
+
export interface JsonApiDatasetOutMeta {
|
|
4719
|
+
'origin'?: JsonApiDatasetOutMetaOrigin;
|
|
4720
|
+
}
|
|
4721
|
+
export interface JsonApiDatasetOutMetaOrigin {
|
|
4722
|
+
/**
|
|
4723
|
+
* defines type of the origin of the entity
|
|
4724
|
+
*/
|
|
4725
|
+
'originType': JsonApiDatasetOutMetaOriginOriginTypeEnum;
|
|
4726
|
+
/**
|
|
4727
|
+
* defines id of the workspace where the entity comes from
|
|
4728
|
+
*/
|
|
4729
|
+
'originId': string;
|
|
4730
|
+
}
|
|
4731
|
+
export type JsonApiDatasetOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
4656
4732
|
export interface JsonApiDatasetOutRelationships {
|
|
4657
4733
|
'attributes'?: JsonApiDatasetOutRelationshipsAttributes;
|
|
4658
4734
|
'facts'?: JsonApiDatasetOutRelationshipsFacts;
|
|
4659
4735
|
'aggregatedFacts'?: JsonApiDatasetOutRelationshipsAggregatedFacts;
|
|
4660
|
-
'references'?:
|
|
4736
|
+
'references'?: JsonApiDatasetOutRelationshipsReferences;
|
|
4661
4737
|
'workspaceDataFilters'?: JsonApiDatasetOutRelationshipsWorkspaceDataFilters;
|
|
4662
4738
|
}
|
|
4663
4739
|
export interface JsonApiDatasetOutRelationshipsAggregatedFacts {
|
|
@@ -4678,6 +4754,12 @@ export interface JsonApiDatasetOutRelationshipsFacts {
|
|
|
4678
4754
|
*/
|
|
4679
4755
|
'data': Array<JsonApiFactLinkage>;
|
|
4680
4756
|
}
|
|
4757
|
+
export interface JsonApiDatasetOutRelationshipsReferences {
|
|
4758
|
+
/**
|
|
4759
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
4760
|
+
*/
|
|
4761
|
+
'data': Array<JsonApiDatasetLinkage>;
|
|
4762
|
+
}
|
|
4681
4763
|
export interface JsonApiDatasetOutRelationshipsWorkspaceDataFilters {
|
|
4682
4764
|
/**
|
|
4683
4765
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -4693,7 +4775,7 @@ export interface JsonApiDatasetOutWithLinks {
|
|
|
4693
4775
|
* API identifier of an object
|
|
4694
4776
|
*/
|
|
4695
4777
|
'id': string;
|
|
4696
|
-
'meta'?:
|
|
4778
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
4697
4779
|
'attributes': JsonApiDatasetOutAttributes;
|
|
4698
4780
|
'relationships'?: JsonApiDatasetOutRelationships;
|
|
4699
4781
|
'links'?: ObjectLinks;
|
|
@@ -4746,7 +4828,7 @@ export interface JsonApiEntitlementOutDocument {
|
|
|
4746
4828
|
export interface JsonApiEntitlementOutList {
|
|
4747
4829
|
'data': Array<JsonApiEntitlementOutWithLinks>;
|
|
4748
4830
|
'links'?: ListLinks;
|
|
4749
|
-
'meta'?:
|
|
4831
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
4750
4832
|
}
|
|
4751
4833
|
export interface JsonApiEntitlementOutWithLinks {
|
|
4752
4834
|
/**
|
|
@@ -4773,8 +4855,8 @@ export interface JsonApiExportDefinitionIn {
|
|
|
4773
4855
|
* API identifier of an object
|
|
4774
4856
|
*/
|
|
4775
4857
|
'id': string;
|
|
4776
|
-
'attributes'?:
|
|
4777
|
-
'relationships'?:
|
|
4858
|
+
'attributes'?: JsonApiExportDefinitionPatchAttributes;
|
|
4859
|
+
'relationships'?: JsonApiExportDefinitionPatchRelationships;
|
|
4778
4860
|
}
|
|
4779
4861
|
export type JsonApiExportDefinitionInTypeEnum = 'exportDefinition';
|
|
4780
4862
|
export interface JsonApiExportDefinitionInDocument {
|
|
@@ -4800,7 +4882,7 @@ export interface JsonApiExportDefinitionOut {
|
|
|
4800
4882
|
* API identifier of an object
|
|
4801
4883
|
*/
|
|
4802
4884
|
'id': string;
|
|
4803
|
-
'meta'?:
|
|
4885
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
4804
4886
|
'attributes'?: JsonApiExportDefinitionOutAttributes;
|
|
4805
4887
|
'relationships'?: JsonApiExportDefinitionOutRelationships;
|
|
4806
4888
|
}
|
|
@@ -4843,27 +4925,18 @@ export type JsonApiExportDefinitionOutIncludes = JsonApiAnalyticalDashboardOutWi
|
|
|
4843
4925
|
export interface JsonApiExportDefinitionOutList {
|
|
4844
4926
|
'data': Array<JsonApiExportDefinitionOutWithLinks>;
|
|
4845
4927
|
'links'?: ListLinks;
|
|
4846
|
-
'meta'?:
|
|
4928
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
4847
4929
|
/**
|
|
4848
4930
|
* Included resources
|
|
4849
4931
|
*/
|
|
4850
4932
|
'included'?: Array<JsonApiExportDefinitionOutIncludes>;
|
|
4851
4933
|
}
|
|
4852
|
-
export interface JsonApiExportDefinitionOutMeta {
|
|
4853
|
-
'origin'?: JsonApiAnalyticalDashboardOutMetaOrigin;
|
|
4854
|
-
}
|
|
4855
4934
|
export interface JsonApiExportDefinitionOutRelationships {
|
|
4856
4935
|
'visualizationObject'?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
4857
|
-
'analyticalDashboard'?:
|
|
4858
|
-
'automation'?:
|
|
4859
|
-
'createdBy'?:
|
|
4860
|
-
'modifiedBy'?:
|
|
4861
|
-
}
|
|
4862
|
-
export interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard {
|
|
4863
|
-
'data': JsonApiAnalyticalDashboardLinkage | null;
|
|
4864
|
-
}
|
|
4865
|
-
export interface JsonApiExportDefinitionOutRelationshipsAutomation {
|
|
4866
|
-
'data': JsonApiAutomationLinkage | null;
|
|
4936
|
+
'analyticalDashboard'?: JsonApiAutomationOutRelationshipsAnalyticalDashboard;
|
|
4937
|
+
'automation'?: JsonApiAutomationResultOutRelationshipsAutomation;
|
|
4938
|
+
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
4939
|
+
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
4867
4940
|
}
|
|
4868
4941
|
export interface JsonApiExportDefinitionOutRelationshipsVisualizationObject {
|
|
4869
4942
|
'data': JsonApiVisualizationObjectLinkage | null;
|
|
@@ -4877,7 +4950,7 @@ export interface JsonApiExportDefinitionOutWithLinks {
|
|
|
4877
4950
|
* API identifier of an object
|
|
4878
4951
|
*/
|
|
4879
4952
|
'id': string;
|
|
4880
|
-
'meta'?:
|
|
4953
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
4881
4954
|
'attributes'?: JsonApiExportDefinitionOutAttributes;
|
|
4882
4955
|
'relationships'?: JsonApiExportDefinitionOutRelationships;
|
|
4883
4956
|
'links'?: ObjectLinks;
|
|
@@ -4895,13 +4968,24 @@ export interface JsonApiExportDefinitionPatch {
|
|
|
4895
4968
|
* API identifier of an object
|
|
4896
4969
|
*/
|
|
4897
4970
|
'id': string;
|
|
4898
|
-
'attributes'?:
|
|
4899
|
-
'relationships'?:
|
|
4971
|
+
'attributes'?: JsonApiExportDefinitionPatchAttributes;
|
|
4972
|
+
'relationships'?: JsonApiExportDefinitionPatchRelationships;
|
|
4900
4973
|
}
|
|
4901
4974
|
export type JsonApiExportDefinitionPatchTypeEnum = 'exportDefinition';
|
|
4975
|
+
export interface JsonApiExportDefinitionPatchAttributes {
|
|
4976
|
+
'title'?: string;
|
|
4977
|
+
'description'?: string;
|
|
4978
|
+
'tags'?: Array<string>;
|
|
4979
|
+
'requestPayload'?: JsonApiExportDefinitionOutAttributesRequestPayload;
|
|
4980
|
+
'areRelationsValid'?: boolean;
|
|
4981
|
+
}
|
|
4902
4982
|
export interface JsonApiExportDefinitionPatchDocument {
|
|
4903
4983
|
'data': JsonApiExportDefinitionPatch;
|
|
4904
4984
|
}
|
|
4985
|
+
export interface JsonApiExportDefinitionPatchRelationships {
|
|
4986
|
+
'visualizationObject'?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
4987
|
+
'analyticalDashboard'?: JsonApiAutomationOutRelationshipsAnalyticalDashboard;
|
|
4988
|
+
}
|
|
4905
4989
|
/**
|
|
4906
4990
|
* JSON:API representation of exportDefinition entity.
|
|
4907
4991
|
*/
|
|
@@ -4914,24 +4998,13 @@ export interface JsonApiExportDefinitionPostOptionalId {
|
|
|
4914
4998
|
* API identifier of an object
|
|
4915
4999
|
*/
|
|
4916
5000
|
'id'?: string;
|
|
4917
|
-
'attributes'?:
|
|
4918
|
-
'relationships'?:
|
|
5001
|
+
'attributes'?: JsonApiExportDefinitionPatchAttributes;
|
|
5002
|
+
'relationships'?: JsonApiExportDefinitionPatchRelationships;
|
|
4919
5003
|
}
|
|
4920
5004
|
export type JsonApiExportDefinitionPostOptionalIdTypeEnum = 'exportDefinition';
|
|
4921
|
-
export interface JsonApiExportDefinitionPostOptionalIdAttributes {
|
|
4922
|
-
'title'?: string;
|
|
4923
|
-
'description'?: string;
|
|
4924
|
-
'tags'?: Array<string>;
|
|
4925
|
-
'requestPayload'?: JsonApiExportDefinitionOutAttributesRequestPayload;
|
|
4926
|
-
'areRelationsValid'?: boolean;
|
|
4927
|
-
}
|
|
4928
5005
|
export interface JsonApiExportDefinitionPostOptionalIdDocument {
|
|
4929
5006
|
'data': JsonApiExportDefinitionPostOptionalId;
|
|
4930
5007
|
}
|
|
4931
|
-
export interface JsonApiExportDefinitionPostOptionalIdRelationships {
|
|
4932
|
-
'visualizationObject'?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
4933
|
-
'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
4934
|
-
}
|
|
4935
5008
|
/**
|
|
4936
5009
|
* JSON:API representation of exportTemplate entity.
|
|
4937
5010
|
*/
|
|
@@ -4944,7 +5017,7 @@ export interface JsonApiExportTemplateIn {
|
|
|
4944
5017
|
* API identifier of an object
|
|
4945
5018
|
*/
|
|
4946
5019
|
'id': string;
|
|
4947
|
-
'attributes':
|
|
5020
|
+
'attributes': JsonApiExportTemplateOutAttributes;
|
|
4948
5021
|
}
|
|
4949
5022
|
export type JsonApiExportTemplateInTypeEnum = 'exportTemplate';
|
|
4950
5023
|
export interface JsonApiExportTemplateInDocument {
|
|
@@ -4962,20 +5035,28 @@ export interface JsonApiExportTemplateOut {
|
|
|
4962
5035
|
* API identifier of an object
|
|
4963
5036
|
*/
|
|
4964
5037
|
'id': string;
|
|
4965
|
-
'attributes':
|
|
5038
|
+
'attributes': JsonApiExportTemplateOutAttributes;
|
|
4966
5039
|
}
|
|
4967
5040
|
export type JsonApiExportTemplateOutTypeEnum = 'exportTemplate';
|
|
4968
|
-
export interface
|
|
4969
|
-
|
|
4970
|
-
|
|
4971
|
-
|
|
5041
|
+
export interface JsonApiExportTemplateOutAttributes {
|
|
5042
|
+
/**
|
|
5043
|
+
* User-facing name of the Slides template.
|
|
5044
|
+
*/
|
|
5045
|
+
'name': string;
|
|
5046
|
+
'dashboardSlidesTemplate'?: JsonApiExportTemplatePatchAttributesDashboardSlidesTemplate | null;
|
|
5047
|
+
'widgetSlidesTemplate'?: JsonApiExportTemplatePatchAttributesWidgetSlidesTemplate | null;
|
|
5048
|
+
}
|
|
5049
|
+
export interface JsonApiExportTemplateOutDocument {
|
|
5050
|
+
'data': JsonApiExportTemplateOut;
|
|
5051
|
+
'links'?: ObjectLinks;
|
|
5052
|
+
}
|
|
4972
5053
|
/**
|
|
4973
5054
|
* A JSON:API document with a list of resources
|
|
4974
5055
|
*/
|
|
4975
5056
|
export interface JsonApiExportTemplateOutList {
|
|
4976
5057
|
'data': Array<JsonApiExportTemplateOutWithLinks>;
|
|
4977
5058
|
'links'?: ListLinks;
|
|
4978
|
-
'meta'?:
|
|
5059
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
4979
5060
|
}
|
|
4980
5061
|
export interface JsonApiExportTemplateOutWithLinks {
|
|
4981
5062
|
/**
|
|
@@ -4986,7 +5067,7 @@ export interface JsonApiExportTemplateOutWithLinks {
|
|
|
4986
5067
|
* API identifier of an object
|
|
4987
5068
|
*/
|
|
4988
5069
|
'id': string;
|
|
4989
|
-
'attributes':
|
|
5070
|
+
'attributes': JsonApiExportTemplateOutAttributes;
|
|
4990
5071
|
'links'?: ObjectLinks;
|
|
4991
5072
|
}
|
|
4992
5073
|
export type JsonApiExportTemplateOutWithLinksTypeEnum = 'exportTemplate';
|
|
@@ -5010,60 +5091,52 @@ export interface JsonApiExportTemplatePatchAttributes {
|
|
|
5010
5091
|
* User-facing name of the Slides template.
|
|
5011
5092
|
*/
|
|
5012
5093
|
'name'?: string;
|
|
5013
|
-
'dashboardSlidesTemplate'?:
|
|
5014
|
-
'widgetSlidesTemplate'?:
|
|
5015
|
-
}
|
|
5016
|
-
export interface JsonApiExportTemplatePatchDocument {
|
|
5017
|
-
'data': JsonApiExportTemplatePatch;
|
|
5018
|
-
}
|
|
5019
|
-
/**
|
|
5020
|
-
* JSON:API representation of exportTemplate entity.
|
|
5021
|
-
*/
|
|
5022
|
-
export interface JsonApiExportTemplatePostOptionalId {
|
|
5023
|
-
/**
|
|
5024
|
-
* Object type
|
|
5025
|
-
*/
|
|
5026
|
-
'type': JsonApiExportTemplatePostOptionalIdTypeEnum;
|
|
5027
|
-
/**
|
|
5028
|
-
* API identifier of an object
|
|
5029
|
-
*/
|
|
5030
|
-
'id'?: string;
|
|
5031
|
-
'attributes': JsonApiExportTemplatePostOptionalIdAttributes;
|
|
5032
|
-
}
|
|
5033
|
-
export type JsonApiExportTemplatePostOptionalIdTypeEnum = 'exportTemplate';
|
|
5034
|
-
export interface JsonApiExportTemplatePostOptionalIdAttributes {
|
|
5035
|
-
/**
|
|
5036
|
-
* User-facing name of the Slides template.
|
|
5037
|
-
*/
|
|
5038
|
-
'name': string;
|
|
5039
|
-
'dashboardSlidesTemplate'?: JsonApiExportTemplatePostOptionalIdAttributesDashboardSlidesTemplate | null;
|
|
5040
|
-
'widgetSlidesTemplate'?: JsonApiExportTemplatePostOptionalIdAttributesWidgetSlidesTemplate | null;
|
|
5094
|
+
'dashboardSlidesTemplate'?: JsonApiExportTemplatePatchAttributesDashboardSlidesTemplate | null;
|
|
5095
|
+
'widgetSlidesTemplate'?: JsonApiExportTemplatePatchAttributesWidgetSlidesTemplate | null;
|
|
5041
5096
|
}
|
|
5042
5097
|
/**
|
|
5043
5098
|
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5044
5099
|
*/
|
|
5045
|
-
export interface
|
|
5100
|
+
export interface JsonApiExportTemplatePatchAttributesDashboardSlidesTemplate {
|
|
5046
5101
|
/**
|
|
5047
5102
|
* Export types this template applies to.
|
|
5048
5103
|
*/
|
|
5049
|
-
'appliedOn': Array<
|
|
5104
|
+
'appliedOn': Array<JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
5050
5105
|
'coverSlide'?: CoverSlideTemplate | null;
|
|
5051
5106
|
'introSlide'?: IntroSlideTemplate | null;
|
|
5052
5107
|
'sectionSlide'?: SectionSlideTemplate | null;
|
|
5053
5108
|
'contentSlide'?: ContentSlideTemplate | null;
|
|
5054
5109
|
}
|
|
5055
|
-
export type
|
|
5110
|
+
export type JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
5056
5111
|
/**
|
|
5057
5112
|
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5058
5113
|
*/
|
|
5059
|
-
export interface
|
|
5114
|
+
export interface JsonApiExportTemplatePatchAttributesWidgetSlidesTemplate {
|
|
5060
5115
|
/**
|
|
5061
5116
|
* Export types this template applies to.
|
|
5062
5117
|
*/
|
|
5063
|
-
'appliedOn': Array<
|
|
5118
|
+
'appliedOn': Array<JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
5064
5119
|
'contentSlide'?: ContentSlideTemplate | null;
|
|
5065
5120
|
}
|
|
5066
|
-
export type
|
|
5121
|
+
export type JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
5122
|
+
export interface JsonApiExportTemplatePatchDocument {
|
|
5123
|
+
'data': JsonApiExportTemplatePatch;
|
|
5124
|
+
}
|
|
5125
|
+
/**
|
|
5126
|
+
* JSON:API representation of exportTemplate entity.
|
|
5127
|
+
*/
|
|
5128
|
+
export interface JsonApiExportTemplatePostOptionalId {
|
|
5129
|
+
/**
|
|
5130
|
+
* Object type
|
|
5131
|
+
*/
|
|
5132
|
+
'type': JsonApiExportTemplatePostOptionalIdTypeEnum;
|
|
5133
|
+
/**
|
|
5134
|
+
* API identifier of an object
|
|
5135
|
+
*/
|
|
5136
|
+
'id'?: string;
|
|
5137
|
+
'attributes': JsonApiExportTemplateOutAttributes;
|
|
5138
|
+
}
|
|
5139
|
+
export type JsonApiExportTemplatePostOptionalIdTypeEnum = 'exportTemplate';
|
|
5067
5140
|
export interface JsonApiExportTemplatePostOptionalIdDocument {
|
|
5068
5141
|
'data': JsonApiExportTemplatePostOptionalId;
|
|
5069
5142
|
}
|
|
@@ -5087,7 +5160,7 @@ export interface JsonApiFactOut {
|
|
|
5087
5160
|
* API identifier of an object
|
|
5088
5161
|
*/
|
|
5089
5162
|
'id': string;
|
|
5090
|
-
'meta'?:
|
|
5163
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
5091
5164
|
'attributes'?: JsonApiFactOutAttributes;
|
|
5092
5165
|
'relationships'?: JsonApiFactOutRelationships;
|
|
5093
5166
|
}
|
|
@@ -5118,7 +5191,7 @@ export interface JsonApiFactOutDocument {
|
|
|
5118
5191
|
export interface JsonApiFactOutList {
|
|
5119
5192
|
'data': Array<JsonApiFactOutWithLinks>;
|
|
5120
5193
|
'links'?: ListLinks;
|
|
5121
|
-
'meta'?:
|
|
5194
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
5122
5195
|
/**
|
|
5123
5196
|
* Included resources
|
|
5124
5197
|
*/
|
|
@@ -5139,7 +5212,7 @@ export interface JsonApiFactOutWithLinks {
|
|
|
5139
5212
|
* API identifier of an object
|
|
5140
5213
|
*/
|
|
5141
5214
|
'id': string;
|
|
5142
|
-
'meta'?:
|
|
5215
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
5143
5216
|
'attributes'?: JsonApiFactOutAttributes;
|
|
5144
5217
|
'relationships'?: JsonApiFactOutRelationships;
|
|
5145
5218
|
'links'?: ObjectLinks;
|
|
@@ -5201,7 +5274,7 @@ export interface JsonApiFilterContextOut {
|
|
|
5201
5274
|
* API identifier of an object
|
|
5202
5275
|
*/
|
|
5203
5276
|
'id': string;
|
|
5204
|
-
'meta'?:
|
|
5277
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
5205
5278
|
'attributes': JsonApiFilterContextOutAttributes;
|
|
5206
5279
|
'relationships'?: JsonApiFilterContextOutRelationships;
|
|
5207
5280
|
}
|
|
@@ -5234,7 +5307,7 @@ export type JsonApiFilterContextOutIncludes = JsonApiAttributeOutWithLinks | Jso
|
|
|
5234
5307
|
export interface JsonApiFilterContextOutList {
|
|
5235
5308
|
'data': Array<JsonApiFilterContextOutWithLinks>;
|
|
5236
5309
|
'links'?: ListLinks;
|
|
5237
|
-
'meta'?:
|
|
5310
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
5238
5311
|
/**
|
|
5239
5312
|
* Included resources
|
|
5240
5313
|
*/
|
|
@@ -5242,8 +5315,8 @@ export interface JsonApiFilterContextOutList {
|
|
|
5242
5315
|
}
|
|
5243
5316
|
export interface JsonApiFilterContextOutRelationships {
|
|
5244
5317
|
'attributes'?: JsonApiDatasetOutRelationshipsAttributes;
|
|
5245
|
-
'datasets'?:
|
|
5246
|
-
'labels'?:
|
|
5318
|
+
'datasets'?: JsonApiDatasetOutRelationshipsReferences;
|
|
5319
|
+
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
5247
5320
|
}
|
|
5248
5321
|
export interface JsonApiFilterContextOutWithLinks {
|
|
5249
5322
|
/**
|
|
@@ -5254,7 +5327,7 @@ export interface JsonApiFilterContextOutWithLinks {
|
|
|
5254
5327
|
* API identifier of an object
|
|
5255
5328
|
*/
|
|
5256
5329
|
'id': string;
|
|
5257
|
-
'meta'?:
|
|
5330
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
5258
5331
|
'attributes': JsonApiFilterContextOutAttributes;
|
|
5259
5332
|
'relationships'?: JsonApiFilterContextOutRelationships;
|
|
5260
5333
|
'links'?: ObjectLinks;
|
|
@@ -5373,14 +5446,14 @@ export type JsonApiFilterViewOutIncludes = JsonApiAnalyticalDashboardOutWithLink
|
|
|
5373
5446
|
export interface JsonApiFilterViewOutList {
|
|
5374
5447
|
'data': Array<JsonApiFilterViewOutWithLinks>;
|
|
5375
5448
|
'links'?: ListLinks;
|
|
5376
|
-
'meta'?:
|
|
5449
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
5377
5450
|
/**
|
|
5378
5451
|
* Included resources
|
|
5379
5452
|
*/
|
|
5380
5453
|
'included'?: Array<JsonApiFilterViewOutIncludes>;
|
|
5381
5454
|
}
|
|
5382
5455
|
export interface JsonApiFilterViewOutRelationships {
|
|
5383
|
-
'analyticalDashboard'?:
|
|
5456
|
+
'analyticalDashboard'?: JsonApiAutomationOutRelationshipsAnalyticalDashboard;
|
|
5384
5457
|
'user'?: JsonApiFilterViewOutRelationshipsUser;
|
|
5385
5458
|
}
|
|
5386
5459
|
export interface JsonApiFilterViewOutRelationshipsUser {
|
|
@@ -5445,60 +5518,9 @@ export interface JsonApiIdentityProviderIn {
|
|
|
5445
5518
|
* API identifier of an object
|
|
5446
5519
|
*/
|
|
5447
5520
|
'id': string;
|
|
5448
|
-
'attributes'?:
|
|
5521
|
+
'attributes'?: JsonApiIdentityProviderPatchAttributes;
|
|
5449
5522
|
}
|
|
5450
5523
|
export type JsonApiIdentityProviderInTypeEnum = 'identityProvider';
|
|
5451
|
-
export interface JsonApiIdentityProviderInAttributes {
|
|
5452
|
-
/**
|
|
5453
|
-
* 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.
|
|
5454
|
-
*/
|
|
5455
|
-
'identifiers'?: Array<string>;
|
|
5456
|
-
/**
|
|
5457
|
-
* 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.
|
|
5458
|
-
*/
|
|
5459
|
-
'customClaimMapping'?: {
|
|
5460
|
-
[key: string]: string;
|
|
5461
|
-
};
|
|
5462
|
-
/**
|
|
5463
|
-
* 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.
|
|
5464
|
-
*/
|
|
5465
|
-
'samlMetadata'?: string;
|
|
5466
|
-
/**
|
|
5467
|
-
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5468
|
-
*/
|
|
5469
|
-
'oauthClientId'?: string;
|
|
5470
|
-
/**
|
|
5471
|
-
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5472
|
-
*/
|
|
5473
|
-
'oauthClientSecret'?: string;
|
|
5474
|
-
/**
|
|
5475
|
-
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5476
|
-
*/
|
|
5477
|
-
'oauthIssuerLocation'?: string;
|
|
5478
|
-
/**
|
|
5479
|
-
* 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.
|
|
5480
|
-
*/
|
|
5481
|
-
'oauthIssuerId'?: string;
|
|
5482
|
-
/**
|
|
5483
|
-
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
5484
|
-
*/
|
|
5485
|
-
'oauthSubjectIdClaim'?: string;
|
|
5486
|
-
/**
|
|
5487
|
-
* 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.
|
|
5488
|
-
*/
|
|
5489
|
-
'oauthCustomAuthAttributes'?: {
|
|
5490
|
-
[key: string]: string;
|
|
5491
|
-
};
|
|
5492
|
-
/**
|
|
5493
|
-
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
5494
|
-
*/
|
|
5495
|
-
'oauthCustomScopes'?: Array<string> | null;
|
|
5496
|
-
/**
|
|
5497
|
-
* 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.
|
|
5498
|
-
*/
|
|
5499
|
-
'idpType'?: JsonApiIdentityProviderInAttributesIdpTypeEnum;
|
|
5500
|
-
}
|
|
5501
|
-
export type JsonApiIdentityProviderInAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
|
|
5502
5524
|
export interface JsonApiIdentityProviderInDocument {
|
|
5503
5525
|
'data': JsonApiIdentityProviderIn;
|
|
5504
5526
|
}
|
|
@@ -5578,7 +5600,7 @@ export interface JsonApiIdentityProviderOutDocument {
|
|
|
5578
5600
|
export interface JsonApiIdentityProviderOutList {
|
|
5579
5601
|
'data': Array<JsonApiIdentityProviderOutWithLinks>;
|
|
5580
5602
|
'links'?: ListLinks;
|
|
5581
|
-
'meta'?:
|
|
5603
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
5582
5604
|
}
|
|
5583
5605
|
export interface JsonApiIdentityProviderOutWithLinks {
|
|
5584
5606
|
/**
|
|
@@ -5605,9 +5627,60 @@ export interface JsonApiIdentityProviderPatch {
|
|
|
5605
5627
|
* API identifier of an object
|
|
5606
5628
|
*/
|
|
5607
5629
|
'id': string;
|
|
5608
|
-
'attributes'?:
|
|
5630
|
+
'attributes'?: JsonApiIdentityProviderPatchAttributes;
|
|
5609
5631
|
}
|
|
5610
5632
|
export type JsonApiIdentityProviderPatchTypeEnum = 'identityProvider';
|
|
5633
|
+
export interface JsonApiIdentityProviderPatchAttributes {
|
|
5634
|
+
/**
|
|
5635
|
+
* 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.
|
|
5636
|
+
*/
|
|
5637
|
+
'identifiers'?: Array<string>;
|
|
5638
|
+
/**
|
|
5639
|
+
* 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.
|
|
5640
|
+
*/
|
|
5641
|
+
'customClaimMapping'?: {
|
|
5642
|
+
[key: string]: string;
|
|
5643
|
+
};
|
|
5644
|
+
/**
|
|
5645
|
+
* 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.
|
|
5646
|
+
*/
|
|
5647
|
+
'samlMetadata'?: string;
|
|
5648
|
+
/**
|
|
5649
|
+
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5650
|
+
*/
|
|
5651
|
+
'oauthClientId'?: string;
|
|
5652
|
+
/**
|
|
5653
|
+
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5654
|
+
*/
|
|
5655
|
+
'oauthClientSecret'?: string;
|
|
5656
|
+
/**
|
|
5657
|
+
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5658
|
+
*/
|
|
5659
|
+
'oauthIssuerLocation'?: string;
|
|
5660
|
+
/**
|
|
5661
|
+
* 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.
|
|
5662
|
+
*/
|
|
5663
|
+
'oauthIssuerId'?: string;
|
|
5664
|
+
/**
|
|
5665
|
+
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
5666
|
+
*/
|
|
5667
|
+
'oauthSubjectIdClaim'?: string;
|
|
5668
|
+
/**
|
|
5669
|
+
* 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.
|
|
5670
|
+
*/
|
|
5671
|
+
'oauthCustomAuthAttributes'?: {
|
|
5672
|
+
[key: string]: string;
|
|
5673
|
+
};
|
|
5674
|
+
/**
|
|
5675
|
+
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
5676
|
+
*/
|
|
5677
|
+
'oauthCustomScopes'?: Array<string> | null;
|
|
5678
|
+
/**
|
|
5679
|
+
* 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.
|
|
5680
|
+
*/
|
|
5681
|
+
'idpType'?: JsonApiIdentityProviderPatchAttributesIdpTypeEnum;
|
|
5682
|
+
}
|
|
5683
|
+
export type JsonApiIdentityProviderPatchAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
|
|
5611
5684
|
export interface JsonApiIdentityProviderPatchDocument {
|
|
5612
5685
|
'data': JsonApiIdentityProviderPatch;
|
|
5613
5686
|
}
|
|
@@ -5623,12 +5696,9 @@ export interface JsonApiJwkIn {
|
|
|
5623
5696
|
* API identifier of an object
|
|
5624
5697
|
*/
|
|
5625
5698
|
'id': string;
|
|
5626
|
-
'attributes'?:
|
|
5699
|
+
'attributes'?: JsonApiJwkPatchAttributes;
|
|
5627
5700
|
}
|
|
5628
5701
|
export type JsonApiJwkInTypeEnum = 'jwk';
|
|
5629
|
-
export interface JsonApiJwkInAttributes {
|
|
5630
|
-
'content'?: RsaSpecification;
|
|
5631
|
-
}
|
|
5632
5702
|
export interface JsonApiJwkInDocument {
|
|
5633
5703
|
'data': JsonApiJwkIn;
|
|
5634
5704
|
}
|
|
@@ -5644,7 +5714,7 @@ export interface JsonApiJwkOut {
|
|
|
5644
5714
|
* API identifier of an object
|
|
5645
5715
|
*/
|
|
5646
5716
|
'id': string;
|
|
5647
|
-
'attributes'?:
|
|
5717
|
+
'attributes'?: JsonApiJwkPatchAttributes;
|
|
5648
5718
|
}
|
|
5649
5719
|
export type JsonApiJwkOutTypeEnum = 'jwk';
|
|
5650
5720
|
export interface JsonApiJwkOutDocument {
|
|
@@ -5657,7 +5727,7 @@ export interface JsonApiJwkOutDocument {
|
|
|
5657
5727
|
export interface JsonApiJwkOutList {
|
|
5658
5728
|
'data': Array<JsonApiJwkOutWithLinks>;
|
|
5659
5729
|
'links'?: ListLinks;
|
|
5660
|
-
'meta'?:
|
|
5730
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
5661
5731
|
}
|
|
5662
5732
|
export interface JsonApiJwkOutWithLinks {
|
|
5663
5733
|
/**
|
|
@@ -5668,7 +5738,7 @@ export interface JsonApiJwkOutWithLinks {
|
|
|
5668
5738
|
* API identifier of an object
|
|
5669
5739
|
*/
|
|
5670
5740
|
'id': string;
|
|
5671
|
-
'attributes'?:
|
|
5741
|
+
'attributes'?: JsonApiJwkPatchAttributes;
|
|
5672
5742
|
'links'?: ObjectLinks;
|
|
5673
5743
|
}
|
|
5674
5744
|
export type JsonApiJwkOutWithLinksTypeEnum = 'jwk';
|
|
@@ -5684,9 +5754,12 @@ export interface JsonApiJwkPatch {
|
|
|
5684
5754
|
* API identifier of an object
|
|
5685
5755
|
*/
|
|
5686
5756
|
'id': string;
|
|
5687
|
-
'attributes'?:
|
|
5757
|
+
'attributes'?: JsonApiJwkPatchAttributes;
|
|
5688
5758
|
}
|
|
5689
5759
|
export type JsonApiJwkPatchTypeEnum = 'jwk';
|
|
5760
|
+
export interface JsonApiJwkPatchAttributes {
|
|
5761
|
+
'content'?: RsaSpecification;
|
|
5762
|
+
}
|
|
5690
5763
|
export interface JsonApiJwkPatchDocument {
|
|
5691
5764
|
'data': JsonApiJwkPatch;
|
|
5692
5765
|
}
|
|
@@ -5721,7 +5794,7 @@ export interface JsonApiKnowledgeRecommendationOut {
|
|
|
5721
5794
|
* API identifier of an object
|
|
5722
5795
|
*/
|
|
5723
5796
|
'id': string;
|
|
5724
|
-
'meta'?:
|
|
5797
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
5725
5798
|
'attributes': JsonApiKnowledgeRecommendationOutAttributes;
|
|
5726
5799
|
'relationships'?: JsonApiKnowledgeRecommendationOutRelationships;
|
|
5727
5800
|
}
|
|
@@ -5811,7 +5884,7 @@ export type JsonApiKnowledgeRecommendationOutIncludes = JsonApiAnalyticalDashboa
|
|
|
5811
5884
|
export interface JsonApiKnowledgeRecommendationOutList {
|
|
5812
5885
|
'data': Array<JsonApiKnowledgeRecommendationOutWithLinks>;
|
|
5813
5886
|
'links'?: ListLinks;
|
|
5814
|
-
'meta'?:
|
|
5887
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
5815
5888
|
/**
|
|
5816
5889
|
* Included resources
|
|
5817
5890
|
*/
|
|
@@ -5819,7 +5892,7 @@ export interface JsonApiKnowledgeRecommendationOutList {
|
|
|
5819
5892
|
}
|
|
5820
5893
|
export interface JsonApiKnowledgeRecommendationOutRelationships {
|
|
5821
5894
|
'metric'?: JsonApiKnowledgeRecommendationOutRelationshipsMetric;
|
|
5822
|
-
'analyticalDashboard'?:
|
|
5895
|
+
'analyticalDashboard'?: JsonApiAutomationOutRelationshipsAnalyticalDashboard;
|
|
5823
5896
|
}
|
|
5824
5897
|
export interface JsonApiKnowledgeRecommendationOutRelationshipsMetric {
|
|
5825
5898
|
'data': JsonApiMetricLinkage | null;
|
|
@@ -5833,7 +5906,7 @@ export interface JsonApiKnowledgeRecommendationOutWithLinks {
|
|
|
5833
5906
|
* API identifier of an object
|
|
5834
5907
|
*/
|
|
5835
5908
|
'id': string;
|
|
5836
|
-
'meta'?:
|
|
5909
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
5837
5910
|
'attributes': JsonApiKnowledgeRecommendationOutAttributes;
|
|
5838
5911
|
'relationships'?: JsonApiKnowledgeRecommendationOutRelationships;
|
|
5839
5912
|
'links'?: ObjectLinks;
|
|
@@ -6011,7 +6084,7 @@ export interface JsonApiKnowledgeRecommendationPostOptionalIdDocument {
|
|
|
6011
6084
|
}
|
|
6012
6085
|
export interface JsonApiKnowledgeRecommendationPostOptionalIdRelationships {
|
|
6013
6086
|
'metric': JsonApiKnowledgeRecommendationOutRelationshipsMetric;
|
|
6014
|
-
'analyticalDashboard'?:
|
|
6087
|
+
'analyticalDashboard'?: JsonApiAutomationOutRelationshipsAnalyticalDashboard;
|
|
6015
6088
|
}
|
|
6016
6089
|
/**
|
|
6017
6090
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
@@ -6033,7 +6106,7 @@ export interface JsonApiLabelOut {
|
|
|
6033
6106
|
* API identifier of an object
|
|
6034
6107
|
*/
|
|
6035
6108
|
'id': string;
|
|
6036
|
-
'meta'?:
|
|
6109
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
6037
6110
|
'attributes'?: JsonApiLabelOutAttributes;
|
|
6038
6111
|
'relationships'?: JsonApiLabelOutRelationships;
|
|
6039
6112
|
}
|
|
@@ -6080,7 +6153,7 @@ export interface JsonApiLabelOutDocument {
|
|
|
6080
6153
|
export interface JsonApiLabelOutList {
|
|
6081
6154
|
'data': Array<JsonApiLabelOutWithLinks>;
|
|
6082
6155
|
'links'?: ListLinks;
|
|
6083
|
-
'meta'?:
|
|
6156
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
6084
6157
|
/**
|
|
6085
6158
|
* Included resources
|
|
6086
6159
|
*/
|
|
@@ -6101,7 +6174,7 @@ export interface JsonApiLabelOutWithLinks {
|
|
|
6101
6174
|
* API identifier of an object
|
|
6102
6175
|
*/
|
|
6103
6176
|
'id': string;
|
|
6104
|
-
'meta'?:
|
|
6177
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
6105
6178
|
'attributes'?: JsonApiLabelOutAttributes;
|
|
6106
6179
|
'relationships'?: JsonApiLabelOutRelationships;
|
|
6107
6180
|
'links'?: ObjectLinks;
|
|
@@ -6218,7 +6291,7 @@ export interface JsonApiLlmEndpointOutDocument {
|
|
|
6218
6291
|
export interface JsonApiLlmEndpointOutList {
|
|
6219
6292
|
'data': Array<JsonApiLlmEndpointOutWithLinks>;
|
|
6220
6293
|
'links'?: ListLinks;
|
|
6221
|
-
'meta'?:
|
|
6294
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
6222
6295
|
}
|
|
6223
6296
|
export interface JsonApiLlmEndpointOutWithLinks {
|
|
6224
6297
|
/**
|
|
@@ -6308,7 +6381,7 @@ export interface JsonApiMemoryItemOut {
|
|
|
6308
6381
|
* API identifier of an object
|
|
6309
6382
|
*/
|
|
6310
6383
|
'id': string;
|
|
6311
|
-
'meta'?:
|
|
6384
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
6312
6385
|
'attributes': JsonApiMemoryItemOutAttributes;
|
|
6313
6386
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
6314
6387
|
}
|
|
@@ -6358,7 +6431,7 @@ export interface JsonApiMemoryItemOutDocument {
|
|
|
6358
6431
|
export interface JsonApiMemoryItemOutList {
|
|
6359
6432
|
'data': Array<JsonApiMemoryItemOutWithLinks>;
|
|
6360
6433
|
'links'?: ListLinks;
|
|
6361
|
-
'meta'?:
|
|
6434
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
6362
6435
|
/**
|
|
6363
6436
|
* Included resources
|
|
6364
6437
|
*/
|
|
@@ -6373,7 +6446,7 @@ export interface JsonApiMemoryItemOutWithLinks {
|
|
|
6373
6446
|
* API identifier of an object
|
|
6374
6447
|
*/
|
|
6375
6448
|
'id': string;
|
|
6376
|
-
'meta'?:
|
|
6449
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
6377
6450
|
'attributes': JsonApiMemoryItemOutAttributes;
|
|
6378
6451
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
6379
6452
|
'links'?: ObjectLinks;
|
|
@@ -6499,7 +6572,7 @@ export interface JsonApiMetricOut {
|
|
|
6499
6572
|
* API identifier of an object
|
|
6500
6573
|
*/
|
|
6501
6574
|
'id': string;
|
|
6502
|
-
'meta'?:
|
|
6575
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
6503
6576
|
'attributes': JsonApiMetricOutAttributes;
|
|
6504
6577
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
6505
6578
|
}
|
|
@@ -6551,7 +6624,7 @@ export type JsonApiMetricOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDat
|
|
|
6551
6624
|
export interface JsonApiMetricOutList {
|
|
6552
6625
|
'data': Array<JsonApiMetricOutWithLinks>;
|
|
6553
6626
|
'links'?: ListLinks;
|
|
6554
|
-
'meta'?:
|
|
6627
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
6555
6628
|
/**
|
|
6556
6629
|
* Included resources
|
|
6557
6630
|
*/
|
|
@@ -6566,7 +6639,7 @@ export interface JsonApiMetricOutWithLinks {
|
|
|
6566
6639
|
* API identifier of an object
|
|
6567
6640
|
*/
|
|
6568
6641
|
'id': string;
|
|
6569
|
-
'meta'?:
|
|
6642
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
6570
6643
|
'attributes': JsonApiMetricOutAttributes;
|
|
6571
6644
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
6572
6645
|
'links'?: ObjectLinks;
|
|
@@ -6662,7 +6735,7 @@ export interface JsonApiNotificationChannelIdentifierOutDocument {
|
|
|
6662
6735
|
export interface JsonApiNotificationChannelIdentifierOutList {
|
|
6663
6736
|
'data': Array<JsonApiNotificationChannelIdentifierOutWithLinks>;
|
|
6664
6737
|
'links'?: ListLinks;
|
|
6665
|
-
'meta'?:
|
|
6738
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
6666
6739
|
}
|
|
6667
6740
|
export interface JsonApiNotificationChannelIdentifierOutWithLinks {
|
|
6668
6741
|
/**
|
|
@@ -6689,7 +6762,7 @@ export interface JsonApiNotificationChannelIn {
|
|
|
6689
6762
|
* API identifier of an object
|
|
6690
6763
|
*/
|
|
6691
6764
|
'id': string;
|
|
6692
|
-
'attributes'?:
|
|
6765
|
+
'attributes'?: JsonApiNotificationChannelPatchAttributes;
|
|
6693
6766
|
}
|
|
6694
6767
|
export type JsonApiNotificationChannelInTypeEnum = 'notificationChannel';
|
|
6695
6768
|
export interface JsonApiNotificationChannelInDocument {
|
|
@@ -6763,7 +6836,7 @@ export interface JsonApiNotificationChannelOutDocument {
|
|
|
6763
6836
|
export interface JsonApiNotificationChannelOutList {
|
|
6764
6837
|
'data': Array<JsonApiNotificationChannelOutWithLinks>;
|
|
6765
6838
|
'links'?: ListLinks;
|
|
6766
|
-
'meta'?:
|
|
6839
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
6767
6840
|
}
|
|
6768
6841
|
export interface JsonApiNotificationChannelOutWithLinks {
|
|
6769
6842
|
/**
|
|
@@ -6790,28 +6863,10 @@ export interface JsonApiNotificationChannelPatch {
|
|
|
6790
6863
|
* API identifier of an object
|
|
6791
6864
|
*/
|
|
6792
6865
|
'id': string;
|
|
6793
|
-
'attributes'?:
|
|
6866
|
+
'attributes'?: JsonApiNotificationChannelPatchAttributes;
|
|
6794
6867
|
}
|
|
6795
6868
|
export type JsonApiNotificationChannelPatchTypeEnum = 'notificationChannel';
|
|
6796
|
-
export interface
|
|
6797
|
-
'data': JsonApiNotificationChannelPatch;
|
|
6798
|
-
}
|
|
6799
|
-
/**
|
|
6800
|
-
* JSON:API representation of notificationChannel entity.
|
|
6801
|
-
*/
|
|
6802
|
-
export interface JsonApiNotificationChannelPostOptionalId {
|
|
6803
|
-
/**
|
|
6804
|
-
* Object type
|
|
6805
|
-
*/
|
|
6806
|
-
'type': JsonApiNotificationChannelPostOptionalIdTypeEnum;
|
|
6807
|
-
/**
|
|
6808
|
-
* API identifier of an object
|
|
6809
|
-
*/
|
|
6810
|
-
'id'?: string;
|
|
6811
|
-
'attributes'?: JsonApiNotificationChannelPostOptionalIdAttributes;
|
|
6812
|
-
}
|
|
6813
|
-
export type JsonApiNotificationChannelPostOptionalIdTypeEnum = 'notificationChannel';
|
|
6814
|
-
export interface JsonApiNotificationChannelPostOptionalIdAttributes {
|
|
6869
|
+
export interface JsonApiNotificationChannelPatchAttributes {
|
|
6815
6870
|
'name'?: string | null;
|
|
6816
6871
|
'description'?: string | null;
|
|
6817
6872
|
'destination'?: JsonApiNotificationChannelOutAttributesDestination;
|
|
@@ -6822,7 +6877,7 @@ export interface JsonApiNotificationChannelPostOptionalIdAttributes {
|
|
|
6822
6877
|
/**
|
|
6823
6878
|
* 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
|
|
6824
6879
|
*/
|
|
6825
|
-
'dashboardLinkVisibility'?:
|
|
6880
|
+
'dashboardLinkVisibility'?: JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum;
|
|
6826
6881
|
/**
|
|
6827
6882
|
* 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}}
|
|
6828
6883
|
*/
|
|
@@ -6830,15 +6885,33 @@ export interface JsonApiNotificationChannelPostOptionalIdAttributes {
|
|
|
6830
6885
|
/**
|
|
6831
6886
|
* 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
|
|
6832
6887
|
*/
|
|
6833
|
-
'allowedRecipients'?:
|
|
6888
|
+
'allowedRecipients'?: JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum;
|
|
6834
6889
|
/**
|
|
6835
6890
|
* 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
|
|
6836
6891
|
*/
|
|
6837
|
-
'inPlatformNotification'?:
|
|
6892
|
+
'inPlatformNotification'?: JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum;
|
|
6893
|
+
}
|
|
6894
|
+
export type JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
|
|
6895
|
+
export type JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum = 'CREATOR' | 'INTERNAL' | 'EXTERNAL';
|
|
6896
|
+
export type JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
|
|
6897
|
+
export interface JsonApiNotificationChannelPatchDocument {
|
|
6898
|
+
'data': JsonApiNotificationChannelPatch;
|
|
6838
6899
|
}
|
|
6839
|
-
|
|
6840
|
-
|
|
6841
|
-
|
|
6900
|
+
/**
|
|
6901
|
+
* JSON:API representation of notificationChannel entity.
|
|
6902
|
+
*/
|
|
6903
|
+
export interface JsonApiNotificationChannelPostOptionalId {
|
|
6904
|
+
/**
|
|
6905
|
+
* Object type
|
|
6906
|
+
*/
|
|
6907
|
+
'type': JsonApiNotificationChannelPostOptionalIdTypeEnum;
|
|
6908
|
+
/**
|
|
6909
|
+
* API identifier of an object
|
|
6910
|
+
*/
|
|
6911
|
+
'id'?: string;
|
|
6912
|
+
'attributes'?: JsonApiNotificationChannelPatchAttributes;
|
|
6913
|
+
}
|
|
6914
|
+
export type JsonApiNotificationChannelPostOptionalIdTypeEnum = 'notificationChannel';
|
|
6842
6915
|
export interface JsonApiNotificationChannelPostOptionalIdDocument {
|
|
6843
6916
|
'data': JsonApiNotificationChannelPostOptionalId;
|
|
6844
6917
|
}
|
|
@@ -6854,13 +6927,33 @@ export interface JsonApiOrganizationIn {
|
|
|
6854
6927
|
* API identifier of an object
|
|
6855
6928
|
*/
|
|
6856
6929
|
'id': string;
|
|
6857
|
-
'attributes'?:
|
|
6858
|
-
'relationships'?:
|
|
6930
|
+
'attributes'?: JsonApiOrganizationInAttributes;
|
|
6931
|
+
'relationships'?: JsonApiOrganizationInRelationships;
|
|
6859
6932
|
}
|
|
6860
6933
|
export type JsonApiOrganizationInTypeEnum = 'organization';
|
|
6934
|
+
export interface JsonApiOrganizationInAttributes {
|
|
6935
|
+
'name'?: string | null;
|
|
6936
|
+
'hostname'?: string;
|
|
6937
|
+
'allowedOrigins'?: Array<string>;
|
|
6938
|
+
/**
|
|
6939
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
6940
|
+
* @deprecated
|
|
6941
|
+
*/
|
|
6942
|
+
'earlyAccess'?: string | null;
|
|
6943
|
+
/**
|
|
6944
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
6945
|
+
*/
|
|
6946
|
+
'earlyAccessValues'?: Array<string> | null;
|
|
6947
|
+
}
|
|
6861
6948
|
export interface JsonApiOrganizationInDocument {
|
|
6862
6949
|
'data': JsonApiOrganizationIn;
|
|
6863
6950
|
}
|
|
6951
|
+
export interface JsonApiOrganizationInRelationships {
|
|
6952
|
+
'identityProvider'?: JsonApiOrganizationInRelationshipsIdentityProvider;
|
|
6953
|
+
}
|
|
6954
|
+
export interface JsonApiOrganizationInRelationshipsIdentityProvider {
|
|
6955
|
+
'data': JsonApiIdentityProviderLinkage | null;
|
|
6956
|
+
}
|
|
6864
6957
|
/**
|
|
6865
6958
|
* JSON:API representation of organization entity.
|
|
6866
6959
|
*/
|
|
@@ -6928,7 +7021,7 @@ export type JsonApiOrganizationOutMetaPermissionsEnum = 'MANAGE' | 'SELF_CREATE_
|
|
|
6928
7021
|
export interface JsonApiOrganizationOutRelationships {
|
|
6929
7022
|
'bootstrapUser'?: JsonApiFilterViewOutRelationshipsUser;
|
|
6930
7023
|
'bootstrapUserGroup'?: JsonApiUserDataFilterOutRelationshipsUserGroup;
|
|
6931
|
-
'identityProvider'?:
|
|
7024
|
+
'identityProvider'?: JsonApiOrganizationInRelationshipsIdentityProvider;
|
|
6932
7025
|
}
|
|
6933
7026
|
/**
|
|
6934
7027
|
* JSON:API representation of patching organization entity.
|
|
@@ -6942,33 +7035,13 @@ export interface JsonApiOrganizationPatch {
|
|
|
6942
7035
|
* API identifier of an object
|
|
6943
7036
|
*/
|
|
6944
7037
|
'id': string;
|
|
6945
|
-
'attributes'?:
|
|
6946
|
-
'relationships'?:
|
|
7038
|
+
'attributes'?: JsonApiOrganizationInAttributes;
|
|
7039
|
+
'relationships'?: JsonApiOrganizationInRelationships;
|
|
6947
7040
|
}
|
|
6948
7041
|
export type JsonApiOrganizationPatchTypeEnum = 'organization';
|
|
6949
|
-
export interface JsonApiOrganizationPatchAttributes {
|
|
6950
|
-
'name'?: string | null;
|
|
6951
|
-
'hostname'?: string;
|
|
6952
|
-
'allowedOrigins'?: Array<string>;
|
|
6953
|
-
/**
|
|
6954
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
6955
|
-
* @deprecated
|
|
6956
|
-
*/
|
|
6957
|
-
'earlyAccess'?: string | null;
|
|
6958
|
-
/**
|
|
6959
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
6960
|
-
*/
|
|
6961
|
-
'earlyAccessValues'?: Array<string> | null;
|
|
6962
|
-
}
|
|
6963
7042
|
export interface JsonApiOrganizationPatchDocument {
|
|
6964
7043
|
'data': JsonApiOrganizationPatch;
|
|
6965
7044
|
}
|
|
6966
|
-
export interface JsonApiOrganizationPatchRelationships {
|
|
6967
|
-
'identityProvider'?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
6968
|
-
}
|
|
6969
|
-
export interface JsonApiOrganizationPatchRelationshipsIdentityProvider {
|
|
6970
|
-
'data': JsonApiIdentityProviderLinkage | null;
|
|
6971
|
-
}
|
|
6972
7045
|
/**
|
|
6973
7046
|
* JSON:API representation of organizationSetting entity.
|
|
6974
7047
|
*/
|
|
@@ -6981,17 +7054,9 @@ export interface JsonApiOrganizationSettingIn {
|
|
|
6981
7054
|
* API identifier of an object
|
|
6982
7055
|
*/
|
|
6983
7056
|
'id': string;
|
|
6984
|
-
'attributes'?:
|
|
7057
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
6985
7058
|
}
|
|
6986
7059
|
export type JsonApiOrganizationSettingInTypeEnum = 'organizationSetting';
|
|
6987
|
-
export interface JsonApiOrganizationSettingInAttributes {
|
|
6988
|
-
/**
|
|
6989
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
6990
|
-
*/
|
|
6991
|
-
'content'?: object;
|
|
6992
|
-
'type'?: JsonApiOrganizationSettingInAttributesTypeEnum;
|
|
6993
|
-
}
|
|
6994
|
-
export type JsonApiOrganizationSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS';
|
|
6995
7060
|
export interface JsonApiOrganizationSettingInDocument {
|
|
6996
7061
|
'data': JsonApiOrganizationSettingIn;
|
|
6997
7062
|
}
|
|
@@ -7007,7 +7072,7 @@ export interface JsonApiOrganizationSettingOut {
|
|
|
7007
7072
|
* API identifier of an object
|
|
7008
7073
|
*/
|
|
7009
7074
|
'id': string;
|
|
7010
|
-
'attributes'?:
|
|
7075
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
7011
7076
|
}
|
|
7012
7077
|
export type JsonApiOrganizationSettingOutTypeEnum = 'organizationSetting';
|
|
7013
7078
|
export interface JsonApiOrganizationSettingOutDocument {
|
|
@@ -7020,7 +7085,7 @@ export interface JsonApiOrganizationSettingOutDocument {
|
|
|
7020
7085
|
export interface JsonApiOrganizationSettingOutList {
|
|
7021
7086
|
'data': Array<JsonApiOrganizationSettingOutWithLinks>;
|
|
7022
7087
|
'links'?: ListLinks;
|
|
7023
|
-
'meta'?:
|
|
7088
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
7024
7089
|
}
|
|
7025
7090
|
export interface JsonApiOrganizationSettingOutWithLinks {
|
|
7026
7091
|
/**
|
|
@@ -7031,7 +7096,7 @@ export interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
7031
7096
|
* API identifier of an object
|
|
7032
7097
|
*/
|
|
7033
7098
|
'id': string;
|
|
7034
|
-
'attributes'?:
|
|
7099
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
7035
7100
|
'links'?: ObjectLinks;
|
|
7036
7101
|
}
|
|
7037
7102
|
export type JsonApiOrganizationSettingOutWithLinksTypeEnum = 'organizationSetting';
|
|
@@ -7047,7 +7112,7 @@ export interface JsonApiOrganizationSettingPatch {
|
|
|
7047
7112
|
* API identifier of an object
|
|
7048
7113
|
*/
|
|
7049
7114
|
'id': string;
|
|
7050
|
-
'attributes'?:
|
|
7115
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
7051
7116
|
}
|
|
7052
7117
|
export type JsonApiOrganizationSettingPatchTypeEnum = 'organizationSetting';
|
|
7053
7118
|
export interface JsonApiOrganizationSettingPatchDocument {
|
|
@@ -7065,7 +7130,7 @@ export interface JsonApiThemeIn {
|
|
|
7065
7130
|
* API identifier of an object
|
|
7066
7131
|
*/
|
|
7067
7132
|
'id': string;
|
|
7068
|
-
'attributes':
|
|
7133
|
+
'attributes': JsonApiColorPaletteOutAttributes;
|
|
7069
7134
|
}
|
|
7070
7135
|
export type JsonApiThemeInTypeEnum = 'theme';
|
|
7071
7136
|
export interface JsonApiThemeInDocument {
|
|
@@ -7083,7 +7148,7 @@ export interface JsonApiThemeOut {
|
|
|
7083
7148
|
* API identifier of an object
|
|
7084
7149
|
*/
|
|
7085
7150
|
'id': string;
|
|
7086
|
-
'attributes':
|
|
7151
|
+
'attributes': JsonApiColorPaletteOutAttributes;
|
|
7087
7152
|
}
|
|
7088
7153
|
export type JsonApiThemeOutTypeEnum = 'theme';
|
|
7089
7154
|
export interface JsonApiThemeOutDocument {
|
|
@@ -7096,7 +7161,7 @@ export interface JsonApiThemeOutDocument {
|
|
|
7096
7161
|
export interface JsonApiThemeOutList {
|
|
7097
7162
|
'data': Array<JsonApiThemeOutWithLinks>;
|
|
7098
7163
|
'links'?: ListLinks;
|
|
7099
|
-
'meta'?:
|
|
7164
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
7100
7165
|
}
|
|
7101
7166
|
export interface JsonApiThemeOutWithLinks {
|
|
7102
7167
|
/**
|
|
@@ -7107,7 +7172,7 @@ export interface JsonApiThemeOutWithLinks {
|
|
|
7107
7172
|
* API identifier of an object
|
|
7108
7173
|
*/
|
|
7109
7174
|
'id': string;
|
|
7110
|
-
'attributes':
|
|
7175
|
+
'attributes': JsonApiColorPaletteOutAttributes;
|
|
7111
7176
|
'links'?: ObjectLinks;
|
|
7112
7177
|
}
|
|
7113
7178
|
export type JsonApiThemeOutWithLinksTypeEnum = 'theme';
|
|
@@ -7142,7 +7207,7 @@ export interface JsonApiUserDataFilterIn {
|
|
|
7142
7207
|
*/
|
|
7143
7208
|
'id': string;
|
|
7144
7209
|
'attributes': JsonApiUserDataFilterOutAttributes;
|
|
7145
|
-
'relationships'?:
|
|
7210
|
+
'relationships'?: JsonApiUserDataFilterPatchRelationships;
|
|
7146
7211
|
}
|
|
7147
7212
|
export type JsonApiUserDataFilterInTypeEnum = 'userDataFilter';
|
|
7148
7213
|
export interface JsonApiUserDataFilterInDocument {
|
|
@@ -7160,7 +7225,7 @@ export interface JsonApiUserDataFilterOut {
|
|
|
7160
7225
|
* API identifier of an object
|
|
7161
7226
|
*/
|
|
7162
7227
|
'id': string;
|
|
7163
|
-
'meta'?:
|
|
7228
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
7164
7229
|
'attributes': JsonApiUserDataFilterOutAttributes;
|
|
7165
7230
|
'relationships'?: JsonApiUserDataFilterOutRelationships;
|
|
7166
7231
|
}
|
|
@@ -7190,7 +7255,7 @@ export type JsonApiUserDataFilterOutIncludes = JsonApiAttributeOutWithLinks | Js
|
|
|
7190
7255
|
export interface JsonApiUserDataFilterOutList {
|
|
7191
7256
|
'data': Array<JsonApiUserDataFilterOutWithLinks>;
|
|
7192
7257
|
'links'?: ListLinks;
|
|
7193
|
-
'meta'?:
|
|
7258
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
7194
7259
|
/**
|
|
7195
7260
|
* Included resources
|
|
7196
7261
|
*/
|
|
@@ -7201,9 +7266,9 @@ export interface JsonApiUserDataFilterOutRelationships {
|
|
|
7201
7266
|
'userGroup'?: JsonApiUserDataFilterOutRelationshipsUserGroup;
|
|
7202
7267
|
'facts'?: JsonApiDatasetOutRelationshipsFacts;
|
|
7203
7268
|
'attributes'?: JsonApiDatasetOutRelationshipsAttributes;
|
|
7204
|
-
'labels'?:
|
|
7205
|
-
'metrics'?:
|
|
7206
|
-
'datasets'?:
|
|
7269
|
+
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
7270
|
+
'metrics'?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
7271
|
+
'datasets'?: JsonApiDatasetOutRelationshipsReferences;
|
|
7207
7272
|
}
|
|
7208
7273
|
export interface JsonApiUserDataFilterOutRelationshipsUserGroup {
|
|
7209
7274
|
'data': JsonApiUserGroupLinkage | null;
|
|
@@ -7217,7 +7282,7 @@ export interface JsonApiUserDataFilterOutWithLinks {
|
|
|
7217
7282
|
* API identifier of an object
|
|
7218
7283
|
*/
|
|
7219
7284
|
'id': string;
|
|
7220
|
-
'meta'?:
|
|
7285
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
7221
7286
|
'attributes': JsonApiUserDataFilterOutAttributes;
|
|
7222
7287
|
'relationships'?: JsonApiUserDataFilterOutRelationships;
|
|
7223
7288
|
'links'?: ObjectLinks;
|
|
@@ -7236,7 +7301,7 @@ export interface JsonApiUserDataFilterPatch {
|
|
|
7236
7301
|
*/
|
|
7237
7302
|
'id': string;
|
|
7238
7303
|
'attributes': JsonApiUserDataFilterPatchAttributes;
|
|
7239
|
-
'relationships'?:
|
|
7304
|
+
'relationships'?: JsonApiUserDataFilterPatchRelationships;
|
|
7240
7305
|
}
|
|
7241
7306
|
export type JsonApiUserDataFilterPatchTypeEnum = 'userDataFilter';
|
|
7242
7307
|
export interface JsonApiUserDataFilterPatchAttributes {
|
|
@@ -7249,6 +7314,10 @@ export interface JsonApiUserDataFilterPatchAttributes {
|
|
|
7249
7314
|
export interface JsonApiUserDataFilterPatchDocument {
|
|
7250
7315
|
'data': JsonApiUserDataFilterPatch;
|
|
7251
7316
|
}
|
|
7317
|
+
export interface JsonApiUserDataFilterPatchRelationships {
|
|
7318
|
+
'user'?: JsonApiFilterViewOutRelationshipsUser;
|
|
7319
|
+
'userGroup'?: JsonApiUserDataFilterOutRelationshipsUserGroup;
|
|
7320
|
+
}
|
|
7252
7321
|
/**
|
|
7253
7322
|
* JSON:API representation of userDataFilter entity.
|
|
7254
7323
|
*/
|
|
@@ -7262,16 +7331,12 @@ export interface JsonApiUserDataFilterPostOptionalId {
|
|
|
7262
7331
|
*/
|
|
7263
7332
|
'id'?: string;
|
|
7264
7333
|
'attributes': JsonApiUserDataFilterOutAttributes;
|
|
7265
|
-
'relationships'?:
|
|
7334
|
+
'relationships'?: JsonApiUserDataFilterPatchRelationships;
|
|
7266
7335
|
}
|
|
7267
7336
|
export type JsonApiUserDataFilterPostOptionalIdTypeEnum = 'userDataFilter';
|
|
7268
7337
|
export interface JsonApiUserDataFilterPostOptionalIdDocument {
|
|
7269
7338
|
'data': JsonApiUserDataFilterPostOptionalId;
|
|
7270
7339
|
}
|
|
7271
|
-
export interface JsonApiUserDataFilterPostOptionalIdRelationships {
|
|
7272
|
-
'user'?: JsonApiFilterViewOutRelationshipsUser;
|
|
7273
|
-
'userGroup'?: JsonApiUserDataFilterOutRelationshipsUserGroup;
|
|
7274
|
-
}
|
|
7275
7340
|
/**
|
|
7276
7341
|
* JSON:API representation of userGroup entity.
|
|
7277
7342
|
*/
|
|
@@ -7284,19 +7349,13 @@ export interface JsonApiUserGroupIn {
|
|
|
7284
7349
|
* API identifier of an object
|
|
7285
7350
|
*/
|
|
7286
7351
|
'id': string;
|
|
7287
|
-
'attributes'?:
|
|
7288
|
-
'relationships'?:
|
|
7352
|
+
'attributes'?: JsonApiUserGroupOutAttributes;
|
|
7353
|
+
'relationships'?: JsonApiUserGroupOutRelationships;
|
|
7289
7354
|
}
|
|
7290
7355
|
export type JsonApiUserGroupInTypeEnum = 'userGroup';
|
|
7291
|
-
export interface JsonApiUserGroupInAttributes {
|
|
7292
|
-
'name'?: string;
|
|
7293
|
-
}
|
|
7294
7356
|
export interface JsonApiUserGroupInDocument {
|
|
7295
7357
|
'data': JsonApiUserGroupIn;
|
|
7296
7358
|
}
|
|
7297
|
-
export interface JsonApiUserGroupInRelationships {
|
|
7298
|
-
'parents'?: JsonApiUserOutRelationshipsUserGroups;
|
|
7299
|
-
}
|
|
7300
7359
|
/**
|
|
7301
7360
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
7302
7361
|
*/
|
|
@@ -7317,10 +7376,13 @@ export interface JsonApiUserGroupOut {
|
|
|
7317
7376
|
* API identifier of an object
|
|
7318
7377
|
*/
|
|
7319
7378
|
'id': string;
|
|
7320
|
-
'attributes'?:
|
|
7321
|
-
'relationships'?:
|
|
7379
|
+
'attributes'?: JsonApiUserGroupOutAttributes;
|
|
7380
|
+
'relationships'?: JsonApiUserGroupOutRelationships;
|
|
7322
7381
|
}
|
|
7323
7382
|
export type JsonApiUserGroupOutTypeEnum = 'userGroup';
|
|
7383
|
+
export interface JsonApiUserGroupOutAttributes {
|
|
7384
|
+
'name'?: string;
|
|
7385
|
+
}
|
|
7324
7386
|
export interface JsonApiUserGroupOutDocument {
|
|
7325
7387
|
'data': JsonApiUserGroupOut;
|
|
7326
7388
|
'links'?: ObjectLinks;
|
|
@@ -7335,12 +7397,15 @@ export interface JsonApiUserGroupOutDocument {
|
|
|
7335
7397
|
export interface JsonApiUserGroupOutList {
|
|
7336
7398
|
'data': Array<JsonApiUserGroupOutWithLinks>;
|
|
7337
7399
|
'links'?: ListLinks;
|
|
7338
|
-
'meta'?:
|
|
7400
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
7339
7401
|
/**
|
|
7340
7402
|
* Included resources
|
|
7341
7403
|
*/
|
|
7342
7404
|
'included'?: Array<JsonApiUserGroupOutWithLinks>;
|
|
7343
7405
|
}
|
|
7406
|
+
export interface JsonApiUserGroupOutRelationships {
|
|
7407
|
+
'parents'?: JsonApiUserOutRelationshipsUserGroups;
|
|
7408
|
+
}
|
|
7344
7409
|
export interface JsonApiUserGroupOutWithLinks {
|
|
7345
7410
|
/**
|
|
7346
7411
|
* Object type
|
|
@@ -7350,8 +7415,8 @@ export interface JsonApiUserGroupOutWithLinks {
|
|
|
7350
7415
|
* API identifier of an object
|
|
7351
7416
|
*/
|
|
7352
7417
|
'id': string;
|
|
7353
|
-
'attributes'?:
|
|
7354
|
-
'relationships'?:
|
|
7418
|
+
'attributes'?: JsonApiUserGroupOutAttributes;
|
|
7419
|
+
'relationships'?: JsonApiUserGroupOutRelationships;
|
|
7355
7420
|
'links'?: ObjectLinks;
|
|
7356
7421
|
}
|
|
7357
7422
|
export type JsonApiUserGroupOutWithLinksTypeEnum = 'userGroup';
|
|
@@ -7367,8 +7432,8 @@ export interface JsonApiUserGroupPatch {
|
|
|
7367
7432
|
* API identifier of an object
|
|
7368
7433
|
*/
|
|
7369
7434
|
'id': string;
|
|
7370
|
-
'attributes'?:
|
|
7371
|
-
'relationships'?:
|
|
7435
|
+
'attributes'?: JsonApiUserGroupOutAttributes;
|
|
7436
|
+
'relationships'?: JsonApiUserGroupOutRelationships;
|
|
7372
7437
|
}
|
|
7373
7438
|
export type JsonApiUserGroupPatchTypeEnum = 'userGroup';
|
|
7374
7439
|
export interface JsonApiUserGroupPatchDocument {
|
|
@@ -7412,7 +7477,7 @@ export interface JsonApiUserIdentifierOutDocument {
|
|
|
7412
7477
|
export interface JsonApiUserIdentifierOutList {
|
|
7413
7478
|
'data': Array<JsonApiUserIdentifierOutWithLinks>;
|
|
7414
7479
|
'links'?: ListLinks;
|
|
7415
|
-
'meta'?:
|
|
7480
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
7416
7481
|
}
|
|
7417
7482
|
export interface JsonApiUserIdentifierOutWithLinks {
|
|
7418
7483
|
/**
|
|
@@ -7490,7 +7555,7 @@ export interface JsonApiUserOutDocument {
|
|
|
7490
7555
|
export interface JsonApiUserOutList {
|
|
7491
7556
|
'data': Array<JsonApiUserOutWithLinks>;
|
|
7492
7557
|
'links'?: ListLinks;
|
|
7493
|
-
'meta'?:
|
|
7558
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
7494
7559
|
/**
|
|
7495
7560
|
* Included resources
|
|
7496
7561
|
*/
|
|
@@ -7550,7 +7615,7 @@ export interface JsonApiUserSettingIn {
|
|
|
7550
7615
|
* API identifier of an object
|
|
7551
7616
|
*/
|
|
7552
7617
|
'id': string;
|
|
7553
|
-
'attributes'?:
|
|
7618
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
7554
7619
|
}
|
|
7555
7620
|
export type JsonApiUserSettingInTypeEnum = 'userSetting';
|
|
7556
7621
|
export interface JsonApiUserSettingInDocument {
|
|
@@ -7568,7 +7633,7 @@ export interface JsonApiUserSettingOut {
|
|
|
7568
7633
|
* API identifier of an object
|
|
7569
7634
|
*/
|
|
7570
7635
|
'id': string;
|
|
7571
|
-
'attributes'?:
|
|
7636
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
7572
7637
|
}
|
|
7573
7638
|
export type JsonApiUserSettingOutTypeEnum = 'userSetting';
|
|
7574
7639
|
export interface JsonApiUserSettingOutDocument {
|
|
@@ -7581,7 +7646,7 @@ export interface JsonApiUserSettingOutDocument {
|
|
|
7581
7646
|
export interface JsonApiUserSettingOutList {
|
|
7582
7647
|
'data': Array<JsonApiUserSettingOutWithLinks>;
|
|
7583
7648
|
'links'?: ListLinks;
|
|
7584
|
-
'meta'?:
|
|
7649
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
7585
7650
|
}
|
|
7586
7651
|
export interface JsonApiUserSettingOutWithLinks {
|
|
7587
7652
|
/**
|
|
@@ -7592,7 +7657,7 @@ export interface JsonApiUserSettingOutWithLinks {
|
|
|
7592
7657
|
* API identifier of an object
|
|
7593
7658
|
*/
|
|
7594
7659
|
'id': string;
|
|
7595
|
-
'attributes'?:
|
|
7660
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
7596
7661
|
'links'?: ObjectLinks;
|
|
7597
7662
|
}
|
|
7598
7663
|
export type JsonApiUserSettingOutWithLinksTypeEnum = 'userSetting';
|
|
@@ -7634,7 +7699,7 @@ export interface JsonApiVisualizationObjectOut {
|
|
|
7634
7699
|
* API identifier of an object
|
|
7635
7700
|
*/
|
|
7636
7701
|
'id': string;
|
|
7637
|
-
'meta'?:
|
|
7702
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
7638
7703
|
'attributes': JsonApiVisualizationObjectOutAttributes;
|
|
7639
7704
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
7640
7705
|
}
|
|
@@ -7672,20 +7737,35 @@ export interface JsonApiVisualizationObjectOutDocument {
|
|
|
7672
7737
|
export interface JsonApiVisualizationObjectOutList {
|
|
7673
7738
|
'data': Array<JsonApiVisualizationObjectOutWithLinks>;
|
|
7674
7739
|
'links'?: ListLinks;
|
|
7675
|
-
'meta'?:
|
|
7740
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
7676
7741
|
/**
|
|
7677
7742
|
* Included resources
|
|
7678
7743
|
*/
|
|
7679
7744
|
'included'?: Array<JsonApiMetricOutIncludes>;
|
|
7680
7745
|
}
|
|
7681
7746
|
export interface JsonApiVisualizationObjectOutRelationships {
|
|
7682
|
-
'createdBy'?:
|
|
7683
|
-
'modifiedBy'?:
|
|
7747
|
+
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
7748
|
+
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
7684
7749
|
'facts'?: JsonApiDatasetOutRelationshipsFacts;
|
|
7685
7750
|
'attributes'?: JsonApiDatasetOutRelationshipsAttributes;
|
|
7686
|
-
'labels'?:
|
|
7687
|
-
'metrics'?:
|
|
7688
|
-
'datasets'?:
|
|
7751
|
+
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
7752
|
+
'metrics'?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
7753
|
+
'datasets'?: JsonApiDatasetOutRelationshipsReferences;
|
|
7754
|
+
}
|
|
7755
|
+
export interface JsonApiVisualizationObjectOutRelationshipsCreatedBy {
|
|
7756
|
+
'data': JsonApiUserIdentifierLinkage | null;
|
|
7757
|
+
}
|
|
7758
|
+
export interface JsonApiVisualizationObjectOutRelationshipsLabels {
|
|
7759
|
+
/**
|
|
7760
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7761
|
+
*/
|
|
7762
|
+
'data': Array<JsonApiLabelLinkage>;
|
|
7763
|
+
}
|
|
7764
|
+
export interface JsonApiVisualizationObjectOutRelationshipsMetrics {
|
|
7765
|
+
/**
|
|
7766
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7767
|
+
*/
|
|
7768
|
+
'data': Array<JsonApiMetricLinkage>;
|
|
7689
7769
|
}
|
|
7690
7770
|
export interface JsonApiVisualizationObjectOutWithLinks {
|
|
7691
7771
|
/**
|
|
@@ -7696,7 +7776,7 @@ export interface JsonApiVisualizationObjectOutWithLinks {
|
|
|
7696
7776
|
* API identifier of an object
|
|
7697
7777
|
*/
|
|
7698
7778
|
'id': string;
|
|
7699
|
-
'meta'?:
|
|
7779
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
7700
7780
|
'attributes': JsonApiVisualizationObjectOutAttributes;
|
|
7701
7781
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
7702
7782
|
'links'?: ObjectLinks;
|
|
@@ -7785,7 +7865,7 @@ export interface JsonApiWorkspaceAutomationOutAttributes {
|
|
|
7785
7865
|
* Additional details to be included in the automated message.
|
|
7786
7866
|
*/
|
|
7787
7867
|
'details'?: object;
|
|
7788
|
-
'metadata'?:
|
|
7868
|
+
'metadata'?: JsonApiAutomationOutAttributesMetadata | null;
|
|
7789
7869
|
/**
|
|
7790
7870
|
* Current state of the automation.
|
|
7791
7871
|
*/
|
|
@@ -7794,87 +7874,23 @@ export interface JsonApiWorkspaceAutomationOutAttributes {
|
|
|
7794
7874
|
* Specify automation evaluation mode.
|
|
7795
7875
|
*/
|
|
7796
7876
|
'evaluationMode'?: JsonApiWorkspaceAutomationOutAttributesEvaluationModeEnum;
|
|
7797
|
-
'schedule'?:
|
|
7798
|
-
'alert'?:
|
|
7799
|
-
'tabularExports'?: Array<
|
|
7800
|
-
'visualExports'?: Array<
|
|
7801
|
-
'imageExports'?: Array<
|
|
7802
|
-
'rawExports'?: Array<
|
|
7803
|
-
'slidesExports'?: Array<
|
|
7804
|
-
'dashboardTabularExports'?: Array<
|
|
7877
|
+
'schedule'?: JsonApiAutomationOutAttributesSchedule;
|
|
7878
|
+
'alert'?: JsonApiAutomationOutAttributesAlert;
|
|
7879
|
+
'tabularExports'?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
|
|
7880
|
+
'visualExports'?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
|
|
7881
|
+
'imageExports'?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
|
|
7882
|
+
'rawExports'?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
|
|
7883
|
+
'slidesExports'?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
|
|
7884
|
+
'dashboardTabularExports'?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
|
|
7805
7885
|
/**
|
|
7806
7886
|
* External recipients of the automation action results.
|
|
7807
7887
|
*/
|
|
7808
|
-
'externalRecipients'?: Array<
|
|
7888
|
+
'externalRecipients'?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
|
|
7809
7889
|
'createdAt'?: string;
|
|
7810
7890
|
'modifiedAt'?: string;
|
|
7811
7891
|
}
|
|
7812
7892
|
export type JsonApiWorkspaceAutomationOutAttributesStateEnum = 'ACTIVE' | 'PAUSED';
|
|
7813
7893
|
export type JsonApiWorkspaceAutomationOutAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
|
|
7814
|
-
export interface JsonApiWorkspaceAutomationOutAttributesAlert {
|
|
7815
|
-
'execution': AlertAfm;
|
|
7816
|
-
'condition': AlertCondition;
|
|
7817
|
-
/**
|
|
7818
|
-
* 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.
|
|
7819
|
-
*/
|
|
7820
|
-
'trigger'?: JsonApiWorkspaceAutomationOutAttributesAlertTriggerEnum;
|
|
7821
|
-
/**
|
|
7822
|
-
* Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.
|
|
7823
|
-
*/
|
|
7824
|
-
'interval'?: JsonApiWorkspaceAutomationOutAttributesAlertIntervalEnum;
|
|
7825
|
-
}
|
|
7826
|
-
export type JsonApiWorkspaceAutomationOutAttributesAlertTriggerEnum = 'ALWAYS' | 'ONCE' | 'ONCE_PER_INTERVAL';
|
|
7827
|
-
export type JsonApiWorkspaceAutomationOutAttributesAlertIntervalEnum = 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
|
|
7828
|
-
export interface JsonApiWorkspaceAutomationOutAttributesDashboardTabularExportsInner {
|
|
7829
|
-
'requestPayload': DashboardTabularExportRequestV2;
|
|
7830
|
-
}
|
|
7831
|
-
export interface JsonApiWorkspaceAutomationOutAttributesExternalRecipientsInner {
|
|
7832
|
-
/**
|
|
7833
|
-
* E-mail address to send notifications from.
|
|
7834
|
-
*/
|
|
7835
|
-
'email': string;
|
|
7836
|
-
}
|
|
7837
|
-
export interface JsonApiWorkspaceAutomationOutAttributesImageExportsInner {
|
|
7838
|
-
'requestPayload': ImageExportRequest;
|
|
7839
|
-
}
|
|
7840
|
-
/**
|
|
7841
|
-
* Additional information for the automation.
|
|
7842
|
-
*/
|
|
7843
|
-
export interface JsonApiWorkspaceAutomationOutAttributesMetadata {
|
|
7844
|
-
[key: string]: any;
|
|
7845
|
-
'widget'?: string;
|
|
7846
|
-
'visibleFilters'?: Array<VisibleFilter>;
|
|
7847
|
-
}
|
|
7848
|
-
export interface JsonApiWorkspaceAutomationOutAttributesRawExportsInner {
|
|
7849
|
-
'requestPayload': RawExportAutomationRequest;
|
|
7850
|
-
}
|
|
7851
|
-
export interface JsonApiWorkspaceAutomationOutAttributesSchedule {
|
|
7852
|
-
/**
|
|
7853
|
-
* 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.
|
|
7854
|
-
*/
|
|
7855
|
-
'cron': string;
|
|
7856
|
-
/**
|
|
7857
|
-
* Human-readable description of the cron expression.
|
|
7858
|
-
*/
|
|
7859
|
-
'cronDescription'?: string;
|
|
7860
|
-
/**
|
|
7861
|
-
* Timezone in which the schedule is defined.
|
|
7862
|
-
*/
|
|
7863
|
-
'timezone': string;
|
|
7864
|
-
/**
|
|
7865
|
-
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
7866
|
-
*/
|
|
7867
|
-
'firstRun'?: string;
|
|
7868
|
-
}
|
|
7869
|
-
export interface JsonApiWorkspaceAutomationOutAttributesSlidesExportsInner {
|
|
7870
|
-
'requestPayload': SlidesExportRequest;
|
|
7871
|
-
}
|
|
7872
|
-
export interface JsonApiWorkspaceAutomationOutAttributesTabularExportsInner {
|
|
7873
|
-
'requestPayload': TabularExportRequest;
|
|
7874
|
-
}
|
|
7875
|
-
export interface JsonApiWorkspaceAutomationOutAttributesVisualExportsInner {
|
|
7876
|
-
'requestPayload': VisualExportRequest;
|
|
7877
|
-
}
|
|
7878
7894
|
/**
|
|
7879
7895
|
* @type JsonApiWorkspaceAutomationOutIncludes
|
|
7880
7896
|
*/
|
|
@@ -7885,45 +7901,21 @@ export type JsonApiWorkspaceAutomationOutIncludes = JsonApiAnalyticalDashboardOu
|
|
|
7885
7901
|
export interface JsonApiWorkspaceAutomationOutList {
|
|
7886
7902
|
'data': Array<JsonApiWorkspaceAutomationOutWithLinks>;
|
|
7887
7903
|
'links'?: ListLinks;
|
|
7888
|
-
'meta'?:
|
|
7904
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
7889
7905
|
/**
|
|
7890
7906
|
* Included resources
|
|
7891
7907
|
*/
|
|
7892
7908
|
'included'?: Array<JsonApiWorkspaceAutomationOutIncludes>;
|
|
7893
7909
|
}
|
|
7894
|
-
export interface JsonApiWorkspaceAutomationOutListMeta {
|
|
7895
|
-
'page'?: PageMetadata;
|
|
7896
|
-
}
|
|
7897
7910
|
export interface JsonApiWorkspaceAutomationOutRelationships {
|
|
7898
|
-
'workspace'?:
|
|
7899
|
-
'notificationChannel'?:
|
|
7900
|
-
'analyticalDashboard'?:
|
|
7901
|
-
'createdBy'?:
|
|
7902
|
-
'modifiedBy'?:
|
|
7903
|
-
'exportDefinitions'?:
|
|
7904
|
-
'recipients'?:
|
|
7905
|
-
'automationResults'?:
|
|
7906
|
-
}
|
|
7907
|
-
export interface JsonApiWorkspaceAutomationOutRelationshipsAutomationResults {
|
|
7908
|
-
/**
|
|
7909
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7910
|
-
*/
|
|
7911
|
-
'data': Array<JsonApiAutomationResultLinkage>;
|
|
7912
|
-
}
|
|
7913
|
-
export interface JsonApiWorkspaceAutomationOutRelationshipsExportDefinitions {
|
|
7914
|
-
/**
|
|
7915
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7916
|
-
*/
|
|
7917
|
-
'data': Array<JsonApiExportDefinitionLinkage>;
|
|
7918
|
-
}
|
|
7919
|
-
export interface JsonApiWorkspaceAutomationOutRelationshipsNotificationChannel {
|
|
7920
|
-
'data': JsonApiNotificationChannelLinkage | null;
|
|
7921
|
-
}
|
|
7922
|
-
export interface JsonApiWorkspaceAutomationOutRelationshipsRecipients {
|
|
7923
|
-
/**
|
|
7924
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7925
|
-
*/
|
|
7926
|
-
'data': Array<JsonApiUserLinkage>;
|
|
7911
|
+
'workspace'?: JsonApiWorkspacePatchRelationshipsParent;
|
|
7912
|
+
'notificationChannel'?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
7913
|
+
'analyticalDashboard'?: JsonApiAutomationOutRelationshipsAnalyticalDashboard;
|
|
7914
|
+
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
7915
|
+
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
7916
|
+
'exportDefinitions'?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
7917
|
+
'recipients'?: JsonApiAutomationOutRelationshipsRecipients;
|
|
7918
|
+
'automationResults'?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
7927
7919
|
}
|
|
7928
7920
|
export interface JsonApiWorkspaceAutomationOutWithLinks {
|
|
7929
7921
|
/**
|
|
@@ -7978,7 +7970,7 @@ export interface JsonApiWorkspaceDataFilterOut {
|
|
|
7978
7970
|
* API identifier of an object
|
|
7979
7971
|
*/
|
|
7980
7972
|
'id': string;
|
|
7981
|
-
'meta'?:
|
|
7973
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
7982
7974
|
'attributes'?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
7983
7975
|
'relationships'?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
7984
7976
|
}
|
|
@@ -8002,7 +7994,7 @@ export interface JsonApiWorkspaceDataFilterOutDocument {
|
|
|
8002
7994
|
export interface JsonApiWorkspaceDataFilterOutList {
|
|
8003
7995
|
'data': Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
8004
7996
|
'links'?: ListLinks;
|
|
8005
|
-
'meta'?:
|
|
7997
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
8006
7998
|
/**
|
|
8007
7999
|
* Included resources
|
|
8008
8000
|
*/
|
|
@@ -8026,7 +8018,7 @@ export interface JsonApiWorkspaceDataFilterOutWithLinks {
|
|
|
8026
8018
|
* API identifier of an object
|
|
8027
8019
|
*/
|
|
8028
8020
|
'id': string;
|
|
8029
|
-
'meta'?:
|
|
8021
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
8030
8022
|
'attributes'?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
8031
8023
|
'relationships'?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
8032
8024
|
'links'?: ObjectLinks;
|
|
@@ -8090,7 +8082,7 @@ export interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
8090
8082
|
* API identifier of an object
|
|
8091
8083
|
*/
|
|
8092
8084
|
'id': string;
|
|
8093
|
-
'meta'?:
|
|
8085
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
8094
8086
|
'attributes'?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
8095
8087
|
'relationships'?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
8096
8088
|
}
|
|
@@ -8114,7 +8106,7 @@ export interface JsonApiWorkspaceDataFilterSettingOutDocument {
|
|
|
8114
8106
|
export interface JsonApiWorkspaceDataFilterSettingOutList {
|
|
8115
8107
|
'data': Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>;
|
|
8116
8108
|
'links'?: ListLinks;
|
|
8117
|
-
'meta'?:
|
|
8109
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
8118
8110
|
/**
|
|
8119
8111
|
* Included resources
|
|
8120
8112
|
*/
|
|
@@ -8135,7 +8127,7 @@ export interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
8135
8127
|
* API identifier of an object
|
|
8136
8128
|
*/
|
|
8137
8129
|
'id': string;
|
|
8138
|
-
'meta'?:
|
|
8130
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
8139
8131
|
'attributes'?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
8140
8132
|
'relationships'?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
8141
8133
|
'links'?: ObjectLinks;
|
|
@@ -8172,8 +8164,8 @@ export interface JsonApiWorkspaceIn {
|
|
|
8172
8164
|
* API identifier of an object
|
|
8173
8165
|
*/
|
|
8174
8166
|
'id': string;
|
|
8175
|
-
'attributes'?:
|
|
8176
|
-
'relationships'?:
|
|
8167
|
+
'attributes'?: JsonApiWorkspacePatchAttributes;
|
|
8168
|
+
'relationships'?: JsonApiWorkspacePatchRelationships;
|
|
8177
8169
|
}
|
|
8178
8170
|
export type JsonApiWorkspaceInTypeEnum = 'workspace';
|
|
8179
8171
|
export interface JsonApiWorkspaceInDocument {
|
|
@@ -8200,42 +8192,10 @@ export interface JsonApiWorkspaceOut {
|
|
|
8200
8192
|
*/
|
|
8201
8193
|
'id': string;
|
|
8202
8194
|
'meta'?: JsonApiWorkspaceOutMeta;
|
|
8203
|
-
'attributes'?:
|
|
8204
|
-
'relationships'?:
|
|
8195
|
+
'attributes'?: JsonApiWorkspacePatchAttributes;
|
|
8196
|
+
'relationships'?: JsonApiWorkspacePatchRelationships;
|
|
8205
8197
|
}
|
|
8206
8198
|
export type JsonApiWorkspaceOutTypeEnum = 'workspace';
|
|
8207
|
-
export interface JsonApiWorkspaceOutAttributes {
|
|
8208
|
-
'name'?: string | null;
|
|
8209
|
-
/**
|
|
8210
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
8211
|
-
* @deprecated
|
|
8212
|
-
*/
|
|
8213
|
-
'earlyAccess'?: string | null;
|
|
8214
|
-
/**
|
|
8215
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
8216
|
-
*/
|
|
8217
|
-
'earlyAccessValues'?: Array<string> | null;
|
|
8218
|
-
'description'?: string | null;
|
|
8219
|
-
/**
|
|
8220
|
-
* Custom prefix of entity identifiers in workspace
|
|
8221
|
-
*/
|
|
8222
|
-
'prefix'?: string | null;
|
|
8223
|
-
'cacheExtraLimit'?: number;
|
|
8224
|
-
'dataSource'?: JsonApiWorkspaceOutAttributesDataSource;
|
|
8225
|
-
}
|
|
8226
|
-
/**
|
|
8227
|
-
* 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.
|
|
8228
|
-
*/
|
|
8229
|
-
export interface JsonApiWorkspaceOutAttributesDataSource {
|
|
8230
|
-
/**
|
|
8231
|
-
* The ID of the used data source.
|
|
8232
|
-
*/
|
|
8233
|
-
'id': string;
|
|
8234
|
-
/**
|
|
8235
|
-
* The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
|
|
8236
|
-
*/
|
|
8237
|
-
'schemaPath'?: Array<string>;
|
|
8238
|
-
}
|
|
8239
8199
|
export interface JsonApiWorkspaceOutDocument {
|
|
8240
8200
|
'data': JsonApiWorkspaceOut;
|
|
8241
8201
|
'links'?: ObjectLinks;
|
|
@@ -8250,7 +8210,7 @@ export interface JsonApiWorkspaceOutDocument {
|
|
|
8250
8210
|
export interface JsonApiWorkspaceOutList {
|
|
8251
8211
|
'data': Array<JsonApiWorkspaceOutWithLinks>;
|
|
8252
8212
|
'links'?: ListLinks;
|
|
8253
|
-
'meta'?:
|
|
8213
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
8254
8214
|
/**
|
|
8255
8215
|
* Included resources
|
|
8256
8216
|
*/
|
|
@@ -8292,12 +8252,6 @@ export interface JsonApiWorkspaceOutMetaHierarchy {
|
|
|
8292
8252
|
*/
|
|
8293
8253
|
'childrenCount': number;
|
|
8294
8254
|
}
|
|
8295
|
-
export interface JsonApiWorkspaceOutRelationships {
|
|
8296
|
-
'parent'?: JsonApiWorkspaceOutRelationshipsParent;
|
|
8297
|
-
}
|
|
8298
|
-
export interface JsonApiWorkspaceOutRelationshipsParent {
|
|
8299
|
-
'data': JsonApiWorkspaceLinkage | null;
|
|
8300
|
-
}
|
|
8301
8255
|
export interface JsonApiWorkspaceOutWithLinks {
|
|
8302
8256
|
/**
|
|
8303
8257
|
* Object type
|
|
@@ -8308,8 +8262,8 @@ export interface JsonApiWorkspaceOutWithLinks {
|
|
|
8308
8262
|
*/
|
|
8309
8263
|
'id': string;
|
|
8310
8264
|
'meta'?: JsonApiWorkspaceOutMeta;
|
|
8311
|
-
'attributes'?:
|
|
8312
|
-
'relationships'?:
|
|
8265
|
+
'attributes'?: JsonApiWorkspacePatchAttributes;
|
|
8266
|
+
'relationships'?: JsonApiWorkspacePatchRelationships;
|
|
8313
8267
|
'links'?: ObjectLinks;
|
|
8314
8268
|
}
|
|
8315
8269
|
export type JsonApiWorkspaceOutWithLinksTypeEnum = 'workspace';
|
|
@@ -8325,13 +8279,51 @@ export interface JsonApiWorkspacePatch {
|
|
|
8325
8279
|
* API identifier of an object
|
|
8326
8280
|
*/
|
|
8327
8281
|
'id': string;
|
|
8328
|
-
'attributes'?:
|
|
8329
|
-
'relationships'?:
|
|
8282
|
+
'attributes'?: JsonApiWorkspacePatchAttributes;
|
|
8283
|
+
'relationships'?: JsonApiWorkspacePatchRelationships;
|
|
8330
8284
|
}
|
|
8331
8285
|
export type JsonApiWorkspacePatchTypeEnum = 'workspace';
|
|
8286
|
+
export interface JsonApiWorkspacePatchAttributes {
|
|
8287
|
+
'name'?: string | null;
|
|
8288
|
+
/**
|
|
8289
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
8290
|
+
* @deprecated
|
|
8291
|
+
*/
|
|
8292
|
+
'earlyAccess'?: string | null;
|
|
8293
|
+
/**
|
|
8294
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
8295
|
+
*/
|
|
8296
|
+
'earlyAccessValues'?: Array<string> | null;
|
|
8297
|
+
'description'?: string | null;
|
|
8298
|
+
/**
|
|
8299
|
+
* Custom prefix of entity identifiers in workspace
|
|
8300
|
+
*/
|
|
8301
|
+
'prefix'?: string | null;
|
|
8302
|
+
'cacheExtraLimit'?: number;
|
|
8303
|
+
'dataSource'?: JsonApiWorkspacePatchAttributesDataSource;
|
|
8304
|
+
}
|
|
8305
|
+
/**
|
|
8306
|
+
* 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.
|
|
8307
|
+
*/
|
|
8308
|
+
export interface JsonApiWorkspacePatchAttributesDataSource {
|
|
8309
|
+
/**
|
|
8310
|
+
* The ID of the used data source.
|
|
8311
|
+
*/
|
|
8312
|
+
'id': string;
|
|
8313
|
+
/**
|
|
8314
|
+
* The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
|
|
8315
|
+
*/
|
|
8316
|
+
'schemaPath'?: Array<string>;
|
|
8317
|
+
}
|
|
8332
8318
|
export interface JsonApiWorkspacePatchDocument {
|
|
8333
8319
|
'data': JsonApiWorkspacePatch;
|
|
8334
8320
|
}
|
|
8321
|
+
export interface JsonApiWorkspacePatchRelationships {
|
|
8322
|
+
'parent'?: JsonApiWorkspacePatchRelationshipsParent;
|
|
8323
|
+
}
|
|
8324
|
+
export interface JsonApiWorkspacePatchRelationshipsParent {
|
|
8325
|
+
'data': JsonApiWorkspaceLinkage | null;
|
|
8326
|
+
}
|
|
8335
8327
|
/**
|
|
8336
8328
|
* JSON:API representation of workspaceSetting entity.
|
|
8337
8329
|
*/
|
|
@@ -8344,7 +8336,7 @@ export interface JsonApiWorkspaceSettingIn {
|
|
|
8344
8336
|
* API identifier of an object
|
|
8345
8337
|
*/
|
|
8346
8338
|
'id': string;
|
|
8347
|
-
'attributes'?:
|
|
8339
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
8348
8340
|
}
|
|
8349
8341
|
export type JsonApiWorkspaceSettingInTypeEnum = 'workspaceSetting';
|
|
8350
8342
|
export interface JsonApiWorkspaceSettingInDocument {
|
|
@@ -8362,10 +8354,18 @@ export interface JsonApiWorkspaceSettingOut {
|
|
|
8362
8354
|
* API identifier of an object
|
|
8363
8355
|
*/
|
|
8364
8356
|
'id': string;
|
|
8365
|
-
'meta'?:
|
|
8366
|
-
'attributes'?:
|
|
8357
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
8358
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
8367
8359
|
}
|
|
8368
8360
|
export type JsonApiWorkspaceSettingOutTypeEnum = 'workspaceSetting';
|
|
8361
|
+
export interface JsonApiWorkspaceSettingOutAttributes {
|
|
8362
|
+
/**
|
|
8363
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
8364
|
+
*/
|
|
8365
|
+
'content'?: object;
|
|
8366
|
+
'type'?: JsonApiWorkspaceSettingOutAttributesTypeEnum;
|
|
8367
|
+
}
|
|
8368
|
+
export type JsonApiWorkspaceSettingOutAttributesTypeEnum = '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';
|
|
8369
8369
|
export interface JsonApiWorkspaceSettingOutDocument {
|
|
8370
8370
|
'data': JsonApiWorkspaceSettingOut;
|
|
8371
8371
|
'links'?: ObjectLinks;
|
|
@@ -8376,7 +8376,7 @@ export interface JsonApiWorkspaceSettingOutDocument {
|
|
|
8376
8376
|
export interface JsonApiWorkspaceSettingOutList {
|
|
8377
8377
|
'data': Array<JsonApiWorkspaceSettingOutWithLinks>;
|
|
8378
8378
|
'links'?: ListLinks;
|
|
8379
|
-
'meta'?:
|
|
8379
|
+
'meta'?: JsonApiAggregatedFactOutListMeta;
|
|
8380
8380
|
}
|
|
8381
8381
|
export interface JsonApiWorkspaceSettingOutWithLinks {
|
|
8382
8382
|
/**
|
|
@@ -8387,8 +8387,8 @@ export interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
8387
8387
|
* API identifier of an object
|
|
8388
8388
|
*/
|
|
8389
8389
|
'id': string;
|
|
8390
|
-
'meta'?:
|
|
8391
|
-
'attributes'?:
|
|
8390
|
+
'meta'?: JsonApiDatasetOutMeta;
|
|
8391
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
8392
8392
|
'links'?: ObjectLinks;
|
|
8393
8393
|
}
|
|
8394
8394
|
export type JsonApiWorkspaceSettingOutWithLinksTypeEnum = 'workspaceSetting';
|
|
@@ -8404,7 +8404,7 @@ export interface JsonApiWorkspaceSettingPatch {
|
|
|
8404
8404
|
* API identifier of an object
|
|
8405
8405
|
*/
|
|
8406
8406
|
'id': string;
|
|
8407
|
-
'attributes'?:
|
|
8407
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
8408
8408
|
}
|
|
8409
8409
|
export type JsonApiWorkspaceSettingPatchTypeEnum = 'workspaceSetting';
|
|
8410
8410
|
export interface JsonApiWorkspaceSettingPatchDocument {
|
|
@@ -8422,7 +8422,7 @@ export interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
8422
8422
|
* API identifier of an object
|
|
8423
8423
|
*/
|
|
8424
8424
|
'id'?: string;
|
|
8425
|
-
'attributes'?:
|
|
8425
|
+
'attributes'?: JsonApiWorkspaceSettingOutAttributes;
|
|
8426
8426
|
}
|
|
8427
8427
|
export type JsonApiWorkspaceSettingPostOptionalIdTypeEnum = 'workspaceSetting';
|
|
8428
8428
|
export interface JsonApiWorkspaceSettingPostOptionalIdDocument {
|
|
@@ -8476,6 +8476,34 @@ export interface LocaleRequest {
|
|
|
8476
8476
|
* @type ManageDashboardPermissionsRequestInner
|
|
8477
8477
|
*/
|
|
8478
8478
|
export type ManageDashboardPermissionsRequestInner = PermissionsForAssignee | PermissionsForAssigneeRule;
|
|
8479
|
+
/**
|
|
8480
|
+
* Filter via label with given match type and literal value.
|
|
8481
|
+
*/
|
|
8482
|
+
export interface MatchAttributeFilter {
|
|
8483
|
+
'matchAttributeFilter': MatchAttributeFilterMatchAttributeFilter;
|
|
8484
|
+
}
|
|
8485
|
+
export interface MatchAttributeFilterMatchAttributeFilter {
|
|
8486
|
+
/**
|
|
8487
|
+
* Literal used to limit label values.
|
|
8488
|
+
*/
|
|
8489
|
+
'literal': string;
|
|
8490
|
+
/**
|
|
8491
|
+
* Requested match type.
|
|
8492
|
+
*/
|
|
8493
|
+
'matchType': MatchAttributeFilterMatchAttributeFilterMatchTypeEnum;
|
|
8494
|
+
/**
|
|
8495
|
+
* Indicates whether the filter should negate the match.
|
|
8496
|
+
*/
|
|
8497
|
+
'negate'?: boolean;
|
|
8498
|
+
/**
|
|
8499
|
+
* Indicates whether the filter match is evaluated in case-sensitive mode or not.
|
|
8500
|
+
*/
|
|
8501
|
+
'caseSensitive'?: boolean;
|
|
8502
|
+
'localIdentifier'?: string;
|
|
8503
|
+
'applyOnResult'?: boolean;
|
|
8504
|
+
'label': AfmIdentifier;
|
|
8505
|
+
}
|
|
8506
|
+
export type MatchAttributeFilterMatchAttributeFilterMatchTypeEnum = 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS';
|
|
8479
8507
|
/**
|
|
8480
8508
|
* @type MeasureDefinition
|
|
8481
8509
|
* Abstract metric definition type
|