@gooddata/api-client-tiger 11.20.0-alpha.2 → 11.20.0-alpha.4

package/esm/generated/afm-rest-api/api.d.ts

@@ -44,10 +44,6 @@ export interface AbsoluteDateFilterAbsoluteDateFilter {
     'to': string;
     'localIdentifier'?: string;
     'applyOnResult'?: boolean;
-    /**
-     * If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).
-     */
-    'includeEmptyValues'?: boolean;
     'dataset': AfmObjectIdentifierDataset;
 }
 /**
@@ -1766,10 +1762,6 @@ export interface RelativeDateFilterRelativeDateFilter {
     'localIdentifier'?: string;
     'applyOnResult'?: boolean;
     'boundedFilter'?: BoundedFilter;
-    /**
-     * If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).
-     */
-    'includeEmptyValues'?: boolean;
     'dataset': AfmObjectIdentifierDataset;
 }
 export type RelativeDateFilterRelativeDateFilterGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
@@ -2227,6 +2219,27 @@ export interface ValidateLLMEndpointResponse {
      */
     'message': string;
 }
+export interface WorkflowDashboardSummaryRequestDto {
+    'dashboardId': string;
+    'keyMetricIds'?: Array<string>;
+    'referenceQuarter'?: string;
+    'customUserPrompt'?: string;
+}
+export interface WorkflowDashboardSummaryResponseDto {
+    'runId': string;
+    'status': string;
+    'message': string;
+}
+export interface WorkflowStatusResponseDto {
+    'runId': string;
+    'status': string;
+    'message': string;
+    'result'?: {
+        [key: string]: object;
+    };
+    'error'?: string;
+    'currentPhase'?: string;
+}
 /**
  * (BETA) Deletes an existing database in the organization\'s AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.
  * @summary (BETA) Delete an existing AILake Database instance
@@ -2543,6 +2556,15 @@ export declare function ActionsApiAxiosParamCreator_AnomalyDetectionResult(works
  * @throws {RequiredError}
  */
 export declare function ActionsApiAxiosParamCreator_CancelExecutions(workspaceId: string, afmCancelTokens: AfmCancelTokens, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ *
+ * @param {string} workspaceId Workspace identifier
+ * @param {string} runId
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApiAxiosParamCreator_CancelWorkflow(workspaceId: string, runId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * Computes change analysis for the provided execution definition.
  * @summary Compute change analysis
@@ -2676,6 +2698,15 @@ export declare function ActionsApiAxiosParamCreator_Forecast(workspaceId: string
  * @throws {RequiredError}
  */
 export declare function ActionsApiAxiosParamCreator_ForecastResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ *
+ * @param {string} workspaceId Workspace identifier
+ * @param {WorkflowDashboardSummaryRequestDto} workflowDashboardSummaryRequestDto
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApiAxiosParamCreator_GenerateDashboardSummary(workspaceId: string, workflowDashboardSummaryRequestDto: WorkflowDashboardSummaryRequestDto, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * Returns metadata quality issues detected by the platform linter.
  * @summary Get Quality Issues
@@ -2695,6 +2726,15 @@ export declare function ActionsApiAxiosParamCreator_GetQualityIssues(workspaceId
  * @throws {RequiredError}
  */
 export declare function ActionsApiAxiosParamCreator_GetQualityIssuesCalculationStatus(workspaceId: string, processId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ *
+ * @param {string} workspaceId Workspace identifier
+ * @param {string} runId
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApiAxiosParamCreator_GetWorkflowStatus(workspaceId: string, runId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
  * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -2908,6 +2948,18 @@ export declare function ActionsApi_AnomalyDetectionResult(axios: AxiosInstance,
  * @throws {RequiredError}
  */
 export declare function ActionsApi_CancelExecutions(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiCancelExecutionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AfmCancelTokens>;
+/**
+ *
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ActionsApiCancelWorkflowRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApi_CancelWorkflow(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiCancelWorkflowRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<{
+    [key: string]: string;
+}>;
 /**
  * Computes change analysis for the provided execution definition.
  * @summary Compute change analysis
@@ -3040,6 +3092,16 @@ export declare function ActionsApi_Forecast(axios: AxiosInstance, basePath: stri
  * @throws {RequiredError}
  */
 export declare function ActionsApi_ForecastResult(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiForecastResultRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ForecastResult>;
+/**
+ *
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ActionsApiGenerateDashboardSummaryRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApi_GenerateDashboardSummary(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiGenerateDashboardSummaryRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<WorkflowDashboardSummaryResponseDto>;
 /**
  * Returns metadata quality issues detected by the platform linter.
  * @summary Get Quality Issues
@@ -3062,6 +3124,16 @@ export declare function ActionsApi_GetQualityIssues(axios: AxiosInstance, basePa
  * @throws {RequiredError}
  */
 export declare function ActionsApi_GetQualityIssuesCalculationStatus(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiGetQualityIssuesCalculationStatusRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<QualityIssuesCalculationStatusResponse>;
+/**
+ *
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ActionsApiGetWorkflowStatusRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApi_GetWorkflowStatus(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiGetWorkflowStatusRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<WorkflowStatusResponseDto>;
 /**
  * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
  * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -3272,6 +3344,16 @@ export interface ActionsApiInterface {
      * @memberof ActionsApiInterface
      */
     cancelExecutions(requestParameters: ActionsApiCancelExecutionsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
+    /**
+     *
+     * @param {ActionsApiCancelWorkflowRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    cancelWorkflow(requestParameters: ActionsApiCancelWorkflowRequest, options?: AxiosRequestConfig): AxiosPromise<{
+        [key: string]: string;
+    }>;
     /**
      * Computes change analysis for the provided execution definition.
      * @summary Compute change analysis
@@ -3380,6 +3462,14 @@ export interface ActionsApiInterface {
      * @memberof ActionsApiInterface
      */
     forecastResult(requestParameters: ActionsApiForecastResultRequest, options?: AxiosRequestConfig): AxiosPromise<ForecastResult>;
+    /**
+     *
+     * @param {ActionsApiGenerateDashboardSummaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    generateDashboardSummary(requestParameters: ActionsApiGenerateDashboardSummaryRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowDashboardSummaryResponseDto>;
     /**
      * Returns metadata quality issues detected by the platform linter.
      * @summary Get Quality Issues
@@ -3398,6 +3488,14 @@ export interface ActionsApiInterface {
      * @memberof ActionsApiInterface
      */
     getQualityIssuesCalculationStatus(requestParameters: ActionsApiGetQualityIssuesCalculationStatusRequest, options?: AxiosRequestConfig): AxiosPromise<QualityIssuesCalculationStatusResponse>;
+    /**
+     *
+     * @param {ActionsApiGetWorkflowStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    getWorkflowStatus(requestParameters: ActionsApiGetWorkflowStatusRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowStatusResponseDto>;
     /**
      * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
      * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -3677,6 +3775,25 @@ export interface ActionsApiCancelExecutionsRequest {
      */
     readonly afmCancelTokens: AfmCancelTokens;
 }
+/**
+ * Request parameters for cancelWorkflow operation in ActionsApi.
+ * @export
+ * @interface ActionsApiCancelWorkflowRequest
+ */
+export interface ActionsApiCancelWorkflowRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ActionsApiCancelWorkflow
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ActionsApiCancelWorkflow
+     */
+    readonly runId: string;
+}
 /**
  * Request parameters for changeAnalysis operation in ActionsApi.
  * @export
@@ -3983,6 +4100,25 @@ export interface ActionsApiForecastResultRequest {
      */
     readonly limit?: number;
 }
+/**
+ * Request parameters for generateDashboardSummary operation in ActionsApi.
+ * @export
+ * @interface ActionsApiGenerateDashboardSummaryRequest
+ */
+export interface ActionsApiGenerateDashboardSummaryRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ActionsApiGenerateDashboardSummary
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {WorkflowDashboardSummaryRequestDto}
+     * @memberof ActionsApiGenerateDashboardSummary
+     */
+    readonly workflowDashboardSummaryRequestDto: WorkflowDashboardSummaryRequestDto;
+}
 /**
  * Request parameters for getQualityIssues operation in ActionsApi.
  * @export
@@ -4015,6 +4151,25 @@ export interface ActionsApiGetQualityIssuesCalculationStatusRequest {
      */
     readonly processId: string;
 }
+/**
+ * Request parameters for getWorkflowStatus operation in ActionsApi.
+ * @export
+ * @interface ActionsApiGetWorkflowStatusRequest
+ */
+export interface ActionsApiGetWorkflowStatusRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ActionsApiGetWorkflowStatus
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ActionsApiGetWorkflowStatus
+     */
+    readonly runId: string;
+}
 /**
  * Request parameters for keyDriverAnalysis operation in ActionsApi.
  * @export
@@ -4352,6 +4507,16 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
      * @memberof ActionsApi
      */
     cancelExecutions(requestParameters: ActionsApiCancelExecutionsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
+    /**
+     *
+     * @param {ActionsApiCancelWorkflowRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    cancelWorkflow(requestParameters: ActionsApiCancelWorkflowRequest, options?: AxiosRequestConfig): AxiosPromise<{
+        [key: string]: string;
+    }>;
     /**
      * Computes change analysis for the provided execution definition.
      * @summary Compute change analysis
@@ -4460,6 +4625,14 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
      * @memberof ActionsApi
      */
     forecastResult(requestParameters: ActionsApiForecastResultRequest, options?: AxiosRequestConfig): AxiosPromise<ForecastResult>;
+    /**
+     *
+     * @param {ActionsApiGenerateDashboardSummaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    generateDashboardSummary(requestParameters: ActionsApiGenerateDashboardSummaryRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowDashboardSummaryResponseDto>;
     /**
      * Returns metadata quality issues detected by the platform linter.
      * @summary Get Quality Issues
@@ -4478,6 +4651,14 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
      * @memberof ActionsApi
      */
     getQualityIssuesCalculationStatus(requestParameters: ActionsApiGetQualityIssuesCalculationStatusRequest, options?: AxiosRequestConfig): AxiosPromise<QualityIssuesCalculationStatusResponse>;
+    /**
+     *
+     * @param {ActionsApiGetWorkflowStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    getWorkflowStatus(requestParameters: ActionsApiGetWorkflowStatusRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowStatusResponseDto>;
     /**
      * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
      * @summary (EXPERIMENTAL) Compute key driver analysis