@aurigma/ng-design-atoms-api-client 2.48.1 → 2.50.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -412,6 +412,13 @@ export interface IDesignAtomsImagesApiClient {
412
412
  * @return Success
413
413
  */
414
414
  renderImagePreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderImagePreviewModel | null | undefined): Observable<FileResponse>;
415
+ /**
416
+ * Renders a web image preview with the specified parameters and saves rendering result as resource.
417
+ * @param tenantId (optional) Tenant identifier
418
+ * @param body (optional) Render model with preview parameters.
419
+ * @return Success
420
+ */
421
+ renderImagePreviewToResource(tenantId?: number | undefined, body?: RenderImagePreviewToResourceModel | null | undefined): Observable<ResourceInfoDto>;
415
422
  }
416
423
  export declare class DesignAtomsImagesApiClient extends ApiClientBase implements IDesignAtomsImagesApiClient {
417
424
  private http;
@@ -428,6 +435,14 @@ export declare class DesignAtomsImagesApiClient extends ApiClientBase implements
428
435
  */
429
436
  renderImagePreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderImagePreviewModel | null | undefined): Observable<FileResponse>;
430
437
  protected processRenderImagePreview(response: HttpResponseBase): Observable<FileResponse>;
438
+ /**
439
+ * Renders a web image preview with the specified parameters and saves rendering result as resource.
440
+ * @param tenantId (optional) Tenant identifier
441
+ * @param body (optional) Render model with preview parameters.
442
+ * @return Success
443
+ */
444
+ renderImagePreviewToResource(tenantId?: number | undefined, body?: RenderImagePreviewToResourceModel | null | undefined): Observable<ResourceInfoDto>;
445
+ protected processRenderImagePreviewToResource(response: HttpResponseBase): Observable<ResourceInfoDto>;
431
446
  }
432
447
  export interface IDesignAtomsMockups3dApiClient {
433
448
  /**
@@ -630,6 +645,13 @@ export interface IDesignAtomsServiceApiClient {
630
645
  * @return Success
631
646
  */
632
647
  createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, sourceFile?: FileParameter | null | undefined): Observable<any>;
648
+ /**
649
+ * Extracts product item image.
650
+ * @param tenantId (optional) Tenant identifier
651
+ * @param body (optional) Extraction parameters.
652
+ * @return Success
653
+ */
654
+ extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | null | undefined): Observable<FileResponse>;
633
655
  /**
634
656
  * Creates a private design from a public design.
635
657
  * @param designId (optional) Public design ID.
@@ -657,6 +679,13 @@ export interface IDesignAtomsServiceApiClient {
657
679
  * @return Success
658
680
  */
659
681
  renderDesignPreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignPreviewModel | null | undefined): Observable<FileResponse>;
682
+ /**
683
+ * Renders a design preview with the specified parameters and saves rendering result as resource.
684
+ * @param tenantId (optional) Tenant identifier
685
+ * @param body (optional) Render model with preview parameters.
686
+ * @return Success
687
+ */
688
+ renderDesignPreviewToResource(tenantId?: number | undefined, body?: RenderDesignPreviewToResourceModel | null | undefined): Observable<ResourceInfoDto>;
660
689
  /**
661
690
  * Renders a design proof with the specified parameters.
662
691
  * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
@@ -666,6 +695,13 @@ export interface IDesignAtomsServiceApiClient {
666
695
  * @return Success
667
696
  */
668
697
  renderDesignProof(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignProofModel | null | undefined): Observable<FileResponse>;
698
+ /**
699
+ * Renders a design proof with the specified parameters and saves rendering result as resource.
700
+ * @param tenantId (optional) Tenant identifier
701
+ * @param body (optional) Render model with preview parameters.
702
+ * @return Success
703
+ */
704
+ renderDesignProofToResource(tenantId?: number | undefined, body?: RenderDesignProofToResourceModel | null | undefined): Observable<ResourceInfoDto>;
669
705
  /**
670
706
  * Render product proof image with specified parameters.
671
707
  * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
@@ -845,6 +881,14 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
845
881
  */
846
882
  createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, sourceFile?: FileParameter | null | undefined): Observable<any>;
847
883
  protected processCreateItem(response: HttpResponseBase): Observable<any>;
884
+ /**
885
+ * Extracts product item image.
886
+ * @param tenantId (optional) Tenant identifier
887
+ * @param body (optional) Extraction parameters.
888
+ * @return Success
889
+ */
890
+ extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | null | undefined): Observable<FileResponse>;
891
+ protected processExtractItemImage(response: HttpResponseBase): Observable<FileResponse>;
848
892
  /**
849
893
  * Creates a private design from a public design.
850
894
  * @param designId (optional) Public design ID.
@@ -875,6 +919,14 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
875
919
  */
876
920
  renderDesignPreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignPreviewModel | null | undefined): Observable<FileResponse>;
877
921
  protected processRenderDesignPreview(response: HttpResponseBase): Observable<FileResponse>;
922
+ /**
923
+ * Renders a design preview with the specified parameters and saves rendering result as resource.
924
+ * @param tenantId (optional) Tenant identifier
925
+ * @param body (optional) Render model with preview parameters.
926
+ * @return Success
927
+ */
928
+ renderDesignPreviewToResource(tenantId?: number | undefined, body?: RenderDesignPreviewToResourceModel | null | undefined): Observable<ResourceInfoDto>;
929
+ protected processRenderDesignPreviewToResource(response: HttpResponseBase): Observable<ResourceInfoDto>;
878
930
  /**
879
931
  * Renders a design proof with the specified parameters.
880
932
  * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
@@ -885,6 +937,14 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
885
937
  */
886
938
  renderDesignProof(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignProofModel | null | undefined): Observable<FileResponse>;
887
939
  protected processRenderDesignProof(response: HttpResponseBase): Observable<FileResponse>;
940
+ /**
941
+ * Renders a design proof with the specified parameters and saves rendering result as resource.
942
+ * @param tenantId (optional) Tenant identifier
943
+ * @param body (optional) Render model with preview parameters.
944
+ * @return Success
945
+ */
946
+ renderDesignProofToResource(tenantId?: number | undefined, body?: RenderDesignProofToResourceModel | null | undefined): Observable<ResourceInfoDto>;
947
+ protected processRenderDesignProofToResource(response: HttpResponseBase): Observable<ResourceInfoDto>;
888
948
  /**
889
949
  * Render product proof image with specified parameters.
890
950
  * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
@@ -1470,6 +1530,36 @@ export interface RenderImagePreviewModel {
1470
1530
  /** Image preview configuration. */
1471
1531
  renderingConfig?: ImagePreviewRenderingConfig | null;
1472
1532
  }
1533
+ export interface ResourceParams {
1534
+ ownerId?: string | null;
1535
+ namespace?: string | null;
1536
+ name?: string | null;
1537
+ sourceId?: string | null;
1538
+ type?: string | null;
1539
+ anonymousAccess?: boolean;
1540
+ }
1541
+ export interface RenderImagePreviewToResourceModel {
1542
+ /** Parameters of resource that should be created for a preview rendering result. */
1543
+ previewResourceParams?: ResourceParams | null;
1544
+ /** External image URL. */
1545
+ imageUrl?: string | null;
1546
+ /** Storage image identifier. */
1547
+ imageId?: string | null;
1548
+ /** Storage image owner identifier. */
1549
+ ownerId?: string | null;
1550
+ /** Mockup identifier. */
1551
+ mockupId?: string | null;
1552
+ /** Image preview configuration. */
1553
+ renderingConfig?: ImagePreviewRenderingConfig | null;
1554
+ }
1555
+ export interface ResourceInfoDto {
1556
+ id?: string | null;
1557
+ ownerId?: string | null;
1558
+ name?: string | null;
1559
+ namespace?: string | null;
1560
+ private?: boolean;
1561
+ url?: string | null;
1562
+ }
1473
1563
  export interface Mockup3dAttributesDto {
1474
1564
  data?: {
1475
1565
  [key: string]: string;
@@ -1582,6 +1672,11 @@ export declare enum ItemSourceType {
1582
1672
  ImageStorage = "ImageStorage",
1583
1673
  PrivateImageStorage = "PrivateImageStorage"
1584
1674
  }
1675
+ /** Render product parameters */
1676
+ export interface ExtractItemImageModel {
1677
+ /** Serialized item description */
1678
+ item: any;
1679
+ }
1585
1680
  /** Product preview file format. */
1586
1681
  export declare enum ProductPreviewFormat {
1587
1682
  Jpeg = "Jpeg",
@@ -1607,6 +1702,22 @@ Used to get mockup file from public storage. */
1607
1702
  /** Variable (user) data for design variable fields in the preview image. */
1608
1703
  variableData?: VariableInfo[] | null;
1609
1704
  }
1705
+ export interface RenderDesignPreviewToResourceModel {
1706
+ /** Parameters of resource that should be created for a preview rendering result. */
1707
+ previewResourceParams?: ResourceParams | null;
1708
+ /** Design ID.
1709
+ Used to get design file from public or private storage. */
1710
+ designId?: string | null;
1711
+ /** Mockup ID.
1712
+ Used to get mockup file from public storage. */
1713
+ mockupId?: string | null;
1714
+ /** ID of the design owner. */
1715
+ ownerId?: string | null;
1716
+ /** Rendering configuration for getting a preview of design. */
1717
+ renderingConfig?: ProductPreviewRenderingConfig | null;
1718
+ /** Variable (user) data for design variable fields in the preview image. */
1719
+ variableData?: VariableInfo[] | null;
1720
+ }
1610
1721
  export declare enum ProductProofFormat {
1611
1722
  Jpeg = "Jpeg",
1612
1723
  Png = "Png",
@@ -1657,6 +1768,19 @@ Used to get design file from public or private storage. */
1657
1768
  /** Variable (user) data for design variable fields in the proof image. */
1658
1769
  variableData?: VariableInfo[] | null;
1659
1770
  }
1771
+ export interface RenderDesignProofToResourceModel {
1772
+ /** Parameters of resource that should be created for a preview rendering result. */
1773
+ proofResourceParams?: ResourceParams | null;
1774
+ /** Design ID.
1775
+ Used to get design file from public or private storage. */
1776
+ designId?: string | null;
1777
+ /** ID of the design owner. */
1778
+ ownerId?: string | null;
1779
+ /** Rendering configuration for getting a proof image of design. */
1780
+ renderingConfig?: ProductProofRenderingConfig | null;
1781
+ /** Variable (user) data for design variable fields in the proof image. */
1782
+ variableData?: VariableInfo[] | null;
1783
+ }
1660
1784
  /** Render product parameters */
1661
1785
  export interface RenderProductModel {
1662
1786
  /** Serialized product description */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aurigma/ng-design-atoms-api-client",
3
- "version": "2.48.1",
3
+ "version": "2.50.1",
4
4
  "license": "SEE LICENSE IN License.md",
5
5
  "description": "Angular API Client for Design Atoms API service of Customer's Canvas web-to-print system.",
6
6
  "author": "Aurigma Inc <info@aurigma.com> (https://customerscanvas.com)",