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

package/dist/cjs/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.
@@ -416,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.
@@ -441,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.
@@ -614,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.
@@ -630,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.
@@ -638,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.
@@ -673,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.
@@ -691,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.
@@ -700,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.
@@ -873,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. */
@@ -946,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. */
@@ -1036,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;
 }
@@ -1050,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. */
@@ -1117,6 +1124,7 @@ 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;
@@ -1135,6 +1143,7 @@ export interface OrderDataItemDto {
     key?: string | null;
     /** Order data item value. */
     value?: string | null;
+    /** Order data item type. */
     type?: OrderDataItemValueType;
 }
 /** Storefront types. */
@@ -1157,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;