@gooddata/api-client-tiger 11.3.0-alpha.1 → 11.3.0-alpha.3

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

@@ -221,6 +221,29 @@ 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 RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = {
     BETWEEN: "BETWEEN",
     NOT_BETWEEN: "NOT_BETWEEN",
@@ -639,6 +662,84 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Computes change analysis for the provided execution definition.
+         * @summary Compute change analysis
+         * @param {string} workspaceId Workspace identifier
+         * @param {ChangeAnalysisRequest} changeAnalysisRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        changeAnalysis: async (workspaceId, changeAnalysisRequest, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            assertParamExists("changeAnalysis", "workspaceId", workspaceId);
+            // verify required parameter 'changeAnalysisRequest' is not null or undefined
+            assertParamExists("changeAnalysis", "changeAnalysisRequest", changeAnalysisRequest);
+            const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis`.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 = {};
+            localVarHeaderParameter["Content-Type"] = "application/json";
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {
+                ...localVarHeaderParameter,
+                ...headersFromBaseOptions,
+                ...options.headers,
+            };
+            const needsSerialization = typeof changeAnalysisRequest !== "string" ||
+                localVarRequestOptions.headers["Content-Type"] === "application/json";
+            localVarRequestOptions.data = needsSerialization
+                ? JSON.stringify(changeAnalysisRequest !== undefined ? changeAnalysisRequest : {})
+                : changeAnalysisRequest || "";
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Gets change analysis result.
+         * @summary Get change analysis result
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} resultId Result ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        changeAnalysisResult: async (workspaceId, resultId, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            assertParamExists("changeAnalysisResult", "workspaceId", workspaceId);
+            // verify required parameter 'resultId' is not null or undefined
+            assertParamExists("changeAnalysisResult", "resultId", resultId);
+            const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId}`
+                .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
+                .replace(`{${"resultId"}}`, encodeURIComponent(String(resultId)));
+            // 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 clusters for data points from the provided execution result and parameters.
          * @summary (EXPERIMENTAL) Smart functions - Clustering
@@ -1744,6 +1845,30 @@ export const ActionsApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.cancelExecutions(workspaceId, afmCancelTokens, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Computes change analysis for the provided execution definition.
+         * @summary Compute change analysis
+         * @param {string} workspaceId Workspace identifier
+         * @param {ChangeAnalysisRequest} changeAnalysisRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async changeAnalysis(workspaceId, changeAnalysisRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.changeAnalysis(workspaceId, changeAnalysisRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Gets change analysis result.
+         * @summary Get change analysis result
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} resultId Result ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async changeAnalysisResult(workspaceId, resultId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.changeAnalysisResult(workspaceId, resultId, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
          * @summary (EXPERIMENTAL) Smart functions - Clustering
@@ -2153,6 +2278,30 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
                 .cancelExecutions(requestParameters.workspaceId, requestParameters.afmCancelTokens, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Computes change analysis for the provided execution definition.
+         * @summary Compute change analysis
+         * @param {ActionsApiChangeAnalysisRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        changeAnalysis(requestParameters, options) {
+            return localVarFp
+                .changeAnalysis(requestParameters.workspaceId, requestParameters.changeAnalysisRequest, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * Gets change analysis result.
+         * @summary Get change analysis result
+         * @param {ActionsApiChangeAnalysisResultRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        changeAnalysisResult(requestParameters, options) {
+            return localVarFp
+                .changeAnalysisResult(requestParameters.workspaceId, requestParameters.resultId, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
          * @summary (EXPERIMENTAL) Smart functions - Clustering
@@ -2554,6 +2703,32 @@ export class ActionsApi extends BaseAPI {
             .cancelExecutions(requestParameters.workspaceId, requestParameters.afmCancelTokens, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {ActionsApiChangeAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    changeAnalysis(requestParameters, options) {
+        return ActionsApiFp(this.configuration)
+            .changeAnalysis(requestParameters.workspaceId, requestParameters.changeAnalysisRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {ActionsApiChangeAnalysisResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    changeAnalysisResult(requestParameters, options) {
+        return ActionsApiFp(this.configuration)
+            .changeAnalysisResult(requestParameters.workspaceId, requestParameters.resultId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
      * @summary (EXPERIMENTAL) Smart functions - Clustering
@@ -2873,6 +3048,84 @@ export class ActionsApi extends BaseAPI {
  */
 export const ComputationApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         * Computes change analysis for the provided execution definition.
+         * @summary Compute change analysis
+         * @param {string} workspaceId Workspace identifier
+         * @param {ChangeAnalysisRequest} changeAnalysisRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        changeAnalysis: async (workspaceId, changeAnalysisRequest, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            assertParamExists("changeAnalysis", "workspaceId", workspaceId);
+            // verify required parameter 'changeAnalysisRequest' is not null or undefined
+            assertParamExists("changeAnalysis", "changeAnalysisRequest", changeAnalysisRequest);
+            const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis`.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 = {};
+            localVarHeaderParameter["Content-Type"] = "application/json";
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {
+                ...localVarHeaderParameter,
+                ...headersFromBaseOptions,
+                ...options.headers,
+            };
+            const needsSerialization = typeof changeAnalysisRequest !== "string" ||
+                localVarRequestOptions.headers["Content-Type"] === "application/json";
+            localVarRequestOptions.data = needsSerialization
+                ? JSON.stringify(changeAnalysisRequest !== undefined ? changeAnalysisRequest : {})
+                : changeAnalysisRequest || "";
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Gets change analysis result.
+         * @summary Get change analysis result
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} resultId Result ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        changeAnalysisResult: async (workspaceId, resultId, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            assertParamExists("changeAnalysisResult", "workspaceId", workspaceId);
+            // verify required parameter 'resultId' is not null or undefined
+            assertParamExists("changeAnalysisResult", "resultId", resultId);
+            const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId}`
+                .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
+                .replace(`{${"resultId"}}`, encodeURIComponent(String(resultId)));
+            // 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,
+            };
+        },
         /**
          * Returns paged list of elements (values) of given label satisfying given filtering criteria.
          * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -3291,6 +3544,30 @@ export const ComputationApiAxiosParamCreator = function (configuration) {
 export const ComputationApiFp = function (configuration) {
     const localVarAxiosParamCreator = ComputationApiAxiosParamCreator(configuration);
     return {
+        /**
+         * Computes change analysis for the provided execution definition.
+         * @summary Compute change analysis
+         * @param {string} workspaceId Workspace identifier
+         * @param {ChangeAnalysisRequest} changeAnalysisRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async changeAnalysis(workspaceId, changeAnalysisRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.changeAnalysis(workspaceId, changeAnalysisRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Gets change analysis result.
+         * @summary Get change analysis result
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} resultId Result ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async changeAnalysisResult(workspaceId, resultId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.changeAnalysisResult(workspaceId, resultId, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Returns paged list of elements (values) of given label satisfying given filtering criteria.
          * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -3421,6 +3698,30 @@ export const ComputationApiFp = function (configuration) {
 export const ComputationApiFactory = function (configuration, basePath, axios) {
     const localVarFp = ComputationApiFp(configuration);
     return {
+        /**
+         * Computes change analysis for the provided execution definition.
+         * @summary Compute change analysis
+         * @param {ComputationApiChangeAnalysisRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        changeAnalysis(requestParameters, options) {
+            return localVarFp
+                .changeAnalysis(requestParameters.workspaceId, requestParameters.changeAnalysisRequest, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * Gets change analysis result.
+         * @summary Get change analysis result
+         * @param {ComputationApiChangeAnalysisResultRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        changeAnalysisResult(requestParameters, options) {
+            return localVarFp
+                .changeAnalysisResult(requestParameters.workspaceId, requestParameters.resultId, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * Returns paged list of elements (values) of given label satisfying given filtering criteria.
          * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -3538,6 +3839,32 @@ export const ComputationApiFactory = function (configuration, basePath, axios) {
  * @extends {BaseAPI}
  */
 export class ComputationApi extends BaseAPI {
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {ComputationApiChangeAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComputationApi
+     */
+    changeAnalysis(requestParameters, options) {
+        return ComputationApiFp(this.configuration)
+            .changeAnalysis(requestParameters.workspaceId, requestParameters.changeAnalysisRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {ComputationApiChangeAnalysisResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComputationApi
+     */
+    changeAnalysisResult(requestParameters, options) {
+        return ComputationApiFp(this.configuration)
+            .changeAnalysisResult(requestParameters.workspaceId, requestParameters.resultId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns paged list of elements (values) of given label satisfying given filtering criteria.
      * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.