@aurigma/axios-storefront-api-client - npm Package Compare versions

Comparing version 2.22.30 to 2.23.1

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

@@ -290,2 +290,10 @@ import { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
     /**
+     * Creates a new project by 'Render HiRes' scenario.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | undefined): Promise<ProjectDto>;
+    /**
      * Returns all available status transitions for a project.
@@ -332,2 +340,3 @@ * @param id Project identifier.
      * @return Success
+     * @deprecated
      */
@@ -343,5 +352,27 @@ getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined): Promise<ProjectPdfResultDto>;
      * @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.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProjectProcessingResults(id: number, tenantId?: number | null | undefined): Promise<ProjectProcessingResultsDto>;
+    /**
+     * Resumes project processing.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    resumeProjectProcessing(id: number, tenantId?: number | null | undefined): Promise<void>;
+    /**
+     * Restarts a project processing routine.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    restartProjectProcessing(id: number, tenantId?: number | null | undefined): Promise<void>;
+    /**
      * Returns an order description from the ecommerce system for the specified project.
@@ -402,2 +433,11 @@ * @param id Project identifier.
     /**
+     * Creates a new project by 'Render HiRes' scenario.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
+    protected processCreateByRenderHiResScenario(response: AxiosResponse): Promise<ProjectDto>;
+    /**
      * Returns all available status transitions for a project.
@@ -449,2 +489,3 @@ * @param id Project identifier.
      * @return Success
+     * @deprecated
      */
@@ -461,2 +502,3 @@ getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectPdfResultDto>;
      * @return Success
+     * @deprecated
      */
@@ -466,2 +508,26 @@ getProjectPdfZip(id: number, designUserId: string, designId: string, attachment?: boolean | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
     /**
+     * Returns a project processing results.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProjectProcessingResults(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectProcessingResultsDto>;
+    protected processGetProjectProcessingResults(response: AxiosResponse): Promise<ProjectProcessingResultsDto>;
+    /**
+     * Resumes project processing.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    resumeProjectProcessing(id: number, 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 tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    restartProjectProcessing(id: number, 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.
@@ -789,6 +855,6 @@ * @param id Project identifier.
 /** Available product resource types */
-export declare enum ProjectProductResourceType {
-    _0 = 0,
-    _1 = 1,
-    _2 = 2
+export declare enum ProjectItemResourceType {
+    General = "General",
+    Preview = "Preview",
+    Hires = "Hires"
 }
@@ -801,3 +867,3 @@ /** Dto class, containing information about a project item resource. */
     name?: string | null;
-    type?: ProjectProductResourceType;
+    type?: ProjectItemResourceType;
 }
@@ -875,3 +941,3 @@ /** Dto class, containing information about a project item. */
     name?: string | null;
-    type?: ProjectProductResourceType;
+    type?: ProjectItemResourceType;
 }
@@ -924,2 +990,61 @@ /** Dto class, containing create operation paramters for a project item. */
 }
+/** Dto class, containing ecommerce order description. */
+export interface OrderDetailsDto {
+    /** 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. */
+    customerName?: string | null;
+}
+export declare enum RenderHiResScenarioOutputFormat {
+    Pdf = "Pdf",
+    Jpeg = "Jpeg",
+    Png = "Png",
+    Tiff = "Tiff"
+}
+export declare enum RenderHiResScenarioOutputColorSpace {
+    Rgb = "Rgb",
+    Grayscale = "Grayscale",
+    Cmyk = "Cmyk"
+}
+export declare enum RenderHiResScenarioOutputFlipMode {
+    None = "None",
+    Horizontal = "Horizontal",
+    Vertical = "Vertical",
+    Both = "Both"
+}
+/** Dto class, containing 'RenderHiRes' scenario paramters. */
+export interface RenderHiResScenarioDto {
+    /** Private design identifier. */
+    designId: string;
+    /** Output file name (without extension). */
+    name?: string | null;
+    /** Output file DPI. */
+    dpi?: number;
+    format?: RenderHiResScenarioOutputFormat;
+    colorSpace?: RenderHiResScenarioOutputColorSpace;
+    flipMode?: RenderHiResScenarioOutputFlipMode;
+    /** Output file access mode. */
+    anonymousAccess?: boolean | null;
+}
+/** Dto class, containing 'create' operation parameters for project entity. */
+export interface CreateProjectByRenderHiResScenarioDto {
+    /** Project owner identifier. */
+    ownerId: string;
+    /** Project name. */
+    name?: string | null;
+    /** Description of the project. */
+    description?: string | null;
+    orderDetails?: OrderDetailsDto;
+    scenario: RenderHiResScenarioDto;
+}
 /** Project transition dto class. */
@@ -967,2 +1092,30 @@ export interface ProjectTransitionDto {
 }
+/** 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. */
+    url?: string | null;
+    /** Project output file name */
+    name?: string | null;
+    /** Project output file format */
+    format?: string | null;
+    /** Project output file id withing artifacts storage. */
+    artifactId?: string | null;
+    /** Project output file access strategy. */
+    anonymousAccess?: boolean;
+}
+/** Dto class, containing description of project processing results. */
+export interface ProjectProcessingResultsDto {
+    status?: ProjectProcessingStatus;
+    /** Project status description. */
+    statusDescription?: string | null;
+    /** Collection of project output file descriptions. */
+    outputFileDetails?: ProjectOutputFileDetailsDto[] | null;
+}
 /** Storefront types. */
@@ -969,0 +1122,0 @@ export declare enum StorefrontType {

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

@@ -290,2 +290,10 @@ import { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
     /**
+     * Creates a new project by 'Render HiRes' scenario.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | undefined): Promise<ProjectDto>;
+    /**
      * Returns all available status transitions for a project.
@@ -332,2 +340,3 @@ * @param id Project identifier.
      * @return Success
+     * @deprecated
      */
@@ -343,5 +352,27 @@ getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined): Promise<ProjectPdfResultDto>;
      * @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.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProjectProcessingResults(id: number, tenantId?: number | null | undefined): Promise<ProjectProcessingResultsDto>;
+    /**
+     * Resumes project processing.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    resumeProjectProcessing(id: number, tenantId?: number | null | undefined): Promise<void>;
+    /**
+     * Restarts a project processing routine.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    restartProjectProcessing(id: number, tenantId?: number | null | undefined): Promise<void>;
+    /**
      * Returns an order description from the ecommerce system for the specified project.
@@ -402,2 +433,11 @@ * @param id Project identifier.
     /**
+     * Creates a new project by 'Render HiRes' scenario.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
+    protected processCreateByRenderHiResScenario(response: AxiosResponse): Promise<ProjectDto>;
+    /**
      * Returns all available status transitions for a project.
@@ -449,2 +489,3 @@ * @param id Project identifier.
      * @return Success
+     * @deprecated
      */
@@ -461,2 +502,3 @@ getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectPdfResultDto>;
      * @return Success
+     * @deprecated
      */
@@ -466,2 +508,26 @@ getProjectPdfZip(id: number, designUserId: string, designId: string, attachment?: boolean | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
     /**
+     * Returns a project processing results.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProjectProcessingResults(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectProcessingResultsDto>;
+    protected processGetProjectProcessingResults(response: AxiosResponse): Promise<ProjectProcessingResultsDto>;
+    /**
+     * Resumes project processing.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    resumeProjectProcessing(id: number, 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 tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    restartProjectProcessing(id: number, 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.
@@ -789,6 +855,6 @@ * @param id Project identifier.
 /** Available product resource types */
-export declare enum ProjectProductResourceType {
-    _0 = 0,
-    _1 = 1,
-    _2 = 2
+export declare enum ProjectItemResourceType {
+    General = "General",
+    Preview = "Preview",
+    Hires = "Hires"
 }
@@ -801,3 +867,3 @@ /** Dto class, containing information about a project item resource. */
     name?: string | null;
-    type?: ProjectProductResourceType;
+    type?: ProjectItemResourceType;
 }
@@ -875,3 +941,3 @@ /** Dto class, containing information about a project item. */
     name?: string | null;
-    type?: ProjectProductResourceType;
+    type?: ProjectItemResourceType;
 }
@@ -924,2 +990,61 @@ /** Dto class, containing create operation paramters for a project item. */
 }
+/** Dto class, containing ecommerce order description. */
+export interface OrderDetailsDto {
+    /** 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. */
+    customerName?: string | null;
+}
+export declare enum RenderHiResScenarioOutputFormat {
+    Pdf = "Pdf",
+    Jpeg = "Jpeg",
+    Png = "Png",
+    Tiff = "Tiff"
+}
+export declare enum RenderHiResScenarioOutputColorSpace {
+    Rgb = "Rgb",
+    Grayscale = "Grayscale",
+    Cmyk = "Cmyk"
+}
+export declare enum RenderHiResScenarioOutputFlipMode {
+    None = "None",
+    Horizontal = "Horizontal",
+    Vertical = "Vertical",
+    Both = "Both"
+}
+/** Dto class, containing 'RenderHiRes' scenario paramters. */
+export interface RenderHiResScenarioDto {
+    /** Private design identifier. */
+    designId: string;
+    /** Output file name (without extension). */
+    name?: string | null;
+    /** Output file DPI. */
+    dpi?: number;
+    format?: RenderHiResScenarioOutputFormat;
+    colorSpace?: RenderHiResScenarioOutputColorSpace;
+    flipMode?: RenderHiResScenarioOutputFlipMode;
+    /** Output file access mode. */
+    anonymousAccess?: boolean | null;
+}
+/** Dto class, containing 'create' operation parameters for project entity. */
+export interface CreateProjectByRenderHiResScenarioDto {
+    /** Project owner identifier. */
+    ownerId: string;
+    /** Project name. */
+    name?: string | null;
+    /** Description of the project. */
+    description?: string | null;
+    orderDetails?: OrderDetailsDto;
+    scenario: RenderHiResScenarioDto;
+}
 /** Project transition dto class. */
@@ -967,2 +1092,30 @@ export interface ProjectTransitionDto {
 }
+/** 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. */
+    url?: string | null;
+    /** Project output file name */
+    name?: string | null;
+    /** Project output file format */
+    format?: string | null;
+    /** Project output file id withing artifacts storage. */
+    artifactId?: string | null;
+    /** Project output file access strategy. */
+    anonymousAccess?: boolean;
+}
+/** Dto class, containing description of project processing results. */
+export interface ProjectProcessingResultsDto {
+    status?: ProjectProcessingStatus;
+    /** Project status description. */
+    statusDescription?: string | null;
+    /** Collection of project output file descriptions. */
+    outputFileDetails?: ProjectOutputFileDetailsDto[] | null;
+}
 /** Storefront types. */
@@ -969,0 +1122,0 @@ export declare enum StorefrontType {

package.json

 {
   "name": "@aurigma/axios-storefront-api-client",
-  "version": "2.22.30",
+  "version": "2.23.1",
   "license": "SEE LICENSE IN License.md",
@@ -5,0 +5,0 @@ "description": "Axios API Client for Storefront API service of Customer's Canvas web-to-print system.",

No alert changes

Improved metrics

Total package byte prevSize

601950

increased by11.07%

Lines of code

8779

increased by12.01%

No dependency changes