@aurigma/axios-storefront-api-client 2.24.1 → 2.25.1

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

@@ -64,7 +64,7 @@ export interface IProductReferencesApiClient {
      * @param body (optional) Create operation parameters.
      * @return Success
      */
-    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | undefined): Promise<ProductReferenceDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined): Promise<ProductReferenceDto>;
     /**
      * Returns a storefront product reference.
      * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
@@ -136,7 +136,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
      * @param body (optional) Create operation parameters.
      * @return Success
      */
-    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
     protected processCreate(response: AxiosResponse): Promise<ProductReferenceDto>;
     /**
      * Returns a storefront product reference.
@@ -271,7 +271,7 @@ export interface IProjectsApiClient {
      * @param body (optional) Create operation parameters.
      * @return Success
      */
-    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectDto | undefined): Promise<ProjectDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectDto | null | undefined): Promise<ProjectDto>;
     /**
      * Returns a project by identifier.
      * @param id Project identifier.
@@ -293,7 +293,7 @@ export interface IProjectsApiClient {
      * @param body (optional) Create operation parameters.
      * @return Success
      */
-    createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | undefined): Promise<ProjectDto>;
+    createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | null | undefined): Promise<ProjectDto>;
     /**
      * Returns all available status transitions for a project.
      * @param id Project identifier.
@@ -378,6 +378,14 @@ export interface IProjectsApiClient {
      * @return Success
      */
     getProjectOrder(id: number, tenantId?: number | null | undefined): Promise<any>;
+    /**
+     * Attachs the specified data to the project's order in ecommerce system.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) A list of data items, which should be attached to project's order.
+     * @return Success
+     */
+    attachDataToProjectOrder(id: number, tenantId?: number | null | undefined, body?: OrderDataItemDto[] | null | undefined): Promise<void>;
 }
 export declare class ProjectsApiClient extends ApiClientBase implements IProjectsApiClient {
     private instance;
@@ -408,7 +416,7 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      * @param body (optional) Create operation parameters.
      * @return Success
      */
-    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectDto | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
     protected processCreate(response: AxiosResponse): Promise<ProjectDto>;
     /**
      * Returns a project by identifier.
@@ -433,7 +441,7 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      * @param body (optional) Create operation parameters.
      * @return Success
      */
-    createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
+    createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
     protected processCreateByRenderHiResScenario(response: AxiosResponse): Promise<ProjectDto>;
     /**
      * Returns all available status transitions for a project.
@@ -530,6 +538,15 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      */
     getProjectOrder(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
     protected processGetProjectOrder(response: AxiosResponse): Promise<any>;
+    /**
+     * Attachs the specified data to the project's order in ecommerce system.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) A list of data items, which should be attached to project's order.
+     * @return Success
+     */
+    attachDataToProjectOrder(id: number, tenantId?: number | null | undefined, body?: OrderDataItemDto[] | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    protected processAttachDataToProjectOrder(response: AxiosResponse): Promise<void>;
 }
 export interface IStorefrontsApiClient {
     /**
@@ -597,7 +614,7 @@ export interface IStorefrontUsersApiClient {
      * @param body (optional) Operation parameters.
      * @return Success
      */
-    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateStorefrontUserDto | undefined): Promise<StorefrontUserDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateStorefrontUserDto | null | undefined): Promise<StorefrontUserDto>;
     /**
      * Returns a storefront user by identifier.
      * @param id Storefront user identifier.
@@ -613,7 +630,7 @@ export interface IStorefrontUsersApiClient {
      * @param body (optional) Operation parameters.
      * @return Success
      */
-    register(storefrontId: number, tenantId?: number | null | undefined, body?: RegisterStorefrontUserInput | undefined): Promise<StorefrontUserDto>;
+    register(storefrontId: number, tenantId?: number | null | undefined, body?: RegisterStorefrontUserInput | null | undefined): Promise<StorefrontUserDto>;
     /**
      * Transfers all existing data for the anonymous storefront user to the selected regular storefront user account.
      * @param storefrontId Storefront identifier.
@@ -621,7 +638,7 @@ export interface IStorefrontUsersApiClient {
      * @param body (optional) Operation parameters.
      * @return Success
      */
-    mergeAnonymous(storefrontId: number, tenantId?: number | null | undefined, body?: MergeAnonymousUserDataInput | undefined): Promise<void>;
+    mergeAnonymous(storefrontId: number, tenantId?: number | null | undefined, body?: MergeAnonymousUserDataInput | null | undefined): Promise<void>;
     /**
      * Returns an API access token for the specified storefront user.
      * @param storefrontUserId Storefront user identifier.
@@ -656,7 +673,7 @@ export declare class StorefrontUsersApiClient extends ApiClientBase implements I
      * @param body (optional) Operation parameters.
      * @return Success
      */
-    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateStorefrontUserDto | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontUserDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateStorefrontUserDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontUserDto>;
     protected processCreate(response: AxiosResponse): Promise<StorefrontUserDto>;
     /**
      * Returns a storefront user by identifier.
@@ -674,7 +691,7 @@ export declare class StorefrontUsersApiClient extends ApiClientBase implements I
      * @param body (optional) Operation parameters.
      * @return Success
      */
-    register(storefrontId: number, tenantId?: number | null | undefined, body?: RegisterStorefrontUserInput | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontUserDto>;
+    register(storefrontId: number, tenantId?: number | null | undefined, body?: RegisterStorefrontUserInput | null | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontUserDto>;
     protected processRegister(response: AxiosResponse): Promise<StorefrontUserDto>;
     /**
      * Transfers all existing data for the anonymous storefront user to the selected regular storefront user account.
@@ -683,7 +700,7 @@ export declare class StorefrontUsersApiClient extends ApiClientBase implements I
      * @param body (optional) Operation parameters.
      * @return Success
      */
-    mergeAnonymous(storefrontId: number, tenantId?: number | null | undefined, body?: MergeAnonymousUserDataInput | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    mergeAnonymous(storefrontId: number, tenantId?: number | null | undefined, body?: MergeAnonymousUserDataInput | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processMergeAnonymous(response: AxiosResponse): Promise<void>;
     /**
      * Returns an API access token for the specified storefront user.
@@ -856,6 +873,7 @@ export interface ProjectItemResourceDto {
     resourceId?: string | null;
     /** Resource name. */
     name?: string | null;
+    /** Resource type. */
     type?: ProjectItemResourceType;
 }
 /** Dto class, containing information about a project item. */
@@ -929,6 +947,7 @@ export interface ProjectItemResourceParametersDto {
     url?: string | null;
     /** Resource name. */
     name?: string | null;
+    /** Resource type. */
     type?: ProjectItemResourceType;
 }
 /** Dto class, containing create operation paramters for a project item. */
@@ -1019,9 +1038,12 @@ export interface RenderHiResScenarioDto {
     name?: string | null;
     /** Output file DPI. */
     dpi?: number;
-    format?: RenderHiResScenarioOutputFormat;
-    colorSpace?: RenderHiResScenarioOutputColorSpace;
-    flipMode?: RenderHiResScenarioOutputFlipMode;
+    /** Output file format. */
+    format?: RenderHiResScenarioOutputFormat | null;
+    /** Output file color space. */
+    colorSpace?: RenderHiResScenarioOutputColorSpace | null;
+    /** Output file flip mode. */
+    flipMode?: RenderHiResScenarioOutputFlipMode | null;
     /** Output file access mode. */
     anonymousAccess?: boolean | null;
 }
@@ -1033,7 +1055,9 @@ export interface CreateProjectByRenderHiResScenarioDto {
     name?: string | null;
     /** Description of the project. */
     description?: string | null;
-    orderDetails?: OrderDetailsDto;
+    /** Ecommerce system order description. */
+    orderDetails?: OrderDetailsDto | null;
+    /** List of project items. */
     scenario: RenderHiResScenarioDto;
 }
 /** Project transition dto class. */
@@ -1100,12 +1124,28 @@ export interface ProjectOutputFileDetailsDto {
 }
 /** Dto class, containing description of project processing results. */
 export interface ProjectProcessingResultsDto {
+    /** Project processing status. */
     status?: ProjectProcessingStatus;
     /** Project status description. */
     statusDescription?: string | null;
     /** Collection of project output file descriptions. */
     outputFileDetails?: ProjectOutputFileDetailsDto[] | null;
 }
+/** Available value types for order data item. */
+export declare enum OrderDataItemValueType {
+    PlainText = "PlainText",
+    CommaSeparatedList = "CommaSeparatedList",
+    SerializedJson = "SerializedJson"
+}
+/** Dto class, containing information about project's order data item. */
+export interface OrderDataItemDto {
+    /** Order data item key (eventuall order metadata field name). */
+    key?: string | null;
+    /** Order data item value. */
+    value?: string | null;
+    /** Order data item type. */
+    type?: OrderDataItemValueType;
+}
 /** Storefront types. */
 export declare enum StorefrontType {
     Custom = "Custom",
@@ -1126,6 +1166,7 @@ export interface StorefrontDto {
     tenantId?: number;
     /** Storefront name. */
     name?: string | null;
+    /** Storefront ecommerce system type. */
     type?: StorefrontType;
     /** Storefront entity creation date and time. */
     created?: string;

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

@@ -2198,6 +2198,79 @@ export class ProjectsApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Attachs the specified data to the project's order in ecommerce system.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) A list of data items, which should be attached to project's order.
+     * @return Success
+     */
+    attachDataToProjectOrder(id, tenantId, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/storefront/v1/projects/{id}/order-data?";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (tenantId !== undefined && tenantId !== null)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        const content_ = JSON.stringify(body);
+        let options_ = {
+            data: content_,
+            method: "POST",
+            url: url_,
+            headers: {
+                "Content-Type": "application/json-patch+json",
+            },
+            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.processAttachDataToProjectOrder(_response));
+        });
+    }
+    processAttachDataToProjectOrder(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 === 204) {
+            const _responseText = response.data;
+            return Promise.resolve(null);
+        }
+        else if (status === 404) {
+            const _responseText = response.data;
+            let result404 = null;
+            let resultData404 = _responseText;
+            result404 = JSON.parse(resultData404);
+            return throwException("Not Found", status, _responseText, _headers, result404);
+        }
+        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);
+    }
 }
 export class StorefrontsApiClient extends ApiClientBase {
     instance;
@@ -3091,6 +3164,13 @@ export var ProjectProcessingStatus;
     ProjectProcessingStatus["Completed"] = "Completed";
     ProjectProcessingStatus["Failed"] = "Failed";
 })(ProjectProcessingStatus || (ProjectProcessingStatus = {}));
+/** Available value types for order data item. */
+export var OrderDataItemValueType;
+(function (OrderDataItemValueType) {
+    OrderDataItemValueType["PlainText"] = "PlainText";
+    OrderDataItemValueType["CommaSeparatedList"] = "CommaSeparatedList";
+    OrderDataItemValueType["SerializedJson"] = "SerializedJson";
+})(OrderDataItemValueType || (OrderDataItemValueType = {}));
 /** Storefront types. */
 export var StorefrontType;
 (function (StorefrontType) {