@gooddata/sdk-backend-spi 10.42.0-alpha.2 → 10.42.0-alpha.4
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/index.d.ts +1 -0
- package/esm/index.d.ts.map +1 -1
- package/esm/organization/automations/index.d.ts +237 -0
- package/esm/organization/automations/index.d.ts.map +1 -0
- package/esm/organization/automations/index.js +3 -0
- package/esm/organization/automations/index.js.map +1 -0
- package/esm/organization/index.d.ts +8 -0
- package/esm/organization/index.d.ts.map +1 -1
- package/esm/sdk-backend-spi.d.ts +368 -9
- package/esm/workspace/attributes/index.d.ts +14 -1
- package/esm/workspace/attributes/index.d.ts.map +1 -1
- package/esm/workspace/automations/index.d.ts +14 -0
- package/esm/workspace/automations/index.d.ts.map +1 -1
- package/esm/workspace/dashboards/index.d.ts +15 -1
- package/esm/workspace/dashboards/index.d.ts.map +1 -1
- package/esm/workspace/execution/export.js +1 -1
- package/esm/workspace/execution/index.d.ts +9 -9
- package/esm/workspace/execution/index.d.ts.map +1 -1
- package/esm/workspace/facts/index.d.ts +20 -1
- package/esm/workspace/facts/index.d.ts.map +1 -1
- package/esm/workspace/index.d.ts +12 -0
- package/esm/workspace/index.d.ts.map +1 -1
- package/esm/workspace/insights/index.d.ts +15 -1
- package/esm/workspace/insights/index.d.ts.map +1 -1
- package/esm/workspace/measures/index.d.ts +22 -1
- package/esm/workspace/measures/index.d.ts.map +1 -1
- package/esm/workspace/users/index.js +1 -0
- package/esm/workspace/users/index.js.map +1 -1
- package/package.json +3 -2
package/esm/sdk-backend-spi.d.ts
CHANGED
|
@@ -41,12 +41,14 @@ import { IColorPaletteDefinition } from '@gooddata/sdk-model';
|
|
|
41
41
|
import { IColorPaletteMetadataObject } from '@gooddata/sdk-model';
|
|
42
42
|
import { IDashboard } from '@gooddata/sdk-model';
|
|
43
43
|
import { IDashboardAttributeFilterConfig } from '@gooddata/sdk-model';
|
|
44
|
+
import { IDashboardBase } from '@gooddata/sdk-model';
|
|
44
45
|
import { IDashboardDefinition } from '@gooddata/sdk-model';
|
|
45
46
|
import { IDashboardFilterView } from '@gooddata/sdk-model';
|
|
46
47
|
import { IDashboardFilterViewSaveRequest } from '@gooddata/sdk-model';
|
|
47
48
|
import { IDashboardLayout } from '@gooddata/sdk-model';
|
|
48
49
|
import { IDashboardLayoutItem } from '@gooddata/sdk-model';
|
|
49
50
|
import { IDashboardLayoutSection } from '@gooddata/sdk-model';
|
|
51
|
+
import { IDashboardObjectIdentity } from '@gooddata/sdk-model';
|
|
50
52
|
import { IDashboardPermissions } from '@gooddata/sdk-model';
|
|
51
53
|
import { IDashboardPlugin } from '@gooddata/sdk-model';
|
|
52
54
|
import { IDashboardPluginDefinition } from '@gooddata/sdk-model';
|
|
@@ -84,6 +86,8 @@ import { IMeasure } from '@gooddata/sdk-model';
|
|
|
84
86
|
import { IMeasureMetadataObject } from '@gooddata/sdk-model';
|
|
85
87
|
import { IMeasureMetadataObjectDefinition } from '@gooddata/sdk-model';
|
|
86
88
|
import { IMetadataObject } from '@gooddata/sdk-model';
|
|
89
|
+
import { IMetadataObjectBase } from '@gooddata/sdk-model';
|
|
90
|
+
import { IMetadataObjectIdentity } from '@gooddata/sdk-model';
|
|
87
91
|
import { INotification } from '@gooddata/sdk-model';
|
|
88
92
|
import { INotificationChannelExternalRecipient } from '@gooddata/sdk-model';
|
|
89
93
|
import { INotificationChannelIdentifier } from '@gooddata/sdk-model';
|
|
@@ -128,6 +132,7 @@ import { IWorkspaceUserGroup } from '@gooddata/sdk-model';
|
|
|
128
132
|
import { LlmEndpointOpenAIPatch } from '@gooddata/sdk-model';
|
|
129
133
|
import { LlmEndpointTestResults } from '@gooddata/sdk-model';
|
|
130
134
|
import { NotificationChannelDestinationType } from '@gooddata/sdk-model';
|
|
135
|
+
import { ObjectOrigin } from '@gooddata/sdk-model';
|
|
131
136
|
import { ObjectType } from '@gooddata/sdk-model';
|
|
132
137
|
import { ObjRef } from '@gooddata/sdk-model';
|
|
133
138
|
import { OrganizationPermissionAssignment } from '@gooddata/sdk-model';
|
|
@@ -585,8 +590,8 @@ export declare interface IAnomalyDetectionConfig {
|
|
|
585
590
|
*/
|
|
586
591
|
export declare interface IAnomalyDetectionResult {
|
|
587
592
|
attribute: string[];
|
|
588
|
-
values: number
|
|
589
|
-
anomalyFlag: boolean
|
|
593
|
+
values: Array<number | null>;
|
|
594
|
+
anomalyFlag: Array<boolean | null>;
|
|
590
595
|
}
|
|
591
596
|
|
|
592
597
|
/**
|
|
@@ -684,6 +689,13 @@ export declare interface IAttributesQuery {
|
|
|
684
689
|
* @returns attributes query
|
|
685
690
|
*/
|
|
686
691
|
withInclude(include: string[]): IAttributesQuery;
|
|
692
|
+
/**
|
|
693
|
+
* Sets origin for the query.
|
|
694
|
+
*
|
|
695
|
+
* @param origin - origin to apply. This is an open string union to allow platform-specific origin values in addition to the built-in literals.
|
|
696
|
+
* @returns attributes query
|
|
697
|
+
*/
|
|
698
|
+
withOrigin(origin: ObjectOrigin | (string & {})): IAttributesQuery;
|
|
687
699
|
/**
|
|
688
700
|
* Starts the query.
|
|
689
701
|
*
|
|
@@ -1308,9 +1320,9 @@ export declare interface IClusteringConfig {
|
|
|
1308
1320
|
*/
|
|
1309
1321
|
export declare interface IClusteringResult {
|
|
1310
1322
|
attribute: string[];
|
|
1311
|
-
clusters: number
|
|
1312
|
-
xcoord: number
|
|
1313
|
-
ycoord: number
|
|
1323
|
+
clusters: Array<number | null>;
|
|
1324
|
+
xcoord: Array<number | null>;
|
|
1325
|
+
ycoord: Array<number | null>;
|
|
1314
1326
|
}
|
|
1315
1327
|
|
|
1316
1328
|
/**
|
|
@@ -1453,6 +1465,13 @@ export declare interface IDashboardsQuery {
|
|
|
1453
1465
|
* @returns dashboards query
|
|
1454
1466
|
*/
|
|
1455
1467
|
withInclude(include: string[]): IDashboardsQuery;
|
|
1468
|
+
/**
|
|
1469
|
+
* Sets origin for the query.
|
|
1470
|
+
|
|
1471
|
+
* @param origin - origin to apply. This is an open string union to allow platform-specific origin values in addition to the built-in literals.
|
|
1472
|
+
* @returns dashboards query
|
|
1473
|
+
*/
|
|
1474
|
+
withOrigin(origin: ObjectOrigin | (string & {})): IDashboardsQuery;
|
|
1456
1475
|
/**
|
|
1457
1476
|
* Starts the dashboards query.
|
|
1458
1477
|
*
|
|
@@ -2465,6 +2484,13 @@ export declare interface IFactsQuery {
|
|
|
2465
2484
|
* @returns facts query
|
|
2466
2485
|
*/
|
|
2467
2486
|
withInclude(include: string[]): IFactsQuery;
|
|
2487
|
+
/**
|
|
2488
|
+
* Sets origin for the query.
|
|
2489
|
+
*
|
|
2490
|
+
* @param origin - origin to apply. This is an open string union to allow platform-specific origin values in addition to the built-in literals.
|
|
2491
|
+
* @returns facts query
|
|
2492
|
+
*/
|
|
2493
|
+
withOrigin(origin: ObjectOrigin | (string & {})): IFactsQuery;
|
|
2468
2494
|
/**
|
|
2469
2495
|
* Starts the query.
|
|
2470
2496
|
*
|
|
@@ -2560,10 +2586,10 @@ export declare interface IForecastConfig {
|
|
|
2560
2586
|
*/
|
|
2561
2587
|
export declare interface IForecastResult {
|
|
2562
2588
|
attribute: string[];
|
|
2563
|
-
origin: number
|
|
2564
|
-
prediction: number
|
|
2565
|
-
lowerBound: number
|
|
2566
|
-
upperBound: number
|
|
2589
|
+
origin: Array<number | null>;
|
|
2590
|
+
prediction: Array<number | null>;
|
|
2591
|
+
lowerBound: Array<number | null>;
|
|
2592
|
+
upperBound: Array<number | null>;
|
|
2567
2593
|
}
|
|
2568
2594
|
|
|
2569
2595
|
/**
|
|
@@ -2749,6 +2775,44 @@ export declare interface IGetInsightOptions {
|
|
|
2749
2775
|
loadUserData?: boolean;
|
|
2750
2776
|
}
|
|
2751
2777
|
|
|
2778
|
+
/**
|
|
2779
|
+
* Configuration options for loading organization automation metadata objects.
|
|
2780
|
+
*
|
|
2781
|
+
* @alpha
|
|
2782
|
+
*/
|
|
2783
|
+
export declare interface IGetOrganizationAutomationsOptions {
|
|
2784
|
+
/**
|
|
2785
|
+
* Specify (zero-based) starting offset for the results. Default: 0
|
|
2786
|
+
*/
|
|
2787
|
+
offset?: number;
|
|
2788
|
+
/**
|
|
2789
|
+
* Specify number of items per page. Default: 50
|
|
2790
|
+
*/
|
|
2791
|
+
limit?: number;
|
|
2792
|
+
/**
|
|
2793
|
+
* Filter automations by specific workspace IDs for centralized management.
|
|
2794
|
+
*
|
|
2795
|
+
* @remarks
|
|
2796
|
+
* If not provided, automations from all workspaces in the organization are returned.
|
|
2797
|
+
*/
|
|
2798
|
+
workspaceIds?: string[];
|
|
2799
|
+
}
|
|
2800
|
+
|
|
2801
|
+
/**
|
|
2802
|
+
* Configuration options for loading organization automation metadata objects with query.
|
|
2803
|
+
*
|
|
2804
|
+
* @alpha
|
|
2805
|
+
*/
|
|
2806
|
+
export declare interface IGetOrganizationAutomationsQueryOptions {
|
|
2807
|
+
/**
|
|
2808
|
+
* Specify if automationResult should be included in the response.
|
|
2809
|
+
*
|
|
2810
|
+
* @remarks
|
|
2811
|
+
* Defaults to false.
|
|
2812
|
+
*/
|
|
2813
|
+
includeAutomationResult?: boolean;
|
|
2814
|
+
}
|
|
2815
|
+
|
|
2752
2816
|
/**
|
|
2753
2817
|
* Configuration options for getting scheduled mails.
|
|
2754
2818
|
*
|
|
@@ -2870,6 +2934,13 @@ export declare interface IInsightsQuery {
|
|
|
2870
2934
|
* @returns insights query
|
|
2871
2935
|
*/
|
|
2872
2936
|
withInclude(include: string[]): IInsightsQuery;
|
|
2937
|
+
/**
|
|
2938
|
+
* Sets origin for the query.
|
|
2939
|
+
*
|
|
2940
|
+
* @param origin - origin to apply. This is an open string union to allow platform-specific origin values in addition to the built-in literals.
|
|
2941
|
+
* @returns insights query
|
|
2942
|
+
*/
|
|
2943
|
+
withOrigin(origin: ObjectOrigin | (string & {})): IInsightsQuery;
|
|
2873
2944
|
/**
|
|
2874
2945
|
* Starts the query.
|
|
2875
2946
|
*
|
|
@@ -3030,6 +3101,13 @@ export declare interface IMeasuresQuery {
|
|
|
3030
3101
|
* @returns measures query
|
|
3031
3102
|
*/
|
|
3032
3103
|
withInclude(include: string[]): IMeasuresQuery;
|
|
3104
|
+
/**
|
|
3105
|
+
* Sets origin for the query.
|
|
3106
|
+
*
|
|
3107
|
+
* @param origin - origin to apply. This is an open string union to allow platform-specific origin values in addition to the built-in literals.
|
|
3108
|
+
* @returns measures query
|
|
3109
|
+
*/
|
|
3110
|
+
withOrigin(origin: ObjectOrigin | (string & {})): IMeasuresQuery;
|
|
3033
3111
|
/**
|
|
3034
3112
|
* Starts the query.
|
|
3035
3113
|
*
|
|
@@ -3273,8 +3351,210 @@ export declare interface IOrganization {
|
|
|
3273
3351
|
* Returns service that can be used to query and manage organization notifications.
|
|
3274
3352
|
*/
|
|
3275
3353
|
notifications(): IOrganizationNotificationService;
|
|
3354
|
+
/**
|
|
3355
|
+
* Returns service that can be used to query and manage automations across all workspaces in the organization
|
|
3356
|
+
* for centralized automation management.
|
|
3357
|
+
*
|
|
3358
|
+
* @alpha
|
|
3359
|
+
*/
|
|
3360
|
+
automations(): IOrganizationAutomationService;
|
|
3361
|
+
}
|
|
3362
|
+
|
|
3363
|
+
/**
|
|
3364
|
+
* This service provides access to organization-wide automations for centralized automation management.
|
|
3365
|
+
* It allows managing automations across all workspaces within the organization.
|
|
3366
|
+
*
|
|
3367
|
+
* @alpha
|
|
3368
|
+
*/
|
|
3369
|
+
export declare interface IOrganizationAutomationService {
|
|
3370
|
+
/**
|
|
3371
|
+
* List automations across the organization for centralized management
|
|
3372
|
+
*
|
|
3373
|
+
* @param options - specify additional options
|
|
3374
|
+
* @returns methods for querying organization automations
|
|
3375
|
+
*/
|
|
3376
|
+
getAutomationsQuery(options?: IGetOrganizationAutomationsQueryOptions): IOrganizationAutomationsQuery;
|
|
3377
|
+
/**
|
|
3378
|
+
* Delete automation from any workspace within the organization
|
|
3379
|
+
*
|
|
3380
|
+
* @param id - id of the automation
|
|
3381
|
+
* @returns Promise resolved when the automation is deleted.
|
|
3382
|
+
*/
|
|
3383
|
+
deleteAutomation(id: string, workspaceId: string): Promise<void>;
|
|
3384
|
+
/**
|
|
3385
|
+
* Delete multiple automations across workspaces for centralized management
|
|
3386
|
+
*
|
|
3387
|
+
* Deletes multiple automations identified by their IDs from any workspace within the organization.
|
|
3388
|
+
*
|
|
3389
|
+
* @param ids - IDs of the automations to delete
|
|
3390
|
+
* @returns Promise resolved when the automations are deleted.
|
|
3391
|
+
*/
|
|
3392
|
+
deleteAutomations(automations: Array<{
|
|
3393
|
+
id: string;
|
|
3394
|
+
workspaceId: string;
|
|
3395
|
+
}>): Promise<void>;
|
|
3396
|
+
/**
|
|
3397
|
+
* Pause automation from any workspace within the organization
|
|
3398
|
+
*
|
|
3399
|
+
* @param id - id of the automation
|
|
3400
|
+
* @param workspaceId - id of the workspace containing the automation
|
|
3401
|
+
* @returns Promise resolved when the automation is paused.
|
|
3402
|
+
*/
|
|
3403
|
+
pauseAutomation(id: string, workspaceId: string): Promise<void>;
|
|
3404
|
+
/**
|
|
3405
|
+
* Pause multiple automations across workspaces for centralized management
|
|
3406
|
+
*
|
|
3407
|
+
* Pauses multiple automations identified by their IDs from any workspace within the organization.
|
|
3408
|
+
*
|
|
3409
|
+
* @param ids - IDs of the automations to pause
|
|
3410
|
+
* @returns Promise resolved when the automations are paused.
|
|
3411
|
+
*/
|
|
3412
|
+
pauseAutomations(automations: Array<{
|
|
3413
|
+
id: string;
|
|
3414
|
+
workspaceId: string;
|
|
3415
|
+
}>): Promise<void>;
|
|
3416
|
+
/**
|
|
3417
|
+
* Resume automation from any workspace within the organization
|
|
3418
|
+
*
|
|
3419
|
+
* @param id - id of the automation
|
|
3420
|
+
* @param workspaceId - id of the workspace containing the automation
|
|
3421
|
+
* @returns Promise resolved when the automation is resumed.
|
|
3422
|
+
*/
|
|
3423
|
+
resumeAutomation(id: string, workspaceId: string): Promise<void>;
|
|
3424
|
+
/**
|
|
3425
|
+
* Resume multiple automations across workspaces for centralized management
|
|
3426
|
+
*
|
|
3427
|
+
* Resumes multiple automations identified by their IDs from any workspace within the organization.
|
|
3428
|
+
*
|
|
3429
|
+
* @param ids - IDs of the automations to resume
|
|
3430
|
+
* @returns Promise resolved when the automations are resumed.
|
|
3431
|
+
*/
|
|
3432
|
+
resumeAutomations(automations: Array<{
|
|
3433
|
+
id: string;
|
|
3434
|
+
workspaceId: string;
|
|
3435
|
+
}>): Promise<void>;
|
|
3436
|
+
}
|
|
3437
|
+
|
|
3438
|
+
/**
|
|
3439
|
+
* Service to query automations across the organization for centralized automation management.
|
|
3440
|
+
*
|
|
3441
|
+
* @alpha
|
|
3442
|
+
*/
|
|
3443
|
+
export declare interface IOrganizationAutomationsQuery {
|
|
3444
|
+
/**
|
|
3445
|
+
* Sets number of automations to return per page.
|
|
3446
|
+
* Default size: 100
|
|
3447
|
+
*
|
|
3448
|
+
* @param size - desired max number of automations per page must be a positive number
|
|
3449
|
+
* @returns organization automations query
|
|
3450
|
+
*/
|
|
3451
|
+
withSize(size: number): IOrganizationAutomationsQuery;
|
|
3452
|
+
/**
|
|
3453
|
+
* Sets starting page for the query. Backend WILL return no data if the page is greater than
|
|
3454
|
+
* total number of pages.
|
|
3455
|
+
* Default page: 0
|
|
3456
|
+
*
|
|
3457
|
+
* @param page - zero indexed, must be non-negative
|
|
3458
|
+
* @returns organization automations query
|
|
3459
|
+
*/
|
|
3460
|
+
withPage(page: number): IOrganizationAutomationsQuery;
|
|
3461
|
+
/**
|
|
3462
|
+
* Sets filter for the query.
|
|
3463
|
+
*
|
|
3464
|
+
* @param filter - filter to apply
|
|
3465
|
+
* @returns organization automations query
|
|
3466
|
+
*/
|
|
3467
|
+
withFilter(filter: {
|
|
3468
|
+
title?: string;
|
|
3469
|
+
}): IOrganizationAutomationsQuery;
|
|
3470
|
+
/**
|
|
3471
|
+
* Sets sorting for the query.
|
|
3472
|
+
*
|
|
3473
|
+
* @param sort - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
3474
|
+
* @returns organization automations query
|
|
3475
|
+
*/
|
|
3476
|
+
withSorting(sort: string[]): IOrganizationAutomationsQuery;
|
|
3477
|
+
/**
|
|
3478
|
+
* Sets type of the automation for the query.
|
|
3479
|
+
*
|
|
3480
|
+
* @param type - type of the automation, e.g. "schedule" or "trigger"
|
|
3481
|
+
* @returns organization automations query
|
|
3482
|
+
*/
|
|
3483
|
+
withType(type: OrganizationAutomationType): IOrganizationAutomationsQuery;
|
|
3484
|
+
/**
|
|
3485
|
+
* Sets author of the automation for the query.
|
|
3486
|
+
*
|
|
3487
|
+
* @param author - author of the automation
|
|
3488
|
+
* @param multiValue - if true, the author is a multi-value filter
|
|
3489
|
+
* @returns organization automations query
|
|
3490
|
+
*/
|
|
3491
|
+
withAuthor(author: string, multiValue?: boolean): IOrganizationAutomationsQuery;
|
|
3492
|
+
/**
|
|
3493
|
+
* Sets recipient of the automation for the query.
|
|
3494
|
+
*
|
|
3495
|
+
* @param recipient - recipient of the automation
|
|
3496
|
+
* @param multiValue - if true, the recipient is a multi-value filter
|
|
3497
|
+
* @returns organization automations query
|
|
3498
|
+
*/
|
|
3499
|
+
withRecipient(recipient: string, multiValue?: boolean): IOrganizationAutomationsQuery;
|
|
3500
|
+
/**
|
|
3501
|
+
* Sets external recipient of the automation for the query.
|
|
3502
|
+
*
|
|
3503
|
+
* @param externalRecipient - external recipient of the automation
|
|
3504
|
+
* @returns organization automations query
|
|
3505
|
+
*/
|
|
3506
|
+
withExternalRecipient(externalRecipient: string): IOrganizationAutomationsQuery;
|
|
3507
|
+
/**
|
|
3508
|
+
* This filter gets automations if either author or recipient of the automation is the provided user.
|
|
3509
|
+
*
|
|
3510
|
+
* @param user - author or recipient of the automation
|
|
3511
|
+
* @returns organization automations query
|
|
3512
|
+
*/
|
|
3513
|
+
withUser(user: string): IOrganizationAutomationsQuery;
|
|
3514
|
+
/**
|
|
3515
|
+
* Sets dashboard id for the query.
|
|
3516
|
+
*
|
|
3517
|
+
* @param dashboard - dashboard id
|
|
3518
|
+
* @param multiValue - if true, the dashboard is a multi-value filter
|
|
3519
|
+
* @returns organization automations query
|
|
3520
|
+
*/
|
|
3521
|
+
withDashboard(dashboard: string, multiValue?: boolean): IOrganizationAutomationsQuery;
|
|
3522
|
+
/**
|
|
3523
|
+
* Sets status of automation results for the query.
|
|
3524
|
+
*
|
|
3525
|
+
* @param status - status of the automation result ("SUCCESS" or "FAILED")
|
|
3526
|
+
* @param multiValue - if true, the status is a multi-value filter
|
|
3527
|
+
* @returns organization automations query
|
|
3528
|
+
*/
|
|
3529
|
+
withStatus(status: string, multiValue?: boolean): IOrganizationAutomationsQuery;
|
|
3530
|
+
/**
|
|
3531
|
+
* Filter automations by workspace IDs for centralized management.
|
|
3532
|
+
*
|
|
3533
|
+
* @param workspaceIds - list of workspace IDs to filter by
|
|
3534
|
+
* @returns organization automations query
|
|
3535
|
+
*/
|
|
3536
|
+
withWorkspace(workspace: string, multiValue?: boolean): IOrganizationAutomationsQuery;
|
|
3537
|
+
/**
|
|
3538
|
+
* Starts the organization automations query.
|
|
3539
|
+
*
|
|
3540
|
+
* @returns promise of first page of the results
|
|
3541
|
+
*/
|
|
3542
|
+
query(): Promise<IOrganizationAutomationsQueryResult>;
|
|
3543
|
+
/**
|
|
3544
|
+
* Starts the organization automations query.
|
|
3545
|
+
*
|
|
3546
|
+
* @returns promise with a list of all automations matching the specified options
|
|
3547
|
+
*/
|
|
3548
|
+
queryAll(): Promise<IAutomationMetadataObject[]>;
|
|
3276
3549
|
}
|
|
3277
3550
|
|
|
3551
|
+
/**
|
|
3552
|
+
* Queried organization automations are returned in a paged representation for centralized management.
|
|
3553
|
+
*
|
|
3554
|
+
* @alpha
|
|
3555
|
+
*/
|
|
3556
|
+
export declare type IOrganizationAutomationsQueryResult = IPagedResource<IAutomationMetadataObject>;
|
|
3557
|
+
|
|
3278
3558
|
/**
|
|
3279
3559
|
* This service provides access to organization llm endpoints configuration.
|
|
3280
3560
|
*
|
|
@@ -4583,6 +4863,12 @@ export declare interface IWorkspaceAttributesService {
|
|
|
4583
4863
|
* @returns promise of attribute metadata object
|
|
4584
4864
|
*/
|
|
4585
4865
|
getAttribute(ref: ObjRef): Promise<IAttributeMetadataObject>;
|
|
4866
|
+
/**
|
|
4867
|
+
* Updates metadata of the attribute.
|
|
4868
|
+
*
|
|
4869
|
+
* @param updatedAttribute - update to apply
|
|
4870
|
+
*/
|
|
4871
|
+
updateAttributeMeta(updatedAttribute: Partial<IMetadataObjectBase> & IMetadataObjectIdentity): Promise<IAttributeMetadataObject>;
|
|
4586
4872
|
/**
|
|
4587
4873
|
* Gets the list of metadata of attribute with the provided list of uris. (list of object refs)
|
|
4588
4874
|
*
|
|
@@ -4716,6 +5002,13 @@ export declare interface IWorkspaceAutomationService {
|
|
|
4716
5002
|
* @returns Promise resolved when the user is unsubscribed.
|
|
4717
5003
|
*/
|
|
4718
5004
|
unsubscribeAutomations(ids: string[]): Promise<void>;
|
|
5005
|
+
/**
|
|
5006
|
+
* Pause automation
|
|
5007
|
+
*
|
|
5008
|
+
* @param id - id of the automation
|
|
5009
|
+
* @returns Promise resolved when the automation is paused.
|
|
5010
|
+
*/
|
|
5011
|
+
pauseAutomation(id: string): Promise<void>;
|
|
4719
5012
|
/**
|
|
4720
5013
|
* Pause automations
|
|
4721
5014
|
*
|
|
@@ -4725,6 +5018,13 @@ export declare interface IWorkspaceAutomationService {
|
|
|
4725
5018
|
* @returns Promise resolved when the automations are paused.
|
|
4726
5019
|
*/
|
|
4727
5020
|
pauseAutomations(ids: string[]): Promise<void>;
|
|
5021
|
+
/**
|
|
5022
|
+
* Resume automation
|
|
5023
|
+
*
|
|
5024
|
+
* @param id - id of the automation
|
|
5025
|
+
* @returns Promise resolved when the automation is resumed.
|
|
5026
|
+
*/
|
|
5027
|
+
resumeAutomation(id: string): Promise<void>;
|
|
4728
5028
|
/**
|
|
4729
5029
|
* Resume automations
|
|
4730
5030
|
*
|
|
@@ -5102,6 +5402,13 @@ export declare interface IWorkspaceDashboardsService {
|
|
|
5102
5402
|
* @returns promise of the updated dashboard
|
|
5103
5403
|
*/
|
|
5104
5404
|
updateDashboard(dashboard: IDashboard, updatedDashboard: IDashboardDefinition): Promise<IDashboard>;
|
|
5405
|
+
/**
|
|
5406
|
+
* Patch dashboard
|
|
5407
|
+
*
|
|
5408
|
+
* @param updatedDashboard - modified dashboard
|
|
5409
|
+
* @returns promise of the updated dashboard
|
|
5410
|
+
*/
|
|
5411
|
+
updateDashboardMeta(updatedDashboard: IDashboardObjectIdentity & Partial<IDashboardBase>): Promise<IDashboard>;
|
|
5105
5412
|
/**
|
|
5106
5413
|
* Delete dashboard
|
|
5107
5414
|
*
|
|
@@ -5527,6 +5834,18 @@ export declare interface IWorkspaceFactsService {
|
|
|
5527
5834
|
* @returns facts query
|
|
5528
5835
|
*/
|
|
5529
5836
|
getFactsQuery(): IFactsQuery;
|
|
5837
|
+
/**
|
|
5838
|
+
* Get information about the given fact
|
|
5839
|
+
* @param ref - ref of the fact
|
|
5840
|
+
* @returns promise of metadata object
|
|
5841
|
+
*/
|
|
5842
|
+
getFact(ref: ObjRef): Promise<IFactMetadataObject>;
|
|
5843
|
+
/**
|
|
5844
|
+
* Updates metadata of the fact.
|
|
5845
|
+
*
|
|
5846
|
+
* @param updatedFact - update to apply
|
|
5847
|
+
*/
|
|
5848
|
+
updateFactMeta(updatedFact: Partial<IMetadataObjectBase> & IMetadataObjectIdentity): Promise<IFactMetadataObject>;
|
|
5530
5849
|
}
|
|
5531
5850
|
|
|
5532
5851
|
/**
|
|
@@ -5595,6 +5914,13 @@ export declare interface IWorkspaceInsightsService {
|
|
|
5595
5914
|
* @returns promise of updated insight
|
|
5596
5915
|
*/
|
|
5597
5916
|
updateInsight(insight: IInsight): Promise<IInsight>;
|
|
5917
|
+
/**
|
|
5918
|
+
* Update metadata object for the insight
|
|
5919
|
+
*
|
|
5920
|
+
* @param insight - metadata object to update
|
|
5921
|
+
* @returns promise of updated measure
|
|
5922
|
+
*/
|
|
5923
|
+
updateInsightMeta(insight: Partial<IMetadataObjectBase> & IMetadataObjectIdentity): Promise<IInsight>;
|
|
5598
5924
|
/**
|
|
5599
5925
|
* Delete insight with the given reference
|
|
5600
5926
|
*
|
|
@@ -5681,6 +6007,13 @@ export declare interface IWorkspaceMeasuresService {
|
|
|
5681
6007
|
* @returns promise of updated measure
|
|
5682
6008
|
*/
|
|
5683
6009
|
updateMeasure(measure: IMeasureMetadataObject): Promise<IMeasureMetadataObject>;
|
|
6010
|
+
/**
|
|
6011
|
+
* Update metadata object for the measure
|
|
6012
|
+
*
|
|
6013
|
+
* @param measure - metadata object to update
|
|
6014
|
+
* @returns promise of updated measure
|
|
6015
|
+
*/
|
|
6016
|
+
updateMeasureMeta(measure: Partial<IMetadataObjectBase> & IMetadataObjectIdentity): Promise<IMeasureMetadataObject>;
|
|
5684
6017
|
/**
|
|
5685
6018
|
* Delete measure with the given reference
|
|
5686
6019
|
*
|
|
@@ -5701,6 +6034,13 @@ export declare interface IWorkspaceMeasuresService {
|
|
|
5701
6034
|
* @returns measures query
|
|
5702
6035
|
*/
|
|
5703
6036
|
getMeasuresQuery(): IMeasuresQuery;
|
|
6037
|
+
/**
|
|
6038
|
+
* Get measure by reference
|
|
6039
|
+
*
|
|
6040
|
+
* @param ref - ref of the measure to get
|
|
6041
|
+
* @returns promise of measure
|
|
6042
|
+
*/
|
|
6043
|
+
getMeasure(ref: ObjRef): Promise<IMeasureMetadataObject>;
|
|
5704
6044
|
}
|
|
5705
6045
|
|
|
5706
6046
|
/**
|
|
@@ -5911,6 +6251,18 @@ export declare interface IWorkspacesQuery {
|
|
|
5911
6251
|
* Executes the query and returns the result asynchronously.
|
|
5912
6252
|
*/
|
|
5913
6253
|
query(): Promise<IWorkspacesQueryResult>;
|
|
6254
|
+
/**
|
|
6255
|
+
* Executes the query and returns workspace descriptors in a paged result.
|
|
6256
|
+
* This is more efficient when you only need workspace metadata (id, title, etc.)
|
|
6257
|
+
* and don't need the full workspace services.
|
|
6258
|
+
*/
|
|
6259
|
+
queryDescriptors(): Promise<IPagedResource<IWorkspaceDescriptor>>;
|
|
6260
|
+
/**
|
|
6261
|
+
* Executes the query and returns all workspace descriptors.
|
|
6262
|
+
* This is more efficient when you only need workspace metadata (id, title, etc.)
|
|
6263
|
+
* and don't need the full workspace services.
|
|
6264
|
+
*/
|
|
6265
|
+
queryAllDescriptors(): Promise<IWorkspaceDescriptor[]>;
|
|
5914
6266
|
}
|
|
5915
6267
|
|
|
5916
6268
|
/**
|
|
@@ -6244,6 +6596,13 @@ export declare class NotSupported extends AnalyticalBackendError {
|
|
|
6244
6596
|
constructor(message: string);
|
|
6245
6597
|
}
|
|
6246
6598
|
|
|
6599
|
+
/**
|
|
6600
|
+
* Type of automation supported across the organization.
|
|
6601
|
+
*
|
|
6602
|
+
* @alpha
|
|
6603
|
+
*/
|
|
6604
|
+
export declare type OrganizationAutomationType = "schedule" | "trigger" | "alert";
|
|
6605
|
+
|
|
6247
6606
|
/**
|
|
6248
6607
|
* Prepares execution of the provided definition against a backend.
|
|
6249
6608
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IAttributeDisplayFormMetadataObject, IAttributeMetadataObject, IDataSetMetadataObject, IMetadataObject, ObjRef } from "@gooddata/sdk-model";
|
|
1
|
+
import { IAttributeDisplayFormMetadataObject, IAttributeMetadataObject, IDataSetMetadataObject, IMetadataObject, IMetadataObjectBase, IMetadataObjectIdentity, ObjRef, ObjectOrigin } from "@gooddata/sdk-model";
|
|
2
2
|
import { IElementsQueryFactory } from "./elements/index.js";
|
|
3
3
|
import { IFilterBaseOptions } from "../../common/filtering.js";
|
|
4
4
|
import { IPagedResource } from "../../common/paging.js";
|
|
@@ -63,6 +63,12 @@ export interface IWorkspaceAttributesService {
|
|
|
63
63
|
* @returns promise of attribute metadata object
|
|
64
64
|
*/
|
|
65
65
|
getAttribute(ref: ObjRef): Promise<IAttributeMetadataObject>;
|
|
66
|
+
/**
|
|
67
|
+
* Updates metadata of the attribute.
|
|
68
|
+
*
|
|
69
|
+
* @param updatedAttribute - update to apply
|
|
70
|
+
*/
|
|
71
|
+
updateAttributeMeta(updatedAttribute: Partial<IMetadataObjectBase> & IMetadataObjectIdentity): Promise<IAttributeMetadataObject>;
|
|
66
72
|
/**
|
|
67
73
|
* Gets the list of metadata of attribute with the provided list of uris. (list of object refs)
|
|
68
74
|
*
|
|
@@ -160,6 +166,13 @@ export interface IAttributesQuery {
|
|
|
160
166
|
* @returns attributes query
|
|
161
167
|
*/
|
|
162
168
|
withInclude(include: string[]): IAttributesQuery;
|
|
169
|
+
/**
|
|
170
|
+
* Sets origin for the query.
|
|
171
|
+
*
|
|
172
|
+
* @param origin - origin to apply. This is an open string union to allow platform-specific origin values in addition to the built-in literals.
|
|
173
|
+
* @returns attributes query
|
|
174
|
+
*/
|
|
175
|
+
withOrigin(origin: ObjectOrigin | (string & {})): IAttributesQuery;
|
|
163
176
|
/**
|
|
164
177
|
* Starts the query.
|
|
165
178
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/attributes/index.ts"],"names":[],"mappings":"AACA,OAAO,EACH,mCAAmC,EACnC,wBAAwB,EACxB,sBAAsB,EACtB,eAAe,EACf,MAAM,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/attributes/index.ts"],"names":[],"mappings":"AACA,OAAO,EACH,mCAAmC,EACnC,wBAAwB,EACxB,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,uBAAuB,EACvB,MAAM,EACN,YAAY,EACf,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,SAAS,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC;CACpC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;;;OAMG;IACH,QAAQ,IAAI,qBAAqB,CAAC;IAElC;;;;OAIG;IACH,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAAC;IAEnF;;;;;;;;;OASG;IACH,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,mCAAmC,EAAE,CAAC,CAAC;IAEzF;;;;;OAKG;IACH,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAE1E;;;;;OAKG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAE7D;;;;OAIG;IACH,mBAAmB,CACf,gBAAgB,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,uBAAuB,GACzE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAErC;;;;;;;;;OASG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC;IAEnE;;;;;;;OAOG;IACH,mBAAmB,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEhE;;;;;OAKG;IACH,wBAAwB,CAAC,mBAAmB,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAE/E;;;;OAIG;IACH,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/D;;;;OAIG;IACH,2BAA2B,CAAC,eAAe,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC;IAE5F;;;;;OAKG;IACH,mCAAmC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEpE;;;;OAIG;IACH,kBAAkB,IAAI,gBAAgB,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAEzC;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAEzC;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;IAEzD;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;IAE9C;;;;;OAKG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;IAEjD;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,gBAAgB,CAAC;IAEnE;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,wBAAwB,CAAC,CAAC"}
|
|
@@ -137,6 +137,13 @@ export interface IWorkspaceAutomationService {
|
|
|
137
137
|
* @returns Promise resolved when the user is unsubscribed.
|
|
138
138
|
*/
|
|
139
139
|
unsubscribeAutomations(ids: string[]): Promise<void>;
|
|
140
|
+
/**
|
|
141
|
+
* Pause automation
|
|
142
|
+
*
|
|
143
|
+
* @param id - id of the automation
|
|
144
|
+
* @returns Promise resolved when the automation is paused.
|
|
145
|
+
*/
|
|
146
|
+
pauseAutomation(id: string): Promise<void>;
|
|
140
147
|
/**
|
|
141
148
|
* Pause automations
|
|
142
149
|
*
|
|
@@ -146,6 +153,13 @@ export interface IWorkspaceAutomationService {
|
|
|
146
153
|
* @returns Promise resolved when the automations are paused.
|
|
147
154
|
*/
|
|
148
155
|
pauseAutomations(ids: string[]): Promise<void>;
|
|
156
|
+
/**
|
|
157
|
+
* Resume automation
|
|
158
|
+
*
|
|
159
|
+
* @param id - id of the automation
|
|
160
|
+
* @returns Promise resolved when the automation is resumed.
|
|
161
|
+
*/
|
|
162
|
+
resumeAutomation(id: string): Promise<void>;
|
|
149
163
|
/**
|
|
150
164
|
* Resume automations
|
|
151
165
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/automations/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,yBAAyB,EAAE,mCAAmC,EAAE,MAAM,qBAAqB,CAAC;AAErG,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AAEH,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;AAE9D;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;;OAKG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,2BAA2B,GAAG,iBAAiB,CAAC;IAE9E;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;IAEvF;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAE/F;;;;;;OAMG;IACH,gBAAgB,CACZ,UAAU,EAAE,mCAAmC,EAC/C,OAAO,CAAC,EAAE,qBAAqB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;OAMG;IACH,gBAAgB,CACZ,UAAU,EAAE,yBAAyB,EACrC,OAAO,CAAC,EAAE,qBAAqB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;;;;OAOG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;;;;OAQG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD;;;;;;;OAOG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAE1C;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAE1C;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,iBAAiB,CAAC;IAE1D;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAAC;IAE/C;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,iBAAiB,CAAC;IAElD;;;;;;OAMG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IAEpE;;;;;;OAMG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IAE1E;;;;;OAKG;IACH,qBAAqB,CAAC,iBAAiB,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAEpE;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAE1C;;;;;;OAMG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IAE1E;;;;;;OAMG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IAEpE;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAE1C;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;CACpD;AAED;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAAC,yBAAyB,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/automations/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,yBAAyB,EAAE,mCAAmC,EAAE,MAAM,qBAAqB,CAAC;AAErG,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AAEH,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;AAE9D;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;;OAKG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,2BAA2B,GAAG,iBAAiB,CAAC;IAE9E;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;IAEvF;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAE/F;;;;;;OAMG;IACH,gBAAgB,CACZ,UAAU,EAAE,mCAAmC,EAC/C,OAAO,CAAC,EAAE,qBAAqB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;;OAMG;IACH,gBAAgB,CACZ,UAAU,EAAE,yBAAyB,EACrC,OAAO,CAAC,EAAE,qBAAqB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAEtC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;;;;OAOG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;;;;OAQG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD;;;;;OAKG;IACH,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;;;;OAOG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;;;;OAOG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAE1C;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAE1C;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,iBAAiB,CAAC;IAE1D;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAAC;IAE/C;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,iBAAiB,CAAC;IAElD;;;;;;OAMG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IAEpE;;;;;;OAMG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IAE1E;;;;;OAKG;IACH,qBAAqB,CAAC,iBAAiB,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAEpE;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAE1C;;;;;;OAMG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IAE1E;;;;;;OAMG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IAEpE;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAE1C;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;CACpD;AAED;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAAC,yBAAyB,CAAC,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CatalogItem, FilterContextItem, IDashboard, IDashboardAttributeFilterConfig, IDashboardDefinition, IDashboardFilterView, IDashboardFilterViewSaveRequest, IDashboardPermissions, IDashboardPlugin, IDashboardPluginDefinition, IDataSetMetadataObject, IDateFilter, IExecutionDefinition, IExistingDashboard, IFilter, IFilterContext, IFilterContextDefinition, IInsight, IListedDashboard, IScheduledMail, IScheduledMailDefinition, IWidget, IWidgetAlert, IWidgetAlertDefinition, ObjRef, ObjectType } from "@gooddata/sdk-model";
|
|
1
|
+
import { CatalogItem, FilterContextItem, IDashboard, IDashboardAttributeFilterConfig, IDashboardBase, IDashboardDefinition, IDashboardFilterView, IDashboardFilterViewSaveRequest, IDashboardObjectIdentity, IDashboardPermissions, IDashboardPlugin, IDashboardPluginDefinition, IDataSetMetadataObject, IDateFilter, IExecutionDefinition, IExistingDashboard, IFilter, IFilterContext, IFilterContextDefinition, IInsight, IListedDashboard, IScheduledMail, IScheduledMailDefinition, IWidget, IWidgetAlert, IWidgetAlertDefinition, ObjRef, ObjectOrigin, ObjectType } from "@gooddata/sdk-model";
|
|
2
2
|
import { IFilterBaseOptions } from "../../common/filtering.js";
|
|
3
3
|
import { IPagedResource } from "../../common/paging.js";
|
|
4
4
|
import { IExportResult } from "../execution/export.js";
|
|
@@ -293,6 +293,13 @@ export interface IWorkspaceDashboardsService {
|
|
|
293
293
|
* @returns promise of the updated dashboard
|
|
294
294
|
*/
|
|
295
295
|
updateDashboard(dashboard: IDashboard, updatedDashboard: IDashboardDefinition): Promise<IDashboard>;
|
|
296
|
+
/**
|
|
297
|
+
* Patch dashboard
|
|
298
|
+
*
|
|
299
|
+
* @param updatedDashboard - modified dashboard
|
|
300
|
+
* @returns promise of the updated dashboard
|
|
301
|
+
*/
|
|
302
|
+
updateDashboardMeta(updatedDashboard: IDashboardObjectIdentity & Partial<IDashboardBase>): Promise<IDashboard>;
|
|
296
303
|
/**
|
|
297
304
|
* Delete dashboard
|
|
298
305
|
*
|
|
@@ -611,6 +618,13 @@ export interface IDashboardsQuery {
|
|
|
611
618
|
* @returns dashboards query
|
|
612
619
|
*/
|
|
613
620
|
withInclude(include: string[]): IDashboardsQuery;
|
|
621
|
+
/**
|
|
622
|
+
* Sets origin for the query.
|
|
623
|
+
|
|
624
|
+
* @param origin - origin to apply. This is an open string union to allow platform-specific origin values in addition to the built-in literals.
|
|
625
|
+
* @returns dashboards query
|
|
626
|
+
*/
|
|
627
|
+
withOrigin(origin: ObjectOrigin | (string & {})): IDashboardsQuery;
|
|
614
628
|
/**
|
|
615
629
|
* Starts the dashboards query.
|
|
616
630
|
*
|