@aurigma/axios-storefront-api-client 2.62.12 → 2.65.1

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

@@ -105,6 +105,14 @@ export interface IProductBundlesApiClient {
      * @return Success
      */
     getProductBundle(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductBundleDto>;
+    /**
+     * Returns a product bundle personalization parameters by product identifier.
+     * @param id Product bundle identifier.
+     * @param productBundleVersionId (optional) Product bundle version identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductBundlePersonalizationParameters(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product bundle summary by product bundle identifier.
      * @param id Product bundle identifier.
@@ -150,6 +158,15 @@ export declare class ProductBundlesApiClient extends ApiClientBase implements IP
      */
     getProductBundle(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductBundleDto>;
     protected processGetProductBundle(response: AxiosResponse): Promise<ProductBundleDto>;
+    /**
+     * Returns a product bundle personalization parameters by product identifier.
+     * @param id Product bundle identifier.
+     * @param productBundleVersionId (optional) Product bundle version identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductBundlePersonalizationParameters(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
+    protected processGetProductBundlePersonalizationParameters(response: AxiosResponse): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product bundle summary by product bundle identifier.
      * @param id Product bundle identifier.
@@ -191,6 +208,14 @@ export interface IProductLinksApiClient {
      * @return Success
      */
     getProductLink(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductLinkDto>;
+    /**
+     * Returns a product link personalization parameters by product identifier.
+     * @param id Product link identifier.
+     * @param productLinkVersionId (optional) Product link version identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductLinkPersonalizationParameters(id: number, productLinkVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product link summary by product link identifier.
      * @param id Product link identifier.
@@ -239,6 +264,15 @@ export declare class ProductLinksApiClient extends ApiClientBase implements IPro
      */
     getProductLink(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductLinkDto>;
     protected processGetProductLink(response: AxiosResponse): Promise<ProductLinkDto>;
+    /**
+     * Returns a product link personalization parameters by product identifier.
+     * @param id Product link identifier.
+     * @param productLinkVersionId (optional) Product link version identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductLinkPersonalizationParameters(id: number, productLinkVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
+    protected processGetProductLinkPersonalizationParameters(response: AxiosResponse): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product link summary by product link identifier.
      * @param id Product link identifier.
@@ -372,6 +406,14 @@ export interface IProductReferencesApiClient {
      * @return Success
      */
     get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductReferenceDto>;
+    /**
+     * Returns a personalization parameters by the storefront product reference.
+     * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getPersonalizationParameters(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product specification by the storefront product reference.
      * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
@@ -554,6 +596,15 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
      */
     get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
     protected processGet(response: AxiosResponse): Promise<ProductReferenceDto>;
+    /**
+     * Returns a personalization parameters by the storefront product reference.
+     * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getPersonalizationParameters(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
+    protected processGetPersonalizationParameters(response: AxiosResponse): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product specification by the storefront product reference.
      * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
@@ -646,6 +697,14 @@ export interface IProductsApiClient {
      * @return Success
      */
     getProduct(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductDto>;
+    /**
+     * Returns a product personalization parameters by product identifier.
+     * @param id Product identifier.
+     * @param productVersionId (optional) Product version identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductSummary(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product summary by product identifier.
      * @param id Product identifier.
@@ -656,7 +715,7 @@ export interface IProductsApiClient {
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getProductSummary(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
+    getProductSummary2(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
     /**
      * Returns a list of product options.
      * @param id Product identifier.
@@ -823,6 +882,15 @@ export declare class ProductsApiClient extends ApiClientBase implements IProduct
      */
     getProduct(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductDto>;
     protected processGetProduct(response: AxiosResponse): Promise<ProductDto>;
+    /**
+     * Returns a product personalization parameters by product identifier.
+     * @param id Product identifier.
+     * @param productVersionId (optional) Product version identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductSummary(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
+    protected processGetProductSummary(response: AxiosResponse): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product summary by product identifier.
      * @param id Product identifier.
@@ -833,8 +901,8 @@ export declare class ProductsApiClient extends ApiClientBase implements IProduct
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getProductSummary(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
-    protected processGetProductSummary(response: AxiosResponse): Promise<ProductSummaryDto>;
+    getProductSummary2(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
+    protected processGetProductSummary2(response: AxiosResponse): Promise<ProductSummaryDto>;
     /**
      * Returns a list of product options.
      * @param id Product identifier.
@@ -1003,6 +1071,13 @@ export interface IProductSpecificationsApiClient {
      * @return Success
      */
     get(id: number, tenantId?: number | null | undefined): Promise<ProductSpecificationDto>;
+    /**
+     * Returns a product specification personalization parameters by product identifier.
+     * @param id Product specification identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductSpecificationSummary(id: number, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product personalization workflow description by product specification identifier.
      * @param id Product specification identifier.
@@ -1035,6 +1110,14 @@ 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 specification personalization parameters by product identifier.
+     * @param id Product specification identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductSpecificationSummary(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
+    protected processGetProductSpecificationSummary(response: AxiosResponse): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product personalization workflow description by product specification identifier.
      * @param id Product specification identifier.
@@ -1129,7 +1212,7 @@ export interface IProjectsApiClient {
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAvailableTransitions(id: number, tenantId?: number | null | undefined): Promise<PagedOfProjectTransitionDto>;
+    getAvailableTransitions(id: number, tenantId?: number | null | undefined): Promise<PagedOfProjectStatusTransitionDto>;
     /**
      * Changes the project status.
      * @param id Project identifier
@@ -1165,7 +1248,7 @@ export interface IProjectsApiClient {
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAllTransitions(tenantId?: number | null | undefined): Promise<PagedOfProjectTransitionDto>;
+    getAllTransitions(tenantId?: number | null | undefined): Promise<PagedOfProjectStatusTransitionDto>;
     /**
      * Returns a project processing results.
      * @param id Project identifier.
@@ -1305,8 +1388,8 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAvailableTransitions(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectTransitionDto>;
-    protected processGetAvailableTransitions(response: AxiosResponse): Promise<PagedOfProjectTransitionDto>;
+    getAvailableTransitions(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusTransitionDto>;
+    protected processGetAvailableTransitions(response: AxiosResponse): Promise<PagedOfProjectStatusTransitionDto>;
     /**
      * Changes the project status.
      * @param id Project identifier
@@ -1346,8 +1429,8 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAllTransitions(tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectTransitionDto>;
-    protected processGetAllTransitions(response: AxiosResponse): Promise<PagedOfProjectTransitionDto>;
+    getAllTransitions(tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusTransitionDto>;
+    protected processGetAllTransitions(response: AxiosResponse): Promise<PagedOfProjectStatusTransitionDto>;
     /**
      * Returns a project processing results.
      * @param id Project identifier.
@@ -1402,10 +1485,11 @@ export interface IStorefrontsApiClient {
      * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
      * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
      * @param search (optional) Search string for partial match.
+     * @param status (optional) Storefront status.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfStorefrontDto>;
+    getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, status?: StorefrontStatus | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfStorefrontDto>;
     /**
      * Returns a storefront by identifier.
      * @param id Storefront identifier.
@@ -1426,10 +1510,11 @@ export declare class StorefrontsApiClient extends ApiClientBase implements IStor
      * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
      * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
      * @param search (optional) Search string for partial match.
+     * @param status (optional) Storefront status.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontDto>;
+    getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, status?: StorefrontStatus | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontDto>;
     protected processGetAll(response: AxiosResponse): Promise<PagedOfStorefrontDto>;
     /**
      * Returns a storefront by identifier.
@@ -1760,6 +1845,49 @@ export interface GeneralConflictDto {
     /** Coflict type. */
     type?: ConflictType;
 }
+/** Customer's Canvas product type. */
+export declare enum ProductType {
+    ProductSpecification = "ProductSpecification",
+    Product = "Product",
+    ProductLink = "ProductLink",
+    ProductBundle = "ProductBundle"
+}
+/** Type of editor that should be configured by workflow. */
+export declare enum WorkflowType {
+    UIFramework = "UIFramework",
+    SimpleEditor = "SimpleEditor",
+    DesignEditor = "DesignEditor",
+    WorkflowElements = "WorkflowElements"
+}
+/** DTO class, containing information needed to start personalization process. */
+export interface PersonalizationParametersDto {
+    /** Customer's Canvas product type. */
+    productType?: ProductType;
+    /** Customer's Canvas product identifier.
+May keep reference to `Product`, `Product Specification`, `Product Link` or `Product Bundle` (depending on `Type` value). */
+    id?: number | null;
+    /** Customer's Canvas product version identifier.
+May keep reference to version of `Product`, `Product Link` or `Product Bundle` (depending on `Type` value). */
+    versionId?: number | null;
+    /** API Gateway URL address. */
+    apiGatewayUrl?: string | null;
+    /** Design Editor application URL address. */
+    designEditorUrl?: string | null;
+    /** Preflight application URL address. */
+    preflightUrl?: string | null;
+    /** Dynamic Image application URL address. */
+    dynamicImageUrl?: string | null;
+    /** Link to UI-Framework bundle. */
+    uiFrameworkUrl?: string | null;
+    /** Link to Simple Editor bundle. */
+    simpleEditorUrl?: string | null;
+    /** Link to Workflow Elements bundle. */
+    workflowElementsUrl?: string | null;
+    /** Personalization workflow type. */
+    workflowType?: WorkflowType;
+    /** Serialized content of compiled personalization workflow. */
+    workflowContent?: string | null;
+}
 /** Available appearance types. */
 export declare enum AppearanceDataType {
     Radio = "Radio",
@@ -1858,6 +1986,8 @@ export interface ProductSummaryDto {
     productVariantSku?: string | null;
     /** Product variant price. If product variant is not specified, should be null. */
     productVariantPrice?: number | null;
+    /** Product variant weight. If product variant is not specified, should be null. */
+    productVariantWeight?: number | null;
     /** Product variant availability. If product variant is not specified, should be null. */
     isProductVariantAvailable?: boolean | null;
     /** Product name. If product link is specified, name of link will be used. */
@@ -1882,13 +2012,6 @@ export interface ProductSummaryDto {
 If product link or variant is specified, product options will be filtered by link or variant options. */
     options?: ProductSummaryOptionDto[] | null;
 }
-/** Type of editor that should be configured by workflow. */
-export declare enum WorkflowType {
-    UIFramework = "UIFramework",
-    SimpleEditor = "SimpleEditor",
-    DesignEditor = "DesignEditor",
-    WorkflowElements = "WorkflowElements"
-}
 /** Personalization workflow description DTO. */
 export interface PersonalizationWorkflowDto {
     /** Workflow identifier. */
@@ -2233,6 +2356,8 @@ export interface ProductVariantDto {
     isAvailable?: boolean;
     /** Product variant price. */
     price?: number | null;
+    /** Product variant weight. */
+    weight?: number | null;
     /** Product variant sort index. */
     sortIndex?: number;
     /** Product variant identifier (usually SKU) in storefront / online store. */
@@ -2487,6 +2612,8 @@ export interface ProjectDto {
     orderUrl?: string | null;
     /** Order number in ecommerce system. */
     orderNumber?: number | null;
+    /** Order name in ecommerce system. */
+    orderName?: string | null;
     /** Order item identifier from storefront order. */
     orderLineItemId?: string | null;
     /** Order item index from storefront order. */
@@ -2594,6 +2721,8 @@ export interface CreateSingleItemProjectDto {
     orderUrl?: string | null;
     /** Order number in ecommerce system. */
     orderNumber?: number | null;
+    /** Order name in ecommerce system. */
+    orderName?: string | null;
     /** Customer identifier in ecommerce system. */
     customerId?: string | null;
     /** Customer name in ecommerce system. */
@@ -2615,6 +2744,8 @@ export interface CreateMultiItemProjectDto {
     orderUrl?: string | null;
     /** Order number in ecommerce system. */
     orderNumber?: number | null;
+    /** Order name in ecommerce system. */
+    orderName?: string | null;
     /** Customer identifier in ecommerce system. */
     customerId?: string | null;
     /** Customer name in ecommerce system. */
@@ -2636,6 +2767,8 @@ export interface OrderDetailsDto {
     orderUrl?: string | null;
     /** Order number in ecommerce system. */
     orderNumber?: number | null;
+    /** Order name in ecommerce system. */
+    orderName?: string | null;
     /** Line item index from ecommerce system order. */
     orderLineItemIndex?: number | null;
     /** Line Item identifier from ecommerce system order. */
@@ -2734,8 +2867,10 @@ export interface CreateProjectBySpecificPipelineScenarioDto {
     /** 'Specific Pipeline' scenario params. For more information check BackOffice.Web.PublicApi.ApiStorefront.Models.SpecificPipelineScenarioDto. */
     scenario: SpecificPipelineScenarioDto;
 }
-/** Project transition dto class. */
-export interface ProjectTransitionDto {
+/** Project status transition dto class. */
+export interface ProjectStatusTransitionDto {
+    /** Transition identifier. */
+    id?: number;
     /** Transition identifying name. */
     name?: string | null;
     /** Transition display name. */
@@ -2746,23 +2881,27 @@ export interface ProjectTransitionDto {
     resultStatus?: number;
 }
 /** Paged list of items. */
-export interface PagedOfProjectTransitionDto {
+export interface PagedOfProjectStatusTransitionDto {
     /** Items count. */
     total?: number;
     /** Items list. */
-    items?: ProjectTransitionDto[] | null;
+    items?: ProjectStatusTransitionDto[] | null;
 }
-/** Dto class, containing the information about project status. */
+/** Project status parameters. */
 export interface ProjectStatusDto {
+    /** Project status identifier. */
+    id?: number;
     /** Status code. */
     code?: number;
+    /** Status mark color. */
+    color?: string | null;
     /** Status display name. */
     displayName?: string | null;
 }
-/** Dto class, containing information about the project transition conflict. */
-export interface ProjectTransitionConflictDto {
+/** Dto class, containing information about the project status transition conflict. */
+export interface ProjectStatusTransitionConflictDto {
     /** A list of all available status transitions for the project. */
-    availableTransitions?: ProjectTransitionDto[] | null;
+    availableTransitions?: ProjectStatusTransitionDto[] | null;
     /** Problem description. */
     description?: string | null;
     /** Coflict type. */
@@ -2838,6 +2977,11 @@ export declare enum StorefrontType {
     Shopify = "Shopify",
     ShopifyCustom = "ShopifyCustom"
 }
+/** Storefront status. */
+export declare enum StorefrontStatus {
+    Dev = "Dev",
+    Prod = "Prod"
+}
 /** Dto class, containing information about a storefront. */
 export interface StorefrontDto {
     /** Storefront identifier. */
@@ -2850,6 +2994,8 @@ export interface StorefrontDto {
     type?: StorefrontType;
     /** Storefront entity creation date and time. */
     created?: string;
+    /** Storefront status. */
+    status?: StorefrontStatus;
 }
 /** Paged list of items. */
 export interface PagedOfStorefrontDto {