@aurigma/axios-design-atoms-api-client 2.54.3 → 2.56.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.
- package/dist/cjs/design-atoms-api-client.d.ts +166 -176
- package/dist/cjs/design-atoms-api-client.js +209 -240
- package/dist/cjs/design-atoms-api-client.js.map +1 -1
- package/dist/esm/design-atoms-api-client.d.ts +166 -176
- package/dist/esm/design-atoms-api-client.js +208 -239
- package/dist/esm/design-atoms-api-client.js.map +1 -1
- package/package.json +1 -1
|
@@ -501,22 +501,14 @@ export declare class DesignAtomsMockups3dApiClient extends ApiClientBase impleme
|
|
|
501
501
|
protected processGetGeometryFile(response: AxiosResponse): Promise<FileResponse>;
|
|
502
502
|
}
|
|
503
503
|
export interface IDesignAtomsServiceApiClient {
|
|
504
|
-
/**
|
|
505
|
-
* Converts colors
|
|
506
|
-
* @param tenantId (optional) Tenant identifier
|
|
507
|
-
* @param body (optional) Convert colors operation parameters
|
|
508
|
-
* @return Success
|
|
509
|
-
*/
|
|
510
|
-
convertColors(tenantId?: number | undefined, body?: ConvertColorsModel | null | undefined): Promise<any>;
|
|
511
504
|
/**
|
|
512
505
|
* Creates new design file with specified parameters and saves it in storage.
|
|
513
|
-
* @param privateStorage (optional) If set to 'true' design will be saved to private storage
|
|
514
506
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
515
507
|
* @param tenantId (optional) Tenant identifier
|
|
516
508
|
* @param body (optional) Design creation parameters
|
|
517
509
|
* @return Success
|
|
518
510
|
*/
|
|
519
|
-
createDesign(
|
|
511
|
+
createDesign(privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: CreateDesignModel | null | undefined): Promise<DesignInfo>;
|
|
520
512
|
/**
|
|
521
513
|
* Returns content of the background.
|
|
522
514
|
* @param id Design identifier.
|
|
@@ -529,26 +521,23 @@ export interface IDesignAtomsServiceApiClient {
|
|
|
529
521
|
/**
|
|
530
522
|
* Loads product (design model) from design file taken from storage
|
|
531
523
|
* @param id Design identifier
|
|
532
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
533
524
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
534
525
|
* @param tenantId (optional) Tenant identifier
|
|
535
526
|
* @return Success
|
|
536
527
|
*/
|
|
537
|
-
loadProduct(id: string | null,
|
|
528
|
+
loadProduct(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<any>;
|
|
538
529
|
/**
|
|
539
530
|
* Saves product (design model) to design file and updates design in storage.
|
|
540
531
|
* @param id Design identifier
|
|
541
|
-
* @param privateStorage (optional) If set to 'true' design will be saved to private storage
|
|
542
532
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
543
533
|
* @param tenantId (optional) Tenant identifier
|
|
544
534
|
* @param body (optional) Serialized product description
|
|
545
535
|
* @return Success
|
|
546
536
|
*/
|
|
547
|
-
saveProduct(id: string | null,
|
|
537
|
+
saveProduct(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | null | undefined): Promise<void>;
|
|
548
538
|
/**
|
|
549
539
|
* Patches product (design model) in design file.
|
|
550
540
|
* @param id Design identifier.
|
|
551
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage.
|
|
552
541
|
* @param privateStorageOwner (optional) Private storage owner identifier.
|
|
553
542
|
* @param tenantId (optional) Tenant identifier
|
|
554
543
|
* @param patchType (optional)
|
|
@@ -559,7 +548,7 @@ export interface IDesignAtomsServiceApiClient {
|
|
|
559
548
|
* @param replacePlaceholderItemContentInfo_sourceFile (optional)
|
|
560
549
|
* @return Success
|
|
561
550
|
*/
|
|
562
|
-
patchProduct(id: string | null,
|
|
551
|
+
patchProduct(id: string | null, 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>;
|
|
563
552
|
/**
|
|
564
553
|
* Returns design parameters stored in product model.
|
|
565
554
|
* @param id Design identifier.
|
|
@@ -571,66 +560,68 @@ export interface IDesignAtomsServiceApiClient {
|
|
|
571
560
|
/**
|
|
572
561
|
* Loads data schema from design file taken from storage
|
|
573
562
|
* @param id Design identifier
|
|
574
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
575
563
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
576
564
|
* @param tenantId (optional) Tenant identifier
|
|
577
565
|
* @return Success
|
|
578
566
|
*/
|
|
579
|
-
loadDataSchema(id: string | null,
|
|
567
|
+
loadDataSchema(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
|
|
580
568
|
/**
|
|
581
569
|
* Gets variable items information for design file taken from storage
|
|
582
570
|
* @param id Design identifier
|
|
583
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
584
571
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
585
572
|
* @param tenantId (optional) Tenant identifier
|
|
586
573
|
* @return Success
|
|
587
574
|
*/
|
|
588
|
-
getVariables(id: string | null,
|
|
575
|
+
getVariables(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<VariablesModel>;
|
|
589
576
|
/**
|
|
590
577
|
* Sets variable items values for design file taken from storage
|
|
591
578
|
* @param id Design identifier
|
|
592
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
593
579
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
594
580
|
* @param tenantId (optional) Tenant identifier
|
|
595
581
|
* @param body (optional) Design variable values
|
|
596
582
|
* @return Success
|
|
597
583
|
*/
|
|
598
|
-
setVariables(id: string | null,
|
|
584
|
+
setVariables(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined): Promise<void>;
|
|
599
585
|
/**
|
|
600
586
|
* Loads variable data printing information from design file taken from storage
|
|
601
587
|
* @param id Design identifier
|
|
602
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
603
588
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
604
589
|
* @param tenantId (optional) Tenant identifier
|
|
605
590
|
* @return Success
|
|
606
591
|
*/
|
|
607
|
-
loadVdpData(id: string | null,
|
|
592
|
+
loadVdpData(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<VdpDataModel>;
|
|
608
593
|
/**
|
|
609
594
|
* Saves variable data printing information to design file and updates design in storage.
|
|
610
595
|
* @param id Design identifier
|
|
611
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
612
596
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
613
597
|
* @param tenantId (optional) Tenant identifier
|
|
614
598
|
* @param body (optional) Serialized vdp data
|
|
615
599
|
* @return Success
|
|
616
600
|
*/
|
|
617
|
-
saveVdpData(id: string | null,
|
|
601
|
+
saveVdpData(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VdpDataModel | null | undefined): Promise<void>;
|
|
618
602
|
/**
|
|
619
|
-
* Deletes variable data printing
|
|
603
|
+
* Deletes variable data printing information from design file and updates design in storage.
|
|
620
604
|
* @param id Design identifier
|
|
621
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
622
605
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
623
606
|
* @param tenantId (optional) Tenant identifier
|
|
624
607
|
* @return Success
|
|
625
608
|
*/
|
|
626
|
-
deleteVdpData(id: string | null,
|
|
609
|
+
deleteVdpData(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
|
|
627
610
|
/**
|
|
628
|
-
*
|
|
611
|
+
* Loads product (design model) from resource file taken from storage
|
|
612
|
+
* @param id Resource identifier
|
|
613
|
+
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
629
614
|
* @param tenantId (optional) Tenant identifier
|
|
630
|
-
* @param body (optional) Items to flatten.
|
|
631
615
|
* @return Success
|
|
632
616
|
*/
|
|
633
|
-
|
|
617
|
+
loadProductFromResource(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<any>;
|
|
618
|
+
/**
|
|
619
|
+
* Converts colors
|
|
620
|
+
* @param tenantId (optional) Tenant identifier
|
|
621
|
+
* @param body (optional) Convert colors operation parameters
|
|
622
|
+
* @return Success
|
|
623
|
+
*/
|
|
624
|
+
convertColors(tenantId?: number | undefined, body?: ConvertColorsModel | null | undefined): Promise<any>;
|
|
634
625
|
/**
|
|
635
626
|
* Creates product item
|
|
636
627
|
* @param itemType (optional) Desired item type
|
|
@@ -650,23 +641,20 @@ export interface IDesignAtomsServiceApiClient {
|
|
|
650
641
|
*/
|
|
651
642
|
extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | null | undefined): Promise<FileResponse>;
|
|
652
643
|
/**
|
|
653
|
-
*
|
|
654
|
-
* @param designId (optional) Public design ID.
|
|
655
|
-
* @param privateDesignId (optional) Private design ID.
|
|
656
|
-
* @param privateStorageOwner (optional) Private storage owner ID.
|
|
644
|
+
* Flatten items.
|
|
657
645
|
* @param tenantId (optional) Tenant identifier
|
|
646
|
+
* @param body (optional) Items to flatten.
|
|
658
647
|
* @return Success
|
|
659
648
|
*/
|
|
660
|
-
|
|
649
|
+
flattenItems(tenantId?: number | undefined, body?: any[] | null | undefined): Promise<any>;
|
|
661
650
|
/**
|
|
662
|
-
*
|
|
663
|
-
* @param
|
|
664
|
-
* @param privateDesignId (optional) Private design ID.
|
|
665
|
-
* @param privateStorageOwner (optional) Private storage owner ID.
|
|
651
|
+
* Render product proof image with specified parameters.
|
|
652
|
+
* @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
|
|
666
653
|
* @param tenantId (optional) Tenant identifier
|
|
654
|
+
* @param body (optional) Preview parameters.
|
|
667
655
|
* @return Success
|
|
668
656
|
*/
|
|
669
|
-
|
|
657
|
+
renderProduct(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderProductModel | null | undefined): Promise<FileResponse>;
|
|
670
658
|
/**
|
|
671
659
|
* Renders a design preview with the specified parameters.
|
|
672
660
|
* @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
|
|
@@ -700,45 +688,39 @@ export interface IDesignAtomsServiceApiClient {
|
|
|
700
688
|
*/
|
|
701
689
|
renderDesignProofToResource(tenantId?: number | undefined, body?: RenderDesignProofToResourceModel | null | undefined): Promise<ResourceInfoDto>;
|
|
702
690
|
/**
|
|
703
|
-
*
|
|
704
|
-
* @param
|
|
691
|
+
* Creates a private design from a public design.
|
|
692
|
+
* @param designId (optional) Public design ID.
|
|
693
|
+
* @param privateDesignId (optional) Private design ID.
|
|
694
|
+
* @param privateStorageOwner (optional) Private storage owner ID.
|
|
705
695
|
* @param tenantId (optional) Tenant identifier
|
|
706
|
-
* @param body (optional) Preview parameters.
|
|
707
696
|
* @return Success
|
|
697
|
+
* @deprecated
|
|
708
698
|
*/
|
|
709
|
-
|
|
699
|
+
createPrivateDesignFromDesign(designId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
|
|
710
700
|
/**
|
|
711
|
-
*
|
|
712
|
-
* @param
|
|
713
|
-
* @param
|
|
714
|
-
* @param privateStorageOwner (optional) Private storage owner
|
|
701
|
+
* Creates a private design from a public resource.
|
|
702
|
+
* @param resourceId (optional) Resource ID.
|
|
703
|
+
* @param privateDesignId (optional) Private design ID.
|
|
704
|
+
* @param privateStorageOwner (optional) Private storage owner ID.
|
|
715
705
|
* @param tenantId (optional) Tenant identifier
|
|
716
706
|
* @return Success
|
|
707
|
+
* @deprecated
|
|
717
708
|
*/
|
|
718
|
-
|
|
709
|
+
createPrivateDesignFromResource(resourceId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
|
|
719
710
|
}
|
|
720
711
|
export declare class DesignAtomsServiceApiClient extends ApiClientBase implements IDesignAtomsServiceApiClient {
|
|
721
712
|
private instance;
|
|
722
713
|
private baseUrl;
|
|
723
714
|
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
724
715
|
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
725
|
-
/**
|
|
726
|
-
* Converts colors
|
|
727
|
-
* @param tenantId (optional) Tenant identifier
|
|
728
|
-
* @param body (optional) Convert colors operation parameters
|
|
729
|
-
* @return Success
|
|
730
|
-
*/
|
|
731
|
-
convertColors(tenantId?: number | undefined, body?: ConvertColorsModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
732
|
-
protected processConvertColors(response: AxiosResponse): Promise<any>;
|
|
733
716
|
/**
|
|
734
717
|
* Creates new design file with specified parameters and saves it in storage.
|
|
735
|
-
* @param privateStorage (optional) If set to 'true' design will be saved to private storage
|
|
736
718
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
737
719
|
* @param tenantId (optional) Tenant identifier
|
|
738
720
|
* @param body (optional) Design creation parameters
|
|
739
721
|
* @return Success
|
|
740
722
|
*/
|
|
741
|
-
createDesign(
|
|
723
|
+
createDesign(privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: CreateDesignModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<DesignInfo>;
|
|
742
724
|
protected processCreateDesign(response: AxiosResponse): Promise<DesignInfo>;
|
|
743
725
|
/**
|
|
744
726
|
* Returns content of the background.
|
|
@@ -753,28 +735,25 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
|
|
|
753
735
|
/**
|
|
754
736
|
* Loads product (design model) from design file taken from storage
|
|
755
737
|
* @param id Design identifier
|
|
756
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
757
738
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
758
739
|
* @param tenantId (optional) Tenant identifier
|
|
759
740
|
* @return Success
|
|
760
741
|
*/
|
|
761
|
-
loadProduct(id: string | null,
|
|
742
|
+
loadProduct(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
762
743
|
protected processLoadProduct(response: AxiosResponse): Promise<any>;
|
|
763
744
|
/**
|
|
764
745
|
* Saves product (design model) to design file and updates design in storage.
|
|
765
746
|
* @param id Design identifier
|
|
766
|
-
* @param privateStorage (optional) If set to 'true' design will be saved to private storage
|
|
767
747
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
768
748
|
* @param tenantId (optional) Tenant identifier
|
|
769
749
|
* @param body (optional) Serialized product description
|
|
770
750
|
* @return Success
|
|
771
751
|
*/
|
|
772
|
-
saveProduct(id: string | null,
|
|
752
|
+
saveProduct(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
773
753
|
protected processSaveProduct(response: AxiosResponse): Promise<void>;
|
|
774
754
|
/**
|
|
775
755
|
* Patches product (design model) in design file.
|
|
776
756
|
* @param id Design identifier.
|
|
777
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage.
|
|
778
757
|
* @param privateStorageOwner (optional) Private storage owner identifier.
|
|
779
758
|
* @param tenantId (optional) Tenant identifier
|
|
780
759
|
* @param patchType (optional)
|
|
@@ -785,7 +764,7 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
|
|
|
785
764
|
* @param replacePlaceholderItemContentInfo_sourceFile (optional)
|
|
786
765
|
* @return Success
|
|
787
766
|
*/
|
|
788
|
-
patchProduct(id: string | null,
|
|
767
|
+
patchProduct(id: string | null, 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>;
|
|
789
768
|
protected processPatchProduct(response: AxiosResponse): Promise<void>;
|
|
790
769
|
/**
|
|
791
770
|
* Returns design parameters stored in product model.
|
|
@@ -799,73 +778,76 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
|
|
|
799
778
|
/**
|
|
800
779
|
* Loads data schema from design file taken from storage
|
|
801
780
|
* @param id Design identifier
|
|
802
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
803
781
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
804
782
|
* @param tenantId (optional) Tenant identifier
|
|
805
783
|
* @return Success
|
|
806
784
|
*/
|
|
807
|
-
loadDataSchema(id: string | null,
|
|
785
|
+
loadDataSchema(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
808
786
|
protected processLoadDataSchema(response: AxiosResponse): Promise<FileResponse>;
|
|
809
787
|
/**
|
|
810
788
|
* Gets variable items information for design file taken from storage
|
|
811
789
|
* @param id Design identifier
|
|
812
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
813
790
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
814
791
|
* @param tenantId (optional) Tenant identifier
|
|
815
792
|
* @return Success
|
|
816
793
|
*/
|
|
817
|
-
getVariables(id: string | null,
|
|
794
|
+
getVariables(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<VariablesModel>;
|
|
818
795
|
protected processGetVariables(response: AxiosResponse): Promise<VariablesModel>;
|
|
819
796
|
/**
|
|
820
797
|
* Sets variable items values for design file taken from storage
|
|
821
798
|
* @param id Design identifier
|
|
822
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
823
799
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
824
800
|
* @param tenantId (optional) Tenant identifier
|
|
825
801
|
* @param body (optional) Design variable values
|
|
826
802
|
* @return Success
|
|
827
803
|
*/
|
|
828
|
-
setVariables(id: string | null,
|
|
804
|
+
setVariables(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
829
805
|
protected processSetVariables(response: AxiosResponse): Promise<void>;
|
|
830
806
|
/**
|
|
831
807
|
* Loads variable data printing information from design file taken from storage
|
|
832
808
|
* @param id Design identifier
|
|
833
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
834
809
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
835
810
|
* @param tenantId (optional) Tenant identifier
|
|
836
811
|
* @return Success
|
|
837
812
|
*/
|
|
838
|
-
loadVdpData(id: string | null,
|
|
813
|
+
loadVdpData(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<VdpDataModel>;
|
|
839
814
|
protected processLoadVdpData(response: AxiosResponse): Promise<VdpDataModel>;
|
|
840
815
|
/**
|
|
841
816
|
* Saves variable data printing information to design file and updates design in storage.
|
|
842
817
|
* @param id Design identifier
|
|
843
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
844
818
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
845
819
|
* @param tenantId (optional) Tenant identifier
|
|
846
820
|
* @param body (optional) Serialized vdp data
|
|
847
821
|
* @return Success
|
|
848
822
|
*/
|
|
849
|
-
saveVdpData(id: string | null,
|
|
823
|
+
saveVdpData(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VdpDataModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
850
824
|
protected processSaveVdpData(response: AxiosResponse): Promise<void>;
|
|
851
825
|
/**
|
|
852
|
-
* Deletes variable data printing
|
|
826
|
+
* Deletes variable data printing information from design file and updates design in storage.
|
|
853
827
|
* @param id Design identifier
|
|
854
|
-
* @param privateStorage (optional) If set to 'true' design will be taken from private storage
|
|
855
828
|
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
856
829
|
* @param tenantId (optional) Tenant identifier
|
|
857
830
|
* @return Success
|
|
858
831
|
*/
|
|
859
|
-
deleteVdpData(id: string | null,
|
|
832
|
+
deleteVdpData(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
860
833
|
protected processDeleteVdpData(response: AxiosResponse): Promise<void>;
|
|
861
834
|
/**
|
|
862
|
-
*
|
|
835
|
+
* Loads product (design model) from resource file taken from storage
|
|
836
|
+
* @param id Resource identifier
|
|
837
|
+
* @param privateStorageOwner (optional) Private storage owner identifier
|
|
863
838
|
* @param tenantId (optional) Tenant identifier
|
|
864
|
-
* @param body (optional) Items to flatten.
|
|
865
839
|
* @return Success
|
|
866
840
|
*/
|
|
867
|
-
|
|
868
|
-
protected
|
|
841
|
+
loadProductFromResource(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
842
|
+
protected processLoadProductFromResource(response: AxiosResponse): Promise<any>;
|
|
843
|
+
/**
|
|
844
|
+
* Converts colors
|
|
845
|
+
* @param tenantId (optional) Tenant identifier
|
|
846
|
+
* @param body (optional) Convert colors operation parameters
|
|
847
|
+
* @return Success
|
|
848
|
+
*/
|
|
849
|
+
convertColors(tenantId?: number | undefined, body?: ConvertColorsModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
850
|
+
protected processConvertColors(response: AxiosResponse): Promise<any>;
|
|
869
851
|
/**
|
|
870
852
|
* Creates product item
|
|
871
853
|
* @param itemType (optional) Desired item type
|
|
@@ -887,25 +869,22 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
|
|
|
887
869
|
extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
888
870
|
protected processExtractItemImage(response: AxiosResponse): Promise<FileResponse>;
|
|
889
871
|
/**
|
|
890
|
-
*
|
|
891
|
-
* @param designId (optional) Public design ID.
|
|
892
|
-
* @param privateDesignId (optional) Private design ID.
|
|
893
|
-
* @param privateStorageOwner (optional) Private storage owner ID.
|
|
872
|
+
* Flatten items.
|
|
894
873
|
* @param tenantId (optional) Tenant identifier
|
|
874
|
+
* @param body (optional) Items to flatten.
|
|
895
875
|
* @return Success
|
|
896
876
|
*/
|
|
897
|
-
|
|
898
|
-
protected
|
|
877
|
+
flattenItems(tenantId?: number | undefined, body?: any[] | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
878
|
+
protected processFlattenItems(response: AxiosResponse): Promise<any>;
|
|
899
879
|
/**
|
|
900
|
-
*
|
|
901
|
-
* @param
|
|
902
|
-
* @param privateDesignId (optional) Private design ID.
|
|
903
|
-
* @param privateStorageOwner (optional) Private storage owner ID.
|
|
880
|
+
* Render product proof image with specified parameters.
|
|
881
|
+
* @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
|
|
904
882
|
* @param tenantId (optional) Tenant identifier
|
|
883
|
+
* @param body (optional) Preview parameters.
|
|
905
884
|
* @return Success
|
|
906
885
|
*/
|
|
907
|
-
|
|
908
|
-
protected
|
|
886
|
+
renderProduct(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderProductModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
887
|
+
protected processRenderProduct(response: AxiosResponse): Promise<FileResponse>;
|
|
909
888
|
/**
|
|
910
889
|
* Renders a design preview with the specified parameters.
|
|
911
890
|
* @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
|
|
@@ -943,24 +922,27 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
|
|
|
943
922
|
renderDesignProofToResource(tenantId?: number | undefined, body?: RenderDesignProofToResourceModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
|
|
944
923
|
protected processRenderDesignProofToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
|
|
945
924
|
/**
|
|
946
|
-
*
|
|
947
|
-
* @param
|
|
925
|
+
* Creates a private design from a public design.
|
|
926
|
+
* @param designId (optional) Public design ID.
|
|
927
|
+
* @param privateDesignId (optional) Private design ID.
|
|
928
|
+
* @param privateStorageOwner (optional) Private storage owner ID.
|
|
948
929
|
* @param tenantId (optional) Tenant identifier
|
|
949
|
-
* @param body (optional) Preview parameters.
|
|
950
930
|
* @return Success
|
|
931
|
+
* @deprecated
|
|
951
932
|
*/
|
|
952
|
-
|
|
953
|
-
protected
|
|
933
|
+
createPrivateDesignFromDesign(designId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
934
|
+
protected processCreatePrivateDesignFromDesign(response: AxiosResponse): Promise<void>;
|
|
954
935
|
/**
|
|
955
|
-
*
|
|
956
|
-
* @param
|
|
957
|
-
* @param
|
|
958
|
-
* @param privateStorageOwner (optional) Private storage owner
|
|
936
|
+
* Creates a private design from a public resource.
|
|
937
|
+
* @param resourceId (optional) Resource ID.
|
|
938
|
+
* @param privateDesignId (optional) Private design ID.
|
|
939
|
+
* @param privateStorageOwner (optional) Private storage owner ID.
|
|
959
940
|
* @param tenantId (optional) Tenant identifier
|
|
960
941
|
* @return Success
|
|
942
|
+
* @deprecated
|
|
961
943
|
*/
|
|
962
|
-
|
|
963
|
-
protected
|
|
944
|
+
createPrivateDesignFromResource(resourceId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
945
|
+
protected processCreatePrivateDesignFromResource(response: AxiosResponse): Promise<void>;
|
|
964
946
|
}
|
|
965
947
|
export interface IDesignAtomsViewerApiClient {
|
|
966
948
|
/**
|
|
@@ -1522,6 +1504,8 @@ export interface RenderImagePreviewModel {
|
|
|
1522
1504
|
imageId?: string | null;
|
|
1523
1505
|
/** Storage image owner identifier. */
|
|
1524
1506
|
ownerId?: string | null;
|
|
1507
|
+
/** Mockup owner identifier. */
|
|
1508
|
+
mockupOwnerId?: string | null;
|
|
1525
1509
|
/** Mockup identifier. */
|
|
1526
1510
|
mockupId?: string | null;
|
|
1527
1511
|
/** Image preview configuration. */
|
|
@@ -1544,6 +1528,8 @@ export interface RenderImagePreviewToResourceModel {
|
|
|
1544
1528
|
imageId?: string | null;
|
|
1545
1529
|
/** Storage image owner identifier. */
|
|
1546
1530
|
ownerId?: string | null;
|
|
1531
|
+
/** Mockup owner identifier. */
|
|
1532
|
+
mockupOwnerId?: string | null;
|
|
1547
1533
|
/** Mockup identifier. */
|
|
1548
1534
|
mockupId?: string | null;
|
|
1549
1535
|
/** Image preview configuration. */
|
|
@@ -1562,26 +1548,15 @@ export interface Mockup3dAttributesDto {
|
|
|
1562
1548
|
[key: string]: string;
|
|
1563
1549
|
} | null;
|
|
1564
1550
|
}
|
|
1565
|
-
/**
|
|
1566
|
-
export interface ConvertColorsModel {
|
|
1567
|
-
/** Serialized color description */
|
|
1568
|
-
colors: any[];
|
|
1569
|
-
/** Source color profile description */
|
|
1570
|
-
sourceColorProfile?: string | null;
|
|
1571
|
-
/** Destination color profile description */
|
|
1572
|
-
destinationColorProfile?: string | null;
|
|
1573
|
-
/** Targent color profile description */
|
|
1574
|
-
targetDeviceColorProfile?: string | null;
|
|
1575
|
-
}
|
|
1576
|
-
/** Design creation parameters */
|
|
1551
|
+
/** Design creation parameters. */
|
|
1577
1552
|
export interface CreateDesignModel {
|
|
1578
|
-
/** Serialized product description */
|
|
1553
|
+
/** Serialized product description. */
|
|
1579
1554
|
product?: any | null;
|
|
1580
|
-
/** Serialized product data schema (base64 file stream) */
|
|
1555
|
+
/** Serialized product data schema (base64 file stream). */
|
|
1581
1556
|
dataSchema?: string | null;
|
|
1582
|
-
/** Design name */
|
|
1557
|
+
/** Design name. */
|
|
1583
1558
|
name?: string | null;
|
|
1584
|
-
/** Design location (folder path) */
|
|
1559
|
+
/** Design location (folder path). */
|
|
1585
1560
|
path?: string | null;
|
|
1586
1561
|
}
|
|
1587
1562
|
export interface DesignInfo {
|
|
@@ -1645,35 +1620,92 @@ export interface VariableInfo {
|
|
|
1645
1620
|
/** Variable type. */
|
|
1646
1621
|
type?: string | null;
|
|
1647
1622
|
}
|
|
1648
|
-
/** Variables information */
|
|
1623
|
+
/** Variables information. */
|
|
1649
1624
|
export interface VariablesModel {
|
|
1650
|
-
/** List of variables */
|
|
1625
|
+
/** List of variables. */
|
|
1651
1626
|
items?: VariableInfo[] | null;
|
|
1652
1627
|
}
|
|
1653
|
-
/** Variable data printing information */
|
|
1628
|
+
/** Variable data printing information. */
|
|
1654
1629
|
export interface VdpDataModel {
|
|
1655
|
-
/** Serialized vdp dataset */
|
|
1630
|
+
/** Serialized vdp dataset. */
|
|
1656
1631
|
vdpDataSet?: any | null;
|
|
1657
|
-
/** Serialized vdp items data */
|
|
1632
|
+
/** Serialized vdp items data. */
|
|
1658
1633
|
vdpItemsData?: any | null;
|
|
1659
1634
|
}
|
|
1635
|
+
/** Convert colors operation parameters. */
|
|
1636
|
+
export interface ConvertColorsModel {
|
|
1637
|
+
/** Serialized color description. */
|
|
1638
|
+
colors: any[];
|
|
1639
|
+
/** Source color profile description. */
|
|
1640
|
+
sourceColorProfile?: string | null;
|
|
1641
|
+
/** Destination color profile description. */
|
|
1642
|
+
destinationColorProfile?: string | null;
|
|
1643
|
+
/** Targent color profile description. */
|
|
1644
|
+
targetDeviceColorProfile?: string | null;
|
|
1645
|
+
}
|
|
1660
1646
|
export declare enum ItemType {
|
|
1661
1647
|
Image = "Image",
|
|
1662
1648
|
Shape = "Shape",
|
|
1663
1649
|
Clipart = "Clipart",
|
|
1664
1650
|
Group = "Group"
|
|
1665
1651
|
}
|
|
1666
|
-
/** Item souce types */
|
|
1652
|
+
/** Item souce types. */
|
|
1667
1653
|
export declare enum ItemSourceType {
|
|
1668
1654
|
File = "File",
|
|
1669
1655
|
ImageStorage = "ImageStorage",
|
|
1670
1656
|
PrivateImageStorage = "PrivateImageStorage"
|
|
1671
1657
|
}
|
|
1672
|
-
/** Render product parameters */
|
|
1658
|
+
/** Render product parameters. */
|
|
1673
1659
|
export interface ExtractItemImageModel {
|
|
1674
|
-
/** Serialized item description */
|
|
1660
|
+
/** Serialized item description. */
|
|
1675
1661
|
item: any;
|
|
1676
1662
|
}
|
|
1663
|
+
export declare enum ProductProofFormat {
|
|
1664
|
+
Jpeg = "Jpeg",
|
|
1665
|
+
Png = "Png",
|
|
1666
|
+
Tiff = "Tiff",
|
|
1667
|
+
Pdf = "Pdf"
|
|
1668
|
+
}
|
|
1669
|
+
export declare enum ProductProofInterpolationMode {
|
|
1670
|
+
High = "High",
|
|
1671
|
+
Medium = "Medium",
|
|
1672
|
+
Low = "Low",
|
|
1673
|
+
NearestNeighbour = "NearestNeighbour",
|
|
1674
|
+
Linear = "Linear",
|
|
1675
|
+
Cubic = "Cubic",
|
|
1676
|
+
Supersampling = "Supersampling",
|
|
1677
|
+
Lanczos = "Lanczos",
|
|
1678
|
+
Anisotropic4 = "Anisotropic4",
|
|
1679
|
+
Anisotropic9 = "Anisotropic9",
|
|
1680
|
+
Lanczos3 = "Lanczos3"
|
|
1681
|
+
}
|
|
1682
|
+
export interface ProductProofRenderingConfig {
|
|
1683
|
+
/** Surface to render */
|
|
1684
|
+
surfaceIndex?: number | null;
|
|
1685
|
+
/** Desired proof image width */
|
|
1686
|
+
width?: number;
|
|
1687
|
+
/** Desired proof image height */
|
|
1688
|
+
height?: number;
|
|
1689
|
+
/** Desired proof image format */
|
|
1690
|
+
format?: ProductProofFormat | null;
|
|
1691
|
+
/** Desired proof image interpolation */
|
|
1692
|
+
interpolationMode?: ProductProofInterpolationMode | null;
|
|
1693
|
+
/** Defines whether safety lines should be visualized */
|
|
1694
|
+
safetyLinesEnabled?: boolean | null;
|
|
1695
|
+
/** Defines whether watermark should be included */
|
|
1696
|
+
watermarkEnabled?: boolean | null;
|
|
1697
|
+
/** Defines watermark opacity (in range 0 .. 1.0) */
|
|
1698
|
+
watermarkOpacity?: number | null;
|
|
1699
|
+
/** Defines whether watermark should be repeated */
|
|
1700
|
+
watermarkRepeat?: boolean | null;
|
|
1701
|
+
}
|
|
1702
|
+
/** Render product parameters. */
|
|
1703
|
+
export interface RenderProductModel {
|
|
1704
|
+
/** Serialized product description. */
|
|
1705
|
+
product: any;
|
|
1706
|
+
/** Proof Image rendering config. */
|
|
1707
|
+
renderingConfig?: ProductProofRenderingConfig | null;
|
|
1708
|
+
}
|
|
1677
1709
|
/** Product preview file format. */
|
|
1678
1710
|
export declare enum ProductPreviewFormat {
|
|
1679
1711
|
Jpeg = "Jpeg",
|
|
@@ -1694,6 +1726,8 @@ Used to get mockup file from public storage. */
|
|
|
1694
1726
|
mockupId?: string | null;
|
|
1695
1727
|
/** ID of the design owner. */
|
|
1696
1728
|
ownerId?: string | null;
|
|
1729
|
+
/** ID of the mockup owner. */
|
|
1730
|
+
mockupOwnerId?: string | null;
|
|
1697
1731
|
/** Rendering configuration for getting a preview of design. */
|
|
1698
1732
|
renderingConfig?: ProductPreviewRenderingConfig | null;
|
|
1699
1733
|
/** Variable (user) data for design variable fields in the preview image. */
|
|
@@ -1710,50 +1744,13 @@ Used to get mockup file from public storage. */
|
|
|
1710
1744
|
mockupId?: string | null;
|
|
1711
1745
|
/** ID of the design owner. */
|
|
1712
1746
|
ownerId?: string | null;
|
|
1747
|
+
/** ID of the mockup owner. */
|
|
1748
|
+
mockupOwnerId?: string | null;
|
|
1713
1749
|
/** Rendering configuration for getting a preview of design. */
|
|
1714
1750
|
renderingConfig?: ProductPreviewRenderingConfig | null;
|
|
1715
1751
|
/** Variable (user) data for design variable fields in the preview image. */
|
|
1716
1752
|
variableData?: VariableInfo[] | null;
|
|
1717
1753
|
}
|
|
1718
|
-
export declare enum ProductProofFormat {
|
|
1719
|
-
Jpeg = "Jpeg",
|
|
1720
|
-
Png = "Png",
|
|
1721
|
-
Tiff = "Tiff",
|
|
1722
|
-
Pdf = "Pdf"
|
|
1723
|
-
}
|
|
1724
|
-
export declare enum ProductProofInterpolationMode {
|
|
1725
|
-
High = "High",
|
|
1726
|
-
Medium = "Medium",
|
|
1727
|
-
Low = "Low",
|
|
1728
|
-
NearestNeighbour = "NearestNeighbour",
|
|
1729
|
-
Linear = "Linear",
|
|
1730
|
-
Cubic = "Cubic",
|
|
1731
|
-
Supersampling = "Supersampling",
|
|
1732
|
-
Lanczos = "Lanczos",
|
|
1733
|
-
Anisotropic4 = "Anisotropic4",
|
|
1734
|
-
Anisotropic9 = "Anisotropic9",
|
|
1735
|
-
Lanczos3 = "Lanczos3"
|
|
1736
|
-
}
|
|
1737
|
-
export interface ProductProofRenderingConfig {
|
|
1738
|
-
/** Surface to render */
|
|
1739
|
-
surfaceIndex?: number | null;
|
|
1740
|
-
/** Desired proof image width */
|
|
1741
|
-
width?: number;
|
|
1742
|
-
/** Desired proof image height */
|
|
1743
|
-
height?: number;
|
|
1744
|
-
/** Desired proof image format */
|
|
1745
|
-
format?: ProductProofFormat | null;
|
|
1746
|
-
/** Desired proof image interpolation */
|
|
1747
|
-
interpolationMode?: ProductProofInterpolationMode | null;
|
|
1748
|
-
/** Defines whether safety lines should be visualized */
|
|
1749
|
-
safetyLinesEnabled?: boolean | null;
|
|
1750
|
-
/** Defines whether watermark should be included */
|
|
1751
|
-
watermarkEnabled?: boolean | null;
|
|
1752
|
-
/** Defines watermark opacity (in range 0 .. 1.0) */
|
|
1753
|
-
watermarkOpacity?: number | null;
|
|
1754
|
-
/** Defines whether watermark should be repeated */
|
|
1755
|
-
watermarkRepeat?: boolean | null;
|
|
1756
|
-
}
|
|
1757
1754
|
export interface RenderDesignProofModel {
|
|
1758
1755
|
/** Design ID.
|
|
1759
1756
|
Used to get design file from public or private storage. */
|
|
@@ -1778,13 +1775,6 @@ Used to get design file from public or private storage. */
|
|
|
1778
1775
|
/** Variable (user) data for design variable fields in the proof image. */
|
|
1779
1776
|
variableData?: VariableInfo[] | null;
|
|
1780
1777
|
}
|
|
1781
|
-
/** Render product parameters */
|
|
1782
|
-
export interface RenderProductModel {
|
|
1783
|
-
/** Serialized product description */
|
|
1784
|
-
product: any;
|
|
1785
|
-
/** Proof Image rendering config */
|
|
1786
|
-
renderingConfig?: ProductProofRenderingConfig | null;
|
|
1787
|
-
}
|
|
1788
1778
|
export interface FileParameter {
|
|
1789
1779
|
data: any;
|
|
1790
1780
|
fileName: string;
|