@aurigma/axios-design-atoms-api-client 2.64.1 → 2.65.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.
@@ -606,43 +606,202 @@ export declare class DesignAtomsMockups3dApiClient extends ApiClientBase impleme
606
606
  getGeometryFile(id: string, ownerId?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
607
607
  protected processGetGeometryFile(response: AxiosResponse): Promise<FileResponse>;
608
608
  }
609
- export interface IDesignAtomsServiceApiClient {
609
+ export interface IDesignAtomsPrintProductApiClient {
610
610
  /**
611
- * Creates new design file with specified parameters and saves it in storage.
611
+ * Patches a print-product of the specified design file.
612
+ * @param id Design identifier.
612
613
  * @param privateStorageOwner (optional) Private storage owner identifier.
613
614
  * @param tenantId (optional) Tenant identifier
614
- * @param body (optional) Design creation parameters.
615
- * @return Created
615
+ * @param patchType (optional)
616
+ * @param replaceImageItemFileInfo_itemName (optional)
617
+ * @param replaceImageItemFileInfo_sourceFile (optional)
618
+ * @param replacePlaceholderItemContentInfo_placeholderItemName (optional)
619
+ * @param replacePlaceholderItemContentInfo_newContentType (optional)
620
+ * @param replacePlaceholderItemContentInfo_sourceFile (optional)
621
+ * @return No Content
616
622
  */
617
- createDesign(privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: CreateDesignModel | undefined): Promise<DesignInfo>;
623
+ patchDesignProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, replacePlaceholderItemContentInfo_placeholderItemName?: string | null | undefined, replacePlaceholderItemContentInfo_newContentType?: PlaceholderItemContentType | undefined, replacePlaceholderItemContentInfo_sourceFile?: FileParameter | null | undefined): Promise<void>;
618
624
  /**
619
- * Returns content of the background.
625
+ * Returns a print-product of the specified design file as a json-serialized model.
620
626
  * @param id Design identifier.
621
- * @param surfaceIndex (optional) Surface index.
622
627
  * @param privateStorageOwner (optional) Private storage owner identifier.
623
628
  * @param tenantId (optional) Tenant identifier
624
629
  * @return Success
625
630
  */
626
- extractBackground(id: string, surfaceIndex?: number | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
631
+ getDesignProductModel(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<any>;
632
+ /**
633
+ * Saves a print-product provided as a json-serialized model to the specified design file.
634
+ * @param id Design identifier.
635
+ * @param privateStorageOwner (optional) Private storage owner identifier.
636
+ * @param tenantId (optional) Tenant identifier
637
+ * @param body (optional) Serialized print-product description.
638
+ * @return No Content
639
+ */
640
+ updateDesignProductModel(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined): Promise<void>;
627
641
  /**
628
- * Loads product (design model) from design file taken from storage.
642
+ * Returns a list of print-area descriptions of the specified design file.
629
643
  * @param id Design identifier.
644
+ * @param surfaceId (optional)
630
645
  * @param privateStorageOwner (optional) Private storage owner identifier.
631
646
  * @param tenantId (optional) Tenant identifier
632
647
  * @return Success
633
648
  */
634
- loadProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<any>;
649
+ getDesignPrintAreas(id: string, surfaceId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<DesignPrintAreaDto[]>;
635
650
  /**
636
- * Saves product (design model) to design file and updates design in storage.
651
+ * Deletes a specified print-area in an existing design file.
637
652
  * @param id Design identifier.
653
+ * @param printAreaId Design print-area identifier.
654
+ * @param privateStorageOwner (optional) Private storage owner identifier.
655
+ * @param tenantId (optional) Tenant identifier
656
+ * @return No Content
657
+ */
658
+ deleteDesignPrintArea(id: string, printAreaId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
659
+ /**
660
+ * Returns a print-area of the specified design file as a json-serialized model.
661
+ * @param id Design identifier.
662
+ * @param printAreaId Design print-area identifier.
638
663
  * @param privateStorageOwner (optional) Private storage owner identifier.
639
664
  * @param tenantId (optional) Tenant identifier
640
- * @param body (optional) Serialized product description.
641
665
  * @return Success
642
666
  */
643
- saveProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined): Promise<void>;
667
+ getDesignPrintAreaModel(id: string, printAreaId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<any>;
668
+ /**
669
+ * Updates a specified print-area in an existing design file with the data provided as a json-serialized print-area model.
670
+ * @param id Design identifier.
671
+ * @param printAreaId Design print-area identifier.
672
+ * @param privateStorageOwner (optional) Private storage owner identifier.
673
+ * @param tenantId (optional) Tenant identifier
674
+ * @param body (optional) Updated print-area model.
675
+ * @return Success
676
+ */
677
+ updateDesignPrintAreaModel(id: string, printAreaId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined): Promise<any>;
678
+ /**
679
+ * Inserts a new print-area provided as a json-serialized model at the specified position in an existing design file.
680
+ Print-area identifier will be reset by auto-generated value to prevent identifiers collisions.
681
+ * @param id Design identifier.
682
+ * @param surfaceId (optional) Parent surface identifier.
683
+ * @param privateStorageOwner (optional) Private storage owner identifier.
684
+ * @param tenantId (optional) Tenant identifier
685
+ * @param body (optional) New print-area model.
686
+ * @return Success
687
+ */
688
+ addDesignPrintAreaModel(id: string, surfaceId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined): Promise<any>;
689
+ /**
690
+ * Returns a list of print-product surfaces descriptions of the specified design file.
691
+ * @param id Design identifier.
692
+ * @param privateStorageOwner (optional) Private storage owner identifier.
693
+ * @param tenantId (optional) Tenant identifier
694
+ * @return Success
695
+ */
696
+ getDesignSurfaces(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<DesignSurfaceDto[]>;
697
+ /**
698
+ * Deletes a specified print-product surface in an existing design file.
699
+ * @param id Design identifier.
700
+ * @param surfaceId Surface identifier.
701
+ * @param privateStorageOwner (optional) Private storage owner identifier.
702
+ * @param tenantId (optional) Tenant identifier
703
+ * @return No Content
704
+ */
705
+ deleteDesignSurface(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
706
+ /**
707
+ * Returns a down-mockup description of the specified surface in an existing design file.
708
+ * @param id Design identifier.
709
+ * @param surfaceId Design surface identifier.
710
+ * @param privateStorageOwner (optional) Private storage owner identifier.
711
+ * @param tenantId (optional) Tenant identifier
712
+ * @return Success
713
+ */
714
+ getDesignSurfaceDownMockup(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<DesignSurfaceMockupDto>;
715
+ /**
716
+ * Updates a content file of down-mockup for the specified surface in an existing design file.
717
+ * @param id Design identifier.
718
+ * @param surfaceId Design surface identifier.
719
+ * @param privateStorageOwner (optional) Private storage owner identifier.
720
+ * @param tenantId (optional) Tenant identifier
721
+ * @param position_top (optional)
722
+ * @param position_left (optional)
723
+ * @param sourceFile (optional)
724
+ * @return Success
725
+ */
726
+ updateDesignSurfaceDownMockup(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, position_top?: number | undefined, position_left?: number | undefined, sourceFile?: FileParameter | null | undefined): Promise<any>;
727
+ /**
728
+ * Returns a content file for down-mockup of the specified surface in an existing design file.
729
+ * @param id Design identifier.
730
+ * @param surfaceId Design surface identifier.
731
+ * @param privateStorageOwner (optional) Private storage owner identifier.
732
+ * @param tenantId (optional) Tenant identifier
733
+ * @return Success
734
+ */
735
+ getDesignSurfaceDownMockupContent(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
736
+ /**
737
+ * Returns an up-mockup description of the specified surface in an existing design file.
738
+ * @param id Design identifier.
739
+ * @param surfaceId Design surface identifier.
740
+ * @param privateStorageOwner (optional) Private storage owner identifier.
741
+ * @param tenantId (optional) Tenant identifier
742
+ * @return Success
743
+ */
744
+ getDesignSurfaceUpMockup(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<DesignSurfaceMockupDto>;
745
+ /**
746
+ * Updates a content file of up-mockup for the specified surface in an existing design.
747
+ * @param id Design identifier.
748
+ * @param surfaceId Design surface identifier.
749
+ * @param privateStorageOwner (optional) Private storage owner identifier.
750
+ * @param tenantId (optional) Tenant identifier
751
+ * @param position_top (optional)
752
+ * @param position_left (optional)
753
+ * @param sourceFile (optional)
754
+ * @return Success
755
+ */
756
+ updateDesignSurfaceUpMockup(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, position_top?: number | undefined, position_left?: number | undefined, sourceFile?: FileParameter | null | undefined): Promise<any>;
644
757
  /**
645
- * Patches product (design model) in design file.
758
+ * Returns a content file for up-mockup of the specified surface in an existing design file.
759
+ * @param id Design identifier.
760
+ * @param surfaceId Design surface identifier.
761
+ * @param privateStorageOwner (optional) Private storage owner identifier.
762
+ * @param tenantId (optional) Tenant identifier
763
+ * @return Success
764
+ */
765
+ getDesignSurfaceUpMockupContent(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
766
+ /**
767
+ * Returns a print-product surface of the specified design file as a json-serialized model.
768
+ * @param id Design identifier.
769
+ * @param surfaceId Surface identifier.
770
+ * @param privateStorageOwner (optional) Private storage owner identifier.
771
+ * @param tenantId (optional) Tenant identifier
772
+ * @return Success
773
+ */
774
+ getDesignSurfaceModel(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<any>;
775
+ /**
776
+ * Replaces a specified print-product surface in an existing design file with the data provided as a json-serialized surface model.
777
+ All identifiers of a replaced surface (including surface identifier) will be reset by auto-generated values to prevent identifiers collisions.
778
+ * @param id Design identifier.
779
+ * @param surfaceId Design surface identifier.
780
+ * @param privateStorageOwner (optional) Private storage owner identifier.
781
+ * @param tenantId (optional) Tenant identifier
782
+ * @param body (optional) Updated surface model.
783
+ * @return Success
784
+ */
785
+ replaceDesignSurfaceModel(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined): Promise<any>;
786
+ /**
787
+ * Inserts a new surface provided as a json-serialized model at the specified position in an existing design file.
788
+ All identifiers of a replaced surface (including surface identifier) will be reset by auto-generated values to prevent identifiers collisions.
789
+ * @param id Design identifier.
790
+ * @param surfaceIndex (optional) New surface index.
791
+ * @param privateStorageOwner (optional) Private storage owner identifier.
792
+ * @param tenantId (optional) Tenant identifier
793
+ * @param body (optional) New surface model.
794
+ * @return Success
795
+ */
796
+ addDesignSurfaceModel(id: string, surfaceIndex?: number | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined): Promise<any>;
797
+ }
798
+ export declare class DesignAtomsPrintProductApiClient extends ApiClientBase implements IDesignAtomsPrintProductApiClient {
799
+ private instance;
800
+ private baseUrl;
801
+ protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
802
+ constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
803
+ /**
804
+ * Patches a print-product of the specified design file.
646
805
  * @param id Design identifier.
647
806
  * @param privateStorageOwner (optional) Private storage owner identifier.
648
807
  * @param tenantId (optional) Tenant identifier
@@ -652,154 +811,452 @@ export interface IDesignAtomsServiceApiClient {
652
811
  * @param replacePlaceholderItemContentInfo_placeholderItemName (optional)
653
812
  * @param replacePlaceholderItemContentInfo_newContentType (optional)
654
813
  * @param replacePlaceholderItemContentInfo_sourceFile (optional)
814
+ * @return No Content
815
+ */
816
+ patchDesignProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, replacePlaceholderItemContentInfo_placeholderItemName?: string | null | undefined, replacePlaceholderItemContentInfo_newContentType?: PlaceholderItemContentType | undefined, replacePlaceholderItemContentInfo_sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
817
+ protected processPatchDesignProduct(response: AxiosResponse): Promise<void>;
818
+ /**
819
+ * Returns a print-product of the specified design file as a json-serialized model.
820
+ * @param id Design identifier.
821
+ * @param privateStorageOwner (optional) Private storage owner identifier.
822
+ * @param tenantId (optional) Tenant identifier
655
823
  * @return Success
656
824
  */
657
- patchProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, replacePlaceholderItemContentInfo_placeholderItemName?: string | null | undefined, replacePlaceholderItemContentInfo_newContentType?: PlaceholderItemContentType | undefined, replacePlaceholderItemContentInfo_sourceFile?: FileParameter | null | undefined): Promise<void>;
825
+ getDesignProductModel(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
826
+ protected processGetDesignProductModel(response: AxiosResponse): Promise<any>;
658
827
  /**
659
- * Returns design parameters stored in product model.
828
+ * Saves a print-product provided as a json-serialized model to the specified design file.
829
+ * @param id Design identifier.
830
+ * @param privateStorageOwner (optional) Private storage owner identifier.
831
+ * @param tenantId (optional) Tenant identifier
832
+ * @param body (optional) Serialized print-product description.
833
+ * @return No Content
834
+ */
835
+ updateDesignProductModel(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
836
+ protected processUpdateDesignProductModel(response: AxiosResponse): Promise<void>;
837
+ /**
838
+ * Returns a list of print-area descriptions of the specified design file.
660
839
  * @param id Design identifier.
840
+ * @param surfaceId (optional)
661
841
  * @param privateStorageOwner (optional) Private storage owner identifier.
662
842
  * @param tenantId (optional) Tenant identifier
663
843
  * @return Success
664
844
  */
665
- getDesignParameters(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<DesignParameters>;
845
+ getDesignPrintAreas(id: string, surfaceId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignPrintAreaDto[]>;
846
+ protected processGetDesignPrintAreas(response: AxiosResponse): Promise<DesignPrintAreaDto[]>;
847
+ /**
848
+ * Deletes a specified print-area in an existing design file.
849
+ * @param id Design identifier.
850
+ * @param printAreaId Design print-area identifier.
851
+ * @param privateStorageOwner (optional) Private storage owner identifier.
852
+ * @param tenantId (optional) Tenant identifier
853
+ * @return No Content
854
+ */
855
+ deleteDesignPrintArea(id: string, printAreaId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
856
+ protected processDeleteDesignPrintArea(response: AxiosResponse): Promise<void>;
666
857
  /**
667
- * Loads data schema from design file taken from storage.
858
+ * Returns a print-area of the specified design file as a json-serialized model.
668
859
  * @param id Design identifier.
860
+ * @param printAreaId Design print-area identifier.
669
861
  * @param privateStorageOwner (optional) Private storage owner identifier.
670
862
  * @param tenantId (optional) Tenant identifier
671
863
  * @return Success
672
864
  */
673
- loadDataSchema(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
865
+ getDesignPrintAreaModel(id: string, printAreaId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
866
+ protected processGetDesignPrintAreaModel(response: AxiosResponse): Promise<any>;
674
867
  /**
675
- * Loads a toggle set from design file taken from storage.
868
+ * Updates a specified print-area in an existing design file with the data provided as a json-serialized print-area model.
676
869
  * @param id Design identifier.
870
+ * @param printAreaId Design print-area identifier.
677
871
  * @param privateStorageOwner (optional) Private storage owner identifier.
678
872
  * @param tenantId (optional) Tenant identifier
873
+ * @param body (optional) Updated print-area model.
679
874
  * @return Success
680
875
  */
681
- loadToggleSet(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
876
+ updateDesignPrintAreaModel(id: string, printAreaId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
877
+ protected processUpdateDesignPrintAreaModel(response: AxiosResponse): Promise<any>;
682
878
  /**
683
- * Gets variable items information for design file taken from storage.
879
+ * Inserts a new print-area provided as a json-serialized model at the specified position in an existing design file.
880
+ Print-area identifier will be reset by auto-generated value to prevent identifiers collisions.
684
881
  * @param id Design identifier.
882
+ * @param surfaceId (optional) Parent surface identifier.
685
883
  * @param privateStorageOwner (optional) Private storage owner identifier.
686
884
  * @param tenantId (optional) Tenant identifier
885
+ * @param body (optional) New print-area model.
687
886
  * @return Success
688
887
  */
689
- getVariables(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<VariablesModel>;
888
+ addDesignPrintAreaModel(id: string, surfaceId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
889
+ protected processAddDesignPrintAreaModel(response: AxiosResponse): Promise<any>;
690
890
  /**
691
- * Sets variable items values for design file taken from storage.
891
+ * Returns a list of print-product surfaces descriptions of the specified design file.
692
892
  * @param id Design identifier.
693
893
  * @param privateStorageOwner (optional) Private storage owner identifier.
694
894
  * @param tenantId (optional) Tenant identifier
695
- * @param body (optional) Design variable values.
696
895
  * @return Success
697
896
  */
698
- setVariables(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | undefined): Promise<void>;
897
+ getDesignSurfaces(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignSurfaceDto[]>;
898
+ protected processGetDesignSurfaces(response: AxiosResponse): Promise<DesignSurfaceDto[]>;
699
899
  /**
700
- * Loads variable data printing information from design file taken from storage.
900
+ * Deletes a specified print-product surface in an existing design file.
901
+ * @param id Design identifier.
902
+ * @param surfaceId Surface identifier.
903
+ * @param privateStorageOwner (optional) Private storage owner identifier.
904
+ * @param tenantId (optional) Tenant identifier
905
+ * @return No Content
906
+ */
907
+ deleteDesignSurface(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
908
+ protected processDeleteDesignSurface(response: AxiosResponse): Promise<void>;
909
+ /**
910
+ * Returns a down-mockup description of the specified surface in an existing design file.
701
911
  * @param id Design identifier.
912
+ * @param surfaceId Design surface identifier.
702
913
  * @param privateStorageOwner (optional) Private storage owner identifier.
703
914
  * @param tenantId (optional) Tenant identifier
704
915
  * @return Success
705
916
  */
706
- loadVdpData(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<VdpDataModel>;
917
+ getDesignSurfaceDownMockup(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignSurfaceMockupDto>;
918
+ protected processGetDesignSurfaceDownMockup(response: AxiosResponse): Promise<DesignSurfaceMockupDto>;
707
919
  /**
708
- * Saves variable data printing information to design file and updates design in storage.
920
+ * Updates a content file of down-mockup for the specified surface in an existing design file.
709
921
  * @param id Design identifier.
922
+ * @param surfaceId Design surface identifier.
710
923
  * @param privateStorageOwner (optional) Private storage owner identifier.
711
924
  * @param tenantId (optional) Tenant identifier
712
- * @param body (optional) Serialized vdp data.
925
+ * @param position_top (optional)
926
+ * @param position_left (optional)
927
+ * @param sourceFile (optional)
713
928
  * @return Success
714
929
  */
715
- saveVdpData(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VdpDataModel | undefined): Promise<void>;
930
+ updateDesignSurfaceDownMockup(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, position_top?: number | undefined, position_left?: number | undefined, sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
931
+ protected processUpdateDesignSurfaceDownMockup(response: AxiosResponse): Promise<any>;
716
932
  /**
717
- * Deletes variable data printing information from design file and updates design in storage.
933
+ * Returns a content file for down-mockup of the specified surface in an existing design file.
718
934
  * @param id Design identifier.
935
+ * @param surfaceId Design surface identifier.
719
936
  * @param privateStorageOwner (optional) Private storage owner identifier.
720
937
  * @param tenantId (optional) Tenant identifier
721
938
  * @return Success
722
939
  */
723
- deleteVdpData(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
940
+ getDesignSurfaceDownMockupContent(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
941
+ protected processGetDesignSurfaceDownMockupContent(response: AxiosResponse): Promise<FileResponse>;
942
+ /**
943
+ * Returns an up-mockup description of the specified surface in an existing design file.
944
+ * @param id Design identifier.
945
+ * @param surfaceId Design surface identifier.
946
+ * @param privateStorageOwner (optional) Private storage owner identifier.
947
+ * @param tenantId (optional) Tenant identifier
948
+ * @return Success
949
+ */
950
+ getDesignSurfaceUpMockup(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignSurfaceMockupDto>;
951
+ protected processGetDesignSurfaceUpMockup(response: AxiosResponse): Promise<DesignSurfaceMockupDto>;
952
+ /**
953
+ * Updates a content file of up-mockup for the specified surface in an existing design.
954
+ * @param id Design identifier.
955
+ * @param surfaceId Design surface identifier.
956
+ * @param privateStorageOwner (optional) Private storage owner identifier.
957
+ * @param tenantId (optional) Tenant identifier
958
+ * @param position_top (optional)
959
+ * @param position_left (optional)
960
+ * @param sourceFile (optional)
961
+ * @return Success
962
+ */
963
+ updateDesignSurfaceUpMockup(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, position_top?: number | undefined, position_left?: number | undefined, sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
964
+ protected processUpdateDesignSurfaceUpMockup(response: AxiosResponse): Promise<any>;
724
965
  /**
725
- * Loads product (design model) from resource file taken from storage.
726
- * @param id Resource identifier.
966
+ * Returns a content file for up-mockup of the specified surface in an existing design file.
967
+ * @param id Design identifier.
968
+ * @param surfaceId Design surface identifier.
969
+ * @param privateStorageOwner (optional) Private storage owner identifier.
970
+ * @param tenantId (optional) Tenant identifier
971
+ * @return Success
972
+ */
973
+ getDesignSurfaceUpMockupContent(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
974
+ protected processGetDesignSurfaceUpMockupContent(response: AxiosResponse): Promise<FileResponse>;
975
+ /**
976
+ * Returns a print-product surface of the specified design file as a json-serialized model.
977
+ * @param id Design identifier.
978
+ * @param surfaceId Surface identifier.
979
+ * @param privateStorageOwner (optional) Private storage owner identifier.
980
+ * @param tenantId (optional) Tenant identifier
981
+ * @return Success
982
+ */
983
+ getDesignSurfaceModel(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
984
+ protected processGetDesignSurfaceModel(response: AxiosResponse): Promise<any>;
985
+ /**
986
+ * Replaces a specified print-product surface in an existing design file with the data provided as a json-serialized surface model.
987
+ All identifiers of a replaced surface (including surface identifier) will be reset by auto-generated values to prevent identifiers collisions.
988
+ * @param id Design identifier.
989
+ * @param surfaceId Design surface identifier.
990
+ * @param privateStorageOwner (optional) Private storage owner identifier.
991
+ * @param tenantId (optional) Tenant identifier
992
+ * @param body (optional) Updated surface model.
993
+ * @return Success
994
+ */
995
+ replaceDesignSurfaceModel(id: string, surfaceId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
996
+ protected processReplaceDesignSurfaceModel(response: AxiosResponse): Promise<any>;
997
+ /**
998
+ * Inserts a new surface provided as a json-serialized model at the specified position in an existing design file.
999
+ All identifiers of a replaced surface (including surface identifier) will be reset by auto-generated values to prevent identifiers collisions.
1000
+ * @param id Design identifier.
1001
+ * @param surfaceIndex (optional) New surface index.
1002
+ * @param privateStorageOwner (optional) Private storage owner identifier.
1003
+ * @param tenantId (optional) Tenant identifier
1004
+ * @param body (optional) New surface model.
1005
+ * @return Success
1006
+ */
1007
+ addDesignSurfaceModel(id: string, surfaceIndex?: number | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1008
+ protected processAddDesignSurfaceModel(response: AxiosResponse): Promise<any>;
1009
+ }
1010
+ export interface IDesignAtomsPrintProductItemsApiClient {
1011
+ /**
1012
+ * Extracts print-product item image.
1013
+ * @param tenantId (optional) Tenant identifier
1014
+ * @param body (optional) Extraction parameters.
1015
+ * @return Success
1016
+ */
1017
+ extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | undefined): Promise<FileResponse>;
1018
+ /**
1019
+ * Flattens print-product items.
1020
+ * @param tenantId (optional) Tenant identifier
1021
+ * @param body (optional) List of print-product items to flatten.
1022
+ * @return Success
1023
+ */
1024
+ flattenItems(tenantId?: number | undefined, body?: any[] | undefined): Promise<any>;
1025
+ /**
1026
+ * Creates print-product item from input image file.
1027
+ * @param itemType (optional) Desired item type.
1028
+ * @param tenantId (optional) Tenant identifier
1029
+ * @param sourceFile (optional)
1030
+ * @return Success
1031
+ */
1032
+ createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined): Promise<any>;
1033
+ /**
1034
+ * Creates multiple print-product items from input image files.
1035
+ * @param itemType (optional) Desired print-product items type.
1036
+ * @param tenantId (optional) Tenant identifier
1037
+ * @param sourceFiles (optional)
1038
+ * @return Success
1039
+ */
1040
+ batchCreateItemsFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFiles?: FileParameter[] | null | undefined): Promise<any>;
1041
+ /**
1042
+ * Creates print-product item from image file taken from storage.
1043
+ * @param itemType (optional) Desired item type.
1044
+ * @param tenantId (optional) Tenant identifier
1045
+ * @param body (optional) Operation parameters.
1046
+ * @return Success
1047
+ */
1048
+ createItemFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromStorageModel | undefined): Promise<any>;
1049
+ /**
1050
+ * Creates multiple print-product items from the specified image files in storage.
1051
+ * @param itemType (optional) Desired items type.
1052
+ * @param tenantId (optional) Tenant identifier
1053
+ * @param body (optional) Operation parameters.
1054
+ * @return Success
1055
+ */
1056
+ batchCreateItemsFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromStorageModel | undefined): Promise<any>;
1057
+ /**
1058
+ * Creates print-product item from remote web image provided by URL.
1059
+ * @param itemType (optional) Desired item type.
1060
+ * @param tenantId (optional) Tenant identifier
1061
+ * @param body (optional) Operation parameters.
1062
+ * @return Success
1063
+ */
1064
+ createItemFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromUrlModel | undefined): Promise<any>;
1065
+ /**
1066
+ * Creates multiple print-product items from remote web images provided by URLs list.
1067
+ * @param itemType (optional) Desired items type.
1068
+ * @param tenantId (optional) Tenant identifier
1069
+ * @param body (optional) Operation parameters.
1070
+ * @return Success
1071
+ */
1072
+ batchCreateItemsFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromUrlModel | undefined): Promise<any>;
1073
+ }
1074
+ export declare class DesignAtomsPrintProductItemsApiClient extends ApiClientBase implements IDesignAtomsPrintProductItemsApiClient {
1075
+ private instance;
1076
+ private baseUrl;
1077
+ protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
1078
+ constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
1079
+ /**
1080
+ * Extracts print-product item image.
1081
+ * @param tenantId (optional) Tenant identifier
1082
+ * @param body (optional) Extraction parameters.
1083
+ * @return Success
1084
+ */
1085
+ extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
1086
+ protected processExtractItemImage(response: AxiosResponse): Promise<FileResponse>;
1087
+ /**
1088
+ * Flattens print-product items.
1089
+ * @param tenantId (optional) Tenant identifier
1090
+ * @param body (optional) List of print-product items to flatten.
1091
+ * @return Success
1092
+ */
1093
+ flattenItems(tenantId?: number | undefined, body?: any[] | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1094
+ protected processFlattenItems(response: AxiosResponse): Promise<any>;
1095
+ /**
1096
+ * Creates print-product item from input image file.
1097
+ * @param itemType (optional) Desired item type.
1098
+ * @param tenantId (optional) Tenant identifier
1099
+ * @param sourceFile (optional)
1100
+ * @return Success
1101
+ */
1102
+ createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1103
+ protected processCreateItemFromFile(response: AxiosResponse): Promise<any>;
1104
+ /**
1105
+ * Creates multiple print-product items from input image files.
1106
+ * @param itemType (optional) Desired print-product items type.
1107
+ * @param tenantId (optional) Tenant identifier
1108
+ * @param sourceFiles (optional)
1109
+ * @return Success
1110
+ */
1111
+ batchCreateItemsFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFiles?: FileParameter[] | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1112
+ protected processBatchCreateItemsFromFile(response: AxiosResponse): Promise<any>;
1113
+ /**
1114
+ * Creates print-product item from image file taken from storage.
1115
+ * @param itemType (optional) Desired item type.
1116
+ * @param tenantId (optional) Tenant identifier
1117
+ * @param body (optional) Operation parameters.
1118
+ * @return Success
1119
+ */
1120
+ createItemFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromStorageModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1121
+ protected processCreateItemFromStorage(response: AxiosResponse): Promise<any>;
1122
+ /**
1123
+ * Creates multiple print-product items from the specified image files in storage.
1124
+ * @param itemType (optional) Desired items type.
1125
+ * @param tenantId (optional) Tenant identifier
1126
+ * @param body (optional) Operation parameters.
1127
+ * @return Success
1128
+ */
1129
+ batchCreateItemsFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromStorageModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1130
+ protected processBatchCreateItemsFromStorage(response: AxiosResponse): Promise<any>;
1131
+ /**
1132
+ * Creates print-product item from remote web image provided by URL.
1133
+ * @param itemType (optional) Desired item type.
1134
+ * @param tenantId (optional) Tenant identifier
1135
+ * @param body (optional) Operation parameters.
1136
+ * @return Success
1137
+ */
1138
+ createItemFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromUrlModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1139
+ protected processCreateItemFromUrl(response: AxiosResponse): Promise<any>;
1140
+ /**
1141
+ * Creates multiple print-product items from remote web images provided by URLs list.
1142
+ * @param itemType (optional) Desired items type.
1143
+ * @param tenantId (optional) Tenant identifier
1144
+ * @param body (optional) Operation parameters.
1145
+ * @return Success
1146
+ */
1147
+ batchCreateItemsFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromUrlModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1148
+ protected processBatchCreateItemsFromUrl(response: AxiosResponse): Promise<any>;
1149
+ }
1150
+ export interface IDesignAtomsServiceApiClient {
1151
+ /**
1152
+ * Creates new design file with specified parameters and saves it in storage.
1153
+ * @param privateStorageOwner (optional) Private storage owner identifier.
1154
+ * @param tenantId (optional) Tenant identifier
1155
+ * @param body (optional) Design creation parameters.
1156
+ * @return Created
1157
+ */
1158
+ createDesign(privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: CreateDesignModel | undefined): Promise<DesignInfo>;
1159
+ /**
1160
+ * Returns image content of the background.
1161
+ * @param id Design identifier.
1162
+ * @param surfaceIndex (optional) Surface index.
1163
+ * @param privateStorageOwner (optional) Private storage owner identifier.
1164
+ * @param tenantId (optional) Tenant identifier
1165
+ * @return Success
1166
+ */
1167
+ extractBackground(id: string, surfaceIndex?: number | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
1168
+ /**
1169
+ * Sets specified editor-mockups for selected design surfaces.
1170
+ * @param id Design identifier.
1171
+ * @param privateStorageOwner (optional) Private storage owner identifier.
1172
+ * @param tenantId (optional) Tenant identifier
1173
+ * @param body (optional) Operation parameters.
1174
+ * @return No Content
1175
+ */
1176
+ setEditorMockups(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: SetEditorMockupsModel | undefined): Promise<void>;
1177
+ /**
1178
+ * Returns design parameters stored in product model.
1179
+ * @param id Design identifier.
727
1180
  * @param privateStorageOwner (optional) Private storage owner identifier.
728
1181
  * @param tenantId (optional) Tenant identifier
729
1182
  * @return Success
730
1183
  */
731
- loadProductFromResource(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<any>;
1184
+ getDesignParameters(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<DesignParameters>;
732
1185
  /**
733
- * Converts colors.
1186
+ * Loads a data schema from design file taken from storage.
1187
+ * @param id Design identifier.
1188
+ * @param privateStorageOwner (optional) Private storage owner identifier.
734
1189
  * @param tenantId (optional) Tenant identifier
735
- * @param body (optional) Convert colors operation parameters.
736
1190
  * @return Success
737
1191
  */
738
- convertColors(tenantId?: number | undefined, body?: ConvertColorsModel | undefined): Promise<any>;
1192
+ loadDataSchema(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
739
1193
  /**
740
- * Extracts product item image.
1194
+ * Loads a toggle set from design file taken from storage.
1195
+ * @param id Design identifier.
1196
+ * @param privateStorageOwner (optional) Private storage owner identifier.
741
1197
  * @param tenantId (optional) Tenant identifier
742
- * @param body (optional) Extraction parameters.
743
1198
  * @return Success
744
1199
  */
745
- extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | undefined): Promise<FileResponse>;
1200
+ loadToggleSet(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
746
1201
  /**
747
- * Flatten items.
1202
+ * Returns variable items information for design file taken from storage.
1203
+ * @param id Design identifier.
1204
+ * @param privateStorageOwner (optional) Private storage owner identifier.
748
1205
  * @param tenantId (optional) Tenant identifier
749
- * @param body (optional) Items to flatten.
750
1206
  * @return Success
751
1207
  */
752
- flattenItems(tenantId?: number | undefined, body?: any[] | undefined): Promise<any>;
1208
+ getVariables(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<VariablesModel>;
753
1209
  /**
754
- * Creates product item from input image file.
755
- * @param itemType (optional) Desired item type.
1210
+ * Saves variable items values for design file taken from storage.
1211
+ * @param id Design identifier.
1212
+ * @param privateStorageOwner (optional) Private storage owner identifier.
756
1213
  * @param tenantId (optional) Tenant identifier
757
- * @param sourceFile (optional)
1214
+ * @param body (optional) Design variable values.
758
1215
  * @return Success
759
1216
  */
760
- createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined): Promise<any>;
1217
+ setVariables(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | undefined): Promise<void>;
761
1218
  /**
762
- * Creates multiple product items from input image files.
763
- * @param itemType (optional) Desired items type.
1219
+ * Loads variable data printing information from design file taken from storage.
1220
+ * @param id Design identifier.
1221
+ * @param privateStorageOwner (optional) Private storage owner identifier.
764
1222
  * @param tenantId (optional) Tenant identifier
765
- * @param sourceFiles (optional)
766
1223
  * @return Success
767
1224
  */
768
- batchCreateItemsFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFiles?: FileParameter[] | null | undefined): Promise<any>;
1225
+ loadVdpData(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<VdpDataModel>;
769
1226
  /**
770
- * Creates product item from image in storage.
771
- * @param itemType (optional) Desired item type.
1227
+ * Saves variable data printing information to design file and updates design in storage.
1228
+ * @param id Design identifier.
1229
+ * @param privateStorageOwner (optional) Private storage owner identifier.
772
1230
  * @param tenantId (optional) Tenant identifier
773
- * @param body (optional) Operation parameters.
1231
+ * @param body (optional) Serialized vdp data.
774
1232
  * @return Success
775
1233
  */
776
- createItemFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromStorageModel | undefined): Promise<any>;
1234
+ saveVdpData(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VdpDataModel | undefined): Promise<void>;
777
1235
  /**
778
- * Creates multiple product items from images in storage.
779
- * @param itemType (optional) Desired items type.
1236
+ * Deletes variable data printing information from design file and updates design file in storage.
1237
+ * @param id Design identifier.
1238
+ * @param privateStorageOwner (optional) Private storage owner identifier.
780
1239
  * @param tenantId (optional) Tenant identifier
781
- * @param body (optional) Create items operation parameters.
782
1240
  * @return Success
783
1241
  */
784
- batchCreateItemsFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromStorageModel | undefined): Promise<any>;
1242
+ deleteVdpData(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
785
1243
  /**
786
- * Creates product item from remote web image provided by URL.
787
- * @param itemType (optional) Desired item type.
1244
+ * Converts colors for print-product item manipulations.
788
1245
  * @param tenantId (optional) Tenant identifier
789
- * @param body (optional) Operation parameters.
1246
+ * @param body (optional) Convert colors operation parameters.
790
1247
  * @return Success
791
1248
  */
792
- createItemFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromUrlModel | undefined): Promise<any>;
1249
+ convertColors(tenantId?: number | undefined, body?: ConvertColorsModel | undefined): Promise<any>;
793
1250
  /**
794
- * Creates multiple product items from remote web images provided by URLs list.
795
- * @param itemType (optional) Desired items type.
1251
+ * Loads print-product from resource file taken from storage.
1252
+ * @param id (optional) Resource identifier.
1253
+ * @param privateStorageOwner (optional) Private storage owner identifier.
796
1254
  * @param tenantId (optional) Tenant identifier
797
- * @param body (optional) Operation parameters.
798
1255
  * @return Success
799
1256
  */
800
- batchCreateItemsFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromUrlModel | undefined): Promise<any>;
1257
+ loadProductFromResource(id?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<any>;
801
1258
  /**
802
- * Render product proof image with specified parameters.
1259
+ * Renders a product proof image with specified parameters.
803
1260
  * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
804
1261
  (default value is 'false').
805
1262
  * @param tenantId (optional) Tenant identifier
@@ -840,7 +1297,41 @@ export interface IDesignAtomsServiceApiClient {
840
1297
  */
841
1298
  renderDesignProofToResource(tenantId?: number | undefined, body?: RenderDesignProofToResourceModel | undefined): Promise<ResourceInfoDto>;
842
1299
  /**
843
- * Creates product item.
1300
+ * Loads print-product from design file taken from storage.
1301
+ * @param id Design identifier.
1302
+ * @param privateStorageOwner (optional) Private storage owner identifier.
1303
+ * @param tenantId (optional) Tenant identifier
1304
+ * @return Success
1305
+ * @deprecated
1306
+ */
1307
+ loadProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<any>;
1308
+ /**
1309
+ * Saves print-product to design file and updates design file in storage.
1310
+ * @param id Design identifier.
1311
+ * @param privateStorageOwner (optional) Private storage owner identifier.
1312
+ * @param tenantId (optional) Tenant identifier
1313
+ * @param body (optional) Serialized product description.
1314
+ * @return Success
1315
+ * @deprecated
1316
+ */
1317
+ saveProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined): Promise<void>;
1318
+ /**
1319
+ * Patches print-product in design file.
1320
+ * @param id Design identifier.
1321
+ * @param privateStorageOwner (optional) Private storage owner identifier.
1322
+ * @param tenantId (optional) Tenant identifier
1323
+ * @param patchType (optional)
1324
+ * @param replaceImageItemFileInfo_itemName (optional)
1325
+ * @param replaceImageItemFileInfo_sourceFile (optional)
1326
+ * @param replacePlaceholderItemContentInfo_placeholderItemName (optional)
1327
+ * @param replacePlaceholderItemContentInfo_newContentType (optional)
1328
+ * @param replacePlaceholderItemContentInfo_sourceFile (optional)
1329
+ * @return Success
1330
+ * @deprecated
1331
+ */
1332
+ patchProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, replacePlaceholderItemContentInfo_placeholderItemName?: string | null | undefined, replacePlaceholderItemContentInfo_newContentType?: PlaceholderItemContentType | undefined, replacePlaceholderItemContentInfo_sourceFile?: FileParameter | null | undefined): Promise<void>;
1333
+ /**
1334
+ * Creates print-product item.
844
1335
  * @param itemType (optional) Desired item type.
845
1336
  * @param tenantId (optional) Tenant identifier
846
1337
  * @param sourceType (optional)
@@ -852,6 +1343,22 @@ export interface IDesignAtomsServiceApiClient {
852
1343
  * @deprecated
853
1344
  */
854
1345
  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>;
1346
+ /**
1347
+ * Extracts print-product item image.
1348
+ * @param tenantId (optional) Tenant identifier
1349
+ * @param body (optional) Extraction parameters.
1350
+ * @return Success
1351
+ * @deprecated
1352
+ */
1353
+ extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | undefined): Promise<FileResponse>;
1354
+ /**
1355
+ * Flattens print-product items.
1356
+ * @param tenantId (optional) Tenant identifier
1357
+ * @param body (optional) Items to flatten.
1358
+ * @return Success
1359
+ * @deprecated
1360
+ */
1361
+ flattenItems(tenantId?: number | undefined, body?: any[] | undefined): Promise<any>;
855
1362
  /**
856
1363
  * Creates a private design from a public design.
857
1364
  * @param designId (optional) Public design identifier.
@@ -888,7 +1395,7 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
888
1395
  createDesign(privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: CreateDesignModel | undefined, cancelToken?: CancelToken | undefined): Promise<DesignInfo>;
889
1396
  protected processCreateDesign(response: AxiosResponse): Promise<DesignInfo>;
890
1397
  /**
891
- * Returns content of the background.
1398
+ * Returns image content of the background.
892
1399
  * @param id Design identifier.
893
1400
  * @param surfaceIndex (optional) Surface index.
894
1401
  * @param privateStorageOwner (optional) Private storage owner identifier.
@@ -898,39 +1405,15 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
898
1405
  extractBackground(id: string, surfaceIndex?: number | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
899
1406
  protected processExtractBackground(response: AxiosResponse): Promise<FileResponse>;
900
1407
  /**
901
- * Loads product (design model) from design file taken from storage.
902
- * @param id Design identifier.
903
- * @param privateStorageOwner (optional) Private storage owner identifier.
904
- * @param tenantId (optional) Tenant identifier
905
- * @return Success
906
- */
907
- loadProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
908
- protected processLoadProduct(response: AxiosResponse): Promise<any>;
909
- /**
910
- * Saves product (design model) to design file and updates design in storage.
911
- * @param id Design identifier.
912
- * @param privateStorageOwner (optional) Private storage owner identifier.
913
- * @param tenantId (optional) Tenant identifier
914
- * @param body (optional) Serialized product description.
915
- * @return Success
916
- */
917
- saveProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
918
- protected processSaveProduct(response: AxiosResponse): Promise<void>;
919
- /**
920
- * Patches product (design model) in design file.
1408
+ * Sets specified editor-mockups for selected design surfaces.
921
1409
  * @param id Design identifier.
922
1410
  * @param privateStorageOwner (optional) Private storage owner identifier.
923
1411
  * @param tenantId (optional) Tenant identifier
924
- * @param patchType (optional)
925
- * @param replaceImageItemFileInfo_itemName (optional)
926
- * @param replaceImageItemFileInfo_sourceFile (optional)
927
- * @param replacePlaceholderItemContentInfo_placeholderItemName (optional)
928
- * @param replacePlaceholderItemContentInfo_newContentType (optional)
929
- * @param replacePlaceholderItemContentInfo_sourceFile (optional)
930
- * @return Success
1412
+ * @param body (optional) Operation parameters.
1413
+ * @return No Content
931
1414
  */
932
- patchProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, replacePlaceholderItemContentInfo_placeholderItemName?: string | null | undefined, replacePlaceholderItemContentInfo_newContentType?: PlaceholderItemContentType | undefined, replacePlaceholderItemContentInfo_sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
933
- protected processPatchProduct(response: AxiosResponse): Promise<void>;
1415
+ setEditorMockups(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: SetEditorMockupsModel | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
1416
+ protected processSetEditorMockups(response: AxiosResponse): Promise<void>;
934
1417
  /**
935
1418
  * Returns design parameters stored in product model.
936
1419
  * @param id Design identifier.
@@ -941,7 +1424,7 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
941
1424
  getDesignParameters(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignParameters>;
942
1425
  protected processGetDesignParameters(response: AxiosResponse): Promise<DesignParameters>;
943
1426
  /**
944
- * Loads data schema from design file taken from storage.
1427
+ * Loads a data schema from design file taken from storage.
945
1428
  * @param id Design identifier.
946
1429
  * @param privateStorageOwner (optional) Private storage owner identifier.
947
1430
  * @param tenantId (optional) Tenant identifier
@@ -959,7 +1442,7 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
959
1442
  loadToggleSet(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
960
1443
  protected processLoadToggleSet(response: AxiosResponse): Promise<FileResponse>;
961
1444
  /**
962
- * Gets variable items information for design file taken from storage.
1445
+ * Returns variable items information for design file taken from storage.
963
1446
  * @param id Design identifier.
964
1447
  * @param privateStorageOwner (optional) Private storage owner identifier.
965
1448
  * @param tenantId (optional) Tenant identifier
@@ -968,7 +1451,7 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
968
1451
  getVariables(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<VariablesModel>;
969
1452
  protected processGetVariables(response: AxiosResponse): Promise<VariablesModel>;
970
1453
  /**
971
- * Sets variable items values for design file taken from storage.
1454
+ * Saves variable items values for design file taken from storage.
972
1455
  * @param id Design identifier.
973
1456
  * @param privateStorageOwner (optional) Private storage owner identifier.
974
1457
  * @param tenantId (optional) Tenant identifier
@@ -997,7 +1480,7 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
997
1480
  saveVdpData(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VdpDataModel | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
998
1481
  protected processSaveVdpData(response: AxiosResponse): Promise<void>;
999
1482
  /**
1000
- * Deletes variable data printing information from design file and updates design in storage.
1483
+ * Deletes variable data printing information from design file and updates design file in storage.
1001
1484
  * @param id Design identifier.
1002
1485
  * @param privateStorageOwner (optional) Private storage owner identifier.
1003
1486
  * @param tenantId (optional) Tenant identifier
@@ -1006,16 +1489,7 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
1006
1489
  deleteVdpData(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
1007
1490
  protected processDeleteVdpData(response: AxiosResponse): Promise<void>;
1008
1491
  /**
1009
- * Loads product (design model) from resource file taken from storage.
1010
- * @param id Resource identifier.
1011
- * @param privateStorageOwner (optional) Private storage owner identifier.
1012
- * @param tenantId (optional) Tenant identifier
1013
- * @return Success
1014
- */
1015
- loadProductFromResource(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1016
- protected processLoadProductFromResource(response: AxiosResponse): Promise<any>;
1017
- /**
1018
- * Converts colors.
1492
+ * Converts colors for print-product item manipulations.
1019
1493
  * @param tenantId (optional) Tenant identifier
1020
1494
  * @param body (optional) Convert colors operation parameters.
1021
1495
  * @return Success
@@ -1023,77 +1497,16 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
1023
1497
  convertColors(tenantId?: number | undefined, body?: ConvertColorsModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1024
1498
  protected processConvertColors(response: AxiosResponse): Promise<any>;
1025
1499
  /**
1026
- * Extracts product item image.
1027
- * @param tenantId (optional) Tenant identifier
1028
- * @param body (optional) Extraction parameters.
1029
- * @return Success
1030
- */
1031
- extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
1032
- protected processExtractItemImage(response: AxiosResponse): Promise<FileResponse>;
1033
- /**
1034
- * Flatten items.
1035
- * @param tenantId (optional) Tenant identifier
1036
- * @param body (optional) Items to flatten.
1037
- * @return Success
1038
- */
1039
- flattenItems(tenantId?: number | undefined, body?: any[] | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1040
- protected processFlattenItems(response: AxiosResponse): Promise<any>;
1041
- /**
1042
- * Creates product item from input image file.
1043
- * @param itemType (optional) Desired item type.
1044
- * @param tenantId (optional) Tenant identifier
1045
- * @param sourceFile (optional)
1046
- * @return Success
1047
- */
1048
- createItemFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1049
- protected processCreateItemFromFile(response: AxiosResponse): Promise<any>;
1050
- /**
1051
- * Creates multiple product items from input image files.
1052
- * @param itemType (optional) Desired items type.
1053
- * @param tenantId (optional) Tenant identifier
1054
- * @param sourceFiles (optional)
1055
- * @return Success
1056
- */
1057
- batchCreateItemsFromFile(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceFiles?: FileParameter[] | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1058
- protected processBatchCreateItemsFromFile(response: AxiosResponse): Promise<any>;
1059
- /**
1060
- * Creates product item from image in storage.
1061
- * @param itemType (optional) Desired item type.
1062
- * @param tenantId (optional) Tenant identifier
1063
- * @param body (optional) Operation parameters.
1064
- * @return Success
1065
- */
1066
- createItemFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromStorageModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1067
- protected processCreateItemFromStorage(response: AxiosResponse): Promise<any>;
1068
- /**
1069
- * Creates multiple product items from images in storage.
1070
- * @param itemType (optional) Desired items type.
1071
- * @param tenantId (optional) Tenant identifier
1072
- * @param body (optional) Create items operation parameters.
1073
- * @return Success
1074
- */
1075
- batchCreateItemsFromStorage(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromStorageModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1076
- protected processBatchCreateItemsFromStorage(response: AxiosResponse): Promise<any>;
1077
- /**
1078
- * Creates product item from remote web image provided by URL.
1079
- * @param itemType (optional) Desired item type.
1080
- * @param tenantId (optional) Tenant identifier
1081
- * @param body (optional) Operation parameters.
1082
- * @return Success
1083
- */
1084
- createItemFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: CreateItemFromUrlModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1085
- protected processCreateItemFromUrl(response: AxiosResponse): Promise<any>;
1086
- /**
1087
- * Creates multiple product items from remote web images provided by URLs list.
1088
- * @param itemType (optional) Desired items type.
1500
+ * Loads print-product from resource file taken from storage.
1501
+ * @param id (optional) Resource identifier.
1502
+ * @param privateStorageOwner (optional) Private storage owner identifier.
1089
1503
  * @param tenantId (optional) Tenant identifier
1090
- * @param body (optional) Operation parameters.
1091
1504
  * @return Success
1092
1505
  */
1093
- batchCreateItemsFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromUrlModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1094
- protected processBatchCreateItemsFromUrl(response: AxiosResponse): Promise<any>;
1506
+ loadProductFromResource(id?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1507
+ protected processLoadProductFromResource(response: AxiosResponse): Promise<any>;
1095
1508
  /**
1096
- * Render product proof image with specified parameters.
1509
+ * Renders a product proof image with specified parameters.
1097
1510
  * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
1098
1511
  (default value is 'false').
1099
1512
  * @param tenantId (optional) Tenant identifier
@@ -1139,7 +1552,44 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
1139
1552
  renderDesignProofToResource(tenantId?: number | undefined, body?: RenderDesignProofToResourceModel | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
1140
1553
  protected processRenderDesignProofToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
1141
1554
  /**
1142
- * Creates product item.
1555
+ * Loads print-product from design file taken from storage.
1556
+ * @param id Design identifier.
1557
+ * @param privateStorageOwner (optional) Private storage owner identifier.
1558
+ * @param tenantId (optional) Tenant identifier
1559
+ * @return Success
1560
+ * @deprecated
1561
+ */
1562
+ loadProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1563
+ protected processLoadProduct(response: AxiosResponse): Promise<any>;
1564
+ /**
1565
+ * Saves print-product to design file and updates design file in storage.
1566
+ * @param id Design identifier.
1567
+ * @param privateStorageOwner (optional) Private storage owner identifier.
1568
+ * @param tenantId (optional) Tenant identifier
1569
+ * @param body (optional) Serialized product description.
1570
+ * @return Success
1571
+ * @deprecated
1572
+ */
1573
+ saveProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
1574
+ protected processSaveProduct(response: AxiosResponse): Promise<void>;
1575
+ /**
1576
+ * Patches print-product in design file.
1577
+ * @param id Design identifier.
1578
+ * @param privateStorageOwner (optional) Private storage owner identifier.
1579
+ * @param tenantId (optional) Tenant identifier
1580
+ * @param patchType (optional)
1581
+ * @param replaceImageItemFileInfo_itemName (optional)
1582
+ * @param replaceImageItemFileInfo_sourceFile (optional)
1583
+ * @param replacePlaceholderItemContentInfo_placeholderItemName (optional)
1584
+ * @param replacePlaceholderItemContentInfo_newContentType (optional)
1585
+ * @param replacePlaceholderItemContentInfo_sourceFile (optional)
1586
+ * @return Success
1587
+ * @deprecated
1588
+ */
1589
+ patchProduct(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, replacePlaceholderItemContentInfo_placeholderItemName?: string | null | undefined, replacePlaceholderItemContentInfo_newContentType?: PlaceholderItemContentType | undefined, replacePlaceholderItemContentInfo_sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
1590
+ protected processPatchProduct(response: AxiosResponse): Promise<void>;
1591
+ /**
1592
+ * Creates print-product item.
1143
1593
  * @param itemType (optional) Desired item type.
1144
1594
  * @param tenantId (optional) Tenant identifier
1145
1595
  * @param sourceType (optional)
@@ -1152,6 +1602,24 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
1152
1602
  */
1153
1603
  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>;
1154
1604
  protected processCreateItem(response: AxiosResponse): Promise<any>;
1605
+ /**
1606
+ * Extracts print-product item image.
1607
+ * @param tenantId (optional) Tenant identifier
1608
+ * @param body (optional) Extraction parameters.
1609
+ * @return Success
1610
+ * @deprecated
1611
+ */
1612
+ extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
1613
+ protected processExtractItemImage(response: AxiosResponse): Promise<FileResponse>;
1614
+ /**
1615
+ * Flattens print-product items.
1616
+ * @param tenantId (optional) Tenant identifier
1617
+ * @param body (optional) Items to flatten.
1618
+ * @return Success
1619
+ * @deprecated
1620
+ */
1621
+ flattenItems(tenantId?: number | undefined, body?: any[] | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
1622
+ protected processFlattenItems(response: AxiosResponse): Promise<any>;
1155
1623
  /**
1156
1624
  * Creates a private design from a public design.
1157
1625
  * @param designId (optional) Public design identifier.
@@ -1665,6 +2133,50 @@ export interface DesignParameters {
1665
2133
  /** Version of DesignAtoms library that used to save design file. */
1666
2134
  designAtomsVersion?: string | null;
1667
2135
  }
2136
+ /** Design print area parameters. */
2137
+ export interface DesignPrintAreaDto {
2138
+ /** Print area identifier. */
2139
+ id?: string | null;
2140
+ /** Print area name. */
2141
+ name?: string | null;
2142
+ /** Parent surface identifier. */
2143
+ surfaceId?: string | null;
2144
+ /** Print area size. */
2145
+ size?: SizeDto | null;
2146
+ /** Print area position. */
2147
+ position?: PositionDto | null;
2148
+ }
2149
+ /** Design surface parameters. */
2150
+ export interface DesignSurfaceDto {
2151
+ /** Surface identifier. */
2152
+ id?: string | null;
2153
+ /** Surface name. */
2154
+ name?: string | null;
2155
+ /** Surface index (0-based). */
2156
+ index?: number;
2157
+ /** Surface size. */
2158
+ size?: SizeDto | null;
2159
+ }
2160
+ /** Surface mockup parameters. */
2161
+ export interface DesignSurfaceMockupDto {
2162
+ /** Mockup element position. */
2163
+ position?: PositionDto | null;
2164
+ /** Mockup element size. */
2165
+ size?: SizeDto | null;
2166
+ /** Parent surface identifier. */
2167
+ surfaceId?: string | null;
2168
+ /** Mockup image resolution (DPI). */
2169
+ resolution?: number;
2170
+ }
2171
+ /** Parameters of setting design surface mockup operation. */
2172
+ export interface EditorMockupBindingModel {
2173
+ /** Mockup identifier. */
2174
+ mockupId?: string | null;
2175
+ /** Private mockup owner identifier. Set `null` if public mockup is supposed to be used. */
2176
+ mockupOwnerId?: string | null;
2177
+ /** Target surface index. */
2178
+ surfaceIndex?: number;
2179
+ }
1668
2180
  /** Item extraction operation parameters. */
1669
2181
  export interface ExtractItemImageModel {
1670
2182
  /** Serialized item description. */
@@ -1771,6 +2283,13 @@ export interface PointF {
1771
2283
  x?: number;
1772
2284
  y?: number;
1773
2285
  }
2286
+ /** Position of item top left point on design surface. */
2287
+ export interface PositionDto {
2288
+ /** Y axis position. */
2289
+ top?: number;
2290
+ /** X axis position. */
2291
+ left?: number;
2292
+ }
1774
2293
  export interface PreviewColorSettings {
1775
2294
  rgbColorProfileName?: string | null;
1776
2295
  cmykColorProfileName?: string | null;
@@ -1998,11 +2517,25 @@ export interface ResourceParams {
1998
2517
  type?: string | null;
1999
2518
  anonymousAccess?: boolean;
2000
2519
  }
2520
+ /** Parameters of 'setting editor mockup for design surfaces' operation. */
2521
+ export interface SetEditorMockupsModel {
2522
+ /** List of editor mockup binding instructions. */
2523
+ editorMockupBindings?: EditorMockupBindingModel[] | null;
2524
+ }
2525
+ /** Design item size. */
2526
+ export interface SizeDto {
2527
+ /** Design item width. */
2528
+ width?: number;
2529
+ /** Design item height. */
2530
+ height?: number;
2531
+ }
2001
2532
  export interface UnprocessableDesignElementDto {
2002
2533
  /** Problem description. */
2003
2534
  description?: string | null;
2004
2535
  /** Missing element type. */
2005
- readonly missingElementType?: DesignElementType;
2536
+ readonly missingElementType?: DesignElementType | null;
2537
+ /** Missing element type. */
2538
+ readonly unprocessedElementType?: DesignElementType | null;
2006
2539
  }
2007
2540
  export interface UpdateColorsRequest {
2008
2541
  canvasData?: string | null;