@gooddata/api-client-tiger 11.23.0-alpha.1 → 11.23.0-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +887 -812
- package/esm/generated/afm-rest-api/api.d.ts +117 -1
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +55 -0
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +748 -748
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/result-json-api/api.d.ts +14 -14
- package/esm/generated/result-json-api/api.js +10 -10
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js.map +1 -1
- package/package.json +5 -5
|
@@ -2927,7 +2927,7 @@ export interface JsonApiAggregatedFactOut {
|
|
|
2927
2927
|
* API identifier of an object
|
|
2928
2928
|
*/
|
|
2929
2929
|
'id': string;
|
|
2930
|
-
'meta'?:
|
|
2930
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
2931
2931
|
'attributes': JsonApiAggregatedFactOutAttributes;
|
|
2932
2932
|
'relationships'?: JsonApiAggregatedFactOutRelationships;
|
|
2933
2933
|
}
|
|
@@ -2962,17 +2962,14 @@ export type JsonApiAggregatedFactOutIncludes = JsonApiDatasetOutWithLinks | Json
|
|
|
2962
2962
|
export interface JsonApiAggregatedFactOutList {
|
|
2963
2963
|
'data': Array<JsonApiAggregatedFactOutWithLinks>;
|
|
2964
2964
|
'links'?: ListLinks;
|
|
2965
|
-
'meta'?:
|
|
2965
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
2966
2966
|
/**
|
|
2967
2967
|
* Included resources
|
|
2968
2968
|
*/
|
|
2969
2969
|
'included'?: Array<JsonApiAggregatedFactOutIncludes>;
|
|
2970
2970
|
}
|
|
2971
|
-
export interface JsonApiAggregatedFactOutListMeta {
|
|
2972
|
-
'page'?: PageMetadata;
|
|
2973
|
-
}
|
|
2974
2971
|
export interface JsonApiAggregatedFactOutRelationships {
|
|
2975
|
-
'dataset'?:
|
|
2972
|
+
'dataset'?: JsonApiAttributeOutRelationshipsDataset;
|
|
2976
2973
|
'sourceFact'?: JsonApiAggregatedFactOutRelationshipsSourceFact;
|
|
2977
2974
|
}
|
|
2978
2975
|
export interface JsonApiAggregatedFactOutRelationshipsSourceFact {
|
|
@@ -2987,7 +2984,7 @@ export interface JsonApiAggregatedFactOutWithLinks {
|
|
|
2987
2984
|
* API identifier of an object
|
|
2988
2985
|
*/
|
|
2989
2986
|
'id': string;
|
|
2990
|
-
'meta'?:
|
|
2987
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
2991
2988
|
'attributes': JsonApiAggregatedFactOutAttributes;
|
|
2992
2989
|
'relationships'?: JsonApiAggregatedFactOutRelationships;
|
|
2993
2990
|
'links'?: ObjectLinks;
|
|
@@ -3005,9 +3002,23 @@ export interface JsonApiAnalyticalDashboardIn {
|
|
|
3005
3002
|
* API identifier of an object
|
|
3006
3003
|
*/
|
|
3007
3004
|
'id': string;
|
|
3008
|
-
'attributes':
|
|
3005
|
+
'attributes': JsonApiAnalyticalDashboardInAttributes;
|
|
3009
3006
|
}
|
|
3010
3007
|
export type JsonApiAnalyticalDashboardInTypeEnum = 'analyticalDashboard';
|
|
3008
|
+
export interface JsonApiAnalyticalDashboardInAttributes {
|
|
3009
|
+
'title'?: string;
|
|
3010
|
+
'description'?: string;
|
|
3011
|
+
'tags'?: Array<string>;
|
|
3012
|
+
'areRelationsValid'?: boolean;
|
|
3013
|
+
/**
|
|
3014
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
3015
|
+
*/
|
|
3016
|
+
'content': object;
|
|
3017
|
+
/**
|
|
3018
|
+
* AI-generated summary of the dashboard content
|
|
3019
|
+
*/
|
|
3020
|
+
'summary'?: string;
|
|
3021
|
+
}
|
|
3011
3022
|
export interface JsonApiAnalyticalDashboardInDocument {
|
|
3012
3023
|
'data': JsonApiAnalyticalDashboardIn;
|
|
3013
3024
|
}
|
|
@@ -3089,7 +3100,7 @@ export type JsonApiAnalyticalDashboardOutIncludes = JsonApiAnalyticalDashboardOu
|
|
|
3089
3100
|
export interface JsonApiAnalyticalDashboardOutList {
|
|
3090
3101
|
'data': Array<JsonApiAnalyticalDashboardOutWithLinks>;
|
|
3091
3102
|
'links'?: ListLinks;
|
|
3092
|
-
'meta'?:
|
|
3103
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
3093
3104
|
/**
|
|
3094
3105
|
* Included resources
|
|
3095
3106
|
*/
|
|
@@ -3100,7 +3111,7 @@ export interface JsonApiAnalyticalDashboardOutMeta {
|
|
|
3100
3111
|
* List of valid permissions for a logged-in user.
|
|
3101
3112
|
*/
|
|
3102
3113
|
'permissions'?: Array<JsonApiAnalyticalDashboardOutMetaPermissionsEnum>;
|
|
3103
|
-
'origin'?:
|
|
3114
|
+
'origin'?: JsonApiVisualizationObjectOutMetaOrigin;
|
|
3104
3115
|
'accessInfo'?: JsonApiAnalyticalDashboardOutMetaAccessInfo;
|
|
3105
3116
|
}
|
|
3106
3117
|
export type JsonApiAnalyticalDashboardOutMetaPermissionsEnum = 'EDIT' | 'SHARE' | 'VIEW';
|
|
@@ -3118,7 +3129,7 @@ export interface JsonApiAnalyticalDashboardOutRelationships {
|
|
|
3118
3129
|
'analyticalDashboards'?: JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards;
|
|
3119
3130
|
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
3120
3131
|
'metrics'?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
3121
|
-
'datasets'?:
|
|
3132
|
+
'datasets'?: JsonApiVisualizationObjectOutRelationshipsDatasets;
|
|
3122
3133
|
'filterContexts'?: JsonApiAnalyticalDashboardOutRelationshipsFilterContexts;
|
|
3123
3134
|
'dashboardPlugins'?: JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins;
|
|
3124
3135
|
}
|
|
@@ -3205,23 +3216,9 @@ export interface JsonApiAnalyticalDashboardPostOptionalId {
|
|
|
3205
3216
|
* API identifier of an object
|
|
3206
3217
|
*/
|
|
3207
3218
|
'id'?: string;
|
|
3208
|
-
'attributes':
|
|
3219
|
+
'attributes': JsonApiAnalyticalDashboardInAttributes;
|
|
3209
3220
|
}
|
|
3210
3221
|
export type JsonApiAnalyticalDashboardPostOptionalIdTypeEnum = 'analyticalDashboard';
|
|
3211
|
-
export interface JsonApiAnalyticalDashboardPostOptionalIdAttributes {
|
|
3212
|
-
'title'?: string;
|
|
3213
|
-
'description'?: string;
|
|
3214
|
-
'tags'?: Array<string>;
|
|
3215
|
-
'areRelationsValid'?: boolean;
|
|
3216
|
-
/**
|
|
3217
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
3218
|
-
*/
|
|
3219
|
-
'content': object;
|
|
3220
|
-
/**
|
|
3221
|
-
* AI-generated summary of the dashboard content
|
|
3222
|
-
*/
|
|
3223
|
-
'summary'?: string;
|
|
3224
|
-
}
|
|
3225
3222
|
export interface JsonApiAnalyticalDashboardPostOptionalIdDocument {
|
|
3226
3223
|
'data': JsonApiAnalyticalDashboardPostOptionalId;
|
|
3227
3224
|
}
|
|
@@ -3273,7 +3270,10 @@ export interface JsonApiApiTokenOutDocument {
|
|
|
3273
3270
|
export interface JsonApiApiTokenOutList {
|
|
3274
3271
|
'data': Array<JsonApiApiTokenOutWithLinks>;
|
|
3275
3272
|
'links'?: ListLinks;
|
|
3276
|
-
'meta'?:
|
|
3273
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
3274
|
+
}
|
|
3275
|
+
export interface JsonApiApiTokenOutListMeta {
|
|
3276
|
+
'page'?: PageMetadata;
|
|
3277
3277
|
}
|
|
3278
3278
|
export interface JsonApiApiTokenOutWithLinks {
|
|
3279
3279
|
/**
|
|
@@ -3326,7 +3326,7 @@ export interface JsonApiAttributeHierarchyOut {
|
|
|
3326
3326
|
* API identifier of an object
|
|
3327
3327
|
*/
|
|
3328
3328
|
'id': string;
|
|
3329
|
-
'meta'?:
|
|
3329
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
3330
3330
|
'attributes'?: JsonApiAttributeHierarchyOutAttributes;
|
|
3331
3331
|
'relationships'?: JsonApiAttributeHierarchyOutRelationships;
|
|
3332
3332
|
}
|
|
@@ -3367,7 +3367,7 @@ export type JsonApiAttributeHierarchyOutIncludes = JsonApiAttributeOutWithLinks
|
|
|
3367
3367
|
export interface JsonApiAttributeHierarchyOutList {
|
|
3368
3368
|
'data': Array<JsonApiAttributeHierarchyOutWithLinks>;
|
|
3369
3369
|
'links'?: ListLinks;
|
|
3370
|
-
'meta'?:
|
|
3370
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
3371
3371
|
/**
|
|
3372
3372
|
* Included resources
|
|
3373
3373
|
*/
|
|
@@ -3376,7 +3376,7 @@ export interface JsonApiAttributeHierarchyOutList {
|
|
|
3376
3376
|
export interface JsonApiAttributeHierarchyOutRelationships {
|
|
3377
3377
|
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3378
3378
|
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3379
|
-
'attributes'?:
|
|
3379
|
+
'attributes'?: JsonApiVisualizationObjectOutRelationshipsAttributes;
|
|
3380
3380
|
}
|
|
3381
3381
|
export interface JsonApiAttributeHierarchyOutWithLinks {
|
|
3382
3382
|
/**
|
|
@@ -3387,7 +3387,7 @@ export interface JsonApiAttributeHierarchyOutWithLinks {
|
|
|
3387
3387
|
* API identifier of an object
|
|
3388
3388
|
*/
|
|
3389
3389
|
'id': string;
|
|
3390
|
-
'meta'?:
|
|
3390
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
3391
3391
|
'attributes'?: JsonApiAttributeHierarchyOutAttributes;
|
|
3392
3392
|
'relationships'?: JsonApiAttributeHierarchyOutRelationships;
|
|
3393
3393
|
'links'?: ObjectLinks;
|
|
@@ -3441,7 +3441,7 @@ export interface JsonApiAttributeOut {
|
|
|
3441
3441
|
* API identifier of an object
|
|
3442
3442
|
*/
|
|
3443
3443
|
'id': string;
|
|
3444
|
-
'meta'?:
|
|
3444
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
3445
3445
|
'attributes'?: JsonApiAttributeOutAttributes;
|
|
3446
3446
|
'relationships'?: JsonApiAttributeOutRelationships;
|
|
3447
3447
|
}
|
|
@@ -3482,14 +3482,14 @@ export type JsonApiAttributeOutIncludes = JsonApiAttributeHierarchyOutWithLinks
|
|
|
3482
3482
|
export interface JsonApiAttributeOutList {
|
|
3483
3483
|
'data': Array<JsonApiAttributeOutWithLinks>;
|
|
3484
3484
|
'links'?: ListLinks;
|
|
3485
|
-
'meta'?:
|
|
3485
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
3486
3486
|
/**
|
|
3487
3487
|
* Included resources
|
|
3488
3488
|
*/
|
|
3489
3489
|
'included'?: Array<JsonApiAttributeOutIncludes>;
|
|
3490
3490
|
}
|
|
3491
3491
|
export interface JsonApiAttributeOutRelationships {
|
|
3492
|
-
'dataset'?:
|
|
3492
|
+
'dataset'?: JsonApiAttributeOutRelationshipsDataset;
|
|
3493
3493
|
'defaultView'?: JsonApiAttributeOutRelationshipsDefaultView;
|
|
3494
3494
|
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
3495
3495
|
'attributeHierarchies'?: JsonApiAttributeOutRelationshipsAttributeHierarchies;
|
|
@@ -3500,6 +3500,9 @@ export interface JsonApiAttributeOutRelationshipsAttributeHierarchies {
|
|
|
3500
3500
|
*/
|
|
3501
3501
|
'data': Array<JsonApiAttributeHierarchyLinkage>;
|
|
3502
3502
|
}
|
|
3503
|
+
export interface JsonApiAttributeOutRelationshipsDataset {
|
|
3504
|
+
'data': JsonApiDatasetLinkage | null;
|
|
3505
|
+
}
|
|
3503
3506
|
export interface JsonApiAttributeOutRelationshipsDefaultView {
|
|
3504
3507
|
'data': JsonApiLabelLinkage | null;
|
|
3505
3508
|
}
|
|
@@ -3512,7 +3515,7 @@ export interface JsonApiAttributeOutWithLinks {
|
|
|
3512
3515
|
* API identifier of an object
|
|
3513
3516
|
*/
|
|
3514
3517
|
'id': string;
|
|
3515
|
-
'meta'?:
|
|
3518
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
3516
3519
|
'attributes'?: JsonApiAttributeOutAttributes;
|
|
3517
3520
|
'relationships'?: JsonApiAttributeOutRelationships;
|
|
3518
3521
|
'links'?: ObjectLinks;
|
|
@@ -3584,7 +3587,7 @@ export interface JsonApiAutomationOut {
|
|
|
3584
3587
|
* API identifier of an object
|
|
3585
3588
|
*/
|
|
3586
3589
|
'id': string;
|
|
3587
|
-
'meta'?:
|
|
3590
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
3588
3591
|
'attributes'?: JsonApiAutomationOutAttributes;
|
|
3589
3592
|
'relationships'?: JsonApiAutomationOutRelationships;
|
|
3590
3593
|
}
|
|
@@ -3598,7 +3601,7 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
3598
3601
|
* Additional details to be included in the automated message.
|
|
3599
3602
|
*/
|
|
3600
3603
|
'details'?: object;
|
|
3601
|
-
'metadata'?:
|
|
3604
|
+
'metadata'?: JsonApiAutomationPatchAttributesMetadata | null;
|
|
3602
3605
|
/**
|
|
3603
3606
|
* Current state of the automation.
|
|
3604
3607
|
*/
|
|
@@ -3607,18 +3610,18 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
3607
3610
|
* Specify automation evaluation mode.
|
|
3608
3611
|
*/
|
|
3609
3612
|
'evaluationMode'?: JsonApiAutomationOutAttributesEvaluationModeEnum;
|
|
3610
|
-
'schedule'?:
|
|
3611
|
-
'alert'?:
|
|
3612
|
-
'tabularExports'?: Array<
|
|
3613
|
-
'visualExports'?: Array<
|
|
3614
|
-
'imageExports'?: Array<
|
|
3615
|
-
'rawExports'?: Array<
|
|
3616
|
-
'slidesExports'?: Array<
|
|
3617
|
-
'dashboardTabularExports'?: Array<
|
|
3613
|
+
'schedule'?: JsonApiAutomationPatchAttributesSchedule;
|
|
3614
|
+
'alert'?: JsonApiAutomationPatchAttributesAlert;
|
|
3615
|
+
'tabularExports'?: Array<JsonApiAutomationPatchAttributesTabularExportsInner>;
|
|
3616
|
+
'visualExports'?: Array<JsonApiAutomationPatchAttributesVisualExportsInner>;
|
|
3617
|
+
'imageExports'?: Array<JsonApiAutomationPatchAttributesImageExportsInner>;
|
|
3618
|
+
'rawExports'?: Array<JsonApiAutomationPatchAttributesRawExportsInner>;
|
|
3619
|
+
'slidesExports'?: Array<JsonApiAutomationPatchAttributesSlidesExportsInner>;
|
|
3620
|
+
'dashboardTabularExports'?: Array<JsonApiAutomationPatchAttributesDashboardTabularExportsInner>;
|
|
3618
3621
|
/**
|
|
3619
3622
|
* External recipients of the automation action results.
|
|
3620
3623
|
*/
|
|
3621
|
-
'externalRecipients'?: Array<
|
|
3624
|
+
'externalRecipients'?: Array<JsonApiAutomationPatchAttributesExternalRecipientsInner>;
|
|
3622
3625
|
/**
|
|
3623
3626
|
* Time of the entity creation.
|
|
3624
3627
|
*/
|
|
@@ -3630,70 +3633,6 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
3630
3633
|
}
|
|
3631
3634
|
export type JsonApiAutomationOutAttributesStateEnum = 'ACTIVE' | 'PAUSED';
|
|
3632
3635
|
export type JsonApiAutomationOutAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
|
|
3633
|
-
export interface JsonApiAutomationOutAttributesAlert {
|
|
3634
|
-
'execution': AlertAfm;
|
|
3635
|
-
'condition': AlertCondition;
|
|
3636
|
-
/**
|
|
3637
|
-
* 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.
|
|
3638
|
-
*/
|
|
3639
|
-
'trigger'?: JsonApiAutomationOutAttributesAlertTriggerEnum;
|
|
3640
|
-
/**
|
|
3641
|
-
* Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.
|
|
3642
|
-
*/
|
|
3643
|
-
'interval'?: JsonApiAutomationOutAttributesAlertIntervalEnum;
|
|
3644
|
-
}
|
|
3645
|
-
export type JsonApiAutomationOutAttributesAlertTriggerEnum = 'ALWAYS' | 'ONCE' | 'ONCE_PER_INTERVAL';
|
|
3646
|
-
export type JsonApiAutomationOutAttributesAlertIntervalEnum = 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
|
|
3647
|
-
export interface JsonApiAutomationOutAttributesDashboardTabularExportsInner {
|
|
3648
|
-
'requestPayload': DashboardTabularExportRequestV2;
|
|
3649
|
-
}
|
|
3650
|
-
export interface JsonApiAutomationOutAttributesExternalRecipientsInner {
|
|
3651
|
-
/**
|
|
3652
|
-
* E-mail address to send notifications from.
|
|
3653
|
-
*/
|
|
3654
|
-
'email': string;
|
|
3655
|
-
}
|
|
3656
|
-
export interface JsonApiAutomationOutAttributesImageExportsInner {
|
|
3657
|
-
'requestPayload': ImageExportRequest;
|
|
3658
|
-
}
|
|
3659
|
-
/**
|
|
3660
|
-
* Additional information for the automation.
|
|
3661
|
-
*/
|
|
3662
|
-
export interface JsonApiAutomationOutAttributesMetadata {
|
|
3663
|
-
[key: string]: any;
|
|
3664
|
-
'widget'?: string;
|
|
3665
|
-
'visibleFilters'?: Array<VisibleFilter>;
|
|
3666
|
-
}
|
|
3667
|
-
export interface JsonApiAutomationOutAttributesRawExportsInner {
|
|
3668
|
-
'requestPayload': RawExportAutomationRequest;
|
|
3669
|
-
}
|
|
3670
|
-
export interface JsonApiAutomationOutAttributesSchedule {
|
|
3671
|
-
/**
|
|
3672
|
-
* 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.
|
|
3673
|
-
*/
|
|
3674
|
-
'cron': string;
|
|
3675
|
-
/**
|
|
3676
|
-
* Human-readable description of the cron expression.
|
|
3677
|
-
*/
|
|
3678
|
-
'cronDescription'?: string;
|
|
3679
|
-
/**
|
|
3680
|
-
* Timezone in which the schedule is defined.
|
|
3681
|
-
*/
|
|
3682
|
-
'timezone': string;
|
|
3683
|
-
/**
|
|
3684
|
-
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
3685
|
-
*/
|
|
3686
|
-
'firstRun'?: string;
|
|
3687
|
-
}
|
|
3688
|
-
export interface JsonApiAutomationOutAttributesSlidesExportsInner {
|
|
3689
|
-
'requestPayload': SlidesExportRequest;
|
|
3690
|
-
}
|
|
3691
|
-
export interface JsonApiAutomationOutAttributesTabularExportsInner {
|
|
3692
|
-
'requestPayload': TabularExportRequest;
|
|
3693
|
-
}
|
|
3694
|
-
export interface JsonApiAutomationOutAttributesVisualExportsInner {
|
|
3695
|
-
'requestPayload': VisualExportRequest;
|
|
3696
|
-
}
|
|
3697
3636
|
export interface JsonApiAutomationOutDocument {
|
|
3698
3637
|
'data': JsonApiAutomationOut;
|
|
3699
3638
|
'links'?: ObjectLinks;
|
|
@@ -3712,19 +3651,19 @@ export type JsonApiAutomationOutIncludes = JsonApiAnalyticalDashboardOutWithLink
|
|
|
3712
3651
|
export interface JsonApiAutomationOutList {
|
|
3713
3652
|
'data': Array<JsonApiAutomationOutWithLinks>;
|
|
3714
3653
|
'links'?: ListLinks;
|
|
3715
|
-
'meta'?:
|
|
3654
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
3716
3655
|
/**
|
|
3717
3656
|
* Included resources
|
|
3718
3657
|
*/
|
|
3719
3658
|
'included'?: Array<JsonApiAutomationOutIncludes>;
|
|
3720
3659
|
}
|
|
3721
3660
|
export interface JsonApiAutomationOutRelationships {
|
|
3722
|
-
'notificationChannel'?:
|
|
3723
|
-
'analyticalDashboard'?:
|
|
3661
|
+
'notificationChannel'?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
3662
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
3724
3663
|
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3725
3664
|
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3726
|
-
'exportDefinitions'?:
|
|
3727
|
-
'recipients'?:
|
|
3665
|
+
'exportDefinitions'?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
3666
|
+
'recipients'?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
3728
3667
|
'automationResults'?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
3729
3668
|
}
|
|
3730
3669
|
export interface JsonApiAutomationOutRelationshipsAutomationResults {
|
|
@@ -3733,21 +3672,6 @@ export interface JsonApiAutomationOutRelationshipsAutomationResults {
|
|
|
3733
3672
|
*/
|
|
3734
3673
|
'data': Array<JsonApiAutomationResultLinkage>;
|
|
3735
3674
|
}
|
|
3736
|
-
export interface JsonApiAutomationOutRelationshipsExportDefinitions {
|
|
3737
|
-
/**
|
|
3738
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3739
|
-
*/
|
|
3740
|
-
'data': Array<JsonApiExportDefinitionLinkage>;
|
|
3741
|
-
}
|
|
3742
|
-
export interface JsonApiAutomationOutRelationshipsNotificationChannel {
|
|
3743
|
-
'data': JsonApiNotificationChannelLinkage | null;
|
|
3744
|
-
}
|
|
3745
|
-
export interface JsonApiAutomationOutRelationshipsRecipients {
|
|
3746
|
-
/**
|
|
3747
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3748
|
-
*/
|
|
3749
|
-
'data': Array<JsonApiUserLinkage>;
|
|
3750
|
-
}
|
|
3751
3675
|
export interface JsonApiAutomationOutWithLinks {
|
|
3752
3676
|
/**
|
|
3753
3677
|
* Object type
|
|
@@ -3757,7 +3681,7 @@ export interface JsonApiAutomationOutWithLinks {
|
|
|
3757
3681
|
* API identifier of an object
|
|
3758
3682
|
*/
|
|
3759
3683
|
'id': string;
|
|
3760
|
-
'meta'?:
|
|
3684
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
3761
3685
|
'attributes'?: JsonApiAutomationOutAttributes;
|
|
3762
3686
|
'relationships'?: JsonApiAutomationOutRelationships;
|
|
3763
3687
|
'links'?: ObjectLinks;
|
|
@@ -3788,7 +3712,7 @@ export interface JsonApiAutomationPatchAttributes {
|
|
|
3788
3712
|
* Additional details to be included in the automated message.
|
|
3789
3713
|
*/
|
|
3790
3714
|
'details'?: object;
|
|
3791
|
-
'metadata'?:
|
|
3715
|
+
'metadata'?: JsonApiAutomationPatchAttributesMetadata | null;
|
|
3792
3716
|
/**
|
|
3793
3717
|
* Current state of the automation.
|
|
3794
3718
|
*/
|
|
@@ -3797,29 +3721,111 @@ export interface JsonApiAutomationPatchAttributes {
|
|
|
3797
3721
|
* Specify automation evaluation mode.
|
|
3798
3722
|
*/
|
|
3799
3723
|
'evaluationMode'?: JsonApiAutomationPatchAttributesEvaluationModeEnum;
|
|
3800
|
-
'schedule'?:
|
|
3801
|
-
'alert'?:
|
|
3802
|
-
'tabularExports'?: Array<
|
|
3803
|
-
'visualExports'?: Array<
|
|
3804
|
-
'imageExports'?: Array<
|
|
3805
|
-
'rawExports'?: Array<
|
|
3806
|
-
'slidesExports'?: Array<
|
|
3807
|
-
'dashboardTabularExports'?: Array<
|
|
3724
|
+
'schedule'?: JsonApiAutomationPatchAttributesSchedule;
|
|
3725
|
+
'alert'?: JsonApiAutomationPatchAttributesAlert;
|
|
3726
|
+
'tabularExports'?: Array<JsonApiAutomationPatchAttributesTabularExportsInner>;
|
|
3727
|
+
'visualExports'?: Array<JsonApiAutomationPatchAttributesVisualExportsInner>;
|
|
3728
|
+
'imageExports'?: Array<JsonApiAutomationPatchAttributesImageExportsInner>;
|
|
3729
|
+
'rawExports'?: Array<JsonApiAutomationPatchAttributesRawExportsInner>;
|
|
3730
|
+
'slidesExports'?: Array<JsonApiAutomationPatchAttributesSlidesExportsInner>;
|
|
3731
|
+
'dashboardTabularExports'?: Array<JsonApiAutomationPatchAttributesDashboardTabularExportsInner>;
|
|
3808
3732
|
/**
|
|
3809
3733
|
* External recipients of the automation action results.
|
|
3810
3734
|
*/
|
|
3811
|
-
'externalRecipients'?: Array<
|
|
3735
|
+
'externalRecipients'?: Array<JsonApiAutomationPatchAttributesExternalRecipientsInner>;
|
|
3812
3736
|
}
|
|
3813
3737
|
export type JsonApiAutomationPatchAttributesStateEnum = 'ACTIVE' | 'PAUSED';
|
|
3814
3738
|
export type JsonApiAutomationPatchAttributesEvaluationModeEnum = 'SHARED' | 'PER_RECIPIENT';
|
|
3739
|
+
export interface JsonApiAutomationPatchAttributesAlert {
|
|
3740
|
+
'execution': AlertAfm;
|
|
3741
|
+
'condition': AlertCondition;
|
|
3742
|
+
/**
|
|
3743
|
+
* 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.
|
|
3744
|
+
*/
|
|
3745
|
+
'trigger'?: JsonApiAutomationPatchAttributesAlertTriggerEnum;
|
|
3746
|
+
/**
|
|
3747
|
+
* Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.
|
|
3748
|
+
*/
|
|
3749
|
+
'interval'?: JsonApiAutomationPatchAttributesAlertIntervalEnum;
|
|
3750
|
+
}
|
|
3751
|
+
export type JsonApiAutomationPatchAttributesAlertTriggerEnum = 'ALWAYS' | 'ONCE' | 'ONCE_PER_INTERVAL';
|
|
3752
|
+
export type JsonApiAutomationPatchAttributesAlertIntervalEnum = 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
|
|
3753
|
+
export interface JsonApiAutomationPatchAttributesDashboardTabularExportsInner {
|
|
3754
|
+
'requestPayload': DashboardTabularExportRequestV2;
|
|
3755
|
+
}
|
|
3756
|
+
export interface JsonApiAutomationPatchAttributesExternalRecipientsInner {
|
|
3757
|
+
/**
|
|
3758
|
+
* E-mail address to send notifications from.
|
|
3759
|
+
*/
|
|
3760
|
+
'email': string;
|
|
3761
|
+
}
|
|
3762
|
+
export interface JsonApiAutomationPatchAttributesImageExportsInner {
|
|
3763
|
+
'requestPayload': ImageExportRequest;
|
|
3764
|
+
}
|
|
3765
|
+
/**
|
|
3766
|
+
* Additional information for the automation.
|
|
3767
|
+
*/
|
|
3768
|
+
export interface JsonApiAutomationPatchAttributesMetadata {
|
|
3769
|
+
[key: string]: any;
|
|
3770
|
+
'widget'?: string;
|
|
3771
|
+
'visibleFilters'?: Array<VisibleFilter>;
|
|
3772
|
+
}
|
|
3773
|
+
export interface JsonApiAutomationPatchAttributesRawExportsInner {
|
|
3774
|
+
'requestPayload': RawExportAutomationRequest;
|
|
3775
|
+
}
|
|
3776
|
+
export interface JsonApiAutomationPatchAttributesSchedule {
|
|
3777
|
+
/**
|
|
3778
|
+
* 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.
|
|
3779
|
+
*/
|
|
3780
|
+
'cron': string;
|
|
3781
|
+
/**
|
|
3782
|
+
* Human-readable description of the cron expression.
|
|
3783
|
+
*/
|
|
3784
|
+
'cronDescription'?: string;
|
|
3785
|
+
/**
|
|
3786
|
+
* Timezone in which the schedule is defined.
|
|
3787
|
+
*/
|
|
3788
|
+
'timezone': string;
|
|
3789
|
+
/**
|
|
3790
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
3791
|
+
*/
|
|
3792
|
+
'firstRun'?: string;
|
|
3793
|
+
}
|
|
3794
|
+
export interface JsonApiAutomationPatchAttributesSlidesExportsInner {
|
|
3795
|
+
'requestPayload': SlidesExportRequest;
|
|
3796
|
+
}
|
|
3797
|
+
export interface JsonApiAutomationPatchAttributesTabularExportsInner {
|
|
3798
|
+
'requestPayload': TabularExportRequest;
|
|
3799
|
+
}
|
|
3800
|
+
export interface JsonApiAutomationPatchAttributesVisualExportsInner {
|
|
3801
|
+
'requestPayload': VisualExportRequest;
|
|
3802
|
+
}
|
|
3815
3803
|
export interface JsonApiAutomationPatchDocument {
|
|
3816
3804
|
'data': JsonApiAutomationPatch;
|
|
3817
3805
|
}
|
|
3818
3806
|
export interface JsonApiAutomationPatchRelationships {
|
|
3819
|
-
'notificationChannel'?:
|
|
3820
|
-
'analyticalDashboard'?:
|
|
3821
|
-
'exportDefinitions'?:
|
|
3822
|
-
'recipients'?:
|
|
3807
|
+
'notificationChannel'?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
3808
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
3809
|
+
'exportDefinitions'?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
3810
|
+
'recipients'?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
3811
|
+
}
|
|
3812
|
+
export interface JsonApiAutomationPatchRelationshipsAnalyticalDashboard {
|
|
3813
|
+
'data': JsonApiAnalyticalDashboardLinkage | null;
|
|
3814
|
+
}
|
|
3815
|
+
export interface JsonApiAutomationPatchRelationshipsExportDefinitions {
|
|
3816
|
+
/**
|
|
3817
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3818
|
+
*/
|
|
3819
|
+
'data': Array<JsonApiExportDefinitionLinkage>;
|
|
3820
|
+
}
|
|
3821
|
+
export interface JsonApiAutomationPatchRelationshipsNotificationChannel {
|
|
3822
|
+
'data': JsonApiNotificationChannelLinkage | null;
|
|
3823
|
+
}
|
|
3824
|
+
export interface JsonApiAutomationPatchRelationshipsRecipients {
|
|
3825
|
+
/**
|
|
3826
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3827
|
+
*/
|
|
3828
|
+
'data': Array<JsonApiUserLinkage>;
|
|
3823
3829
|
}
|
|
3824
3830
|
/**
|
|
3825
3831
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
@@ -3864,7 +3870,7 @@ export type JsonApiAutomationResultOutAttributesStatusEnum = 'SUCCESS' | 'FAILED
|
|
|
3864
3870
|
export interface JsonApiAutomationResultOutList {
|
|
3865
3871
|
'data': Array<JsonApiAutomationResultOutWithLinks>;
|
|
3866
3872
|
'links'?: ListLinks;
|
|
3867
|
-
'meta'?:
|
|
3873
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
3868
3874
|
/**
|
|
3869
3875
|
* Included resources
|
|
3870
3876
|
*/
|
|
@@ -3937,7 +3943,7 @@ export interface JsonApiColorPaletteOutDocument {
|
|
|
3937
3943
|
export interface JsonApiColorPaletteOutList {
|
|
3938
3944
|
'data': Array<JsonApiColorPaletteOutWithLinks>;
|
|
3939
3945
|
'links'?: ListLinks;
|
|
3940
|
-
'meta'?:
|
|
3946
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
3941
3947
|
}
|
|
3942
3948
|
export interface JsonApiColorPaletteOutWithLinks {
|
|
3943
3949
|
/**
|
|
@@ -3989,7 +3995,7 @@ export interface JsonApiCookieSecurityConfigurationIn {
|
|
|
3989
3995
|
* API identifier of an object
|
|
3990
3996
|
*/
|
|
3991
3997
|
'id': string;
|
|
3992
|
-
'attributes'?:
|
|
3998
|
+
'attributes'?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
3993
3999
|
}
|
|
3994
4000
|
export type JsonApiCookieSecurityConfigurationInTypeEnum = 'cookieSecurityConfiguration';
|
|
3995
4001
|
export interface JsonApiCookieSecurityConfigurationInDocument {
|
|
@@ -4007,9 +4013,16 @@ export interface JsonApiCookieSecurityConfigurationOut {
|
|
|
4007
4013
|
* API identifier of an object
|
|
4008
4014
|
*/
|
|
4009
4015
|
'id': string;
|
|
4010
|
-
'attributes'?:
|
|
4016
|
+
'attributes'?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
4011
4017
|
}
|
|
4012
4018
|
export type JsonApiCookieSecurityConfigurationOutTypeEnum = 'cookieSecurityConfiguration';
|
|
4019
|
+
export interface JsonApiCookieSecurityConfigurationOutAttributes {
|
|
4020
|
+
'lastRotation'?: string;
|
|
4021
|
+
/**
|
|
4022
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
4023
|
+
*/
|
|
4024
|
+
'rotationInterval'?: string;
|
|
4025
|
+
}
|
|
4013
4026
|
export interface JsonApiCookieSecurityConfigurationOutDocument {
|
|
4014
4027
|
'data': JsonApiCookieSecurityConfigurationOut;
|
|
4015
4028
|
'links'?: ObjectLinks;
|
|
@@ -4026,16 +4039,9 @@ export interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
4026
4039
|
* API identifier of an object
|
|
4027
4040
|
*/
|
|
4028
4041
|
'id': string;
|
|
4029
|
-
'attributes'?:
|
|
4042
|
+
'attributes'?: JsonApiCookieSecurityConfigurationOutAttributes;
|
|
4030
4043
|
}
|
|
4031
4044
|
export type JsonApiCookieSecurityConfigurationPatchTypeEnum = 'cookieSecurityConfiguration';
|
|
4032
|
-
export interface JsonApiCookieSecurityConfigurationPatchAttributes {
|
|
4033
|
-
'lastRotation'?: string;
|
|
4034
|
-
/**
|
|
4035
|
-
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
4036
|
-
*/
|
|
4037
|
-
'rotationInterval'?: string;
|
|
4038
|
-
}
|
|
4039
4045
|
export interface JsonApiCookieSecurityConfigurationPatchDocument {
|
|
4040
4046
|
'data': JsonApiCookieSecurityConfigurationPatch;
|
|
4041
4047
|
}
|
|
@@ -4085,7 +4091,7 @@ export interface JsonApiCspDirectiveOutDocument {
|
|
|
4085
4091
|
export interface JsonApiCspDirectiveOutList {
|
|
4086
4092
|
'data': Array<JsonApiCspDirectiveOutWithLinks>;
|
|
4087
4093
|
'links'?: ListLinks;
|
|
4088
|
-
'meta'?:
|
|
4094
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
4089
4095
|
}
|
|
4090
4096
|
export interface JsonApiCspDirectiveOutWithLinks {
|
|
4091
4097
|
/**
|
|
@@ -4151,7 +4157,7 @@ export interface JsonApiCustomApplicationSettingOut {
|
|
|
4151
4157
|
* API identifier of an object
|
|
4152
4158
|
*/
|
|
4153
4159
|
'id': string;
|
|
4154
|
-
'meta'?:
|
|
4160
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
4155
4161
|
'attributes': JsonApiCustomApplicationSettingOutAttributes;
|
|
4156
4162
|
}
|
|
4157
4163
|
export type JsonApiCustomApplicationSettingOutTypeEnum = 'customApplicationSetting';
|
|
@@ -4172,7 +4178,7 @@ export interface JsonApiCustomApplicationSettingOutDocument {
|
|
|
4172
4178
|
export interface JsonApiCustomApplicationSettingOutList {
|
|
4173
4179
|
'data': Array<JsonApiCustomApplicationSettingOutWithLinks>;
|
|
4174
4180
|
'links'?: ListLinks;
|
|
4175
|
-
'meta'?:
|
|
4181
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
4176
4182
|
}
|
|
4177
4183
|
export interface JsonApiCustomApplicationSettingOutWithLinks {
|
|
4178
4184
|
/**
|
|
@@ -4183,7 +4189,7 @@ export interface JsonApiCustomApplicationSettingOutWithLinks {
|
|
|
4183
4189
|
* API identifier of an object
|
|
4184
4190
|
*/
|
|
4185
4191
|
'id': string;
|
|
4186
|
-
'meta'?:
|
|
4192
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
4187
4193
|
'attributes': JsonApiCustomApplicationSettingOutAttributes;
|
|
4188
4194
|
'links'?: ObjectLinks;
|
|
4189
4195
|
}
|
|
@@ -4243,7 +4249,7 @@ export interface JsonApiCustomGeoCollectionIn {
|
|
|
4243
4249
|
* API identifier of an object
|
|
4244
4250
|
*/
|
|
4245
4251
|
'id': string;
|
|
4246
|
-
'attributes'?:
|
|
4252
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
4247
4253
|
}
|
|
4248
4254
|
export type JsonApiCustomGeoCollectionInTypeEnum = 'customGeoCollection';
|
|
4249
4255
|
export interface JsonApiCustomGeoCollectionInDocument {
|
|
@@ -4261,9 +4267,13 @@ export interface JsonApiCustomGeoCollectionOut {
|
|
|
4261
4267
|
* API identifier of an object
|
|
4262
4268
|
*/
|
|
4263
4269
|
'id': string;
|
|
4264
|
-
'attributes'?:
|
|
4270
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
4265
4271
|
}
|
|
4266
4272
|
export type JsonApiCustomGeoCollectionOutTypeEnum = 'customGeoCollection';
|
|
4273
|
+
export interface JsonApiCustomGeoCollectionOutAttributes {
|
|
4274
|
+
'name'?: string | null;
|
|
4275
|
+
'description'?: string | null;
|
|
4276
|
+
}
|
|
4267
4277
|
export interface JsonApiCustomGeoCollectionOutDocument {
|
|
4268
4278
|
'data': JsonApiCustomGeoCollectionOut;
|
|
4269
4279
|
'links'?: ObjectLinks;
|
|
@@ -4274,7 +4284,7 @@ export interface JsonApiCustomGeoCollectionOutDocument {
|
|
|
4274
4284
|
export interface JsonApiCustomGeoCollectionOutList {
|
|
4275
4285
|
'data': Array<JsonApiCustomGeoCollectionOutWithLinks>;
|
|
4276
4286
|
'links'?: ListLinks;
|
|
4277
|
-
'meta'?:
|
|
4287
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
4278
4288
|
}
|
|
4279
4289
|
export interface JsonApiCustomGeoCollectionOutWithLinks {
|
|
4280
4290
|
/**
|
|
@@ -4285,7 +4295,7 @@ export interface JsonApiCustomGeoCollectionOutWithLinks {
|
|
|
4285
4295
|
* API identifier of an object
|
|
4286
4296
|
*/
|
|
4287
4297
|
'id': string;
|
|
4288
|
-
'attributes'?:
|
|
4298
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
4289
4299
|
'links'?: ObjectLinks;
|
|
4290
4300
|
}
|
|
4291
4301
|
export type JsonApiCustomGeoCollectionOutWithLinksTypeEnum = 'customGeoCollection';
|
|
@@ -4301,13 +4311,9 @@ export interface JsonApiCustomGeoCollectionPatch {
|
|
|
4301
4311
|
* API identifier of an object
|
|
4302
4312
|
*/
|
|
4303
4313
|
'id': string;
|
|
4304
|
-
'attributes'?:
|
|
4314
|
+
'attributes'?: JsonApiCustomGeoCollectionOutAttributes;
|
|
4305
4315
|
}
|
|
4306
4316
|
export type JsonApiCustomGeoCollectionPatchTypeEnum = 'customGeoCollection';
|
|
4307
|
-
export interface JsonApiCustomGeoCollectionPatchAttributes {
|
|
4308
|
-
'name'?: string | null;
|
|
4309
|
-
'description'?: string | null;
|
|
4310
|
-
}
|
|
4311
4317
|
export interface JsonApiCustomGeoCollectionPatchDocument {
|
|
4312
4318
|
'data': JsonApiCustomGeoCollectionPatch;
|
|
4313
4319
|
}
|
|
@@ -4349,7 +4355,7 @@ export interface JsonApiDashboardPluginOut {
|
|
|
4349
4355
|
* API identifier of an object
|
|
4350
4356
|
*/
|
|
4351
4357
|
'id': string;
|
|
4352
|
-
'meta'?:
|
|
4358
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
4353
4359
|
'attributes'?: JsonApiDashboardPluginOutAttributes;
|
|
4354
4360
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
4355
4361
|
}
|
|
@@ -4386,7 +4392,7 @@ export interface JsonApiDashboardPluginOutDocument {
|
|
|
4386
4392
|
export interface JsonApiDashboardPluginOutList {
|
|
4387
4393
|
'data': Array<JsonApiDashboardPluginOutWithLinks>;
|
|
4388
4394
|
'links'?: ListLinks;
|
|
4389
|
-
'meta'?:
|
|
4395
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
4390
4396
|
/**
|
|
4391
4397
|
* Included resources
|
|
4392
4398
|
*/
|
|
@@ -4405,7 +4411,7 @@ export interface JsonApiDashboardPluginOutWithLinks {
|
|
|
4405
4411
|
* API identifier of an object
|
|
4406
4412
|
*/
|
|
4407
4413
|
'id': string;
|
|
4408
|
-
'meta'?:
|
|
4414
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
4409
4415
|
'attributes'?: JsonApiDashboardPluginOutAttributes;
|
|
4410
4416
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
4411
4417
|
'links'?: ObjectLinks;
|
|
@@ -4469,7 +4475,7 @@ export interface JsonApiDataSourceIdentifierOut {
|
|
|
4469
4475
|
* API identifier of an object
|
|
4470
4476
|
*/
|
|
4471
4477
|
'id': string;
|
|
4472
|
-
'meta'?:
|
|
4478
|
+
'meta'?: JsonApiDataSourceIdentifierOutMeta;
|
|
4473
4479
|
'attributes': JsonApiDataSourceIdentifierOutAttributes;
|
|
4474
4480
|
}
|
|
4475
4481
|
export type JsonApiDataSourceIdentifierOutTypeEnum = 'dataSourceIdentifier';
|
|
@@ -4489,8 +4495,15 @@ export interface JsonApiDataSourceIdentifierOutDocument {
|
|
|
4489
4495
|
export interface JsonApiDataSourceIdentifierOutList {
|
|
4490
4496
|
'data': Array<JsonApiDataSourceIdentifierOutWithLinks>;
|
|
4491
4497
|
'links'?: ListLinks;
|
|
4492
|
-
'meta'?:
|
|
4498
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
4493
4499
|
}
|
|
4500
|
+
export interface JsonApiDataSourceIdentifierOutMeta {
|
|
4501
|
+
/**
|
|
4502
|
+
* List of valid permissions for a logged-in user.
|
|
4503
|
+
*/
|
|
4504
|
+
'permissions'?: Array<JsonApiDataSourceIdentifierOutMetaPermissionsEnum>;
|
|
4505
|
+
}
|
|
4506
|
+
export type JsonApiDataSourceIdentifierOutMetaPermissionsEnum = 'MANAGE' | 'USE';
|
|
4494
4507
|
export interface JsonApiDataSourceIdentifierOutWithLinks {
|
|
4495
4508
|
/**
|
|
4496
4509
|
* Object type
|
|
@@ -4500,7 +4513,7 @@ export interface JsonApiDataSourceIdentifierOutWithLinks {
|
|
|
4500
4513
|
* API identifier of an object
|
|
4501
4514
|
*/
|
|
4502
4515
|
'id': string;
|
|
4503
|
-
'meta'?:
|
|
4516
|
+
'meta'?: JsonApiDataSourceIdentifierOutMeta;
|
|
4504
4517
|
'attributes': JsonApiDataSourceIdentifierOutAttributes;
|
|
4505
4518
|
'links'?: ObjectLinks;
|
|
4506
4519
|
}
|
|
@@ -4568,7 +4581,7 @@ export interface JsonApiDataSourceInAttributes {
|
|
|
4568
4581
|
/**
|
|
4569
4582
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
4570
4583
|
*/
|
|
4571
|
-
'parameters'?: Array<
|
|
4584
|
+
'parameters'?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
4572
4585
|
/**
|
|
4573
4586
|
* Determines how the results coming from a particular datasource should be cached.
|
|
4574
4587
|
*/
|
|
@@ -4595,7 +4608,7 @@ export interface JsonApiDataSourceOut {
|
|
|
4595
4608
|
* API identifier of an object
|
|
4596
4609
|
*/
|
|
4597
4610
|
'id': string;
|
|
4598
|
-
'meta'?:
|
|
4611
|
+
'meta'?: JsonApiDataSourceIdentifierOutMeta;
|
|
4599
4612
|
'attributes': JsonApiDataSourceOutAttributes;
|
|
4600
4613
|
}
|
|
4601
4614
|
export type JsonApiDataSourceOutTypeEnum = 'dataSource';
|
|
@@ -4627,11 +4640,11 @@ export interface JsonApiDataSourceOutAttributes {
|
|
|
4627
4640
|
/**
|
|
4628
4641
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
4629
4642
|
*/
|
|
4630
|
-
'parameters'?: Array<
|
|
4643
|
+
'parameters'?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
4631
4644
|
/**
|
|
4632
4645
|
* Decoded parameters to be used when connecting to the database providing the data for the data source.
|
|
4633
4646
|
*/
|
|
4634
|
-
'decodedParameters'?: Array<
|
|
4647
|
+
'decodedParameters'?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
4635
4648
|
/**
|
|
4636
4649
|
* Determines how the results coming from a particular datasource should be cached.
|
|
4637
4650
|
*/
|
|
@@ -4648,6 +4661,10 @@ export interface JsonApiDataSourceOutAttributes {
|
|
|
4648
4661
|
export type JsonApiDataSourceOutAttributesTypeEnum = 'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'DRILL' | 'GREENPLUM' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'MONGODB' | 'CRATEDB' | 'AILAKEHOUSE';
|
|
4649
4662
|
export type JsonApiDataSourceOutAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
4650
4663
|
export type JsonApiDataSourceOutAttributesAuthenticationTypeEnum = 'USERNAME_PASSWORD' | 'TOKEN' | 'KEY_PAIR' | 'CLIENT_SECRET' | 'ACCESS_TOKEN';
|
|
4664
|
+
export interface JsonApiDataSourceOutAttributesParametersInner {
|
|
4665
|
+
'name': string;
|
|
4666
|
+
'value': string;
|
|
4667
|
+
}
|
|
4651
4668
|
export interface JsonApiDataSourceOutDocument {
|
|
4652
4669
|
'data': JsonApiDataSourceOut;
|
|
4653
4670
|
'links'?: ObjectLinks;
|
|
@@ -4658,15 +4675,8 @@ export interface JsonApiDataSourceOutDocument {
|
|
|
4658
4675
|
export interface JsonApiDataSourceOutList {
|
|
4659
4676
|
'data': Array<JsonApiDataSourceOutWithLinks>;
|
|
4660
4677
|
'links'?: ListLinks;
|
|
4661
|
-
'meta'?:
|
|
4662
|
-
}
|
|
4663
|
-
export interface JsonApiDataSourceOutMeta {
|
|
4664
|
-
/**
|
|
4665
|
-
* List of valid permissions for a logged-in user.
|
|
4666
|
-
*/
|
|
4667
|
-
'permissions'?: Array<JsonApiDataSourceOutMetaPermissionsEnum>;
|
|
4678
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
4668
4679
|
}
|
|
4669
|
-
export type JsonApiDataSourceOutMetaPermissionsEnum = 'MANAGE' | 'USE';
|
|
4670
4680
|
export interface JsonApiDataSourceOutWithLinks {
|
|
4671
4681
|
/**
|
|
4672
4682
|
* Object type
|
|
@@ -4676,7 +4686,7 @@ export interface JsonApiDataSourceOutWithLinks {
|
|
|
4676
4686
|
* API identifier of an object
|
|
4677
4687
|
*/
|
|
4678
4688
|
'id': string;
|
|
4679
|
-
'meta'?:
|
|
4689
|
+
'meta'?: JsonApiDataSourceIdentifierOutMeta;
|
|
4680
4690
|
'attributes': JsonApiDataSourceOutAttributes;
|
|
4681
4691
|
'links'?: ObjectLinks;
|
|
4682
4692
|
}
|
|
@@ -4744,7 +4754,7 @@ export interface JsonApiDataSourcePatchAttributes {
|
|
|
4744
4754
|
/**
|
|
4745
4755
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
4746
4756
|
*/
|
|
4747
|
-
'parameters'?: Array<
|
|
4757
|
+
'parameters'?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
4748
4758
|
/**
|
|
4749
4759
|
* Determines how the results coming from a particular datasource should be cached.
|
|
4750
4760
|
*/
|
|
@@ -4756,10 +4766,6 @@ export interface JsonApiDataSourcePatchAttributes {
|
|
|
4756
4766
|
}
|
|
4757
4767
|
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';
|
|
4758
4768
|
export type JsonApiDataSourcePatchAttributesCacheStrategyEnum = 'ALWAYS' | 'NEVER';
|
|
4759
|
-
export interface JsonApiDataSourcePatchAttributesParametersInner {
|
|
4760
|
-
'name': string;
|
|
4761
|
-
'value': string;
|
|
4762
|
-
}
|
|
4763
4769
|
export interface JsonApiDataSourcePatchDocument {
|
|
4764
4770
|
'data': JsonApiDataSourcePatch;
|
|
4765
4771
|
}
|
|
@@ -4783,7 +4789,7 @@ export interface JsonApiDatasetOut {
|
|
|
4783
4789
|
* API identifier of an object
|
|
4784
4790
|
*/
|
|
4785
4791
|
'id': string;
|
|
4786
|
-
'meta'?:
|
|
4792
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
4787
4793
|
'attributes': JsonApiDatasetOutAttributes;
|
|
4788
4794
|
'relationships'?: JsonApiDatasetOutRelationships;
|
|
4789
4795
|
}
|
|
@@ -4856,31 +4862,17 @@ export type JsonApiDatasetOutIncludes = JsonApiAggregatedFactOutWithLinks | Json
|
|
|
4856
4862
|
export interface JsonApiDatasetOutList {
|
|
4857
4863
|
'data': Array<JsonApiDatasetOutWithLinks>;
|
|
4858
4864
|
'links'?: ListLinks;
|
|
4859
|
-
'meta'?:
|
|
4865
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
4860
4866
|
/**
|
|
4861
4867
|
* Included resources
|
|
4862
4868
|
*/
|
|
4863
4869
|
'included'?: Array<JsonApiDatasetOutIncludes>;
|
|
4864
4870
|
}
|
|
4865
|
-
export interface JsonApiDatasetOutMeta {
|
|
4866
|
-
'origin'?: JsonApiDatasetOutMetaOrigin;
|
|
4867
|
-
}
|
|
4868
|
-
export interface JsonApiDatasetOutMetaOrigin {
|
|
4869
|
-
/**
|
|
4870
|
-
* defines type of the origin of the entity
|
|
4871
|
-
*/
|
|
4872
|
-
'originType': JsonApiDatasetOutMetaOriginOriginTypeEnum;
|
|
4873
|
-
/**
|
|
4874
|
-
* defines id of the workspace where the entity comes from
|
|
4875
|
-
*/
|
|
4876
|
-
'originId': string;
|
|
4877
|
-
}
|
|
4878
|
-
export type JsonApiDatasetOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
4879
4871
|
export interface JsonApiDatasetOutRelationships {
|
|
4880
|
-
'attributes'?:
|
|
4881
|
-
'facts'?:
|
|
4872
|
+
'attributes'?: JsonApiVisualizationObjectOutRelationshipsAttributes;
|
|
4873
|
+
'facts'?: JsonApiVisualizationObjectOutRelationshipsFacts;
|
|
4882
4874
|
'aggregatedFacts'?: JsonApiDatasetOutRelationshipsAggregatedFacts;
|
|
4883
|
-
'references'?:
|
|
4875
|
+
'references'?: JsonApiVisualizationObjectOutRelationshipsDatasets;
|
|
4884
4876
|
'workspaceDataFilters'?: JsonApiDatasetOutRelationshipsWorkspaceDataFilters;
|
|
4885
4877
|
}
|
|
4886
4878
|
export interface JsonApiDatasetOutRelationshipsAggregatedFacts {
|
|
@@ -4889,24 +4881,6 @@ export interface JsonApiDatasetOutRelationshipsAggregatedFacts {
|
|
|
4889
4881
|
*/
|
|
4890
4882
|
'data': Array<JsonApiAggregatedFactLinkage>;
|
|
4891
4883
|
}
|
|
4892
|
-
export interface JsonApiDatasetOutRelationshipsAttributes {
|
|
4893
|
-
/**
|
|
4894
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
4895
|
-
*/
|
|
4896
|
-
'data': Array<JsonApiAttributeLinkage>;
|
|
4897
|
-
}
|
|
4898
|
-
export interface JsonApiDatasetOutRelationshipsFacts {
|
|
4899
|
-
/**
|
|
4900
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
4901
|
-
*/
|
|
4902
|
-
'data': Array<JsonApiFactLinkage>;
|
|
4903
|
-
}
|
|
4904
|
-
export interface JsonApiDatasetOutRelationshipsReferences {
|
|
4905
|
-
/**
|
|
4906
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
4907
|
-
*/
|
|
4908
|
-
'data': Array<JsonApiDatasetLinkage>;
|
|
4909
|
-
}
|
|
4910
4884
|
export interface JsonApiDatasetOutRelationshipsWorkspaceDataFilters {
|
|
4911
4885
|
/**
|
|
4912
4886
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -4922,7 +4896,7 @@ export interface JsonApiDatasetOutWithLinks {
|
|
|
4922
4896
|
* API identifier of an object
|
|
4923
4897
|
*/
|
|
4924
4898
|
'id': string;
|
|
4925
|
-
'meta'?:
|
|
4899
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
4926
4900
|
'attributes': JsonApiDatasetOutAttributes;
|
|
4927
4901
|
'relationships'?: JsonApiDatasetOutRelationships;
|
|
4928
4902
|
'links'?: ObjectLinks;
|
|
@@ -4975,7 +4949,7 @@ export interface JsonApiEntitlementOutDocument {
|
|
|
4975
4949
|
export interface JsonApiEntitlementOutList {
|
|
4976
4950
|
'data': Array<JsonApiEntitlementOutWithLinks>;
|
|
4977
4951
|
'links'?: ListLinks;
|
|
4978
|
-
'meta'?:
|
|
4952
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
4979
4953
|
}
|
|
4980
4954
|
export interface JsonApiEntitlementOutWithLinks {
|
|
4981
4955
|
/**
|
|
@@ -5029,7 +5003,7 @@ export interface JsonApiExportDefinitionOut {
|
|
|
5029
5003
|
* API identifier of an object
|
|
5030
5004
|
*/
|
|
5031
5005
|
'id': string;
|
|
5032
|
-
'meta'?:
|
|
5006
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
5033
5007
|
'attributes'?: JsonApiExportDefinitionOutAttributes;
|
|
5034
5008
|
'relationships'?: JsonApiExportDefinitionOutRelationships;
|
|
5035
5009
|
}
|
|
@@ -5072,7 +5046,7 @@ export type JsonApiExportDefinitionOutIncludes = JsonApiAnalyticalDashboardOutWi
|
|
|
5072
5046
|
export interface JsonApiExportDefinitionOutList {
|
|
5073
5047
|
'data': Array<JsonApiExportDefinitionOutWithLinks>;
|
|
5074
5048
|
'links'?: ListLinks;
|
|
5075
|
-
'meta'?:
|
|
5049
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
5076
5050
|
/**
|
|
5077
5051
|
* Included resources
|
|
5078
5052
|
*/
|
|
@@ -5080,14 +5054,11 @@ export interface JsonApiExportDefinitionOutList {
|
|
|
5080
5054
|
}
|
|
5081
5055
|
export interface JsonApiExportDefinitionOutRelationships {
|
|
5082
5056
|
'visualizationObject'?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
5083
|
-
'analyticalDashboard'?:
|
|
5057
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
5084
5058
|
'automation'?: JsonApiExportDefinitionOutRelationshipsAutomation;
|
|
5085
5059
|
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
5086
5060
|
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
5087
5061
|
}
|
|
5088
|
-
export interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard {
|
|
5089
|
-
'data': JsonApiAnalyticalDashboardLinkage | null;
|
|
5090
|
-
}
|
|
5091
5062
|
export interface JsonApiExportDefinitionOutRelationshipsAutomation {
|
|
5092
5063
|
'data': JsonApiAutomationLinkage | null;
|
|
5093
5064
|
}
|
|
@@ -5103,7 +5074,7 @@ export interface JsonApiExportDefinitionOutWithLinks {
|
|
|
5103
5074
|
* API identifier of an object
|
|
5104
5075
|
*/
|
|
5105
5076
|
'id': string;
|
|
5106
|
-
'meta'?:
|
|
5077
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
5107
5078
|
'attributes'?: JsonApiExportDefinitionOutAttributes;
|
|
5108
5079
|
'relationships'?: JsonApiExportDefinitionOutRelationships;
|
|
5109
5080
|
'links'?: ObjectLinks;
|
|
@@ -5137,7 +5108,7 @@ export interface JsonApiExportDefinitionPatchDocument {
|
|
|
5137
5108
|
}
|
|
5138
5109
|
export interface JsonApiExportDefinitionPatchRelationships {
|
|
5139
5110
|
'visualizationObject'?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
5140
|
-
'analyticalDashboard'?:
|
|
5111
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
5141
5112
|
}
|
|
5142
5113
|
/**
|
|
5143
5114
|
* JSON:API representation of exportDefinition entity.
|
|
@@ -5196,9 +5167,34 @@ export interface JsonApiExportTemplateOutAttributes {
|
|
|
5196
5167
|
* User-facing name of the Slides template.
|
|
5197
5168
|
*/
|
|
5198
5169
|
'name': string;
|
|
5199
|
-
'dashboardSlidesTemplate'?:
|
|
5200
|
-
'widgetSlidesTemplate'?:
|
|
5170
|
+
'dashboardSlidesTemplate'?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
5171
|
+
'widgetSlidesTemplate'?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
5172
|
+
}
|
|
5173
|
+
/**
|
|
5174
|
+
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5175
|
+
*/
|
|
5176
|
+
export interface JsonApiExportTemplateOutAttributesDashboardSlidesTemplate {
|
|
5177
|
+
/**
|
|
5178
|
+
* Export types this template applies to.
|
|
5179
|
+
*/
|
|
5180
|
+
'appliedOn': Array<JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
5181
|
+
'coverSlide'?: CoverSlideTemplate | null;
|
|
5182
|
+
'introSlide'?: IntroSlideTemplate | null;
|
|
5183
|
+
'sectionSlide'?: SectionSlideTemplate | null;
|
|
5184
|
+
'contentSlide'?: ContentSlideTemplate | null;
|
|
5185
|
+
}
|
|
5186
|
+
export type JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
5187
|
+
/**
|
|
5188
|
+
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5189
|
+
*/
|
|
5190
|
+
export interface JsonApiExportTemplateOutAttributesWidgetSlidesTemplate {
|
|
5191
|
+
/**
|
|
5192
|
+
* Export types this template applies to.
|
|
5193
|
+
*/
|
|
5194
|
+
'appliedOn': Array<JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
5195
|
+
'contentSlide'?: ContentSlideTemplate | null;
|
|
5201
5196
|
}
|
|
5197
|
+
export type JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
5202
5198
|
export interface JsonApiExportTemplateOutDocument {
|
|
5203
5199
|
'data': JsonApiExportTemplateOut;
|
|
5204
5200
|
'links'?: ObjectLinks;
|
|
@@ -5209,7 +5205,7 @@ export interface JsonApiExportTemplateOutDocument {
|
|
|
5209
5205
|
export interface JsonApiExportTemplateOutList {
|
|
5210
5206
|
'data': Array<JsonApiExportTemplateOutWithLinks>;
|
|
5211
5207
|
'links'?: ListLinks;
|
|
5212
|
-
'meta'?:
|
|
5208
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
5213
5209
|
}
|
|
5214
5210
|
export interface JsonApiExportTemplateOutWithLinks {
|
|
5215
5211
|
/**
|
|
@@ -5244,34 +5240,9 @@ export interface JsonApiExportTemplatePatchAttributes {
|
|
|
5244
5240
|
* User-facing name of the Slides template.
|
|
5245
5241
|
*/
|
|
5246
5242
|
'name'?: string;
|
|
5247
|
-
'dashboardSlidesTemplate'?:
|
|
5248
|
-
'widgetSlidesTemplate'?:
|
|
5249
|
-
}
|
|
5250
|
-
/**
|
|
5251
|
-
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5252
|
-
*/
|
|
5253
|
-
export interface JsonApiExportTemplatePatchAttributesDashboardSlidesTemplate {
|
|
5254
|
-
/**
|
|
5255
|
-
* Export types this template applies to.
|
|
5256
|
-
*/
|
|
5257
|
-
'appliedOn': Array<JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
5258
|
-
'coverSlide'?: CoverSlideTemplate | null;
|
|
5259
|
-
'introSlide'?: IntroSlideTemplate | null;
|
|
5260
|
-
'sectionSlide'?: SectionSlideTemplate | null;
|
|
5261
|
-
'contentSlide'?: ContentSlideTemplate | null;
|
|
5262
|
-
}
|
|
5263
|
-
export type JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
5264
|
-
/**
|
|
5265
|
-
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5266
|
-
*/
|
|
5267
|
-
export interface JsonApiExportTemplatePatchAttributesWidgetSlidesTemplate {
|
|
5268
|
-
/**
|
|
5269
|
-
* Export types this template applies to.
|
|
5270
|
-
*/
|
|
5271
|
-
'appliedOn': Array<JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
5272
|
-
'contentSlide'?: ContentSlideTemplate | null;
|
|
5243
|
+
'dashboardSlidesTemplate'?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
5244
|
+
'widgetSlidesTemplate'?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
5273
5245
|
}
|
|
5274
|
-
export type JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum = 'PDF' | 'PPTX';
|
|
5275
5246
|
export interface JsonApiExportTemplatePatchDocument {
|
|
5276
5247
|
'data': JsonApiExportTemplatePatch;
|
|
5277
5248
|
}
|
|
@@ -5313,7 +5284,7 @@ export interface JsonApiFactOut {
|
|
|
5313
5284
|
* API identifier of an object
|
|
5314
5285
|
*/
|
|
5315
5286
|
'id': string;
|
|
5316
|
-
'meta'?:
|
|
5287
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
5317
5288
|
'attributes'?: JsonApiFactOutAttributes;
|
|
5318
5289
|
'relationships'?: JsonApiFactOutRelationships;
|
|
5319
5290
|
}
|
|
@@ -5344,17 +5315,14 @@ export interface JsonApiFactOutDocument {
|
|
|
5344
5315
|
export interface JsonApiFactOutList {
|
|
5345
5316
|
'data': Array<JsonApiFactOutWithLinks>;
|
|
5346
5317
|
'links'?: ListLinks;
|
|
5347
|
-
'meta'?:
|
|
5318
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
5348
5319
|
/**
|
|
5349
5320
|
* Included resources
|
|
5350
5321
|
*/
|
|
5351
5322
|
'included'?: Array<JsonApiDatasetOutWithLinks>;
|
|
5352
5323
|
}
|
|
5353
5324
|
export interface JsonApiFactOutRelationships {
|
|
5354
|
-
'dataset'?:
|
|
5355
|
-
}
|
|
5356
|
-
export interface JsonApiFactOutRelationshipsDataset {
|
|
5357
|
-
'data': JsonApiDatasetLinkage | null;
|
|
5325
|
+
'dataset'?: JsonApiAttributeOutRelationshipsDataset;
|
|
5358
5326
|
}
|
|
5359
5327
|
export interface JsonApiFactOutWithLinks {
|
|
5360
5328
|
/**
|
|
@@ -5365,7 +5333,7 @@ export interface JsonApiFactOutWithLinks {
|
|
|
5365
5333
|
* API identifier of an object
|
|
5366
5334
|
*/
|
|
5367
5335
|
'id': string;
|
|
5368
|
-
'meta'?:
|
|
5336
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
5369
5337
|
'attributes'?: JsonApiFactOutAttributes;
|
|
5370
5338
|
'relationships'?: JsonApiFactOutRelationships;
|
|
5371
5339
|
'links'?: ObjectLinks;
|
|
@@ -5427,7 +5395,7 @@ export interface JsonApiFilterContextOut {
|
|
|
5427
5395
|
* API identifier of an object
|
|
5428
5396
|
*/
|
|
5429
5397
|
'id': string;
|
|
5430
|
-
'meta'?:
|
|
5398
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
5431
5399
|
'attributes': JsonApiFilterContextOutAttributes;
|
|
5432
5400
|
'relationships'?: JsonApiFilterContextOutRelationships;
|
|
5433
5401
|
}
|
|
@@ -5460,15 +5428,15 @@ export type JsonApiFilterContextOutIncludes = JsonApiAttributeOutWithLinks | Jso
|
|
|
5460
5428
|
export interface JsonApiFilterContextOutList {
|
|
5461
5429
|
'data': Array<JsonApiFilterContextOutWithLinks>;
|
|
5462
5430
|
'links'?: ListLinks;
|
|
5463
|
-
'meta'?:
|
|
5431
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
5464
5432
|
/**
|
|
5465
5433
|
* Included resources
|
|
5466
5434
|
*/
|
|
5467
5435
|
'included'?: Array<JsonApiFilterContextOutIncludes>;
|
|
5468
5436
|
}
|
|
5469
5437
|
export interface JsonApiFilterContextOutRelationships {
|
|
5470
|
-
'attributes'?:
|
|
5471
|
-
'datasets'?:
|
|
5438
|
+
'attributes'?: JsonApiVisualizationObjectOutRelationshipsAttributes;
|
|
5439
|
+
'datasets'?: JsonApiVisualizationObjectOutRelationshipsDatasets;
|
|
5472
5440
|
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
5473
5441
|
}
|
|
5474
5442
|
export interface JsonApiFilterContextOutWithLinks {
|
|
@@ -5480,7 +5448,7 @@ export interface JsonApiFilterContextOutWithLinks {
|
|
|
5480
5448
|
* API identifier of an object
|
|
5481
5449
|
*/
|
|
5482
5450
|
'id': string;
|
|
5483
|
-
'meta'?:
|
|
5451
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
5484
5452
|
'attributes': JsonApiFilterContextOutAttributes;
|
|
5485
5453
|
'relationships'?: JsonApiFilterContextOutRelationships;
|
|
5486
5454
|
'links'?: ObjectLinks;
|
|
@@ -5545,7 +5513,7 @@ export interface JsonApiFilterViewIn {
|
|
|
5545
5513
|
*/
|
|
5546
5514
|
'id': string;
|
|
5547
5515
|
'attributes': JsonApiFilterViewOutAttributes;
|
|
5548
|
-
'relationships'?:
|
|
5516
|
+
'relationships'?: JsonApiFilterViewPatchRelationships;
|
|
5549
5517
|
}
|
|
5550
5518
|
export type JsonApiFilterViewInTypeEnum = 'filterView';
|
|
5551
5519
|
export interface JsonApiFilterViewInDocument {
|
|
@@ -5564,7 +5532,7 @@ export interface JsonApiFilterViewOut {
|
|
|
5564
5532
|
*/
|
|
5565
5533
|
'id': string;
|
|
5566
5534
|
'attributes': JsonApiFilterViewOutAttributes;
|
|
5567
|
-
'relationships'?:
|
|
5535
|
+
'relationships'?: JsonApiFilterViewPatchRelationships;
|
|
5568
5536
|
}
|
|
5569
5537
|
export type JsonApiFilterViewOutTypeEnum = 'filterView';
|
|
5570
5538
|
export interface JsonApiFilterViewOutAttributes {
|
|
@@ -5599,16 +5567,12 @@ export type JsonApiFilterViewOutIncludes = JsonApiAnalyticalDashboardOutWithLink
|
|
|
5599
5567
|
export interface JsonApiFilterViewOutList {
|
|
5600
5568
|
'data': Array<JsonApiFilterViewOutWithLinks>;
|
|
5601
5569
|
'links'?: ListLinks;
|
|
5602
|
-
'meta'?:
|
|
5570
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
5603
5571
|
/**
|
|
5604
5572
|
* Included resources
|
|
5605
5573
|
*/
|
|
5606
5574
|
'included'?: Array<JsonApiFilterViewOutIncludes>;
|
|
5607
5575
|
}
|
|
5608
|
-
export interface JsonApiFilterViewOutRelationships {
|
|
5609
|
-
'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
5610
|
-
'user'?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
5611
|
-
}
|
|
5612
5576
|
export interface JsonApiFilterViewOutWithLinks {
|
|
5613
5577
|
/**
|
|
5614
5578
|
* Object type
|
|
@@ -5619,7 +5583,7 @@ export interface JsonApiFilterViewOutWithLinks {
|
|
|
5619
5583
|
*/
|
|
5620
5584
|
'id': string;
|
|
5621
5585
|
'attributes': JsonApiFilterViewOutAttributes;
|
|
5622
|
-
'relationships'?:
|
|
5586
|
+
'relationships'?: JsonApiFilterViewPatchRelationships;
|
|
5623
5587
|
'links'?: ObjectLinks;
|
|
5624
5588
|
}
|
|
5625
5589
|
export type JsonApiFilterViewOutWithLinksTypeEnum = 'filterView';
|
|
@@ -5636,7 +5600,7 @@ export interface JsonApiFilterViewPatch {
|
|
|
5636
5600
|
*/
|
|
5637
5601
|
'id': string;
|
|
5638
5602
|
'attributes': JsonApiFilterViewPatchAttributes;
|
|
5639
|
-
'relationships'?:
|
|
5603
|
+
'relationships'?: JsonApiFilterViewPatchRelationships;
|
|
5640
5604
|
}
|
|
5641
5605
|
export type JsonApiFilterViewPatchTypeEnum = 'filterView';
|
|
5642
5606
|
export interface JsonApiFilterViewPatchAttributes {
|
|
@@ -5656,6 +5620,13 @@ export interface JsonApiFilterViewPatchAttributes {
|
|
|
5656
5620
|
export interface JsonApiFilterViewPatchDocument {
|
|
5657
5621
|
'data': JsonApiFilterViewPatch;
|
|
5658
5622
|
}
|
|
5623
|
+
export interface JsonApiFilterViewPatchRelationships {
|
|
5624
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
5625
|
+
'user'?: JsonApiFilterViewPatchRelationshipsUser;
|
|
5626
|
+
}
|
|
5627
|
+
export interface JsonApiFilterViewPatchRelationshipsUser {
|
|
5628
|
+
'data': JsonApiUserLinkage | null;
|
|
5629
|
+
}
|
|
5659
5630
|
/**
|
|
5660
5631
|
* JSON:API representation of identityProvider entity.
|
|
5661
5632
|
*/
|
|
@@ -5668,9 +5639,60 @@ export interface JsonApiIdentityProviderIn {
|
|
|
5668
5639
|
* API identifier of an object
|
|
5669
5640
|
*/
|
|
5670
5641
|
'id': string;
|
|
5671
|
-
'attributes'?:
|
|
5642
|
+
'attributes'?: JsonApiIdentityProviderInAttributes;
|
|
5672
5643
|
}
|
|
5673
5644
|
export type JsonApiIdentityProviderInTypeEnum = 'identityProvider';
|
|
5645
|
+
export interface JsonApiIdentityProviderInAttributes {
|
|
5646
|
+
/**
|
|
5647
|
+
* 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.
|
|
5648
|
+
*/
|
|
5649
|
+
'identifiers'?: Array<string>;
|
|
5650
|
+
/**
|
|
5651
|
+
* 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.
|
|
5652
|
+
*/
|
|
5653
|
+
'customClaimMapping'?: {
|
|
5654
|
+
[key: string]: string;
|
|
5655
|
+
};
|
|
5656
|
+
/**
|
|
5657
|
+
* 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.
|
|
5658
|
+
*/
|
|
5659
|
+
'samlMetadata'?: string;
|
|
5660
|
+
/**
|
|
5661
|
+
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5662
|
+
*/
|
|
5663
|
+
'oauthClientId'?: string;
|
|
5664
|
+
/**
|
|
5665
|
+
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5666
|
+
*/
|
|
5667
|
+
'oauthClientSecret'?: string;
|
|
5668
|
+
/**
|
|
5669
|
+
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5670
|
+
*/
|
|
5671
|
+
'oauthIssuerLocation'?: string;
|
|
5672
|
+
/**
|
|
5673
|
+
* 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.
|
|
5674
|
+
*/
|
|
5675
|
+
'oauthIssuerId'?: string;
|
|
5676
|
+
/**
|
|
5677
|
+
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
5678
|
+
*/
|
|
5679
|
+
'oauthSubjectIdClaim'?: string;
|
|
5680
|
+
/**
|
|
5681
|
+
* 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.
|
|
5682
|
+
*/
|
|
5683
|
+
'oauthCustomAuthAttributes'?: {
|
|
5684
|
+
[key: string]: string;
|
|
5685
|
+
};
|
|
5686
|
+
/**
|
|
5687
|
+
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
5688
|
+
*/
|
|
5689
|
+
'oauthCustomScopes'?: Array<string> | null;
|
|
5690
|
+
/**
|
|
5691
|
+
* 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.
|
|
5692
|
+
*/
|
|
5693
|
+
'idpType'?: JsonApiIdentityProviderInAttributesIdpTypeEnum;
|
|
5694
|
+
}
|
|
5695
|
+
export type JsonApiIdentityProviderInAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
|
|
5674
5696
|
export interface JsonApiIdentityProviderInDocument {
|
|
5675
5697
|
'data': JsonApiIdentityProviderIn;
|
|
5676
5698
|
}
|
|
@@ -5750,7 +5772,7 @@ export interface JsonApiIdentityProviderOutDocument {
|
|
|
5750
5772
|
export interface JsonApiIdentityProviderOutList {
|
|
5751
5773
|
'data': Array<JsonApiIdentityProviderOutWithLinks>;
|
|
5752
5774
|
'links'?: ListLinks;
|
|
5753
|
-
'meta'?:
|
|
5775
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
5754
5776
|
}
|
|
5755
5777
|
export interface JsonApiIdentityProviderOutWithLinks {
|
|
5756
5778
|
/**
|
|
@@ -5777,60 +5799,9 @@ export interface JsonApiIdentityProviderPatch {
|
|
|
5777
5799
|
* API identifier of an object
|
|
5778
5800
|
*/
|
|
5779
5801
|
'id': string;
|
|
5780
|
-
'attributes'?:
|
|
5802
|
+
'attributes'?: JsonApiIdentityProviderInAttributes;
|
|
5781
5803
|
}
|
|
5782
5804
|
export type JsonApiIdentityProviderPatchTypeEnum = 'identityProvider';
|
|
5783
|
-
export interface JsonApiIdentityProviderPatchAttributes {
|
|
5784
|
-
/**
|
|
5785
|
-
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
|
|
5786
|
-
*/
|
|
5787
|
-
'identifiers'?: Array<string>;
|
|
5788
|
-
/**
|
|
5789
|
-
* 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.
|
|
5790
|
-
*/
|
|
5791
|
-
'customClaimMapping'?: {
|
|
5792
|
-
[key: string]: string;
|
|
5793
|
-
};
|
|
5794
|
-
/**
|
|
5795
|
-
* Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer\'s name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.
|
|
5796
|
-
*/
|
|
5797
|
-
'samlMetadata'?: string;
|
|
5798
|
-
/**
|
|
5799
|
-
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5800
|
-
*/
|
|
5801
|
-
'oauthClientId'?: string;
|
|
5802
|
-
/**
|
|
5803
|
-
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5804
|
-
*/
|
|
5805
|
-
'oauthClientSecret'?: string;
|
|
5806
|
-
/**
|
|
5807
|
-
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
5808
|
-
*/
|
|
5809
|
-
'oauthIssuerLocation'?: string;
|
|
5810
|
-
/**
|
|
5811
|
-
* 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.
|
|
5812
|
-
*/
|
|
5813
|
-
'oauthIssuerId'?: string;
|
|
5814
|
-
/**
|
|
5815
|
-
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
5816
|
-
*/
|
|
5817
|
-
'oauthSubjectIdClaim'?: string;
|
|
5818
|
-
/**
|
|
5819
|
-
* 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.
|
|
5820
|
-
*/
|
|
5821
|
-
'oauthCustomAuthAttributes'?: {
|
|
5822
|
-
[key: string]: string;
|
|
5823
|
-
};
|
|
5824
|
-
/**
|
|
5825
|
-
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
5826
|
-
*/
|
|
5827
|
-
'oauthCustomScopes'?: Array<string> | null;
|
|
5828
|
-
/**
|
|
5829
|
-
* Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer\'s own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
|
|
5830
|
-
*/
|
|
5831
|
-
'idpType'?: JsonApiIdentityProviderPatchAttributesIdpTypeEnum;
|
|
5832
|
-
}
|
|
5833
|
-
export type JsonApiIdentityProviderPatchAttributesIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
|
|
5834
5805
|
export interface JsonApiIdentityProviderPatchDocument {
|
|
5835
5806
|
'data': JsonApiIdentityProviderPatch;
|
|
5836
5807
|
}
|
|
@@ -5846,7 +5817,7 @@ export interface JsonApiJwkIn {
|
|
|
5846
5817
|
* API identifier of an object
|
|
5847
5818
|
*/
|
|
5848
5819
|
'id': string;
|
|
5849
|
-
'attributes'?:
|
|
5820
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
5850
5821
|
}
|
|
5851
5822
|
export type JsonApiJwkInTypeEnum = 'jwk';
|
|
5852
5823
|
export interface JsonApiJwkInDocument {
|
|
@@ -5864,9 +5835,12 @@ export interface JsonApiJwkOut {
|
|
|
5864
5835
|
* API identifier of an object
|
|
5865
5836
|
*/
|
|
5866
5837
|
'id': string;
|
|
5867
|
-
'attributes'?:
|
|
5838
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
5868
5839
|
}
|
|
5869
5840
|
export type JsonApiJwkOutTypeEnum = 'jwk';
|
|
5841
|
+
export interface JsonApiJwkOutAttributes {
|
|
5842
|
+
'content'?: RsaSpecification;
|
|
5843
|
+
}
|
|
5870
5844
|
export interface JsonApiJwkOutDocument {
|
|
5871
5845
|
'data': JsonApiJwkOut;
|
|
5872
5846
|
'links'?: ObjectLinks;
|
|
@@ -5877,7 +5851,7 @@ export interface JsonApiJwkOutDocument {
|
|
|
5877
5851
|
export interface JsonApiJwkOutList {
|
|
5878
5852
|
'data': Array<JsonApiJwkOutWithLinks>;
|
|
5879
5853
|
'links'?: ListLinks;
|
|
5880
|
-
'meta'?:
|
|
5854
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
5881
5855
|
}
|
|
5882
5856
|
export interface JsonApiJwkOutWithLinks {
|
|
5883
5857
|
/**
|
|
@@ -5888,7 +5862,7 @@ export interface JsonApiJwkOutWithLinks {
|
|
|
5888
5862
|
* API identifier of an object
|
|
5889
5863
|
*/
|
|
5890
5864
|
'id': string;
|
|
5891
|
-
'attributes'?:
|
|
5865
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
5892
5866
|
'links'?: ObjectLinks;
|
|
5893
5867
|
}
|
|
5894
5868
|
export type JsonApiJwkOutWithLinksTypeEnum = 'jwk';
|
|
@@ -5904,12 +5878,9 @@ export interface JsonApiJwkPatch {
|
|
|
5904
5878
|
* API identifier of an object
|
|
5905
5879
|
*/
|
|
5906
5880
|
'id': string;
|
|
5907
|
-
'attributes'?:
|
|
5881
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
5908
5882
|
}
|
|
5909
5883
|
export type JsonApiJwkPatchTypeEnum = 'jwk';
|
|
5910
|
-
export interface JsonApiJwkPatchAttributes {
|
|
5911
|
-
'content'?: RsaSpecification;
|
|
5912
|
-
}
|
|
5913
5884
|
export interface JsonApiJwkPatchDocument {
|
|
5914
5885
|
'data': JsonApiJwkPatch;
|
|
5915
5886
|
}
|
|
@@ -5925,13 +5896,83 @@ export interface JsonApiKnowledgeRecommendationIn {
|
|
|
5925
5896
|
* API identifier of an object
|
|
5926
5897
|
*/
|
|
5927
5898
|
'id': string;
|
|
5928
|
-
'attributes':
|
|
5929
|
-
'relationships':
|
|
5899
|
+
'attributes': JsonApiKnowledgeRecommendationInAttributes;
|
|
5900
|
+
'relationships': JsonApiKnowledgeRecommendationInRelationships;
|
|
5930
5901
|
}
|
|
5931
5902
|
export type JsonApiKnowledgeRecommendationInTypeEnum = 'knowledgeRecommendation';
|
|
5903
|
+
export interface JsonApiKnowledgeRecommendationInAttributes {
|
|
5904
|
+
/**
|
|
5905
|
+
* Human-readable title for the recommendation, e.g. \'Revenue decreased vs last month\'
|
|
5906
|
+
*/
|
|
5907
|
+
'title': string;
|
|
5908
|
+
/**
|
|
5909
|
+
* Description of the recommendation
|
|
5910
|
+
*/
|
|
5911
|
+
'description'?: string;
|
|
5912
|
+
'tags'?: Array<string>;
|
|
5913
|
+
'areRelationsValid'?: boolean;
|
|
5914
|
+
/**
|
|
5915
|
+
* Human-readable title of the metric (denormalized for display)
|
|
5916
|
+
*/
|
|
5917
|
+
'metricTitle'?: string;
|
|
5918
|
+
/**
|
|
5919
|
+
* Direction of the metric change
|
|
5920
|
+
*/
|
|
5921
|
+
'direction': JsonApiKnowledgeRecommendationInAttributesDirectionEnum;
|
|
5922
|
+
/**
|
|
5923
|
+
* Time period for comparison
|
|
5924
|
+
*/
|
|
5925
|
+
'comparisonType': JsonApiKnowledgeRecommendationInAttributesComparisonTypeEnum;
|
|
5926
|
+
/**
|
|
5927
|
+
* ID of the widget where the anomaly was detected
|
|
5928
|
+
*/
|
|
5929
|
+
'widgetId'?: string;
|
|
5930
|
+
/**
|
|
5931
|
+
* Name of the widget where the anomaly was detected
|
|
5932
|
+
*/
|
|
5933
|
+
'widgetName'?: string;
|
|
5934
|
+
/**
|
|
5935
|
+
* Confidence score (0.0 to 1.0)
|
|
5936
|
+
*/
|
|
5937
|
+
'confidence'?: any;
|
|
5938
|
+
/**
|
|
5939
|
+
* Structured recommendations data as JSON
|
|
5940
|
+
*/
|
|
5941
|
+
'recommendations'?: object;
|
|
5942
|
+
/**
|
|
5943
|
+
* Number of source documents used for generation
|
|
5944
|
+
*/
|
|
5945
|
+
'sourceCount'?: number;
|
|
5946
|
+
/**
|
|
5947
|
+
* Reference time period for comparison (e.g., \'2023-06\' or \'Jun 2023\')
|
|
5948
|
+
*/
|
|
5949
|
+
'referencePeriod'?: string;
|
|
5950
|
+
/**
|
|
5951
|
+
* Analyzed time period (e.g., \'2023-07\' or \'July 2023\')
|
|
5952
|
+
*/
|
|
5953
|
+
'analyzedPeriod'?: string;
|
|
5954
|
+
/**
|
|
5955
|
+
* Metric value in the reference period
|
|
5956
|
+
*/
|
|
5957
|
+
'referenceValue'?: any;
|
|
5958
|
+
/**
|
|
5959
|
+
* Metric value in the analyzed period (the observed value that triggered the anomaly)
|
|
5960
|
+
*/
|
|
5961
|
+
'analyzedValue'?: any;
|
|
5962
|
+
/**
|
|
5963
|
+
* Human-readable title of the analytical dashboard (denormalized for display)
|
|
5964
|
+
*/
|
|
5965
|
+
'analyticalDashboardTitle'?: string;
|
|
5966
|
+
}
|
|
5967
|
+
export type JsonApiKnowledgeRecommendationInAttributesDirectionEnum = 'INCREASED' | 'DECREASED';
|
|
5968
|
+
export type JsonApiKnowledgeRecommendationInAttributesComparisonTypeEnum = 'MONTH' | 'QUARTER' | 'YEAR';
|
|
5932
5969
|
export interface JsonApiKnowledgeRecommendationInDocument {
|
|
5933
5970
|
'data': JsonApiKnowledgeRecommendationIn;
|
|
5934
5971
|
}
|
|
5972
|
+
export interface JsonApiKnowledgeRecommendationInRelationships {
|
|
5973
|
+
'metric': JsonApiKnowledgeRecommendationPatchRelationshipsMetric;
|
|
5974
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
5975
|
+
}
|
|
5935
5976
|
/**
|
|
5936
5977
|
* JSON:API representation of knowledgeRecommendation entity.
|
|
5937
5978
|
*/
|
|
@@ -5944,9 +5985,9 @@ export interface JsonApiKnowledgeRecommendationOut {
|
|
|
5944
5985
|
* API identifier of an object
|
|
5945
5986
|
*/
|
|
5946
5987
|
'id': string;
|
|
5947
|
-
'meta'?:
|
|
5988
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
5948
5989
|
'attributes': JsonApiKnowledgeRecommendationOutAttributes;
|
|
5949
|
-
'relationships'?:
|
|
5990
|
+
'relationships'?: JsonApiKnowledgeRecommendationPatchRelationships;
|
|
5950
5991
|
}
|
|
5951
5992
|
export type JsonApiKnowledgeRecommendationOutTypeEnum = 'knowledgeRecommendation';
|
|
5952
5993
|
export interface JsonApiKnowledgeRecommendationOutAttributes {
|
|
@@ -6034,19 +6075,12 @@ export type JsonApiKnowledgeRecommendationOutIncludes = JsonApiAnalyticalDashboa
|
|
|
6034
6075
|
export interface JsonApiKnowledgeRecommendationOutList {
|
|
6035
6076
|
'data': Array<JsonApiKnowledgeRecommendationOutWithLinks>;
|
|
6036
6077
|
'links'?: ListLinks;
|
|
6037
|
-
'meta'?:
|
|
6078
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
6038
6079
|
/**
|
|
6039
6080
|
* Included resources
|
|
6040
6081
|
*/
|
|
6041
6082
|
'included'?: Array<JsonApiKnowledgeRecommendationOutIncludes>;
|
|
6042
6083
|
}
|
|
6043
|
-
export interface JsonApiKnowledgeRecommendationOutRelationships {
|
|
6044
|
-
'metric'?: JsonApiKnowledgeRecommendationOutRelationshipsMetric;
|
|
6045
|
-
'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
6046
|
-
}
|
|
6047
|
-
export interface JsonApiKnowledgeRecommendationOutRelationshipsMetric {
|
|
6048
|
-
'data': JsonApiMetricLinkage | null;
|
|
6049
|
-
}
|
|
6050
6084
|
export interface JsonApiKnowledgeRecommendationOutWithLinks {
|
|
6051
6085
|
/**
|
|
6052
6086
|
* Object type
|
|
@@ -6056,9 +6090,9 @@ export interface JsonApiKnowledgeRecommendationOutWithLinks {
|
|
|
6056
6090
|
* API identifier of an object
|
|
6057
6091
|
*/
|
|
6058
6092
|
'id': string;
|
|
6059
|
-
'meta'?:
|
|
6093
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
6060
6094
|
'attributes': JsonApiKnowledgeRecommendationOutAttributes;
|
|
6061
|
-
'relationships'?:
|
|
6095
|
+
'relationships'?: JsonApiKnowledgeRecommendationPatchRelationships;
|
|
6062
6096
|
'links'?: ObjectLinks;
|
|
6063
6097
|
}
|
|
6064
6098
|
export type JsonApiKnowledgeRecommendationOutWithLinksTypeEnum = 'knowledgeRecommendation';
|
|
@@ -6075,7 +6109,7 @@ export interface JsonApiKnowledgeRecommendationPatch {
|
|
|
6075
6109
|
*/
|
|
6076
6110
|
'id': string;
|
|
6077
6111
|
'attributes': JsonApiKnowledgeRecommendationPatchAttributes;
|
|
6078
|
-
'relationships':
|
|
6112
|
+
'relationships': JsonApiKnowledgeRecommendationPatchRelationships;
|
|
6079
6113
|
}
|
|
6080
6114
|
export type JsonApiKnowledgeRecommendationPatchTypeEnum = 'knowledgeRecommendation';
|
|
6081
6115
|
export interface JsonApiKnowledgeRecommendationPatchAttributes {
|
|
@@ -6147,6 +6181,13 @@ export type JsonApiKnowledgeRecommendationPatchAttributesComparisonTypeEnum = 'M
|
|
|
6147
6181
|
export interface JsonApiKnowledgeRecommendationPatchDocument {
|
|
6148
6182
|
'data': JsonApiKnowledgeRecommendationPatch;
|
|
6149
6183
|
}
|
|
6184
|
+
export interface JsonApiKnowledgeRecommendationPatchRelationships {
|
|
6185
|
+
'metric'?: JsonApiKnowledgeRecommendationPatchRelationshipsMetric;
|
|
6186
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
6187
|
+
}
|
|
6188
|
+
export interface JsonApiKnowledgeRecommendationPatchRelationshipsMetric {
|
|
6189
|
+
'data': JsonApiMetricLinkage | null;
|
|
6190
|
+
}
|
|
6150
6191
|
/**
|
|
6151
6192
|
* JSON:API representation of knowledgeRecommendation entity.
|
|
6152
6193
|
*/
|
|
@@ -6159,83 +6200,13 @@ export interface JsonApiKnowledgeRecommendationPostOptionalId {
|
|
|
6159
6200
|
* API identifier of an object
|
|
6160
6201
|
*/
|
|
6161
6202
|
'id'?: string;
|
|
6162
|
-
'attributes':
|
|
6163
|
-
'relationships':
|
|
6203
|
+
'attributes': JsonApiKnowledgeRecommendationInAttributes;
|
|
6204
|
+
'relationships': JsonApiKnowledgeRecommendationInRelationships;
|
|
6164
6205
|
}
|
|
6165
6206
|
export type JsonApiKnowledgeRecommendationPostOptionalIdTypeEnum = 'knowledgeRecommendation';
|
|
6166
|
-
export interface JsonApiKnowledgeRecommendationPostOptionalIdAttributes {
|
|
6167
|
-
/**
|
|
6168
|
-
* Human-readable title for the recommendation, e.g. \'Revenue decreased vs last month\'
|
|
6169
|
-
*/
|
|
6170
|
-
'title': string;
|
|
6171
|
-
/**
|
|
6172
|
-
* Description of the recommendation
|
|
6173
|
-
*/
|
|
6174
|
-
'description'?: string;
|
|
6175
|
-
'tags'?: Array<string>;
|
|
6176
|
-
'areRelationsValid'?: boolean;
|
|
6177
|
-
/**
|
|
6178
|
-
* Human-readable title of the metric (denormalized for display)
|
|
6179
|
-
*/
|
|
6180
|
-
'metricTitle'?: string;
|
|
6181
|
-
/**
|
|
6182
|
-
* Direction of the metric change
|
|
6183
|
-
*/
|
|
6184
|
-
'direction': JsonApiKnowledgeRecommendationPostOptionalIdAttributesDirectionEnum;
|
|
6185
|
-
/**
|
|
6186
|
-
* Time period for comparison
|
|
6187
|
-
*/
|
|
6188
|
-
'comparisonType': JsonApiKnowledgeRecommendationPostOptionalIdAttributesComparisonTypeEnum;
|
|
6189
|
-
/**
|
|
6190
|
-
* ID of the widget where the anomaly was detected
|
|
6191
|
-
*/
|
|
6192
|
-
'widgetId'?: string;
|
|
6193
|
-
/**
|
|
6194
|
-
* Name of the widget where the anomaly was detected
|
|
6195
|
-
*/
|
|
6196
|
-
'widgetName'?: string;
|
|
6197
|
-
/**
|
|
6198
|
-
* Confidence score (0.0 to 1.0)
|
|
6199
|
-
*/
|
|
6200
|
-
'confidence'?: any;
|
|
6201
|
-
/**
|
|
6202
|
-
* Structured recommendations data as JSON
|
|
6203
|
-
*/
|
|
6204
|
-
'recommendations'?: object;
|
|
6205
|
-
/**
|
|
6206
|
-
* Number of source documents used for generation
|
|
6207
|
-
*/
|
|
6208
|
-
'sourceCount'?: number;
|
|
6209
|
-
/**
|
|
6210
|
-
* Reference time period for comparison (e.g., \'2023-06\' or \'Jun 2023\')
|
|
6211
|
-
*/
|
|
6212
|
-
'referencePeriod'?: string;
|
|
6213
|
-
/**
|
|
6214
|
-
* Analyzed time period (e.g., \'2023-07\' or \'July 2023\')
|
|
6215
|
-
*/
|
|
6216
|
-
'analyzedPeriod'?: string;
|
|
6217
|
-
/**
|
|
6218
|
-
* Metric value in the reference period
|
|
6219
|
-
*/
|
|
6220
|
-
'referenceValue'?: any;
|
|
6221
|
-
/**
|
|
6222
|
-
* Metric value in the analyzed period (the observed value that triggered the anomaly)
|
|
6223
|
-
*/
|
|
6224
|
-
'analyzedValue'?: any;
|
|
6225
|
-
/**
|
|
6226
|
-
* Human-readable title of the analytical dashboard (denormalized for display)
|
|
6227
|
-
*/
|
|
6228
|
-
'analyticalDashboardTitle'?: string;
|
|
6229
|
-
}
|
|
6230
|
-
export type JsonApiKnowledgeRecommendationPostOptionalIdAttributesDirectionEnum = 'INCREASED' | 'DECREASED';
|
|
6231
|
-
export type JsonApiKnowledgeRecommendationPostOptionalIdAttributesComparisonTypeEnum = 'MONTH' | 'QUARTER' | 'YEAR';
|
|
6232
6207
|
export interface JsonApiKnowledgeRecommendationPostOptionalIdDocument {
|
|
6233
6208
|
'data': JsonApiKnowledgeRecommendationPostOptionalId;
|
|
6234
6209
|
}
|
|
6235
|
-
export interface JsonApiKnowledgeRecommendationPostOptionalIdRelationships {
|
|
6236
|
-
'metric': JsonApiKnowledgeRecommendationOutRelationshipsMetric;
|
|
6237
|
-
'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
6238
|
-
}
|
|
6239
6210
|
/**
|
|
6240
6211
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
6241
6212
|
*/
|
|
@@ -6256,7 +6227,7 @@ export interface JsonApiLabelOut {
|
|
|
6256
6227
|
* API identifier of an object
|
|
6257
6228
|
*/
|
|
6258
6229
|
'id': string;
|
|
6259
|
-
'meta'?:
|
|
6230
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
6260
6231
|
'attributes'?: JsonApiLabelOutAttributes;
|
|
6261
6232
|
'relationships'?: JsonApiLabelOutRelationships;
|
|
6262
6233
|
}
|
|
@@ -6303,7 +6274,7 @@ export interface JsonApiLabelOutDocument {
|
|
|
6303
6274
|
export interface JsonApiLabelOutList {
|
|
6304
6275
|
'data': Array<JsonApiLabelOutWithLinks>;
|
|
6305
6276
|
'links'?: ListLinks;
|
|
6306
|
-
'meta'?:
|
|
6277
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
6307
6278
|
/**
|
|
6308
6279
|
* Included resources
|
|
6309
6280
|
*/
|
|
@@ -6324,7 +6295,7 @@ export interface JsonApiLabelOutWithLinks {
|
|
|
6324
6295
|
* API identifier of an object
|
|
6325
6296
|
*/
|
|
6326
6297
|
'id': string;
|
|
6327
|
-
'meta'?:
|
|
6298
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
6328
6299
|
'attributes'?: JsonApiLabelOutAttributes;
|
|
6329
6300
|
'relationships'?: JsonApiLabelOutRelationships;
|
|
6330
6301
|
'links'?: ObjectLinks;
|
|
@@ -6441,7 +6412,7 @@ export interface JsonApiLlmEndpointOutDocument {
|
|
|
6441
6412
|
export interface JsonApiLlmEndpointOutList {
|
|
6442
6413
|
'data': Array<JsonApiLlmEndpointOutWithLinks>;
|
|
6443
6414
|
'links'?: ListLinks;
|
|
6444
|
-
'meta'?:
|
|
6415
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
6445
6416
|
}
|
|
6446
6417
|
export interface JsonApiLlmEndpointOutWithLinks {
|
|
6447
6418
|
/**
|
|
@@ -6540,12 +6511,31 @@ export interface JsonApiLlmProviderOutAttributes {
|
|
|
6540
6511
|
* Description of the LLM Provider.
|
|
6541
6512
|
*/
|
|
6542
6513
|
'description'?: string | null;
|
|
6543
|
-
'providerConfig':
|
|
6514
|
+
'providerConfig': JsonApiLlmProviderOutAttributesProviderConfig;
|
|
6544
6515
|
/**
|
|
6545
6516
|
* List of LLM models available for this provider.
|
|
6546
6517
|
*/
|
|
6547
|
-
'models': Array<
|
|
6518
|
+
'models': Array<JsonApiLlmProviderOutAttributesModelsInner> | null;
|
|
6519
|
+
}
|
|
6520
|
+
/**
|
|
6521
|
+
* LLM Model configuration (id, family) within a provider.
|
|
6522
|
+
*/
|
|
6523
|
+
export interface JsonApiLlmProviderOutAttributesModelsInner {
|
|
6524
|
+
/**
|
|
6525
|
+
* Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
|
|
6526
|
+
*/
|
|
6527
|
+
'id': string;
|
|
6528
|
+
/**
|
|
6529
|
+
* Family of LLM models.
|
|
6530
|
+
*/
|
|
6531
|
+
'family': JsonApiLlmProviderOutAttributesModelsInnerFamilyEnum;
|
|
6548
6532
|
}
|
|
6533
|
+
export type JsonApiLlmProviderOutAttributesModelsInnerFamilyEnum = 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE';
|
|
6534
|
+
/**
|
|
6535
|
+
* @type JsonApiLlmProviderOutAttributesProviderConfig
|
|
6536
|
+
* Provider-specific configuration including authentication.
|
|
6537
|
+
*/
|
|
6538
|
+
export type JsonApiLlmProviderOutAttributesProviderConfig = AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
6549
6539
|
export interface JsonApiLlmProviderOutDocument {
|
|
6550
6540
|
'data': JsonApiLlmProviderOut;
|
|
6551
6541
|
'links'?: ObjectLinks;
|
|
@@ -6556,7 +6546,7 @@ export interface JsonApiLlmProviderOutDocument {
|
|
|
6556
6546
|
export interface JsonApiLlmProviderOutList {
|
|
6557
6547
|
'data': Array<JsonApiLlmProviderOutWithLinks>;
|
|
6558
6548
|
'links'?: ListLinks;
|
|
6559
|
-
'meta'?:
|
|
6549
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
6560
6550
|
}
|
|
6561
6551
|
export interface JsonApiLlmProviderOutWithLinks {
|
|
6562
6552
|
/**
|
|
@@ -6592,31 +6582,12 @@ export interface JsonApiLlmProviderPatchAttributes {
|
|
|
6592
6582
|
* Description of the LLM Provider.
|
|
6593
6583
|
*/
|
|
6594
6584
|
'description'?: string | null;
|
|
6595
|
-
'providerConfig'?:
|
|
6585
|
+
'providerConfig'?: JsonApiLlmProviderOutAttributesProviderConfig;
|
|
6596
6586
|
/**
|
|
6597
6587
|
* List of LLM models available for this provider.
|
|
6598
6588
|
*/
|
|
6599
|
-
'models'?: Array<
|
|
6589
|
+
'models'?: Array<JsonApiLlmProviderOutAttributesModelsInner> | null;
|
|
6600
6590
|
}
|
|
6601
|
-
/**
|
|
6602
|
-
* LLM Model configuration (id, family) within a provider.
|
|
6603
|
-
*/
|
|
6604
|
-
export interface JsonApiLlmProviderPatchAttributesModelsInner {
|
|
6605
|
-
/**
|
|
6606
|
-
* Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
|
|
6607
|
-
*/
|
|
6608
|
-
'id': string;
|
|
6609
|
-
/**
|
|
6610
|
-
* Family of LLM models.
|
|
6611
|
-
*/
|
|
6612
|
-
'family': JsonApiLlmProviderPatchAttributesModelsInnerFamilyEnum;
|
|
6613
|
-
}
|
|
6614
|
-
export type JsonApiLlmProviderPatchAttributesModelsInnerFamilyEnum = 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE';
|
|
6615
|
-
/**
|
|
6616
|
-
* @type JsonApiLlmProviderPatchAttributesProviderConfig
|
|
6617
|
-
* Provider-specific configuration including authentication.
|
|
6618
|
-
*/
|
|
6619
|
-
export type JsonApiLlmProviderPatchAttributesProviderConfig = AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
6620
6591
|
export interface JsonApiLlmProviderPatchDocument {
|
|
6621
6592
|
'data': JsonApiLlmProviderPatch;
|
|
6622
6593
|
}
|
|
@@ -6632,9 +6603,32 @@ export interface JsonApiMemoryItemIn {
|
|
|
6632
6603
|
* API identifier of an object
|
|
6633
6604
|
*/
|
|
6634
6605
|
'id': string;
|
|
6635
|
-
'attributes':
|
|
6606
|
+
'attributes': JsonApiMemoryItemInAttributes;
|
|
6636
6607
|
}
|
|
6637
6608
|
export type JsonApiMemoryItemInTypeEnum = 'memoryItem';
|
|
6609
|
+
export interface JsonApiMemoryItemInAttributes {
|
|
6610
|
+
'title'?: string;
|
|
6611
|
+
'description'?: string;
|
|
6612
|
+
'tags'?: Array<string>;
|
|
6613
|
+
'areRelationsValid'?: boolean;
|
|
6614
|
+
/**
|
|
6615
|
+
* Strategy defining when the memory item should be applied
|
|
6616
|
+
*/
|
|
6617
|
+
'strategy': JsonApiMemoryItemInAttributesStrategyEnum;
|
|
6618
|
+
/**
|
|
6619
|
+
* The text that will be injected into the system prompt
|
|
6620
|
+
*/
|
|
6621
|
+
'instruction': string;
|
|
6622
|
+
/**
|
|
6623
|
+
* Set of unique strings used for semantic similarity filtering
|
|
6624
|
+
*/
|
|
6625
|
+
'keywords'?: Array<string>;
|
|
6626
|
+
/**
|
|
6627
|
+
* Whether memory item is disabled
|
|
6628
|
+
*/
|
|
6629
|
+
'isDisabled'?: boolean;
|
|
6630
|
+
}
|
|
6631
|
+
export type JsonApiMemoryItemInAttributesStrategyEnum = 'ALWAYS' | 'AUTO';
|
|
6638
6632
|
export interface JsonApiMemoryItemInDocument {
|
|
6639
6633
|
'data': JsonApiMemoryItemIn;
|
|
6640
6634
|
}
|
|
@@ -6650,7 +6644,7 @@ export interface JsonApiMemoryItemOut {
|
|
|
6650
6644
|
* API identifier of an object
|
|
6651
6645
|
*/
|
|
6652
6646
|
'id': string;
|
|
6653
|
-
'meta'?:
|
|
6647
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
6654
6648
|
'attributes': JsonApiMemoryItemOutAttributes;
|
|
6655
6649
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
6656
6650
|
}
|
|
@@ -6700,7 +6694,7 @@ export interface JsonApiMemoryItemOutDocument {
|
|
|
6700
6694
|
export interface JsonApiMemoryItemOutList {
|
|
6701
6695
|
'data': Array<JsonApiMemoryItemOutWithLinks>;
|
|
6702
6696
|
'links'?: ListLinks;
|
|
6703
|
-
'meta'?:
|
|
6697
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
6704
6698
|
/**
|
|
6705
6699
|
* Included resources
|
|
6706
6700
|
*/
|
|
@@ -6715,7 +6709,7 @@ export interface JsonApiMemoryItemOutWithLinks {
|
|
|
6715
6709
|
* API identifier of an object
|
|
6716
6710
|
*/
|
|
6717
6711
|
'id': string;
|
|
6718
|
-
'meta'?:
|
|
6712
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
6719
6713
|
'attributes': JsonApiMemoryItemOutAttributes;
|
|
6720
6714
|
'relationships'?: JsonApiDashboardPluginOutRelationships;
|
|
6721
6715
|
'links'?: ObjectLinks;
|
|
@@ -6759,47 +6753,24 @@ export interface JsonApiMemoryItemPatchAttributes {
|
|
|
6759
6753
|
'isDisabled'?: boolean;
|
|
6760
6754
|
}
|
|
6761
6755
|
export type JsonApiMemoryItemPatchAttributesStrategyEnum = 'ALWAYS' | 'AUTO';
|
|
6762
|
-
export interface JsonApiMemoryItemPatchDocument {
|
|
6763
|
-
'data': JsonApiMemoryItemPatch;
|
|
6764
|
-
}
|
|
6765
|
-
/**
|
|
6766
|
-
* JSON:API representation of memoryItem entity.
|
|
6767
|
-
*/
|
|
6768
|
-
export interface JsonApiMemoryItemPostOptionalId {
|
|
6769
|
-
/**
|
|
6770
|
-
* Object type
|
|
6771
|
-
*/
|
|
6772
|
-
'type': JsonApiMemoryItemPostOptionalIdTypeEnum;
|
|
6773
|
-
/**
|
|
6774
|
-
* API identifier of an object
|
|
6775
|
-
*/
|
|
6776
|
-
'id'?: string;
|
|
6777
|
-
'attributes': JsonApiMemoryItemPostOptionalIdAttributes;
|
|
6778
|
-
}
|
|
6779
|
-
export type JsonApiMemoryItemPostOptionalIdTypeEnum = 'memoryItem';
|
|
6780
|
-
export interface JsonApiMemoryItemPostOptionalIdAttributes {
|
|
6781
|
-
'title'?: string;
|
|
6782
|
-
'description'?: string;
|
|
6783
|
-
'tags'?: Array<string>;
|
|
6784
|
-
'areRelationsValid'?: boolean;
|
|
6785
|
-
/**
|
|
6786
|
-
* Strategy defining when the memory item should be applied
|
|
6787
|
-
*/
|
|
6788
|
-
'strategy': JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum;
|
|
6789
|
-
/**
|
|
6790
|
-
* The text that will be injected into the system prompt
|
|
6791
|
-
*/
|
|
6792
|
-
'instruction': string;
|
|
6756
|
+
export interface JsonApiMemoryItemPatchDocument {
|
|
6757
|
+
'data': JsonApiMemoryItemPatch;
|
|
6758
|
+
}
|
|
6759
|
+
/**
|
|
6760
|
+
* JSON:API representation of memoryItem entity.
|
|
6761
|
+
*/
|
|
6762
|
+
export interface JsonApiMemoryItemPostOptionalId {
|
|
6793
6763
|
/**
|
|
6794
|
-
*
|
|
6764
|
+
* Object type
|
|
6795
6765
|
*/
|
|
6796
|
-
'
|
|
6766
|
+
'type': JsonApiMemoryItemPostOptionalIdTypeEnum;
|
|
6797
6767
|
/**
|
|
6798
|
-
*
|
|
6768
|
+
* API identifier of an object
|
|
6799
6769
|
*/
|
|
6800
|
-
'
|
|
6770
|
+
'id'?: string;
|
|
6771
|
+
'attributes': JsonApiMemoryItemInAttributes;
|
|
6801
6772
|
}
|
|
6802
|
-
export type
|
|
6773
|
+
export type JsonApiMemoryItemPostOptionalIdTypeEnum = 'memoryItem';
|
|
6803
6774
|
export interface JsonApiMemoryItemPostOptionalIdDocument {
|
|
6804
6775
|
'data': JsonApiMemoryItemPostOptionalId;
|
|
6805
6776
|
}
|
|
@@ -6815,9 +6786,18 @@ export interface JsonApiMetricIn {
|
|
|
6815
6786
|
* API identifier of an object
|
|
6816
6787
|
*/
|
|
6817
6788
|
'id': string;
|
|
6818
|
-
'attributes':
|
|
6789
|
+
'attributes': JsonApiMetricInAttributes;
|
|
6819
6790
|
}
|
|
6820
6791
|
export type JsonApiMetricInTypeEnum = 'metric';
|
|
6792
|
+
export interface JsonApiMetricInAttributes {
|
|
6793
|
+
'title'?: string;
|
|
6794
|
+
'description'?: string;
|
|
6795
|
+
'tags'?: Array<string>;
|
|
6796
|
+
'areRelationsValid'?: boolean;
|
|
6797
|
+
'content': JsonApiMetricOutAttributesContent;
|
|
6798
|
+
'isHidden'?: boolean;
|
|
6799
|
+
'isHiddenFromKda'?: boolean;
|
|
6800
|
+
}
|
|
6821
6801
|
export interface JsonApiMetricInDocument {
|
|
6822
6802
|
'data': JsonApiMetricIn;
|
|
6823
6803
|
}
|
|
@@ -6841,7 +6821,7 @@ export interface JsonApiMetricOut {
|
|
|
6841
6821
|
* API identifier of an object
|
|
6842
6822
|
*/
|
|
6843
6823
|
'id': string;
|
|
6844
|
-
'meta'?:
|
|
6824
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
6845
6825
|
'attributes': JsonApiMetricOutAttributes;
|
|
6846
6826
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
6847
6827
|
}
|
|
@@ -6906,7 +6886,7 @@ export type JsonApiMetricOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDat
|
|
|
6906
6886
|
export interface JsonApiMetricOutList {
|
|
6907
6887
|
'data': Array<JsonApiMetricOutWithLinks>;
|
|
6908
6888
|
'links'?: ListLinks;
|
|
6909
|
-
'meta'?:
|
|
6889
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
6910
6890
|
/**
|
|
6911
6891
|
* Included resources
|
|
6912
6892
|
*/
|
|
@@ -6921,7 +6901,7 @@ export interface JsonApiMetricOutWithLinks {
|
|
|
6921
6901
|
* API identifier of an object
|
|
6922
6902
|
*/
|
|
6923
6903
|
'id': string;
|
|
6924
|
-
'meta'?:
|
|
6904
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
6925
6905
|
'attributes': JsonApiMetricOutAttributes;
|
|
6926
6906
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
6927
6907
|
'links'?: ObjectLinks;
|
|
@@ -6966,18 +6946,9 @@ export interface JsonApiMetricPostOptionalId {
|
|
|
6966
6946
|
* API identifier of an object
|
|
6967
6947
|
*/
|
|
6968
6948
|
'id'?: string;
|
|
6969
|
-
'attributes':
|
|
6949
|
+
'attributes': JsonApiMetricInAttributes;
|
|
6970
6950
|
}
|
|
6971
6951
|
export type JsonApiMetricPostOptionalIdTypeEnum = 'metric';
|
|
6972
|
-
export interface JsonApiMetricPostOptionalIdAttributes {
|
|
6973
|
-
'title'?: string;
|
|
6974
|
-
'description'?: string;
|
|
6975
|
-
'tags'?: Array<string>;
|
|
6976
|
-
'areRelationsValid'?: boolean;
|
|
6977
|
-
'content': JsonApiMetricOutAttributesContent;
|
|
6978
|
-
'isHidden'?: boolean;
|
|
6979
|
-
'isHiddenFromKda'?: boolean;
|
|
6980
|
-
}
|
|
6981
6952
|
export interface JsonApiMetricPostOptionalIdDocument {
|
|
6982
6953
|
'data': JsonApiMetricPostOptionalId;
|
|
6983
6954
|
}
|
|
@@ -7017,7 +6988,7 @@ export interface JsonApiNotificationChannelIdentifierOutDocument {
|
|
|
7017
6988
|
export interface JsonApiNotificationChannelIdentifierOutList {
|
|
7018
6989
|
'data': Array<JsonApiNotificationChannelIdentifierOutWithLinks>;
|
|
7019
6990
|
'links'?: ListLinks;
|
|
7020
|
-
'meta'?:
|
|
6991
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
7021
6992
|
}
|
|
7022
6993
|
export interface JsonApiNotificationChannelIdentifierOutWithLinks {
|
|
7023
6994
|
/**
|
|
@@ -7044,9 +7015,37 @@ export interface JsonApiNotificationChannelIn {
|
|
|
7044
7015
|
* API identifier of an object
|
|
7045
7016
|
*/
|
|
7046
7017
|
'id': string;
|
|
7047
|
-
'attributes'?:
|
|
7018
|
+
'attributes'?: JsonApiNotificationChannelInAttributes;
|
|
7048
7019
|
}
|
|
7049
7020
|
export type JsonApiNotificationChannelInTypeEnum = 'notificationChannel';
|
|
7021
|
+
export interface JsonApiNotificationChannelInAttributes {
|
|
7022
|
+
'name'?: string | null;
|
|
7023
|
+
'description'?: string | null;
|
|
7024
|
+
'destination'?: JsonApiNotificationChannelOutAttributesDestination;
|
|
7025
|
+
/**
|
|
7026
|
+
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
7027
|
+
*/
|
|
7028
|
+
'customDashboardUrl'?: string;
|
|
7029
|
+
/**
|
|
7030
|
+
* 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
|
|
7031
|
+
*/
|
|
7032
|
+
'dashboardLinkVisibility'?: JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum;
|
|
7033
|
+
/**
|
|
7034
|
+
* 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}}
|
|
7035
|
+
*/
|
|
7036
|
+
'notificationSource'?: string;
|
|
7037
|
+
/**
|
|
7038
|
+
* 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
|
|
7039
|
+
*/
|
|
7040
|
+
'allowedRecipients'?: JsonApiNotificationChannelInAttributesAllowedRecipientsEnum;
|
|
7041
|
+
/**
|
|
7042
|
+
* 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
|
|
7043
|
+
*/
|
|
7044
|
+
'inPlatformNotification'?: JsonApiNotificationChannelInAttributesInPlatformNotificationEnum;
|
|
7045
|
+
}
|
|
7046
|
+
export type JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
|
|
7047
|
+
export type JsonApiNotificationChannelInAttributesAllowedRecipientsEnum = 'CREATOR' | 'INTERNAL' | 'EXTERNAL';
|
|
7048
|
+
export type JsonApiNotificationChannelInAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
|
|
7050
7049
|
export interface JsonApiNotificationChannelInDocument {
|
|
7051
7050
|
'data': JsonApiNotificationChannelIn;
|
|
7052
7051
|
}
|
|
@@ -7076,7 +7075,7 @@ export type JsonApiNotificationChannelOutTypeEnum = 'notificationChannel';
|
|
|
7076
7075
|
export interface JsonApiNotificationChannelOutAttributes {
|
|
7077
7076
|
'name'?: string | null;
|
|
7078
7077
|
'description'?: string | null;
|
|
7079
|
-
'destination'?:
|
|
7078
|
+
'destination'?: JsonApiNotificationChannelOutAttributesDestination;
|
|
7080
7079
|
'destinationType'?: JsonApiNotificationChannelOutAttributesDestinationTypeEnum | null;
|
|
7081
7080
|
/**
|
|
7082
7081
|
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
@@ -7103,6 +7102,11 @@ export type JsonApiNotificationChannelOutAttributesDestinationTypeEnum = 'WEBHOO
|
|
|
7103
7102
|
export type JsonApiNotificationChannelOutAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
|
|
7104
7103
|
export type JsonApiNotificationChannelOutAttributesAllowedRecipientsEnum = 'CREATOR' | 'INTERNAL' | 'EXTERNAL';
|
|
7105
7104
|
export type JsonApiNotificationChannelOutAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
|
|
7105
|
+
/**
|
|
7106
|
+
* @type JsonApiNotificationChannelOutAttributesDestination
|
|
7107
|
+
* The destination where the notifications are to be sent.
|
|
7108
|
+
*/
|
|
7109
|
+
export type JsonApiNotificationChannelOutAttributesDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
7106
7110
|
export interface JsonApiNotificationChannelOutDocument {
|
|
7107
7111
|
'data': JsonApiNotificationChannelOut;
|
|
7108
7112
|
'links'?: ObjectLinks;
|
|
@@ -7113,7 +7117,7 @@ export interface JsonApiNotificationChannelOutDocument {
|
|
|
7113
7117
|
export interface JsonApiNotificationChannelOutList {
|
|
7114
7118
|
'data': Array<JsonApiNotificationChannelOutWithLinks>;
|
|
7115
7119
|
'links'?: ListLinks;
|
|
7116
|
-
'meta'?:
|
|
7120
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
7117
7121
|
}
|
|
7118
7122
|
export interface JsonApiNotificationChannelOutWithLinks {
|
|
7119
7123
|
/**
|
|
@@ -7140,42 +7144,9 @@ export interface JsonApiNotificationChannelPatch {
|
|
|
7140
7144
|
* API identifier of an object
|
|
7141
7145
|
*/
|
|
7142
7146
|
'id': string;
|
|
7143
|
-
'attributes'?:
|
|
7147
|
+
'attributes'?: JsonApiNotificationChannelInAttributes;
|
|
7144
7148
|
}
|
|
7145
7149
|
export type JsonApiNotificationChannelPatchTypeEnum = 'notificationChannel';
|
|
7146
|
-
export interface JsonApiNotificationChannelPatchAttributes {
|
|
7147
|
-
'name'?: string | null;
|
|
7148
|
-
'description'?: string | null;
|
|
7149
|
-
'destination'?: JsonApiNotificationChannelPatchAttributesDestination;
|
|
7150
|
-
/**
|
|
7151
|
-
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
7152
|
-
*/
|
|
7153
|
-
'customDashboardUrl'?: string;
|
|
7154
|
-
/**
|
|
7155
|
-
* Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
|
|
7156
|
-
*/
|
|
7157
|
-
'dashboardLinkVisibility'?: JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum;
|
|
7158
|
-
/**
|
|
7159
|
-
* Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
|
|
7160
|
-
*/
|
|
7161
|
-
'notificationSource'?: string;
|
|
7162
|
-
/**
|
|
7163
|
-
* Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
|
|
7164
|
-
*/
|
|
7165
|
-
'allowedRecipients'?: JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum;
|
|
7166
|
-
/**
|
|
7167
|
-
* In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
|
|
7168
|
-
*/
|
|
7169
|
-
'inPlatformNotification'?: JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum;
|
|
7170
|
-
}
|
|
7171
|
-
export type JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
|
|
7172
|
-
export type JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum = 'CREATOR' | 'INTERNAL' | 'EXTERNAL';
|
|
7173
|
-
export type JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
|
|
7174
|
-
/**
|
|
7175
|
-
* @type JsonApiNotificationChannelPatchAttributesDestination
|
|
7176
|
-
* The destination where the notifications are to be sent.
|
|
7177
|
-
*/
|
|
7178
|
-
export type JsonApiNotificationChannelPatchAttributesDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
7179
7150
|
export interface JsonApiNotificationChannelPatchDocument {
|
|
7180
7151
|
'data': JsonApiNotificationChannelPatch;
|
|
7181
7152
|
}
|
|
@@ -7191,7 +7162,7 @@ export interface JsonApiNotificationChannelPostOptionalId {
|
|
|
7191
7162
|
* API identifier of an object
|
|
7192
7163
|
*/
|
|
7193
7164
|
'id'?: string;
|
|
7194
|
-
'attributes'?:
|
|
7165
|
+
'attributes'?: JsonApiNotificationChannelInAttributes;
|
|
7195
7166
|
}
|
|
7196
7167
|
export type JsonApiNotificationChannelPostOptionalIdTypeEnum = 'notificationChannel';
|
|
7197
7168
|
export interface JsonApiNotificationChannelPostOptionalIdDocument {
|
|
@@ -7209,13 +7180,30 @@ export interface JsonApiOrganizationIn {
|
|
|
7209
7180
|
* API identifier of an object
|
|
7210
7181
|
*/
|
|
7211
7182
|
'id': string;
|
|
7212
|
-
'attributes'?:
|
|
7213
|
-
'relationships'?:
|
|
7183
|
+
'attributes'?: JsonApiOrganizationInAttributes;
|
|
7184
|
+
'relationships'?: JsonApiOrganizationInRelationships;
|
|
7214
7185
|
}
|
|
7215
7186
|
export type JsonApiOrganizationInTypeEnum = 'organization';
|
|
7187
|
+
export interface JsonApiOrganizationInAttributes {
|
|
7188
|
+
'name'?: string | null;
|
|
7189
|
+
'hostname'?: string;
|
|
7190
|
+
'allowedOrigins'?: Array<string>;
|
|
7191
|
+
/**
|
|
7192
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
7193
|
+
* @deprecated
|
|
7194
|
+
*/
|
|
7195
|
+
'earlyAccess'?: string | null;
|
|
7196
|
+
/**
|
|
7197
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
7198
|
+
*/
|
|
7199
|
+
'earlyAccessValues'?: Array<string> | null;
|
|
7200
|
+
}
|
|
7216
7201
|
export interface JsonApiOrganizationInDocument {
|
|
7217
7202
|
'data': JsonApiOrganizationIn;
|
|
7218
7203
|
}
|
|
7204
|
+
export interface JsonApiOrganizationInRelationships {
|
|
7205
|
+
'identityProvider'?: JsonApiOrganizationOutRelationshipsIdentityProvider;
|
|
7206
|
+
}
|
|
7219
7207
|
/**
|
|
7220
7208
|
* JSON:API representation of organization entity.
|
|
7221
7209
|
*/
|
|
@@ -7281,15 +7269,12 @@ export interface JsonApiOrganizationOutMeta {
|
|
|
7281
7269
|
}
|
|
7282
7270
|
export type JsonApiOrganizationOutMetaPermissionsEnum = 'MANAGE' | 'SELF_CREATE_TOKEN' | 'BASE_UI_ACCESS';
|
|
7283
7271
|
export interface JsonApiOrganizationOutRelationships {
|
|
7284
|
-
'bootstrapUser'?:
|
|
7285
|
-
'bootstrapUserGroup'?:
|
|
7286
|
-
'identityProvider'?:
|
|
7272
|
+
'bootstrapUser'?: JsonApiFilterViewPatchRelationshipsUser;
|
|
7273
|
+
'bootstrapUserGroup'?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
7274
|
+
'identityProvider'?: JsonApiOrganizationOutRelationshipsIdentityProvider;
|
|
7287
7275
|
}
|
|
7288
|
-
export interface
|
|
7289
|
-
'data':
|
|
7290
|
-
}
|
|
7291
|
-
export interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup {
|
|
7292
|
-
'data': JsonApiUserGroupLinkage | null;
|
|
7276
|
+
export interface JsonApiOrganizationOutRelationshipsIdentityProvider {
|
|
7277
|
+
'data': JsonApiIdentityProviderLinkage | null;
|
|
7293
7278
|
}
|
|
7294
7279
|
/**
|
|
7295
7280
|
* JSON:API representation of patching organization entity.
|
|
@@ -7303,33 +7288,13 @@ export interface JsonApiOrganizationPatch {
|
|
|
7303
7288
|
* API identifier of an object
|
|
7304
7289
|
*/
|
|
7305
7290
|
'id': string;
|
|
7306
|
-
'attributes'?:
|
|
7307
|
-
'relationships'?:
|
|
7291
|
+
'attributes'?: JsonApiOrganizationInAttributes;
|
|
7292
|
+
'relationships'?: JsonApiOrganizationInRelationships;
|
|
7308
7293
|
}
|
|
7309
7294
|
export type JsonApiOrganizationPatchTypeEnum = 'organization';
|
|
7310
|
-
export interface JsonApiOrganizationPatchAttributes {
|
|
7311
|
-
'name'?: string | null;
|
|
7312
|
-
'hostname'?: string;
|
|
7313
|
-
'allowedOrigins'?: Array<string>;
|
|
7314
|
-
/**
|
|
7315
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
7316
|
-
* @deprecated
|
|
7317
|
-
*/
|
|
7318
|
-
'earlyAccess'?: string | null;
|
|
7319
|
-
/**
|
|
7320
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
7321
|
-
*/
|
|
7322
|
-
'earlyAccessValues'?: Array<string> | null;
|
|
7323
|
-
}
|
|
7324
7295
|
export interface JsonApiOrganizationPatchDocument {
|
|
7325
7296
|
'data': JsonApiOrganizationPatch;
|
|
7326
7297
|
}
|
|
7327
|
-
export interface JsonApiOrganizationPatchRelationships {
|
|
7328
|
-
'identityProvider'?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
7329
|
-
}
|
|
7330
|
-
export interface JsonApiOrganizationPatchRelationshipsIdentityProvider {
|
|
7331
|
-
'data': JsonApiIdentityProviderLinkage | null;
|
|
7332
|
-
}
|
|
7333
7298
|
/**
|
|
7334
7299
|
* JSON:API representation of organizationSetting entity.
|
|
7335
7300
|
*/
|
|
@@ -7342,7 +7307,7 @@ export interface JsonApiOrganizationSettingIn {
|
|
|
7342
7307
|
* API identifier of an object
|
|
7343
7308
|
*/
|
|
7344
7309
|
'id': string;
|
|
7345
|
-
'attributes'?:
|
|
7310
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
7346
7311
|
}
|
|
7347
7312
|
export type JsonApiOrganizationSettingInTypeEnum = 'organizationSetting';
|
|
7348
7313
|
export interface JsonApiOrganizationSettingInDocument {
|
|
@@ -7360,9 +7325,17 @@ export interface JsonApiOrganizationSettingOut {
|
|
|
7360
7325
|
* API identifier of an object
|
|
7361
7326
|
*/
|
|
7362
7327
|
'id': string;
|
|
7363
|
-
'attributes'?:
|
|
7328
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
7364
7329
|
}
|
|
7365
7330
|
export type JsonApiOrganizationSettingOutTypeEnum = 'organizationSetting';
|
|
7331
|
+
export interface JsonApiOrganizationSettingOutAttributes {
|
|
7332
|
+
/**
|
|
7333
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
7334
|
+
*/
|
|
7335
|
+
'content'?: object;
|
|
7336
|
+
'type'?: JsonApiOrganizationSettingOutAttributesTypeEnum;
|
|
7337
|
+
}
|
|
7338
|
+
export type JsonApiOrganizationSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS';
|
|
7366
7339
|
export interface JsonApiOrganizationSettingOutDocument {
|
|
7367
7340
|
'data': JsonApiOrganizationSettingOut;
|
|
7368
7341
|
'links'?: ObjectLinks;
|
|
@@ -7373,7 +7346,7 @@ export interface JsonApiOrganizationSettingOutDocument {
|
|
|
7373
7346
|
export interface JsonApiOrganizationSettingOutList {
|
|
7374
7347
|
'data': Array<JsonApiOrganizationSettingOutWithLinks>;
|
|
7375
7348
|
'links'?: ListLinks;
|
|
7376
|
-
'meta'?:
|
|
7349
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
7377
7350
|
}
|
|
7378
7351
|
export interface JsonApiOrganizationSettingOutWithLinks {
|
|
7379
7352
|
/**
|
|
@@ -7384,7 +7357,7 @@ export interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
7384
7357
|
* API identifier of an object
|
|
7385
7358
|
*/
|
|
7386
7359
|
'id': string;
|
|
7387
|
-
'attributes'?:
|
|
7360
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
7388
7361
|
'links'?: ObjectLinks;
|
|
7389
7362
|
}
|
|
7390
7363
|
export type JsonApiOrganizationSettingOutWithLinksTypeEnum = 'organizationSetting';
|
|
@@ -7400,7 +7373,7 @@ export interface JsonApiOrganizationSettingPatch {
|
|
|
7400
7373
|
* API identifier of an object
|
|
7401
7374
|
*/
|
|
7402
7375
|
'id': string;
|
|
7403
|
-
'attributes'?:
|
|
7376
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
7404
7377
|
}
|
|
7405
7378
|
export type JsonApiOrganizationSettingPatchTypeEnum = 'organizationSetting';
|
|
7406
7379
|
export interface JsonApiOrganizationSettingPatchDocument {
|
|
@@ -7449,7 +7422,7 @@ export interface JsonApiThemeOutDocument {
|
|
|
7449
7422
|
export interface JsonApiThemeOutList {
|
|
7450
7423
|
'data': Array<JsonApiThemeOutWithLinks>;
|
|
7451
7424
|
'links'?: ListLinks;
|
|
7452
|
-
'meta'?:
|
|
7425
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
7453
7426
|
}
|
|
7454
7427
|
export interface JsonApiThemeOutWithLinks {
|
|
7455
7428
|
/**
|
|
@@ -7513,7 +7486,7 @@ export interface JsonApiUserDataFilterOut {
|
|
|
7513
7486
|
* API identifier of an object
|
|
7514
7487
|
*/
|
|
7515
7488
|
'id': string;
|
|
7516
|
-
'meta'?:
|
|
7489
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
7517
7490
|
'attributes': JsonApiUserDataFilterOutAttributes;
|
|
7518
7491
|
'relationships'?: JsonApiUserDataFilterOutRelationships;
|
|
7519
7492
|
}
|
|
@@ -7543,20 +7516,20 @@ export type JsonApiUserDataFilterOutIncludes = JsonApiAttributeOutWithLinks | Js
|
|
|
7543
7516
|
export interface JsonApiUserDataFilterOutList {
|
|
7544
7517
|
'data': Array<JsonApiUserDataFilterOutWithLinks>;
|
|
7545
7518
|
'links'?: ListLinks;
|
|
7546
|
-
'meta'?:
|
|
7519
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
7547
7520
|
/**
|
|
7548
7521
|
* Included resources
|
|
7549
7522
|
*/
|
|
7550
7523
|
'included'?: Array<JsonApiUserDataFilterOutIncludes>;
|
|
7551
7524
|
}
|
|
7552
7525
|
export interface JsonApiUserDataFilterOutRelationships {
|
|
7553
|
-
'user'?:
|
|
7554
|
-
'userGroup'?:
|
|
7555
|
-
'facts'?:
|
|
7556
|
-
'attributes'?:
|
|
7526
|
+
'user'?: JsonApiFilterViewPatchRelationshipsUser;
|
|
7527
|
+
'userGroup'?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
7528
|
+
'facts'?: JsonApiVisualizationObjectOutRelationshipsFacts;
|
|
7529
|
+
'attributes'?: JsonApiVisualizationObjectOutRelationshipsAttributes;
|
|
7557
7530
|
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
7558
7531
|
'metrics'?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
7559
|
-
'datasets'?:
|
|
7532
|
+
'datasets'?: JsonApiVisualizationObjectOutRelationshipsDatasets;
|
|
7560
7533
|
}
|
|
7561
7534
|
export interface JsonApiUserDataFilterOutWithLinks {
|
|
7562
7535
|
/**
|
|
@@ -7567,7 +7540,7 @@ export interface JsonApiUserDataFilterOutWithLinks {
|
|
|
7567
7540
|
* API identifier of an object
|
|
7568
7541
|
*/
|
|
7569
7542
|
'id': string;
|
|
7570
|
-
'meta'?:
|
|
7543
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
7571
7544
|
'attributes': JsonApiUserDataFilterOutAttributes;
|
|
7572
7545
|
'relationships'?: JsonApiUserDataFilterOutRelationships;
|
|
7573
7546
|
'links'?: ObjectLinks;
|
|
@@ -7600,8 +7573,11 @@ export interface JsonApiUserDataFilterPatchDocument {
|
|
|
7600
7573
|
'data': JsonApiUserDataFilterPatch;
|
|
7601
7574
|
}
|
|
7602
7575
|
export interface JsonApiUserDataFilterPatchRelationships {
|
|
7603
|
-
'user'?:
|
|
7604
|
-
'userGroup'?:
|
|
7576
|
+
'user'?: JsonApiFilterViewPatchRelationshipsUser;
|
|
7577
|
+
'userGroup'?: JsonApiUserDataFilterPatchRelationshipsUserGroup;
|
|
7578
|
+
}
|
|
7579
|
+
export interface JsonApiUserDataFilterPatchRelationshipsUserGroup {
|
|
7580
|
+
'data': JsonApiUserGroupLinkage | null;
|
|
7605
7581
|
}
|
|
7606
7582
|
/**
|
|
7607
7583
|
* JSON:API representation of userDataFilter entity.
|
|
@@ -7682,14 +7658,20 @@ export interface JsonApiUserGroupOutDocument {
|
|
|
7682
7658
|
export interface JsonApiUserGroupOutList {
|
|
7683
7659
|
'data': Array<JsonApiUserGroupOutWithLinks>;
|
|
7684
7660
|
'links'?: ListLinks;
|
|
7685
|
-
'meta'?:
|
|
7661
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
7686
7662
|
/**
|
|
7687
7663
|
* Included resources
|
|
7688
7664
|
*/
|
|
7689
7665
|
'included'?: Array<JsonApiUserGroupOutWithLinks>;
|
|
7690
7666
|
}
|
|
7691
7667
|
export interface JsonApiUserGroupOutRelationships {
|
|
7692
|
-
'parents'?:
|
|
7668
|
+
'parents'?: JsonApiUserGroupOutRelationshipsParents;
|
|
7669
|
+
}
|
|
7670
|
+
export interface JsonApiUserGroupOutRelationshipsParents {
|
|
7671
|
+
/**
|
|
7672
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7673
|
+
*/
|
|
7674
|
+
'data': Array<JsonApiUserGroupLinkage>;
|
|
7693
7675
|
}
|
|
7694
7676
|
export interface JsonApiUserGroupOutWithLinks {
|
|
7695
7677
|
/**
|
|
@@ -7762,7 +7744,7 @@ export interface JsonApiUserIdentifierOutDocument {
|
|
|
7762
7744
|
export interface JsonApiUserIdentifierOutList {
|
|
7763
7745
|
'data': Array<JsonApiUserIdentifierOutWithLinks>;
|
|
7764
7746
|
'links'?: ListLinks;
|
|
7765
|
-
'meta'?:
|
|
7747
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
7766
7748
|
}
|
|
7767
7749
|
export interface JsonApiUserIdentifierOutWithLinks {
|
|
7768
7750
|
/**
|
|
@@ -7840,20 +7822,14 @@ export interface JsonApiUserOutDocument {
|
|
|
7840
7822
|
export interface JsonApiUserOutList {
|
|
7841
7823
|
'data': Array<JsonApiUserOutWithLinks>;
|
|
7842
7824
|
'links'?: ListLinks;
|
|
7843
|
-
'meta'?:
|
|
7825
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
7844
7826
|
/**
|
|
7845
7827
|
* Included resources
|
|
7846
7828
|
*/
|
|
7847
7829
|
'included'?: Array<JsonApiUserGroupOutWithLinks>;
|
|
7848
7830
|
}
|
|
7849
7831
|
export interface JsonApiUserOutRelationships {
|
|
7850
|
-
'userGroups'?:
|
|
7851
|
-
}
|
|
7852
|
-
export interface JsonApiUserOutRelationshipsUserGroups {
|
|
7853
|
-
/**
|
|
7854
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
7855
|
-
*/
|
|
7856
|
-
'data': Array<JsonApiUserGroupLinkage>;
|
|
7832
|
+
'userGroups'?: JsonApiUserGroupOutRelationshipsParents;
|
|
7857
7833
|
}
|
|
7858
7834
|
export interface JsonApiUserOutWithLinks {
|
|
7859
7835
|
/**
|
|
@@ -7900,17 +7876,9 @@ export interface JsonApiUserSettingIn {
|
|
|
7900
7876
|
* API identifier of an object
|
|
7901
7877
|
*/
|
|
7902
7878
|
'id': string;
|
|
7903
|
-
'attributes'?:
|
|
7879
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
7904
7880
|
}
|
|
7905
7881
|
export type JsonApiUserSettingInTypeEnum = 'userSetting';
|
|
7906
|
-
export interface JsonApiUserSettingInAttributes {
|
|
7907
|
-
/**
|
|
7908
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
7909
|
-
*/
|
|
7910
|
-
'content'?: object;
|
|
7911
|
-
'type'?: JsonApiUserSettingInAttributesTypeEnum;
|
|
7912
|
-
}
|
|
7913
|
-
export type JsonApiUserSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'ENABLE_NULL_JOINS' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS';
|
|
7914
7882
|
export interface JsonApiUserSettingInDocument {
|
|
7915
7883
|
'data': JsonApiUserSettingIn;
|
|
7916
7884
|
}
|
|
@@ -7926,7 +7894,7 @@ export interface JsonApiUserSettingOut {
|
|
|
7926
7894
|
* API identifier of an object
|
|
7927
7895
|
*/
|
|
7928
7896
|
'id': string;
|
|
7929
|
-
'attributes'?:
|
|
7897
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
7930
7898
|
}
|
|
7931
7899
|
export type JsonApiUserSettingOutTypeEnum = 'userSetting';
|
|
7932
7900
|
export interface JsonApiUserSettingOutDocument {
|
|
@@ -7939,7 +7907,7 @@ export interface JsonApiUserSettingOutDocument {
|
|
|
7939
7907
|
export interface JsonApiUserSettingOutList {
|
|
7940
7908
|
'data': Array<JsonApiUserSettingOutWithLinks>;
|
|
7941
7909
|
'links'?: ListLinks;
|
|
7942
|
-
'meta'?:
|
|
7910
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
7943
7911
|
}
|
|
7944
7912
|
export interface JsonApiUserSettingOutWithLinks {
|
|
7945
7913
|
/**
|
|
@@ -7950,7 +7918,7 @@ export interface JsonApiUserSettingOutWithLinks {
|
|
|
7950
7918
|
* API identifier of an object
|
|
7951
7919
|
*/
|
|
7952
7920
|
'id': string;
|
|
7953
|
-
'attributes'?:
|
|
7921
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
7954
7922
|
'links'?: ObjectLinks;
|
|
7955
7923
|
}
|
|
7956
7924
|
export type JsonApiUserSettingOutWithLinksTypeEnum = 'userSetting';
|
|
@@ -7966,9 +7934,20 @@ export interface JsonApiVisualizationObjectIn {
|
|
|
7966
7934
|
* API identifier of an object
|
|
7967
7935
|
*/
|
|
7968
7936
|
'id': string;
|
|
7969
|
-
'attributes':
|
|
7937
|
+
'attributes': JsonApiVisualizationObjectInAttributes;
|
|
7970
7938
|
}
|
|
7971
7939
|
export type JsonApiVisualizationObjectInTypeEnum = 'visualizationObject';
|
|
7940
|
+
export interface JsonApiVisualizationObjectInAttributes {
|
|
7941
|
+
'title'?: string;
|
|
7942
|
+
'description'?: string;
|
|
7943
|
+
'tags'?: Array<string>;
|
|
7944
|
+
'areRelationsValid'?: boolean;
|
|
7945
|
+
/**
|
|
7946
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
7947
|
+
*/
|
|
7948
|
+
'content': object;
|
|
7949
|
+
'isHidden'?: boolean;
|
|
7950
|
+
}
|
|
7972
7951
|
export interface JsonApiVisualizationObjectInDocument {
|
|
7973
7952
|
'data': JsonApiVisualizationObjectIn;
|
|
7974
7953
|
}
|
|
@@ -7992,7 +7971,7 @@ export interface JsonApiVisualizationObjectOut {
|
|
|
7992
7971
|
* API identifier of an object
|
|
7993
7972
|
*/
|
|
7994
7973
|
'id': string;
|
|
7995
|
-
'meta'?:
|
|
7974
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
7996
7975
|
'attributes': JsonApiVisualizationObjectOutAttributes;
|
|
7997
7976
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
7998
7977
|
}
|
|
@@ -8043,25 +8022,57 @@ export interface JsonApiVisualizationObjectOutDocument {
|
|
|
8043
8022
|
export interface JsonApiVisualizationObjectOutList {
|
|
8044
8023
|
'data': Array<JsonApiVisualizationObjectOutWithLinks>;
|
|
8045
8024
|
'links'?: ListLinks;
|
|
8046
|
-
'meta'?:
|
|
8025
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
8047
8026
|
/**
|
|
8048
8027
|
* Included resources
|
|
8049
8028
|
*/
|
|
8050
8029
|
'included'?: Array<JsonApiMetricOutIncludes>;
|
|
8051
8030
|
}
|
|
8031
|
+
export interface JsonApiVisualizationObjectOutMeta {
|
|
8032
|
+
'origin'?: JsonApiVisualizationObjectOutMetaOrigin;
|
|
8033
|
+
}
|
|
8034
|
+
export interface JsonApiVisualizationObjectOutMetaOrigin {
|
|
8035
|
+
/**
|
|
8036
|
+
* defines type of the origin of the entity
|
|
8037
|
+
*/
|
|
8038
|
+
'originType': JsonApiVisualizationObjectOutMetaOriginOriginTypeEnum;
|
|
8039
|
+
/**
|
|
8040
|
+
* defines id of the workspace where the entity comes from
|
|
8041
|
+
*/
|
|
8042
|
+
'originId': string;
|
|
8043
|
+
}
|
|
8044
|
+
export type JsonApiVisualizationObjectOutMetaOriginOriginTypeEnum = 'NATIVE' | 'PARENT';
|
|
8052
8045
|
export interface JsonApiVisualizationObjectOutRelationships {
|
|
8053
8046
|
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
8054
8047
|
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
8055
8048
|
'certifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
8056
|
-
'facts'?:
|
|
8057
|
-
'attributes'?:
|
|
8049
|
+
'facts'?: JsonApiVisualizationObjectOutRelationshipsFacts;
|
|
8050
|
+
'attributes'?: JsonApiVisualizationObjectOutRelationshipsAttributes;
|
|
8058
8051
|
'labels'?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
8059
8052
|
'metrics'?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
8060
|
-
'datasets'?:
|
|
8053
|
+
'datasets'?: JsonApiVisualizationObjectOutRelationshipsDatasets;
|
|
8054
|
+
}
|
|
8055
|
+
export interface JsonApiVisualizationObjectOutRelationshipsAttributes {
|
|
8056
|
+
/**
|
|
8057
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
8058
|
+
*/
|
|
8059
|
+
'data': Array<JsonApiAttributeLinkage>;
|
|
8061
8060
|
}
|
|
8062
8061
|
export interface JsonApiVisualizationObjectOutRelationshipsCreatedBy {
|
|
8063
8062
|
'data': JsonApiUserIdentifierLinkage | null;
|
|
8064
8063
|
}
|
|
8064
|
+
export interface JsonApiVisualizationObjectOutRelationshipsDatasets {
|
|
8065
|
+
/**
|
|
8066
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
8067
|
+
*/
|
|
8068
|
+
'data': Array<JsonApiDatasetLinkage>;
|
|
8069
|
+
}
|
|
8070
|
+
export interface JsonApiVisualizationObjectOutRelationshipsFacts {
|
|
8071
|
+
/**
|
|
8072
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
8073
|
+
*/
|
|
8074
|
+
'data': Array<JsonApiFactLinkage>;
|
|
8075
|
+
}
|
|
8065
8076
|
export interface JsonApiVisualizationObjectOutRelationshipsLabels {
|
|
8066
8077
|
/**
|
|
8067
8078
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -8083,7 +8094,7 @@ export interface JsonApiVisualizationObjectOutWithLinks {
|
|
|
8083
8094
|
* API identifier of an object
|
|
8084
8095
|
*/
|
|
8085
8096
|
'id': string;
|
|
8086
|
-
'meta'?:
|
|
8097
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
8087
8098
|
'attributes': JsonApiVisualizationObjectOutAttributes;
|
|
8088
8099
|
'relationships'?: JsonApiVisualizationObjectOutRelationships;
|
|
8089
8100
|
'links'?: ObjectLinks;
|
|
@@ -8130,20 +8141,9 @@ export interface JsonApiVisualizationObjectPostOptionalId {
|
|
|
8130
8141
|
* API identifier of an object
|
|
8131
8142
|
*/
|
|
8132
8143
|
'id'?: string;
|
|
8133
|
-
'attributes':
|
|
8144
|
+
'attributes': JsonApiVisualizationObjectInAttributes;
|
|
8134
8145
|
}
|
|
8135
8146
|
export type JsonApiVisualizationObjectPostOptionalIdTypeEnum = 'visualizationObject';
|
|
8136
|
-
export interface JsonApiVisualizationObjectPostOptionalIdAttributes {
|
|
8137
|
-
'title'?: string;
|
|
8138
|
-
'description'?: string;
|
|
8139
|
-
'tags'?: Array<string>;
|
|
8140
|
-
'areRelationsValid'?: boolean;
|
|
8141
|
-
/**
|
|
8142
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
8143
|
-
*/
|
|
8144
|
-
'content': object;
|
|
8145
|
-
'isHidden'?: boolean;
|
|
8146
|
-
}
|
|
8147
8147
|
export interface JsonApiVisualizationObjectPostOptionalIdDocument {
|
|
8148
8148
|
'data': JsonApiVisualizationObjectPostOptionalId;
|
|
8149
8149
|
}
|
|
@@ -8172,7 +8172,7 @@ export interface JsonApiWorkspaceAutomationOutAttributes {
|
|
|
8172
8172
|
* Additional details to be included in the automated message.
|
|
8173
8173
|
*/
|
|
8174
8174
|
'details'?: object;
|
|
8175
|
-
'metadata'?:
|
|
8175
|
+
'metadata'?: JsonApiAutomationPatchAttributesMetadata | null;
|
|
8176
8176
|
/**
|
|
8177
8177
|
* Current state of the automation.
|
|
8178
8178
|
*/
|
|
@@ -8181,18 +8181,18 @@ export interface JsonApiWorkspaceAutomationOutAttributes {
|
|
|
8181
8181
|
* Specify automation evaluation mode.
|
|
8182
8182
|
*/
|
|
8183
8183
|
'evaluationMode'?: JsonApiWorkspaceAutomationOutAttributesEvaluationModeEnum;
|
|
8184
|
-
'schedule'?:
|
|
8185
|
-
'alert'?:
|
|
8186
|
-
'tabularExports'?: Array<
|
|
8187
|
-
'visualExports'?: Array<
|
|
8188
|
-
'imageExports'?: Array<
|
|
8189
|
-
'rawExports'?: Array<
|
|
8190
|
-
'slidesExports'?: Array<
|
|
8191
|
-
'dashboardTabularExports'?: Array<
|
|
8184
|
+
'schedule'?: JsonApiAutomationPatchAttributesSchedule;
|
|
8185
|
+
'alert'?: JsonApiAutomationPatchAttributesAlert;
|
|
8186
|
+
'tabularExports'?: Array<JsonApiAutomationPatchAttributesTabularExportsInner>;
|
|
8187
|
+
'visualExports'?: Array<JsonApiAutomationPatchAttributesVisualExportsInner>;
|
|
8188
|
+
'imageExports'?: Array<JsonApiAutomationPatchAttributesImageExportsInner>;
|
|
8189
|
+
'rawExports'?: Array<JsonApiAutomationPatchAttributesRawExportsInner>;
|
|
8190
|
+
'slidesExports'?: Array<JsonApiAutomationPatchAttributesSlidesExportsInner>;
|
|
8191
|
+
'dashboardTabularExports'?: Array<JsonApiAutomationPatchAttributesDashboardTabularExportsInner>;
|
|
8192
8192
|
/**
|
|
8193
8193
|
* External recipients of the automation action results.
|
|
8194
8194
|
*/
|
|
8195
|
-
'externalRecipients'?: Array<
|
|
8195
|
+
'externalRecipients'?: Array<JsonApiAutomationPatchAttributesExternalRecipientsInner>;
|
|
8196
8196
|
'createdAt'?: string;
|
|
8197
8197
|
'modifiedAt'?: string;
|
|
8198
8198
|
}
|
|
@@ -8208,20 +8208,20 @@ export type JsonApiWorkspaceAutomationOutIncludes = JsonApiAnalyticalDashboardOu
|
|
|
8208
8208
|
export interface JsonApiWorkspaceAutomationOutList {
|
|
8209
8209
|
'data': Array<JsonApiWorkspaceAutomationOutWithLinks>;
|
|
8210
8210
|
'links'?: ListLinks;
|
|
8211
|
-
'meta'?:
|
|
8211
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
8212
8212
|
/**
|
|
8213
8213
|
* Included resources
|
|
8214
8214
|
*/
|
|
8215
8215
|
'included'?: Array<JsonApiWorkspaceAutomationOutIncludes>;
|
|
8216
8216
|
}
|
|
8217
8217
|
export interface JsonApiWorkspaceAutomationOutRelationships {
|
|
8218
|
-
'workspace'?:
|
|
8219
|
-
'notificationChannel'?:
|
|
8220
|
-
'analyticalDashboard'?:
|
|
8218
|
+
'workspace'?: JsonApiWorkspaceOutRelationshipsParent;
|
|
8219
|
+
'notificationChannel'?: JsonApiAutomationPatchRelationshipsNotificationChannel;
|
|
8220
|
+
'analyticalDashboard'?: JsonApiAutomationPatchRelationshipsAnalyticalDashboard;
|
|
8221
8221
|
'createdBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
8222
8222
|
'modifiedBy'?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
8223
|
-
'exportDefinitions'?:
|
|
8224
|
-
'recipients'?:
|
|
8223
|
+
'exportDefinitions'?: JsonApiAutomationPatchRelationshipsExportDefinitions;
|
|
8224
|
+
'recipients'?: JsonApiAutomationPatchRelationshipsRecipients;
|
|
8225
8225
|
'automationResults'?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
8226
8226
|
}
|
|
8227
8227
|
export interface JsonApiWorkspaceAutomationOutWithLinks {
|
|
@@ -8277,7 +8277,7 @@ export interface JsonApiWorkspaceDataFilterOut {
|
|
|
8277
8277
|
* API identifier of an object
|
|
8278
8278
|
*/
|
|
8279
8279
|
'id': string;
|
|
8280
|
-
'meta'?:
|
|
8280
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
8281
8281
|
'attributes'?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
8282
8282
|
'relationships'?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
8283
8283
|
}
|
|
@@ -8301,7 +8301,7 @@ export interface JsonApiWorkspaceDataFilterOutDocument {
|
|
|
8301
8301
|
export interface JsonApiWorkspaceDataFilterOutList {
|
|
8302
8302
|
'data': Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
8303
8303
|
'links'?: ListLinks;
|
|
8304
|
-
'meta'?:
|
|
8304
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
8305
8305
|
/**
|
|
8306
8306
|
* Included resources
|
|
8307
8307
|
*/
|
|
@@ -8325,7 +8325,7 @@ export interface JsonApiWorkspaceDataFilterOutWithLinks {
|
|
|
8325
8325
|
* API identifier of an object
|
|
8326
8326
|
*/
|
|
8327
8327
|
'id': string;
|
|
8328
|
-
'meta'?:
|
|
8328
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
8329
8329
|
'attributes'?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
8330
8330
|
'relationships'?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
8331
8331
|
'links'?: ObjectLinks;
|
|
@@ -8362,8 +8362,8 @@ export interface JsonApiWorkspaceDataFilterSettingIn {
|
|
|
8362
8362
|
* API identifier of an object
|
|
8363
8363
|
*/
|
|
8364
8364
|
'id': string;
|
|
8365
|
-
'attributes'?:
|
|
8366
|
-
'relationships'?:
|
|
8365
|
+
'attributes'?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
8366
|
+
'relationships'?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
8367
8367
|
}
|
|
8368
8368
|
export type JsonApiWorkspaceDataFilterSettingInTypeEnum = 'workspaceDataFilterSetting';
|
|
8369
8369
|
export interface JsonApiWorkspaceDataFilterSettingInDocument {
|
|
@@ -8389,16 +8389,11 @@ export interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
8389
8389
|
* API identifier of an object
|
|
8390
8390
|
*/
|
|
8391
8391
|
'id': string;
|
|
8392
|
-
'meta'?:
|
|
8393
|
-
'attributes'?:
|
|
8394
|
-
'relationships'?:
|
|
8392
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
8393
|
+
'attributes'?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
8394
|
+
'relationships'?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
8395
8395
|
}
|
|
8396
8396
|
export type JsonApiWorkspaceDataFilterSettingOutTypeEnum = 'workspaceDataFilterSetting';
|
|
8397
|
-
export interface JsonApiWorkspaceDataFilterSettingOutAttributes {
|
|
8398
|
-
'title'?: string;
|
|
8399
|
-
'description'?: string;
|
|
8400
|
-
'filterValues'?: Array<string>;
|
|
8401
|
-
}
|
|
8402
8397
|
export interface JsonApiWorkspaceDataFilterSettingOutDocument {
|
|
8403
8398
|
'data': JsonApiWorkspaceDataFilterSettingOut;
|
|
8404
8399
|
'links'?: ObjectLinks;
|
|
@@ -8413,18 +8408,12 @@ export interface JsonApiWorkspaceDataFilterSettingOutDocument {
|
|
|
8413
8408
|
export interface JsonApiWorkspaceDataFilterSettingOutList {
|
|
8414
8409
|
'data': Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>;
|
|
8415
8410
|
'links'?: ListLinks;
|
|
8416
|
-
'meta'?:
|
|
8411
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
8417
8412
|
/**
|
|
8418
8413
|
* Included resources
|
|
8419
8414
|
*/
|
|
8420
8415
|
'included'?: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
8421
8416
|
}
|
|
8422
|
-
export interface JsonApiWorkspaceDataFilterSettingOutRelationships {
|
|
8423
|
-
'workspaceDataFilter'?: JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter;
|
|
8424
|
-
}
|
|
8425
|
-
export interface JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter {
|
|
8426
|
-
'data': JsonApiWorkspaceDataFilterLinkage | null;
|
|
8427
|
-
}
|
|
8428
8417
|
export interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
8429
8418
|
/**
|
|
8430
8419
|
* Object type
|
|
@@ -8434,9 +8423,9 @@ export interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
8434
8423
|
* API identifier of an object
|
|
8435
8424
|
*/
|
|
8436
8425
|
'id': string;
|
|
8437
|
-
'meta'?:
|
|
8438
|
-
'attributes'?:
|
|
8439
|
-
'relationships'?:
|
|
8426
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
8427
|
+
'attributes'?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
8428
|
+
'relationships'?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
8440
8429
|
'links'?: ObjectLinks;
|
|
8441
8430
|
}
|
|
8442
8431
|
export type JsonApiWorkspaceDataFilterSettingOutWithLinksTypeEnum = 'workspaceDataFilterSetting';
|
|
@@ -8452,13 +8441,24 @@ export interface JsonApiWorkspaceDataFilterSettingPatch {
|
|
|
8452
8441
|
* API identifier of an object
|
|
8453
8442
|
*/
|
|
8454
8443
|
'id': string;
|
|
8455
|
-
'attributes'?:
|
|
8456
|
-
'relationships'?:
|
|
8444
|
+
'attributes'?: JsonApiWorkspaceDataFilterSettingPatchAttributes;
|
|
8445
|
+
'relationships'?: JsonApiWorkspaceDataFilterSettingPatchRelationships;
|
|
8457
8446
|
}
|
|
8458
8447
|
export type JsonApiWorkspaceDataFilterSettingPatchTypeEnum = 'workspaceDataFilterSetting';
|
|
8448
|
+
export interface JsonApiWorkspaceDataFilterSettingPatchAttributes {
|
|
8449
|
+
'title'?: string;
|
|
8450
|
+
'description'?: string;
|
|
8451
|
+
'filterValues'?: Array<string>;
|
|
8452
|
+
}
|
|
8459
8453
|
export interface JsonApiWorkspaceDataFilterSettingPatchDocument {
|
|
8460
8454
|
'data': JsonApiWorkspaceDataFilterSettingPatch;
|
|
8461
8455
|
}
|
|
8456
|
+
export interface JsonApiWorkspaceDataFilterSettingPatchRelationships {
|
|
8457
|
+
'workspaceDataFilter'?: JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter;
|
|
8458
|
+
}
|
|
8459
|
+
export interface JsonApiWorkspaceDataFilterSettingPatchRelationshipsWorkspaceDataFilter {
|
|
8460
|
+
'data': JsonApiWorkspaceDataFilterLinkage | null;
|
|
8461
|
+
}
|
|
8462
8462
|
/**
|
|
8463
8463
|
* JSON:API representation of workspace entity.
|
|
8464
8464
|
*/
|
|
@@ -8471,8 +8471,8 @@ export interface JsonApiWorkspaceIn {
|
|
|
8471
8471
|
* API identifier of an object
|
|
8472
8472
|
*/
|
|
8473
8473
|
'id': string;
|
|
8474
|
-
'attributes'?:
|
|
8475
|
-
'relationships'?:
|
|
8474
|
+
'attributes'?: JsonApiWorkspaceOutAttributes;
|
|
8475
|
+
'relationships'?: JsonApiWorkspaceOutRelationships;
|
|
8476
8476
|
}
|
|
8477
8477
|
export type JsonApiWorkspaceInTypeEnum = 'workspace';
|
|
8478
8478
|
export interface JsonApiWorkspaceInDocument {
|
|
@@ -8499,10 +8499,42 @@ export interface JsonApiWorkspaceOut {
|
|
|
8499
8499
|
*/
|
|
8500
8500
|
'id': string;
|
|
8501
8501
|
'meta'?: JsonApiWorkspaceOutMeta;
|
|
8502
|
-
'attributes'?:
|
|
8503
|
-
'relationships'?:
|
|
8502
|
+
'attributes'?: JsonApiWorkspaceOutAttributes;
|
|
8503
|
+
'relationships'?: JsonApiWorkspaceOutRelationships;
|
|
8504
8504
|
}
|
|
8505
8505
|
export type JsonApiWorkspaceOutTypeEnum = 'workspace';
|
|
8506
|
+
export interface JsonApiWorkspaceOutAttributes {
|
|
8507
|
+
'name'?: string | null;
|
|
8508
|
+
/**
|
|
8509
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
8510
|
+
* @deprecated
|
|
8511
|
+
*/
|
|
8512
|
+
'earlyAccess'?: string | null;
|
|
8513
|
+
/**
|
|
8514
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
8515
|
+
*/
|
|
8516
|
+
'earlyAccessValues'?: Array<string> | null;
|
|
8517
|
+
'description'?: string | null;
|
|
8518
|
+
/**
|
|
8519
|
+
* Custom prefix of entity identifiers in workspace
|
|
8520
|
+
*/
|
|
8521
|
+
'prefix'?: string | null;
|
|
8522
|
+
'cacheExtraLimit'?: number;
|
|
8523
|
+
'dataSource'?: JsonApiWorkspaceOutAttributesDataSource;
|
|
8524
|
+
}
|
|
8525
|
+
/**
|
|
8526
|
+
* 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.
|
|
8527
|
+
*/
|
|
8528
|
+
export interface JsonApiWorkspaceOutAttributesDataSource {
|
|
8529
|
+
/**
|
|
8530
|
+
* The ID of the used data source.
|
|
8531
|
+
*/
|
|
8532
|
+
'id': string;
|
|
8533
|
+
/**
|
|
8534
|
+
* The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
|
|
8535
|
+
*/
|
|
8536
|
+
'schemaPath'?: Array<string>;
|
|
8537
|
+
}
|
|
8506
8538
|
export interface JsonApiWorkspaceOutDocument {
|
|
8507
8539
|
'data': JsonApiWorkspaceOut;
|
|
8508
8540
|
'links'?: ObjectLinks;
|
|
@@ -8517,7 +8549,7 @@ export interface JsonApiWorkspaceOutDocument {
|
|
|
8517
8549
|
export interface JsonApiWorkspaceOutList {
|
|
8518
8550
|
'data': Array<JsonApiWorkspaceOutWithLinks>;
|
|
8519
8551
|
'links'?: ListLinks;
|
|
8520
|
-
'meta'?:
|
|
8552
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
8521
8553
|
/**
|
|
8522
8554
|
* Included resources
|
|
8523
8555
|
*/
|
|
@@ -8559,6 +8591,12 @@ export interface JsonApiWorkspaceOutMetaHierarchy {
|
|
|
8559
8591
|
*/
|
|
8560
8592
|
'childrenCount': number;
|
|
8561
8593
|
}
|
|
8594
|
+
export interface JsonApiWorkspaceOutRelationships {
|
|
8595
|
+
'parent'?: JsonApiWorkspaceOutRelationshipsParent;
|
|
8596
|
+
}
|
|
8597
|
+
export interface JsonApiWorkspaceOutRelationshipsParent {
|
|
8598
|
+
'data': JsonApiWorkspaceLinkage | null;
|
|
8599
|
+
}
|
|
8562
8600
|
export interface JsonApiWorkspaceOutWithLinks {
|
|
8563
8601
|
/**
|
|
8564
8602
|
* Object type
|
|
@@ -8569,8 +8607,8 @@ export interface JsonApiWorkspaceOutWithLinks {
|
|
|
8569
8607
|
*/
|
|
8570
8608
|
'id': string;
|
|
8571
8609
|
'meta'?: JsonApiWorkspaceOutMeta;
|
|
8572
|
-
'attributes'?:
|
|
8573
|
-
'relationships'?:
|
|
8610
|
+
'attributes'?: JsonApiWorkspaceOutAttributes;
|
|
8611
|
+
'relationships'?: JsonApiWorkspaceOutRelationships;
|
|
8574
8612
|
'links'?: ObjectLinks;
|
|
8575
8613
|
}
|
|
8576
8614
|
export type JsonApiWorkspaceOutWithLinksTypeEnum = 'workspace';
|
|
@@ -8586,51 +8624,13 @@ export interface JsonApiWorkspacePatch {
|
|
|
8586
8624
|
* API identifier of an object
|
|
8587
8625
|
*/
|
|
8588
8626
|
'id': string;
|
|
8589
|
-
'attributes'?:
|
|
8590
|
-
'relationships'?:
|
|
8627
|
+
'attributes'?: JsonApiWorkspaceOutAttributes;
|
|
8628
|
+
'relationships'?: JsonApiWorkspaceOutRelationships;
|
|
8591
8629
|
}
|
|
8592
8630
|
export type JsonApiWorkspacePatchTypeEnum = 'workspace';
|
|
8593
|
-
export interface JsonApiWorkspacePatchAttributes {
|
|
8594
|
-
'name'?: string | null;
|
|
8595
|
-
/**
|
|
8596
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
8597
|
-
* @deprecated
|
|
8598
|
-
*/
|
|
8599
|
-
'earlyAccess'?: string | null;
|
|
8600
|
-
/**
|
|
8601
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
8602
|
-
*/
|
|
8603
|
-
'earlyAccessValues'?: Array<string> | null;
|
|
8604
|
-
'description'?: string | null;
|
|
8605
|
-
/**
|
|
8606
|
-
* Custom prefix of entity identifiers in workspace
|
|
8607
|
-
*/
|
|
8608
|
-
'prefix'?: string | null;
|
|
8609
|
-
'cacheExtraLimit'?: number;
|
|
8610
|
-
'dataSource'?: JsonApiWorkspacePatchAttributesDataSource;
|
|
8611
|
-
}
|
|
8612
|
-
/**
|
|
8613
|
-
* The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.
|
|
8614
|
-
*/
|
|
8615
|
-
export interface JsonApiWorkspacePatchAttributesDataSource {
|
|
8616
|
-
/**
|
|
8617
|
-
* The ID of the used data source.
|
|
8618
|
-
*/
|
|
8619
|
-
'id': string;
|
|
8620
|
-
/**
|
|
8621
|
-
* The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
|
|
8622
|
-
*/
|
|
8623
|
-
'schemaPath'?: Array<string>;
|
|
8624
|
-
}
|
|
8625
8631
|
export interface JsonApiWorkspacePatchDocument {
|
|
8626
8632
|
'data': JsonApiWorkspacePatch;
|
|
8627
8633
|
}
|
|
8628
|
-
export interface JsonApiWorkspacePatchRelationships {
|
|
8629
|
-
'parent'?: JsonApiWorkspacePatchRelationshipsParent;
|
|
8630
|
-
}
|
|
8631
|
-
export interface JsonApiWorkspacePatchRelationshipsParent {
|
|
8632
|
-
'data': JsonApiWorkspaceLinkage | null;
|
|
8633
|
-
}
|
|
8634
8634
|
/**
|
|
8635
8635
|
* JSON:API representation of workspaceSetting entity.
|
|
8636
8636
|
*/
|
|
@@ -8643,7 +8643,7 @@ export interface JsonApiWorkspaceSettingIn {
|
|
|
8643
8643
|
* API identifier of an object
|
|
8644
8644
|
*/
|
|
8645
8645
|
'id': string;
|
|
8646
|
-
'attributes'?:
|
|
8646
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
8647
8647
|
}
|
|
8648
8648
|
export type JsonApiWorkspaceSettingInTypeEnum = 'workspaceSetting';
|
|
8649
8649
|
export interface JsonApiWorkspaceSettingInDocument {
|
|
@@ -8661,8 +8661,8 @@ export interface JsonApiWorkspaceSettingOut {
|
|
|
8661
8661
|
* API identifier of an object
|
|
8662
8662
|
*/
|
|
8663
8663
|
'id': string;
|
|
8664
|
-
'meta'?:
|
|
8665
|
-
'attributes'?:
|
|
8664
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
8665
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
8666
8666
|
}
|
|
8667
8667
|
export type JsonApiWorkspaceSettingOutTypeEnum = 'workspaceSetting';
|
|
8668
8668
|
export interface JsonApiWorkspaceSettingOutDocument {
|
|
@@ -8675,7 +8675,7 @@ export interface JsonApiWorkspaceSettingOutDocument {
|
|
|
8675
8675
|
export interface JsonApiWorkspaceSettingOutList {
|
|
8676
8676
|
'data': Array<JsonApiWorkspaceSettingOutWithLinks>;
|
|
8677
8677
|
'links'?: ListLinks;
|
|
8678
|
-
'meta'?:
|
|
8678
|
+
'meta'?: JsonApiApiTokenOutListMeta;
|
|
8679
8679
|
}
|
|
8680
8680
|
export interface JsonApiWorkspaceSettingOutWithLinks {
|
|
8681
8681
|
/**
|
|
@@ -8686,8 +8686,8 @@ export interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
8686
8686
|
* API identifier of an object
|
|
8687
8687
|
*/
|
|
8688
8688
|
'id': string;
|
|
8689
|
-
'meta'?:
|
|
8690
|
-
'attributes'?:
|
|
8689
|
+
'meta'?: JsonApiVisualizationObjectOutMeta;
|
|
8690
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
8691
8691
|
'links'?: ObjectLinks;
|
|
8692
8692
|
}
|
|
8693
8693
|
export type JsonApiWorkspaceSettingOutWithLinksTypeEnum = 'workspaceSetting';
|
|
@@ -8703,7 +8703,7 @@ export interface JsonApiWorkspaceSettingPatch {
|
|
|
8703
8703
|
* API identifier of an object
|
|
8704
8704
|
*/
|
|
8705
8705
|
'id': string;
|
|
8706
|
-
'attributes'?:
|
|
8706
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
8707
8707
|
}
|
|
8708
8708
|
export type JsonApiWorkspaceSettingPatchTypeEnum = 'workspaceSetting';
|
|
8709
8709
|
export interface JsonApiWorkspaceSettingPatchDocument {
|
|
@@ -8721,7 +8721,7 @@ export interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
8721
8721
|
* API identifier of an object
|
|
8722
8722
|
*/
|
|
8723
8723
|
'id'?: string;
|
|
8724
|
-
'attributes'?:
|
|
8724
|
+
'attributes'?: JsonApiOrganizationSettingOutAttributes;
|
|
8725
8725
|
}
|
|
8726
8726
|
export type JsonApiWorkspaceSettingPostOptionalIdTypeEnum = 'workspaceSetting';
|
|
8727
8727
|
export interface JsonApiWorkspaceSettingPostOptionalIdDocument {
|