@gooddata/sdk-backend-spi 10.5.0-alpha.14 → 10.5.0-alpha.16

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 CHANGED
@@ -48,4 +48,5 @@ export { IOrganizationPermissionService, IPermissionsAssignment } from "./organi
48
48
  export { IOrganizationNotificationChannelService } from "./organization/notificationChannels/index.js";
49
49
  export { IDataFiltersService } from "./workspace/dataFilter/index.js";
50
50
  export { IWorkspaceLogicalModelService, IDateDataset } from "./workspace/ldm/model.js";
51
+ export { IWorkspaceAutomationService, IGetAutomationOptions, IGetAutomationsOptions, AutomationType, IAutomationsQuery, IAutomationsQueryResult, } from "./workspace/automations/index.js";
51
52
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,OAAO,EACH,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEjG,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,OAAO,EACH,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAExE,OAAO,EACH,kBAAkB,EAClB,+BAA+B,EAC/B,yBAAyB,EACzB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,GACjC,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,6BAA6B,EAC7B,kCAAkC,EAClC,oCAAoC,EACpC,sDAAsD,EACtD,yCAAyC,EACzC,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,EACxC,oBAAoB,EACpB,4BAA4B,GAC/B,MAAM,0CAA0C,CAAC;AAElD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEjG,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EACH,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,GAC7B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAEzF,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAE9E,OAAO,EACH,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACrB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,OAAO,EACH,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,6BAA6B,EAC7B,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,uBAAuB,EACvB,6BAA6B,GAChC,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,wBAAwB,EACxB,sCAAsC,EACtC,iBAAiB,EACjB,+BAA+B,EAC/B,mCAAmC,EACnC,iDAAiD,EACjD,+BAA+B,EAC/B,wBAAwB,GAC3B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EACH,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AACvG,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EACH,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,GAClC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAEpF,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,kCAAkC,GACrC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7G,OAAO,EAAE,uCAAuC,EAAE,MAAM,8CAA8C,CAAC;AACvG,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE,OAAO,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,OAAO,EACH,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEjG,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,OAAO,EACH,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAExE,OAAO,EACH,kBAAkB,EAClB,+BAA+B,EAC/B,yBAAyB,EACzB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,GACjC,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,8BAA8B,EAC9B,6BAA6B,EAC7B,2BAA2B,EAC3B,kCAAkC,EAClC,kCAAkC,EAClC,iCAAiC,EACjC,yBAAyB,GAC5B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,6BAA6B,EAC7B,kCAAkC,EAClC,oCAAoC,EACpC,sDAAsD,EACtD,yCAAyC,EACzC,qCAAqC,EACrC,uDAAuD,EACvD,wCAAwC,EACxC,oBAAoB,EACpB,4BAA4B,GAC/B,MAAM,0CAA0C,CAAC;AAElD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEjG,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EACH,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EACH,oBAAoB,EACpB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,GAC7B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAEzF,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAE9E,OAAO,EACH,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,GACrB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,OAAO,EACH,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,gCAAgC,EAChC,iBAAiB,EACjB,6BAA6B,EAC7B,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,UAAU,GACb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,uBAAuB,EACvB,6BAA6B,GAChC,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACH,wBAAwB,EACxB,sCAAsC,EACtC,iBAAiB,EACjB,+BAA+B,EAC/B,mCAAmC,EACnC,iDAAiD,EACjD,+BAA+B,EAC/B,wBAAwB,GAC3B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,OAAO,EACH,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AACvG,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAEhF,OAAO,EACH,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,GAClC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAEpF,OAAO,EACH,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,kCAAkC,GACrC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,8BAA8B,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7G,OAAO,EAAE,uCAAuC,EAAE,MAAM,8CAA8C,CAAC;AACvG,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE,OAAO,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAEvF,OAAO,EACH,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,iBAAiB,EACjB,uBAAuB,GAC1B,MAAM,kCAAkC,CAAC"}
@@ -21,6 +21,8 @@ import { IAttributeElement } from '@gooddata/sdk-model';
21
21
  import { IAttributeFilter } from '@gooddata/sdk-model';
22
22
  import { IAttributeMetadataObject } from '@gooddata/sdk-model';
23
23
  import { IAttributeOrMeasure } from '@gooddata/sdk-model';
24
+ import { IAutomationMetadataObject } from '@gooddata/sdk-model';
25
+ import { IAutomationMetadataObjectDefinition } from '@gooddata/sdk-model';
24
26
  import { IAvailableAccessGrantee } from '@gooddata/sdk-model';
25
27
  import { IBucket } from '@gooddata/sdk-model';
26
28
  import { ICatalogAttribute } from '@gooddata/sdk-model';
@@ -53,8 +55,8 @@ import { IEntitlementDescriptor } from '@gooddata/sdk-model';
53
55
  import { IExecutionConfig } from '@gooddata/sdk-model';
54
56
  import { IExecutionDefinition } from '@gooddata/sdk-model';
55
57
  import { IExistingDashboard } from '@gooddata/sdk-model';
56
- import { IExportDefinition } from '@gooddata/sdk-model';
57
- import { IExportDefinitionBase } from '@gooddata/sdk-model';
58
+ import { IExportDefinitionMetadataObject } from '@gooddata/sdk-model';
59
+ import { IExportDefinitionMetadataObjectDefinition } from '@gooddata/sdk-model';
58
60
  import { IFilter } from '@gooddata/sdk-model';
59
61
  import { IFilterContextDefinition } from '@gooddata/sdk-model';
60
62
  import { IGranularAccessGrantee } from '@gooddata/sdk-model';
@@ -164,6 +166,13 @@ export declare type AuthenticationFlow = {
164
166
  returnRedirectParam: string;
165
167
  };
166
168
 
169
+ /**
170
+ * Type of workspace automation.
171
+ *
172
+ * @alpha
173
+ */
174
+ export declare type AutomationType = "schedule" | "trigger";
175
+
167
176
  /**
168
177
  * Options that is used for propagation cancellation signal / abort signal
169
178
  * @beta
@@ -418,6 +427,12 @@ export declare interface IAnalyticalWorkspace {
418
427
  * Returns parent analytical workspace when this workspace has a parent, undefined otherwise.
419
428
  */
420
429
  getParentWorkspace(): Promise<IAnalyticalWorkspace | undefined>;
430
+ /**
431
+ * Returns service that can be used to query and update workspace automations.
432
+ *
433
+ * @alpha
434
+ */
435
+ automations(): IWorkspaceAutomationService;
421
436
  /**
422
437
  * Returns factory that can be used to query workspace catalog items - attributes, measures, facts and date data sets.
423
438
  */
@@ -665,6 +680,67 @@ export declare interface IAuthenticationProvider {
665
680
  deauthenticate(context: IAuthenticationContext): Promise<void>;
666
681
  }
667
682
 
683
+ /**
684
+ * Service to query automations.
685
+ *
686
+ * @public
687
+ */
688
+ export declare interface IAutomationsQuery {
689
+ /**
690
+ * Sets number of automations to return per page.
691
+ * Default size: 50
692
+ *
693
+ * @param size - desired max number of automations per page must be a positive number
694
+ * @returns automations query
695
+ */
696
+ withSize(size: number): IAutomationsQuery;
697
+ /**
698
+ * Sets starting page for the query. Backend WILL return no data if the page is greater than
699
+ * total number of pages.
700
+ * Default page: 0
701
+ *
702
+ * @param page - zero indexed, must be non-negative
703
+ * @returns automations query
704
+ */
705
+ withPage(page: number): IAutomationsQuery;
706
+ /**
707
+ * Sets filter for the query.
708
+ *
709
+ * @param filter - filter to apply
710
+ * @returns automations query
711
+ */
712
+ withFilter(filter: {
713
+ title?: string;
714
+ }): IAutomationsQuery;
715
+ /**
716
+ * Sets sorting for the query.
717
+ *
718
+ * @param sort - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
719
+ * @returns automations query
720
+ */
721
+ withSorting(sort: string[]): IAutomationsQuery;
722
+ /**
723
+ * Sets type of the automation for the query.
724
+ *
725
+ * @param type - type of the automation, e.g. "schedule" or "trigger"
726
+ * @returns automations query
727
+ */
728
+ withType(type: AutomationType): IAutomationsQuery;
729
+ /**
730
+ * Starts the automations query.
731
+ *
732
+ * @returns promise of first page of the results
733
+ */
734
+ query(): Promise<IAutomationsQueryResult>;
735
+ }
736
+
737
+ /**
738
+ * Queried automations are returned in a paged representation.
739
+ *
740
+ * @public
741
+ */
742
+ export declare type IAutomationsQueryResult = IPagedResource<IAutomationMetadataObject>;
743
+
668
744
  /**
669
745
  * Analytical Backend communicates its capabilities via objects of this type. In return, the capabilities
670
746
  * can then be used by applications to enable / disable particular features.
@@ -1885,7 +1961,7 @@ export declare interface IExportDefinitionsQueryOptions {
1885
1961
  *
1886
1962
  * @alpha
1887
1963
  */
1888
- export declare type IExportDefinitionsQueryResult = IPagedResource<IExportDefinition>;
1964
+ export declare type IExportDefinitionsQueryResult = IPagedResource<IExportDefinitionMetadataObject>;
1889
1965
 
1890
1966
  /**
1891
1967
  * Configuration for PDF export.
@@ -1992,6 +2068,46 @@ export declare interface IForecastView {
1992
2068
  loading: boolean;
1993
2069
  }
1994
2070
 
2071
+ /**
2072
+ * Configuration options for loading automation metadata object.
2073
+ *
2074
+ * @alpha
2075
+ */
2076
+ export declare interface IGetAutomationOptions {
2077
+ /**
2078
+ * Specify if information about the users that created/modified the automation should be loaded.
2079
+ *
2080
+ * @remarks
2081
+ * Defaults to false.
2082
+ *
2083
+ * If user is inactive or logged in user has not rights to access this information than users that created/modified is undefined.
2084
+ */
2085
+ loadUserData?: boolean;
2086
+ }
2087
+
2088
+ /**
2089
+ * Configuration options for loading automation metadata objects.
2090
+ *
2091
+ * @alpha
2092
+ */
2093
+ export declare interface IGetAutomationsOptions {
2094
+ /**
2095
+ * Specify (zero-based) starting offset for the results. Default: 0
2096
+ */
2097
+ offset?: number;
2098
+ /**
2099
+ * Specify number of items per page. Default: 50
2100
+ */
2101
+ limit?: number;
2102
+ /**
2103
+ * Specify if information about the users that created/modified the exportDefinitions should be loaded for each exportDefinition.
2104
+ *
2105
+ * @remarks
2106
+ * Defaults to false.
2107
+ */
2108
+ loadUserData?: boolean;
2109
+ }
2110
+
1995
2111
  /**
1996
2112
  * Configuration options for getting dashboards.
1997
2113
  *
@@ -3463,6 +3579,60 @@ export declare interface IWorkspaceAttributesService {
3463
3579
  getConnectedAttributesByDisplayForm(ref: ObjRef): Promise<ObjRef[]>;
3464
3580
  }
3465
3581
 
3582
+ /**
3583
+ * This service provides access to workspace automations.
3584
+ *
3585
+ * @alpha
3586
+ */
3587
+ export declare interface IWorkspaceAutomationService {
3588
+ /**
3589
+ * List automations
3590
+ *
3591
+ * @returns methods for querying automations
3592
+ */
3593
+ getAutomationsQuery(): IAutomationsQuery;
3594
+ /**
3595
+ * Get all automations
3596
+ *
3597
+ * @param options - specify additional options
3598
+ * @returns Promise resolved with array of automations.
3599
+ * @throws In case of error.
3600
+ *
3601
+ */
3602
+ getAutomations(options?: IGetAutomationsOptions): Promise<IAutomationMetadataObject[]>;
3603
+ /**
3604
+ * Get atuomation by id
3605
+ *
3606
+ * @param id - id of the automation
3607
+ * @param options - specify additional options
3608
+ * @returns Promise resolved with automation definition
3609
+ */
3610
+ getAutomation(id: string, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
3611
+ /**
3612
+ * Create new automation
3613
+ *
3614
+ * @param automation - definition of the automation
3615
+ * @param options - specify additional options
3616
+ * @returns Promise resolved with created automation.
3617
+ */
3618
+ createAutomation(automation: IAutomationMetadataObjectDefinition, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
3619
+ /**
3620
+ * Update existing automation
3621
+ *
3622
+ * @param automation - definition of the automation
3623
+ * @param options - specify additional options
3624
+ * @returns Promise resolved when the automation is updated.
3625
+ */
3626
+ updateAutomation(automation: IAutomationMetadataObject, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
3627
+ /**
3628
+ * Delete automation
3629
+ *
3630
+ * @param id - id of the automation
3631
+ * @returns Promise resolved when the automation is deleted.
3632
+ */
3633
+ deleteAutomation(id: string): Promise<void>;
3634
+ }
3635
+
3466
3636
  /**
3467
3637
  * Instance of workspace catalog with loaded items
3468
3638
  *
@@ -4073,7 +4243,7 @@ export declare interface IWorkspaceDescriptorUpdate {
4073
4243
 
4074
4244
  /**
4075
4245
  * Service to query, update or delete exportDefinitions, and other methods related to exportDefinitions.
4076
- * Check IExportDefinition for more details.
4246
+ * Check IExportDefinitionMetadataObject for more details.
4077
4247
  *
4078
4248
  * @alpha
4079
4249
  */
@@ -4085,7 +4255,7 @@ export declare interface IWorkspaceExportDefinitionsService {
4085
4255
  * @param options - specify additional options
4086
4256
  * @returns promise of exportDefinition
4087
4257
  */
4088
- getExportDefinition(ref: ObjRef, options?: IGetExportDefinitionOptions): Promise<IExportDefinition>;
4258
+ getExportDefinition(ref: ObjRef, options?: IGetExportDefinitionOptions): Promise<IExportDefinitionMetadataObject>;
4089
4259
  /**
4090
4260
  * Queries workspace exportDefinitions, using various criteria and paging settings.
4091
4261
  *
@@ -4105,7 +4275,7 @@ export declare interface IWorkspaceExportDefinitionsService {
4105
4275
  * @param exportDefinition - exportDefinition to create
4106
4276
  * @returns promise of created exportDefinition
4107
4277
  */
4108
- createExportDefinition(exportDefinition: IExportDefinitionBase): Promise<IExportDefinition>;
4278
+ createExportDefinition(exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
4109
4279
  /**
4110
4280
  * Update provided exportDefinition
4111
4281
  *
@@ -4113,7 +4283,7 @@ export declare interface IWorkspaceExportDefinitionsService {
4113
4283
  * @param exportDefinition - exportDefinition to update
4114
4284
  * @returns promise of updated exportDefinition
4115
4285
  */
4116
- updateExportDefinition(ref: ObjRef, exportDefinition: IExportDefinitionBase): Promise<IExportDefinition>;
4286
+ updateExportDefinition(ref: ObjRef, exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
4117
4287
  /**
4118
4288
  * Delete exportDefinition with the given reference
4119
4289
  *
@@ -0,0 +1,159 @@
1
+ import { IAutomationMetadataObject, IAutomationMetadataObjectDefinition } from "@gooddata/sdk-model";
2
+ import { IPagedResource } from "../../common/paging.js";
3
+ /**
4
+ * Type of workspace automation.
5
+ *
6
+ * @alpha
7
+ */
8
+ export type AutomationType = "schedule" | "trigger";
9
+ /**
10
+ * Configuration options for loading automation metadata objects.
11
+ *
12
+ * @alpha
13
+ */
14
+ export interface IGetAutomationsOptions {
15
+ /**
16
+ * Specify (zero-based) starting offset for the results. Default: 0
17
+ */
18
+ offset?: number;
19
+ /**
20
+ * Specify number of items per page. Default: 50
21
+ */
22
+ limit?: number;
23
+ /**
24
+ * Specify if information about the users that created/modified the exportDefinitions should be loaded for each exportDefinition.
25
+ *
26
+ * @remarks
27
+ * Defaults to false.
28
+ */
29
+ loadUserData?: boolean;
30
+ }
31
+ /**
32
+ * Configuration options for loading automation metadata object.
33
+ *
34
+ * @alpha
35
+ */
36
+ export interface IGetAutomationOptions {
37
+ /**
38
+ * Specify if information about the users that created/modified the automation should be loaded.
39
+ *
40
+ * @remarks
41
+ * Defaults to false.
42
+ *
43
+ * If user is inactive or logged in user has not rights to access this information than users that created/modified is undefined.
44
+ */
45
+ loadUserData?: boolean;
46
+ }
47
+ /**
48
+ * This service provides access to workspace automations.
49
+ *
50
+ * @alpha
51
+ */
52
+ export interface IWorkspaceAutomationService {
53
+ /**
54
+ * List automations
55
+ *
56
+ * @returns methods for querying automations
57
+ */
58
+ getAutomationsQuery(): IAutomationsQuery;
59
+ /**
60
+ * Get all automations
61
+ *
62
+ * @param options - specify additional options
63
+ * @returns Promise resolved with array of automations.
64
+ * @throws In case of error.
65
+ *
66
+ */
67
+ getAutomations(options?: IGetAutomationsOptions): Promise<IAutomationMetadataObject[]>;
68
+ /**
69
+ * Get atuomation by id
70
+ *
71
+ * @param id - id of the automation
72
+ * @param options - specify additional options
73
+ * @returns Promise resolved with automation definition
74
+ */
75
+ getAutomation(id: string, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
76
+ /**
77
+ * Create new automation
78
+ *
79
+ * @param automation - definition of the automation
80
+ * @param options - specify additional options
81
+ * @returns Promise resolved with created automation.
82
+ */
83
+ createAutomation(automation: IAutomationMetadataObjectDefinition, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
84
+ /**
85
+ * Update existing automation
86
+ *
87
+ * @param automation - definition of the automation
88
+ * @param options - specify additional options
89
+ * @returns Promise resolved when the automation is updated.
90
+ */
91
+ updateAutomation(automation: IAutomationMetadataObject, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
92
+ /**
93
+ * Delete automation
94
+ *
95
+ * @param id - id of the automation
96
+ * @returns Promise resolved when the automation is deleted.
97
+ */
98
+ deleteAutomation(id: string): Promise<void>;
99
+ }
100
+ /**
101
+ * Service to query automations.
102
+ *
103
+ * @public
104
+ */
105
+ export interface IAutomationsQuery {
106
+ /**
107
+ * Sets number of automations to return per page.
108
+ * Default size: 50
109
+ *
110
+ * @param size - desired max number of automations per page must be a positive number
111
+ * @returns automations query
112
+ */
113
+ withSize(size: number): IAutomationsQuery;
114
+ /**
115
+ * Sets starting page for the query. Backend WILL return no data if the page is greater than
116
+ * total number of pages.
117
+ * Default page: 0
118
+ *
119
+ * @param page - zero indexed, must be non-negative
120
+ * @returns automations query
121
+ */
122
+ withPage(page: number): IAutomationsQuery;
123
+ /**
124
+ * Sets filter for the query.
125
+ *
126
+ * @param filter - filter to apply
127
+ * @returns automations query
128
+ */
129
+ withFilter(filter: {
130
+ title?: string;
131
+ }): IAutomationsQuery;
132
+ /**
133
+ * Sets sorting for the query.
134
+ *
135
+ * @param sort - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
136
+ * @returns automations query
137
+ */
138
+ withSorting(sort: string[]): IAutomationsQuery;
139
+ /**
140
+ * Sets type of the automation for the query.
141
+ *
142
+ * @param type - type of the automation, e.g. "schedule" or "trigger"
143
+ * @returns automations query
144
+ */
145
+ withType(type: AutomationType): IAutomationsQuery;
146
+ /**
147
+ * Starts the automations query.
148
+ *
149
+ * @returns promise of first page of the results
150
+ */
151
+ query(): Promise<IAutomationsQueryResult>;
152
+ }
153
+ /**
154
+ * Queried automations are returned in a paged representation.
155
+ *
156
+ * @public
157
+ */
158
+ export type IAutomationsQueryResult = IPagedResource<IAutomationMetadataObject>;
159
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +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;AACrG,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AAEH,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,SAAS,CAAC;AAEpD;;;;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,qBAAqB;IAClC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;OAIG;IACH,mBAAmB,IAAI,iBAAiB,CAAC;IAEzC;;;;;;;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,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/C;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;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;CAC7C;AAED;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAAC,yBAAyB,CAAC,CAAC"}
@@ -0,0 +1,3 @@
1
+ // (C) 2023-2024 GoodData Corporation
2
+ export {};
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/workspace/automations/index.ts"],"names":[],"mappings":"AAAA,qCAAqC"}
@@ -1,8 +1,8 @@
1
- import { ObjRef, IExportDefinition, IExportDefinitionBase } from "@gooddata/sdk-model";
1
+ import { ObjRef, IExportDefinitionMetadataObject, IExportDefinitionMetadataObjectDefinition } from "@gooddata/sdk-model";
2
2
  import { IPagedResource } from "../../common/paging.js";
3
3
  /**
4
4
  * Service to query, update or delete exportDefinitions, and other methods related to exportDefinitions.
5
- * Check IExportDefinition for more details.
5
+ * Check IExportDefinitionMetadataObject for more details.
6
6
  *
7
7
  * @alpha
8
8
  */
@@ -14,7 +14,7 @@ export interface IWorkspaceExportDefinitionsService {
14
14
  * @param options - specify additional options
15
15
  * @returns promise of exportDefinition
16
16
  */
17
- getExportDefinition(ref: ObjRef, options?: IGetExportDefinitionOptions): Promise<IExportDefinition>;
17
+ getExportDefinition(ref: ObjRef, options?: IGetExportDefinitionOptions): Promise<IExportDefinitionMetadataObject>;
18
18
  /**
19
19
  * Queries workspace exportDefinitions, using various criteria and paging settings.
20
20
  *
@@ -34,7 +34,7 @@ export interface IWorkspaceExportDefinitionsService {
34
34
  * @param exportDefinition - exportDefinition to create
35
35
  * @returns promise of created exportDefinition
36
36
  */
37
- createExportDefinition(exportDefinition: IExportDefinitionBase): Promise<IExportDefinition>;
37
+ createExportDefinition(exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
38
38
  /**
39
39
  * Update provided exportDefinition
40
40
  *
@@ -42,7 +42,7 @@ export interface IWorkspaceExportDefinitionsService {
42
42
  * @param exportDefinition - exportDefinition to update
43
43
  * @returns promise of updated exportDefinition
44
44
  */
45
- updateExportDefinition(ref: ObjRef, exportDefinition: IExportDefinitionBase): Promise<IExportDefinition>;
45
+ updateExportDefinition(ref: ObjRef, exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
46
46
  /**
47
47
  * Delete exportDefinition with the given reference
48
48
  *
@@ -177,5 +177,5 @@ export interface IExportDefinitionsQuery {
177
177
  *
178
178
  * @alpha
179
179
  */
180
- export type IExportDefinitionsQueryResult = IPagedResource<IExportDefinition>;
180
+ export type IExportDefinitionsQueryResult = IPagedResource<IExportDefinitionMetadataObject>;
181
181
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/exportDefinitions/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;;GAKG;AACH,MAAM,WAAW,kCAAkC;IAC/C;;;;;;OAMG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAEpG;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,CAAC,EAAE,8BAA8B,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAEvG;;;;OAIG;IACH,yBAAyB,IAAI,uBAAuB,CAAC;IAErD;;;;;OAKG;IACH,sBAAsB,CAAC,gBAAgB,EAAE,qBAAqB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE5F;;;;;;OAMG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,gBAAgB,EAAE,qBAAqB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAEzG;;;;;OAKG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,IAAI,GAAG,OAAO,GAAG,SAAS,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC3C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC;IAEnC;;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;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,kCAAkC,GAAG,KAAK,GAAG,MAAM,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG,IAAI,GAAG,OAAO,CAAC;AAE/D;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAC/B,iCAAiC,GACjC,GAAG,iCAAiC,IAAI,kCAAkC,EAAE,CAAC;AAEnF;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAEhD;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAEhD;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,uBAAuB,CAAC;IAEhE;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,yBAAyB,EAAE,GAAG,uBAAuB,CAAC;IAExE;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/workspace/exportDefinitions/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,MAAM,EACN,+BAA+B,EAC/B,yCAAyC,EAC5C,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;;GAKG;AACH,MAAM,WAAW,kCAAkC;IAC/C;;;;;;OAMG;IACH,mBAAmB,CACf,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,2BAA2B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAE5C;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,CAAC,EAAE,8BAA8B,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAEvG;;;;OAIG;IACH,yBAAyB,IAAI,uBAAuB,CAAC;IAErD;;;;;OAKG;IACH,sBAAsB,CAClB,gBAAgB,EAAE,yCAAyC,GAC5D,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAE5C;;;;;;OAMG;IACH,sBAAsB,CAClB,GAAG,EAAE,MAAM,EACX,gBAAgB,EAAE,yCAAyC,GAC5D,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAE5C;;;;;OAKG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,IAAI,GAAG,OAAO,GAAG,SAAS,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC3C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC;IAEnC;;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;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,kCAAkC,GAAG,KAAK,GAAG,MAAM,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG,IAAI,GAAG,OAAO,CAAC;AAE/D;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAC/B,iCAAiC,GACjC,GAAG,iCAAiC,IAAI,kCAAkC,EAAE,CAAC;AAEnF;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAEhD;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAEhD;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,uBAAuB,CAAC;IAEhE;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,yBAAyB,EAAE,GAAG,uBAAuB,CAAC;IAExE;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG,cAAc,CAAC,+BAA+B,CAAC,CAAC"}
@@ -18,6 +18,7 @@ import { IAttributeHierarchiesService } from "./attributeHierarchies/index.js";
18
18
  import { IWorkspaceExportDefinitionsService } from "./exportDefinitions/index.js";
19
19
  import { IDataFiltersService } from "./dataFilter/index.js";
20
20
  import { IWorkspaceLogicalModelService } from "./ldm/model.js";
21
+ import { IWorkspaceAutomationService } from "./automations/index.js";
21
22
  /**
22
23
  * Represents an analytical workspace hosted on a backend.
23
24
  *
@@ -47,6 +48,12 @@ export interface IAnalyticalWorkspace {
47
48
  * Returns parent analytical workspace when this workspace has a parent, undefined otherwise.
48
49
  */
49
50
  getParentWorkspace(): Promise<IAnalyticalWorkspace | undefined>;
51
+ /**
52
+ * Returns service that can be used to query and update workspace automations.
53
+ *
54
+ * @alpha
55
+ */
56
+ automations(): IWorkspaceAutomationService;
50
57
  /**
51
58
  * Returns factory that can be used to query workspace catalog items - attributes, measures, facts and date data sets.
52
59
  */
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/workspace/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kCAAkC,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAE/D;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAC;IAEhE;;OAEG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,iBAAiB,IAAI,uBAAuB,CAAC;IAE7C;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,KAAK,IAAI,sBAAsB,CAAC;IAEhC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,SAAS,IAAI,iBAAiB,CAAC;IAE/B;;OAEG;IACH,KAAK,IAAI,oBAAoB,CAAC;IAE9B;;OAEG;IACH,UAAU,IAAI,yBAAyB,CAAC;IAExC;;OAEG;IACH,WAAW,IAAI,4BAA4B,CAAC;IAE5C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,aAAa,IAAI,8BAA8B,CAAC;IAEhD;;;OAGG;IACH,oBAAoB,IAAI,4BAA4B,CAAC;IAErD;;;OAGG;IACH,iBAAiB,IAAI,kCAAkC,CAAC;IAExD;;;OAGG;IACH,WAAW,IAAI,mBAAmB,CAAC;IAEnC;;;OAGG;IACH,YAAY,IAAI,6BAA6B,CAAC;CACjD;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,0BAA0B;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE1C;;;;OAIG;IACH,cAAc,IAAI,gBAAgB,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,gBAAgB,CAAC;IAE9D;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,sBAAsB,GAAG,gBAAgB,CAAC;IAE7D;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,uBAAuB,GAAG,gBAAgB,CAAC;IAEhE;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,oBAAoB,CAAC,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/workspace/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kCAAkC,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAErE;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAC;IAEhE;;;;OAIG;IACH,WAAW,IAAI,2BAA2B,CAAC;IAE3C;;OAEG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,iBAAiB,IAAI,uBAAuB,CAAC;IAE7C;;OAEG;IACH,UAAU,IAAI,2BAA2B,CAAC;IAE1C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;OAEG;IACH,KAAK,IAAI,sBAAsB,CAAC;IAEhC;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,SAAS,IAAI,iBAAiB,CAAC;IAE/B;;OAEG;IACH,KAAK,IAAI,oBAAoB,CAAC;IAE9B;;OAEG;IACH,UAAU,IAAI,yBAAyB,CAAC;IAExC;;OAEG;IACH,WAAW,IAAI,4BAA4B,CAAC;IAE5C;;OAEG;IACH,QAAQ,IAAI,yBAAyB,CAAC;IAEtC;;;OAGG;IACH,OAAO,IAAI,wBAAwB,CAAC;IAEpC;;OAEG;IACH,aAAa,IAAI,8BAA8B,CAAC;IAEhD;;;OAGG;IACH,oBAAoB,IAAI,4BAA4B,CAAC;IAErD;;;OAGG;IACH,iBAAiB,IAAI,kCAAkC,CAAC;IAExD;;;OAGG;IACH,WAAW,IAAI,mBAAmB,CAAC;IAEnC;;;OAGG;IACH,YAAY,IAAI,6BAA6B,CAAC;CACjD;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,0BAA0B;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE1C;;;;OAIG;IACH,cAAc,IAAI,gBAAgB,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,gBAAgB,CAAC;IAE9D;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,sBAAsB,GAAG,gBAAgB,CAAC;IAE7D;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,uBAAuB,GAAG,gBAAgB,CAAC;IAEhE;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE7C;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,oBAAoB,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gooddata/sdk-backend-spi",
3
- "version": "10.5.0-alpha.14",
3
+ "version": "10.5.0-alpha.16",
4
4
  "author": "GoodData",
5
5
  "description": "GoodData Backend SPI abstraction interfaces",
6
6
  "repository": {
@@ -24,7 +24,7 @@
24
24
  "lodash": "^4.17.21",
25
25
  "ts-invariant": "^0.7.5",
26
26
  "tslib": "^2.5.0",
27
- "@gooddata/sdk-model": "10.5.0-alpha.14"
27
+ "@gooddata/sdk-model": "10.5.0-alpha.16"
28
28
  },
29
29
  "devDependencies": {
30
30
  "@gooddata/eslint-config": "^4.1.0",