@gooddata/api-client-tiger 11.70.0-alpha.0 → 11.70.0-alpha.1

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.
@@ -37,7 +37,7 @@ export interface AFM {
37
37
  */
38
38
  'measures': Array<MeasureItem>;
39
39
  /**
40
- * (EXPERIMENTAL) Parameter values to use for this execution.
40
+ * Parameter values to use for this execution.
41
41
  */
42
42
  'parameters'?: Array<ParameterItem>;
43
43
  }
@@ -735,7 +735,7 @@ export interface DatabaseInstance {
735
735
  * @type DateFilter
736
736
  * Abstract filter definition type for dates.
737
737
  */
738
- export type DateFilter = AbsoluteDateFilter | AbsoluteGranularityDateFilter | AllTimeDateFilter | RelativeDateFilter;
738
+ export type DateFilter = AbsoluteDateFilter | AbsoluteGranularityDateFilter | AllTimeDateFilter | ParameterizedDateFilter | RelativeDateFilter;
739
739
  /**
740
740
  * Filter definition type specified by label and values.
741
741
  */
@@ -1079,7 +1079,7 @@ export type FilterByLabelTypeEnum = 'PRIMARY' | 'REQUESTED';
1079
1079
  * @type FilterDefinition
1080
1080
  * Abstract filter definition type
1081
1081
  */
1082
- export type FilterDefinition = AbsoluteDateFilter | AbsoluteGranularityDateFilter | AllTimeDateFilter | ComparisonMeasureValueFilter | CompoundMeasureValueFilter | InlineFilterDefinition | MatchAttributeFilter | NegativeAttributeFilter | PositiveAttributeFilter | RangeMeasureValueFilter | RankingFilter | RelativeDateFilter;
1082
+ export type FilterDefinition = AbsoluteDateFilter | AbsoluteGranularityDateFilter | AllTimeDateFilter | ComparisonMeasureValueFilter | CompoundMeasureValueFilter | InlineFilterDefinition | MatchAttributeFilter | NegativeAttributeFilter | ParameterizedDateFilter | PositiveAttributeFilter | RangeMeasureValueFilter | RankingFilter | RelativeDateFilter;
1083
1083
  /**
1084
1084
  * @type FilterDefinitionForSimpleMeasure
1085
1085
  * Abstract filter definition type for simple metric.
@@ -2001,7 +2001,7 @@ export interface Paging {
2001
2001
  'total': number;
2002
2002
  }
2003
2003
  /**
2004
- * (EXPERIMENTAL) Parameter value for this execution.
2004
+ * Parameter value for this execution.
2005
2005
  */
2006
2006
  export interface ParameterItem {
2007
2007
  [key: string]: any;
@@ -2011,6 +2011,23 @@ export interface ParameterItem {
2011
2011
  */
2012
2012
  'value': string;
2013
2013
  }
2014
+ /**
2015
+ * A date filter whose period comes from a DATE_RANGE parameter. Each execution uses the parameter\'s current granularity and range.
2016
+ */
2017
+ export interface ParameterizedDateFilter {
2018
+ 'parameterizedDateFilter': ParameterizedDateFilterParameterizedDateFilter;
2019
+ }
2020
+ export interface ParameterizedDateFilterParameterizedDateFilter {
2021
+ 'applyOnResult'?: boolean;
2022
+ 'dataset': AfmObjectIdentifierDataset;
2023
+ /**
2024
+ * Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.
2025
+ */
2026
+ 'emptyValueHandling'?: ParameterizedDateFilterParameterizedDateFilterEmptyValueHandlingEnum;
2027
+ 'localIdentifier'?: string;
2028
+ 'parameter': AfmObjectIdentifierParameter;
2029
+ }
2030
+ export type ParameterizedDateFilterParameterizedDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
2014
2031
  /**
2015
2032
  * Operation that is still pending
2016
2033
  */
@@ -2657,6 +2674,27 @@ export interface VisualizationObjectExecution {
2657
2674
  'filters'?: Array<FilterDefinition>;
2658
2675
  'settings'?: ExecutionSettings;
2659
2676
  }
2677
+ export interface WorkflowDashboardSummaryRequestDto {
2678
+ 'customUserPrompt'?: string;
2679
+ 'dashboardId': string;
2680
+ 'keyMetricIds'?: Array<string>;
2681
+ 'referenceQuarter'?: string;
2682
+ }
2683
+ export interface WorkflowDashboardSummaryResponseDto {
2684
+ 'message': string;
2685
+ 'runId': string;
2686
+ 'status': string;
2687
+ }
2688
+ export interface WorkflowStatusResponseDto {
2689
+ 'currentPhase'?: string;
2690
+ 'error'?: string;
2691
+ 'message': string;
2692
+ 'result'?: {
2693
+ [key: string]: object;
2694
+ };
2695
+ 'runId': string;
2696
+ 'status': string;
2697
+ }
2660
2698
  /**
2661
2699
  * (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.
2662
2700
  * @summary (BETA) Add a data source to an AILake Database instance
@@ -4620,6 +4658,15 @@ export declare function ActionsApiAxiosParamCreator_CancelExecutions(workspaceId
4620
4658
  * @throws {RequiredError}
4621
4659
  */
4622
4660
  export declare function ActionsApiAxiosParamCreator_CancelFlows(workspaceId: string, afmCancelTokens: AfmCancelTokens, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
4661
+ /**
4662
+ *
4663
+ * @param {string} workspaceId Workspace identifier
4664
+ * @param {string} runId
4665
+ * @param {*} [options] Override http request option.
4666
+ * @param {Configuration} [configuration] Optional configuration.
4667
+ * @throws {RequiredError}
4668
+ */
4669
+ export declare function ActionsApiAxiosParamCreator_CancelWorkflow(workspaceId: string, runId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
4623
4670
  /**
4624
4671
  * Computes change analysis for the provided execution definition.
4625
4672
  * @summary Compute change analysis
@@ -4766,6 +4813,15 @@ export declare function ActionsApiAxiosParamCreator_Forecast(workspaceId: string
4766
4813
  * @throws {RequiredError}
4767
4814
  */
4768
4815
  export declare function ActionsApiAxiosParamCreator_ForecastResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
4816
+ /**
4817
+ *
4818
+ * @param {string} workspaceId Workspace identifier
4819
+ * @param {WorkflowDashboardSummaryRequestDto} workflowDashboardSummaryRequestDto
4820
+ * @param {*} [options] Override http request option.
4821
+ * @param {Configuration} [configuration] Optional configuration.
4822
+ * @throws {RequiredError}
4823
+ */
4824
+ export declare function ActionsApiAxiosParamCreator_GenerateDashboardSummary(workspaceId: string, workflowDashboardSummaryRequestDto: WorkflowDashboardSummaryRequestDto, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
4769
4825
  /**
4770
4826
  * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
4771
4827
  * @summary Generate Description for Analytics Object
@@ -4805,6 +4861,15 @@ export declare function ActionsApiAxiosParamCreator_GetQualityIssues(workspaceId
4805
4861
  * @throws {RequiredError}
4806
4862
  */
4807
4863
  export declare function ActionsApiAxiosParamCreator_GetQualityIssuesCalculationStatus(workspaceId: string, processId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
4864
+ /**
4865
+ *
4866
+ * @param {string} workspaceId Workspace identifier
4867
+ * @param {string} runId
4868
+ * @param {*} [options] Override http request option.
4869
+ * @param {Configuration} [configuration] Optional configuration.
4870
+ * @throws {RequiredError}
4871
+ */
4872
+ export declare function ActionsApiAxiosParamCreator_GetWorkflowStatus(workspaceId: string, runId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
4808
4873
  /**
4809
4874
  * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
4810
4875
  * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -5121,6 +5186,18 @@ export declare function ActionsApi_CancelExecutions(axios: AxiosInstance, basePa
5121
5186
  * @throws {RequiredError}
5122
5187
  */
5123
5188
  export declare function ActionsApi_CancelFlows(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiCancelFlowsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AfmCancelTokens>;
5189
+ /**
5190
+ *
5191
+ * @param {AxiosInstance} axios Axios instance.
5192
+ * @param {string} basePath Base path.
5193
+ * @param {ActionsApiCancelWorkflowRequest} requestParameters Request parameters.
5194
+ * @param {*} [options] Override http request option.
5195
+ * @param {Configuration} [configuration] Optional configuration.
5196
+ * @throws {RequiredError}
5197
+ */
5198
+ export declare function ActionsApi_CancelWorkflow(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiCancelWorkflowRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<{
5199
+ [key: string]: string;
5200
+ }>;
5124
5201
  /**
5125
5202
  * Computes change analysis for the provided execution definition.
5126
5203
  * @summary Compute change analysis
@@ -5264,6 +5341,16 @@ export declare function ActionsApi_Forecast(axios: AxiosInstance, basePath: stri
5264
5341
  * @throws {RequiredError}
5265
5342
  */
5266
5343
  export declare function ActionsApi_ForecastResult(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiForecastResultRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ForecastResult>;
5344
+ /**
5345
+ *
5346
+ * @param {AxiosInstance} axios Axios instance.
5347
+ * @param {string} basePath Base path.
5348
+ * @param {ActionsApiGenerateDashboardSummaryRequest} requestParameters Request parameters.
5349
+ * @param {*} [options] Override http request option.
5350
+ * @param {Configuration} [configuration] Optional configuration.
5351
+ * @throws {RequiredError}
5352
+ */
5353
+ export declare function ActionsApi_GenerateDashboardSummary(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiGenerateDashboardSummaryRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<WorkflowDashboardSummaryResponseDto>;
5267
5354
  /**
5268
5355
  * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
5269
5356
  * @summary Generate Description for Analytics Object
@@ -5308,6 +5395,16 @@ export declare function ActionsApi_GetQualityIssues(axios: AxiosInstance, basePa
5308
5395
  * @throws {RequiredError}
5309
5396
  */
5310
5397
  export declare function ActionsApi_GetQualityIssuesCalculationStatus(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiGetQualityIssuesCalculationStatusRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<QualityIssuesCalculationStatusResponse>;
5398
+ /**
5399
+ *
5400
+ * @param {AxiosInstance} axios Axios instance.
5401
+ * @param {string} basePath Base path.
5402
+ * @param {ActionsApiGetWorkflowStatusRequest} requestParameters Request parameters.
5403
+ * @param {*} [options] Override http request option.
5404
+ * @param {Configuration} [configuration] Optional configuration.
5405
+ * @throws {RequiredError}
5406
+ */
5407
+ export declare function ActionsApi_GetWorkflowStatus(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiGetWorkflowStatusRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<WorkflowStatusResponseDto>;
5311
5408
  /**
5312
5409
  * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
5313
5410
  * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -5633,6 +5730,16 @@ export interface ActionsApiInterface {
5633
5730
  * @memberof ActionsApiInterface
5634
5731
  */
5635
5732
  cancelFlows(requestParameters: ActionsApiCancelFlowsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
5733
+ /**
5734
+ *
5735
+ * @param {ActionsApiCancelWorkflowRequest} requestParameters Request parameters.
5736
+ * @param {*} [options] Override http request option.
5737
+ * @throws {RequiredError}
5738
+ * @memberof ActionsApiInterface
5739
+ */
5740
+ cancelWorkflow(requestParameters: ActionsApiCancelWorkflowRequest, options?: AxiosRequestConfig): AxiosPromise<{
5741
+ [key: string]: string;
5742
+ }>;
5636
5743
  /**
5637
5744
  * Computes change analysis for the provided execution definition.
5638
5745
  * @summary Compute change analysis
@@ -5750,6 +5857,14 @@ export interface ActionsApiInterface {
5750
5857
  * @memberof ActionsApiInterface
5751
5858
  */
5752
5859
  forecastResult(requestParameters: ActionsApiForecastResultRequest, options?: AxiosRequestConfig): AxiosPromise<ForecastResult>;
5860
+ /**
5861
+ *
5862
+ * @param {ActionsApiGenerateDashboardSummaryRequest} requestParameters Request parameters.
5863
+ * @param {*} [options] Override http request option.
5864
+ * @throws {RequiredError}
5865
+ * @memberof ActionsApiInterface
5866
+ */
5867
+ generateDashboardSummary(requestParameters: ActionsApiGenerateDashboardSummaryRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowDashboardSummaryResponseDto>;
5753
5868
  /**
5754
5869
  * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
5755
5870
  * @summary Generate Description for Analytics Object
@@ -5786,6 +5901,14 @@ export interface ActionsApiInterface {
5786
5901
  * @memberof ActionsApiInterface
5787
5902
  */
5788
5903
  getQualityIssuesCalculationStatus(requestParameters: ActionsApiGetQualityIssuesCalculationStatusRequest, options?: AxiosRequestConfig): AxiosPromise<QualityIssuesCalculationStatusResponse>;
5904
+ /**
5905
+ *
5906
+ * @param {ActionsApiGetWorkflowStatusRequest} requestParameters Request parameters.
5907
+ * @param {*} [options] Override http request option.
5908
+ * @throws {RequiredError}
5909
+ * @memberof ActionsApiInterface
5910
+ */
5911
+ getWorkflowStatus(requestParameters: ActionsApiGetWorkflowStatusRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowStatusResponseDto>;
5789
5912
  /**
5790
5913
  * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
5791
5914
  * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -6139,6 +6262,25 @@ export interface ActionsApiCancelFlowsRequest {
6139
6262
  */
6140
6263
  readonly afmCancelTokens: AfmCancelTokens;
6141
6264
  }
6265
+ /**
6266
+ * Request parameters for cancelWorkflow operation in ActionsApi.
6267
+ * @export
6268
+ * @interface ActionsApiCancelWorkflowRequest
6269
+ */
6270
+ export interface ActionsApiCancelWorkflowRequest {
6271
+ /**
6272
+ * Workspace identifier
6273
+ * @type {string}
6274
+ * @memberof ActionsApiCancelWorkflow
6275
+ */
6276
+ readonly workspaceId: string;
6277
+ /**
6278
+ *
6279
+ * @type {string}
6280
+ * @memberof ActionsApiCancelWorkflow
6281
+ */
6282
+ readonly runId: string;
6283
+ }
6142
6284
  /**
6143
6285
  * Request parameters for changeAnalysis operation in ActionsApi.
6144
6286
  * @export
@@ -6482,6 +6624,25 @@ export interface ActionsApiForecastResultRequest {
6482
6624
  */
6483
6625
  readonly limit?: number;
6484
6626
  }
6627
+ /**
6628
+ * Request parameters for generateDashboardSummary operation in ActionsApi.
6629
+ * @export
6630
+ * @interface ActionsApiGenerateDashboardSummaryRequest
6631
+ */
6632
+ export interface ActionsApiGenerateDashboardSummaryRequest {
6633
+ /**
6634
+ * Workspace identifier
6635
+ * @type {string}
6636
+ * @memberof ActionsApiGenerateDashboardSummary
6637
+ */
6638
+ readonly workspaceId: string;
6639
+ /**
6640
+ *
6641
+ * @type {WorkflowDashboardSummaryRequestDto}
6642
+ * @memberof ActionsApiGenerateDashboardSummary
6643
+ */
6644
+ readonly workflowDashboardSummaryRequestDto: WorkflowDashboardSummaryRequestDto;
6645
+ }
6485
6646
  /**
6486
6647
  * Request parameters for generateDescription operation in ActionsApi.
6487
6648
  * @export
@@ -6552,6 +6713,25 @@ export interface ActionsApiGetQualityIssuesCalculationStatusRequest {
6552
6713
  */
6553
6714
  readonly processId: string;
6554
6715
  }
6716
+ /**
6717
+ * Request parameters for getWorkflowStatus operation in ActionsApi.
6718
+ * @export
6719
+ * @interface ActionsApiGetWorkflowStatusRequest
6720
+ */
6721
+ export interface ActionsApiGetWorkflowStatusRequest {
6722
+ /**
6723
+ * Workspace identifier
6724
+ * @type {string}
6725
+ * @memberof ActionsApiGetWorkflowStatus
6726
+ */
6727
+ readonly workspaceId: string;
6728
+ /**
6729
+ *
6730
+ * @type {string}
6731
+ * @memberof ActionsApiGetWorkflowStatus
6732
+ */
6733
+ readonly runId: string;
6734
+ }
6555
6735
  /**
6556
6736
  * Request parameters for keyDriverAnalysis operation in ActionsApi.
6557
6737
  * @export
@@ -7096,6 +7276,16 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
7096
7276
  * @memberof ActionsApi
7097
7277
  */
7098
7278
  cancelFlows(requestParameters: ActionsApiCancelFlowsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
7279
+ /**
7280
+ *
7281
+ * @param {ActionsApiCancelWorkflowRequest} requestParameters Request parameters.
7282
+ * @param {*} [options] Override http request option.
7283
+ * @throws {RequiredError}
7284
+ * @memberof ActionsApi
7285
+ */
7286
+ cancelWorkflow(requestParameters: ActionsApiCancelWorkflowRequest, options?: AxiosRequestConfig): AxiosPromise<{
7287
+ [key: string]: string;
7288
+ }>;
7099
7289
  /**
7100
7290
  * Computes change analysis for the provided execution definition.
7101
7291
  * @summary Compute change analysis
@@ -7213,6 +7403,14 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
7213
7403
  * @memberof ActionsApi
7214
7404
  */
7215
7405
  forecastResult(requestParameters: ActionsApiForecastResultRequest, options?: AxiosRequestConfig): AxiosPromise<ForecastResult>;
7406
+ /**
7407
+ *
7408
+ * @param {ActionsApiGenerateDashboardSummaryRequest} requestParameters Request parameters.
7409
+ * @param {*} [options] Override http request option.
7410
+ * @throws {RequiredError}
7411
+ * @memberof ActionsApi
7412
+ */
7413
+ generateDashboardSummary(requestParameters: ActionsApiGenerateDashboardSummaryRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowDashboardSummaryResponseDto>;
7216
7414
  /**
7217
7415
  * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
7218
7416
  * @summary Generate Description for Analytics Object
@@ -7249,6 +7447,14 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
7249
7447
  * @memberof ActionsApi
7250
7448
  */
7251
7449
  getQualityIssuesCalculationStatus(requestParameters: ActionsApiGetQualityIssuesCalculationStatusRequest, options?: AxiosRequestConfig): AxiosPromise<QualityIssuesCalculationStatusResponse>;
7450
+ /**
7451
+ *
7452
+ * @param {ActionsApiGetWorkflowStatusRequest} requestParameters Request parameters.
7453
+ * @param {*} [options] Override http request option.
7454
+ * @throws {RequiredError}
7455
+ * @memberof ActionsApi
7456
+ */
7457
+ getWorkflowStatus(requestParameters: ActionsApiGetWorkflowStatusRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowStatusResponseDto>;
7252
7458
  /**
7253
7459
  * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
7254
7460
  * @summary (EXPERIMENTAL) Compute key driver analysis