@aurigma/axios-design-atoms-api-client 2.63.1 → 2.64.1

package/dist/esm/design-atoms-api-client.d.ts

@@ -401,7 +401,7 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
 }
 export interface IDesignAtomsImagesApiClient {
     /**
-     * Renders a web image preview with the specified parameters.
+     * Renders a preview of an image with the specified parameters.
      * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
     (default value is 'false').
      * @param tenantId (optional) Tenant identifier
@@ -410,7 +410,58 @@ export interface IDesignAtomsImagesApiClient {
      */
     renderImagePreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderImagePreviewModel | undefined): Promise<FileResponse>;
     /**
-     * Renders a web image preview with the specified parameters and saves rendering result as resource.
+     * Renders a preview of an uploaded image with the specified parameters.
+     * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
+    (default value is 'false').
+     * @param tenantId (optional) Tenant identifier
+     * @param sourceFile (optional)
+     * @param mockupOwnerId (optional)
+     * @param mockupId (optional)
+     * @param width (optional)
+     * @param height (optional)
+     * @param fileFormat (optional)
+     * @param fitMode (optional)
+     * @return Success
+     */
+    renderImagePreviewFromFile(attachment?: boolean | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined): Promise<FileResponse>;
+    /**
+     * Renders a preview of an uploaded image with the specified parameters and saves rendering result as resource.
+     * @param tenantId (optional) Tenant identifier
+     * @param resourceOwnerId (optional)
+     * @param resourceNamespace (optional)
+     * @param resourceName (optional)
+     * @param resourceSourceId (optional)
+     * @param resourceType (optional)
+     * @param anonymousAccess (optional)
+     * @param overwriteExistingResource (optional)
+     * @param sourceFile (optional)
+     * @param mockupOwnerId (optional)
+     * @param mockupId (optional)
+     * @param width (optional)
+     * @param height (optional)
+     * @param fileFormat (optional)
+     * @param fitMode (optional)
+     * @return Success
+     */
+    renderImagePreviewFromFileToResource(tenantId?: number | undefined, resourceOwnerId?: string | null | undefined, resourceNamespace?: string | null | undefined, resourceName?: string | null | undefined, resourceSourceId?: string | null | undefined, resourceType?: string | null | undefined, anonymousAccess?: boolean | undefined, overwriteExistingResource?: boolean | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined): Promise<ResourceInfoDto>;
+    /**
+     * Renders a preview of a web image with the specified parameters.
+     * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
+    (default value is 'false').
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderImagePreviewFromUrl(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderImagePreviewFromUrlModel | undefined): Promise<FileResponse>;
+    /**
+     * Renders a preview of a web image with the specified parameters and saves rendering result as resource.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderImagePreviewFromUrlToResource(tenantId?: number | undefined, body?: RenderImagePreviewFromUrlToResourceModel | undefined): Promise<ResourceInfoDto>;
+    /**
+     * Renders a preview of an image with the specified parameters and saves rendering result as resource.
      * @param tenantId (optional) Tenant identifier
      * @param body (optional) Render model with preview parameters.
      * @return Success
@@ -423,7 +474,7 @@ export declare class DesignAtomsImagesApiClient extends ApiClientBase implements
     protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
     constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
     /**
-     * Renders a web image preview with the specified parameters.
+     * Renders a preview of an image with the specified parameters.
      * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
     (default value is 'false').
      * @param tenantId (optional) Tenant identifier
@@ -433,7 +484,62 @@ export declare class DesignAtomsImagesApiClient extends ApiClientBase implements
     renderImagePreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderImagePreviewModel | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
     protected processRenderImagePreview(response: AxiosResponse): Promise<FileResponse>;
     /**
-     * Renders a web image preview with the specified parameters and saves rendering result as resource.
+     * Renders a preview of an uploaded image with the specified parameters.
+     * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
+    (default value is 'false').
+     * @param tenantId (optional) Tenant identifier
+     * @param sourceFile (optional)
+     * @param mockupOwnerId (optional)
+     * @param mockupId (optional)
+     * @param width (optional)
+     * @param height (optional)
+     * @param fileFormat (optional)
+     * @param fitMode (optional)
+     * @return Success
+     */
+    renderImagePreviewFromFile(attachment?: boolean | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processRenderImagePreviewFromFile(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Renders a preview of an uploaded image with the specified parameters and saves rendering result as resource.
+     * @param tenantId (optional) Tenant identifier
+     * @param resourceOwnerId (optional)
+     * @param resourceNamespace (optional)
+     * @param resourceName (optional)
+     * @param resourceSourceId (optional)
+     * @param resourceType (optional)
+     * @param anonymousAccess (optional)
+     * @param overwriteExistingResource (optional)
+     * @param sourceFile (optional)
+     * @param mockupOwnerId (optional)
+     * @param mockupId (optional)
+     * @param width (optional)
+     * @param height (optional)
+     * @param fileFormat (optional)
+     * @param fitMode (optional)
+     * @return Success
+     */
+    renderImagePreviewFromFileToResource(tenantId?: number | undefined, resourceOwnerId?: string | null | undefined, resourceNamespace?: string | null | undefined, resourceName?: string | null | undefined, resourceSourceId?: string | null | undefined, resourceType?: string | null | undefined, anonymousAccess?: boolean | undefined, overwriteExistingResource?: boolean | undefined, sourceFile?: FileParameter | null | undefined, mockupOwnerId?: string | null | undefined, mockupId?: string | null | undefined, width?: number | null | undefined, height?: number | null | undefined, fileFormat?: ImagePreviewFormat | null | undefined, fitMode?: ImagePreviewFitMode | null | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
+    protected processRenderImagePreviewFromFileToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
+    /**
+     * Renders a preview of a web image with the specified parameters.
+     * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
+    (default value is 'false').
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderImagePreviewFromUrl(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderImagePreviewFromUrlModel | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processRenderImagePreviewFromUrl(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Renders a preview of a web image with the specified parameters and saves rendering result as resource.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderImagePreviewFromUrlToResource(tenantId?: number | undefined, body?: RenderImagePreviewFromUrlToResourceModel | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
+    protected processRenderImagePreviewFromUrlToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
+    /**
+     * Renders a preview of an image with the specified parameters and saves rendering result as resource.
      * @param tenantId (optional) Tenant identifier
      * @param body (optional) Render model with preview parameters.
      * @return Success
@@ -630,17 +736,6 @@ export interface IDesignAtomsServiceApiClient {
      * @return Success
      */
     convertColors(tenantId?: number | undefined, body?: ConvertColorsModel | undefined): Promise<any>;
-    /**
-     * Creates product item.
-     * @param itemType (optional) Desired item type.
-     * @param tenantId (optional) Tenant identifier
-     * @param sourceType (optional)
-     * @param sourceId (optional)
-     * @param sourceOwnerId (optional)
-     * @param sourceFile (optional)
-     * @return Success
-     */
-    createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, sourceFile?: FileParameter | null | undefined): Promise<any>;
     /**
      * Extracts product item image.
      * @param tenantId (optional) Tenant identifier
@@ -655,6 +750,54 @@ export interface IDesignAtomsServiceApiClient {
      * @return Success
      */
     flattenItems(tenantId?: number | undefined, body?: any[] | undefined): Promise<any>;
+    /**
+     * Creates product item from input image file.
+     * @param itemType (optional) Desired item type.
+     * @param tenantId (optional) Tenant identifier
+     * @param sourceFile (optional)
+     * @return Success
+     */
+    createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined): Promise<any>;
+    /**
+     * Creates multiple product items from input image files.
+     * @param itemType (optional) Desired items type.
+     * @param tenantId (optional) Tenant identifier
+     * @param sourceFiles (optional)
+     * @return Success
+     */
+    batchCreateItemsFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFiles?: FileParameter[] | null | undefined): Promise<any>;
+    /**
+     * Creates product item from image in storage.
+     * @param itemType (optional) Desired item type.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Operation parameters.
+     * @return Success
+     */
+    createItemFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromStorageModel | undefined): Promise<any>;
+    /**
+     * Creates multiple product items from images in storage.
+     * @param itemType (optional) Desired items type.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Create items operation parameters.
+     * @return Success
+     */
+    batchCreateItemsFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromStorageModel | undefined): Promise<any>;
+    /**
+     * Creates product item from remote web image provided by URL.
+     * @param itemType (optional) Desired item type.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Operation parameters.
+     * @return Success
+     */
+    createItemFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromUrlModel | undefined): Promise<any>;
+    /**
+     * Creates multiple product items from remote web images provided by URLs list.
+     * @param itemType (optional) Desired items type.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Operation parameters.
+     * @return Success
+     */
+    batchCreateItemsFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromUrlModel | undefined): Promise<any>;
     /**
      * Render product proof image with specified parameters.
      * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
@@ -696,6 +839,19 @@ export interface IDesignAtomsServiceApiClient {
      * @return Success
      */
     renderDesignProofToResource(tenantId?: number | undefined, body?: RenderDesignProofToResourceModel | undefined): Promise<ResourceInfoDto>;
+    /**
+     * Creates product item.
+     * @param itemType (optional) Desired item type.
+     * @param tenantId (optional) Tenant identifier
+     * @param sourceType (optional)
+     * @param sourceId (optional)
+     * @param sourceOwnerId (optional)
+     * @param url (optional)
+     * @param sourceFile (optional)
+     * @return Success
+     * @deprecated
+     */
+    createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, url?: string | null | undefined, sourceFile?: FileParameter | null | undefined): Promise<any>;
     /**
      * Creates a private design from a public design.
      * @param designId (optional) Public design identifier.
@@ -866,18 +1022,6 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      */
     convertColors(tenantId?: number | undefined, body?: ConvertColorsModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
     protected processConvertColors(response: AxiosResponse): Promise<any>;
-    /**
-     * Creates product item.
-     * @param itemType (optional) Desired item type.
-     * @param tenantId (optional) Tenant identifier
-     * @param sourceType (optional)
-     * @param sourceId (optional)
-     * @param sourceOwnerId (optional)
-     * @param sourceFile (optional)
-     * @return Success
-     */
-    createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
-    protected processCreateItem(response: AxiosResponse): Promise<any>;
     /**
      * Extracts product item image.
      * @param tenantId (optional) Tenant identifier
@@ -894,6 +1038,60 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      */
     flattenItems(tenantId?: number | undefined, body?: any[] | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
     protected processFlattenItems(response: AxiosResponse): Promise<any>;
+    /**
+     * Creates product item from input image file.
+     * @param itemType (optional) Desired item type.
+     * @param tenantId (optional) Tenant identifier
+     * @param sourceFile (optional)
+     * @return Success
+     */
+    createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
+    protected processCreateItemFromFile(response: AxiosResponse): Promise<any>;
+    /**
+     * Creates multiple product items from input image files.
+     * @param itemType (optional) Desired items type.
+     * @param tenantId (optional) Tenant identifier
+     * @param sourceFiles (optional)
+     * @return Success
+     */
+    batchCreateItemsFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFiles?: FileParameter[] | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
+    protected processBatchCreateItemsFromFile(response: AxiosResponse): Promise<any>;
+    /**
+     * Creates product item from image in storage.
+     * @param itemType (optional) Desired item type.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Operation parameters.
+     * @return Success
+     */
+    createItemFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromStorageModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
+    protected processCreateItemFromStorage(response: AxiosResponse): Promise<any>;
+    /**
+     * Creates multiple product items from images in storage.
+     * @param itemType (optional) Desired items type.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Create items operation parameters.
+     * @return Success
+     */
+    batchCreateItemsFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromStorageModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
+    protected processBatchCreateItemsFromStorage(response: AxiosResponse): Promise<any>;
+    /**
+     * Creates product item from remote web image provided by URL.
+     * @param itemType (optional) Desired item type.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Operation parameters.
+     * @return Success
+     */
+    createItemFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromUrlModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
+    protected processCreateItemFromUrl(response: AxiosResponse): Promise<any>;
+    /**
+     * Creates multiple product items from remote web images provided by URLs list.
+     * @param itemType (optional) Desired items type.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Operation parameters.
+     * @return Success
+     */
+    batchCreateItemsFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromUrlModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
+    protected processBatchCreateItemsFromUrl(response: AxiosResponse): Promise<any>;
     /**
      * Render product proof image with specified parameters.
      * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
@@ -940,6 +1138,20 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      */
     renderDesignProofToResource(tenantId?: number | undefined, body?: RenderDesignProofToResourceModel | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
     protected processRenderDesignProofToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
+    /**
+     * Creates product item.
+     * @param itemType (optional) Desired item type.
+     * @param tenantId (optional) Tenant identifier
+     * @param sourceType (optional)
+     * @param sourceId (optional)
+     * @param sourceOwnerId (optional)
+     * @param url (optional)
+     * @param sourceFile (optional)
+     * @return Success
+     * @deprecated
+     */
+    createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, url?: string | null | undefined, sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
+    protected processCreateItem(response: AxiosResponse): Promise<any>;
     /**
      * Creates a private design from a public design.
      * @param designId (optional) Public design identifier.
@@ -1371,6 +1583,18 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
     updateShapeItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
     protected processUpdateShapeItemHandler(response: AxiosResponse): Promise<any>;
 }
+/** Batch create items from storage source operation parameters. */
+export interface BatchCreateItemsFromStorageModel {
+    /** Source image assets owner identifier. If value is set, all images should belong to a specified user. */
+    sourceOwnerId?: string | null;
+    /** Source image asset identifiers. */
+    sourceIds?: string[] | null;
+}
+/** Batch create items from web source operation parameters. */
+export interface BatchCreateItemsFromUrlModel {
+    /** Source URLs. */
+    urls?: string[] | null;
+}
 /** Information about a service. */
 export interface BuildInfoModel {
     /** Version number. */
@@ -1408,6 +1632,18 @@ export interface CreateDesignModel {
     /** Design location (folder path). */
     path?: string | null;
 }
+/** Create item from storage source operation parameters. */
+export interface CreateItemFromStorageModel {
+    /** Source image asset owner identifier. If value is set, all images should belong to a specified user. */
+    sourceOwnerId?: string | null;
+    /** Source image asset identifier. */
+    sourceId?: string | null;
+}
+/** Create item from web source operation parameters. */
+export interface CreateItemFromUrlModel {
+    /** Source URL. */
+    url?: string | null;
+}
 export declare enum DesignElementType {
     Product = "Product",
     Design = "Design",
@@ -1481,7 +1717,8 @@ export interface ImagePreviewRenderingConfig {
 export declare enum ItemSourceType {
     File = "File",
     ImageStorage = "ImageStorage",
-    PrivateImageStorage = "PrivateImageStorage"
+    PrivateImageStorage = "PrivateImageStorage",
+    Url = "Url"
 }
 export declare enum ItemType {
     Image = "Image",
@@ -1635,6 +1872,8 @@ Used to get mockup file from public storage. */
 export interface RenderDesignPreviewToResourceModel {
     /** Parameters of resource that should be created for a preview rendering result. */
     previewResourceParams?: ResourceParams | null;
+    /** Flag that indicates if an existing resource should be overwritten. */
+    overwriteExistingResource?: boolean;
     /** Design identifier.
 Used to get design file from public or private storage. */
     designId?: string | null;
@@ -1664,6 +1903,8 @@ Used to get design file from public or private storage. */
 export interface RenderDesignProofToResourceModel {
     /** Parameters of resource that should be created for a preview rendering result. */
     proofResourceParams?: ResourceParams | null;
+    /** Flag that indicates if an existing resource should be overwritten. */
+    overwriteExistingResource?: boolean;
     /** Design identifier.
 Used to get design file from public or private storage. */
     designId?: string | null;
@@ -1674,6 +1915,32 @@ Used to get design file from public or private storage. */
     /** Variable (user) data for design variable fields in the proof image. */
     variableData?: VariableInfo[] | null;
 }
+/** Web image preview rendering parameters. */
+export interface RenderImagePreviewFromUrlModel {
+    /** Web image URL. */
+    imageUrl?: string | null;
+    /** Mockup owner identifier. */
+    mockupOwnerId?: string | null;
+    /** Mockup identifier. */
+    mockupId?: string | null;
+    /** Image preview configuration. */
+    renderingConfig?: ImagePreviewRenderingConfig | null;
+}
+/** Image preview rendering parameters. Result will be saved as resource with parameters set as Aurigma.DesignAtomsApi.WebApi.Models.Image.RenderImagePreviewFromUrlToResourceModel.PreviewResourceParams. */
+export interface RenderImagePreviewFromUrlToResourceModel {
+    /** Parameters of resource that should be created for a preview rendering result. */
+    previewResourceParams?: ResourceParams | null;
+    /** Flag that indicates if an existing resource should be overwritten. */
+    overwriteExistingResource?: boolean;
+    /** Web image URL. */
+    imageUrl?: string | null;
+    /** Mockup owner identifier. */
+    mockupOwnerId?: string | null;
+    /** Mockup identifier. */
+    mockupId?: string | null;
+    /** Image preview configuration. */
+    renderingConfig?: ImagePreviewRenderingConfig | null;
+}
 /** Image preview rendering parameters. */
 export interface RenderImagePreviewModel {
     /** External image URL. */
@@ -1693,6 +1960,8 @@ export interface RenderImagePreviewModel {
 export interface RenderImagePreviewToResourceModel {
     /** Parameters of resource that should be created for a preview rendering result. */
     previewResourceParams?: ResourceParams | null;
+    /** Flag that indicates if an existing resource should be overwritten. */
+    overwriteExistingResource?: boolean;
     /** External image URL. */
     imageUrl?: string | null;
     /** Storage image identifier. */