@aurigma/axios-storefront-api-client 2.46.4 → 2.49.1

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

@@ -343,14 +343,6 @@ export interface IProjectsApiClient {
      * @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>;
-    /**
-     * Creates a new project.
-     * @param storefrontId Storefront identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @param body (optional) Create operation parameters.
-     * @return Success
-     */
-    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectDto | null | undefined): Promise<ProjectDto>;
     /**
      * Returns a project by identifier.
      * @param id Project identifier.
@@ -379,6 +371,22 @@ export interface IProjectsApiClient {
      * @return Success
      */
     getPreviewUrl(id: number, tenantId?: number | null | undefined): Promise<string>;
+    /**
+     * Creates a new project with single item.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createWithSingleItem(storefrontId: number, tenantId?: number | null | undefined, body?: CreateSingleItemProjectDto | null | undefined): Promise<ProjectDto>;
+    /**
+     * Creates a new project with multiple items.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createWithMultipleItems(storefrontId: number, tenantId?: number | null | undefined, body?: CreateMultiItemProjectDto | null | undefined): Promise<ProjectDto>;
     /**
      * Creates a new project by 'Render HiRes' scenario.
      * @param storefrontId Storefront identifier.
@@ -454,24 +462,27 @@ export interface IProjectsApiClient {
     /**
      * Returns a project processing results.
      * @param id Project identifier.
+     * @param itemId (optional) Project item identifier.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getProjectProcessingResults(id: number, tenantId?: number | null | undefined): Promise<ProjectProcessingResultsDto>;
+    getProjectProcessingResults(id: number, itemId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProjectProcessingResultsDto>;
     /**
      * Resumes project processing.
      * @param id Project identifier.
+     * @param itemId (optional) Project item identifier. If value is set, only specified item processing will be resumed.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    resumeProjectProcessing(id: number, tenantId?: number | null | undefined): Promise<void>;
+    resumeProjectProcessing(id: number, itemId?: number | null | undefined, tenantId?: number | null | undefined): Promise<void>;
     /**
      * Restarts a project processing routine.
      * @param id Project identifier.
+     * @param itemId (optional) Project item identifier. If value is set, only specified item processing will be restarted.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    restartProjectProcessing(id: number, tenantId?: number | null | undefined): Promise<void>;
+    restartProjectProcessing(id: number, itemId?: number | null | undefined, tenantId?: number | null | undefined): Promise<void>;
     /**
      * Returns an order description from the ecommerce system for the specified project.
      * @param id Project identifier.
@@ -482,11 +493,12 @@ export interface IProjectsApiClient {
     /**
      * Attachs the specified data to the project's order in ecommerce system.
      * @param id Project identifier.
+     * @param itemId (optional)
      * @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>;
+    attachDataToProjectOrder(id: number, itemId?: number | null | undefined, tenantId?: number | null | undefined, body?: OrderDataItemDto[] | null | undefined): Promise<void>;
 }
 export declare class ProjectsApiClient extends ApiClientBase implements IProjectsApiClient {
     private instance;
@@ -511,15 +523,6 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      */
     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>;
     protected processGetAll(response: AxiosResponse): Promise<PagedOfProjectDto>;
-    /**
-     * Creates a new project.
-     * @param storefrontId Storefront identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @param body (optional) Create operation parameters.
-     * @return Success
-     */
-    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.
      * @param id Project identifier.
@@ -552,6 +555,24 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      */
     getPreviewUrl(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
     protected processGetPreviewUrl(response: AxiosResponse): Promise<string>;
+    /**
+     * Creates a new project with single item.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createWithSingleItem(storefrontId: number, tenantId?: number | null | undefined, body?: CreateSingleItemProjectDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
+    protected processCreateWithSingleItem(response: AxiosResponse): Promise<ProjectDto>;
+    /**
+     * Creates a new project with multiple items.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createWithMultipleItems(storefrontId: number, tenantId?: number | null | undefined, body?: CreateMultiItemProjectDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
+    protected processCreateWithMultipleItems(response: AxiosResponse): Promise<ProjectDto>;
     /**
      * Creates a new project by 'Render HiRes' scenario.
      * @param storefrontId Storefront identifier.
@@ -636,26 +657,29 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
     /**
      * Returns a project processing results.
      * @param id Project identifier.
+     * @param itemId (optional) Project item identifier.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getProjectProcessingResults(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectProcessingResultsDto>;
+    getProjectProcessingResults(id: number, itemId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectProcessingResultsDto>;
     protected processGetProjectProcessingResults(response: AxiosResponse): Promise<ProjectProcessingResultsDto>;
     /**
      * Resumes project processing.
      * @param id Project identifier.
+     * @param itemId (optional) Project item identifier. If value is set, only specified item processing will be resumed.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    resumeProjectProcessing(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    resumeProjectProcessing(id: number, itemId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processResumeProjectProcessing(response: AxiosResponse): Promise<void>;
     /**
      * Restarts a project processing routine.
      * @param id Project identifier.
+     * @param itemId (optional) Project item identifier. If value is set, only specified item processing will be restarted.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    restartProjectProcessing(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    restartProjectProcessing(id: number, itemId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processRestartProjectProcessing(response: AxiosResponse): Promise<void>;
     /**
      * Returns an order description from the ecommerce system for the specified project.
@@ -668,11 +692,12 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
     /**
      * Attachs the specified data to the project's order in ecommerce system.
      * @param id Project identifier.
+     * @param itemId (optional)
      * @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>;
+    attachDataToProjectOrder(id: number, itemId?: number | null | undefined, tenantId?: number | null | undefined, body?: OrderDataItemDto[] | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processAttachDataToProjectOrder(response: AxiosResponse): Promise<void>;
 }
 export interface IStorefrontsApiClient {
@@ -1061,10 +1086,18 @@ export interface ProjectItemResourceDto {
 }
 /** Dto class, containing information about a project item. */
 export interface ProjectItemDto {
+    /** Item identifier. */
+    id?: number;
     /** Item name. */
     name?: string | null;
     /** Item quantity information. */
     quantity?: number | null;
+    /** Order item identifier from storefront order. */
+    orderLineItemId?: string | null;
+    /** Order item index from storefront order. */
+    orderLineItemIndex?: number | null;
+    /** Storefront product reference (i.e external reference to Customer's Canvas product specification). */
+    productReference?: string | null;
     /** Item information. */
     fields?: {
         [key: string]: any;
@@ -1082,7 +1115,7 @@ export interface ProjectItemDto {
 export interface ProjectDto {
     /** Project identifier. */
     id?: number;
-    /** Product reference (i.e external reference to Customer's Canvas product specification) */
+    /** Storefront product identifier. */
     productReference?: string | null;
     /** Storefront identifier. */
     storefrontId?: number;
@@ -1094,9 +1127,9 @@ export interface ProjectDto {
     orderUrl?: string | null;
     /** Order number in ecommerce system. */
     orderNumber?: number | null;
-    /** Line item identifier from external ecommerce system order. */
+    /** Order item identifier from storefront order. */
     orderLineItemId?: string | null;
-    /** Line item index from external ecommerce system order. */
+    /** Order item index from storefront order. */
     orderLineItemIndex?: number | null;
     /** Customer identifier in ecommerce system. */
     customerId?: string | null;
@@ -1126,7 +1159,7 @@ export interface PagedOfProjectDto {
     /** Items list. */
     items?: ProjectDto[] | null;
 }
-/** Dto class, containing create operation paramters for a project item resource. */
+/** Dto class, containing create operation parameters for a project item resource. */
 export interface ProjectItemResourceParametersDto {
     /** Resource URL. */
     url?: string | null;
@@ -1143,6 +1176,12 @@ export interface ProjectItemParametersDto {
     name?: string | null;
     /** Item quantity information. */
     quantity?: number | null;
+    /** Line item index from ecommerce system order. */
+    orderLineItemIndex?: number | null;
+    /** Line Item identifier from ecommerce system order. */
+    orderLineItemId?: string | null;
+    /** Storefront product identifier. */
+    productReference?: string | null;
     /** Item information. */
     fields?: {
         [key: string]: any;
@@ -1156,20 +1195,43 @@ export interface ProjectItemParametersDto {
     /** External resources descriptions. */
     resources?: ProjectItemResourceParametersDto[] | null;
 }
-/** Dto class, containing create operation parameters for project entity. */
-export interface CreateProjectDto {
+/** Dto class, containing create operation parameters for single-item project entity. */
+export interface CreateSingleItemProjectDto {
     /** Product reference (i.e external reference to Customer's Canvas product specification - main subject of this project). */
-    productReference: string;
+    productReference?: string | null;
+    /** Line item index from ecommerce system order. */
+    orderLineItemIndex?: number | null;
+    /** Line Item identifier from ecommerce system order. */
+    orderLineItemId?: string | null;
+    /** List of project items. */
+    items?: ProjectItemParametersDto[] | null;
+    /** Order identifier in ecommerce system. */
+    orderId?: string | null;
+    /** Order url in ecommerce system. */
+    orderUrl?: string | null;
+    /** Order number in ecommerce system. */
+    orderNumber?: number | null;
+    /** Customer identifier in ecommerce system. */
+    customerId?: string | null;
+    /** Customer name in ecommerce system. */
+    customerName?: string | null;
+    /** Project name. */
+    name?: string | null;
+    /** Project owner identifier. */
+    ownerId: string;
+    /** List of project items. */
+    item?: ProjectItemParametersDto | null;
+    /** Description of the project. */
+    description?: string | null;
+}
+/** Dto class, containing create operation parameters for multi-item project entity. */
+export interface CreateMultiItemProjectDto {
     /** Order identifier in ecommerce system. */
     orderId?: string | null;
     /** Order url in ecommerce system. */
     orderUrl?: string | null;
     /** Order number in ecommerce system. */
     orderNumber?: number | null;
-    /** Line item index from ecommerce system order. */
-    orderLineItemIndex?: number | null;
-    /** Line Item identifier from ecommerce system order. */
-    orderLineItemId?: string | null;
     /** Customer identifier in ecommerce system. */
     customerId?: string | null;
     /** Customer name in ecommerce system. */
@@ -1244,13 +1306,25 @@ export interface CreateProjectByRenderHiResScenarioDto {
     description?: string | null;
     /** Ecommerce system order description. */
     orderDetails?: OrderDetailsDto | null;
+    /** Line item index from ecommerce system order. */
+    orderLineItemIndex?: number | null;
+    /** Line Item identifier from ecommerce system order. */
+    orderLineItemId?: string | null;
     /** List of project items. */
     scenario: RenderHiResScenarioDto;
 }
+export interface ItemPipelineDto {
+    itemName?: string | null;
+    pipelineId?: number;
+}
 /** Dto class, containing 'Specific Pipeline' scenario parameters. */
 export interface SpecificPipelineScenarioDto {
     /** An existing processing pipeline identifier. */
-    pipelineId?: number;
+    pipelineId?: number | null;
+    /** An existing processing pipeline identifier for project post-processing. */
+    postProcessingPipelineId?: number | null;
+    /** List of objects describing connections between project items and processing pipelines. */
+    itemPipelines?: ItemPipelineDto[] | null;
 }
 /** Dto class, containing 'create' operation parameters for a new project that should be created by executing 'Specific Pipeline' scenario. */
 export interface CreateProjectBySpecificPipelineScenarioDto {
@@ -1311,16 +1385,24 @@ export interface ProjectPdfResultDto {
 }
 /** Dto class, containing description of a project output file. */
 export interface ProjectOutputFileDetailsDto {
+    /** Project item identifier. */
+    projectItemId?: number | null;
+    /** Order item identifier from storefront. */
+    orderLineItemId?: string | null;
+    /** Order item index from storefront. */
+    orderLineItemIndex?: number | null;
     /** Project output file URL. */
     url?: string | null;
-    /** Project output file name */
+    /** Project output file name. */
     name?: string | null;
-    /** Project output file format */
+    /** Project output file format. */
     format?: string | null;
-    /** Project output file id withing artifacts storage. */
+    /** Output artifact file identifier. */
     artifactId?: string | null;
     /** Project output file access strategy. */
     anonymousAccess?: boolean;
+    /** Project output file size in bytes. */
+    size?: number | null;
 }
 /** Dto class, containing description of project processing results. */
 export interface ProjectProcessingResultsDto {