@aurigma/axios-storefront-api-client 2.51.1 → 2.52.2

package/dist/cjs/storefront-api-client.d.ts

@@ -338,11 +338,12 @@ export interface IProjectsApiClient {
      * @param search (optional) Search string for partial match.
      * @param orderId (optional) Identifier of corresponding order.
      * @param processingStatus (optional) Project processing status filter.
+     * @param includeObsolete (optional) Indicates if obsolete projects prepared to be removed should be included to result.
      * @param storefrontId (optional) Storefront identifier.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, processingStatus?: ProjectProcessingStatus | null | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProjectDto>;
+    getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, processingStatus?: ProjectProcessingStatus | null | undefined, includeObsolete?: boolean | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProjectDto>;
     /**
      * Returns a project by identifier.
      * @param id Project identifier.
@@ -426,6 +427,14 @@ export interface IProjectsApiClient {
      * @return Success
      */
     forceStatus(id: number, status: number, tenantId?: number | null | undefined): Promise<ProjectStatusDto>;
+    /**
+     * Deletes specified projects.
+    These projects will be hide from projects list immediately, but complete projects data cleaning will take some additional time.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional)
+     * @return Success
+     */
+    batchDelete(tenantId?: number | null | undefined, body?: BatchDeleteProjectsInput | null | undefined): Promise<PagedOfProjectStatusDto>;
     /**
      * Returns a list of all existing project statuses.
      * @param tenantId (optional) Tenant identifier.
@@ -517,11 +526,12 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      * @param search (optional) Search string for partial match.
      * @param orderId (optional) Identifier of corresponding order.
      * @param processingStatus (optional) Project processing status filter.
+     * @param includeObsolete (optional) Indicates if obsolete projects prepared to be removed should be included to result.
      * @param storefrontId (optional) Storefront identifier.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, processingStatus?: ProjectProcessingStatus | null | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectDto>;
+    getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, processingStatus?: ProjectProcessingStatus | null | undefined, includeObsolete?: boolean | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectDto>;
     protected processGetAll(response: AxiosResponse): Promise<PagedOfProjectDto>;
     /**
      * Returns a project by identifier.
@@ -617,6 +627,15 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      */
     forceStatus(id: number, status: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusDto>;
     protected processForceStatus(response: AxiosResponse): Promise<ProjectStatusDto>;
+    /**
+     * Deletes specified projects.
+    These projects will be hide from projects list immediately, but complete projects data cleaning will take some additional time.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional)
+     * @return Success
+     */
+    batchDelete(tenantId?: number | null | undefined, body?: BatchDeleteProjectsInput | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusDto>;
+    protected processBatchDelete(response: AxiosResponse): Promise<PagedOfProjectStatusDto>;
     /**
      * Returns a list of all existing project statuses.
      * @param tenantId (optional) Tenant identifier.
@@ -1159,6 +1178,11 @@ export interface PagedOfProjectDto {
     /** Items list. */
     items?: ProjectDto[] | null;
 }
+/** Conflict descritpion. */
+export interface ConflictDto {
+    /** Conflict description. */
+    description?: string | null;
+}
 /** Dto class, containing create operation parameters for a project item resource. */
 export interface ProjectItemResourceParametersDto {
     /** Resource URL. */
@@ -1360,11 +1384,6 @@ export interface PagedOfProjectTransitionDto {
     /** Items list. */
     items?: ProjectTransitionDto[] | null;
 }
-/** Dto class, containing information about the project transition conflict. */
-export interface ProjectTransitionConflictDto {
-    /** A list of all available status transitions for the project. */
-    availableTransitions?: ProjectTransitionDto[] | null;
-}
 /** Dto class, containing the information about project status. */
 export interface ProjectStatusDto {
     /** Status code. */
@@ -1372,6 +1391,18 @@ export interface ProjectStatusDto {
     /** Status display name. */
     displayName?: string | null;
 }
+/** Dto class, containing information about the project transition conflict. */
+export interface ProjectTransitionConflictDto {
+    /** A list of all available status transitions for the project. */
+    availableTransitions?: ProjectTransitionDto[] | null;
+    /** Conflict description. */
+    description?: string | null;
+}
+/** Dto class, containing parameters for the 'projects batch delete' operation. */
+export interface BatchDeleteProjectsInput {
+    /** Identifiers of projects that should be deleted. */
+    ids?: number[] | null;
+}
 /** Paged list of items. */
 export interface PagedOfProjectStatusDto {
     /** Items count. */

package/dist/cjs/storefront-api-client.js

@@ -1301,11 +1301,12 @@ class ProjectsApiClient extends ApiClientBase {
      * @param search (optional) Search string for partial match.
      * @param orderId (optional) Identifier of corresponding order.
      * @param processingStatus (optional) Project processing status filter.
+     * @param includeObsolete (optional) Indicates if obsolete projects prepared to be removed should be included to result.
      * @param storefrontId (optional) Storefront identifier.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAll(ownerId, productReference, status, datePeriod, skip, take, sorting, search, orderId, processingStatus, storefrontId, tenantId, cancelToken) {
+    getAll(ownerId, productReference, status, datePeriod, skip, take, sorting, search, orderId, processingStatus, includeObsolete, storefrontId, tenantId, cancelToken) {
         let url_ = this.baseUrl + "/api/storefront/v1/projects?";
         if (ownerId !== undefined && ownerId !== null)
             url_ += "ownerId=" + encodeURIComponent("" + ownerId) + "&";
@@ -1329,6 +1330,10 @@ class ProjectsApiClient extends ApiClientBase {
             url_ += "orderId=" + encodeURIComponent("" + orderId) + "&";
         if (processingStatus !== undefined && processingStatus !== null)
             url_ += "processingStatus=" + encodeURIComponent("" + processingStatus) + "&";
+        if (includeObsolete === null)
+            throw new Error("The parameter 'includeObsolete' cannot be null.");
+        else if (includeObsolete !== undefined)
+            url_ += "includeObsolete=" + encodeURIComponent("" + includeObsolete) + "&";
         if (storefrontId !== undefined && storefrontId !== null)
             url_ += "storefrontId=" + encodeURIComponent("" + storefrontId) + "&";
         if (tenantId !== undefined && tenantId !== null)
@@ -1445,6 +1450,13 @@ class ProjectsApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -1513,6 +1525,13 @@ class ProjectsApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -1586,6 +1605,13 @@ class ProjectsApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -1659,6 +1685,13 @@ class ProjectsApiClient extends ApiClientBase {
             result404 = resultData404;
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = resultData409;
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -2261,6 +2294,80 @@ class ProjectsApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
+        else if (status === 401) {
+            const _responseText = response.data;
+            return throwException("Unauthorized", status, _responseText, _headers);
+        }
+        else if (status === 403) {
+            const _responseText = response.data;
+            return throwException("Forbidden", status, _responseText, _headers);
+        }
+        else if (status !== 200 && status !== 204) {
+            const _responseText = response.data;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return Promise.resolve(null);
+    }
+    /**
+     * Deletes specified projects.
+    These projects will be hide from projects list immediately, but complete projects data cleaning will take some additional time.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional)
+     * @return Success
+     */
+    batchDelete(tenantId, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/storefront/v1/projects/batch-delete?";
+        if (tenantId !== undefined && tenantId !== null)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        const content_ = JSON.stringify(body);
+        let options_ = {
+            data: content_,
+            method: "DELETE",
+            url: url_,
+            headers: {
+                "Content-Type": "application/json-patch+json",
+                "Accept": "text/plain"
+            },
+            cancelToken
+        };
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.instance.request(transformedOptions_);
+        }).catch((_error) => {
+            if (isAxiosError(_error) && _error.response) {
+                return _error.response;
+            }
+            else {
+                throw _error;
+            }
+        }).then((_response) => {
+            return this.transformResult(url_, _response, (_response) => this.processBatchDelete(_response));
+        });
+    }
+    processBatchDelete(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && typeof response.headers === "object") {
+            for (let k in response.headers) {
+                if (response.headers.hasOwnProperty(k)) {
+                    _headers[k] = response.headers[k];
+                }
+            }
+        }
+        if (status === 200) {
+            const _responseText = response.data;
+            let result200 = null;
+            let resultData200 = _responseText;
+            result200 = JSON.parse(resultData200);
+            return Promise.resolve(result200);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -2462,6 +2569,13 @@ class ProjectsApiClient extends ApiClientBase {
             result200 = JSON.parse(resultData200);
             return Promise.resolve(result200);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -2549,6 +2663,13 @@ class ProjectsApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -2625,6 +2746,13 @@ class ProjectsApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -2696,6 +2824,13 @@ class ProjectsApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -2767,6 +2902,13 @@ class ProjectsApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -2840,6 +2982,13 @@ class ProjectsApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -2916,6 +3065,13 @@ class ProjectsApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -3077,6 +3233,13 @@ class StorefrontsApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -3326,6 +3489,13 @@ class StorefrontUsersApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);