@gooddata/api-client-tiger 10.26.0-alpha.9 → 10.26.0

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

@@ -546,6 +546,47 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is canceled.
+         * @summary Applies all the given cancel tokens.
+         * @param {string} workspaceId Workspace identifier
+         * @param {AfmCancelTokens} afmCancelTokens
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        cancelExecutions: async (workspaceId, afmCancelTokens, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            assertParamExists("cancelExecutions", "workspaceId", workspaceId);
+            // verify required parameter 'afmCancelTokens' is not null or undefined
+            assertParamExists("cancelExecutions", "afmCancelTokens", afmCancelTokens);
+            const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel`.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 afmCancelTokens !== "string" ||
+                localVarRequestOptions.headers["Content-Type"] === "application/json";
+            localVarRequestOptions.data = needsSerialization
+                ? JSON.stringify(afmCancelTokens !== undefined ? afmCancelTokens : {})
+                : afmCancelTokens || "";
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
          * @summary (EXPERIMENTAL) Smart functions - Clustering
@@ -1100,10 +1141,11 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
          * @param {Array<number>} [offset] Request page with these offsets. Format is offset&#x3D;1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.
          * @param {Array<number>} [limit] Return only this number of items. Format is limit&#x3D;1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.
          * @param {Array<string>} [excludedTotalDimensions] Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.
+         * @param {string} [xGDCCANCELTOKEN]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        retrieveResult: async (workspaceId, resultId, offset, limit, excludedTotalDimensions, options = {}) => {
+        retrieveResult: async (workspaceId, resultId, offset, limit, excludedTotalDimensions, xGDCCANCELTOKEN, options = {}) => {
             // verify required parameter 'workspaceId' is not null or undefined
             assertParamExists("retrieveResult", "workspaceId", workspaceId);
             // verify required parameter 'resultId' is not null or undefined
@@ -1129,6 +1171,9 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
             if (excludedTotalDimensions) {
                 localVarQueryParameter["excludedTotalDimensions"] = excludedTotalDimensions.join(COLLECTION_FORMATS.csv);
             }
+            if (xGDCCANCELTOKEN !== undefined && xGDCCANCELTOKEN !== null) {
+                localVarHeaderParameter["X-GDC-CANCEL-TOKEN"] = String(xGDCCANCELTOKEN);
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {
@@ -1226,6 +1271,18 @@ export const ActionsApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.anomalyDetectionResult(workspaceId, resultId, offset, limit, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is canceled.
+         * @summary Applies all the given cancel tokens.
+         * @param {string} workspaceId Workspace identifier
+         * @param {AfmCancelTokens} afmCancelTokens
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async cancelExecutions(workspaceId, afmCancelTokens, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.cancelExecutions(workspaceId, afmCancelTokens, 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
@@ -1395,11 +1452,12 @@ export const ActionsApiFp = function (configuration) {
          * @param {Array<number>} [offset] Request page with these offsets. Format is offset&#x3D;1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.
          * @param {Array<number>} [limit] Return only this number of items. Format is limit&#x3D;1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.
          * @param {Array<string>} [excludedTotalDimensions] Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.
+         * @param {string} [xGDCCANCELTOKEN]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async retrieveResult(workspaceId, resultId, offset, limit, excludedTotalDimensions, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveResult(workspaceId, resultId, offset, limit, excludedTotalDimensions, options);
+        async retrieveResult(workspaceId, resultId, offset, limit, excludedTotalDimensions, xGDCCANCELTOKEN, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveResult(workspaceId, resultId, offset, limit, excludedTotalDimensions, xGDCCANCELTOKEN, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     };
@@ -1483,6 +1541,18 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
                 .anomalyDetectionResult(requestParameters.workspaceId, requestParameters.resultId, requestParameters.offset, requestParameters.limit, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is canceled.
+         * @summary Applies all the given cancel tokens.
+         * @param {ActionsApiCancelExecutionsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        cancelExecutions(requestParameters, options) {
+            return localVarFp
+                .cancelExecutions(requestParameters.workspaceId, requestParameters.afmCancelTokens, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
          * @summary (EXPERIMENTAL) Smart functions - Clustering
@@ -1636,7 +1706,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
          */
         retrieveResult(requestParameters, options) {
             return localVarFp
-                .retrieveResult(requestParameters.workspaceId, requestParameters.resultId, requestParameters.offset, requestParameters.limit, requestParameters.excludedTotalDimensions, options)
+                .retrieveResult(requestParameters.workspaceId, requestParameters.resultId, requestParameters.offset, requestParameters.limit, requestParameters.excludedTotalDimensions, requestParameters.xGDCCANCELTOKEN, options)
                 .then((request) => request(axios, basePath));
         },
     };
@@ -1726,6 +1796,19 @@ export class ActionsApi extends BaseAPI {
             .anomalyDetectionResult(requestParameters.workspaceId, requestParameters.resultId, requestParameters.offset, requestParameters.limit, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is canceled.
+     * @summary Applies all the given cancel tokens.
+     * @param {ActionsApiCancelExecutionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    cancelExecutions(requestParameters, options) {
+        return ActionsApiFp(this.configuration)
+            .cancelExecutions(requestParameters.workspaceId, requestParameters.afmCancelTokens, 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
@@ -1892,7 +1975,7 @@ export class ActionsApi extends BaseAPI {
      */
     retrieveResult(requestParameters, options) {
         return ActionsApiFp(this.configuration)
-            .retrieveResult(requestParameters.workspaceId, requestParameters.resultId, requestParameters.offset, requestParameters.limit, requestParameters.excludedTotalDimensions, options)
+            .retrieveResult(requestParameters.workspaceId, requestParameters.resultId, requestParameters.offset, requestParameters.limit, requestParameters.excludedTotalDimensions, requestParameters.xGDCCANCELTOKEN, options)
             .then((request) => request(this.axios, this.basePath));
     }
 }
@@ -2266,10 +2349,11 @@ export const ComputationApiAxiosParamCreator = function (configuration) {
          * @param {Array<number>} [offset] Request page with these offsets. Format is offset&#x3D;1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.
          * @param {Array<number>} [limit] Return only this number of items. Format is limit&#x3D;1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.
          * @param {Array<string>} [excludedTotalDimensions] Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.
+         * @param {string} [xGDCCANCELTOKEN]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        retrieveResult: async (workspaceId, resultId, offset, limit, excludedTotalDimensions, options = {}) => {
+        retrieveResult: async (workspaceId, resultId, offset, limit, excludedTotalDimensions, xGDCCANCELTOKEN, options = {}) => {
             // verify required parameter 'workspaceId' is not null or undefined
             assertParamExists("retrieveResult", "workspaceId", workspaceId);
             // verify required parameter 'resultId' is not null or undefined
@@ -2295,6 +2379,9 @@ export const ComputationApiAxiosParamCreator = function (configuration) {
             if (excludedTotalDimensions) {
                 localVarQueryParameter["excludedTotalDimensions"] = excludedTotalDimensions.join(COLLECTION_FORMATS.csv);
             }
+            if (xGDCCANCELTOKEN !== undefined && xGDCCANCELTOKEN !== null) {
+                localVarHeaderParameter["X-GDC-CANCEL-TOKEN"] = String(xGDCCANCELTOKEN);
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {
@@ -2429,11 +2516,12 @@ export const ComputationApiFp = function (configuration) {
          * @param {Array<number>} [offset] Request page with these offsets. Format is offset&#x3D;1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.
          * @param {Array<number>} [limit] Return only this number of items. Format is limit&#x3D;1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.
          * @param {Array<string>} [excludedTotalDimensions] Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.
+         * @param {string} [xGDCCANCELTOKEN]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async retrieveResult(workspaceId, resultId, offset, limit, excludedTotalDimensions, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveResult(workspaceId, resultId, offset, limit, excludedTotalDimensions, options);
+        async retrieveResult(workspaceId, resultId, offset, limit, excludedTotalDimensions, xGDCCANCELTOKEN, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveResult(workspaceId, resultId, offset, limit, excludedTotalDimensions, xGDCCANCELTOKEN, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     };
@@ -2550,7 +2638,7 @@ export const ComputationApiFactory = function (configuration, basePath, axios) {
          */
         retrieveResult(requestParameters, options) {
             return localVarFp
-                .retrieveResult(requestParameters.workspaceId, requestParameters.resultId, requestParameters.offset, requestParameters.limit, requestParameters.excludedTotalDimensions, options)
+                .retrieveResult(requestParameters.workspaceId, requestParameters.resultId, requestParameters.offset, requestParameters.limit, requestParameters.excludedTotalDimensions, requestParameters.xGDCCANCELTOKEN, options)
                 .then((request) => request(axios, basePath));
         },
     };
@@ -2676,7 +2764,7 @@ export class ComputationApi extends BaseAPI {
      */
     retrieveResult(requestParameters, options) {
         return ComputationApiFp(this.configuration)
-            .retrieveResult(requestParameters.workspaceId, requestParameters.resultId, requestParameters.offset, requestParameters.limit, requestParameters.excludedTotalDimensions, options)
+            .retrieveResult(requestParameters.workspaceId, requestParameters.resultId, requestParameters.offset, requestParameters.limit, requestParameters.excludedTotalDimensions, requestParameters.xGDCCANCELTOKEN, options)
             .then((request) => request(this.axios, this.basePath));
     }
 }