@gooddata/api-client-tiger 11.5.0-alpha.4 → 11.5.0-alpha.6

package/esm/generated/afm-rest-api/api.js

@@ -221,28 +221,15 @@ export const MetricAggFunctionEnum = {
     AVG: "AVG",
     MEDIAN: "MEDIAN",
 };
-export const ObjectIdentifierTypeEnum = {
-    ANALYTICAL_DASHBOARD: "analyticalDashboard",
-    ATTRIBUTE: "attribute",
-    ATTRIBUTE_HIERARCHY: "attributeHierarchy",
-    DASHBOARD_PLUGIN: "dashboardPlugin",
-    DATASET: "dataset",
-    FACT: "fact",
-    AGGREGATED_FACT: "aggregatedFact",
-    LABEL: "label",
-    METRIC: "metric",
-    USER_DATA_FILTER: "userDataFilter",
-    EXPORT_DEFINITION: "exportDefinition",
-    AUTOMATION: "automation",
-    AUTOMATION_RESULT: "automationResult",
-    PROMPT: "prompt",
-    VISUALIZATION_OBJECT: "visualizationObject",
-    FILTER_CONTEXT: "filterContext",
-    WORKSPACE_SETTINGS: "workspaceSettings",
-    CUSTOM_APPLICATION_SETTING: "customApplicationSetting",
-    WORKSPACE_DATA_FILTER: "workspaceDataFilter",
-    WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting",
-    FILTER_VIEW: "filterView",
+export const QualityIssueSeverityEnum = {
+    ERROR: "error",
+    WARNING: "warning",
+};
+export const QualityIssuesCalculationStatusResponseStatusEnum = {
+    RUNNING: "RUNNING",
+    COMPLETED: "COMPLETED",
+    FAILED: "FAILED",
+    NOT_FOUND: "NOT_FOUND",
 };
 export const RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = {
     BETWEEN: "BETWEEN",
@@ -324,6 +311,11 @@ export const TotalFunctionEnum = {
     MED: "MED",
     NAT: "NAT",
 };
+export const TriggerQualityIssuesCalculationResponseStatusEnum = {
+    RUNNING: "RUNNING",
+    COMPLETED: "COMPLETED",
+    FAILED: "FAILED",
+};
 /**
  * ActionsApi - axios parameter creator
  * @export
@@ -1301,6 +1293,43 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Returns the status of a quality issues calculation process identified by process ID.
+         * @summary Get Quality Issues Calculation Status
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} processId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getQualityIssuesCalculationStatus: async (workspaceId, processId, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            assertParamExists("getQualityIssuesCalculationStatus", "workspaceId", workspaceId);
+            // verify required parameter 'processId' is not null or undefined
+            assertParamExists("getQualityIssuesCalculationStatus", "processId", processId);
+            const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId}`
+                .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
+                .replace(`{${"processId"}}`, encodeURIComponent(String(processId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {
+                ...localVarHeaderParameter,
+                ...headersFromBaseOptions,
+                ...options.headers,
+            };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
          * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -1614,6 +1643,38 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.
+         * @summary Trigger Quality Issues Calculation
+         * @param {string} workspaceId Workspace identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerQualityIssuesCalculation: async (workspaceId, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            assertParamExists("triggerQualityIssuesCalculation", "workspaceId", workspaceId);
+            const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {
+                ...localVarHeaderParameter,
+                ...headersFromBaseOptions,
+                ...options.headers,
+            };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * (EXPERIMENTAL) Updates memory item and returns it
          * @summary (EXPERIMENTAL) Update memory item
@@ -2037,6 +2098,18 @@ export const ActionsApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getQualityIssues(workspaceId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Returns the status of a quality issues calculation process identified by process ID.
+         * @summary Get Quality Issues Calculation Status
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} processId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getQualityIssuesCalculationStatus(workspaceId, processId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getQualityIssuesCalculationStatus(workspaceId, processId, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
          * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -2137,6 +2210,17 @@ export const ActionsApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.tags(workspaceId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.
+         * @summary Trigger Quality Issues Calculation
+         * @param {string} workspaceId Workspace identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async triggerQualityIssuesCalculation(workspaceId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.triggerQualityIssuesCalculation(workspaceId, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * (EXPERIMENTAL) Updates memory item and returns it
          * @summary (EXPERIMENTAL) Update memory item
@@ -2458,6 +2542,18 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
                 .getQualityIssues(requestParameters.workspaceId, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Returns the status of a quality issues calculation process identified by process ID.
+         * @summary Get Quality Issues Calculation Status
+         * @param {ActionsApiGetQualityIssuesCalculationStatusRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getQualityIssuesCalculationStatus(requestParameters, options) {
+            return localVarFp
+                .getQualityIssuesCalculationStatus(requestParameters.workspaceId, requestParameters.processId, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
          * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -2554,6 +2650,18 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
                 .tags(requestParameters.workspaceId, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.
+         * @summary Trigger Quality Issues Calculation
+         * @param {ActionsApiTriggerQualityIssuesCalculationRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerQualityIssuesCalculation(requestParameters, options) {
+            return localVarFp
+                .triggerQualityIssuesCalculation(requestParameters.workspaceId, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * (EXPERIMENTAL) Updates memory item and returns it
          * @summary (EXPERIMENTAL) Update memory item
@@ -2898,6 +3006,19 @@ export class ActionsApi extends BaseAPI {
             .getQualityIssues(requestParameters.workspaceId, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Returns the status of a quality issues calculation process identified by process ID.
+     * @summary Get Quality Issues Calculation Status
+     * @param {ActionsApiGetQualityIssuesCalculationStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    getQualityIssuesCalculationStatus(requestParameters, options) {
+        return ActionsApiFp(this.configuration)
+            .getQualityIssuesCalculationStatus(requestParameters.workspaceId, requestParameters.processId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
      * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -3002,6 +3123,19 @@ export class ActionsApi extends BaseAPI {
             .tags(requestParameters.workspaceId, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.
+     * @summary Trigger Quality Issues Calculation
+     * @param {ActionsApiTriggerQualityIssuesCalculationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    triggerQualityIssuesCalculation(requestParameters, options) {
+        return ActionsApiFp(this.configuration)
+            .triggerQualityIssuesCalculation(requestParameters.workspaceId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * (EXPERIMENTAL) Updates memory item and returns it
      * @summary (EXPERIMENTAL) Update memory item
@@ -4612,6 +4746,43 @@ export const SmartFunctionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Returns the status of a quality issues calculation process identified by process ID.
+         * @summary Get Quality Issues Calculation Status
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} processId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getQualityIssuesCalculationStatus: async (workspaceId, processId, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            assertParamExists("getQualityIssuesCalculationStatus", "workspaceId", workspaceId);
+            // verify required parameter 'processId' is not null or undefined
+            assertParamExists("getQualityIssuesCalculationStatus", "processId", processId);
+            const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId}`
+                .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
+                .replace(`{${"processId"}}`, encodeURIComponent(String(processId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {
+                ...localVarHeaderParameter,
+                ...headersFromBaseOptions,
+                ...options.headers,
+            };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * (EXPERIMENTAL) Returns a list of memory items
          * @summary (EXPERIMENTAL) List all memory items
@@ -4745,6 +4916,38 @@ export const SmartFunctionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.
+         * @summary Trigger Quality Issues Calculation
+         * @param {string} workspaceId Workspace identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerQualityIssuesCalculation: async (workspaceId, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            assertParamExists("triggerQualityIssuesCalculation", "workspaceId", workspaceId);
+            const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {
+                ...localVarHeaderParameter,
+                ...headersFromBaseOptions,
+                ...options.headers,
+            };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * (EXPERIMENTAL) Updates memory item and returns it
          * @summary (EXPERIMENTAL) Update memory item
@@ -5066,6 +5269,18 @@ export const SmartFunctionsApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getQualityIssues(workspaceId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Returns the status of a quality issues calculation process identified by process ID.
+         * @summary Get Quality Issues Calculation Status
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} processId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getQualityIssuesCalculationStatus(workspaceId, processId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getQualityIssuesCalculationStatus(workspaceId, processId, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * (EXPERIMENTAL) Returns a list of memory items
          * @summary (EXPERIMENTAL) List all memory items
@@ -5111,6 +5326,17 @@ export const SmartFunctionsApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.tags(workspaceId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.
+         * @summary Trigger Quality Issues Calculation
+         * @param {string} workspaceId Workspace identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async triggerQualityIssuesCalculation(workspaceId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.triggerQualityIssuesCalculation(workspaceId, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * (EXPERIMENTAL) Updates memory item and returns it
          * @summary (EXPERIMENTAL) Update memory item
@@ -5336,6 +5562,18 @@ export const SmartFunctionsApiFactory = function (configuration, basePath, axios
                 .getQualityIssues(requestParameters.workspaceId, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Returns the status of a quality issues calculation process identified by process ID.
+         * @summary Get Quality Issues Calculation Status
+         * @param {SmartFunctionsApiGetQualityIssuesCalculationStatusRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getQualityIssuesCalculationStatus(requestParameters, options) {
+            return localVarFp
+                .getQualityIssuesCalculationStatus(requestParameters.workspaceId, requestParameters.processId, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * (EXPERIMENTAL) Returns a list of memory items
          * @summary (EXPERIMENTAL) List all memory items
@@ -5384,6 +5622,18 @@ export const SmartFunctionsApiFactory = function (configuration, basePath, axios
                 .tags(requestParameters.workspaceId, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.
+         * @summary Trigger Quality Issues Calculation
+         * @param {SmartFunctionsApiTriggerQualityIssuesCalculationRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerQualityIssuesCalculation(requestParameters, options) {
+            return localVarFp
+                .triggerQualityIssuesCalculation(requestParameters.workspaceId, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * (EXPERIMENTAL) Updates memory item and returns it
          * @summary (EXPERIMENTAL) Update memory item
@@ -5624,6 +5874,19 @@ export class SmartFunctionsApi extends BaseAPI {
             .getQualityIssues(requestParameters.workspaceId, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Returns the status of a quality issues calculation process identified by process ID.
+     * @summary Get Quality Issues Calculation Status
+     * @param {SmartFunctionsApiGetQualityIssuesCalculationStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SmartFunctionsApi
+     */
+    getQualityIssuesCalculationStatus(requestParameters, options) {
+        return SmartFunctionsApiFp(this.configuration)
+            .getQualityIssuesCalculationStatus(requestParameters.workspaceId, requestParameters.processId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * (EXPERIMENTAL) Returns a list of memory items
      * @summary (EXPERIMENTAL) List all memory items
@@ -5676,6 +5939,19 @@ export class SmartFunctionsApi extends BaseAPI {
             .tags(requestParameters.workspaceId, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.
+     * @summary Trigger Quality Issues Calculation
+     * @param {SmartFunctionsApiTriggerQualityIssuesCalculationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SmartFunctionsApi
+     */
+    triggerQualityIssuesCalculation(requestParameters, options) {
+        return SmartFunctionsApiFp(this.configuration)
+            .triggerQualityIssuesCalculation(requestParameters.workspaceId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * (EXPERIMENTAL) Updates memory item and returns it
      * @summary (EXPERIMENTAL) Update memory item