@gooddata/api-client-tiger 10.43.0-alpha.2 → 10.43.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 +765 -758
- package/esm/generated/metadata-json-api/api.d.ts +697 -693
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +51 -46
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +6792 -6739
- package/package.json +3 -3
|
@@ -3095,7 +3095,7 @@ export interface JsonApiAggregatedFactOut {
|
|
|
3095
3095
|
* API identifier of an object
|
|
3096
3096
|
*/
|
|
3097
3097
|
id: string;
|
|
3098
|
-
meta?:
|
|
3098
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3099
3099
|
attributes: JsonApiAggregatedFactOutAttributes;
|
|
3100
3100
|
relationships?: JsonApiAggregatedFactOutRelationships;
|
|
3101
3101
|
}
|
|
@@ -3145,14 +3145,14 @@ export type JsonApiAggregatedFactOutIncludes = JsonApiDatasetOutWithLinks | Json
|
|
|
3145
3145
|
export interface JsonApiAggregatedFactOutList {
|
|
3146
3146
|
data: Array<JsonApiAggregatedFactOutWithLinks>;
|
|
3147
3147
|
links?: ListLinks;
|
|
3148
|
-
meta?:
|
|
3148
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
3149
3149
|
/**
|
|
3150
3150
|
* Included resources
|
|
3151
3151
|
*/
|
|
3152
3152
|
included?: Array<JsonApiAggregatedFactOutIncludes>;
|
|
3153
3153
|
}
|
|
3154
3154
|
export interface JsonApiAggregatedFactOutRelationships {
|
|
3155
|
-
dataset?:
|
|
3155
|
+
dataset?: JsonApiFactOutRelationshipsDataset;
|
|
3156
3156
|
sourceFact?: JsonApiAggregatedFactOutRelationshipsSourceFact;
|
|
3157
3157
|
}
|
|
3158
3158
|
export interface JsonApiAggregatedFactOutRelationshipsSourceFact {
|
|
@@ -3167,7 +3167,7 @@ export interface JsonApiAggregatedFactOutWithLinks {
|
|
|
3167
3167
|
* API identifier of an object
|
|
3168
3168
|
*/
|
|
3169
3169
|
id: string;
|
|
3170
|
-
meta?:
|
|
3170
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3171
3171
|
attributes: JsonApiAggregatedFactOutAttributes;
|
|
3172
3172
|
relationships?: JsonApiAggregatedFactOutRelationships;
|
|
3173
3173
|
links?: ObjectLinks;
|
|
@@ -3188,22 +3188,12 @@ export interface JsonApiAnalyticalDashboardIn {
|
|
|
3188
3188
|
* API identifier of an object
|
|
3189
3189
|
*/
|
|
3190
3190
|
id: string;
|
|
3191
|
-
attributes:
|
|
3191
|
+
attributes: JsonApiFilterContextOutAttributes;
|
|
3192
3192
|
}
|
|
3193
3193
|
export declare const JsonApiAnalyticalDashboardInTypeEnum: {
|
|
3194
3194
|
readonly ANALYTICAL_DASHBOARD: "analyticalDashboard";
|
|
3195
3195
|
};
|
|
3196
3196
|
export type JsonApiAnalyticalDashboardInTypeEnum = (typeof JsonApiAnalyticalDashboardInTypeEnum)[keyof typeof JsonApiAnalyticalDashboardInTypeEnum];
|
|
3197
|
-
export interface JsonApiAnalyticalDashboardInAttributes {
|
|
3198
|
-
title?: string;
|
|
3199
|
-
description?: string;
|
|
3200
|
-
tags?: Array<string>;
|
|
3201
|
-
areRelationsValid?: boolean;
|
|
3202
|
-
/**
|
|
3203
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
3204
|
-
*/
|
|
3205
|
-
content: object;
|
|
3206
|
-
}
|
|
3207
3197
|
export interface JsonApiAnalyticalDashboardInDocument {
|
|
3208
3198
|
data: JsonApiAnalyticalDashboardIn;
|
|
3209
3199
|
}
|
|
@@ -3256,7 +3246,7 @@ export type JsonApiAnalyticalDashboardOutIncludes = JsonApiAnalyticalDashboardOu
|
|
|
3256
3246
|
export interface JsonApiAnalyticalDashboardOutList {
|
|
3257
3247
|
data: Array<JsonApiAnalyticalDashboardOutWithLinks>;
|
|
3258
3248
|
links?: ListLinks;
|
|
3259
|
-
meta?:
|
|
3249
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
3260
3250
|
/**
|
|
3261
3251
|
* Included resources
|
|
3262
3252
|
*/
|
|
@@ -3267,7 +3257,7 @@ export interface JsonApiAnalyticalDashboardOutMeta {
|
|
|
3267
3257
|
* List of valid permissions for a logged-in user.
|
|
3268
3258
|
*/
|
|
3269
3259
|
permissions?: Array<JsonApiAnalyticalDashboardOutMetaPermissionsEnum>;
|
|
3270
|
-
origin?:
|
|
3260
|
+
origin?: JsonApiDatasetOutMetaOrigin;
|
|
3271
3261
|
accessInfo?: JsonApiAnalyticalDashboardOutMetaAccessInfo;
|
|
3272
3262
|
}
|
|
3273
3263
|
export declare const JsonApiAnalyticalDashboardOutMetaPermissionsEnum: {
|
|
@@ -3289,7 +3279,7 @@ export interface JsonApiAnalyticalDashboardOutRelationships {
|
|
|
3289
3279
|
analyticalDashboards?: JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards;
|
|
3290
3280
|
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
3291
3281
|
metrics?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
3292
|
-
datasets?:
|
|
3282
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
3293
3283
|
filterContexts?: JsonApiAnalyticalDashboardOutRelationshipsFilterContexts;
|
|
3294
3284
|
dashboardPlugins?: JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins;
|
|
3295
3285
|
}
|
|
@@ -3378,7 +3368,7 @@ export interface JsonApiAnalyticalDashboardPostOptionalId {
|
|
|
3378
3368
|
* API identifier of an object
|
|
3379
3369
|
*/
|
|
3380
3370
|
id?: string;
|
|
3381
|
-
attributes:
|
|
3371
|
+
attributes: JsonApiFilterContextOutAttributes;
|
|
3382
3372
|
}
|
|
3383
3373
|
export declare const JsonApiAnalyticalDashboardPostOptionalIdTypeEnum: {
|
|
3384
3374
|
readonly ANALYTICAL_DASHBOARD: "analyticalDashboard";
|
|
@@ -3441,7 +3431,7 @@ export interface JsonApiApiTokenOutDocument {
|
|
|
3441
3431
|
export interface JsonApiApiTokenOutList {
|
|
3442
3432
|
data: Array<JsonApiApiTokenOutWithLinks>;
|
|
3443
3433
|
links?: ListLinks;
|
|
3444
|
-
meta?:
|
|
3434
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
3445
3435
|
}
|
|
3446
3436
|
export interface JsonApiApiTokenOutWithLinks {
|
|
3447
3437
|
/**
|
|
@@ -3513,7 +3503,7 @@ export interface JsonApiAttributeHierarchyOut {
|
|
|
3513
3503
|
* API identifier of an object
|
|
3514
3504
|
*/
|
|
3515
3505
|
id: string;
|
|
3516
|
-
meta?:
|
|
3506
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3517
3507
|
attributes?: JsonApiAttributeHierarchyOutAttributes;
|
|
3518
3508
|
relationships?: JsonApiAttributeHierarchyOutRelationships;
|
|
3519
3509
|
}
|
|
@@ -3551,7 +3541,7 @@ export type JsonApiAttributeHierarchyOutIncludes = JsonApiAttributeOutWithLinks
|
|
|
3551
3541
|
export interface JsonApiAttributeHierarchyOutList {
|
|
3552
3542
|
data: Array<JsonApiAttributeHierarchyOutWithLinks>;
|
|
3553
3543
|
links?: ListLinks;
|
|
3554
|
-
meta?:
|
|
3544
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
3555
3545
|
/**
|
|
3556
3546
|
* Included resources
|
|
3557
3547
|
*/
|
|
@@ -3560,7 +3550,7 @@ export interface JsonApiAttributeHierarchyOutList {
|
|
|
3560
3550
|
export interface JsonApiAttributeHierarchyOutRelationships {
|
|
3561
3551
|
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3562
3552
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3563
|
-
attributes?:
|
|
3553
|
+
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
3564
3554
|
}
|
|
3565
3555
|
export interface JsonApiAttributeHierarchyOutWithLinks {
|
|
3566
3556
|
/**
|
|
@@ -3571,7 +3561,7 @@ export interface JsonApiAttributeHierarchyOutWithLinks {
|
|
|
3571
3561
|
* API identifier of an object
|
|
3572
3562
|
*/
|
|
3573
3563
|
id: string;
|
|
3574
|
-
meta?:
|
|
3564
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3575
3565
|
attributes?: JsonApiAttributeHierarchyOutAttributes;
|
|
3576
3566
|
relationships?: JsonApiAttributeHierarchyOutRelationships;
|
|
3577
3567
|
links?: ObjectLinks;
|
|
@@ -3624,7 +3614,7 @@ export interface JsonApiAttributeOut {
|
|
|
3624
3614
|
* API identifier of an object
|
|
3625
3615
|
*/
|
|
3626
3616
|
id: string;
|
|
3627
|
-
meta?:
|
|
3617
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3628
3618
|
attributes?: JsonApiAttributeOutAttributes;
|
|
3629
3619
|
relationships?: JsonApiAttributeOutRelationships;
|
|
3630
3620
|
}
|
|
@@ -3695,14 +3685,14 @@ export type JsonApiAttributeOutIncludes = JsonApiAttributeHierarchyOutWithLinks
|
|
|
3695
3685
|
export interface JsonApiAttributeOutList {
|
|
3696
3686
|
data: Array<JsonApiAttributeOutWithLinks>;
|
|
3697
3687
|
links?: ListLinks;
|
|
3698
|
-
meta?:
|
|
3688
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
3699
3689
|
/**
|
|
3700
3690
|
* Included resources
|
|
3701
3691
|
*/
|
|
3702
3692
|
included?: Array<JsonApiAttributeOutIncludes>;
|
|
3703
3693
|
}
|
|
3704
3694
|
export interface JsonApiAttributeOutRelationships {
|
|
3705
|
-
dataset?:
|
|
3695
|
+
dataset?: JsonApiFactOutRelationshipsDataset;
|
|
3706
3696
|
defaultView?: JsonApiAttributeOutRelationshipsDefaultView;
|
|
3707
3697
|
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
3708
3698
|
attributeHierarchies?: JsonApiAttributeOutRelationshipsAttributeHierarchies;
|
|
@@ -3713,9 +3703,6 @@ export interface JsonApiAttributeOutRelationshipsAttributeHierarchies {
|
|
|
3713
3703
|
*/
|
|
3714
3704
|
data: Array<JsonApiAttributeHierarchyLinkage>;
|
|
3715
3705
|
}
|
|
3716
|
-
export interface JsonApiAttributeOutRelationshipsDataset {
|
|
3717
|
-
data: JsonApiDatasetLinkage | null;
|
|
3718
|
-
}
|
|
3719
3706
|
export interface JsonApiAttributeOutRelationshipsDefaultView {
|
|
3720
3707
|
data: JsonApiLabelLinkage | null;
|
|
3721
3708
|
}
|
|
@@ -3728,7 +3715,7 @@ export interface JsonApiAttributeOutWithLinks {
|
|
|
3728
3715
|
* API identifier of an object
|
|
3729
3716
|
*/
|
|
3730
3717
|
id: string;
|
|
3731
|
-
meta?:
|
|
3718
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3732
3719
|
attributes?: JsonApiAttributeOutAttributes;
|
|
3733
3720
|
relationships?: JsonApiAttributeOutRelationships;
|
|
3734
3721
|
links?: ObjectLinks;
|
|
@@ -3765,117 +3752,37 @@ export interface JsonApiAutomationInAttributes {
|
|
|
3765
3752
|
* Additional details to be included in the automated message.
|
|
3766
3753
|
*/
|
|
3767
3754
|
details?: object;
|
|
3768
|
-
metadata?:
|
|
3755
|
+
metadata?: JsonApiAutomationOutAttributesMetadata | null;
|
|
3769
3756
|
/**
|
|
3770
3757
|
* Current state of the automation.
|
|
3771
3758
|
*/
|
|
3772
3759
|
state?: JsonApiAutomationInAttributesStateEnum;
|
|
3773
|
-
schedule?:
|
|
3774
|
-
alert?:
|
|
3775
|
-
tabularExports?: Array<
|
|
3776
|
-
visualExports?: Array<
|
|
3777
|
-
imageExports?: Array<
|
|
3778
|
-
rawExports?: Array<
|
|
3779
|
-
slidesExports?: Array<
|
|
3780
|
-
dashboardTabularExports?: Array<
|
|
3760
|
+
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
3761
|
+
alert?: JsonApiAutomationOutAttributesAlert;
|
|
3762
|
+
tabularExports?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
|
|
3763
|
+
visualExports?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
|
|
3764
|
+
imageExports?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
|
|
3765
|
+
rawExports?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
|
|
3766
|
+
slidesExports?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
|
|
3767
|
+
dashboardTabularExports?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
|
|
3781
3768
|
/**
|
|
3782
3769
|
* External recipients of the automation action results.
|
|
3783
3770
|
*/
|
|
3784
|
-
externalRecipients?: Array<
|
|
3771
|
+
externalRecipients?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
|
|
3785
3772
|
}
|
|
3786
3773
|
export declare const JsonApiAutomationInAttributesStateEnum: {
|
|
3787
3774
|
readonly ACTIVE: "ACTIVE";
|
|
3788
3775
|
readonly PAUSED: "PAUSED";
|
|
3789
3776
|
};
|
|
3790
3777
|
export type JsonApiAutomationInAttributesStateEnum = (typeof JsonApiAutomationInAttributesStateEnum)[keyof typeof JsonApiAutomationInAttributesStateEnum];
|
|
3791
|
-
export interface JsonApiAutomationInAttributesAlert {
|
|
3792
|
-
execution: AlertAfm;
|
|
3793
|
-
condition: AlertCondition;
|
|
3794
|
-
/**
|
|
3795
|
-
* 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.
|
|
3796
|
-
*/
|
|
3797
|
-
trigger?: JsonApiAutomationInAttributesAlertTriggerEnum;
|
|
3798
|
-
}
|
|
3799
|
-
export declare const JsonApiAutomationInAttributesAlertTriggerEnum: {
|
|
3800
|
-
readonly ALWAYS: "ALWAYS";
|
|
3801
|
-
readonly ONCE: "ONCE";
|
|
3802
|
-
};
|
|
3803
|
-
export type JsonApiAutomationInAttributesAlertTriggerEnum = (typeof JsonApiAutomationInAttributesAlertTriggerEnum)[keyof typeof JsonApiAutomationInAttributesAlertTriggerEnum];
|
|
3804
|
-
export interface JsonApiAutomationInAttributesDashboardTabularExportsInner {
|
|
3805
|
-
requestPayload: DashboardTabularExportRequestV2;
|
|
3806
|
-
}
|
|
3807
|
-
export interface JsonApiAutomationInAttributesExternalRecipientsInner {
|
|
3808
|
-
/**
|
|
3809
|
-
* E-mail address to send notifications from.
|
|
3810
|
-
*/
|
|
3811
|
-
email: string;
|
|
3812
|
-
}
|
|
3813
|
-
export interface JsonApiAutomationInAttributesImageExportsInner {
|
|
3814
|
-
requestPayload: ImageExportRequest;
|
|
3815
|
-
}
|
|
3816
|
-
/**
|
|
3817
|
-
* Additional information for the automation.
|
|
3818
|
-
*/
|
|
3819
|
-
export interface JsonApiAutomationInAttributesMetadata {
|
|
3820
|
-
widget?: string;
|
|
3821
|
-
visibleFilters?: Array<VisibleFilter>;
|
|
3822
|
-
}
|
|
3823
|
-
export interface JsonApiAutomationInAttributesRawExportsInner {
|
|
3824
|
-
requestPayload: RawExportAutomationRequest;
|
|
3825
|
-
}
|
|
3826
|
-
export interface JsonApiAutomationInAttributesSchedule {
|
|
3827
|
-
/**
|
|
3828
|
-
* 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.
|
|
3829
|
-
*/
|
|
3830
|
-
cron: string;
|
|
3831
|
-
/**
|
|
3832
|
-
* Human-readable description of the cron expression.
|
|
3833
|
-
*/
|
|
3834
|
-
cronDescription?: string;
|
|
3835
|
-
/**
|
|
3836
|
-
* Timezone in which the schedule is defined.
|
|
3837
|
-
*/
|
|
3838
|
-
timezone: string;
|
|
3839
|
-
/**
|
|
3840
|
-
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
3841
|
-
*/
|
|
3842
|
-
firstRun?: string;
|
|
3843
|
-
}
|
|
3844
|
-
export interface JsonApiAutomationInAttributesSlidesExportsInner {
|
|
3845
|
-
requestPayload: SlidesExportRequest;
|
|
3846
|
-
}
|
|
3847
|
-
export interface JsonApiAutomationInAttributesTabularExportsInner {
|
|
3848
|
-
requestPayload: TabularExportRequest;
|
|
3849
|
-
}
|
|
3850
|
-
export interface JsonApiAutomationInAttributesVisualExportsInner {
|
|
3851
|
-
requestPayload: VisualExportRequest;
|
|
3852
|
-
}
|
|
3853
3778
|
export interface JsonApiAutomationInDocument {
|
|
3854
3779
|
data: JsonApiAutomationIn;
|
|
3855
3780
|
}
|
|
3856
3781
|
export interface JsonApiAutomationInRelationships {
|
|
3857
|
-
notificationChannel?:
|
|
3858
|
-
analyticalDashboard?:
|
|
3859
|
-
exportDefinitions?:
|
|
3860
|
-
recipients?:
|
|
3861
|
-
}
|
|
3862
|
-
export interface JsonApiAutomationInRelationshipsAnalyticalDashboard {
|
|
3863
|
-
data: JsonApiAnalyticalDashboardLinkage | null;
|
|
3864
|
-
}
|
|
3865
|
-
export interface JsonApiAutomationInRelationshipsExportDefinitions {
|
|
3866
|
-
/**
|
|
3867
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3868
|
-
*/
|
|
3869
|
-
data: Array<JsonApiExportDefinitionLinkage>;
|
|
3870
|
-
}
|
|
3871
|
-
export interface JsonApiAutomationInRelationshipsNotificationChannel {
|
|
3872
|
-
data: JsonApiNotificationChannelLinkage | null;
|
|
3873
|
-
}
|
|
3874
|
-
export interface JsonApiAutomationInRelationshipsRecipients {
|
|
3875
|
-
/**
|
|
3876
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3877
|
-
*/
|
|
3878
|
-
data: Array<JsonApiUserLinkage>;
|
|
3782
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
3783
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
3784
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
3785
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
3879
3786
|
}
|
|
3880
3787
|
/**
|
|
3881
3788
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
@@ -3900,7 +3807,7 @@ export interface JsonApiAutomationOut {
|
|
|
3900
3807
|
* API identifier of an object
|
|
3901
3808
|
*/
|
|
3902
3809
|
id: string;
|
|
3903
|
-
meta?:
|
|
3810
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3904
3811
|
attributes?: JsonApiAutomationOutAttributes;
|
|
3905
3812
|
relationships?: JsonApiAutomationOutRelationships;
|
|
3906
3813
|
}
|
|
@@ -3917,23 +3824,23 @@ export interface JsonApiAutomationOutAttributes {
|
|
|
3917
3824
|
* Additional details to be included in the automated message.
|
|
3918
3825
|
*/
|
|
3919
3826
|
details?: object;
|
|
3920
|
-
metadata?:
|
|
3827
|
+
metadata?: JsonApiAutomationOutAttributesMetadata | null;
|
|
3921
3828
|
/**
|
|
3922
3829
|
* Current state of the automation.
|
|
3923
3830
|
*/
|
|
3924
3831
|
state?: JsonApiAutomationOutAttributesStateEnum;
|
|
3925
|
-
schedule?:
|
|
3926
|
-
alert?:
|
|
3927
|
-
tabularExports?: Array<
|
|
3928
|
-
visualExports?: Array<
|
|
3929
|
-
imageExports?: Array<
|
|
3930
|
-
rawExports?: Array<
|
|
3931
|
-
slidesExports?: Array<
|
|
3932
|
-
dashboardTabularExports?: Array<
|
|
3832
|
+
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
3833
|
+
alert?: JsonApiAutomationOutAttributesAlert;
|
|
3834
|
+
tabularExports?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
|
|
3835
|
+
visualExports?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
|
|
3836
|
+
imageExports?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
|
|
3837
|
+
rawExports?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
|
|
3838
|
+
slidesExports?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
|
|
3839
|
+
dashboardTabularExports?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
|
|
3933
3840
|
/**
|
|
3934
3841
|
* External recipients of the automation action results.
|
|
3935
3842
|
*/
|
|
3936
|
-
externalRecipients?: Array<
|
|
3843
|
+
externalRecipients?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
|
|
3937
3844
|
createdAt?: string;
|
|
3938
3845
|
modifiedAt?: string;
|
|
3939
3846
|
}
|
|
@@ -3942,6 +3849,68 @@ export declare const JsonApiAutomationOutAttributesStateEnum: {
|
|
|
3942
3849
|
readonly PAUSED: "PAUSED";
|
|
3943
3850
|
};
|
|
3944
3851
|
export type JsonApiAutomationOutAttributesStateEnum = (typeof JsonApiAutomationOutAttributesStateEnum)[keyof typeof JsonApiAutomationOutAttributesStateEnum];
|
|
3852
|
+
export interface JsonApiAutomationOutAttributesAlert {
|
|
3853
|
+
execution: AlertAfm;
|
|
3854
|
+
condition: AlertCondition;
|
|
3855
|
+
/**
|
|
3856
|
+
* 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.
|
|
3857
|
+
*/
|
|
3858
|
+
trigger?: JsonApiAutomationOutAttributesAlertTriggerEnum;
|
|
3859
|
+
}
|
|
3860
|
+
export declare const JsonApiAutomationOutAttributesAlertTriggerEnum: {
|
|
3861
|
+
readonly ALWAYS: "ALWAYS";
|
|
3862
|
+
readonly ONCE: "ONCE";
|
|
3863
|
+
};
|
|
3864
|
+
export type JsonApiAutomationOutAttributesAlertTriggerEnum = (typeof JsonApiAutomationOutAttributesAlertTriggerEnum)[keyof typeof JsonApiAutomationOutAttributesAlertTriggerEnum];
|
|
3865
|
+
export interface JsonApiAutomationOutAttributesDashboardTabularExportsInner {
|
|
3866
|
+
requestPayload: DashboardTabularExportRequestV2;
|
|
3867
|
+
}
|
|
3868
|
+
export interface JsonApiAutomationOutAttributesExternalRecipientsInner {
|
|
3869
|
+
/**
|
|
3870
|
+
* E-mail address to send notifications from.
|
|
3871
|
+
*/
|
|
3872
|
+
email: string;
|
|
3873
|
+
}
|
|
3874
|
+
export interface JsonApiAutomationOutAttributesImageExportsInner {
|
|
3875
|
+
requestPayload: ImageExportRequest;
|
|
3876
|
+
}
|
|
3877
|
+
/**
|
|
3878
|
+
* Additional information for the automation.
|
|
3879
|
+
*/
|
|
3880
|
+
export interface JsonApiAutomationOutAttributesMetadata {
|
|
3881
|
+
widget?: string;
|
|
3882
|
+
visibleFilters?: Array<VisibleFilter>;
|
|
3883
|
+
}
|
|
3884
|
+
export interface JsonApiAutomationOutAttributesRawExportsInner {
|
|
3885
|
+
requestPayload: RawExportAutomationRequest;
|
|
3886
|
+
}
|
|
3887
|
+
export interface JsonApiAutomationOutAttributesSchedule {
|
|
3888
|
+
/**
|
|
3889
|
+
* 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.
|
|
3890
|
+
*/
|
|
3891
|
+
cron: string;
|
|
3892
|
+
/**
|
|
3893
|
+
* Human-readable description of the cron expression.
|
|
3894
|
+
*/
|
|
3895
|
+
cronDescription?: string;
|
|
3896
|
+
/**
|
|
3897
|
+
* Timezone in which the schedule is defined.
|
|
3898
|
+
*/
|
|
3899
|
+
timezone: string;
|
|
3900
|
+
/**
|
|
3901
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
3902
|
+
*/
|
|
3903
|
+
firstRun?: string;
|
|
3904
|
+
}
|
|
3905
|
+
export interface JsonApiAutomationOutAttributesSlidesExportsInner {
|
|
3906
|
+
requestPayload: SlidesExportRequest;
|
|
3907
|
+
}
|
|
3908
|
+
export interface JsonApiAutomationOutAttributesTabularExportsInner {
|
|
3909
|
+
requestPayload: TabularExportRequest;
|
|
3910
|
+
}
|
|
3911
|
+
export interface JsonApiAutomationOutAttributesVisualExportsInner {
|
|
3912
|
+
requestPayload: VisualExportRequest;
|
|
3913
|
+
}
|
|
3945
3914
|
export interface JsonApiAutomationOutDocument {
|
|
3946
3915
|
data: JsonApiAutomationOut;
|
|
3947
3916
|
links?: ObjectLinks;
|
|
@@ -3960,19 +3929,19 @@ export type JsonApiAutomationOutIncludes = JsonApiAnalyticalDashboardOutWithLink
|
|
|
3960
3929
|
export interface JsonApiAutomationOutList {
|
|
3961
3930
|
data: Array<JsonApiAutomationOutWithLinks>;
|
|
3962
3931
|
links?: ListLinks;
|
|
3963
|
-
meta?:
|
|
3932
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
3964
3933
|
/**
|
|
3965
3934
|
* Included resources
|
|
3966
3935
|
*/
|
|
3967
3936
|
included?: Array<JsonApiAutomationOutIncludes>;
|
|
3968
3937
|
}
|
|
3969
3938
|
export interface JsonApiAutomationOutRelationships {
|
|
3970
|
-
notificationChannel?:
|
|
3971
|
-
analyticalDashboard?:
|
|
3939
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
3940
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
3972
3941
|
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3973
3942
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
3974
|
-
exportDefinitions?:
|
|
3975
|
-
recipients?:
|
|
3943
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
3944
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
3976
3945
|
automationResults?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
3977
3946
|
}
|
|
3978
3947
|
export interface JsonApiAutomationOutRelationshipsAutomationResults {
|
|
@@ -3981,6 +3950,21 @@ export interface JsonApiAutomationOutRelationshipsAutomationResults {
|
|
|
3981
3950
|
*/
|
|
3982
3951
|
data: Array<JsonApiAutomationResultLinkage>;
|
|
3983
3952
|
}
|
|
3953
|
+
export interface JsonApiAutomationOutRelationshipsExportDefinitions {
|
|
3954
|
+
/**
|
|
3955
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3956
|
+
*/
|
|
3957
|
+
data: Array<JsonApiExportDefinitionLinkage>;
|
|
3958
|
+
}
|
|
3959
|
+
export interface JsonApiAutomationOutRelationshipsNotificationChannel {
|
|
3960
|
+
data: JsonApiNotificationChannelLinkage | null;
|
|
3961
|
+
}
|
|
3962
|
+
export interface JsonApiAutomationOutRelationshipsRecipients {
|
|
3963
|
+
/**
|
|
3964
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
3965
|
+
*/
|
|
3966
|
+
data: Array<JsonApiUserLinkage>;
|
|
3967
|
+
}
|
|
3984
3968
|
export interface JsonApiAutomationOutWithLinks {
|
|
3985
3969
|
/**
|
|
3986
3970
|
* Object type
|
|
@@ -3990,7 +3974,7 @@ export interface JsonApiAutomationOutWithLinks {
|
|
|
3990
3974
|
* API identifier of an object
|
|
3991
3975
|
*/
|
|
3992
3976
|
id: string;
|
|
3993
|
-
meta?:
|
|
3977
|
+
meta?: JsonApiDatasetOutMeta;
|
|
3994
3978
|
attributes?: JsonApiAutomationOutAttributes;
|
|
3995
3979
|
relationships?: JsonApiAutomationOutRelationships;
|
|
3996
3980
|
links?: ObjectLinks;
|
|
@@ -4144,7 +4128,10 @@ export interface JsonApiColorPaletteOutDocument {
|
|
|
4144
4128
|
export interface JsonApiColorPaletteOutList {
|
|
4145
4129
|
data: Array<JsonApiColorPaletteOutWithLinks>;
|
|
4146
4130
|
links?: ListLinks;
|
|
4147
|
-
meta?:
|
|
4131
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
4132
|
+
}
|
|
4133
|
+
export interface JsonApiColorPaletteOutListMeta {
|
|
4134
|
+
page?: PageMetadata;
|
|
4148
4135
|
}
|
|
4149
4136
|
export interface JsonApiColorPaletteOutWithLinks {
|
|
4150
4137
|
/**
|
|
@@ -4202,12 +4189,19 @@ export interface JsonApiCookieSecurityConfigurationIn {
|
|
|
4202
4189
|
* API identifier of an object
|
|
4203
4190
|
*/
|
|
4204
4191
|
id: string;
|
|
4205
|
-
attributes?:
|
|
4192
|
+
attributes?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
4206
4193
|
}
|
|
4207
4194
|
export declare const JsonApiCookieSecurityConfigurationInTypeEnum: {
|
|
4208
4195
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
4209
4196
|
};
|
|
4210
4197
|
export type JsonApiCookieSecurityConfigurationInTypeEnum = (typeof JsonApiCookieSecurityConfigurationInTypeEnum)[keyof typeof JsonApiCookieSecurityConfigurationInTypeEnum];
|
|
4198
|
+
export interface JsonApiCookieSecurityConfigurationInAttributes {
|
|
4199
|
+
lastRotation?: string;
|
|
4200
|
+
/**
|
|
4201
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
4202
|
+
*/
|
|
4203
|
+
rotationInterval?: string;
|
|
4204
|
+
}
|
|
4211
4205
|
export interface JsonApiCookieSecurityConfigurationInDocument {
|
|
4212
4206
|
data: JsonApiCookieSecurityConfigurationIn;
|
|
4213
4207
|
}
|
|
@@ -4223,19 +4217,12 @@ export interface JsonApiCookieSecurityConfigurationOut {
|
|
|
4223
4217
|
* API identifier of an object
|
|
4224
4218
|
*/
|
|
4225
4219
|
id: string;
|
|
4226
|
-
attributes?:
|
|
4220
|
+
attributes?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
4227
4221
|
}
|
|
4228
4222
|
export declare const JsonApiCookieSecurityConfigurationOutTypeEnum: {
|
|
4229
4223
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
4230
4224
|
};
|
|
4231
4225
|
export type JsonApiCookieSecurityConfigurationOutTypeEnum = (typeof JsonApiCookieSecurityConfigurationOutTypeEnum)[keyof typeof JsonApiCookieSecurityConfigurationOutTypeEnum];
|
|
4232
|
-
export interface JsonApiCookieSecurityConfigurationOutAttributes {
|
|
4233
|
-
lastRotation?: string;
|
|
4234
|
-
/**
|
|
4235
|
-
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
4236
|
-
*/
|
|
4237
|
-
rotationInterval?: string;
|
|
4238
|
-
}
|
|
4239
4226
|
export interface JsonApiCookieSecurityConfigurationOutDocument {
|
|
4240
4227
|
data: JsonApiCookieSecurityConfigurationOut;
|
|
4241
4228
|
links?: ObjectLinks;
|
|
@@ -4252,7 +4239,7 @@ export interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
4252
4239
|
* API identifier of an object
|
|
4253
4240
|
*/
|
|
4254
4241
|
id: string;
|
|
4255
|
-
attributes?:
|
|
4242
|
+
attributes?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
4256
4243
|
}
|
|
4257
4244
|
export declare const JsonApiCookieSecurityConfigurationPatchTypeEnum: {
|
|
4258
4245
|
readonly COOKIE_SECURITY_CONFIGURATION: "cookieSecurityConfiguration";
|
|
@@ -4313,7 +4300,7 @@ export interface JsonApiCspDirectiveOutDocument {
|
|
|
4313
4300
|
export interface JsonApiCspDirectiveOutList {
|
|
4314
4301
|
data: Array<JsonApiCspDirectiveOutWithLinks>;
|
|
4315
4302
|
links?: ListLinks;
|
|
4316
|
-
meta?:
|
|
4303
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
4317
4304
|
}
|
|
4318
4305
|
export interface JsonApiCspDirectiveOutWithLinks {
|
|
4319
4306
|
/**
|
|
@@ -4367,19 +4354,12 @@ export interface JsonApiCustomApplicationSettingIn {
|
|
|
4367
4354
|
* API identifier of an object
|
|
4368
4355
|
*/
|
|
4369
4356
|
id: string;
|
|
4370
|
-
attributes:
|
|
4357
|
+
attributes: JsonApiCustomApplicationSettingOutAttributes;
|
|
4371
4358
|
}
|
|
4372
4359
|
export declare const JsonApiCustomApplicationSettingInTypeEnum: {
|
|
4373
4360
|
readonly CUSTOM_APPLICATION_SETTING: "customApplicationSetting";
|
|
4374
4361
|
};
|
|
4375
4362
|
export type JsonApiCustomApplicationSettingInTypeEnum = (typeof JsonApiCustomApplicationSettingInTypeEnum)[keyof typeof JsonApiCustomApplicationSettingInTypeEnum];
|
|
4376
|
-
export interface JsonApiCustomApplicationSettingInAttributes {
|
|
4377
|
-
applicationName: string;
|
|
4378
|
-
/**
|
|
4379
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
4380
|
-
*/
|
|
4381
|
-
content: object;
|
|
4382
|
-
}
|
|
4383
4363
|
export interface JsonApiCustomApplicationSettingInDocument {
|
|
4384
4364
|
data: JsonApiCustomApplicationSettingIn;
|
|
4385
4365
|
}
|
|
@@ -4395,13 +4375,20 @@ export interface JsonApiCustomApplicationSettingOut {
|
|
|
4395
4375
|
* API identifier of an object
|
|
4396
4376
|
*/
|
|
4397
4377
|
id: string;
|
|
4398
|
-
meta?:
|
|
4399
|
-
attributes:
|
|
4378
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4379
|
+
attributes: JsonApiCustomApplicationSettingOutAttributes;
|
|
4400
4380
|
}
|
|
4401
4381
|
export declare const JsonApiCustomApplicationSettingOutTypeEnum: {
|
|
4402
4382
|
readonly CUSTOM_APPLICATION_SETTING: "customApplicationSetting";
|
|
4403
4383
|
};
|
|
4404
4384
|
export type JsonApiCustomApplicationSettingOutTypeEnum = (typeof JsonApiCustomApplicationSettingOutTypeEnum)[keyof typeof JsonApiCustomApplicationSettingOutTypeEnum];
|
|
4385
|
+
export interface JsonApiCustomApplicationSettingOutAttributes {
|
|
4386
|
+
applicationName: string;
|
|
4387
|
+
/**
|
|
4388
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
4389
|
+
*/
|
|
4390
|
+
content: object;
|
|
4391
|
+
}
|
|
4405
4392
|
export interface JsonApiCustomApplicationSettingOutDocument {
|
|
4406
4393
|
data: JsonApiCustomApplicationSettingOut;
|
|
4407
4394
|
links?: ObjectLinks;
|
|
@@ -4412,7 +4399,7 @@ export interface JsonApiCustomApplicationSettingOutDocument {
|
|
|
4412
4399
|
export interface JsonApiCustomApplicationSettingOutList {
|
|
4413
4400
|
data: Array<JsonApiCustomApplicationSettingOutWithLinks>;
|
|
4414
4401
|
links?: ListLinks;
|
|
4415
|
-
meta?:
|
|
4402
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
4416
4403
|
}
|
|
4417
4404
|
export interface JsonApiCustomApplicationSettingOutWithLinks {
|
|
4418
4405
|
/**
|
|
@@ -4423,8 +4410,8 @@ export interface JsonApiCustomApplicationSettingOutWithLinks {
|
|
|
4423
4410
|
* API identifier of an object
|
|
4424
4411
|
*/
|
|
4425
4412
|
id: string;
|
|
4426
|
-
meta?:
|
|
4427
|
-
attributes:
|
|
4413
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4414
|
+
attributes: JsonApiCustomApplicationSettingOutAttributes;
|
|
4428
4415
|
links?: ObjectLinks;
|
|
4429
4416
|
}
|
|
4430
4417
|
export declare const JsonApiCustomApplicationSettingOutWithLinksTypeEnum: {
|
|
@@ -4471,7 +4458,7 @@ export interface JsonApiCustomApplicationSettingPostOptionalId {
|
|
|
4471
4458
|
* API identifier of an object
|
|
4472
4459
|
*/
|
|
4473
4460
|
id?: string;
|
|
4474
|
-
attributes:
|
|
4461
|
+
attributes: JsonApiCustomApplicationSettingOutAttributes;
|
|
4475
4462
|
}
|
|
4476
4463
|
export declare const JsonApiCustomApplicationSettingPostOptionalIdTypeEnum: {
|
|
4477
4464
|
readonly CUSTOM_APPLICATION_SETTING: "customApplicationSetting";
|
|
@@ -4534,7 +4521,7 @@ export interface JsonApiDashboardPluginOut {
|
|
|
4534
4521
|
* API identifier of an object
|
|
4535
4522
|
*/
|
|
4536
4523
|
id: string;
|
|
4537
|
-
meta?:
|
|
4524
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4538
4525
|
attributes?: JsonApiDashboardPluginOutAttributes;
|
|
4539
4526
|
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
4540
4527
|
}
|
|
@@ -4568,7 +4555,7 @@ export interface JsonApiDashboardPluginOutDocument {
|
|
|
4568
4555
|
export interface JsonApiDashboardPluginOutList {
|
|
4569
4556
|
data: Array<JsonApiDashboardPluginOutWithLinks>;
|
|
4570
4557
|
links?: ListLinks;
|
|
4571
|
-
meta?:
|
|
4558
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
4572
4559
|
/**
|
|
4573
4560
|
* Included resources
|
|
4574
4561
|
*/
|
|
@@ -4587,7 +4574,7 @@ export interface JsonApiDashboardPluginOutWithLinks {
|
|
|
4587
4574
|
* API identifier of an object
|
|
4588
4575
|
*/
|
|
4589
4576
|
id: string;
|
|
4590
|
-
meta?:
|
|
4577
|
+
meta?: JsonApiDatasetOutMeta;
|
|
4591
4578
|
attributes?: JsonApiDashboardPluginOutAttributes;
|
|
4592
4579
|
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
4593
4580
|
links?: ObjectLinks;
|
|
@@ -4650,7 +4637,7 @@ export interface JsonApiDataSourceIdentifierOut {
|
|
|
4650
4637
|
* API identifier of an object
|
|
4651
4638
|
*/
|
|
4652
4639
|
id: string;
|
|
4653
|
-
meta?:
|
|
4640
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
4654
4641
|
attributes: JsonApiDataSourceIdentifierOutAttributes;
|
|
4655
4642
|
}
|
|
4656
4643
|
export declare const JsonApiDataSourceIdentifierOutTypeEnum: {
|
|
@@ -4701,8 +4688,19 @@ export interface JsonApiDataSourceIdentifierOutDocument {
|
|
|
4701
4688
|
export interface JsonApiDataSourceIdentifierOutList {
|
|
4702
4689
|
data: Array<JsonApiDataSourceIdentifierOutWithLinks>;
|
|
4703
4690
|
links?: ListLinks;
|
|
4704
|
-
meta?:
|
|
4691
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
4705
4692
|
}
|
|
4693
|
+
export interface JsonApiDataSourceIdentifierOutMeta {
|
|
4694
|
+
/**
|
|
4695
|
+
* List of valid permissions for a logged-in user.
|
|
4696
|
+
*/
|
|
4697
|
+
permissions?: Array<JsonApiDataSourceIdentifierOutMetaPermissionsEnum>;
|
|
4698
|
+
}
|
|
4699
|
+
export declare const JsonApiDataSourceIdentifierOutMetaPermissionsEnum: {
|
|
4700
|
+
readonly MANAGE: "MANAGE";
|
|
4701
|
+
readonly USE: "USE";
|
|
4702
|
+
};
|
|
4703
|
+
export type JsonApiDataSourceIdentifierOutMetaPermissionsEnum = (typeof JsonApiDataSourceIdentifierOutMetaPermissionsEnum)[keyof typeof JsonApiDataSourceIdentifierOutMetaPermissionsEnum];
|
|
4706
4704
|
export interface JsonApiDataSourceIdentifierOutWithLinks {
|
|
4707
4705
|
/**
|
|
4708
4706
|
* Object type
|
|
@@ -4712,7 +4710,7 @@ export interface JsonApiDataSourceIdentifierOutWithLinks {
|
|
|
4712
4710
|
* API identifier of an object
|
|
4713
4711
|
*/
|
|
4714
4712
|
id: string;
|
|
4715
|
-
meta?:
|
|
4713
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
4716
4714
|
attributes: JsonApiDataSourceIdentifierOutAttributes;
|
|
4717
4715
|
links?: ObjectLinks;
|
|
4718
4716
|
}
|
|
@@ -4786,7 +4784,7 @@ export interface JsonApiDataSourceInAttributes {
|
|
|
4786
4784
|
/**
|
|
4787
4785
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
4788
4786
|
*/
|
|
4789
|
-
parameters?: Array<
|
|
4787
|
+
parameters?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
4790
4788
|
/**
|
|
4791
4789
|
* Determines how the results coming from a particular datasource should be cached.
|
|
4792
4790
|
*/
|
|
@@ -4841,7 +4839,7 @@ export interface JsonApiDataSourceOut {
|
|
|
4841
4839
|
* API identifier of an object
|
|
4842
4840
|
*/
|
|
4843
4841
|
id: string;
|
|
4844
|
-
meta?:
|
|
4842
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
4845
4843
|
attributes: JsonApiDataSourceOutAttributes;
|
|
4846
4844
|
}
|
|
4847
4845
|
export declare const JsonApiDataSourceOutTypeEnum: {
|
|
@@ -4876,11 +4874,11 @@ export interface JsonApiDataSourceOutAttributes {
|
|
|
4876
4874
|
/**
|
|
4877
4875
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
4878
4876
|
*/
|
|
4879
|
-
parameters?: Array<
|
|
4877
|
+
parameters?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
4880
4878
|
/**
|
|
4881
4879
|
* Decoded parameters to be used when connecting to the database providing the data for the data source.
|
|
4882
4880
|
*/
|
|
4883
|
-
decodedParameters?: Array<
|
|
4881
|
+
decodedParameters?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
4884
4882
|
/**
|
|
4885
4883
|
* Determines how the results coming from a particular datasource should be cached.
|
|
4886
4884
|
*/
|
|
@@ -4932,6 +4930,10 @@ export declare const JsonApiDataSourceOutAttributesAuthenticationTypeEnum: {
|
|
|
4932
4930
|
readonly ACCESS_TOKEN: "ACCESS_TOKEN";
|
|
4933
4931
|
};
|
|
4934
4932
|
export type JsonApiDataSourceOutAttributesAuthenticationTypeEnum = (typeof JsonApiDataSourceOutAttributesAuthenticationTypeEnum)[keyof typeof JsonApiDataSourceOutAttributesAuthenticationTypeEnum];
|
|
4933
|
+
export interface JsonApiDataSourceOutAttributesParametersInner {
|
|
4934
|
+
name: string;
|
|
4935
|
+
value: string;
|
|
4936
|
+
}
|
|
4935
4937
|
export interface JsonApiDataSourceOutDocument {
|
|
4936
4938
|
data: JsonApiDataSourceOut;
|
|
4937
4939
|
links?: ObjectLinks;
|
|
@@ -4942,19 +4944,8 @@ export interface JsonApiDataSourceOutDocument {
|
|
|
4942
4944
|
export interface JsonApiDataSourceOutList {
|
|
4943
4945
|
data: Array<JsonApiDataSourceOutWithLinks>;
|
|
4944
4946
|
links?: ListLinks;
|
|
4945
|
-
meta?:
|
|
4946
|
-
}
|
|
4947
|
-
export interface JsonApiDataSourceOutMeta {
|
|
4948
|
-
/**
|
|
4949
|
-
* List of valid permissions for a logged-in user.
|
|
4950
|
-
*/
|
|
4951
|
-
permissions?: Array<JsonApiDataSourceOutMetaPermissionsEnum>;
|
|
4947
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
4952
4948
|
}
|
|
4953
|
-
export declare const JsonApiDataSourceOutMetaPermissionsEnum: {
|
|
4954
|
-
readonly MANAGE: "MANAGE";
|
|
4955
|
-
readonly USE: "USE";
|
|
4956
|
-
};
|
|
4957
|
-
export type JsonApiDataSourceOutMetaPermissionsEnum = (typeof JsonApiDataSourceOutMetaPermissionsEnum)[keyof typeof JsonApiDataSourceOutMetaPermissionsEnum];
|
|
4958
4949
|
export interface JsonApiDataSourceOutWithLinks {
|
|
4959
4950
|
/**
|
|
4960
4951
|
* Object type
|
|
@@ -4964,7 +4955,7 @@ export interface JsonApiDataSourceOutWithLinks {
|
|
|
4964
4955
|
* API identifier of an object
|
|
4965
4956
|
*/
|
|
4966
4957
|
id: string;
|
|
4967
|
-
meta?:
|
|
4958
|
+
meta?: JsonApiDataSourceIdentifierOutMeta;
|
|
4968
4959
|
attributes: JsonApiDataSourceOutAttributes;
|
|
4969
4960
|
links?: ObjectLinks;
|
|
4970
4961
|
}
|
|
@@ -5038,7 +5029,7 @@ export interface JsonApiDataSourcePatchAttributes {
|
|
|
5038
5029
|
/**
|
|
5039
5030
|
* Additional parameters to be used when connecting to the database providing the data for the data source.
|
|
5040
5031
|
*/
|
|
5041
|
-
parameters?: Array<
|
|
5032
|
+
parameters?: Array<JsonApiDataSourceOutAttributesParametersInner> | null;
|
|
5042
5033
|
/**
|
|
5043
5034
|
* Determines how the results coming from a particular datasource should be cached.
|
|
5044
5035
|
*/
|
|
@@ -5078,10 +5069,6 @@ export declare const JsonApiDataSourcePatchAttributesCacheStrategyEnum: {
|
|
|
5078
5069
|
readonly NEVER: "NEVER";
|
|
5079
5070
|
};
|
|
5080
5071
|
export type JsonApiDataSourcePatchAttributesCacheStrategyEnum = (typeof JsonApiDataSourcePatchAttributesCacheStrategyEnum)[keyof typeof JsonApiDataSourcePatchAttributesCacheStrategyEnum];
|
|
5081
|
-
export interface JsonApiDataSourcePatchAttributesParametersInner {
|
|
5082
|
-
name: string;
|
|
5083
|
-
value: string;
|
|
5084
|
-
}
|
|
5085
5072
|
export interface JsonApiDataSourcePatchDocument {
|
|
5086
5073
|
data: JsonApiDataSourcePatch;
|
|
5087
5074
|
}
|
|
@@ -5108,7 +5095,7 @@ export interface JsonApiDatasetOut {
|
|
|
5108
5095
|
* API identifier of an object
|
|
5109
5096
|
*/
|
|
5110
5097
|
id: string;
|
|
5111
|
-
meta?:
|
|
5098
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5112
5099
|
attributes: JsonApiDatasetOutAttributes;
|
|
5113
5100
|
relationships?: JsonApiDatasetOutRelationships;
|
|
5114
5101
|
}
|
|
@@ -5219,17 +5206,35 @@ export type JsonApiDatasetOutIncludes = JsonApiAggregatedFactOutWithLinks | Json
|
|
|
5219
5206
|
export interface JsonApiDatasetOutList {
|
|
5220
5207
|
data: Array<JsonApiDatasetOutWithLinks>;
|
|
5221
5208
|
links?: ListLinks;
|
|
5222
|
-
meta?:
|
|
5209
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
5223
5210
|
/**
|
|
5224
5211
|
* Included resources
|
|
5225
5212
|
*/
|
|
5226
5213
|
included?: Array<JsonApiDatasetOutIncludes>;
|
|
5227
5214
|
}
|
|
5215
|
+
export interface JsonApiDatasetOutMeta {
|
|
5216
|
+
origin?: JsonApiDatasetOutMetaOrigin;
|
|
5217
|
+
}
|
|
5218
|
+
export interface JsonApiDatasetOutMetaOrigin {
|
|
5219
|
+
/**
|
|
5220
|
+
* defines type of the origin of the entity
|
|
5221
|
+
*/
|
|
5222
|
+
originType: JsonApiDatasetOutMetaOriginOriginTypeEnum;
|
|
5223
|
+
/**
|
|
5224
|
+
* defines id of the workspace where the entity comes from
|
|
5225
|
+
*/
|
|
5226
|
+
originId: string;
|
|
5227
|
+
}
|
|
5228
|
+
export declare const JsonApiDatasetOutMetaOriginOriginTypeEnum: {
|
|
5229
|
+
readonly NATIVE: "NATIVE";
|
|
5230
|
+
readonly PARENT: "PARENT";
|
|
5231
|
+
};
|
|
5232
|
+
export type JsonApiDatasetOutMetaOriginOriginTypeEnum = (typeof JsonApiDatasetOutMetaOriginOriginTypeEnum)[keyof typeof JsonApiDatasetOutMetaOriginOriginTypeEnum];
|
|
5228
5233
|
export interface JsonApiDatasetOutRelationships {
|
|
5229
|
-
attributes?:
|
|
5230
|
-
facts?:
|
|
5234
|
+
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
5235
|
+
facts?: JsonApiDatasetOutRelationshipsFacts;
|
|
5231
5236
|
aggregatedFacts?: JsonApiDatasetOutRelationshipsAggregatedFacts;
|
|
5232
|
-
references?:
|
|
5237
|
+
references?: JsonApiDatasetOutRelationshipsReferences;
|
|
5233
5238
|
workspaceDataFilters?: JsonApiDatasetOutRelationshipsWorkspaceDataFilters;
|
|
5234
5239
|
}
|
|
5235
5240
|
export interface JsonApiDatasetOutRelationshipsAggregatedFacts {
|
|
@@ -5238,6 +5243,24 @@ export interface JsonApiDatasetOutRelationshipsAggregatedFacts {
|
|
|
5238
5243
|
*/
|
|
5239
5244
|
data: Array<JsonApiAggregatedFactLinkage>;
|
|
5240
5245
|
}
|
|
5246
|
+
export interface JsonApiDatasetOutRelationshipsAttributes {
|
|
5247
|
+
/**
|
|
5248
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5249
|
+
*/
|
|
5250
|
+
data: Array<JsonApiAttributeLinkage>;
|
|
5251
|
+
}
|
|
5252
|
+
export interface JsonApiDatasetOutRelationshipsFacts {
|
|
5253
|
+
/**
|
|
5254
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5255
|
+
*/
|
|
5256
|
+
data: Array<JsonApiFactLinkage>;
|
|
5257
|
+
}
|
|
5258
|
+
export interface JsonApiDatasetOutRelationshipsReferences {
|
|
5259
|
+
/**
|
|
5260
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
5261
|
+
*/
|
|
5262
|
+
data: Array<JsonApiDatasetLinkage>;
|
|
5263
|
+
}
|
|
5241
5264
|
export interface JsonApiDatasetOutRelationshipsWorkspaceDataFilters {
|
|
5242
5265
|
/**
|
|
5243
5266
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -5253,7 +5276,7 @@ export interface JsonApiDatasetOutWithLinks {
|
|
|
5253
5276
|
* API identifier of an object
|
|
5254
5277
|
*/
|
|
5255
5278
|
id: string;
|
|
5256
|
-
meta?:
|
|
5279
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5257
5280
|
attributes: JsonApiDatasetOutAttributes;
|
|
5258
5281
|
relationships?: JsonApiDatasetOutRelationships;
|
|
5259
5282
|
links?: ObjectLinks;
|
|
@@ -5294,7 +5317,7 @@ export interface JsonApiEntitlementOutDocument {
|
|
|
5294
5317
|
export interface JsonApiEntitlementOutList {
|
|
5295
5318
|
data: Array<JsonApiEntitlementOutWithLinks>;
|
|
5296
5319
|
links?: ListLinks;
|
|
5297
|
-
meta?:
|
|
5320
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
5298
5321
|
}
|
|
5299
5322
|
export interface JsonApiEntitlementOutWithLinks {
|
|
5300
5323
|
/**
|
|
@@ -5343,7 +5366,7 @@ export interface JsonApiExportDefinitionInDocument {
|
|
|
5343
5366
|
}
|
|
5344
5367
|
export interface JsonApiExportDefinitionInRelationships {
|
|
5345
5368
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
5346
|
-
analyticalDashboard?:
|
|
5369
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
5347
5370
|
}
|
|
5348
5371
|
/**
|
|
5349
5372
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
@@ -5368,7 +5391,7 @@ export interface JsonApiExportDefinitionOut {
|
|
|
5368
5391
|
* API identifier of an object
|
|
5369
5392
|
*/
|
|
5370
5393
|
id: string;
|
|
5371
|
-
meta?:
|
|
5394
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5372
5395
|
attributes?: JsonApiExportDefinitionOutAttributes;
|
|
5373
5396
|
relationships?: JsonApiExportDefinitionOutRelationships;
|
|
5374
5397
|
}
|
|
@@ -5408,7 +5431,7 @@ export type JsonApiExportDefinitionOutIncludes = JsonApiAnalyticalDashboardOutWi
|
|
|
5408
5431
|
export interface JsonApiExportDefinitionOutList {
|
|
5409
5432
|
data: Array<JsonApiExportDefinitionOutWithLinks>;
|
|
5410
5433
|
links?: ListLinks;
|
|
5411
|
-
meta?:
|
|
5434
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
5412
5435
|
/**
|
|
5413
5436
|
* Included resources
|
|
5414
5437
|
*/
|
|
@@ -5416,11 +5439,14 @@ export interface JsonApiExportDefinitionOutList {
|
|
|
5416
5439
|
}
|
|
5417
5440
|
export interface JsonApiExportDefinitionOutRelationships {
|
|
5418
5441
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
5419
|
-
analyticalDashboard?:
|
|
5442
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
5420
5443
|
automation?: JsonApiExportDefinitionOutRelationshipsAutomation;
|
|
5421
5444
|
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
5422
5445
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
5423
5446
|
}
|
|
5447
|
+
export interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard {
|
|
5448
|
+
data: JsonApiAnalyticalDashboardLinkage | null;
|
|
5449
|
+
}
|
|
5424
5450
|
export interface JsonApiExportDefinitionOutRelationshipsAutomation {
|
|
5425
5451
|
data: JsonApiAutomationLinkage | null;
|
|
5426
5452
|
}
|
|
@@ -5436,7 +5462,7 @@ export interface JsonApiExportDefinitionOutWithLinks {
|
|
|
5436
5462
|
* API identifier of an object
|
|
5437
5463
|
*/
|
|
5438
5464
|
id: string;
|
|
5439
|
-
meta?:
|
|
5465
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5440
5466
|
attributes?: JsonApiExportDefinitionOutAttributes;
|
|
5441
5467
|
relationships?: JsonApiExportDefinitionOutRelationships;
|
|
5442
5468
|
links?: ObjectLinks;
|
|
@@ -5533,9 +5559,42 @@ export interface JsonApiExportTemplateOutAttributes {
|
|
|
5533
5559
|
* User-facing name of the Slides template.
|
|
5534
5560
|
*/
|
|
5535
5561
|
name: string;
|
|
5536
|
-
dashboardSlidesTemplate?:
|
|
5537
|
-
widgetSlidesTemplate?:
|
|
5562
|
+
dashboardSlidesTemplate?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
5563
|
+
widgetSlidesTemplate?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
5538
5564
|
}
|
|
5565
|
+
/**
|
|
5566
|
+
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5567
|
+
*/
|
|
5568
|
+
export interface JsonApiExportTemplateOutAttributesDashboardSlidesTemplate {
|
|
5569
|
+
/**
|
|
5570
|
+
* Export types this template applies to.
|
|
5571
|
+
*/
|
|
5572
|
+
appliedOn: Array<JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
5573
|
+
coverSlide?: CoverSlideTemplate | null;
|
|
5574
|
+
introSlide?: IntroSlideTemplate | null;
|
|
5575
|
+
sectionSlide?: SectionSlideTemplate | null;
|
|
5576
|
+
contentSlide?: ContentSlideTemplate | null;
|
|
5577
|
+
}
|
|
5578
|
+
export declare const JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum: {
|
|
5579
|
+
readonly PDF: "PDF";
|
|
5580
|
+
readonly PPTX: "PPTX";
|
|
5581
|
+
};
|
|
5582
|
+
export type JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum = (typeof JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum)[keyof typeof JsonApiExportTemplateOutAttributesDashboardSlidesTemplateAppliedOnEnum];
|
|
5583
|
+
/**
|
|
5584
|
+
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5585
|
+
*/
|
|
5586
|
+
export interface JsonApiExportTemplateOutAttributesWidgetSlidesTemplate {
|
|
5587
|
+
/**
|
|
5588
|
+
* Export types this template applies to.
|
|
5589
|
+
*/
|
|
5590
|
+
appliedOn: Array<JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
5591
|
+
contentSlide?: ContentSlideTemplate | null;
|
|
5592
|
+
}
|
|
5593
|
+
export declare const JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum: {
|
|
5594
|
+
readonly PDF: "PDF";
|
|
5595
|
+
readonly PPTX: "PPTX";
|
|
5596
|
+
};
|
|
5597
|
+
export type JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum = (typeof JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum)[keyof typeof JsonApiExportTemplateOutAttributesWidgetSlidesTemplateAppliedOnEnum];
|
|
5539
5598
|
export interface JsonApiExportTemplateOutDocument {
|
|
5540
5599
|
data: JsonApiExportTemplateOut;
|
|
5541
5600
|
links?: ObjectLinks;
|
|
@@ -5546,7 +5605,7 @@ export interface JsonApiExportTemplateOutDocument {
|
|
|
5546
5605
|
export interface JsonApiExportTemplateOutList {
|
|
5547
5606
|
data: Array<JsonApiExportTemplateOutWithLinks>;
|
|
5548
5607
|
links?: ListLinks;
|
|
5549
|
-
meta?:
|
|
5608
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
5550
5609
|
}
|
|
5551
5610
|
export interface JsonApiExportTemplateOutWithLinks {
|
|
5552
5611
|
/**
|
|
@@ -5587,42 +5646,9 @@ export interface JsonApiExportTemplatePatchAttributes {
|
|
|
5587
5646
|
* User-facing name of the Slides template.
|
|
5588
5647
|
*/
|
|
5589
5648
|
name?: string;
|
|
5590
|
-
dashboardSlidesTemplate?:
|
|
5591
|
-
widgetSlidesTemplate?:
|
|
5649
|
+
dashboardSlidesTemplate?: JsonApiExportTemplateOutAttributesDashboardSlidesTemplate | null;
|
|
5650
|
+
widgetSlidesTemplate?: JsonApiExportTemplateOutAttributesWidgetSlidesTemplate | null;
|
|
5592
5651
|
}
|
|
5593
|
-
/**
|
|
5594
|
-
* Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5595
|
-
*/
|
|
5596
|
-
export interface JsonApiExportTemplatePatchAttributesDashboardSlidesTemplate {
|
|
5597
|
-
/**
|
|
5598
|
-
* Export types this template applies to.
|
|
5599
|
-
*/
|
|
5600
|
-
appliedOn: Array<JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum>;
|
|
5601
|
-
coverSlide?: CoverSlideTemplate | null;
|
|
5602
|
-
introSlide?: IntroSlideTemplate | null;
|
|
5603
|
-
sectionSlide?: SectionSlideTemplate | null;
|
|
5604
|
-
contentSlide?: ContentSlideTemplate | null;
|
|
5605
|
-
}
|
|
5606
|
-
export declare const JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum: {
|
|
5607
|
-
readonly PDF: "PDF";
|
|
5608
|
-
readonly PPTX: "PPTX";
|
|
5609
|
-
};
|
|
5610
|
-
export type JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum = (typeof JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum)[keyof typeof JsonApiExportTemplatePatchAttributesDashboardSlidesTemplateAppliedOnEnum];
|
|
5611
|
-
/**
|
|
5612
|
-
* Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}
|
|
5613
|
-
*/
|
|
5614
|
-
export interface JsonApiExportTemplatePatchAttributesWidgetSlidesTemplate {
|
|
5615
|
-
/**
|
|
5616
|
-
* Export types this template applies to.
|
|
5617
|
-
*/
|
|
5618
|
-
appliedOn: Array<JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum>;
|
|
5619
|
-
contentSlide?: ContentSlideTemplate | null;
|
|
5620
|
-
}
|
|
5621
|
-
export declare const JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum: {
|
|
5622
|
-
readonly PDF: "PDF";
|
|
5623
|
-
readonly PPTX: "PPTX";
|
|
5624
|
-
};
|
|
5625
|
-
export type JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum = (typeof JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum)[keyof typeof JsonApiExportTemplatePatchAttributesWidgetSlidesTemplateAppliedOnEnum];
|
|
5626
5652
|
export interface JsonApiExportTemplatePatchDocument {
|
|
5627
5653
|
data: JsonApiExportTemplatePatch;
|
|
5628
5654
|
}
|
|
@@ -5670,7 +5696,7 @@ export interface JsonApiFactOut {
|
|
|
5670
5696
|
* API identifier of an object
|
|
5671
5697
|
*/
|
|
5672
5698
|
id: string;
|
|
5673
|
-
meta?:
|
|
5699
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5674
5700
|
attributes?: JsonApiFactOutAttributes;
|
|
5675
5701
|
relationships?: JsonApiFactOutRelationships;
|
|
5676
5702
|
}
|
|
@@ -5710,14 +5736,17 @@ export interface JsonApiFactOutDocument {
|
|
|
5710
5736
|
export interface JsonApiFactOutList {
|
|
5711
5737
|
data: Array<JsonApiFactOutWithLinks>;
|
|
5712
5738
|
links?: ListLinks;
|
|
5713
|
-
meta?:
|
|
5739
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
5714
5740
|
/**
|
|
5715
5741
|
* Included resources
|
|
5716
5742
|
*/
|
|
5717
5743
|
included?: Array<JsonApiDatasetOutWithLinks>;
|
|
5718
5744
|
}
|
|
5719
5745
|
export interface JsonApiFactOutRelationships {
|
|
5720
|
-
dataset?:
|
|
5746
|
+
dataset?: JsonApiFactOutRelationshipsDataset;
|
|
5747
|
+
}
|
|
5748
|
+
export interface JsonApiFactOutRelationshipsDataset {
|
|
5749
|
+
data: JsonApiDatasetLinkage | null;
|
|
5721
5750
|
}
|
|
5722
5751
|
export interface JsonApiFactOutWithLinks {
|
|
5723
5752
|
/**
|
|
@@ -5728,7 +5757,7 @@ export interface JsonApiFactOutWithLinks {
|
|
|
5728
5757
|
* API identifier of an object
|
|
5729
5758
|
*/
|
|
5730
5759
|
id: string;
|
|
5731
|
-
meta?:
|
|
5760
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5732
5761
|
attributes?: JsonApiFactOutAttributes;
|
|
5733
5762
|
relationships?: JsonApiFactOutRelationships;
|
|
5734
5763
|
links?: ObjectLinks;
|
|
@@ -5749,7 +5778,7 @@ export interface JsonApiFilterContextIn {
|
|
|
5749
5778
|
* API identifier of an object
|
|
5750
5779
|
*/
|
|
5751
5780
|
id: string;
|
|
5752
|
-
attributes:
|
|
5781
|
+
attributes: JsonApiFilterContextOutAttributes;
|
|
5753
5782
|
}
|
|
5754
5783
|
export declare const JsonApiFilterContextInTypeEnum: {
|
|
5755
5784
|
readonly FILTER_CONTEXT: "filterContext";
|
|
@@ -5781,14 +5810,24 @@ export interface JsonApiFilterContextOut {
|
|
|
5781
5810
|
* API identifier of an object
|
|
5782
5811
|
*/
|
|
5783
5812
|
id: string;
|
|
5784
|
-
meta?:
|
|
5785
|
-
attributes:
|
|
5813
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5814
|
+
attributes: JsonApiFilterContextOutAttributes;
|
|
5786
5815
|
relationships?: JsonApiFilterContextOutRelationships;
|
|
5787
5816
|
}
|
|
5788
5817
|
export declare const JsonApiFilterContextOutTypeEnum: {
|
|
5789
5818
|
readonly FILTER_CONTEXT: "filterContext";
|
|
5790
5819
|
};
|
|
5791
5820
|
export type JsonApiFilterContextOutTypeEnum = (typeof JsonApiFilterContextOutTypeEnum)[keyof typeof JsonApiFilterContextOutTypeEnum];
|
|
5821
|
+
export interface JsonApiFilterContextOutAttributes {
|
|
5822
|
+
title?: string;
|
|
5823
|
+
description?: string;
|
|
5824
|
+
tags?: Array<string>;
|
|
5825
|
+
areRelationsValid?: boolean;
|
|
5826
|
+
/**
|
|
5827
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
5828
|
+
*/
|
|
5829
|
+
content: object;
|
|
5830
|
+
}
|
|
5792
5831
|
export interface JsonApiFilterContextOutDocument {
|
|
5793
5832
|
data: JsonApiFilterContextOut;
|
|
5794
5833
|
links?: ObjectLinks;
|
|
@@ -5807,15 +5846,15 @@ export type JsonApiFilterContextOutIncludes = JsonApiAttributeOutWithLinks | Jso
|
|
|
5807
5846
|
export interface JsonApiFilterContextOutList {
|
|
5808
5847
|
data: Array<JsonApiFilterContextOutWithLinks>;
|
|
5809
5848
|
links?: ListLinks;
|
|
5810
|
-
meta?:
|
|
5849
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
5811
5850
|
/**
|
|
5812
5851
|
* Included resources
|
|
5813
5852
|
*/
|
|
5814
5853
|
included?: Array<JsonApiFilterContextOutIncludes>;
|
|
5815
5854
|
}
|
|
5816
5855
|
export interface JsonApiFilterContextOutRelationships {
|
|
5817
|
-
attributes?:
|
|
5818
|
-
datasets?:
|
|
5856
|
+
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
5857
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
5819
5858
|
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
5820
5859
|
}
|
|
5821
5860
|
export interface JsonApiFilterContextOutWithLinks {
|
|
@@ -5827,8 +5866,8 @@ export interface JsonApiFilterContextOutWithLinks {
|
|
|
5827
5866
|
* API identifier of an object
|
|
5828
5867
|
*/
|
|
5829
5868
|
id: string;
|
|
5830
|
-
meta?:
|
|
5831
|
-
attributes:
|
|
5869
|
+
meta?: JsonApiDatasetOutMeta;
|
|
5870
|
+
attributes: JsonApiFilterContextOutAttributes;
|
|
5832
5871
|
relationships?: JsonApiFilterContextOutRelationships;
|
|
5833
5872
|
links?: ObjectLinks;
|
|
5834
5873
|
}
|
|
@@ -5869,7 +5908,7 @@ export interface JsonApiFilterContextPostOptionalId {
|
|
|
5869
5908
|
* API identifier of an object
|
|
5870
5909
|
*/
|
|
5871
5910
|
id?: string;
|
|
5872
|
-
attributes:
|
|
5911
|
+
attributes: JsonApiFilterContextOutAttributes;
|
|
5873
5912
|
}
|
|
5874
5913
|
export declare const JsonApiFilterContextPostOptionalIdTypeEnum: {
|
|
5875
5914
|
readonly FILTER_CONTEXT: "filterContext";
|
|
@@ -5890,34 +5929,16 @@ export interface JsonApiFilterViewIn {
|
|
|
5890
5929
|
* API identifier of an object
|
|
5891
5930
|
*/
|
|
5892
5931
|
id: string;
|
|
5893
|
-
attributes:
|
|
5894
|
-
relationships?:
|
|
5932
|
+
attributes: JsonApiFilterViewOutAttributes;
|
|
5933
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
5895
5934
|
}
|
|
5896
5935
|
export declare const JsonApiFilterViewInTypeEnum: {
|
|
5897
5936
|
readonly FILTER_VIEW: "filterView";
|
|
5898
5937
|
};
|
|
5899
5938
|
export type JsonApiFilterViewInTypeEnum = (typeof JsonApiFilterViewInTypeEnum)[keyof typeof JsonApiFilterViewInTypeEnum];
|
|
5900
|
-
export interface JsonApiFilterViewInAttributes {
|
|
5901
|
-
title: string;
|
|
5902
|
-
description?: string;
|
|
5903
|
-
tags?: Array<string>;
|
|
5904
|
-
areRelationsValid?: boolean;
|
|
5905
|
-
/**
|
|
5906
|
-
* Indicator whether the filter view should by applied by default.
|
|
5907
|
-
*/
|
|
5908
|
-
isDefault?: boolean;
|
|
5909
|
-
/**
|
|
5910
|
-
* The respective filter context.
|
|
5911
|
-
*/
|
|
5912
|
-
content: object;
|
|
5913
|
-
}
|
|
5914
5939
|
export interface JsonApiFilterViewInDocument {
|
|
5915
5940
|
data: JsonApiFilterViewIn;
|
|
5916
5941
|
}
|
|
5917
|
-
export interface JsonApiFilterViewInRelationships {
|
|
5918
|
-
analyticalDashboard?: JsonApiAutomationInRelationshipsAnalyticalDashboard;
|
|
5919
|
-
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
5920
|
-
}
|
|
5921
5942
|
/**
|
|
5922
5943
|
* JSON:API representation of filterView entity.
|
|
5923
5944
|
*/
|
|
@@ -5930,13 +5951,27 @@ export interface JsonApiFilterViewOut {
|
|
|
5930
5951
|
* API identifier of an object
|
|
5931
5952
|
*/
|
|
5932
5953
|
id: string;
|
|
5933
|
-
attributes:
|
|
5934
|
-
relationships?:
|
|
5954
|
+
attributes: JsonApiFilterViewOutAttributes;
|
|
5955
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
5935
5956
|
}
|
|
5936
5957
|
export declare const JsonApiFilterViewOutTypeEnum: {
|
|
5937
5958
|
readonly FILTER_VIEW: "filterView";
|
|
5938
5959
|
};
|
|
5939
5960
|
export type JsonApiFilterViewOutTypeEnum = (typeof JsonApiFilterViewOutTypeEnum)[keyof typeof JsonApiFilterViewOutTypeEnum];
|
|
5961
|
+
export interface JsonApiFilterViewOutAttributes {
|
|
5962
|
+
title: string;
|
|
5963
|
+
description?: string;
|
|
5964
|
+
tags?: Array<string>;
|
|
5965
|
+
areRelationsValid?: boolean;
|
|
5966
|
+
/**
|
|
5967
|
+
* Indicator whether the filter view should by applied by default.
|
|
5968
|
+
*/
|
|
5969
|
+
isDefault?: boolean;
|
|
5970
|
+
/**
|
|
5971
|
+
* The respective filter context.
|
|
5972
|
+
*/
|
|
5973
|
+
content: object;
|
|
5974
|
+
}
|
|
5940
5975
|
export interface JsonApiFilterViewOutDocument {
|
|
5941
5976
|
data: JsonApiFilterViewOut;
|
|
5942
5977
|
links?: ObjectLinks;
|
|
@@ -5955,12 +5990,19 @@ export type JsonApiFilterViewOutIncludes = JsonApiAnalyticalDashboardOutWithLink
|
|
|
5955
5990
|
export interface JsonApiFilterViewOutList {
|
|
5956
5991
|
data: Array<JsonApiFilterViewOutWithLinks>;
|
|
5957
5992
|
links?: ListLinks;
|
|
5958
|
-
meta?:
|
|
5993
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
5959
5994
|
/**
|
|
5960
5995
|
* Included resources
|
|
5961
5996
|
*/
|
|
5962
5997
|
included?: Array<JsonApiFilterViewOutIncludes>;
|
|
5963
5998
|
}
|
|
5999
|
+
export interface JsonApiFilterViewOutRelationships {
|
|
6000
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
6001
|
+
user?: JsonApiFilterViewOutRelationshipsUser;
|
|
6002
|
+
}
|
|
6003
|
+
export interface JsonApiFilterViewOutRelationshipsUser {
|
|
6004
|
+
data: JsonApiUserLinkage | null;
|
|
6005
|
+
}
|
|
5964
6006
|
export interface JsonApiFilterViewOutWithLinks {
|
|
5965
6007
|
/**
|
|
5966
6008
|
* Object type
|
|
@@ -5970,8 +6012,8 @@ export interface JsonApiFilterViewOutWithLinks {
|
|
|
5970
6012
|
* API identifier of an object
|
|
5971
6013
|
*/
|
|
5972
6014
|
id: string;
|
|
5973
|
-
attributes:
|
|
5974
|
-
relationships?:
|
|
6015
|
+
attributes: JsonApiFilterViewOutAttributes;
|
|
6016
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
5975
6017
|
links?: ObjectLinks;
|
|
5976
6018
|
}
|
|
5977
6019
|
export declare const JsonApiFilterViewOutWithLinksTypeEnum: {
|
|
@@ -5991,7 +6033,7 @@ export interface JsonApiFilterViewPatch {
|
|
|
5991
6033
|
*/
|
|
5992
6034
|
id: string;
|
|
5993
6035
|
attributes: JsonApiFilterViewPatchAttributes;
|
|
5994
|
-
relationships?:
|
|
6036
|
+
relationships?: JsonApiFilterViewOutRelationships;
|
|
5995
6037
|
}
|
|
5996
6038
|
export declare const JsonApiFilterViewPatchTypeEnum: {
|
|
5997
6039
|
readonly FILTER_VIEW: "filterView";
|
|
@@ -6026,12 +6068,69 @@ export interface JsonApiIdentityProviderIn {
|
|
|
6026
6068
|
* API identifier of an object
|
|
6027
6069
|
*/
|
|
6028
6070
|
id: string;
|
|
6029
|
-
attributes?:
|
|
6071
|
+
attributes?: JsonApiIdentityProviderInAttributes;
|
|
6030
6072
|
}
|
|
6031
6073
|
export declare const JsonApiIdentityProviderInTypeEnum: {
|
|
6032
6074
|
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
6033
6075
|
};
|
|
6034
6076
|
export type JsonApiIdentityProviderInTypeEnum = (typeof JsonApiIdentityProviderInTypeEnum)[keyof typeof JsonApiIdentityProviderInTypeEnum];
|
|
6077
|
+
export interface JsonApiIdentityProviderInAttributes {
|
|
6078
|
+
/**
|
|
6079
|
+
* 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.
|
|
6080
|
+
*/
|
|
6081
|
+
identifiers?: Array<string>;
|
|
6082
|
+
/**
|
|
6083
|
+
* 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.
|
|
6084
|
+
*/
|
|
6085
|
+
customClaimMapping?: {
|
|
6086
|
+
[key: string]: string;
|
|
6087
|
+
};
|
|
6088
|
+
/**
|
|
6089
|
+
* 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.
|
|
6090
|
+
*/
|
|
6091
|
+
samlMetadata?: string;
|
|
6092
|
+
/**
|
|
6093
|
+
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
6094
|
+
*/
|
|
6095
|
+
oauthClientId?: string;
|
|
6096
|
+
/**
|
|
6097
|
+
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
6098
|
+
*/
|
|
6099
|
+
oauthClientSecret?: string;
|
|
6100
|
+
/**
|
|
6101
|
+
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
6102
|
+
*/
|
|
6103
|
+
oauthIssuerLocation?: string;
|
|
6104
|
+
/**
|
|
6105
|
+
* 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.
|
|
6106
|
+
*/
|
|
6107
|
+
oauthIssuerId?: string;
|
|
6108
|
+
/**
|
|
6109
|
+
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
6110
|
+
*/
|
|
6111
|
+
oauthSubjectIdClaim?: string;
|
|
6112
|
+
/**
|
|
6113
|
+
* 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.
|
|
6114
|
+
*/
|
|
6115
|
+
oauthCustomAuthAttributes?: {
|
|
6116
|
+
[key: string]: string;
|
|
6117
|
+
};
|
|
6118
|
+
/**
|
|
6119
|
+
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
6120
|
+
*/
|
|
6121
|
+
oauthCustomScopes?: Array<string> | null;
|
|
6122
|
+
/**
|
|
6123
|
+
* 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.
|
|
6124
|
+
*/
|
|
6125
|
+
idpType?: JsonApiIdentityProviderInAttributesIdpTypeEnum;
|
|
6126
|
+
}
|
|
6127
|
+
export declare const JsonApiIdentityProviderInAttributesIdpTypeEnum: {
|
|
6128
|
+
readonly MANAGED_IDP: "MANAGED_IDP";
|
|
6129
|
+
readonly FIM_IDP: "FIM_IDP";
|
|
6130
|
+
readonly DEX_IDP: "DEX_IDP";
|
|
6131
|
+
readonly CUSTOM_IDP: "CUSTOM_IDP";
|
|
6132
|
+
};
|
|
6133
|
+
export type JsonApiIdentityProviderInAttributesIdpTypeEnum = (typeof JsonApiIdentityProviderInAttributesIdpTypeEnum)[keyof typeof JsonApiIdentityProviderInAttributesIdpTypeEnum];
|
|
6035
6134
|
export interface JsonApiIdentityProviderInDocument {
|
|
6036
6135
|
data: JsonApiIdentityProviderIn;
|
|
6037
6136
|
}
|
|
@@ -6123,7 +6222,7 @@ export interface JsonApiIdentityProviderOutDocument {
|
|
|
6123
6222
|
export interface JsonApiIdentityProviderOutList {
|
|
6124
6223
|
data: Array<JsonApiIdentityProviderOutWithLinks>;
|
|
6125
6224
|
links?: ListLinks;
|
|
6126
|
-
meta?:
|
|
6225
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
6127
6226
|
}
|
|
6128
6227
|
export interface JsonApiIdentityProviderOutWithLinks {
|
|
6129
6228
|
/**
|
|
@@ -6153,69 +6252,12 @@ export interface JsonApiIdentityProviderPatch {
|
|
|
6153
6252
|
* API identifier of an object
|
|
6154
6253
|
*/
|
|
6155
6254
|
id: string;
|
|
6156
|
-
attributes?:
|
|
6255
|
+
attributes?: JsonApiIdentityProviderInAttributes;
|
|
6157
6256
|
}
|
|
6158
6257
|
export declare const JsonApiIdentityProviderPatchTypeEnum: {
|
|
6159
6258
|
readonly IDENTITY_PROVIDER: "identityProvider";
|
|
6160
6259
|
};
|
|
6161
6260
|
export type JsonApiIdentityProviderPatchTypeEnum = (typeof JsonApiIdentityProviderPatchTypeEnum)[keyof typeof JsonApiIdentityProviderPatchTypeEnum];
|
|
6162
|
-
export interface JsonApiIdentityProviderPatchAttributes {
|
|
6163
|
-
/**
|
|
6164
|
-
* 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.
|
|
6165
|
-
*/
|
|
6166
|
-
identifiers?: Array<string>;
|
|
6167
|
-
/**
|
|
6168
|
-
* 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.
|
|
6169
|
-
*/
|
|
6170
|
-
customClaimMapping?: {
|
|
6171
|
-
[key: string]: string;
|
|
6172
|
-
};
|
|
6173
|
-
/**
|
|
6174
|
-
* 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.
|
|
6175
|
-
*/
|
|
6176
|
-
samlMetadata?: string;
|
|
6177
|
-
/**
|
|
6178
|
-
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
6179
|
-
*/
|
|
6180
|
-
oauthClientId?: string;
|
|
6181
|
-
/**
|
|
6182
|
-
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
6183
|
-
*/
|
|
6184
|
-
oauthClientSecret?: string;
|
|
6185
|
-
/**
|
|
6186
|
-
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
6187
|
-
*/
|
|
6188
|
-
oauthIssuerLocation?: string;
|
|
6189
|
-
/**
|
|
6190
|
-
* 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.
|
|
6191
|
-
*/
|
|
6192
|
-
oauthIssuerId?: string;
|
|
6193
|
-
/**
|
|
6194
|
-
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
6195
|
-
*/
|
|
6196
|
-
oauthSubjectIdClaim?: string;
|
|
6197
|
-
/**
|
|
6198
|
-
* 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.
|
|
6199
|
-
*/
|
|
6200
|
-
oauthCustomAuthAttributes?: {
|
|
6201
|
-
[key: string]: string;
|
|
6202
|
-
};
|
|
6203
|
-
/**
|
|
6204
|
-
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
6205
|
-
*/
|
|
6206
|
-
oauthCustomScopes?: Array<string> | null;
|
|
6207
|
-
/**
|
|
6208
|
-
* 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.
|
|
6209
|
-
*/
|
|
6210
|
-
idpType?: JsonApiIdentityProviderPatchAttributesIdpTypeEnum;
|
|
6211
|
-
}
|
|
6212
|
-
export declare const JsonApiIdentityProviderPatchAttributesIdpTypeEnum: {
|
|
6213
|
-
readonly MANAGED_IDP: "MANAGED_IDP";
|
|
6214
|
-
readonly FIM_IDP: "FIM_IDP";
|
|
6215
|
-
readonly DEX_IDP: "DEX_IDP";
|
|
6216
|
-
readonly CUSTOM_IDP: "CUSTOM_IDP";
|
|
6217
|
-
};
|
|
6218
|
-
export type JsonApiIdentityProviderPatchAttributesIdpTypeEnum = (typeof JsonApiIdentityProviderPatchAttributesIdpTypeEnum)[keyof typeof JsonApiIdentityProviderPatchAttributesIdpTypeEnum];
|
|
6219
6261
|
export interface JsonApiIdentityProviderPatchDocument {
|
|
6220
6262
|
data: JsonApiIdentityProviderPatch;
|
|
6221
6263
|
}
|
|
@@ -6231,7 +6273,7 @@ export interface JsonApiJwkIn {
|
|
|
6231
6273
|
* API identifier of an object
|
|
6232
6274
|
*/
|
|
6233
6275
|
id: string;
|
|
6234
|
-
attributes?:
|
|
6276
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
6235
6277
|
}
|
|
6236
6278
|
export declare const JsonApiJwkInTypeEnum: {
|
|
6237
6279
|
readonly JWK: "jwk";
|
|
@@ -6252,12 +6294,15 @@ export interface JsonApiJwkOut {
|
|
|
6252
6294
|
* API identifier of an object
|
|
6253
6295
|
*/
|
|
6254
6296
|
id: string;
|
|
6255
|
-
attributes?:
|
|
6297
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
6256
6298
|
}
|
|
6257
6299
|
export declare const JsonApiJwkOutTypeEnum: {
|
|
6258
6300
|
readonly JWK: "jwk";
|
|
6259
6301
|
};
|
|
6260
6302
|
export type JsonApiJwkOutTypeEnum = (typeof JsonApiJwkOutTypeEnum)[keyof typeof JsonApiJwkOutTypeEnum];
|
|
6303
|
+
export interface JsonApiJwkOutAttributes {
|
|
6304
|
+
content?: RsaSpecification;
|
|
6305
|
+
}
|
|
6261
6306
|
export interface JsonApiJwkOutDocument {
|
|
6262
6307
|
data: JsonApiJwkOut;
|
|
6263
6308
|
links?: ObjectLinks;
|
|
@@ -6268,7 +6313,7 @@ export interface JsonApiJwkOutDocument {
|
|
|
6268
6313
|
export interface JsonApiJwkOutList {
|
|
6269
6314
|
data: Array<JsonApiJwkOutWithLinks>;
|
|
6270
6315
|
links?: ListLinks;
|
|
6271
|
-
meta?:
|
|
6316
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
6272
6317
|
}
|
|
6273
6318
|
export interface JsonApiJwkOutWithLinks {
|
|
6274
6319
|
/**
|
|
@@ -6279,7 +6324,7 @@ export interface JsonApiJwkOutWithLinks {
|
|
|
6279
6324
|
* API identifier of an object
|
|
6280
6325
|
*/
|
|
6281
6326
|
id: string;
|
|
6282
|
-
attributes?:
|
|
6327
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
6283
6328
|
links?: ObjectLinks;
|
|
6284
6329
|
}
|
|
6285
6330
|
export declare const JsonApiJwkOutWithLinksTypeEnum: {
|
|
@@ -6298,15 +6343,12 @@ export interface JsonApiJwkPatch {
|
|
|
6298
6343
|
* API identifier of an object
|
|
6299
6344
|
*/
|
|
6300
6345
|
id: string;
|
|
6301
|
-
attributes?:
|
|
6346
|
+
attributes?: JsonApiJwkOutAttributes;
|
|
6302
6347
|
}
|
|
6303
6348
|
export declare const JsonApiJwkPatchTypeEnum: {
|
|
6304
6349
|
readonly JWK: "jwk";
|
|
6305
6350
|
};
|
|
6306
6351
|
export type JsonApiJwkPatchTypeEnum = (typeof JsonApiJwkPatchTypeEnum)[keyof typeof JsonApiJwkPatchTypeEnum];
|
|
6307
|
-
export interface JsonApiJwkPatchAttributes {
|
|
6308
|
-
content?: RsaSpecification;
|
|
6309
|
-
}
|
|
6310
6352
|
export interface JsonApiJwkPatchDocument {
|
|
6311
6353
|
data: JsonApiJwkPatch;
|
|
6312
6354
|
}
|
|
@@ -6333,7 +6375,7 @@ export interface JsonApiLabelOut {
|
|
|
6333
6375
|
* API identifier of an object
|
|
6334
6376
|
*/
|
|
6335
6377
|
id: string;
|
|
6336
|
-
meta?:
|
|
6378
|
+
meta?: JsonApiDatasetOutMeta;
|
|
6337
6379
|
attributes?: JsonApiLabelOutAttributes;
|
|
6338
6380
|
relationships?: JsonApiLabelOutRelationships;
|
|
6339
6381
|
}
|
|
@@ -6384,7 +6426,7 @@ export interface JsonApiLabelOutDocument {
|
|
|
6384
6426
|
export interface JsonApiLabelOutList {
|
|
6385
6427
|
data: Array<JsonApiLabelOutWithLinks>;
|
|
6386
6428
|
links?: ListLinks;
|
|
6387
|
-
meta?:
|
|
6429
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
6388
6430
|
/**
|
|
6389
6431
|
* Included resources
|
|
6390
6432
|
*/
|
|
@@ -6405,7 +6447,7 @@ export interface JsonApiLabelOutWithLinks {
|
|
|
6405
6447
|
* API identifier of an object
|
|
6406
6448
|
*/
|
|
6407
6449
|
id: string;
|
|
6408
|
-
meta?:
|
|
6450
|
+
meta?: JsonApiDatasetOutMeta;
|
|
6409
6451
|
attributes?: JsonApiLabelOutAttributes;
|
|
6410
6452
|
relationships?: JsonApiLabelOutRelationships;
|
|
6411
6453
|
links?: ObjectLinks;
|
|
@@ -6521,7 +6563,7 @@ export interface JsonApiLlmEndpointOutDocument {
|
|
|
6521
6563
|
export interface JsonApiLlmEndpointOutList {
|
|
6522
6564
|
data: Array<JsonApiLlmEndpointOutWithLinks>;
|
|
6523
6565
|
links?: ListLinks;
|
|
6524
|
-
meta?:
|
|
6566
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
6525
6567
|
}
|
|
6526
6568
|
export interface JsonApiLlmEndpointOutWithLinks {
|
|
6527
6569
|
/**
|
|
@@ -6642,7 +6684,7 @@ export interface JsonApiMetricOut {
|
|
|
6642
6684
|
* API identifier of an object
|
|
6643
6685
|
*/
|
|
6644
6686
|
id: string;
|
|
6645
|
-
meta?:
|
|
6687
|
+
meta?: JsonApiDatasetOutMeta;
|
|
6646
6688
|
attributes: JsonApiMetricOutAttributes;
|
|
6647
6689
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
6648
6690
|
}
|
|
@@ -6681,7 +6723,7 @@ export type JsonApiMetricOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDat
|
|
|
6681
6723
|
export interface JsonApiMetricOutList {
|
|
6682
6724
|
data: Array<JsonApiMetricOutWithLinks>;
|
|
6683
6725
|
links?: ListLinks;
|
|
6684
|
-
meta?:
|
|
6726
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
6685
6727
|
/**
|
|
6686
6728
|
* Included resources
|
|
6687
6729
|
*/
|
|
@@ -6696,7 +6738,7 @@ export interface JsonApiMetricOutWithLinks {
|
|
|
6696
6738
|
* API identifier of an object
|
|
6697
6739
|
*/
|
|
6698
6740
|
id: string;
|
|
6699
|
-
meta?:
|
|
6741
|
+
meta?: JsonApiDatasetOutMeta;
|
|
6700
6742
|
attributes: JsonApiMetricOutAttributes;
|
|
6701
6743
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
6702
6744
|
links?: ObjectLinks;
|
|
@@ -6804,7 +6846,7 @@ export interface JsonApiNotificationChannelIdentifierOutDocument {
|
|
|
6804
6846
|
export interface JsonApiNotificationChannelIdentifierOutList {
|
|
6805
6847
|
data: Array<JsonApiNotificationChannelIdentifierOutWithLinks>;
|
|
6806
6848
|
links?: ListLinks;
|
|
6807
|
-
meta?:
|
|
6849
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
6808
6850
|
}
|
|
6809
6851
|
export interface JsonApiNotificationChannelIdentifierOutWithLinks {
|
|
6810
6852
|
/**
|
|
@@ -6834,7 +6876,7 @@ export interface JsonApiNotificationChannelIn {
|
|
|
6834
6876
|
* API identifier of an object
|
|
6835
6877
|
*/
|
|
6836
6878
|
id: string;
|
|
6837
|
-
attributes?:
|
|
6879
|
+
attributes?: JsonApiNotificationChannelPostOptionalIdAttributes;
|
|
6838
6880
|
}
|
|
6839
6881
|
export declare const JsonApiNotificationChannelInTypeEnum: {
|
|
6840
6882
|
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
@@ -6937,7 +6979,7 @@ export interface JsonApiNotificationChannelOutDocument {
|
|
|
6937
6979
|
export interface JsonApiNotificationChannelOutList {
|
|
6938
6980
|
data: Array<JsonApiNotificationChannelOutWithLinks>;
|
|
6939
6981
|
links?: ListLinks;
|
|
6940
|
-
meta?:
|
|
6982
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
6941
6983
|
}
|
|
6942
6984
|
export interface JsonApiNotificationChannelOutWithLinks {
|
|
6943
6985
|
/**
|
|
@@ -6967,13 +7009,34 @@ export interface JsonApiNotificationChannelPatch {
|
|
|
6967
7009
|
* API identifier of an object
|
|
6968
7010
|
*/
|
|
6969
7011
|
id: string;
|
|
6970
|
-
attributes?:
|
|
7012
|
+
attributes?: JsonApiNotificationChannelPostOptionalIdAttributes;
|
|
6971
7013
|
}
|
|
6972
7014
|
export declare const JsonApiNotificationChannelPatchTypeEnum: {
|
|
6973
7015
|
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
6974
7016
|
};
|
|
6975
7017
|
export type JsonApiNotificationChannelPatchTypeEnum = (typeof JsonApiNotificationChannelPatchTypeEnum)[keyof typeof JsonApiNotificationChannelPatchTypeEnum];
|
|
6976
|
-
export interface
|
|
7018
|
+
export interface JsonApiNotificationChannelPatchDocument {
|
|
7019
|
+
data: JsonApiNotificationChannelPatch;
|
|
7020
|
+
}
|
|
7021
|
+
/**
|
|
7022
|
+
* JSON:API representation of notificationChannel entity.
|
|
7023
|
+
*/
|
|
7024
|
+
export interface JsonApiNotificationChannelPostOptionalId {
|
|
7025
|
+
/**
|
|
7026
|
+
* Object type
|
|
7027
|
+
*/
|
|
7028
|
+
type: JsonApiNotificationChannelPostOptionalIdTypeEnum;
|
|
7029
|
+
/**
|
|
7030
|
+
* API identifier of an object
|
|
7031
|
+
*/
|
|
7032
|
+
id?: string;
|
|
7033
|
+
attributes?: JsonApiNotificationChannelPostOptionalIdAttributes;
|
|
7034
|
+
}
|
|
7035
|
+
export declare const JsonApiNotificationChannelPostOptionalIdTypeEnum: {
|
|
7036
|
+
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
7037
|
+
};
|
|
7038
|
+
export type JsonApiNotificationChannelPostOptionalIdTypeEnum = (typeof JsonApiNotificationChannelPostOptionalIdTypeEnum)[keyof typeof JsonApiNotificationChannelPostOptionalIdTypeEnum];
|
|
7039
|
+
export interface JsonApiNotificationChannelPostOptionalIdAttributes {
|
|
6977
7040
|
name?: string | null;
|
|
6978
7041
|
description?: string | null;
|
|
6979
7042
|
destination?: JsonApiNotificationChannelOutAttributesDestination;
|
|
@@ -6984,7 +7047,7 @@ export interface JsonApiNotificationChannelPatchAttributes {
|
|
|
6984
7047
|
/**
|
|
6985
7048
|
* 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
|
|
6986
7049
|
*/
|
|
6987
|
-
dashboardLinkVisibility?:
|
|
7050
|
+
dashboardLinkVisibility?: JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum;
|
|
6988
7051
|
/**
|
|
6989
7052
|
* 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}}
|
|
6990
7053
|
*/
|
|
@@ -6992,50 +7055,29 @@ export interface JsonApiNotificationChannelPatchAttributes {
|
|
|
6992
7055
|
/**
|
|
6993
7056
|
* 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
|
|
6994
7057
|
*/
|
|
6995
|
-
allowedRecipients?:
|
|
7058
|
+
allowedRecipients?: JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum;
|
|
6996
7059
|
/**
|
|
6997
7060
|
* 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
|
|
6998
7061
|
*/
|
|
6999
|
-
inPlatformNotification?:
|
|
7062
|
+
inPlatformNotification?: JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum;
|
|
7000
7063
|
}
|
|
7001
|
-
export declare const
|
|
7064
|
+
export declare const JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum: {
|
|
7002
7065
|
readonly HIDDEN: "HIDDEN";
|
|
7003
7066
|
readonly INTERNAL_ONLY: "INTERNAL_ONLY";
|
|
7004
7067
|
readonly ALL: "ALL";
|
|
7005
7068
|
};
|
|
7006
|
-
export type
|
|
7007
|
-
export declare const
|
|
7069
|
+
export type JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum = (typeof JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum)[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum];
|
|
7070
|
+
export declare const JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum: {
|
|
7008
7071
|
readonly CREATOR: "CREATOR";
|
|
7009
7072
|
readonly INTERNAL: "INTERNAL";
|
|
7010
7073
|
readonly EXTERNAL: "EXTERNAL";
|
|
7011
7074
|
};
|
|
7012
|
-
export type
|
|
7013
|
-
export declare const
|
|
7075
|
+
export type JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum = (typeof JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum)[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesAllowedRecipientsEnum];
|
|
7076
|
+
export declare const JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum: {
|
|
7014
7077
|
readonly DISABLED: "DISABLED";
|
|
7015
7078
|
readonly ENABLED: "ENABLED";
|
|
7016
7079
|
};
|
|
7017
|
-
export type
|
|
7018
|
-
export interface JsonApiNotificationChannelPatchDocument {
|
|
7019
|
-
data: JsonApiNotificationChannelPatch;
|
|
7020
|
-
}
|
|
7021
|
-
/**
|
|
7022
|
-
* JSON:API representation of notificationChannel entity.
|
|
7023
|
-
*/
|
|
7024
|
-
export interface JsonApiNotificationChannelPostOptionalId {
|
|
7025
|
-
/**
|
|
7026
|
-
* Object type
|
|
7027
|
-
*/
|
|
7028
|
-
type: JsonApiNotificationChannelPostOptionalIdTypeEnum;
|
|
7029
|
-
/**
|
|
7030
|
-
* API identifier of an object
|
|
7031
|
-
*/
|
|
7032
|
-
id?: string;
|
|
7033
|
-
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
7034
|
-
}
|
|
7035
|
-
export declare const JsonApiNotificationChannelPostOptionalIdTypeEnum: {
|
|
7036
|
-
readonly NOTIFICATION_CHANNEL: "notificationChannel";
|
|
7037
|
-
};
|
|
7038
|
-
export type JsonApiNotificationChannelPostOptionalIdTypeEnum = (typeof JsonApiNotificationChannelPostOptionalIdTypeEnum)[keyof typeof JsonApiNotificationChannelPostOptionalIdTypeEnum];
|
|
7080
|
+
export type JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum = (typeof JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum)[keyof typeof JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum];
|
|
7039
7081
|
export interface JsonApiNotificationChannelPostOptionalIdDocument {
|
|
7040
7082
|
data: JsonApiNotificationChannelPostOptionalId;
|
|
7041
7083
|
}
|
|
@@ -7051,16 +7093,57 @@ export interface JsonApiOrganizationIn {
|
|
|
7051
7093
|
* API identifier of an object
|
|
7052
7094
|
*/
|
|
7053
7095
|
id: string;
|
|
7054
|
-
attributes?:
|
|
7055
|
-
relationships?:
|
|
7096
|
+
attributes?: JsonApiOrganizationInAttributes;
|
|
7097
|
+
relationships?: JsonApiOrganizationInRelationships;
|
|
7056
7098
|
}
|
|
7057
7099
|
export declare const JsonApiOrganizationInTypeEnum: {
|
|
7058
7100
|
readonly ORGANIZATION: "organization";
|
|
7059
7101
|
};
|
|
7060
7102
|
export type JsonApiOrganizationInTypeEnum = (typeof JsonApiOrganizationInTypeEnum)[keyof typeof JsonApiOrganizationInTypeEnum];
|
|
7103
|
+
export interface JsonApiOrganizationInAttributes {
|
|
7104
|
+
name?: string | null;
|
|
7105
|
+
hostname?: string;
|
|
7106
|
+
allowedOrigins?: Array<string>;
|
|
7107
|
+
oauthIssuerLocation?: string;
|
|
7108
|
+
oauthClientId?: string;
|
|
7109
|
+
oauthClientSecret?: string;
|
|
7110
|
+
/**
|
|
7111
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
7112
|
+
* @deprecated
|
|
7113
|
+
*/
|
|
7114
|
+
earlyAccess?: string | null;
|
|
7115
|
+
/**
|
|
7116
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
7117
|
+
*/
|
|
7118
|
+
earlyAccessValues?: Array<string> | null;
|
|
7119
|
+
/**
|
|
7120
|
+
* 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.
|
|
7121
|
+
*/
|
|
7122
|
+
oauthIssuerId?: string;
|
|
7123
|
+
/**
|
|
7124
|
+
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
7125
|
+
*/
|
|
7126
|
+
oauthSubjectIdClaim?: string;
|
|
7127
|
+
/**
|
|
7128
|
+
* 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.
|
|
7129
|
+
*/
|
|
7130
|
+
oauthCustomAuthAttributes?: {
|
|
7131
|
+
[key: string]: string;
|
|
7132
|
+
};
|
|
7133
|
+
/**
|
|
7134
|
+
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
7135
|
+
*/
|
|
7136
|
+
oauthCustomScopes?: Array<string> | null;
|
|
7137
|
+
}
|
|
7061
7138
|
export interface JsonApiOrganizationInDocument {
|
|
7062
7139
|
data: JsonApiOrganizationIn;
|
|
7063
7140
|
}
|
|
7141
|
+
export interface JsonApiOrganizationInRelationships {
|
|
7142
|
+
identityProvider?: JsonApiOrganizationInRelationshipsIdentityProvider;
|
|
7143
|
+
}
|
|
7144
|
+
export interface JsonApiOrganizationInRelationshipsIdentityProvider {
|
|
7145
|
+
data: JsonApiIdentityProviderLinkage | null;
|
|
7146
|
+
}
|
|
7064
7147
|
/**
|
|
7065
7148
|
* JSON:API representation of organization entity.
|
|
7066
7149
|
*/
|
|
@@ -7149,18 +7232,9 @@ export declare const JsonApiOrganizationOutMetaPermissionsEnum: {
|
|
|
7149
7232
|
};
|
|
7150
7233
|
export type JsonApiOrganizationOutMetaPermissionsEnum = (typeof JsonApiOrganizationOutMetaPermissionsEnum)[keyof typeof JsonApiOrganizationOutMetaPermissionsEnum];
|
|
7151
7234
|
export interface JsonApiOrganizationOutRelationships {
|
|
7152
|
-
bootstrapUser?:
|
|
7153
|
-
bootstrapUserGroup?:
|
|
7154
|
-
identityProvider?:
|
|
7155
|
-
}
|
|
7156
|
-
export interface JsonApiOrganizationOutRelationshipsBootstrapUser {
|
|
7157
|
-
data: JsonApiUserLinkage | null;
|
|
7158
|
-
}
|
|
7159
|
-
export interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup {
|
|
7160
|
-
data: JsonApiUserGroupLinkage | null;
|
|
7161
|
-
}
|
|
7162
|
-
export interface JsonApiOrganizationOutRelationshipsIdentityProvider {
|
|
7163
|
-
data: JsonApiIdentityProviderLinkage | null;
|
|
7235
|
+
bootstrapUser?: JsonApiFilterViewOutRelationshipsUser;
|
|
7236
|
+
bootstrapUserGroup?: JsonApiUserDataFilterOutRelationshipsUserGroup;
|
|
7237
|
+
identityProvider?: JsonApiOrganizationInRelationshipsIdentityProvider;
|
|
7164
7238
|
}
|
|
7165
7239
|
/**
|
|
7166
7240
|
* JSON:API representation of patching organization entity.
|
|
@@ -7174,54 +7248,16 @@ export interface JsonApiOrganizationPatch {
|
|
|
7174
7248
|
* API identifier of an object
|
|
7175
7249
|
*/
|
|
7176
7250
|
id: string;
|
|
7177
|
-
attributes?:
|
|
7178
|
-
relationships?:
|
|
7251
|
+
attributes?: JsonApiOrganizationInAttributes;
|
|
7252
|
+
relationships?: JsonApiOrganizationInRelationships;
|
|
7179
7253
|
}
|
|
7180
7254
|
export declare const JsonApiOrganizationPatchTypeEnum: {
|
|
7181
7255
|
readonly ORGANIZATION: "organization";
|
|
7182
7256
|
};
|
|
7183
7257
|
export type JsonApiOrganizationPatchTypeEnum = (typeof JsonApiOrganizationPatchTypeEnum)[keyof typeof JsonApiOrganizationPatchTypeEnum];
|
|
7184
|
-
export interface JsonApiOrganizationPatchAttributes {
|
|
7185
|
-
name?: string | null;
|
|
7186
|
-
hostname?: string;
|
|
7187
|
-
allowedOrigins?: Array<string>;
|
|
7188
|
-
oauthIssuerLocation?: string;
|
|
7189
|
-
oauthClientId?: string;
|
|
7190
|
-
oauthClientSecret?: 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
|
-
/**
|
|
7201
|
-
* 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.
|
|
7202
|
-
*/
|
|
7203
|
-
oauthIssuerId?: string;
|
|
7204
|
-
/**
|
|
7205
|
-
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
7206
|
-
*/
|
|
7207
|
-
oauthSubjectIdClaim?: string;
|
|
7208
|
-
/**
|
|
7209
|
-
* 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.
|
|
7210
|
-
*/
|
|
7211
|
-
oauthCustomAuthAttributes?: {
|
|
7212
|
-
[key: string]: string;
|
|
7213
|
-
};
|
|
7214
|
-
/**
|
|
7215
|
-
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
7216
|
-
*/
|
|
7217
|
-
oauthCustomScopes?: Array<string> | null;
|
|
7218
|
-
}
|
|
7219
7258
|
export interface JsonApiOrganizationPatchDocument {
|
|
7220
7259
|
data: JsonApiOrganizationPatch;
|
|
7221
7260
|
}
|
|
7222
|
-
export interface JsonApiOrganizationPatchRelationships {
|
|
7223
|
-
identityProvider?: JsonApiOrganizationOutRelationshipsIdentityProvider;
|
|
7224
|
-
}
|
|
7225
7261
|
/**
|
|
7226
7262
|
* JSON:API representation of organizationSetting entity.
|
|
7227
7263
|
*/
|
|
@@ -7234,7 +7270,7 @@ export interface JsonApiOrganizationSettingIn {
|
|
|
7234
7270
|
* API identifier of an object
|
|
7235
7271
|
*/
|
|
7236
7272
|
id: string;
|
|
7237
|
-
attributes?:
|
|
7273
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7238
7274
|
}
|
|
7239
7275
|
export declare const JsonApiOrganizationSettingInTypeEnum: {
|
|
7240
7276
|
readonly ORGANIZATION_SETTING: "organizationSetting";
|
|
@@ -7255,7 +7291,7 @@ export interface JsonApiOrganizationSettingOut {
|
|
|
7255
7291
|
* API identifier of an object
|
|
7256
7292
|
*/
|
|
7257
7293
|
id: string;
|
|
7258
|
-
attributes?:
|
|
7294
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7259
7295
|
}
|
|
7260
7296
|
export declare const JsonApiOrganizationSettingOutTypeEnum: {
|
|
7261
7297
|
readonly ORGANIZATION_SETTING: "organizationSetting";
|
|
@@ -7271,7 +7307,7 @@ export interface JsonApiOrganizationSettingOutDocument {
|
|
|
7271
7307
|
export interface JsonApiOrganizationSettingOutList {
|
|
7272
7308
|
data: Array<JsonApiOrganizationSettingOutWithLinks>;
|
|
7273
7309
|
links?: ListLinks;
|
|
7274
|
-
meta?:
|
|
7310
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
7275
7311
|
}
|
|
7276
7312
|
export interface JsonApiOrganizationSettingOutWithLinks {
|
|
7277
7313
|
/**
|
|
@@ -7282,7 +7318,7 @@ export interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
7282
7318
|
* API identifier of an object
|
|
7283
7319
|
*/
|
|
7284
7320
|
id: string;
|
|
7285
|
-
attributes?:
|
|
7321
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7286
7322
|
links?: ObjectLinks;
|
|
7287
7323
|
}
|
|
7288
7324
|
export declare const JsonApiOrganizationSettingOutWithLinksTypeEnum: {
|
|
@@ -7301,7 +7337,7 @@ export interface JsonApiOrganizationSettingPatch {
|
|
|
7301
7337
|
* API identifier of an object
|
|
7302
7338
|
*/
|
|
7303
7339
|
id: string;
|
|
7304
|
-
attributes?:
|
|
7340
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7305
7341
|
}
|
|
7306
7342
|
export declare const JsonApiOrganizationSettingPatchTypeEnum: {
|
|
7307
7343
|
readonly ORGANIZATION_SETTING: "organizationSetting";
|
|
@@ -7359,7 +7395,7 @@ export interface JsonApiThemeOutDocument {
|
|
|
7359
7395
|
export interface JsonApiThemeOutList {
|
|
7360
7396
|
data: Array<JsonApiThemeOutWithLinks>;
|
|
7361
7397
|
links?: ListLinks;
|
|
7362
|
-
meta?:
|
|
7398
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
7363
7399
|
}
|
|
7364
7400
|
export interface JsonApiThemeOutWithLinks {
|
|
7365
7401
|
/**
|
|
@@ -7410,26 +7446,19 @@ export interface JsonApiUserDataFilterIn {
|
|
|
7410
7446
|
* API identifier of an object
|
|
7411
7447
|
*/
|
|
7412
7448
|
id: string;
|
|
7413
|
-
attributes:
|
|
7449
|
+
attributes: JsonApiUserDataFilterOutAttributes;
|
|
7414
7450
|
relationships?: JsonApiUserDataFilterInRelationships;
|
|
7415
7451
|
}
|
|
7416
7452
|
export declare const JsonApiUserDataFilterInTypeEnum: {
|
|
7417
7453
|
readonly USER_DATA_FILTER: "userDataFilter";
|
|
7418
7454
|
};
|
|
7419
7455
|
export type JsonApiUserDataFilterInTypeEnum = (typeof JsonApiUserDataFilterInTypeEnum)[keyof typeof JsonApiUserDataFilterInTypeEnum];
|
|
7420
|
-
export interface JsonApiUserDataFilterInAttributes {
|
|
7421
|
-
title?: string;
|
|
7422
|
-
description?: string;
|
|
7423
|
-
tags?: Array<string>;
|
|
7424
|
-
areRelationsValid?: boolean;
|
|
7425
|
-
maql: string;
|
|
7426
|
-
}
|
|
7427
7456
|
export interface JsonApiUserDataFilterInDocument {
|
|
7428
7457
|
data: JsonApiUserDataFilterIn;
|
|
7429
7458
|
}
|
|
7430
7459
|
export interface JsonApiUserDataFilterInRelationships {
|
|
7431
|
-
user?:
|
|
7432
|
-
userGroup?:
|
|
7460
|
+
user?: JsonApiFilterViewOutRelationshipsUser;
|
|
7461
|
+
userGroup?: JsonApiUserDataFilterOutRelationshipsUserGroup;
|
|
7433
7462
|
}
|
|
7434
7463
|
/**
|
|
7435
7464
|
* JSON:API representation of userDataFilter entity.
|
|
@@ -7443,14 +7472,21 @@ export interface JsonApiUserDataFilterOut {
|
|
|
7443
7472
|
* API identifier of an object
|
|
7444
7473
|
*/
|
|
7445
7474
|
id: string;
|
|
7446
|
-
meta?:
|
|
7447
|
-
attributes:
|
|
7475
|
+
meta?: JsonApiDatasetOutMeta;
|
|
7476
|
+
attributes: JsonApiUserDataFilterOutAttributes;
|
|
7448
7477
|
relationships?: JsonApiUserDataFilterOutRelationships;
|
|
7449
7478
|
}
|
|
7450
7479
|
export declare const JsonApiUserDataFilterOutTypeEnum: {
|
|
7451
7480
|
readonly USER_DATA_FILTER: "userDataFilter";
|
|
7452
7481
|
};
|
|
7453
7482
|
export type JsonApiUserDataFilterOutTypeEnum = (typeof JsonApiUserDataFilterOutTypeEnum)[keyof typeof JsonApiUserDataFilterOutTypeEnum];
|
|
7483
|
+
export interface JsonApiUserDataFilterOutAttributes {
|
|
7484
|
+
title?: string;
|
|
7485
|
+
description?: string;
|
|
7486
|
+
tags?: Array<string>;
|
|
7487
|
+
areRelationsValid?: boolean;
|
|
7488
|
+
maql: string;
|
|
7489
|
+
}
|
|
7454
7490
|
export interface JsonApiUserDataFilterOutDocument {
|
|
7455
7491
|
data: JsonApiUserDataFilterOut;
|
|
7456
7492
|
links?: ObjectLinks;
|
|
@@ -7469,20 +7505,23 @@ export type JsonApiUserDataFilterOutIncludes = JsonApiAttributeOutWithLinks | Js
|
|
|
7469
7505
|
export interface JsonApiUserDataFilterOutList {
|
|
7470
7506
|
data: Array<JsonApiUserDataFilterOutWithLinks>;
|
|
7471
7507
|
links?: ListLinks;
|
|
7472
|
-
meta?:
|
|
7508
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
7473
7509
|
/**
|
|
7474
7510
|
* Included resources
|
|
7475
7511
|
*/
|
|
7476
7512
|
included?: Array<JsonApiUserDataFilterOutIncludes>;
|
|
7477
7513
|
}
|
|
7478
7514
|
export interface JsonApiUserDataFilterOutRelationships {
|
|
7479
|
-
user?:
|
|
7480
|
-
userGroup?:
|
|
7481
|
-
facts?:
|
|
7482
|
-
attributes?:
|
|
7515
|
+
user?: JsonApiFilterViewOutRelationshipsUser;
|
|
7516
|
+
userGroup?: JsonApiUserDataFilterOutRelationshipsUserGroup;
|
|
7517
|
+
facts?: JsonApiDatasetOutRelationshipsFacts;
|
|
7518
|
+
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
7483
7519
|
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
7484
7520
|
metrics?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
7485
|
-
datasets?:
|
|
7521
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
7522
|
+
}
|
|
7523
|
+
export interface JsonApiUserDataFilterOutRelationshipsUserGroup {
|
|
7524
|
+
data: JsonApiUserGroupLinkage | null;
|
|
7486
7525
|
}
|
|
7487
7526
|
export interface JsonApiUserDataFilterOutWithLinks {
|
|
7488
7527
|
/**
|
|
@@ -7493,8 +7532,8 @@ export interface JsonApiUserDataFilterOutWithLinks {
|
|
|
7493
7532
|
* API identifier of an object
|
|
7494
7533
|
*/
|
|
7495
7534
|
id: string;
|
|
7496
|
-
meta?:
|
|
7497
|
-
attributes:
|
|
7535
|
+
meta?: JsonApiDatasetOutMeta;
|
|
7536
|
+
attributes: JsonApiUserDataFilterOutAttributes;
|
|
7498
7537
|
relationships?: JsonApiUserDataFilterOutRelationships;
|
|
7499
7538
|
links?: ObjectLinks;
|
|
7500
7539
|
}
|
|
@@ -7543,7 +7582,7 @@ export interface JsonApiUserDataFilterPostOptionalId {
|
|
|
7543
7582
|
* API identifier of an object
|
|
7544
7583
|
*/
|
|
7545
7584
|
id?: string;
|
|
7546
|
-
attributes:
|
|
7585
|
+
attributes: JsonApiUserDataFilterOutAttributes;
|
|
7547
7586
|
relationships?: JsonApiUserDataFilterInRelationships;
|
|
7548
7587
|
}
|
|
7549
7588
|
export declare const JsonApiUserDataFilterPostOptionalIdTypeEnum: {
|
|
@@ -7622,7 +7661,7 @@ export interface JsonApiUserGroupOutDocument {
|
|
|
7622
7661
|
export interface JsonApiUserGroupOutList {
|
|
7623
7662
|
data: Array<JsonApiUserGroupOutWithLinks>;
|
|
7624
7663
|
links?: ListLinks;
|
|
7625
|
-
meta?:
|
|
7664
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
7626
7665
|
/**
|
|
7627
7666
|
* Included resources
|
|
7628
7667
|
*/
|
|
@@ -7714,7 +7753,7 @@ export interface JsonApiUserIdentifierOutDocument {
|
|
|
7714
7753
|
export interface JsonApiUserIdentifierOutList {
|
|
7715
7754
|
data: Array<JsonApiUserIdentifierOutWithLinks>;
|
|
7716
7755
|
links?: ListLinks;
|
|
7717
|
-
meta?:
|
|
7756
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
7718
7757
|
}
|
|
7719
7758
|
export interface JsonApiUserIdentifierOutWithLinks {
|
|
7720
7759
|
/**
|
|
@@ -7804,7 +7843,7 @@ export interface JsonApiUserOutDocument {
|
|
|
7804
7843
|
export interface JsonApiUserOutList {
|
|
7805
7844
|
data: Array<JsonApiUserOutWithLinks>;
|
|
7806
7845
|
links?: ListLinks;
|
|
7807
|
-
meta?:
|
|
7846
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
7808
7847
|
/**
|
|
7809
7848
|
* Included resources
|
|
7810
7849
|
*/
|
|
@@ -7870,7 +7909,7 @@ export interface JsonApiUserSettingIn {
|
|
|
7870
7909
|
* API identifier of an object
|
|
7871
7910
|
*/
|
|
7872
7911
|
id: string;
|
|
7873
|
-
attributes?:
|
|
7912
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7874
7913
|
}
|
|
7875
7914
|
export declare const JsonApiUserSettingInTypeEnum: {
|
|
7876
7915
|
readonly USER_SETTING: "userSetting";
|
|
@@ -7891,7 +7930,7 @@ export interface JsonApiUserSettingOut {
|
|
|
7891
7930
|
* API identifier of an object
|
|
7892
7931
|
*/
|
|
7893
7932
|
id: string;
|
|
7894
|
-
attributes?:
|
|
7933
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7895
7934
|
}
|
|
7896
7935
|
export declare const JsonApiUserSettingOutTypeEnum: {
|
|
7897
7936
|
readonly USER_SETTING: "userSetting";
|
|
@@ -7907,7 +7946,7 @@ export interface JsonApiUserSettingOutDocument {
|
|
|
7907
7946
|
export interface JsonApiUserSettingOutList {
|
|
7908
7947
|
data: Array<JsonApiUserSettingOutWithLinks>;
|
|
7909
7948
|
links?: ListLinks;
|
|
7910
|
-
meta?:
|
|
7949
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
7911
7950
|
}
|
|
7912
7951
|
export interface JsonApiUserSettingOutWithLinks {
|
|
7913
7952
|
/**
|
|
@@ -7918,7 +7957,7 @@ export interface JsonApiUserSettingOutWithLinks {
|
|
|
7918
7957
|
* API identifier of an object
|
|
7919
7958
|
*/
|
|
7920
7959
|
id: string;
|
|
7921
|
-
attributes?:
|
|
7960
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
7922
7961
|
links?: ObjectLinks;
|
|
7923
7962
|
}
|
|
7924
7963
|
export declare const JsonApiUserSettingOutWithLinksTypeEnum: {
|
|
@@ -7937,7 +7976,7 @@ export interface JsonApiVisualizationObjectIn {
|
|
|
7937
7976
|
* API identifier of an object
|
|
7938
7977
|
*/
|
|
7939
7978
|
id: string;
|
|
7940
|
-
attributes:
|
|
7979
|
+
attributes: JsonApiFilterContextOutAttributes;
|
|
7941
7980
|
}
|
|
7942
7981
|
export declare const JsonApiVisualizationObjectInTypeEnum: {
|
|
7943
7982
|
readonly VISUALIZATION_OBJECT: "visualizationObject";
|
|
@@ -7969,7 +8008,7 @@ export interface JsonApiVisualizationObjectOut {
|
|
|
7969
8008
|
* API identifier of an object
|
|
7970
8009
|
*/
|
|
7971
8010
|
id: string;
|
|
7972
|
-
meta?:
|
|
8011
|
+
meta?: JsonApiDatasetOutMeta;
|
|
7973
8012
|
attributes: JsonApiVisualizationObjectOutAttributes;
|
|
7974
8013
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
7975
8014
|
}
|
|
@@ -8003,60 +8042,24 @@ export interface JsonApiVisualizationObjectOutDocument {
|
|
|
8003
8042
|
export interface JsonApiVisualizationObjectOutList {
|
|
8004
8043
|
data: Array<JsonApiVisualizationObjectOutWithLinks>;
|
|
8005
8044
|
links?: ListLinks;
|
|
8006
|
-
meta?:
|
|
8045
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
8007
8046
|
/**
|
|
8008
8047
|
* Included resources
|
|
8009
8048
|
*/
|
|
8010
8049
|
included?: Array<JsonApiMetricOutIncludes>;
|
|
8011
8050
|
}
|
|
8012
|
-
export interface JsonApiVisualizationObjectOutMeta {
|
|
8013
|
-
origin?: JsonApiVisualizationObjectOutMetaOrigin;
|
|
8014
|
-
}
|
|
8015
|
-
export interface JsonApiVisualizationObjectOutMetaOrigin {
|
|
8016
|
-
/**
|
|
8017
|
-
* defines type of the origin of the entity
|
|
8018
|
-
*/
|
|
8019
|
-
originType: JsonApiVisualizationObjectOutMetaOriginOriginTypeEnum;
|
|
8020
|
-
/**
|
|
8021
|
-
* defines id of the workspace where the entity comes from
|
|
8022
|
-
*/
|
|
8023
|
-
originId: string;
|
|
8024
|
-
}
|
|
8025
|
-
export declare const JsonApiVisualizationObjectOutMetaOriginOriginTypeEnum: {
|
|
8026
|
-
readonly NATIVE: "NATIVE";
|
|
8027
|
-
readonly PARENT: "PARENT";
|
|
8028
|
-
};
|
|
8029
|
-
export type JsonApiVisualizationObjectOutMetaOriginOriginTypeEnum = (typeof JsonApiVisualizationObjectOutMetaOriginOriginTypeEnum)[keyof typeof JsonApiVisualizationObjectOutMetaOriginOriginTypeEnum];
|
|
8030
8051
|
export interface JsonApiVisualizationObjectOutRelationships {
|
|
8031
8052
|
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
8032
8053
|
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
8033
|
-
facts?:
|
|
8034
|
-
attributes?:
|
|
8054
|
+
facts?: JsonApiDatasetOutRelationshipsFacts;
|
|
8055
|
+
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
8035
8056
|
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
8036
8057
|
metrics?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
8037
|
-
datasets?:
|
|
8038
|
-
}
|
|
8039
|
-
export interface JsonApiVisualizationObjectOutRelationshipsAttributes {
|
|
8040
|
-
/**
|
|
8041
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
8042
|
-
*/
|
|
8043
|
-
data: Array<JsonApiAttributeLinkage>;
|
|
8058
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
8044
8059
|
}
|
|
8045
8060
|
export interface JsonApiVisualizationObjectOutRelationshipsCreatedBy {
|
|
8046
8061
|
data: JsonApiUserIdentifierLinkage | null;
|
|
8047
8062
|
}
|
|
8048
|
-
export interface JsonApiVisualizationObjectOutRelationshipsDatasets {
|
|
8049
|
-
/**
|
|
8050
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
8051
|
-
*/
|
|
8052
|
-
data: Array<JsonApiDatasetLinkage>;
|
|
8053
|
-
}
|
|
8054
|
-
export interface JsonApiVisualizationObjectOutRelationshipsFacts {
|
|
8055
|
-
/**
|
|
8056
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
8057
|
-
*/
|
|
8058
|
-
data: Array<JsonApiFactLinkage>;
|
|
8059
|
-
}
|
|
8060
8063
|
export interface JsonApiVisualizationObjectOutRelationshipsLabels {
|
|
8061
8064
|
/**
|
|
8062
8065
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -8078,7 +8081,7 @@ export interface JsonApiVisualizationObjectOutWithLinks {
|
|
|
8078
8081
|
* API identifier of an object
|
|
8079
8082
|
*/
|
|
8080
8083
|
id: string;
|
|
8081
|
-
meta?:
|
|
8084
|
+
meta?: JsonApiDatasetOutMeta;
|
|
8082
8085
|
attributes: JsonApiVisualizationObjectOutAttributes;
|
|
8083
8086
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
8084
8087
|
links?: ObjectLinks;
|
|
@@ -8120,7 +8123,7 @@ export interface JsonApiVisualizationObjectPostOptionalId {
|
|
|
8120
8123
|
* API identifier of an object
|
|
8121
8124
|
*/
|
|
8122
8125
|
id?: string;
|
|
8123
|
-
attributes:
|
|
8126
|
+
attributes: JsonApiFilterContextOutAttributes;
|
|
8124
8127
|
}
|
|
8125
8128
|
export declare const JsonApiVisualizationObjectPostOptionalIdTypeEnum: {
|
|
8126
8129
|
readonly VISUALIZATION_OBJECT: "visualizationObject";
|
|
@@ -8141,65 +8144,38 @@ export interface JsonApiWorkspaceAutomationOut {
|
|
|
8141
8144
|
* API identifier of an object
|
|
8142
8145
|
*/
|
|
8143
8146
|
id: string;
|
|
8144
|
-
attributes
|
|
8145
|
-
relationships?:
|
|
8147
|
+
attributes?: JsonApiAutomationOutAttributes;
|
|
8148
|
+
relationships?: JsonApiWorkspaceAutomationOutRelationships;
|
|
8146
8149
|
}
|
|
8147
8150
|
export declare const JsonApiWorkspaceAutomationOutTypeEnum: {
|
|
8148
8151
|
readonly WORKSPACE_AUTOMATION: "workspaceAutomation";
|
|
8149
8152
|
};
|
|
8150
8153
|
export type JsonApiWorkspaceAutomationOutTypeEnum = (typeof JsonApiWorkspaceAutomationOutTypeEnum)[keyof typeof JsonApiWorkspaceAutomationOutTypeEnum];
|
|
8151
|
-
|
|
8152
|
-
|
|
8153
|
-
|
|
8154
|
-
|
|
8155
|
-
workspaceId: string;
|
|
8156
|
-
title?: string;
|
|
8157
|
-
description?: string;
|
|
8158
|
-
tags?: Array<string>;
|
|
8159
|
-
areRelationsValid?: boolean;
|
|
8160
|
-
/**
|
|
8161
|
-
* Additional details to be included in the automated message.
|
|
8162
|
-
*/
|
|
8163
|
-
details?: object;
|
|
8164
|
-
metadata?: JsonApiAutomationInAttributesMetadata | null;
|
|
8165
|
-
/**
|
|
8166
|
-
* Current state of the automation.
|
|
8167
|
-
*/
|
|
8168
|
-
state?: JsonApiWorkspaceAutomationOutAttributesStateEnum;
|
|
8169
|
-
schedule?: JsonApiAutomationInAttributesSchedule;
|
|
8170
|
-
alert?: JsonApiAutomationInAttributesAlert;
|
|
8171
|
-
tabularExports?: Array<JsonApiAutomationInAttributesTabularExportsInner>;
|
|
8172
|
-
visualExports?: Array<JsonApiAutomationInAttributesVisualExportsInner>;
|
|
8173
|
-
imageExports?: Array<JsonApiAutomationInAttributesImageExportsInner>;
|
|
8174
|
-
rawExports?: Array<JsonApiAutomationInAttributesRawExportsInner>;
|
|
8175
|
-
slidesExports?: Array<JsonApiAutomationInAttributesSlidesExportsInner>;
|
|
8176
|
-
dashboardTabularExports?: Array<JsonApiAutomationInAttributesDashboardTabularExportsInner>;
|
|
8177
|
-
/**
|
|
8178
|
-
* External recipients of the automation action results.
|
|
8179
|
-
*/
|
|
8180
|
-
externalRecipients?: Array<JsonApiAutomationInAttributesExternalRecipientsInner>;
|
|
8181
|
-
createdAt?: string;
|
|
8182
|
-
modifiedAt?: string;
|
|
8183
|
-
}
|
|
8184
|
-
export declare const JsonApiWorkspaceAutomationOutAttributesStateEnum: {
|
|
8185
|
-
readonly ACTIVE: "ACTIVE";
|
|
8186
|
-
readonly PAUSED: "PAUSED";
|
|
8187
|
-
};
|
|
8188
|
-
export type JsonApiWorkspaceAutomationOutAttributesStateEnum = (typeof JsonApiWorkspaceAutomationOutAttributesStateEnum)[keyof typeof JsonApiWorkspaceAutomationOutAttributesStateEnum];
|
|
8154
|
+
/**
|
|
8155
|
+
* @type JsonApiWorkspaceAutomationOutIncludes
|
|
8156
|
+
*/
|
|
8157
|
+
export type JsonApiWorkspaceAutomationOutIncludes = JsonApiAnalyticalDashboardOutWithLinks | JsonApiAutomationResultOutWithLinks | JsonApiExportDefinitionOutWithLinks | JsonApiNotificationChannelOutWithLinks | JsonApiUserIdentifierOutWithLinks | JsonApiUserOutWithLinks | JsonApiWorkspaceOutWithLinks;
|
|
8189
8158
|
/**
|
|
8190
8159
|
* A JSON:API document with a list of resources
|
|
8191
8160
|
*/
|
|
8192
8161
|
export interface JsonApiWorkspaceAutomationOutList {
|
|
8193
8162
|
data: Array<JsonApiWorkspaceAutomationOutWithLinks>;
|
|
8194
8163
|
links?: ListLinks;
|
|
8195
|
-
meta?:
|
|
8164
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
8196
8165
|
/**
|
|
8197
8166
|
* Included resources
|
|
8198
8167
|
*/
|
|
8199
|
-
included?: Array<
|
|
8168
|
+
included?: Array<JsonApiWorkspaceAutomationOutIncludes>;
|
|
8200
8169
|
}
|
|
8201
|
-
export interface
|
|
8202
|
-
|
|
8170
|
+
export interface JsonApiWorkspaceAutomationOutRelationships {
|
|
8171
|
+
workspace?: JsonApiWorkspaceOutRelationshipsParent;
|
|
8172
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
8173
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
8174
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
8175
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
8176
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
8177
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
8178
|
+
automationResults?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
8203
8179
|
}
|
|
8204
8180
|
export interface JsonApiWorkspaceAutomationOutWithLinks {
|
|
8205
8181
|
/**
|
|
@@ -8210,8 +8186,8 @@ export interface JsonApiWorkspaceAutomationOutWithLinks {
|
|
|
8210
8186
|
* API identifier of an object
|
|
8211
8187
|
*/
|
|
8212
8188
|
id: string;
|
|
8213
|
-
attributes
|
|
8214
|
-
relationships?:
|
|
8189
|
+
attributes?: JsonApiAutomationOutAttributes;
|
|
8190
|
+
relationships?: JsonApiWorkspaceAutomationOutRelationships;
|
|
8215
8191
|
links?: ObjectLinks;
|
|
8216
8192
|
}
|
|
8217
8193
|
export declare const JsonApiWorkspaceAutomationOutWithLinksTypeEnum: {
|
|
@@ -8263,7 +8239,7 @@ export interface JsonApiWorkspaceDataFilterOut {
|
|
|
8263
8239
|
* API identifier of an object
|
|
8264
8240
|
*/
|
|
8265
8241
|
id: string;
|
|
8266
|
-
meta?:
|
|
8242
|
+
meta?: JsonApiDatasetOutMeta;
|
|
8267
8243
|
attributes?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
8268
8244
|
relationships?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
8269
8245
|
}
|
|
@@ -8290,7 +8266,7 @@ export interface JsonApiWorkspaceDataFilterOutDocument {
|
|
|
8290
8266
|
export interface JsonApiWorkspaceDataFilterOutList {
|
|
8291
8267
|
data: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
8292
8268
|
links?: ListLinks;
|
|
8293
|
-
meta?:
|
|
8269
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
8294
8270
|
/**
|
|
8295
8271
|
* Included resources
|
|
8296
8272
|
*/
|
|
@@ -8314,7 +8290,7 @@ export interface JsonApiWorkspaceDataFilterOutWithLinks {
|
|
|
8314
8290
|
* API identifier of an object
|
|
8315
8291
|
*/
|
|
8316
8292
|
id: string;
|
|
8317
|
-
meta?:
|
|
8293
|
+
meta?: JsonApiDatasetOutMeta;
|
|
8318
8294
|
attributes?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
8319
8295
|
relationships?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
8320
8296
|
links?: ObjectLinks;
|
|
@@ -8357,27 +8333,16 @@ export interface JsonApiWorkspaceDataFilterSettingIn {
|
|
|
8357
8333
|
* API identifier of an object
|
|
8358
8334
|
*/
|
|
8359
8335
|
id: string;
|
|
8360
|
-
attributes?:
|
|
8361
|
-
relationships?:
|
|
8336
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
8337
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
8362
8338
|
}
|
|
8363
8339
|
export declare const JsonApiWorkspaceDataFilterSettingInTypeEnum: {
|
|
8364
8340
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
8365
8341
|
};
|
|
8366
8342
|
export type JsonApiWorkspaceDataFilterSettingInTypeEnum = (typeof JsonApiWorkspaceDataFilterSettingInTypeEnum)[keyof typeof JsonApiWorkspaceDataFilterSettingInTypeEnum];
|
|
8367
|
-
export interface JsonApiWorkspaceDataFilterSettingInAttributes {
|
|
8368
|
-
title?: string;
|
|
8369
|
-
description?: string;
|
|
8370
|
-
filterValues?: Array<string>;
|
|
8371
|
-
}
|
|
8372
8343
|
export interface JsonApiWorkspaceDataFilterSettingInDocument {
|
|
8373
8344
|
data: JsonApiWorkspaceDataFilterSettingIn;
|
|
8374
8345
|
}
|
|
8375
|
-
export interface JsonApiWorkspaceDataFilterSettingInRelationships {
|
|
8376
|
-
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter;
|
|
8377
|
-
}
|
|
8378
|
-
export interface JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter {
|
|
8379
|
-
data: JsonApiWorkspaceDataFilterLinkage | null;
|
|
8380
|
-
}
|
|
8381
8346
|
/**
|
|
8382
8347
|
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
8383
8348
|
*/
|
|
@@ -8401,14 +8366,19 @@ export interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
8401
8366
|
* API identifier of an object
|
|
8402
8367
|
*/
|
|
8403
8368
|
id: string;
|
|
8404
|
-
meta?:
|
|
8405
|
-
attributes?:
|
|
8406
|
-
relationships?:
|
|
8369
|
+
meta?: JsonApiDatasetOutMeta;
|
|
8370
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
8371
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
8407
8372
|
}
|
|
8408
8373
|
export declare const JsonApiWorkspaceDataFilterSettingOutTypeEnum: {
|
|
8409
8374
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
8410
8375
|
};
|
|
8411
8376
|
export type JsonApiWorkspaceDataFilterSettingOutTypeEnum = (typeof JsonApiWorkspaceDataFilterSettingOutTypeEnum)[keyof typeof JsonApiWorkspaceDataFilterSettingOutTypeEnum];
|
|
8377
|
+
export interface JsonApiWorkspaceDataFilterSettingOutAttributes {
|
|
8378
|
+
title?: string;
|
|
8379
|
+
description?: string;
|
|
8380
|
+
filterValues?: Array<string>;
|
|
8381
|
+
}
|
|
8412
8382
|
export interface JsonApiWorkspaceDataFilterSettingOutDocument {
|
|
8413
8383
|
data: JsonApiWorkspaceDataFilterSettingOut;
|
|
8414
8384
|
links?: ObjectLinks;
|
|
@@ -8423,12 +8393,18 @@ export interface JsonApiWorkspaceDataFilterSettingOutDocument {
|
|
|
8423
8393
|
export interface JsonApiWorkspaceDataFilterSettingOutList {
|
|
8424
8394
|
data: Array<JsonApiWorkspaceDataFilterSettingOutWithLinks>;
|
|
8425
8395
|
links?: ListLinks;
|
|
8426
|
-
meta?:
|
|
8396
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
8427
8397
|
/**
|
|
8428
8398
|
* Included resources
|
|
8429
8399
|
*/
|
|
8430
8400
|
included?: Array<JsonApiWorkspaceDataFilterOutWithLinks>;
|
|
8431
8401
|
}
|
|
8402
|
+
export interface JsonApiWorkspaceDataFilterSettingOutRelationships {
|
|
8403
|
+
workspaceDataFilter?: JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter;
|
|
8404
|
+
}
|
|
8405
|
+
export interface JsonApiWorkspaceDataFilterSettingOutRelationshipsWorkspaceDataFilter {
|
|
8406
|
+
data: JsonApiWorkspaceDataFilterLinkage | null;
|
|
8407
|
+
}
|
|
8432
8408
|
export interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
8433
8409
|
/**
|
|
8434
8410
|
* Object type
|
|
@@ -8438,9 +8414,9 @@ export interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
8438
8414
|
* API identifier of an object
|
|
8439
8415
|
*/
|
|
8440
8416
|
id: string;
|
|
8441
|
-
meta?:
|
|
8442
|
-
attributes?:
|
|
8443
|
-
relationships?:
|
|
8417
|
+
meta?: JsonApiDatasetOutMeta;
|
|
8418
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
8419
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
8444
8420
|
links?: ObjectLinks;
|
|
8445
8421
|
}
|
|
8446
8422
|
export declare const JsonApiWorkspaceDataFilterSettingOutWithLinksTypeEnum: {
|
|
@@ -8459,8 +8435,8 @@ export interface JsonApiWorkspaceDataFilterSettingPatch {
|
|
|
8459
8435
|
* API identifier of an object
|
|
8460
8436
|
*/
|
|
8461
8437
|
id: string;
|
|
8462
|
-
attributes?:
|
|
8463
|
-
relationships?:
|
|
8438
|
+
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
8439
|
+
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
8464
8440
|
}
|
|
8465
8441
|
export declare const JsonApiWorkspaceDataFilterSettingPatchTypeEnum: {
|
|
8466
8442
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
@@ -8481,8 +8457,8 @@ export interface JsonApiWorkspaceIn {
|
|
|
8481
8457
|
* API identifier of an object
|
|
8482
8458
|
*/
|
|
8483
8459
|
id: string;
|
|
8484
|
-
attributes?:
|
|
8485
|
-
relationships?:
|
|
8460
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
8461
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
8486
8462
|
}
|
|
8487
8463
|
export declare const JsonApiWorkspaceInTypeEnum: {
|
|
8488
8464
|
readonly WORKSPACE: "workspace";
|
|
@@ -8515,13 +8491,45 @@ export interface JsonApiWorkspaceOut {
|
|
|
8515
8491
|
*/
|
|
8516
8492
|
id: string;
|
|
8517
8493
|
meta?: JsonApiWorkspaceOutMeta;
|
|
8518
|
-
attributes?:
|
|
8519
|
-
relationships?:
|
|
8494
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
8495
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
8520
8496
|
}
|
|
8521
8497
|
export declare const JsonApiWorkspaceOutTypeEnum: {
|
|
8522
8498
|
readonly WORKSPACE: "workspace";
|
|
8523
8499
|
};
|
|
8524
8500
|
export type JsonApiWorkspaceOutTypeEnum = (typeof JsonApiWorkspaceOutTypeEnum)[keyof typeof JsonApiWorkspaceOutTypeEnum];
|
|
8501
|
+
export interface JsonApiWorkspaceOutAttributes {
|
|
8502
|
+
name?: string | null;
|
|
8503
|
+
/**
|
|
8504
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
8505
|
+
* @deprecated
|
|
8506
|
+
*/
|
|
8507
|
+
earlyAccess?: string | null;
|
|
8508
|
+
/**
|
|
8509
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
8510
|
+
*/
|
|
8511
|
+
earlyAccessValues?: Array<string> | null;
|
|
8512
|
+
description?: string | null;
|
|
8513
|
+
/**
|
|
8514
|
+
* Custom prefix of entity identifiers in workspace
|
|
8515
|
+
*/
|
|
8516
|
+
prefix?: string | null;
|
|
8517
|
+
cacheExtraLimit?: number;
|
|
8518
|
+
dataSource?: JsonApiWorkspaceOutAttributesDataSource;
|
|
8519
|
+
}
|
|
8520
|
+
/**
|
|
8521
|
+
* 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.
|
|
8522
|
+
*/
|
|
8523
|
+
export interface JsonApiWorkspaceOutAttributesDataSource {
|
|
8524
|
+
/**
|
|
8525
|
+
* The ID of the used data source.
|
|
8526
|
+
*/
|
|
8527
|
+
id: string;
|
|
8528
|
+
/**
|
|
8529
|
+
* The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...
|
|
8530
|
+
*/
|
|
8531
|
+
schemaPath?: Array<string>;
|
|
8532
|
+
}
|
|
8525
8533
|
export interface JsonApiWorkspaceOutDocument {
|
|
8526
8534
|
data: JsonApiWorkspaceOut;
|
|
8527
8535
|
links?: ObjectLinks;
|
|
@@ -8536,7 +8544,7 @@ export interface JsonApiWorkspaceOutDocument {
|
|
|
8536
8544
|
export interface JsonApiWorkspaceOutList {
|
|
8537
8545
|
data: Array<JsonApiWorkspaceOutWithLinks>;
|
|
8538
8546
|
links?: ListLinks;
|
|
8539
|
-
meta?:
|
|
8547
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
8540
8548
|
/**
|
|
8541
8549
|
* Included resources
|
|
8542
8550
|
*/
|
|
@@ -8589,6 +8597,12 @@ export interface JsonApiWorkspaceOutMetaHierarchy {
|
|
|
8589
8597
|
*/
|
|
8590
8598
|
childrenCount: number;
|
|
8591
8599
|
}
|
|
8600
|
+
export interface JsonApiWorkspaceOutRelationships {
|
|
8601
|
+
parent?: JsonApiWorkspaceOutRelationshipsParent;
|
|
8602
|
+
}
|
|
8603
|
+
export interface JsonApiWorkspaceOutRelationshipsParent {
|
|
8604
|
+
data: JsonApiWorkspaceLinkage | null;
|
|
8605
|
+
}
|
|
8592
8606
|
export interface JsonApiWorkspaceOutWithLinks {
|
|
8593
8607
|
/**
|
|
8594
8608
|
* Object type
|
|
@@ -8599,8 +8613,8 @@ export interface JsonApiWorkspaceOutWithLinks {
|
|
|
8599
8613
|
*/
|
|
8600
8614
|
id: string;
|
|
8601
8615
|
meta?: JsonApiWorkspaceOutMeta;
|
|
8602
|
-
attributes?:
|
|
8603
|
-
relationships?:
|
|
8616
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
8617
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
8604
8618
|
links?: ObjectLinks;
|
|
8605
8619
|
}
|
|
8606
8620
|
export declare const JsonApiWorkspaceOutWithLinksTypeEnum: {
|
|
@@ -8619,80 +8633,64 @@ export interface JsonApiWorkspacePatch {
|
|
|
8619
8633
|
* API identifier of an object
|
|
8620
8634
|
*/
|
|
8621
8635
|
id: string;
|
|
8622
|
-
attributes?:
|
|
8623
|
-
relationships?:
|
|
8636
|
+
attributes?: JsonApiWorkspaceOutAttributes;
|
|
8637
|
+
relationships?: JsonApiWorkspaceOutRelationships;
|
|
8624
8638
|
}
|
|
8625
8639
|
export declare const JsonApiWorkspacePatchTypeEnum: {
|
|
8626
8640
|
readonly WORKSPACE: "workspace";
|
|
8627
8641
|
};
|
|
8628
8642
|
export type JsonApiWorkspacePatchTypeEnum = (typeof JsonApiWorkspacePatchTypeEnum)[keyof typeof JsonApiWorkspacePatchTypeEnum];
|
|
8629
|
-
export interface
|
|
8630
|
-
|
|
8631
|
-
/**
|
|
8632
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
8633
|
-
* @deprecated
|
|
8634
|
-
*/
|
|
8635
|
-
earlyAccess?: string | null;
|
|
8636
|
-
/**
|
|
8637
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
8638
|
-
*/
|
|
8639
|
-
earlyAccessValues?: Array<string> | null;
|
|
8640
|
-
description?: string | null;
|
|
8641
|
-
/**
|
|
8642
|
-
* Custom prefix of entity identifiers in workspace
|
|
8643
|
-
*/
|
|
8644
|
-
prefix?: string | null;
|
|
8645
|
-
cacheExtraLimit?: number;
|
|
8646
|
-
dataSource?: JsonApiWorkspacePatchAttributesDataSource;
|
|
8643
|
+
export interface JsonApiWorkspacePatchDocument {
|
|
8644
|
+
data: JsonApiWorkspacePatch;
|
|
8647
8645
|
}
|
|
8648
8646
|
/**
|
|
8649
|
-
*
|
|
8647
|
+
* JSON:API representation of workspaceSetting entity.
|
|
8650
8648
|
*/
|
|
8651
|
-
export interface
|
|
8649
|
+
export interface JsonApiWorkspaceSettingIn {
|
|
8652
8650
|
/**
|
|
8653
|
-
*
|
|
8651
|
+
* Object type
|
|
8654
8652
|
*/
|
|
8655
|
-
|
|
8653
|
+
type: JsonApiWorkspaceSettingInTypeEnum;
|
|
8656
8654
|
/**
|
|
8657
|
-
*
|
|
8655
|
+
* API identifier of an object
|
|
8658
8656
|
*/
|
|
8659
|
-
|
|
8660
|
-
|
|
8661
|
-
export interface JsonApiWorkspacePatchDocument {
|
|
8662
|
-
data: JsonApiWorkspacePatch;
|
|
8663
|
-
}
|
|
8664
|
-
export interface JsonApiWorkspacePatchRelationships {
|
|
8665
|
-
parent?: JsonApiWorkspacePatchRelationshipsParent;
|
|
8657
|
+
id: string;
|
|
8658
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
8666
8659
|
}
|
|
8667
|
-
export
|
|
8668
|
-
|
|
8660
|
+
export declare const JsonApiWorkspaceSettingInTypeEnum: {
|
|
8661
|
+
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
8662
|
+
};
|
|
8663
|
+
export type JsonApiWorkspaceSettingInTypeEnum = (typeof JsonApiWorkspaceSettingInTypeEnum)[keyof typeof JsonApiWorkspaceSettingInTypeEnum];
|
|
8664
|
+
export interface JsonApiWorkspaceSettingInDocument {
|
|
8665
|
+
data: JsonApiWorkspaceSettingIn;
|
|
8669
8666
|
}
|
|
8670
8667
|
/**
|
|
8671
8668
|
* JSON:API representation of workspaceSetting entity.
|
|
8672
8669
|
*/
|
|
8673
|
-
export interface
|
|
8670
|
+
export interface JsonApiWorkspaceSettingOut {
|
|
8674
8671
|
/**
|
|
8675
8672
|
* Object type
|
|
8676
8673
|
*/
|
|
8677
|
-
type:
|
|
8674
|
+
type: JsonApiWorkspaceSettingOutTypeEnum;
|
|
8678
8675
|
/**
|
|
8679
8676
|
* API identifier of an object
|
|
8680
8677
|
*/
|
|
8681
8678
|
id: string;
|
|
8682
|
-
|
|
8679
|
+
meta?: JsonApiDatasetOutMeta;
|
|
8680
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
8683
8681
|
}
|
|
8684
|
-
export declare const
|
|
8682
|
+
export declare const JsonApiWorkspaceSettingOutTypeEnum: {
|
|
8685
8683
|
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
8686
8684
|
};
|
|
8687
|
-
export type
|
|
8688
|
-
export interface
|
|
8685
|
+
export type JsonApiWorkspaceSettingOutTypeEnum = (typeof JsonApiWorkspaceSettingOutTypeEnum)[keyof typeof JsonApiWorkspaceSettingOutTypeEnum];
|
|
8686
|
+
export interface JsonApiWorkspaceSettingOutAttributes {
|
|
8689
8687
|
/**
|
|
8690
8688
|
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
8691
8689
|
*/
|
|
8692
8690
|
content?: object;
|
|
8693
|
-
type?:
|
|
8691
|
+
type?: JsonApiWorkspaceSettingOutAttributesTypeEnum;
|
|
8694
8692
|
}
|
|
8695
|
-
export declare const
|
|
8693
|
+
export declare const JsonApiWorkspaceSettingOutAttributesTypeEnum: {
|
|
8696
8694
|
readonly TIMEZONE: "TIMEZONE";
|
|
8697
8695
|
readonly ACTIVE_THEME: "ACTIVE_THEME";
|
|
8698
8696
|
readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE";
|
|
@@ -8722,29 +8720,7 @@ export declare const JsonApiWorkspaceSettingInAttributesTypeEnum: {
|
|
|
8722
8720
|
readonly AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE: "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE";
|
|
8723
8721
|
readonly ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS: "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS";
|
|
8724
8722
|
};
|
|
8725
|
-
export type
|
|
8726
|
-
export interface JsonApiWorkspaceSettingInDocument {
|
|
8727
|
-
data: JsonApiWorkspaceSettingIn;
|
|
8728
|
-
}
|
|
8729
|
-
/**
|
|
8730
|
-
* JSON:API representation of workspaceSetting entity.
|
|
8731
|
-
*/
|
|
8732
|
-
export interface JsonApiWorkspaceSettingOut {
|
|
8733
|
-
/**
|
|
8734
|
-
* Object type
|
|
8735
|
-
*/
|
|
8736
|
-
type: JsonApiWorkspaceSettingOutTypeEnum;
|
|
8737
|
-
/**
|
|
8738
|
-
* API identifier of an object
|
|
8739
|
-
*/
|
|
8740
|
-
id: string;
|
|
8741
|
-
meta?: JsonApiVisualizationObjectOutMeta;
|
|
8742
|
-
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
8743
|
-
}
|
|
8744
|
-
export declare const JsonApiWorkspaceSettingOutTypeEnum: {
|
|
8745
|
-
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
8746
|
-
};
|
|
8747
|
-
export type JsonApiWorkspaceSettingOutTypeEnum = (typeof JsonApiWorkspaceSettingOutTypeEnum)[keyof typeof JsonApiWorkspaceSettingOutTypeEnum];
|
|
8723
|
+
export type JsonApiWorkspaceSettingOutAttributesTypeEnum = (typeof JsonApiWorkspaceSettingOutAttributesTypeEnum)[keyof typeof JsonApiWorkspaceSettingOutAttributesTypeEnum];
|
|
8748
8724
|
export interface JsonApiWorkspaceSettingOutDocument {
|
|
8749
8725
|
data: JsonApiWorkspaceSettingOut;
|
|
8750
8726
|
links?: ObjectLinks;
|
|
@@ -8755,7 +8731,7 @@ export interface JsonApiWorkspaceSettingOutDocument {
|
|
|
8755
8731
|
export interface JsonApiWorkspaceSettingOutList {
|
|
8756
8732
|
data: Array<JsonApiWorkspaceSettingOutWithLinks>;
|
|
8757
8733
|
links?: ListLinks;
|
|
8758
|
-
meta?:
|
|
8734
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
8759
8735
|
}
|
|
8760
8736
|
export interface JsonApiWorkspaceSettingOutWithLinks {
|
|
8761
8737
|
/**
|
|
@@ -8766,8 +8742,8 @@ export interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
8766
8742
|
* API identifier of an object
|
|
8767
8743
|
*/
|
|
8768
8744
|
id: string;
|
|
8769
|
-
meta?:
|
|
8770
|
-
attributes?:
|
|
8745
|
+
meta?: JsonApiDatasetOutMeta;
|
|
8746
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
8771
8747
|
links?: ObjectLinks;
|
|
8772
8748
|
}
|
|
8773
8749
|
export declare const JsonApiWorkspaceSettingOutWithLinksTypeEnum: {
|
|
@@ -8786,7 +8762,7 @@ export interface JsonApiWorkspaceSettingPatch {
|
|
|
8786
8762
|
* API identifier of an object
|
|
8787
8763
|
*/
|
|
8788
8764
|
id: string;
|
|
8789
|
-
attributes?:
|
|
8765
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
8790
8766
|
}
|
|
8791
8767
|
export declare const JsonApiWorkspaceSettingPatchTypeEnum: {
|
|
8792
8768
|
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
@@ -8807,7 +8783,7 @@ export interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
8807
8783
|
* API identifier of an object
|
|
8808
8784
|
*/
|
|
8809
8785
|
id?: string;
|
|
8810
|
-
attributes?:
|
|
8786
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
8811
8787
|
}
|
|
8812
8788
|
export declare const JsonApiWorkspaceSettingPostOptionalIdTypeEnum: {
|
|
8813
8789
|
readonly WORKSPACE_SETTING: "workspaceSetting";
|
|
@@ -9571,25 +9547,53 @@ export interface Settings {
|
|
|
9571
9547
|
mergeHeaders?: boolean;
|
|
9572
9548
|
/**
|
|
9573
9549
|
* Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)
|
|
9550
|
+
* @deprecated
|
|
9574
9551
|
*/
|
|
9575
9552
|
showFilters?: boolean;
|
|
9576
9553
|
/**
|
|
9577
9554
|
* Page size and orientation. (PDF)
|
|
9555
|
+
* @deprecated
|
|
9578
9556
|
*/
|
|
9579
9557
|
pdfPageSize?: string;
|
|
9580
9558
|
/**
|
|
9581
9559
|
* Custom CSS styles for the table. (PDF, HTML)
|
|
9560
|
+
* @deprecated
|
|
9582
9561
|
*/
|
|
9583
9562
|
pdfTableStyle?: Array<PdfTableStyle>;
|
|
9584
9563
|
/**
|
|
9585
9564
|
* Top left header content. (PDF)
|
|
9565
|
+
* @deprecated
|
|
9586
9566
|
*/
|
|
9587
9567
|
pdfTopLeftContent?: string;
|
|
9588
9568
|
/**
|
|
9589
9569
|
* Top right header content. (PDF)
|
|
9570
|
+
* @deprecated
|
|
9590
9571
|
*/
|
|
9591
9572
|
pdfTopRightContent?: string;
|
|
9573
|
+
/**
|
|
9574
|
+
* Set page size. (PDF)
|
|
9575
|
+
*/
|
|
9576
|
+
pageSize?: SettingsPageSizeEnum;
|
|
9577
|
+
/**
|
|
9578
|
+
* Set page orientation. (PDF)
|
|
9579
|
+
*/
|
|
9580
|
+
pageOrientation?: SettingsPageOrientationEnum;
|
|
9581
|
+
/**
|
|
9582
|
+
* Show info page with export information.
|
|
9583
|
+
*/
|
|
9584
|
+
showInfoPage?: boolean;
|
|
9592
9585
|
}
|
|
9586
|
+
export declare const SettingsPageSizeEnum: {
|
|
9587
|
+
readonly A3: "A3";
|
|
9588
|
+
readonly A4: "A4";
|
|
9589
|
+
readonly LETTER: "LETTER";
|
|
9590
|
+
};
|
|
9591
|
+
export type SettingsPageSizeEnum = (typeof SettingsPageSizeEnum)[keyof typeof SettingsPageSizeEnum];
|
|
9592
|
+
export declare const SettingsPageOrientationEnum: {
|
|
9593
|
+
readonly PORTRAIT: "PORTRAIT";
|
|
9594
|
+
readonly LANDSCAPE: "LANDSCAPE";
|
|
9595
|
+
};
|
|
9596
|
+
export type SettingsPageOrientationEnum = (typeof SettingsPageOrientationEnum)[keyof typeof SettingsPageOrientationEnum];
|
|
9593
9597
|
/**
|
|
9594
9598
|
* Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
|
|
9595
9599
|
*/
|
|
@@ -14837,7 +14841,7 @@ export declare const AutomationOrganizationViewControllerApiAxiosParamCreator: (
|
|
|
14837
14841
|
*
|
|
14838
14842
|
* @summary Get all Automations across all Workspaces
|
|
14839
14843
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
14840
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
14844
|
+
* @param {Array<'workspaces' | 'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'workspace' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
14841
14845
|
* @param {number} [page] Zero-based page index (0..N)
|
|
14842
14846
|
* @param {number} [size] The size of the page to be returned
|
|
14843
14847
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -14845,7 +14849,7 @@ export declare const AutomationOrganizationViewControllerApiAxiosParamCreator: (
|
|
|
14845
14849
|
* @param {*} [options] Override http request option.
|
|
14846
14850
|
* @throws {RequiredError}
|
|
14847
14851
|
*/
|
|
14848
|
-
getAllAutomationsWorkspaceAutomations: (filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14852
|
+
getAllAutomationsWorkspaceAutomations: (filter?: string, include?: Array<"workspaces" | "notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "workspace" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
14849
14853
|
};
|
|
14850
14854
|
/**
|
|
14851
14855
|
* AutomationOrganizationViewControllerApi - functional programming interface
|
|
@@ -14856,7 +14860,7 @@ export declare const AutomationOrganizationViewControllerApiFp: (configuration?:
|
|
|
14856
14860
|
*
|
|
14857
14861
|
* @summary Get all Automations across all Workspaces
|
|
14858
14862
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
14859
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
14863
|
+
* @param {Array<'workspaces' | 'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'workspace' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
14860
14864
|
* @param {number} [page] Zero-based page index (0..N)
|
|
14861
14865
|
* @param {number} [size] The size of the page to be returned
|
|
14862
14866
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -14864,7 +14868,7 @@ export declare const AutomationOrganizationViewControllerApiFp: (configuration?:
|
|
|
14864
14868
|
* @param {*} [options] Override http request option.
|
|
14865
14869
|
* @throws {RequiredError}
|
|
14866
14870
|
*/
|
|
14867
|
-
getAllAutomationsWorkspaceAutomations(filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiWorkspaceAutomationOutList>>;
|
|
14871
|
+
getAllAutomationsWorkspaceAutomations(filter?: string, include?: Array<"workspaces" | "notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "workspace" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiWorkspaceAutomationOutList>>;
|
|
14868
14872
|
};
|
|
14869
14873
|
/**
|
|
14870
14874
|
* AutomationOrganizationViewControllerApi - factory interface
|
|
@@ -14910,10 +14914,10 @@ export interface AutomationOrganizationViewControllerApiGetAllAutomationsWorkspa
|
|
|
14910
14914
|
readonly filter?: string;
|
|
14911
14915
|
/**
|
|
14912
14916
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
14913
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
14917
|
+
* @type {Array<'workspaces' | 'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'workspace' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
14914
14918
|
* @memberof AutomationOrganizationViewControllerApiGetAllAutomationsWorkspaceAutomations
|
|
14915
14919
|
*/
|
|
14916
|
-
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
14920
|
+
readonly include?: Array<"workspaces" | "notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "workspace" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
14917
14921
|
/**
|
|
14918
14922
|
* Zero-based page index (0..N)
|
|
14919
14923
|
* @type {number}
|
|
@@ -15003,7 +15007,7 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: Configura
|
|
|
15003
15007
|
*
|
|
15004
15008
|
* @summary Get all Automations across all Workspaces
|
|
15005
15009
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
15006
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
15010
|
+
* @param {Array<'workspaces' | 'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'workspace' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
15007
15011
|
* @param {number} [page] Zero-based page index (0..N)
|
|
15008
15012
|
* @param {number} [size] The size of the page to be returned
|
|
15009
15013
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -15011,7 +15015,7 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: Configura
|
|
|
15011
15015
|
* @param {*} [options] Override http request option.
|
|
15012
15016
|
* @throws {RequiredError}
|
|
15013
15017
|
*/
|
|
15014
|
-
getAllAutomationsWorkspaceAutomations: (filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15018
|
+
getAllAutomationsWorkspaceAutomations: (filter?: string, include?: Array<"workspaces" | "notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "workspace" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
15015
15019
|
/**
|
|
15016
15020
|
*
|
|
15017
15021
|
* @summary Get all Automations
|
|
@@ -15198,7 +15202,7 @@ export declare const AutomationsApiFp: (configuration?: Configuration) => {
|
|
|
15198
15202
|
*
|
|
15199
15203
|
* @summary Get all Automations across all Workspaces
|
|
15200
15204
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
15201
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
15205
|
+
* @param {Array<'workspaces' | 'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'workspace' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
15202
15206
|
* @param {number} [page] Zero-based page index (0..N)
|
|
15203
15207
|
* @param {number} [size] The size of the page to be returned
|
|
15204
15208
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -15206,7 +15210,7 @@ export declare const AutomationsApiFp: (configuration?: Configuration) => {
|
|
|
15206
15210
|
* @param {*} [options] Override http request option.
|
|
15207
15211
|
* @throws {RequiredError}
|
|
15208
15212
|
*/
|
|
15209
|
-
getAllAutomationsWorkspaceAutomations(filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiWorkspaceAutomationOutList>>;
|
|
15213
|
+
getAllAutomationsWorkspaceAutomations(filter?: string, include?: Array<"workspaces" | "notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "workspace" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiWorkspaceAutomationOutList>>;
|
|
15210
15214
|
/**
|
|
15211
15215
|
*
|
|
15212
15216
|
* @summary Get all Automations
|
|
@@ -15782,10 +15786,10 @@ export interface AutomationsApiGetAllAutomationsWorkspaceAutomationsRequest {
|
|
|
15782
15786
|
readonly filter?: string;
|
|
15783
15787
|
/**
|
|
15784
15788
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
15785
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
15789
|
+
* @type {Array<'workspaces' | 'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'workspace' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
15786
15790
|
* @memberof AutomationsApiGetAllAutomationsWorkspaceAutomations
|
|
15787
15791
|
*/
|
|
15788
|
-
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
15792
|
+
readonly include?: Array<"workspaces" | "notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "workspace" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
15789
15793
|
/**
|
|
15790
15794
|
* Zero-based page index (0..N)
|
|
15791
15795
|
* @type {number}
|
|
@@ -21663,7 +21667,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
21663
21667
|
*
|
|
21664
21668
|
* @summary Get all Automations across all Workspaces
|
|
21665
21669
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
21666
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
21670
|
+
* @param {Array<'workspaces' | 'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'workspace' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
21667
21671
|
* @param {number} [page] Zero-based page index (0..N)
|
|
21668
21672
|
* @param {number} [size] The size of the page to be returned
|
|
21669
21673
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -21671,7 +21675,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
21671
21675
|
* @param {*} [options] Override http request option.
|
|
21672
21676
|
* @throws {RequiredError}
|
|
21673
21677
|
*/
|
|
21674
|
-
getAllAutomationsWorkspaceAutomations: (filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
21678
|
+
getAllAutomationsWorkspaceAutomations: (filter?: string, include?: Array<"workspaces" | "notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "workspace" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
21675
21679
|
/**
|
|
21676
21680
|
*
|
|
21677
21681
|
* @param {string} workspaceId
|
|
@@ -23883,7 +23887,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
23883
23887
|
*
|
|
23884
23888
|
* @summary Get all Automations across all Workspaces
|
|
23885
23889
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
23886
|
-
* @param {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
23890
|
+
* @param {Array<'workspaces' | 'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'workspace' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
23887
23891
|
* @param {number} [page] Zero-based page index (0..N)
|
|
23888
23892
|
* @param {number} [size] The size of the page to be returned
|
|
23889
23893
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -23891,7 +23895,7 @@ export declare const EntitiesApiFp: (configuration?: Configuration) => {
|
|
|
23891
23895
|
* @param {*} [options] Override http request option.
|
|
23892
23896
|
* @throws {RequiredError}
|
|
23893
23897
|
*/
|
|
23894
|
-
getAllAutomationsWorkspaceAutomations(filter?: string, include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiWorkspaceAutomationOutList>>;
|
|
23898
|
+
getAllAutomationsWorkspaceAutomations(filter?: string, include?: Array<"workspaces" | "notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "workspace" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiWorkspaceAutomationOutList>>;
|
|
23895
23899
|
/**
|
|
23896
23900
|
*
|
|
23897
23901
|
* @param {string} workspaceId
|
|
@@ -30242,10 +30246,10 @@ export interface EntitiesApiGetAllAutomationsWorkspaceAutomationsRequest {
|
|
|
30242
30246
|
readonly filter?: string;
|
|
30243
30247
|
/**
|
|
30244
30248
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
30245
|
-
* @type {Array<'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
30249
|
+
* @type {Array<'workspaces' | 'notificationChannels' | 'analyticalDashboards' | 'userIdentifiers' | 'exportDefinitions' | 'users' | 'automationResults' | 'workspace' | 'notificationChannel' | 'analyticalDashboard' | 'createdBy' | 'modifiedBy' | 'recipients' | 'ALL'>}
|
|
30246
30250
|
* @memberof EntitiesApiGetAllAutomationsWorkspaceAutomations
|
|
30247
30251
|
*/
|
|
30248
|
-
readonly include?: Array<"notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
30252
|
+
readonly include?: Array<"workspaces" | "notificationChannels" | "analyticalDashboards" | "userIdentifiers" | "exportDefinitions" | "users" | "automationResults" | "workspace" | "notificationChannel" | "analyticalDashboard" | "createdBy" | "modifiedBy" | "recipients" | "ALL">;
|
|
30249
30253
|
/**
|
|
30250
30254
|
* Zero-based page index (0..N)
|
|
30251
30255
|
* @type {number}
|