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

package/lib/storefront-api-client.d.ts

@@ -67,7 +67,7 @@ export interface IProductReferencesApiClient {
      * @param body (optional) Create operation parameters.
      * @return Success
      */
-    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | undefined): Observable<ProductReferenceDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined): Observable<ProductReferenceDto>;
     /**
      * Returns a storefront product reference.
      * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
@@ -139,7 +139,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): Observable<ProductReferenceDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined): Observable<ProductReferenceDto>;
     protected processCreate(response: HttpResponseBase): Observable<ProductReferenceDto>;
     /**
      * Returns a storefront product reference.
@@ -274,7 +274,7 @@ export interface IProjectsApiClient {
      * @param body (optional) Create operation parameters.
      * @return Success
      */
-    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectDto | undefined): Observable<ProjectDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectDto | null | undefined): Observable<ProjectDto>;
     /**
      * Returns a project by identifier.
      * @param id Project identifier.
@@ -296,7 +296,7 @@ export interface IProjectsApiClient {
      * @param body (optional) Create operation parameters.
      * @return Success
      */
-    createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | undefined): Observable<ProjectDto>;
+    createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | null | undefined): Observable<ProjectDto>;
     /**
      * Returns all available status transitions for a project.
      * @param id Project identifier.
@@ -381,6 +381,14 @@ export interface IProjectsApiClient {
      * @return Success
      */
     getProjectOrder(id: number, tenantId?: number | null | undefined): Observable<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): Observable<void>;
 }
 export declare class ProjectsApiClient extends ApiClientBase implements IProjectsApiClient {
     private http;
@@ -411,7 +419,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): Observable<ProjectDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectDto | null | undefined): Observable<ProjectDto>;
     protected processCreate(response: HttpResponseBase): Observable<ProjectDto>;
     /**
      * Returns a project by identifier.
@@ -436,7 +444,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): Observable<ProjectDto>;
+    createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | null | undefined): Observable<ProjectDto>;
     protected processCreateByRenderHiResScenario(response: HttpResponseBase): Observable<ProjectDto>;
     /**
      * Returns all available status transitions for a project.
@@ -533,6 +541,15 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      */
     getProjectOrder(id: number, tenantId?: number | null | undefined): Observable<any>;
     protected processGetProjectOrder(response: HttpResponseBase): Observable<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): Observable<void>;
+    protected processAttachDataToProjectOrder(response: HttpResponseBase): Observable<void>;
 }
 export interface IStorefrontsApiClient {
     /**
@@ -600,7 +617,7 @@ export interface IStorefrontUsersApiClient {
      * @param body (optional) Operation parameters.
      * @return Success
      */
-    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateStorefrontUserDto | undefined): Observable<StorefrontUserDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateStorefrontUserDto | null | undefined): Observable<StorefrontUserDto>;
     /**
      * Returns a storefront user by identifier.
      * @param id Storefront user identifier.
@@ -616,7 +633,7 @@ export interface IStorefrontUsersApiClient {
      * @param body (optional) Operation parameters.
      * @return Success
      */
-    register(storefrontId: number, tenantId?: number | null | undefined, body?: RegisterStorefrontUserInput | undefined): Observable<StorefrontUserDto>;
+    register(storefrontId: number, tenantId?: number | null | undefined, body?: RegisterStorefrontUserInput | null | undefined): Observable<StorefrontUserDto>;
     /**
      * Transfers all existing data for the anonymous storefront user to the selected regular storefront user account.
      * @param storefrontId Storefront identifier.
@@ -624,7 +641,7 @@ export interface IStorefrontUsersApiClient {
      * @param body (optional) Operation parameters.
      * @return Success
      */
-    mergeAnonymous(storefrontId: number, tenantId?: number | null | undefined, body?: MergeAnonymousUserDataInput | undefined): Observable<void>;
+    mergeAnonymous(storefrontId: number, tenantId?: number | null | undefined, body?: MergeAnonymousUserDataInput | null | undefined): Observable<void>;
     /**
      * Returns an API access token for the specified storefront user.
      * @param storefrontUserId Storefront user identifier.
@@ -659,7 +676,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): Observable<StorefrontUserDto>;
+    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateStorefrontUserDto | null | undefined): Observable<StorefrontUserDto>;
     protected processCreate(response: HttpResponseBase): Observable<StorefrontUserDto>;
     /**
      * Returns a storefront user by identifier.
@@ -677,7 +694,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): Observable<StorefrontUserDto>;
+    register(storefrontId: number, tenantId?: number | null | undefined, body?: RegisterStorefrontUserInput | null | undefined): Observable<StorefrontUserDto>;
     protected processRegister(response: HttpResponseBase): Observable<StorefrontUserDto>;
     /**
      * Transfers all existing data for the anonymous storefront user to the selected regular storefront user account.
@@ -686,7 +703,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): Observable<void>;
+    mergeAnonymous(storefrontId: number, tenantId?: number | null | undefined, body?: MergeAnonymousUserDataInput | null | undefined): Observable<void>;
     protected processMergeAnonymous(response: HttpResponseBase): Observable<void>;
     /**
      * Returns an API access token for the specified storefront user.
@@ -859,6 +876,7 @@ export interface ProjectItemResourceDto {
     resourceId?: string | null;
     /** Resource name. */
     name?: string | null;
+    /** Resource type. */
     type?: ProjectItemResourceType;
 }
 /** Dto class, containing information about a project item. */
@@ -932,6 +950,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. */
@@ -1022,9 +1041,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;
 }
@@ -1036,7 +1058,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. */
@@ -1103,12 +1127,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",
@@ -1129,6 +1169,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aurigma/ng-storefront-api-client",
-  "version": "2.24.1",
+  "version": "2.25.1",
   "license": "SEE LICENSE IN License.md",
   "description": "Angular API Client for Storefront API service of Customer's Canvas web-to-print system.",
   "author": "Aurigma Inc <info@aurigma.com> (https://customerscanvas.com)",