@aurigma/axios-storefront-api-client 2.38.2 → 2.40.1

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

@@ -43,6 +43,48 @@ export declare class BuildInfoApiClient extends ApiClientBase implements IBuildI
     getInfo(cancelToken?: CancelToken | undefined): Promise<BuildInfoModel>;
     protected processGetInfo(response: AxiosResponse): Promise<BuildInfoModel>;
 }
+export interface IProcessingPipelinesApiClient {
+    /**
+     * Returns all processing pipelines relevant to the specified query parameters.
+     * @param skip (optional) Defines page start offset from beginning of sorted result list.
+     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
+     * @param search (optional) Search string for partial by processing pipeline name.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getAll(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProcessingPipelineDto>;
+    /**
+     * Returns a processing pipeline.
+     * @param id Processing pipeline identifier..
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    get(id: number, tenantId?: number | null | undefined): Promise<ProcessingPipelineDto>;
+}
+export declare class ProcessingPipelinesApiClient extends ApiClientBase implements IProcessingPipelinesApiClient {
+    private instance;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Returns all processing pipelines relevant to the specified query parameters.
+     * @param skip (optional) Defines page start offset from beginning of sorted result list.
+     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
+     * @param search (optional) Search string for partial by processing pipeline name.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getAll(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProcessingPipelineDto>;
+    protected processGetAll(response: AxiosResponse): Promise<PagedOfProcessingPipelineDto>;
+    /**
+     * Returns a processing pipeline.
+     * @param id Processing pipeline identifier..
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    get(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProcessingPipelineDto>;
+    protected processGet(response: AxiosResponse): Promise<ProcessingPipelineDto>;
+}
 export interface IProductReferencesApiClient {
     /**
      * Returns all storefront product references relevant to the specified query parameters.
@@ -89,14 +131,6 @@ export interface IProductReferencesApiClient {
      * @return Success
      */
     getProductSpecification(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductSpecificationDto>;
-    /**
-     * Returns a product personalization workflow configuration by storefront product reference.
-     * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
-     * @param storefrontId Storefront identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @return Success
-     */
-    getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<string>;
     /**
      * Returns a product cost details from ecommerce system.
      * @param reference Product reference - external reference to Customer's Canvas product product specification, e.g online store product identifier.
@@ -109,6 +143,20 @@ export interface IProductReferencesApiClient {
      * @return Success
      */
     getProductCostDetails(reference: string | null, sku: string, storefrontId: number, storefrontUserId?: string | null | undefined, currencyCode?: string | null | undefined, quantity?: number | undefined, tenantId?: number | null | undefined): Promise<ProductCostDetailsDto>;
+    /**
+     * Returns a product personalization workflow description by product specification identifier.
+     * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
+     * @param storefrontId (optional) Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getPersonalizationWorkflow(reference: string | null, storefrontId?: number | undefined, tenantId?: number | null | undefined): Promise<PersonalizationWorkflowDto>;
+    /**
+     * @param tenantId (optional)
+     * @return Success
+     * @deprecated
+     */
+    getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<string>;
 }
 export declare class ProductReferencesApiClient extends ApiClientBase implements IProductReferencesApiClient {
     private instance;
@@ -165,15 +213,6 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
      */
     getProductSpecification(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSpecificationDto>;
     protected processGetProductSpecification(response: AxiosResponse): Promise<ProductSpecificationDto>;
-    /**
-     * Returns a product personalization workflow configuration by storefront product reference.
-     * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
-     * @param storefrontId Storefront identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @return Success
-     */
-    getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
-    protected processGetProductConfig(response: AxiosResponse): Promise<string>;
     /**
      * Returns a product cost details from ecommerce system.
      * @param reference Product reference - external reference to Customer's Canvas product product specification, e.g online store product identifier.
@@ -187,6 +226,22 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
      */
     getProductCostDetails(reference: string | null, sku: string, storefrontId: number, storefrontUserId?: string | null | undefined, currencyCode?: string | null | undefined, quantity?: number | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductCostDetailsDto>;
     protected processGetProductCostDetails(response: AxiosResponse): Promise<ProductCostDetailsDto>;
+    /**
+     * Returns a product personalization workflow description by product specification identifier.
+     * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
+     * @param storefrontId (optional) Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getPersonalizationWorkflow(reference: string | null, storefrontId?: number | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationWorkflowDto>;
+    protected processGetPersonalizationWorkflow(response: AxiosResponse): Promise<PersonalizationWorkflowDto>;
+    /**
+     * @param tenantId (optional)
+     * @return Success
+     * @deprecated
+     */
+    getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
+    protected processGetProductConfig(response: AxiosResponse): Promise<string>;
 }
 export interface IProductSpecificationsApiClient {
     /**
@@ -207,11 +262,17 @@ export interface IProductSpecificationsApiClient {
      */
     get(id: number, tenantId?: number | null | undefined): Promise<ProductSpecificationDto>;
     /**
-     * Returns a product personlization workflow configuration by product specification identifier.
+     * Returns a product personalization workflow description by product specification identifier.
      * @param id Product specification identifier.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
+    getPersonalizationWorkflow(id: number, tenantId?: number | null | undefined): Promise<PersonalizationWorkflowDto>;
+    /**
+     * @param tenantId (optional)
+     * @return Success
+     * @deprecated
+     */
     getConfiguration(id: number, tenantId?: number | null | undefined): Promise<string>;
 }
 export declare class ProductSpecificationsApiClient extends ApiClientBase implements IProductSpecificationsApiClient {
@@ -239,11 +300,18 @@ export declare class ProductSpecificationsApiClient extends ApiClientBase implem
     get(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSpecificationDto>;
     protected processGet(response: AxiosResponse): Promise<ProductSpecificationDto>;
     /**
-     * Returns a product personlization workflow configuration by product specification identifier.
+     * Returns a product personalization workflow description by product specification identifier.
      * @param id Product specification identifier.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
+    getPersonalizationWorkflow(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationWorkflowDto>;
+    protected processGetPersonalizationWorkflow(response: AxiosResponse): Promise<PersonalizationWorkflowDto>;
+    /**
+     * @param tenantId (optional)
+     * @return Success
+     * @deprecated
+     */
     getConfiguration(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
     protected processGetConfiguration(response: AxiosResponse): Promise<string>;
 }
@@ -259,11 +327,12 @@ export interface IProjectsApiClient {
      * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
      * @param search (optional) Search string for partial match.
      * @param orderId (optional) Identifier of corresponding order.
+     * @param processingStatus (optional) Project processing status filter.
      * @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, 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, storefrontId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProjectDto>;
     /**
      * Creates a new project.
      * @param storefrontId Storefront identifier.
@@ -308,6 +377,14 @@ export interface IProjectsApiClient {
      * @return Success
      */
     createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | null | undefined): Promise<ProjectDto>;
+    /**
+     * Creates a new project by 'Specific Pipeline' scenario.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createBySpecificPipelineScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectBySpecificPipelineScenarioDto | null | undefined): Promise<ProjectDto>;
     /**
      * Returns all available status transitions for a project.
      * @param id Project identifier.
@@ -417,11 +494,12 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
      * @param search (optional) Search string for partial match.
      * @param orderId (optional) Identifier of corresponding order.
+     * @param processingStatus (optional) Project processing status filter.
      * @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, 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, storefrontId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectDto>;
     protected processGetAll(response: AxiosResponse): Promise<PagedOfProjectDto>;
     /**
      * Creates a new project.
@@ -473,6 +551,15 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      */
     createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
     protected processCreateByRenderHiResScenario(response: AxiosResponse): Promise<ProjectDto>;
+    /**
+     * Creates a new project by 'Specific Pipeline' scenario.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createBySpecificPipelineScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectBySpecificPipelineScenarioDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
+    protected processCreateBySpecificPipelineScenario(response: AxiosResponse): Promise<ProjectDto>;
     /**
      * Returns all available status transitions for a project.
      * @param id Project identifier.
@@ -800,6 +887,29 @@ export interface BuildInfoModel {
     /** Service name. */
     appName?: string | null;
 }
+/** Dto class, containing information about processing pipeline details. */
+export interface ProcessingPipelineDto {
+    /** Processing pipeline identifier. */
+    id?: number;
+    /** Processing pipeline name. */
+    name?: string | null;
+    /** Processing pipeline content. */
+    content?: string | null;
+}
+/** Paged list of items. */
+export interface PagedOfProcessingPipelineDto {
+    /** Items count. */
+    total?: number;
+    /** Items list. */
+    items?: ProcessingPipelineDto[] | null;
+}
+export interface ProblemDetails {
+    type?: string | null;
+    title?: string | null;
+    status?: number | null;
+    detail?: string | null;
+    instance?: string | null;
+}
 /** Dto class, containing information about storefront product reference. */
 export interface ProductReferenceDto {
     /** Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier. */
@@ -827,13 +937,6 @@ export interface CreateProductReferenceDto {
     /** Customer's Canvas product specification identifier. */
     productSpecificationId: number;
 }
-export interface ProblemDetails {
-    type?: string | null;
-    title?: string | null;
-    status?: number | null;
-    detail?: string | null;
-    instance?: string | null;
-}
 /** Dto class, containing information about product attribute. */
 export interface ProductAttributeDto {
     /** Product attribute name. */
@@ -857,6 +960,10 @@ export interface ProductSpecificationDto {
     created?: string;
     /** Product specification modification time. */
     lastModified?: string | null;
+    /** Personalization workflow identifier. */
+    personalizationWorkflowId?: number;
+    /** Processing pipeline identifier. */
+    processingPipelineId?: number;
 }
 /** Dto class, containing information about storefront product cost details. */
 export interface ProductCostDetailsDto {
@@ -877,6 +984,22 @@ export interface ProductCostDetailsDto {
     /** Tenant identifier. */
     tenantId?: number;
 }
+/** Type of editor that should be configured by workflow. */
+export declare enum WorkflowType {
+    UIFramework = "UIFramework",
+    SimpleEditor = "SimpleEditor",
+    DesignEditor = "DesignEditor",
+    HandyEditor = "HandyEditor"
+}
+/** Personalization workflow description DTO. */
+export interface PersonalizationWorkflowDto {
+    /** Workflow identifier. */
+    id?: number;
+    /** Processed workflow JSON. */
+    content?: string | null;
+    /** Workflow type. */
+    workflowType?: WorkflowType;
+}
 /** Paged list of items. */
 export interface PagedOfProductSpecificationDto {
     /** Items count. */
@@ -891,6 +1014,13 @@ export declare enum DatePeriod {
     Last7Days = "Last7Days",
     Last30Days = "Last30Days"
 }
+/** Available project processing statuses. */
+export declare enum ProjectProcessingStatus {
+    Pending = "Pending",
+    InProgress = "InProgress",
+    Completed = "Completed",
+    Failed = "Failed"
+}
 /** Available product resource types */
 export declare enum ProjectItemResourceType {
     General = "General",
@@ -963,6 +1093,8 @@ export interface ProjectDto {
     lastModified?: string | null;
     /** Description of the project. */
     description?: string | null;
+    /** Project processing status. */
+    processingStatus?: ProjectProcessingStatus;
 }
 /** Paged list of items. */
 export interface PagedOfProjectDto {
@@ -982,7 +1114,7 @@ export interface ProjectItemResourceParametersDto {
     /** Original resource identifier. */
     resourceId?: string | null;
 }
-/** Dto class, containing create operation paramters for a project item. */
+/** Dto class, containing create operation parameters for a project item. */
 export interface ProjectItemParametersDto {
     /** Item name. */
     name?: string | null;
@@ -1062,7 +1194,7 @@ export declare enum RenderHiResScenarioOutputFlipMode {
     Vertical = "Vertical",
     Both = "Both"
 }
-/** Dto class, containing 'RenderHiRes' scenario paramters. */
+/** Dto class, containing 'RenderHiRes' scenario parameters. */
 export interface RenderHiResScenarioDto {
     /** Private design identifier. */
     designId: string;
@@ -1092,6 +1224,26 @@ export interface CreateProjectByRenderHiResScenarioDto {
     /** List of project items. */
     scenario: RenderHiResScenarioDto;
 }
+/** Dto class, containing 'Specific Pipeline' scenario parameters. */
+export interface SpecificPipelineScenarioDto {
+    /** An existing processing pipeline identifier. */
+    pipelineId?: number;
+}
+/** Dto class, containing 'create' operation parameters for a new project that should be created by executing 'Specific Pipeline' scenario. <seealso cref="T:BackOffice.Web.PublicApi.ApiStorefront.Models.CreateProjectDto" /> */
+export interface CreateProjectBySpecificPipelineScenarioDto {
+    /** Project owner identifier. */
+    ownerId: string;
+    /** Project name. */
+    name?: string | null;
+    /** Description of the project. */
+    description?: string | null;
+    /** Ecommerce system order description. */
+    orderDetails?: OrderDetailsDto | null;
+    /** List of project items. */
+    items?: ProjectItemParametersDto[] | null;
+    /** 'Specific Pipeline' scenario params. <seealso cref="T:BackOffice.Web.PublicApi.ApiStorefront.Models.SpecificPipelineScenarioDto" /> */
+    scenario: SpecificPipelineScenarioDto;
+}
 /** Project transition dto class. */
 export interface ProjectTransitionDto {
     /** Transition identifying name. */
@@ -1134,13 +1286,6 @@ export interface ProjectPdfResultDto {
     /** Project pdf url. */
     url?: string | null;
 }
-/** Available project processing statuses. */
-export declare enum ProjectProcessingStatus {
-    Pending = "Pending",
-    InProgress = "InProgress",
-    Completed = "Completed",
-    Failed = "Failed"
-}
 /** Dto class, containing description of a project output file. */
 export interface ProjectOutputFileDetailsDto {
     /** Project output file URL. */
@@ -1255,6 +1400,8 @@ export interface TenantApplicationsInfoDto {
     uiFrameworkUrl?: string | null;
     /** An url to the 'Simple editor'. */
     simpleEditorUrl?: string | null;
+    /** An url to the 'Handy editor'. */
+    handyEditorUrl?: string | null;
     /** An url to the 'Preflight' tenant application. */
     preflightUrl?: string | null;
     /** An url to the 'Dynamic Image' tenant application. */