@aurigma/axios-storefront-api-client 2.54.19 → 2.55.3

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

@@ -197,14 +197,6 @@ export interface IProductReferencesApiClient {
      * @return Success
      */
     getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductReferenceDto>;
-    /**
-     * Creates a new storefront product reference.
-     * @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?: CreateProductReferenceDto | null | undefined): Promise<ProductReferenceDto>;
     /**
      * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
      * @param storefrontId Storefront identifier.
@@ -270,14 +262,6 @@ export interface IProductReferencesApiClient {
      * @return Success
      */
     get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductReferenceDto>;
-    /**
-     * Deletes the 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
-     */
-    delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductReferenceDto>;
     /**
      * 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.
@@ -332,15 +316,6 @@ export interface IProductReferencesApiClient {
      * @return Success
      */
     getPersonalizationWorkflow(reference: string | null, storefrontId?: number | undefined, tenantId?: number | null | undefined): Promise<PersonalizationWorkflowDto>;
-    /**
-     * Returns a product personalization workflow configuration by storefront product reference.
-     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
-     * @param storefrontId Storefront identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @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;
@@ -367,15 +342,6 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
      */
     getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductReferenceDto>;
     protected processGetAll(response: AxiosResponse): Promise<PagedOfProductReferenceDto>;
-    /**
-     * Creates a new storefront product reference.
-     * @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?: CreateProductReferenceDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
-    protected processCreate(response: AxiosResponse): Promise<ProductReferenceDto>;
     /**
      * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
      * @param storefrontId Storefront identifier.
@@ -445,15 +411,6 @@ 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>;
-    /**
-     * Deletes the 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
-     */
-    delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
-    protected processDelete(response: AxiosResponse): Promise<ProductReferenceDto>;
     /**
      * 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.
@@ -514,16 +471,6 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
      */
     getPersonalizationWorkflow(reference: string | null, storefrontId?: number | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationWorkflowDto>;
     protected processGetPersonalizationWorkflow(response: AxiosResponse): Promise<PersonalizationWorkflowDto>;
-    /**
-     * Returns a product personalization workflow configuration by storefront product reference.
-     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
-     * @param storefrontId Storefront identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @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 IProductsApiClient {
     /**
@@ -678,15 +625,6 @@ export interface IProductsApiClient {
      * @return Success
      */
     updateProductVariantResources(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<void>;
-    /**
-     * Set product variant price.
-     * @param id Product identifier.
-     * @param productVersionId (optional) Product version identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @param body (optional) Set product variant price operation parameters.
-     * @return Success
-     */
-    setProductVariantPrice(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto[] | null | undefined): Promise<void>;
     /**
      * Returns a list of all available product tags.
      * @param search (optional) Search string for partial match.
@@ -875,16 +813,6 @@ export declare class ProductsApiClient extends ApiClientBase implements IProduct
      */
     updateProductVariantResources(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processUpdateProductVariantResources(response: AxiosResponse): Promise<void>;
-    /**
-     * Set product variant price.
-     * @param id Product identifier.
-     * @param productVersionId (optional) Product version identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @param body (optional) Set product variant price operation parameters.
-     * @return Success
-     */
-    setProductVariantPrice(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto[] | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
-    protected processSetProductVariantPrice(response: AxiosResponse): Promise<void>;
     /**
      * Returns a list of all available product tags.
      * @param search (optional) Search string for partial match.
@@ -930,14 +858,6 @@ export interface IProductSpecificationsApiClient {
      * @return Success
      */
     getPersonalizationWorkflow(id: number, tenantId?: number | null | undefined): Promise<PersonalizationWorkflowDto>;
-    /**
-     * Returns a product personalization workflow configuration by product specification identifier.
-     * @param id Product specification identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @return Success
-     * @deprecated
-     */
-    getConfiguration(id: number, tenantId?: number | null | undefined): Promise<string>;
 }
 export declare class ProductSpecificationsApiClient extends ApiClientBase implements IProductSpecificationsApiClient {
     private instance;
@@ -971,15 +891,6 @@ export declare class ProductSpecificationsApiClient extends ApiClientBase implem
      */
     getPersonalizationWorkflow(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationWorkflowDto>;
     protected processGetPersonalizationWorkflow(response: AxiosResponse): Promise<PersonalizationWorkflowDto>;
-    /**
-     * Returns a product personalization workflow configuration by product specification identifier.
-     * @param id Product specification identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @return Success
-     * @deprecated
-     */
-    getConfiguration(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
-    protected processGetConfiguration(response: AxiosResponse): Promise<string>;
 }
 export interface IProjectsApiClient {
     /**
@@ -1103,27 +1014,6 @@ export interface IProjectsApiClient {
      * @return Success
      */
     getAllTransitions(tenantId?: number | null | undefined): Promise<PagedOfProjectTransitionDto>;
-    /**
-     * Returns an url to download project print file.
-     * @param id Project identifier.
-     * @param designUserId Design owner identifier.
-     * @param designId Design identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @return Success
-     * @deprecated
-     */
-    getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined): Promise<ProjectPdfResultDto>;
-    /**
-     * Returns an archive file, which contains all project print files.
-     * @param id Project identifier.
-     * @param designUserId Design owner identifier.
-     * @param designId Design identifier.
-     * @param attachment (optional) If set to 'true', the requested file will be provided as an attachment with proper filename supplied (default value is 'false').
-     * @param tenantId (optional) Tenant identifier.
-     * @return Success
-     * @deprecated
-     */
-    getProjectPdfZip(id: number, designUserId: string, designId: string, attachment?: boolean | null | undefined, tenantId?: number | null | undefined): Promise<FileResponse>;
     /**
      * Returns a project processing results.
      * @param id Project identifier.
@@ -1306,29 +1196,6 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      */
     getAllTransitions(tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectTransitionDto>;
     protected processGetAllTransitions(response: AxiosResponse): Promise<PagedOfProjectTransitionDto>;
-    /**
-     * Returns an url to download project print file.
-     * @param id Project identifier.
-     * @param designUserId Design owner identifier.
-     * @param designId Design identifier.
-     * @param tenantId (optional) Tenant identifier.
-     * @return Success
-     * @deprecated
-     */
-    getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectPdfResultDto>;
-    protected processGetProjectPdfUrl(response: AxiosResponse): Promise<ProjectPdfResultDto>;
-    /**
-     * Returns an archive file, which contains all project print files.
-     * @param id Project identifier.
-     * @param designUserId Design owner identifier.
-     * @param designId Design identifier.
-     * @param attachment (optional) If set to 'true', the requested file will be provided as an attachment with proper filename supplied (default value is 'false').
-     * @param tenantId (optional) Tenant identifier.
-     * @return Success
-     * @deprecated
-     */
-    getProjectPdfZip(id: number, designUserId: string, designId: string, attachment?: boolean | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
-    protected processGetProjectPdfZip(response: AxiosResponse): Promise<FileResponse>;
     /**
      * Returns a project processing results.
      * @param id Project identifier.
@@ -1887,47 +1754,6 @@ export interface PagedOfProductReferenceDto {
     /** Items list. */
     items?: ProductReferenceDto[] | null;
 }
-/** Dto class, containing create operation parameters for storefront product reference. */
-export interface CreateProductReferenceDto {
-    /** Product reference is an external reference to Customer's Canvas product, e.g online store product identifier. */
-    productReference: string;
-    /** Product reference target type. */
-    productReferenceType?: ProductReferenceType;
-    /** Product reference name, e.g. online store product name. */
-    productReferenceName?: string | null;
-    /** Customer's Canvas product specification identifier. */
-    productSpecificationId?: number | null;
-    /** Customer's Canvas product identifier. */
-    productId?: number | null;
-    /** Customer's Canvas product link identifier. */
-    productLinkId?: number | null;
-}
-/** DTO class, containing information about storefront product reference. */
-export interface ProductReferenceInfo {
-    /** Product reference is an external reference to Customer's Canvas product, e.g online store product identifier. */
-    productReference?: string | null;
-    /** Product reference target type. */
-    productReferenceType?: ProductReferenceType;
-    /** Product reference name, e.g. online store product name. */
-    productReferenceName?: string | null;
-    /** Customer's Canvas product specification identifier. */
-    productSpecificationId?: number;
-    /** Customer's Canvas product identifier. */
-    productId?: number;
-    /** Customer's Canvas product link identifier. */
-    productLinkId?: number;
-    /** Storefront identifier. */
-    storefrontId?: number;
-}
-/** DTO class, containing information about storefront product reference creation conflict. */
-export interface ProductReferenceCreationConflictDto {
-    /** List of storefront product references, which are already exist. */
-    existingReferences?: ProductReferenceInfo[] | null;
-    /** Problem description. */
-    description?: string | null;
-    /** Coflict type. */
-    type?: ConflictType;
-}
 /** Dto class, containing information about product attribute. */
 export interface ProductAttributeDto {
     /** Product attribute name. */
@@ -1945,6 +1771,8 @@ export interface ProductSpecificationDto {
     tenantId?: number;
     /** Product specification name. */
     name?: string | null;
+    /** Product specification description. */
+    description?: string | null;
     /** List of product attributes. */
     productAttributes?: ProductAttributeDto[] | null;
     /** Product specification creation time. */
@@ -2115,6 +1943,8 @@ export interface ProductVariantOptionDto {
 export interface ProductVariantDto {
     /** Product variant identifier. */
     id?: number;
+    /** Product variant unique identifier. */
+    uid?: string | null;
     /** Product version identifier. */
     productVersionId?: number;
     /** Product identifier. */
@@ -2129,6 +1959,8 @@ export interface ProductVariantDto {
     sortIndex?: number;
     /** Product variant identifier (usually SKU) in storefront / online store. */
     storefrontProductVariantId?: string | null;
+    /** Product variant SKU. */
+    sku?: string | null;
     /** A list of product variant options. */
     productVariantOptions?: ProductVariantOptionDto[] | null;
 }
@@ -2173,6 +2005,8 @@ export interface ProductVariantResourceDto {
 export interface ProductVariantDesignDto {
     /** Product variant identifier. */
     productVariantId?: number;
+    /** Product variant unique identifier. */
+    productVariantUID?: string | null;
     /** Product version identifier. */
     productVersionId?: number;
     /** Product identifier. */
@@ -2187,6 +2021,8 @@ export interface ProductVariantDesignDto {
     sortIndex?: number;
     /** Product variant identifier (usually SKU) in storefront / online store. */
     storefrontProductVariantId?: string | null;
+    /** Product variant SKU. */
+    sku?: string | null;
     /** Design identifier. */
     designId?: string | null;
     /** Design name. */
@@ -2225,6 +2061,8 @@ export declare enum SurfaceUsageType {
 export interface ProductVariantMockupDto {
     /** Product variant identifier. */
     productVariantId?: number;
+    /** Product variant unique identifier. */
+    productVariantUID?: string | null;
     /** Product version identifier. */
     productVersionId?: number;
     /** Product identifier. */
@@ -2233,6 +2071,8 @@ export interface ProductVariantMockupDto {
     tenantId?: number | null;
     /** Product variant identifier in online store (usually SKU). */
     storefrontProductVariantId?: string | null;
+    /** Product variant SKU. */
+    sku?: string | null;
     /** Mockup identifier. */
     mockupId?: string | null;
     /** Mockup name. */
@@ -2257,6 +2097,8 @@ export interface PagedOfProductVariantMockupDto {
 export interface ProductVariantDocumentDto {
     /** Product variant identifier. */
     productVariantId?: number;
+    /** Product variant unique identifier. */
+    productVariantUID?: string | null;
     /** Product version identifier. */
     productVersionId?: number;
     /** Product identifier. */
@@ -2271,6 +2113,8 @@ export interface ProductVariantDocumentDto {
     sortIndex?: number;
     /** Product variant identifier (usually SKU) in storefront / online store. */
     storefrontProductVariantId?: string | null;
+    /** Product variant SKU. */
+    sku?: string | null;
     /** Document identifier. */
     documentId?: string | null;
     /** Document name. */
@@ -2289,13 +2133,6 @@ export interface PagedOfProductVariantDocumentDto {
     /** Items list. */
     items?: ProductVariantDocumentDto[] | null;
 }
-/** Parameters for setting product variants price. */
-export interface SetProductVariantPriceDto {
-    /** Price. */
-    price?: number | null;
-    /** Identifiers of variants for price setting. */
-    variantIds?: number[] | null;
-}
 /** Defines all available date period filter values for queries. */
 export declare enum DatePeriod {
     All = "All",
@@ -2638,11 +2475,6 @@ export interface PagedOfProjectStatusDto {
     /** Items list. */
     items?: ProjectStatusDto[] | null;
 }
-/** Dto class, containing result of 'get project pdf url' operation. */
-export interface ProjectPdfResultDto {
-    /** Project pdf url. */
-    url?: string | null;
-}
 /** Dto class, containing description of a project output file. */
 export interface ProjectOutputFileDetailsDto {
     /** Project item identifier. */