@teemill/platform 0.9.0 → 0.11.0
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/README.md +2 -2
- package/api.ts +2252 -110
- package/base.ts +3 -3
- package/common.ts +3 -3
- package/configuration.ts +10 -4
- package/dist/api.d.ts +1594 -59
- package/dist/api.js +1001 -25
- package/dist/base.d.ts +3 -3
- package/dist/base.js +3 -3
- package/dist/common.d.ts +3 -3
- package/dist/common.js +3 -3
- package/dist/configuration.d.ts +3 -3
- package/dist/configuration.js +5 -4
- package/dist/esm/api.d.ts +1594 -59
- package/dist/esm/api.js +988 -24
- package/dist/esm/base.d.ts +3 -3
- package/dist/esm/base.js +3 -3
- package/dist/esm/common.d.ts +3 -3
- package/dist/esm/common.js +3 -3
- package/dist/esm/configuration.d.ts +3 -3
- package/dist/esm/configuration.js +5 -4
- package/dist/esm/index.d.ts +3 -3
- package/dist/esm/index.js +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +3 -3
- package/index.ts +3 -3
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Platform API
|
|
3
|
-
* Manage Your podOS platform
|
|
3
|
+
* Manage Your podOS platform
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.11.0
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.9.0
|
|
6
|
-
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
@@ -87,6 +87,62 @@ export interface ApiError {
|
|
|
87
87
|
*/
|
|
88
88
|
'message': string;
|
|
89
89
|
}
|
|
90
|
+
/**
|
|
91
|
+
* Application of a variant
|
|
92
|
+
* @export
|
|
93
|
+
* @interface Application
|
|
94
|
+
*/
|
|
95
|
+
export interface Application {
|
|
96
|
+
/**
|
|
97
|
+
* Placement of the application
|
|
98
|
+
* @type {string}
|
|
99
|
+
* @memberof Application
|
|
100
|
+
*/
|
|
101
|
+
'placement': string;
|
|
102
|
+
/**
|
|
103
|
+
*
|
|
104
|
+
* @type {ApplicationTechnology}
|
|
105
|
+
* @memberof Application
|
|
106
|
+
*/
|
|
107
|
+
'technology'?: ApplicationTechnology | null;
|
|
108
|
+
/**
|
|
109
|
+
*
|
|
110
|
+
* @type {Mockup}
|
|
111
|
+
* @memberof Application
|
|
112
|
+
*/
|
|
113
|
+
'mockup': Mockup;
|
|
114
|
+
/**
|
|
115
|
+
*
|
|
116
|
+
* @type {Output}
|
|
117
|
+
* @memberof Application
|
|
118
|
+
*/
|
|
119
|
+
'output'?: Output;
|
|
120
|
+
/**
|
|
121
|
+
* Whether the application requires pretreatment
|
|
122
|
+
* @type {boolean}
|
|
123
|
+
* @memberof Application
|
|
124
|
+
*/
|
|
125
|
+
'requiresPretreat'?: boolean;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Technology to be used for the application
|
|
129
|
+
* @export
|
|
130
|
+
* @interface ApplicationTechnology
|
|
131
|
+
*/
|
|
132
|
+
export interface ApplicationTechnology {
|
|
133
|
+
/**
|
|
134
|
+
* Unique object identifier
|
|
135
|
+
* @type {string}
|
|
136
|
+
* @memberof ApplicationTechnology
|
|
137
|
+
*/
|
|
138
|
+
'id'?: string;
|
|
139
|
+
/**
|
|
140
|
+
* A reference to the resource location
|
|
141
|
+
* @type {string}
|
|
142
|
+
* @memberof ApplicationTechnology
|
|
143
|
+
*/
|
|
144
|
+
'ref'?: string;
|
|
145
|
+
}
|
|
90
146
|
/**
|
|
91
147
|
* Order recipient contact information, used only for courier tracking/updates.
|
|
92
148
|
* @export
|
|
@@ -106,6 +162,56 @@ export interface ContactInformation {
|
|
|
106
162
|
*/
|
|
107
163
|
'phone'?: string | null;
|
|
108
164
|
}
|
|
165
|
+
/**
|
|
166
|
+
* The customer that has placed an order on your platform
|
|
167
|
+
* @export
|
|
168
|
+
* @interface Customer
|
|
169
|
+
*/
|
|
170
|
+
export interface Customer {
|
|
171
|
+
/**
|
|
172
|
+
* Unique object identifier
|
|
173
|
+
* @type {string}
|
|
174
|
+
* @memberof Customer
|
|
175
|
+
*/
|
|
176
|
+
'id': string;
|
|
177
|
+
/**
|
|
178
|
+
*
|
|
179
|
+
* @type {string}
|
|
180
|
+
* @memberof Customer
|
|
181
|
+
*/
|
|
182
|
+
'email': string;
|
|
183
|
+
/**
|
|
184
|
+
*
|
|
185
|
+
* @type {string}
|
|
186
|
+
* @memberof Customer
|
|
187
|
+
*/
|
|
188
|
+
'firstName'?: string;
|
|
189
|
+
/**
|
|
190
|
+
*
|
|
191
|
+
* @type {string}
|
|
192
|
+
* @memberof Customer
|
|
193
|
+
*/
|
|
194
|
+
'lastName'?: string;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
*
|
|
198
|
+
* @export
|
|
199
|
+
* @interface CustomersResponse
|
|
200
|
+
*/
|
|
201
|
+
export interface CustomersResponse {
|
|
202
|
+
/**
|
|
203
|
+
*
|
|
204
|
+
* @type {Array<Customer>}
|
|
205
|
+
* @memberof CustomersResponse
|
|
206
|
+
*/
|
|
207
|
+
'customers': Array<Customer>;
|
|
208
|
+
/**
|
|
209
|
+
*
|
|
210
|
+
* @type {number}
|
|
211
|
+
* @memberof CustomersResponse
|
|
212
|
+
*/
|
|
213
|
+
'nextPageToken'?: number | null;
|
|
214
|
+
}
|
|
109
215
|
/**
|
|
110
216
|
*
|
|
111
217
|
* @export
|
|
@@ -306,6 +412,87 @@ export interface Image {
|
|
|
306
412
|
*/
|
|
307
413
|
'sortOrder'?: number;
|
|
308
414
|
}
|
|
415
|
+
/**
|
|
416
|
+
*
|
|
417
|
+
* @export
|
|
418
|
+
* @interface Metafield
|
|
419
|
+
*/
|
|
420
|
+
export interface Metafield {
|
|
421
|
+
/**
|
|
422
|
+
* The unique identifier for a meta field
|
|
423
|
+
* @type {string}
|
|
424
|
+
* @memberof Metafield
|
|
425
|
+
*/
|
|
426
|
+
'key': string;
|
|
427
|
+
/**
|
|
428
|
+
* The data stored in the meta field. Always stored as a string, regardless of the meta field\'s type.
|
|
429
|
+
* @type {string}
|
|
430
|
+
* @memberof Metafield
|
|
431
|
+
*/
|
|
432
|
+
'value': string;
|
|
433
|
+
}
|
|
434
|
+
/**
|
|
435
|
+
* Configuration of the product mockup
|
|
436
|
+
* @export
|
|
437
|
+
* @interface Mockup
|
|
438
|
+
*/
|
|
439
|
+
export interface Mockup {
|
|
440
|
+
/**
|
|
441
|
+
* Base image of the mockup
|
|
442
|
+
* @type {string}
|
|
443
|
+
* @memberof Mockup
|
|
444
|
+
*/
|
|
445
|
+
'baseImage': string;
|
|
446
|
+
/**
|
|
447
|
+
*
|
|
448
|
+
* @type {MockupDesignPlacement}
|
|
449
|
+
* @memberof Mockup
|
|
450
|
+
*/
|
|
451
|
+
'designPlacement'?: MockupDesignPlacement | null;
|
|
452
|
+
/**
|
|
453
|
+
* Optional mask applied to the design. Used for products with non-rectangular print areas
|
|
454
|
+
* @type {string}
|
|
455
|
+
* @memberof Mockup
|
|
456
|
+
*/
|
|
457
|
+
'designMask'?: string | null;
|
|
458
|
+
/**
|
|
459
|
+
* Optional image to be overlaid on top of the design. This can be used to give the impression of texture, shading, depth or other effects.
|
|
460
|
+
* @type {string}
|
|
461
|
+
* @memberof Mockup
|
|
462
|
+
*/
|
|
463
|
+
'overlayImage'?: string | null;
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
* Design placement
|
|
467
|
+
* @export
|
|
468
|
+
* @interface MockupDesignPlacement
|
|
469
|
+
*/
|
|
470
|
+
export interface MockupDesignPlacement {
|
|
471
|
+
/**
|
|
472
|
+
* X coordinate in pixels
|
|
473
|
+
* @type {number}
|
|
474
|
+
* @memberof MockupDesignPlacement
|
|
475
|
+
*/
|
|
476
|
+
'x': number;
|
|
477
|
+
/**
|
|
478
|
+
* Y coordinate in pixels
|
|
479
|
+
* @type {number}
|
|
480
|
+
* @memberof MockupDesignPlacement
|
|
481
|
+
*/
|
|
482
|
+
'y': number;
|
|
483
|
+
/**
|
|
484
|
+
* Width in pixels
|
|
485
|
+
* @type {number}
|
|
486
|
+
* @memberof MockupDesignPlacement
|
|
487
|
+
*/
|
|
488
|
+
'width': number;
|
|
489
|
+
/**
|
|
490
|
+
* Height in pixels
|
|
491
|
+
* @type {number}
|
|
492
|
+
* @memberof MockupDesignPlacement
|
|
493
|
+
*/
|
|
494
|
+
'height': number;
|
|
495
|
+
}
|
|
309
496
|
/**
|
|
310
497
|
*
|
|
311
498
|
* @export
|
|
@@ -583,6 +770,174 @@ export interface Origin {
|
|
|
583
770
|
*/
|
|
584
771
|
'isPaid'?: boolean;
|
|
585
772
|
}
|
|
773
|
+
/**
|
|
774
|
+
* Configuration of the files output for this application
|
|
775
|
+
* @export
|
|
776
|
+
* @interface Output
|
|
777
|
+
*/
|
|
778
|
+
export interface Output {
|
|
779
|
+
/**
|
|
780
|
+
* Width of the print file in pixels
|
|
781
|
+
* @type {number}
|
|
782
|
+
* @memberof Output
|
|
783
|
+
*/
|
|
784
|
+
'width': number;
|
|
785
|
+
/**
|
|
786
|
+
* Height of the print file in pixels
|
|
787
|
+
* @type {number}
|
|
788
|
+
* @memberof Output
|
|
789
|
+
*/
|
|
790
|
+
'height': number;
|
|
791
|
+
/**
|
|
792
|
+
* DPI of the print file in pixels
|
|
793
|
+
* @type {number}
|
|
794
|
+
* @memberof Output
|
|
795
|
+
*/
|
|
796
|
+
'dpi': number;
|
|
797
|
+
/**
|
|
798
|
+
*
|
|
799
|
+
* @type {OutputPadding}
|
|
800
|
+
* @memberof Output
|
|
801
|
+
*/
|
|
802
|
+
'padding'?: OutputPadding;
|
|
803
|
+
/**
|
|
804
|
+
* Position of the print
|
|
805
|
+
* @type {string}
|
|
806
|
+
* @memberof Output
|
|
807
|
+
*/
|
|
808
|
+
'position': OutputPositionEnum;
|
|
809
|
+
/**
|
|
810
|
+
* Whether the print should be mirrored horizontally
|
|
811
|
+
* @type {boolean}
|
|
812
|
+
* @memberof Output
|
|
813
|
+
*/
|
|
814
|
+
'mirrorX'?: boolean;
|
|
815
|
+
/**
|
|
816
|
+
* Whether the print should be mirrored vertically
|
|
817
|
+
* @type {boolean}
|
|
818
|
+
* @memberof Output
|
|
819
|
+
*/
|
|
820
|
+
'mirrorY'?: boolean;
|
|
821
|
+
/**
|
|
822
|
+
* Amount of reflection in pixels
|
|
823
|
+
* @type {number}
|
|
824
|
+
* @memberof Output
|
|
825
|
+
*/
|
|
826
|
+
'reflect'?: number;
|
|
827
|
+
/**
|
|
828
|
+
* Amount to extend the print in pixels
|
|
829
|
+
* @type {number}
|
|
830
|
+
* @memberof Output
|
|
831
|
+
*/
|
|
832
|
+
'extend'?: number;
|
|
833
|
+
/**
|
|
834
|
+
* Rotation in degrees
|
|
835
|
+
* @type {number}
|
|
836
|
+
* @memberof Output
|
|
837
|
+
*/
|
|
838
|
+
'rotate'?: number;
|
|
839
|
+
/**
|
|
840
|
+
* Format of the print file
|
|
841
|
+
* @type {string}
|
|
842
|
+
* @memberof Output
|
|
843
|
+
*/
|
|
844
|
+
'fileFormat': OutputFileFormatEnum;
|
|
845
|
+
/**
|
|
846
|
+
*
|
|
847
|
+
* @type {Array<OutputDeviceConfigsInner>}
|
|
848
|
+
* @memberof Output
|
|
849
|
+
*/
|
|
850
|
+
'deviceConfigs'?: Array<OutputDeviceConfigsInner>;
|
|
851
|
+
}
|
|
852
|
+
export declare const OutputPositionEnum: {
|
|
853
|
+
readonly Center: "center";
|
|
854
|
+
readonly Top: "top";
|
|
855
|
+
readonly Left: "left";
|
|
856
|
+
readonly Bottom: "bottom";
|
|
857
|
+
readonly Right: "right";
|
|
858
|
+
readonly RightTop: "right-top";
|
|
859
|
+
readonly RightBottom: "right-bottom";
|
|
860
|
+
readonly LeftTop: "left-top";
|
|
861
|
+
readonly LeftBottom: "left-bottom";
|
|
862
|
+
};
|
|
863
|
+
export type OutputPositionEnum = typeof OutputPositionEnum[keyof typeof OutputPositionEnum];
|
|
864
|
+
export declare const OutputFileFormatEnum: {
|
|
865
|
+
readonly Png: "png";
|
|
866
|
+
readonly Jpg: "jpg";
|
|
867
|
+
readonly Jpeg: "jpeg";
|
|
868
|
+
readonly Webp: "webp";
|
|
869
|
+
readonly Pdf: "pdf";
|
|
870
|
+
};
|
|
871
|
+
export type OutputFileFormatEnum = typeof OutputFileFormatEnum[keyof typeof OutputFileFormatEnum];
|
|
872
|
+
/**
|
|
873
|
+
*
|
|
874
|
+
* @export
|
|
875
|
+
* @interface OutputDeviceConfigsInner
|
|
876
|
+
*/
|
|
877
|
+
export interface OutputDeviceConfigsInner {
|
|
878
|
+
/**
|
|
879
|
+
* Unique object identifier
|
|
880
|
+
* @type {string}
|
|
881
|
+
* @memberof OutputDeviceConfigsInner
|
|
882
|
+
*/
|
|
883
|
+
'modelId'?: string;
|
|
884
|
+
/**
|
|
885
|
+
*
|
|
886
|
+
* @type {Array<OutputDeviceConfigsInnerPropertiesInner>}
|
|
887
|
+
* @memberof OutputDeviceConfigsInner
|
|
888
|
+
*/
|
|
889
|
+
'properties'?: Array<OutputDeviceConfigsInnerPropertiesInner>;
|
|
890
|
+
}
|
|
891
|
+
/**
|
|
892
|
+
*
|
|
893
|
+
* @export
|
|
894
|
+
* @interface OutputDeviceConfigsInnerPropertiesInner
|
|
895
|
+
*/
|
|
896
|
+
export interface OutputDeviceConfigsInnerPropertiesInner {
|
|
897
|
+
/**
|
|
898
|
+
*
|
|
899
|
+
* @type {string}
|
|
900
|
+
* @memberof OutputDeviceConfigsInnerPropertiesInner
|
|
901
|
+
*/
|
|
902
|
+
'name'?: string;
|
|
903
|
+
/**
|
|
904
|
+
*
|
|
905
|
+
* @type {string}
|
|
906
|
+
* @memberof OutputDeviceConfigsInnerPropertiesInner
|
|
907
|
+
*/
|
|
908
|
+
'option'?: string;
|
|
909
|
+
}
|
|
910
|
+
/**
|
|
911
|
+
* Padding to be applied to the print file
|
|
912
|
+
* @export
|
|
913
|
+
* @interface OutputPadding
|
|
914
|
+
*/
|
|
915
|
+
export interface OutputPadding {
|
|
916
|
+
/**
|
|
917
|
+
* Top padding in pixels
|
|
918
|
+
* @type {number}
|
|
919
|
+
* @memberof OutputPadding
|
|
920
|
+
*/
|
|
921
|
+
'top': number;
|
|
922
|
+
/**
|
|
923
|
+
* Right padding in pixels
|
|
924
|
+
* @type {number}
|
|
925
|
+
* @memberof OutputPadding
|
|
926
|
+
*/
|
|
927
|
+
'right': number;
|
|
928
|
+
/**
|
|
929
|
+
* Bottom padding in pixels
|
|
930
|
+
* @type {number}
|
|
931
|
+
* @memberof OutputPadding
|
|
932
|
+
*/
|
|
933
|
+
'bottom': number;
|
|
934
|
+
/**
|
|
935
|
+
* Left padding in pixels
|
|
936
|
+
* @type {number}
|
|
937
|
+
* @memberof OutputPadding
|
|
938
|
+
*/
|
|
939
|
+
'left': number;
|
|
940
|
+
}
|
|
586
941
|
/**
|
|
587
942
|
*
|
|
588
943
|
* @export
|
|
@@ -669,89 +1024,323 @@ export interface Price {
|
|
|
669
1024
|
/**
|
|
670
1025
|
*
|
|
671
1026
|
* @export
|
|
672
|
-
* @interface
|
|
1027
|
+
* @interface Product
|
|
673
1028
|
*/
|
|
674
|
-
export interface
|
|
1029
|
+
export interface Product {
|
|
675
1030
|
/**
|
|
676
1031
|
* Unique object identifier
|
|
677
1032
|
* @type {string}
|
|
678
|
-
* @memberof
|
|
1033
|
+
* @memberof Product
|
|
679
1034
|
*/
|
|
680
|
-
'id'
|
|
1035
|
+
'id': string;
|
|
681
1036
|
/**
|
|
682
|
-
*
|
|
1037
|
+
* A reference to the resource location
|
|
683
1038
|
* @type {string}
|
|
684
|
-
* @memberof
|
|
1039
|
+
* @memberof Product
|
|
685
1040
|
*/
|
|
686
|
-
'
|
|
1041
|
+
'ref': string;
|
|
687
1042
|
/**
|
|
688
1043
|
*
|
|
689
1044
|
* @type {string}
|
|
690
|
-
* @memberof
|
|
1045
|
+
* @memberof Product
|
|
691
1046
|
*/
|
|
692
|
-
'
|
|
1047
|
+
'title': string;
|
|
693
1048
|
/**
|
|
694
|
-
*
|
|
695
|
-
* @type {
|
|
696
|
-
* @memberof
|
|
1049
|
+
* Whether the product is enabled
|
|
1050
|
+
* @type {boolean}
|
|
1051
|
+
* @memberof Product
|
|
697
1052
|
*/
|
|
698
|
-
'
|
|
1053
|
+
'enabled'?: boolean;
|
|
699
1054
|
/**
|
|
700
|
-
*
|
|
701
|
-
* @type {
|
|
702
|
-
* @memberof
|
|
1055
|
+
* Whether stock levels should be tracked for this product
|
|
1056
|
+
* @type {boolean}
|
|
1057
|
+
* @memberof Product
|
|
703
1058
|
*/
|
|
704
|
-
'
|
|
1059
|
+
'trackInventory'?: boolean;
|
|
705
1060
|
/**
|
|
706
|
-
*
|
|
707
|
-
* @type {
|
|
708
|
-
* @memberof
|
|
1061
|
+
* Whether this product should always be purchasable, regardless of factory stock levels
|
|
1062
|
+
* @type {boolean}
|
|
1063
|
+
* @memberof Product
|
|
709
1064
|
*/
|
|
710
|
-
'
|
|
1065
|
+
'alwaysInStock'?: boolean;
|
|
711
1066
|
/**
|
|
712
1067
|
*
|
|
713
|
-
* @type {
|
|
714
|
-
* @memberof
|
|
1068
|
+
* @type {string}
|
|
1069
|
+
* @memberof Product
|
|
715
1070
|
*/
|
|
716
|
-
'
|
|
1071
|
+
'sku'?: string;
|
|
717
1072
|
/**
|
|
718
|
-
*
|
|
719
|
-
* @type {
|
|
720
|
-
* @memberof
|
|
1073
|
+
* Tariff code of the product
|
|
1074
|
+
* @type {number}
|
|
1075
|
+
* @memberof Product
|
|
721
1076
|
*/
|
|
722
|
-
'
|
|
723
|
-
}
|
|
724
|
-
/**
|
|
725
|
-
*
|
|
726
|
-
* @export
|
|
727
|
-
* @interface StatusHistoryItem
|
|
728
|
-
*/
|
|
729
|
-
export interface StatusHistoryItem {
|
|
1077
|
+
'tariffCode'?: number;
|
|
730
1078
|
/**
|
|
731
|
-
*
|
|
732
|
-
* @type {
|
|
733
|
-
* @memberof
|
|
1079
|
+
* Brand of the product
|
|
1080
|
+
* @type {string}
|
|
1081
|
+
* @memberof Product
|
|
734
1082
|
*/
|
|
735
|
-
'
|
|
1083
|
+
'brand'?: string;
|
|
736
1084
|
/**
|
|
737
|
-
*
|
|
1085
|
+
* The owner of the product
|
|
738
1086
|
* @type {string}
|
|
739
|
-
* @memberof
|
|
1087
|
+
* @memberof Product
|
|
740
1088
|
*/
|
|
741
|
-
'
|
|
742
|
-
}
|
|
743
|
-
/**
|
|
744
|
-
*
|
|
745
|
-
* @export
|
|
746
|
-
* @interface UpdateFulfillmentRequest
|
|
747
|
-
*/
|
|
748
|
-
export interface UpdateFulfillmentRequest {
|
|
1089
|
+
'ownerId': string;
|
|
749
1090
|
/**
|
|
750
|
-
*
|
|
1091
|
+
* Description of the product
|
|
751
1092
|
* @type {string}
|
|
752
|
-
* @memberof
|
|
1093
|
+
* @memberof Product
|
|
753
1094
|
*/
|
|
754
|
-
'
|
|
1095
|
+
'description'?: string;
|
|
1096
|
+
/**
|
|
1097
|
+
* Specifications of the product
|
|
1098
|
+
* @type {string}
|
|
1099
|
+
* @memberof Product
|
|
1100
|
+
*/
|
|
1101
|
+
'specifications'?: string;
|
|
1102
|
+
/**
|
|
1103
|
+
*
|
|
1104
|
+
* @type {ProductType}
|
|
1105
|
+
* @memberof Product
|
|
1106
|
+
*/
|
|
1107
|
+
'productType': ProductType;
|
|
1108
|
+
/**
|
|
1109
|
+
* Attributes associated to a product such as Colour and Size.
|
|
1110
|
+
* @type {Array<ProductAttribute>}
|
|
1111
|
+
* @memberof Product
|
|
1112
|
+
*/
|
|
1113
|
+
'attributes': Array<ProductAttribute>;
|
|
1114
|
+
/**
|
|
1115
|
+
* Additional data to be stored with the product
|
|
1116
|
+
* @type {Array<Metafield>}
|
|
1117
|
+
* @memberof Product
|
|
1118
|
+
*/
|
|
1119
|
+
'metafields': Array<Metafield>;
|
|
1120
|
+
/**
|
|
1121
|
+
* Variants
|
|
1122
|
+
* @type {Array<ProductVariantsInner>}
|
|
1123
|
+
* @memberof Product
|
|
1124
|
+
*/
|
|
1125
|
+
'variants': Array<ProductVariantsInner>;
|
|
1126
|
+
/**
|
|
1127
|
+
* ISO 8601 Timestamp
|
|
1128
|
+
* @type {string}
|
|
1129
|
+
* @memberof Product
|
|
1130
|
+
*/
|
|
1131
|
+
'createdAt'?: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* ISO 8601 Timestamp
|
|
1134
|
+
* @type {string}
|
|
1135
|
+
* @memberof Product
|
|
1136
|
+
*/
|
|
1137
|
+
'updatedAt'?: string;
|
|
1138
|
+
/**
|
|
1139
|
+
* Images
|
|
1140
|
+
* @type {Array<Image>}
|
|
1141
|
+
* @memberof Product
|
|
1142
|
+
*/
|
|
1143
|
+
'images'?: Array<Image>;
|
|
1144
|
+
}
|
|
1145
|
+
/**
|
|
1146
|
+
*
|
|
1147
|
+
* @export
|
|
1148
|
+
* @interface ProductAttribute
|
|
1149
|
+
*/
|
|
1150
|
+
export interface ProductAttribute {
|
|
1151
|
+
/**
|
|
1152
|
+
* Attribute name
|
|
1153
|
+
* @type {string}
|
|
1154
|
+
* @memberof ProductAttribute
|
|
1155
|
+
*/
|
|
1156
|
+
'name': string;
|
|
1157
|
+
/**
|
|
1158
|
+
* Position of the attribute when ordered
|
|
1159
|
+
* @type {number}
|
|
1160
|
+
* @memberof ProductAttribute
|
|
1161
|
+
*/
|
|
1162
|
+
'sortOrder': number;
|
|
1163
|
+
/**
|
|
1164
|
+
* Attribute values
|
|
1165
|
+
* @type {Array<ProductAttributeValuesInner>}
|
|
1166
|
+
* @memberof ProductAttribute
|
|
1167
|
+
*/
|
|
1168
|
+
'values': Array<ProductAttributeValuesInner>;
|
|
1169
|
+
}
|
|
1170
|
+
/**
|
|
1171
|
+
*
|
|
1172
|
+
* @export
|
|
1173
|
+
* @interface ProductAttributeValuesInner
|
|
1174
|
+
*/
|
|
1175
|
+
export interface ProductAttributeValuesInner {
|
|
1176
|
+
/**
|
|
1177
|
+
* Position of the attribute value when ordered
|
|
1178
|
+
* @type {number}
|
|
1179
|
+
* @memberof ProductAttributeValuesInner
|
|
1180
|
+
*/
|
|
1181
|
+
'sortOrder': number;
|
|
1182
|
+
/**
|
|
1183
|
+
* Value of the attribute
|
|
1184
|
+
* @type {string}
|
|
1185
|
+
* @memberof ProductAttributeValuesInner
|
|
1186
|
+
*/
|
|
1187
|
+
'value': string;
|
|
1188
|
+
/**
|
|
1189
|
+
*
|
|
1190
|
+
* @type {ProductAttributeValuesInnerThumbnail}
|
|
1191
|
+
* @memberof ProductAttributeValuesInner
|
|
1192
|
+
*/
|
|
1193
|
+
'thumbnail'?: ProductAttributeValuesInnerThumbnail;
|
|
1194
|
+
}
|
|
1195
|
+
/**
|
|
1196
|
+
*
|
|
1197
|
+
* @export
|
|
1198
|
+
* @interface ProductAttributeValuesInnerThumbnail
|
|
1199
|
+
*/
|
|
1200
|
+
export interface ProductAttributeValuesInnerThumbnail {
|
|
1201
|
+
/**
|
|
1202
|
+
*
|
|
1203
|
+
* @type {string}
|
|
1204
|
+
* @memberof ProductAttributeValuesInnerThumbnail
|
|
1205
|
+
*/
|
|
1206
|
+
'type'?: ProductAttributeValuesInnerThumbnailTypeEnum;
|
|
1207
|
+
/**
|
|
1208
|
+
*
|
|
1209
|
+
* @type {string}
|
|
1210
|
+
* @memberof ProductAttributeValuesInnerThumbnail
|
|
1211
|
+
*/
|
|
1212
|
+
'value'?: string;
|
|
1213
|
+
}
|
|
1214
|
+
export declare const ProductAttributeValuesInnerThumbnailTypeEnum: {
|
|
1215
|
+
readonly Text: "text";
|
|
1216
|
+
readonly Color: "color";
|
|
1217
|
+
readonly Image: "image";
|
|
1218
|
+
};
|
|
1219
|
+
export type ProductAttributeValuesInnerThumbnailTypeEnum = typeof ProductAttributeValuesInnerThumbnailTypeEnum[keyof typeof ProductAttributeValuesInnerThumbnailTypeEnum];
|
|
1220
|
+
/**
|
|
1221
|
+
*
|
|
1222
|
+
* @export
|
|
1223
|
+
* @interface ProductType
|
|
1224
|
+
*/
|
|
1225
|
+
export interface ProductType {
|
|
1226
|
+
/**
|
|
1227
|
+
* Id of the product type
|
|
1228
|
+
* @type {number}
|
|
1229
|
+
* @memberof ProductType
|
|
1230
|
+
*/
|
|
1231
|
+
'id'?: number;
|
|
1232
|
+
/**
|
|
1233
|
+
* Name of the product type
|
|
1234
|
+
* @type {string}
|
|
1235
|
+
* @memberof ProductType
|
|
1236
|
+
*/
|
|
1237
|
+
'name'?: string;
|
|
1238
|
+
}
|
|
1239
|
+
/**
|
|
1240
|
+
*
|
|
1241
|
+
* @export
|
|
1242
|
+
* @interface ProductVariantsInner
|
|
1243
|
+
*/
|
|
1244
|
+
export interface ProductVariantsInner {
|
|
1245
|
+
/**
|
|
1246
|
+
* Unique object identifier
|
|
1247
|
+
* @type {string}
|
|
1248
|
+
* @memberof ProductVariantsInner
|
|
1249
|
+
*/
|
|
1250
|
+
'id'?: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* A reference to the resource location
|
|
1253
|
+
* @type {string}
|
|
1254
|
+
* @memberof ProductVariantsInner
|
|
1255
|
+
*/
|
|
1256
|
+
'ref'?: string;
|
|
1257
|
+
}
|
|
1258
|
+
/**
|
|
1259
|
+
*
|
|
1260
|
+
* @export
|
|
1261
|
+
* @interface ShippingMethod
|
|
1262
|
+
*/
|
|
1263
|
+
export interface ShippingMethod {
|
|
1264
|
+
/**
|
|
1265
|
+
* Unique object identifier
|
|
1266
|
+
* @type {string}
|
|
1267
|
+
* @memberof ShippingMethod
|
|
1268
|
+
*/
|
|
1269
|
+
'id'?: string;
|
|
1270
|
+
/**
|
|
1271
|
+
*
|
|
1272
|
+
* @type {string}
|
|
1273
|
+
* @memberof ShippingMethod
|
|
1274
|
+
*/
|
|
1275
|
+
'name'?: string;
|
|
1276
|
+
/**
|
|
1277
|
+
*
|
|
1278
|
+
* @type {string}
|
|
1279
|
+
* @memberof ShippingMethod
|
|
1280
|
+
*/
|
|
1281
|
+
'description'?: string;
|
|
1282
|
+
/**
|
|
1283
|
+
*
|
|
1284
|
+
* @type {DeliveryEstimates}
|
|
1285
|
+
* @memberof ShippingMethod
|
|
1286
|
+
*/
|
|
1287
|
+
'deliveryEstimates'?: DeliveryEstimates;
|
|
1288
|
+
/**
|
|
1289
|
+
*
|
|
1290
|
+
* @type {Price}
|
|
1291
|
+
* @memberof ShippingMethod
|
|
1292
|
+
*/
|
|
1293
|
+
'totalPrice'?: Price;
|
|
1294
|
+
/**
|
|
1295
|
+
*
|
|
1296
|
+
* @type {Price}
|
|
1297
|
+
* @memberof ShippingMethod
|
|
1298
|
+
*/
|
|
1299
|
+
'taxPrice'?: Price;
|
|
1300
|
+
/**
|
|
1301
|
+
*
|
|
1302
|
+
* @type {Price}
|
|
1303
|
+
* @memberof ShippingMethod
|
|
1304
|
+
*/
|
|
1305
|
+
'subtotalPrice'?: Price;
|
|
1306
|
+
/**
|
|
1307
|
+
*
|
|
1308
|
+
* @type {Price}
|
|
1309
|
+
* @memberof ShippingMethod
|
|
1310
|
+
*/
|
|
1311
|
+
'discountPrice'?: Price;
|
|
1312
|
+
}
|
|
1313
|
+
/**
|
|
1314
|
+
*
|
|
1315
|
+
* @export
|
|
1316
|
+
* @interface StatusHistoryItem
|
|
1317
|
+
*/
|
|
1318
|
+
export interface StatusHistoryItem {
|
|
1319
|
+
/**
|
|
1320
|
+
*
|
|
1321
|
+
* @type {OrderStatus}
|
|
1322
|
+
* @memberof StatusHistoryItem
|
|
1323
|
+
*/
|
|
1324
|
+
'status'?: OrderStatus;
|
|
1325
|
+
/**
|
|
1326
|
+
* ISO 8601 Timestamp
|
|
1327
|
+
* @type {string}
|
|
1328
|
+
* @memberof StatusHistoryItem
|
|
1329
|
+
*/
|
|
1330
|
+
'createdAt'?: string;
|
|
1331
|
+
}
|
|
1332
|
+
/**
|
|
1333
|
+
*
|
|
1334
|
+
* @export
|
|
1335
|
+
* @interface UpdateFulfillmentRequest
|
|
1336
|
+
*/
|
|
1337
|
+
export interface UpdateFulfillmentRequest {
|
|
1338
|
+
/**
|
|
1339
|
+
* Unique object identifier
|
|
1340
|
+
* @type {string}
|
|
1341
|
+
* @memberof UpdateFulfillmentRequest
|
|
1342
|
+
*/
|
|
1343
|
+
'fulfillerId'?: string;
|
|
755
1344
|
}
|
|
756
1345
|
/**
|
|
757
1346
|
*
|
|
@@ -778,6 +1367,57 @@ export interface UpdatePlatformRequest {
|
|
|
778
1367
|
*/
|
|
779
1368
|
'clientGiftWrapAvailable'?: boolean;
|
|
780
1369
|
}
|
|
1370
|
+
/**
|
|
1371
|
+
*
|
|
1372
|
+
* @export
|
|
1373
|
+
* @interface UpdateProductRequest
|
|
1374
|
+
*/
|
|
1375
|
+
export interface UpdateProductRequest {
|
|
1376
|
+
/**
|
|
1377
|
+
* The warehouse variants of the product to update
|
|
1378
|
+
* @type {Array<UpdateProductRequestVariantsInner>}
|
|
1379
|
+
* @memberof UpdateProductRequest
|
|
1380
|
+
*/
|
|
1381
|
+
'variants'?: Array<UpdateProductRequestVariantsInner>;
|
|
1382
|
+
/**
|
|
1383
|
+
* Whether the platform warehouse product should be enabled or not
|
|
1384
|
+
* @type {boolean}
|
|
1385
|
+
* @memberof UpdateProductRequest
|
|
1386
|
+
*/
|
|
1387
|
+
'enabled'?: boolean;
|
|
1388
|
+
}
|
|
1389
|
+
/**
|
|
1390
|
+
*
|
|
1391
|
+
* @export
|
|
1392
|
+
* @interface UpdateProductRequestVariantsInner
|
|
1393
|
+
*/
|
|
1394
|
+
export interface UpdateProductRequestVariantsInner {
|
|
1395
|
+
/**
|
|
1396
|
+
* The ID of the variant to update
|
|
1397
|
+
* @type {string}
|
|
1398
|
+
* @memberof UpdateProductRequestVariantsInner
|
|
1399
|
+
*/
|
|
1400
|
+
'id': string;
|
|
1401
|
+
/**
|
|
1402
|
+
* Whether the warehouse variant should be enabled or not
|
|
1403
|
+
* @type {boolean}
|
|
1404
|
+
* @memberof UpdateProductRequestVariantsInner
|
|
1405
|
+
*/
|
|
1406
|
+
'enabled'?: boolean;
|
|
1407
|
+
}
|
|
1408
|
+
/**
|
|
1409
|
+
*
|
|
1410
|
+
* @export
|
|
1411
|
+
* @interface UpdateVariantRequest
|
|
1412
|
+
*/
|
|
1413
|
+
export interface UpdateVariantRequest {
|
|
1414
|
+
/**
|
|
1415
|
+
* Whether the platform warehouse variant is enabled or not
|
|
1416
|
+
* @type {boolean}
|
|
1417
|
+
* @memberof UpdateVariantRequest
|
|
1418
|
+
*/
|
|
1419
|
+
'enabled'?: boolean;
|
|
1420
|
+
}
|
|
781
1421
|
/**
|
|
782
1422
|
*
|
|
783
1423
|
* @export
|
|
@@ -799,6 +1439,399 @@ export interface ValidationError {
|
|
|
799
1439
|
[key: string]: Array<string>;
|
|
800
1440
|
};
|
|
801
1441
|
}
|
|
1442
|
+
/**
|
|
1443
|
+
*
|
|
1444
|
+
* @export
|
|
1445
|
+
* @interface Variant
|
|
1446
|
+
*/
|
|
1447
|
+
export interface Variant {
|
|
1448
|
+
/**
|
|
1449
|
+
* Unique object identifier
|
|
1450
|
+
* @type {string}
|
|
1451
|
+
* @memberof Variant
|
|
1452
|
+
*/
|
|
1453
|
+
'id': string;
|
|
1454
|
+
/**
|
|
1455
|
+
* A reference to the resource location
|
|
1456
|
+
* @type {string}
|
|
1457
|
+
* @memberof Variant
|
|
1458
|
+
*/
|
|
1459
|
+
'ref': string;
|
|
1460
|
+
/**
|
|
1461
|
+
*
|
|
1462
|
+
* @type {ProductVariantsInner}
|
|
1463
|
+
* @memberof Variant
|
|
1464
|
+
*/
|
|
1465
|
+
'product'?: ProductVariantsInner;
|
|
1466
|
+
/**
|
|
1467
|
+
*
|
|
1468
|
+
* @type {string}
|
|
1469
|
+
* @memberof Variant
|
|
1470
|
+
*/
|
|
1471
|
+
'sku': string;
|
|
1472
|
+
/**
|
|
1473
|
+
* ISO 8601 Timestamp
|
|
1474
|
+
* @type {string}
|
|
1475
|
+
* @memberof Variant
|
|
1476
|
+
*/
|
|
1477
|
+
'createdAt'?: string;
|
|
1478
|
+
/**
|
|
1479
|
+
* ISO 8601 Timestamp
|
|
1480
|
+
* @type {string}
|
|
1481
|
+
* @memberof Variant
|
|
1482
|
+
*/
|
|
1483
|
+
'updatedAt'?: string;
|
|
1484
|
+
/**
|
|
1485
|
+
* Images
|
|
1486
|
+
* @type {Array<Image>}
|
|
1487
|
+
* @memberof Variant
|
|
1488
|
+
*/
|
|
1489
|
+
'images'?: Array<Image>;
|
|
1490
|
+
/**
|
|
1491
|
+
* Weight in kg
|
|
1492
|
+
* @type {number}
|
|
1493
|
+
* @memberof Variant
|
|
1494
|
+
*/
|
|
1495
|
+
'weight'?: number;
|
|
1496
|
+
/**
|
|
1497
|
+
* The number of units that can be packed in a single pickface
|
|
1498
|
+
* @type {number}
|
|
1499
|
+
* @memberof Variant
|
|
1500
|
+
*/
|
|
1501
|
+
'packVolume'?: number;
|
|
1502
|
+
/**
|
|
1503
|
+
*
|
|
1504
|
+
* @type {VariantPackedDimensions}
|
|
1505
|
+
* @memberof Variant
|
|
1506
|
+
*/
|
|
1507
|
+
'packedDimensions'?: VariantPackedDimensions;
|
|
1508
|
+
/**
|
|
1509
|
+
* Whether the variant can be pre-ordered
|
|
1510
|
+
* @type {boolean}
|
|
1511
|
+
* @memberof Variant
|
|
1512
|
+
*/
|
|
1513
|
+
'preOrderable'?: boolean;
|
|
1514
|
+
/**
|
|
1515
|
+
* Whether the variant is enabled
|
|
1516
|
+
* @type {boolean}
|
|
1517
|
+
* @memberof Variant
|
|
1518
|
+
*/
|
|
1519
|
+
'enabled'?: boolean;
|
|
1520
|
+
/**
|
|
1521
|
+
* Whether the variant is discontinued
|
|
1522
|
+
* @type {boolean}
|
|
1523
|
+
* @memberof Variant
|
|
1524
|
+
*/
|
|
1525
|
+
'discontinued'?: boolean;
|
|
1526
|
+
/**
|
|
1527
|
+
*
|
|
1528
|
+
* @type {VariantManufacturerOrigin}
|
|
1529
|
+
* @memberof Variant
|
|
1530
|
+
*/
|
|
1531
|
+
'manufacturerOrigin'?: VariantManufacturerOrigin;
|
|
1532
|
+
/**
|
|
1533
|
+
* Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours.
|
|
1534
|
+
* @type {Array<VariantAttribute>}
|
|
1535
|
+
* @memberof Variant
|
|
1536
|
+
*/
|
|
1537
|
+
'attributes': Array<VariantAttribute>;
|
|
1538
|
+
/**
|
|
1539
|
+
* Applications of the variant
|
|
1540
|
+
* @type {Array<Application>}
|
|
1541
|
+
* @memberof Variant
|
|
1542
|
+
*/
|
|
1543
|
+
'applications'?: Array<Application>;
|
|
1544
|
+
}
|
|
1545
|
+
/**
|
|
1546
|
+
*
|
|
1547
|
+
* @export
|
|
1548
|
+
* @interface VariantAttribute
|
|
1549
|
+
*/
|
|
1550
|
+
export interface VariantAttribute {
|
|
1551
|
+
/**
|
|
1552
|
+
* Attribute name
|
|
1553
|
+
* @type {string}
|
|
1554
|
+
* @memberof VariantAttribute
|
|
1555
|
+
*/
|
|
1556
|
+
'name': string;
|
|
1557
|
+
/**
|
|
1558
|
+
* Attribute value
|
|
1559
|
+
* @type {string}
|
|
1560
|
+
* @memberof VariantAttribute
|
|
1561
|
+
*/
|
|
1562
|
+
'value': string;
|
|
1563
|
+
/**
|
|
1564
|
+
*
|
|
1565
|
+
* @type {VariantAttributeThumbnail}
|
|
1566
|
+
* @memberof VariantAttribute
|
|
1567
|
+
*/
|
|
1568
|
+
'thumbnail'?: VariantAttributeThumbnail;
|
|
1569
|
+
/**
|
|
1570
|
+
* Attribute tags
|
|
1571
|
+
* @type {Array<string>}
|
|
1572
|
+
* @memberof VariantAttribute
|
|
1573
|
+
*/
|
|
1574
|
+
'tags'?: Array<string>;
|
|
1575
|
+
}
|
|
1576
|
+
/**
|
|
1577
|
+
* Attribute thumbnail
|
|
1578
|
+
* @export
|
|
1579
|
+
* @interface VariantAttributeThumbnail
|
|
1580
|
+
*/
|
|
1581
|
+
export interface VariantAttributeThumbnail {
|
|
1582
|
+
/**
|
|
1583
|
+
*
|
|
1584
|
+
* @type {string}
|
|
1585
|
+
* @memberof VariantAttributeThumbnail
|
|
1586
|
+
*/
|
|
1587
|
+
'type'?: VariantAttributeThumbnailTypeEnum;
|
|
1588
|
+
/**
|
|
1589
|
+
*
|
|
1590
|
+
* @type {string}
|
|
1591
|
+
* @memberof VariantAttributeThumbnail
|
|
1592
|
+
*/
|
|
1593
|
+
'value'?: string;
|
|
1594
|
+
}
|
|
1595
|
+
export declare const VariantAttributeThumbnailTypeEnum: {
|
|
1596
|
+
readonly Text: "text";
|
|
1597
|
+
readonly Color: "color";
|
|
1598
|
+
readonly Image: "image";
|
|
1599
|
+
};
|
|
1600
|
+
export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
|
|
1601
|
+
/**
|
|
1602
|
+
* Where the product was originally produced or manufactured
|
|
1603
|
+
* @export
|
|
1604
|
+
* @interface VariantManufacturerOrigin
|
|
1605
|
+
*/
|
|
1606
|
+
export interface VariantManufacturerOrigin {
|
|
1607
|
+
/**
|
|
1608
|
+
* Country of origin (ISO 3166-1 alpha-2).
|
|
1609
|
+
* @type {string}
|
|
1610
|
+
* @memberof VariantManufacturerOrigin
|
|
1611
|
+
*/
|
|
1612
|
+
'country'?: string;
|
|
1613
|
+
}
|
|
1614
|
+
/**
|
|
1615
|
+
*
|
|
1616
|
+
* @export
|
|
1617
|
+
* @interface VariantPackedDimensions
|
|
1618
|
+
*/
|
|
1619
|
+
export interface VariantPackedDimensions {
|
|
1620
|
+
/**
|
|
1621
|
+
* Length in mm
|
|
1622
|
+
* @type {number}
|
|
1623
|
+
* @memberof VariantPackedDimensions
|
|
1624
|
+
*/
|
|
1625
|
+
'length'?: number;
|
|
1626
|
+
/**
|
|
1627
|
+
* Width in mm
|
|
1628
|
+
* @type {number}
|
|
1629
|
+
* @memberof VariantPackedDimensions
|
|
1630
|
+
*/
|
|
1631
|
+
'width'?: number;
|
|
1632
|
+
/**
|
|
1633
|
+
* Depth in mm
|
|
1634
|
+
* @type {number}
|
|
1635
|
+
* @memberof VariantPackedDimensions
|
|
1636
|
+
*/
|
|
1637
|
+
'depth'?: number;
|
|
1638
|
+
}
|
|
1639
|
+
/**
|
|
1640
|
+
* CustomersApi - axios parameter creator
|
|
1641
|
+
* @export
|
|
1642
|
+
*/
|
|
1643
|
+
export declare const CustomersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1644
|
+
/**
|
|
1645
|
+
* Export customers as a CSV file
|
|
1646
|
+
* @summary Export customers
|
|
1647
|
+
* @param {string} project Project unique identifier
|
|
1648
|
+
* @param {string} platformId The platform identifier
|
|
1649
|
+
* @param {*} [options] Override http request option.
|
|
1650
|
+
* @throws {RequiredError}
|
|
1651
|
+
*/
|
|
1652
|
+
exportCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1653
|
+
/**
|
|
1654
|
+
* Get a customer for a platform by a given customer ID.
|
|
1655
|
+
* @summary Get customer
|
|
1656
|
+
* @param {string} project Project unique identifier
|
|
1657
|
+
* @param {string} platformId The platform identifier
|
|
1658
|
+
* @param {string} customerId The customer identifier
|
|
1659
|
+
* @param {*} [options] Override http request option.
|
|
1660
|
+
* @throws {RequiredError}
|
|
1661
|
+
*/
|
|
1662
|
+
getCustomer: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1663
|
+
/**
|
|
1664
|
+
* List customers for a platform
|
|
1665
|
+
* @summary List customers
|
|
1666
|
+
* @param {string} project Project unique identifier
|
|
1667
|
+
* @param {string} platformId The platform identifier
|
|
1668
|
+
* @param {*} [options] Override http request option.
|
|
1669
|
+
* @throws {RequiredError}
|
|
1670
|
+
*/
|
|
1671
|
+
listCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1672
|
+
};
|
|
1673
|
+
/**
|
|
1674
|
+
* CustomersApi - functional programming interface
|
|
1675
|
+
* @export
|
|
1676
|
+
*/
|
|
1677
|
+
export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
1678
|
+
/**
|
|
1679
|
+
* Export customers as a CSV file
|
|
1680
|
+
* @summary Export customers
|
|
1681
|
+
* @param {string} project Project unique identifier
|
|
1682
|
+
* @param {string} platformId The platform identifier
|
|
1683
|
+
* @param {*} [options] Override http request option.
|
|
1684
|
+
* @throws {RequiredError}
|
|
1685
|
+
*/
|
|
1686
|
+
exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1687
|
+
/**
|
|
1688
|
+
* Get a customer for a platform by a given customer ID.
|
|
1689
|
+
* @summary Get customer
|
|
1690
|
+
* @param {string} project Project unique identifier
|
|
1691
|
+
* @param {string} platformId The platform identifier
|
|
1692
|
+
* @param {string} customerId The customer identifier
|
|
1693
|
+
* @param {*} [options] Override http request option.
|
|
1694
|
+
* @throws {RequiredError}
|
|
1695
|
+
*/
|
|
1696
|
+
getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
|
|
1697
|
+
/**
|
|
1698
|
+
* List customers for a platform
|
|
1699
|
+
* @summary List customers
|
|
1700
|
+
* @param {string} project Project unique identifier
|
|
1701
|
+
* @param {string} platformId The platform identifier
|
|
1702
|
+
* @param {*} [options] Override http request option.
|
|
1703
|
+
* @throws {RequiredError}
|
|
1704
|
+
*/
|
|
1705
|
+
listCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
|
|
1706
|
+
};
|
|
1707
|
+
/**
|
|
1708
|
+
* CustomersApi - factory interface
|
|
1709
|
+
* @export
|
|
1710
|
+
*/
|
|
1711
|
+
export declare const CustomersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1712
|
+
/**
|
|
1713
|
+
* Export customers as a CSV file
|
|
1714
|
+
* @summary Export customers
|
|
1715
|
+
* @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
|
|
1716
|
+
* @param {*} [options] Override http request option.
|
|
1717
|
+
* @throws {RequiredError}
|
|
1718
|
+
*/
|
|
1719
|
+
exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
1720
|
+
/**
|
|
1721
|
+
* Get a customer for a platform by a given customer ID.
|
|
1722
|
+
* @summary Get customer
|
|
1723
|
+
* @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
|
|
1724
|
+
* @param {*} [options] Override http request option.
|
|
1725
|
+
* @throws {RequiredError}
|
|
1726
|
+
*/
|
|
1727
|
+
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
|
|
1728
|
+
/**
|
|
1729
|
+
* List customers for a platform
|
|
1730
|
+
* @summary List customers
|
|
1731
|
+
* @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
|
|
1732
|
+
* @param {*} [options] Override http request option.
|
|
1733
|
+
* @throws {RequiredError}
|
|
1734
|
+
*/
|
|
1735
|
+
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
|
|
1736
|
+
};
|
|
1737
|
+
/**
|
|
1738
|
+
* Request parameters for exportCustomers operation in CustomersApi.
|
|
1739
|
+
* @export
|
|
1740
|
+
* @interface CustomersApiExportCustomersRequest
|
|
1741
|
+
*/
|
|
1742
|
+
export interface CustomersApiExportCustomersRequest {
|
|
1743
|
+
/**
|
|
1744
|
+
* Project unique identifier
|
|
1745
|
+
* @type {string}
|
|
1746
|
+
* @memberof CustomersApiExportCustomers
|
|
1747
|
+
*/
|
|
1748
|
+
readonly project: string;
|
|
1749
|
+
/**
|
|
1750
|
+
* The platform identifier
|
|
1751
|
+
* @type {string}
|
|
1752
|
+
* @memberof CustomersApiExportCustomers
|
|
1753
|
+
*/
|
|
1754
|
+
readonly platformId: string;
|
|
1755
|
+
}
|
|
1756
|
+
/**
|
|
1757
|
+
* Request parameters for getCustomer operation in CustomersApi.
|
|
1758
|
+
* @export
|
|
1759
|
+
* @interface CustomersApiGetCustomerRequest
|
|
1760
|
+
*/
|
|
1761
|
+
export interface CustomersApiGetCustomerRequest {
|
|
1762
|
+
/**
|
|
1763
|
+
* Project unique identifier
|
|
1764
|
+
* @type {string}
|
|
1765
|
+
* @memberof CustomersApiGetCustomer
|
|
1766
|
+
*/
|
|
1767
|
+
readonly project: string;
|
|
1768
|
+
/**
|
|
1769
|
+
* The platform identifier
|
|
1770
|
+
* @type {string}
|
|
1771
|
+
* @memberof CustomersApiGetCustomer
|
|
1772
|
+
*/
|
|
1773
|
+
readonly platformId: string;
|
|
1774
|
+
/**
|
|
1775
|
+
* The customer identifier
|
|
1776
|
+
* @type {string}
|
|
1777
|
+
* @memberof CustomersApiGetCustomer
|
|
1778
|
+
*/
|
|
1779
|
+
readonly customerId: string;
|
|
1780
|
+
}
|
|
1781
|
+
/**
|
|
1782
|
+
* Request parameters for listCustomers operation in CustomersApi.
|
|
1783
|
+
* @export
|
|
1784
|
+
* @interface CustomersApiListCustomersRequest
|
|
1785
|
+
*/
|
|
1786
|
+
export interface CustomersApiListCustomersRequest {
|
|
1787
|
+
/**
|
|
1788
|
+
* Project unique identifier
|
|
1789
|
+
* @type {string}
|
|
1790
|
+
* @memberof CustomersApiListCustomers
|
|
1791
|
+
*/
|
|
1792
|
+
readonly project: string;
|
|
1793
|
+
/**
|
|
1794
|
+
* The platform identifier
|
|
1795
|
+
* @type {string}
|
|
1796
|
+
* @memberof CustomersApiListCustomers
|
|
1797
|
+
*/
|
|
1798
|
+
readonly platformId: string;
|
|
1799
|
+
}
|
|
1800
|
+
/**
|
|
1801
|
+
* CustomersApi - object-oriented interface
|
|
1802
|
+
* @export
|
|
1803
|
+
* @class CustomersApi
|
|
1804
|
+
* @extends {BaseAPI}
|
|
1805
|
+
*/
|
|
1806
|
+
export declare class CustomersApi extends BaseAPI {
|
|
1807
|
+
/**
|
|
1808
|
+
* Export customers as a CSV file
|
|
1809
|
+
* @summary Export customers
|
|
1810
|
+
* @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
|
|
1811
|
+
* @param {*} [options] Override http request option.
|
|
1812
|
+
* @throws {RequiredError}
|
|
1813
|
+
* @memberof CustomersApi
|
|
1814
|
+
*/
|
|
1815
|
+
exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
1816
|
+
/**
|
|
1817
|
+
* Get a customer for a platform by a given customer ID.
|
|
1818
|
+
* @summary Get customer
|
|
1819
|
+
* @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
|
|
1820
|
+
* @param {*} [options] Override http request option.
|
|
1821
|
+
* @throws {RequiredError}
|
|
1822
|
+
* @memberof CustomersApi
|
|
1823
|
+
*/
|
|
1824
|
+
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any>>;
|
|
1825
|
+
/**
|
|
1826
|
+
* List customers for a platform
|
|
1827
|
+
* @summary List customers
|
|
1828
|
+
* @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
|
|
1829
|
+
* @param {*} [options] Override http request option.
|
|
1830
|
+
* @throws {RequiredError}
|
|
1831
|
+
* @memberof CustomersApi
|
|
1832
|
+
*/
|
|
1833
|
+
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
|
|
1834
|
+
}
|
|
802
1835
|
/**
|
|
803
1836
|
* OrdersApi - axios parameter creator
|
|
804
1837
|
* @export
|
|
@@ -1258,6 +2291,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
1258
2291
|
* @export
|
|
1259
2292
|
*/
|
|
1260
2293
|
export declare const PlatformApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2294
|
+
/**
|
|
2295
|
+
* Export customers as a CSV file
|
|
2296
|
+
* @summary Export customers
|
|
2297
|
+
* @param {string} project Project unique identifier
|
|
2298
|
+
* @param {string} platformId The platform identifier
|
|
2299
|
+
* @param {*} [options] Override http request option.
|
|
2300
|
+
* @throws {RequiredError}
|
|
2301
|
+
*/
|
|
2302
|
+
exportCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1261
2303
|
/**
|
|
1262
2304
|
* Export orders as a CSV file
|
|
1263
2305
|
* @summary Export orders
|
|
@@ -1270,6 +2312,16 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1270
2312
|
* @throws {RequiredError}
|
|
1271
2313
|
*/
|
|
1272
2314
|
exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2315
|
+
/**
|
|
2316
|
+
* Get a customer for a platform by a given customer ID.
|
|
2317
|
+
* @summary Get customer
|
|
2318
|
+
* @param {string} project Project unique identifier
|
|
2319
|
+
* @param {string} platformId The platform identifier
|
|
2320
|
+
* @param {string} customerId The customer identifier
|
|
2321
|
+
* @param {*} [options] Override http request option.
|
|
2322
|
+
* @throws {RequiredError}
|
|
2323
|
+
*/
|
|
2324
|
+
getCustomer: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1273
2325
|
/**
|
|
1274
2326
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1275
2327
|
* @summary Get fulfillment
|
|
@@ -1308,6 +2360,15 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1308
2360
|
* @throws {RequiredError}
|
|
1309
2361
|
*/
|
|
1310
2362
|
listAvailableFulfillers: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2363
|
+
/**
|
|
2364
|
+
* List customers for a platform
|
|
2365
|
+
* @summary List customers
|
|
2366
|
+
* @param {string} project Project unique identifier
|
|
2367
|
+
* @param {string} platformId The platform identifier
|
|
2368
|
+
* @param {*} [options] Override http request option.
|
|
2369
|
+
* @throws {RequiredError}
|
|
2370
|
+
*/
|
|
2371
|
+
listCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1311
2372
|
/**
|
|
1312
2373
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1313
2374
|
* @summary List orders
|
|
@@ -1342,12 +2403,43 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1342
2403
|
* @throws {RequiredError}
|
|
1343
2404
|
*/
|
|
1344
2405
|
updatePlatform: (project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2406
|
+
/**
|
|
2407
|
+
* Updates the warehouse product and its variants
|
|
2408
|
+
* @summary Update warehouse product
|
|
2409
|
+
* @param {string} project Project unique identifier
|
|
2410
|
+
* @param {string} platformId The platform identifier
|
|
2411
|
+
* @param {string} productId Products unique identifier
|
|
2412
|
+
* @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
|
|
2413
|
+
* @param {*} [options] Override http request option.
|
|
2414
|
+
* @throws {RequiredError}
|
|
2415
|
+
*/
|
|
2416
|
+
updateProduct: (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2417
|
+
/**
|
|
2418
|
+
* Updates the warehouse variant
|
|
2419
|
+
* @summary Update warehouse variant
|
|
2420
|
+
* @param {string} project Project unique identifier
|
|
2421
|
+
* @param {string} platformId The platform identifier
|
|
2422
|
+
* @param {string} variantId Variants unique identifier
|
|
2423
|
+
* @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
|
|
2424
|
+
* @param {*} [options] Override http request option.
|
|
2425
|
+
* @throws {RequiredError}
|
|
2426
|
+
*/
|
|
2427
|
+
updateVariant: (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1345
2428
|
};
|
|
1346
2429
|
/**
|
|
1347
2430
|
* PlatformApi - functional programming interface
|
|
1348
2431
|
* @export
|
|
1349
2432
|
*/
|
|
1350
2433
|
export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
2434
|
+
/**
|
|
2435
|
+
* Export customers as a CSV file
|
|
2436
|
+
* @summary Export customers
|
|
2437
|
+
* @param {string} project Project unique identifier
|
|
2438
|
+
* @param {string} platformId The platform identifier
|
|
2439
|
+
* @param {*} [options] Override http request option.
|
|
2440
|
+
* @throws {RequiredError}
|
|
2441
|
+
*/
|
|
2442
|
+
exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1351
2443
|
/**
|
|
1352
2444
|
* Export orders as a CSV file
|
|
1353
2445
|
* @summary Export orders
|
|
@@ -1360,6 +2452,16 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
1360
2452
|
* @throws {RequiredError}
|
|
1361
2453
|
*/
|
|
1362
2454
|
exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2455
|
+
/**
|
|
2456
|
+
* Get a customer for a platform by a given customer ID.
|
|
2457
|
+
* @summary Get customer
|
|
2458
|
+
* @param {string} project Project unique identifier
|
|
2459
|
+
* @param {string} platformId The platform identifier
|
|
2460
|
+
* @param {string} customerId The customer identifier
|
|
2461
|
+
* @param {*} [options] Override http request option.
|
|
2462
|
+
* @throws {RequiredError}
|
|
2463
|
+
*/
|
|
2464
|
+
getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
|
|
1363
2465
|
/**
|
|
1364
2466
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1365
2467
|
* @summary Get fulfillment
|
|
@@ -1389,15 +2491,24 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
1389
2491
|
*/
|
|
1390
2492
|
getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
|
|
1391
2493
|
/**
|
|
1392
|
-
* List available fulfillers for a given fulfillment
|
|
1393
|
-
* @summary List available fulfillers
|
|
2494
|
+
* List available fulfillers for a given fulfillment
|
|
2495
|
+
* @summary List available fulfillers
|
|
2496
|
+
* @param {string} project Project unique identifier
|
|
2497
|
+
* @param {string} platformId The platform identifier
|
|
2498
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
2499
|
+
* @param {*} [options] Override http request option.
|
|
2500
|
+
* @throws {RequiredError}
|
|
2501
|
+
*/
|
|
2502
|
+
listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>>;
|
|
2503
|
+
/**
|
|
2504
|
+
* List customers for a platform
|
|
2505
|
+
* @summary List customers
|
|
1394
2506
|
* @param {string} project Project unique identifier
|
|
1395
2507
|
* @param {string} platformId The platform identifier
|
|
1396
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
1397
2508
|
* @param {*} [options] Override http request option.
|
|
1398
2509
|
* @throws {RequiredError}
|
|
1399
2510
|
*/
|
|
1400
|
-
|
|
2511
|
+
listCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
|
|
1401
2512
|
/**
|
|
1402
2513
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1403
2514
|
* @summary List orders
|
|
@@ -1432,12 +2543,42 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
1432
2543
|
* @throws {RequiredError}
|
|
1433
2544
|
*/
|
|
1434
2545
|
updatePlatform(project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
|
|
2546
|
+
/**
|
|
2547
|
+
* Updates the warehouse product and its variants
|
|
2548
|
+
* @summary Update warehouse product
|
|
2549
|
+
* @param {string} project Project unique identifier
|
|
2550
|
+
* @param {string} platformId The platform identifier
|
|
2551
|
+
* @param {string} productId Products unique identifier
|
|
2552
|
+
* @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
|
|
2553
|
+
* @param {*} [options] Override http request option.
|
|
2554
|
+
* @throws {RequiredError}
|
|
2555
|
+
*/
|
|
2556
|
+
updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
|
|
2557
|
+
/**
|
|
2558
|
+
* Updates the warehouse variant
|
|
2559
|
+
* @summary Update warehouse variant
|
|
2560
|
+
* @param {string} project Project unique identifier
|
|
2561
|
+
* @param {string} platformId The platform identifier
|
|
2562
|
+
* @param {string} variantId Variants unique identifier
|
|
2563
|
+
* @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
|
|
2564
|
+
* @param {*} [options] Override http request option.
|
|
2565
|
+
* @throws {RequiredError}
|
|
2566
|
+
*/
|
|
2567
|
+
updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>>;
|
|
1435
2568
|
};
|
|
1436
2569
|
/**
|
|
1437
2570
|
* PlatformApi - factory interface
|
|
1438
2571
|
* @export
|
|
1439
2572
|
*/
|
|
1440
2573
|
export declare const PlatformApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2574
|
+
/**
|
|
2575
|
+
* Export customers as a CSV file
|
|
2576
|
+
* @summary Export customers
|
|
2577
|
+
* @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
|
|
2578
|
+
* @param {*} [options] Override http request option.
|
|
2579
|
+
* @throws {RequiredError}
|
|
2580
|
+
*/
|
|
2581
|
+
exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
1441
2582
|
/**
|
|
1442
2583
|
* Export orders as a CSV file
|
|
1443
2584
|
* @summary Export orders
|
|
@@ -1446,6 +2587,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
1446
2587
|
* @throws {RequiredError}
|
|
1447
2588
|
*/
|
|
1448
2589
|
exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
2590
|
+
/**
|
|
2591
|
+
* Get a customer for a platform by a given customer ID.
|
|
2592
|
+
* @summary Get customer
|
|
2593
|
+
* @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
|
|
2594
|
+
* @param {*} [options] Override http request option.
|
|
2595
|
+
* @throws {RequiredError}
|
|
2596
|
+
*/
|
|
2597
|
+
getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
|
|
1449
2598
|
/**
|
|
1450
2599
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1451
2600
|
* @summary Get fulfillment
|
|
@@ -1478,6 +2627,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
1478
2627
|
* @throws {RequiredError}
|
|
1479
2628
|
*/
|
|
1480
2629
|
listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse>;
|
|
2630
|
+
/**
|
|
2631
|
+
* List customers for a platform
|
|
2632
|
+
* @summary List customers
|
|
2633
|
+
* @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
|
|
2634
|
+
* @param {*} [options] Override http request option.
|
|
2635
|
+
* @throws {RequiredError}
|
|
2636
|
+
*/
|
|
2637
|
+
listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
|
|
1481
2638
|
/**
|
|
1482
2639
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1483
2640
|
* @summary List orders
|
|
@@ -1502,7 +2659,42 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
1502
2659
|
* @throws {RequiredError}
|
|
1503
2660
|
*/
|
|
1504
2661
|
updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
|
|
2662
|
+
/**
|
|
2663
|
+
* Updates the warehouse product and its variants
|
|
2664
|
+
* @summary Update warehouse product
|
|
2665
|
+
* @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
|
|
2666
|
+
* @param {*} [options] Override http request option.
|
|
2667
|
+
* @throws {RequiredError}
|
|
2668
|
+
*/
|
|
2669
|
+
updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
2670
|
+
/**
|
|
2671
|
+
* Updates the warehouse variant
|
|
2672
|
+
* @summary Update warehouse variant
|
|
2673
|
+
* @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
|
|
2674
|
+
* @param {*} [options] Override http request option.
|
|
2675
|
+
* @throws {RequiredError}
|
|
2676
|
+
*/
|
|
2677
|
+
updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
|
|
1505
2678
|
};
|
|
2679
|
+
/**
|
|
2680
|
+
* Request parameters for exportCustomers operation in PlatformApi.
|
|
2681
|
+
* @export
|
|
2682
|
+
* @interface PlatformApiExportCustomersRequest
|
|
2683
|
+
*/
|
|
2684
|
+
export interface PlatformApiExportCustomersRequest {
|
|
2685
|
+
/**
|
|
2686
|
+
* Project unique identifier
|
|
2687
|
+
* @type {string}
|
|
2688
|
+
* @memberof PlatformApiExportCustomers
|
|
2689
|
+
*/
|
|
2690
|
+
readonly project: string;
|
|
2691
|
+
/**
|
|
2692
|
+
* The platform identifier
|
|
2693
|
+
* @type {string}
|
|
2694
|
+
* @memberof PlatformApiExportCustomers
|
|
2695
|
+
*/
|
|
2696
|
+
readonly platformId: string;
|
|
2697
|
+
}
|
|
1506
2698
|
/**
|
|
1507
2699
|
* Request parameters for exportOrders operation in PlatformApi.
|
|
1508
2700
|
* @export
|
|
@@ -1540,6 +2732,31 @@ export interface PlatformApiExportOrdersRequest {
|
|
|
1540
2732
|
*/
|
|
1541
2733
|
readonly search?: string;
|
|
1542
2734
|
}
|
|
2735
|
+
/**
|
|
2736
|
+
* Request parameters for getCustomer operation in PlatformApi.
|
|
2737
|
+
* @export
|
|
2738
|
+
* @interface PlatformApiGetCustomerRequest
|
|
2739
|
+
*/
|
|
2740
|
+
export interface PlatformApiGetCustomerRequest {
|
|
2741
|
+
/**
|
|
2742
|
+
* Project unique identifier
|
|
2743
|
+
* @type {string}
|
|
2744
|
+
* @memberof PlatformApiGetCustomer
|
|
2745
|
+
*/
|
|
2746
|
+
readonly project: string;
|
|
2747
|
+
/**
|
|
2748
|
+
* The platform identifier
|
|
2749
|
+
* @type {string}
|
|
2750
|
+
* @memberof PlatformApiGetCustomer
|
|
2751
|
+
*/
|
|
2752
|
+
readonly platformId: string;
|
|
2753
|
+
/**
|
|
2754
|
+
* The customer identifier
|
|
2755
|
+
* @type {string}
|
|
2756
|
+
* @memberof PlatformApiGetCustomer
|
|
2757
|
+
*/
|
|
2758
|
+
readonly customerId: string;
|
|
2759
|
+
}
|
|
1543
2760
|
/**
|
|
1544
2761
|
* Request parameters for getFulfillment operation in PlatformApi.
|
|
1545
2762
|
* @export
|
|
@@ -1628,6 +2845,25 @@ export interface PlatformApiListAvailableFulfillersRequest {
|
|
|
1628
2845
|
*/
|
|
1629
2846
|
readonly fulfillmentId: string;
|
|
1630
2847
|
}
|
|
2848
|
+
/**
|
|
2849
|
+
* Request parameters for listCustomers operation in PlatformApi.
|
|
2850
|
+
* @export
|
|
2851
|
+
* @interface PlatformApiListCustomersRequest
|
|
2852
|
+
*/
|
|
2853
|
+
export interface PlatformApiListCustomersRequest {
|
|
2854
|
+
/**
|
|
2855
|
+
* Project unique identifier
|
|
2856
|
+
* @type {string}
|
|
2857
|
+
* @memberof PlatformApiListCustomers
|
|
2858
|
+
*/
|
|
2859
|
+
readonly project: string;
|
|
2860
|
+
/**
|
|
2861
|
+
* The platform identifier
|
|
2862
|
+
* @type {string}
|
|
2863
|
+
* @memberof PlatformApiListCustomers
|
|
2864
|
+
*/
|
|
2865
|
+
readonly platformId: string;
|
|
2866
|
+
}
|
|
1631
2867
|
/**
|
|
1632
2868
|
* Request parameters for listOrders operation in PlatformApi.
|
|
1633
2869
|
* @export
|
|
@@ -1727,6 +2963,68 @@ export interface PlatformApiUpdatePlatformRequest {
|
|
|
1727
2963
|
*/
|
|
1728
2964
|
readonly updatePlatformRequest: UpdatePlatformRequest;
|
|
1729
2965
|
}
|
|
2966
|
+
/**
|
|
2967
|
+
* Request parameters for updateProduct operation in PlatformApi.
|
|
2968
|
+
* @export
|
|
2969
|
+
* @interface PlatformApiUpdateProductRequest
|
|
2970
|
+
*/
|
|
2971
|
+
export interface PlatformApiUpdateProductRequest {
|
|
2972
|
+
/**
|
|
2973
|
+
* Project unique identifier
|
|
2974
|
+
* @type {string}
|
|
2975
|
+
* @memberof PlatformApiUpdateProduct
|
|
2976
|
+
*/
|
|
2977
|
+
readonly project: string;
|
|
2978
|
+
/**
|
|
2979
|
+
* The platform identifier
|
|
2980
|
+
* @type {string}
|
|
2981
|
+
* @memberof PlatformApiUpdateProduct
|
|
2982
|
+
*/
|
|
2983
|
+
readonly platformId: string;
|
|
2984
|
+
/**
|
|
2985
|
+
* Products unique identifier
|
|
2986
|
+
* @type {string}
|
|
2987
|
+
* @memberof PlatformApiUpdateProduct
|
|
2988
|
+
*/
|
|
2989
|
+
readonly productId: string;
|
|
2990
|
+
/**
|
|
2991
|
+
* Update a platform warehouse product
|
|
2992
|
+
* @type {UpdateProductRequest}
|
|
2993
|
+
* @memberof PlatformApiUpdateProduct
|
|
2994
|
+
*/
|
|
2995
|
+
readonly updateProductRequest: UpdateProductRequest;
|
|
2996
|
+
}
|
|
2997
|
+
/**
|
|
2998
|
+
* Request parameters for updateVariant operation in PlatformApi.
|
|
2999
|
+
* @export
|
|
3000
|
+
* @interface PlatformApiUpdateVariantRequest
|
|
3001
|
+
*/
|
|
3002
|
+
export interface PlatformApiUpdateVariantRequest {
|
|
3003
|
+
/**
|
|
3004
|
+
* Project unique identifier
|
|
3005
|
+
* @type {string}
|
|
3006
|
+
* @memberof PlatformApiUpdateVariant
|
|
3007
|
+
*/
|
|
3008
|
+
readonly project: string;
|
|
3009
|
+
/**
|
|
3010
|
+
* The platform identifier
|
|
3011
|
+
* @type {string}
|
|
3012
|
+
* @memberof PlatformApiUpdateVariant
|
|
3013
|
+
*/
|
|
3014
|
+
readonly platformId: string;
|
|
3015
|
+
/**
|
|
3016
|
+
* Variants unique identifier
|
|
3017
|
+
* @type {string}
|
|
3018
|
+
* @memberof PlatformApiUpdateVariant
|
|
3019
|
+
*/
|
|
3020
|
+
readonly variantId: string;
|
|
3021
|
+
/**
|
|
3022
|
+
* Update a platform warehouse variant
|
|
3023
|
+
* @type {UpdateVariantRequest}
|
|
3024
|
+
* @memberof PlatformApiUpdateVariant
|
|
3025
|
+
*/
|
|
3026
|
+
readonly updateVariantRequest: UpdateVariantRequest;
|
|
3027
|
+
}
|
|
1730
3028
|
/**
|
|
1731
3029
|
* PlatformApi - object-oriented interface
|
|
1732
3030
|
* @export
|
|
@@ -1734,6 +3032,15 @@ export interface PlatformApiUpdatePlatformRequest {
|
|
|
1734
3032
|
* @extends {BaseAPI}
|
|
1735
3033
|
*/
|
|
1736
3034
|
export declare class PlatformApi extends BaseAPI {
|
|
3035
|
+
/**
|
|
3036
|
+
* Export customers as a CSV file
|
|
3037
|
+
* @summary Export customers
|
|
3038
|
+
* @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
|
|
3039
|
+
* @param {*} [options] Override http request option.
|
|
3040
|
+
* @throws {RequiredError}
|
|
3041
|
+
* @memberof PlatformApi
|
|
3042
|
+
*/
|
|
3043
|
+
exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
1737
3044
|
/**
|
|
1738
3045
|
* Export orders as a CSV file
|
|
1739
3046
|
* @summary Export orders
|
|
@@ -1743,6 +3050,15 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
1743
3050
|
* @memberof PlatformApi
|
|
1744
3051
|
*/
|
|
1745
3052
|
exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
3053
|
+
/**
|
|
3054
|
+
* Get a customer for a platform by a given customer ID.
|
|
3055
|
+
* @summary Get customer
|
|
3056
|
+
* @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
|
|
3057
|
+
* @param {*} [options] Override http request option.
|
|
3058
|
+
* @throws {RequiredError}
|
|
3059
|
+
* @memberof PlatformApi
|
|
3060
|
+
*/
|
|
3061
|
+
getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any>>;
|
|
1746
3062
|
/**
|
|
1747
3063
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1748
3064
|
* @summary Get fulfillment
|
|
@@ -1779,6 +3095,15 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
1779
3095
|
* @memberof PlatformApi
|
|
1780
3096
|
*/
|
|
1781
3097
|
listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillersResponse, any>>;
|
|
3098
|
+
/**
|
|
3099
|
+
* List customers for a platform
|
|
3100
|
+
* @summary List customers
|
|
3101
|
+
* @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
|
|
3102
|
+
* @param {*} [options] Override http request option.
|
|
3103
|
+
* @throws {RequiredError}
|
|
3104
|
+
* @memberof PlatformApi
|
|
3105
|
+
*/
|
|
3106
|
+
listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
|
|
1782
3107
|
/**
|
|
1783
3108
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1784
3109
|
* @summary List orders
|
|
@@ -1806,4 +3131,214 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
1806
3131
|
* @memberof PlatformApi
|
|
1807
3132
|
*/
|
|
1808
3133
|
updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
|
|
3134
|
+
/**
|
|
3135
|
+
* Updates the warehouse product and its variants
|
|
3136
|
+
* @summary Update warehouse product
|
|
3137
|
+
* @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
|
|
3138
|
+
* @param {*} [options] Override http request option.
|
|
3139
|
+
* @throws {RequiredError}
|
|
3140
|
+
* @memberof PlatformApi
|
|
3141
|
+
*/
|
|
3142
|
+
updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
3143
|
+
/**
|
|
3144
|
+
* Updates the warehouse variant
|
|
3145
|
+
* @summary Update warehouse variant
|
|
3146
|
+
* @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
|
|
3147
|
+
* @param {*} [options] Override http request option.
|
|
3148
|
+
* @throws {RequiredError}
|
|
3149
|
+
* @memberof PlatformApi
|
|
3150
|
+
*/
|
|
3151
|
+
updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
|
|
3152
|
+
}
|
|
3153
|
+
/**
|
|
3154
|
+
* ProductsApi - axios parameter creator
|
|
3155
|
+
* @export
|
|
3156
|
+
*/
|
|
3157
|
+
export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3158
|
+
/**
|
|
3159
|
+
* Updates the warehouse product and its variants
|
|
3160
|
+
* @summary Update warehouse product
|
|
3161
|
+
* @param {string} project Project unique identifier
|
|
3162
|
+
* @param {string} platformId The platform identifier
|
|
3163
|
+
* @param {string} productId Products unique identifier
|
|
3164
|
+
* @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
|
|
3165
|
+
* @param {*} [options] Override http request option.
|
|
3166
|
+
* @throws {RequiredError}
|
|
3167
|
+
*/
|
|
3168
|
+
updateProduct: (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3169
|
+
};
|
|
3170
|
+
/**
|
|
3171
|
+
* ProductsApi - functional programming interface
|
|
3172
|
+
* @export
|
|
3173
|
+
*/
|
|
3174
|
+
export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
3175
|
+
/**
|
|
3176
|
+
* Updates the warehouse product and its variants
|
|
3177
|
+
* @summary Update warehouse product
|
|
3178
|
+
* @param {string} project Project unique identifier
|
|
3179
|
+
* @param {string} platformId The platform identifier
|
|
3180
|
+
* @param {string} productId Products unique identifier
|
|
3181
|
+
* @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
|
|
3182
|
+
* @param {*} [options] Override http request option.
|
|
3183
|
+
* @throws {RequiredError}
|
|
3184
|
+
*/
|
|
3185
|
+
updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
|
|
3186
|
+
};
|
|
3187
|
+
/**
|
|
3188
|
+
* ProductsApi - factory interface
|
|
3189
|
+
* @export
|
|
3190
|
+
*/
|
|
3191
|
+
export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3192
|
+
/**
|
|
3193
|
+
* Updates the warehouse product and its variants
|
|
3194
|
+
* @summary Update warehouse product
|
|
3195
|
+
* @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
|
|
3196
|
+
* @param {*} [options] Override http request option.
|
|
3197
|
+
* @throws {RequiredError}
|
|
3198
|
+
*/
|
|
3199
|
+
updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
3200
|
+
};
|
|
3201
|
+
/**
|
|
3202
|
+
* Request parameters for updateProduct operation in ProductsApi.
|
|
3203
|
+
* @export
|
|
3204
|
+
* @interface ProductsApiUpdateProductRequest
|
|
3205
|
+
*/
|
|
3206
|
+
export interface ProductsApiUpdateProductRequest {
|
|
3207
|
+
/**
|
|
3208
|
+
* Project unique identifier
|
|
3209
|
+
* @type {string}
|
|
3210
|
+
* @memberof ProductsApiUpdateProduct
|
|
3211
|
+
*/
|
|
3212
|
+
readonly project: string;
|
|
3213
|
+
/**
|
|
3214
|
+
* The platform identifier
|
|
3215
|
+
* @type {string}
|
|
3216
|
+
* @memberof ProductsApiUpdateProduct
|
|
3217
|
+
*/
|
|
3218
|
+
readonly platformId: string;
|
|
3219
|
+
/**
|
|
3220
|
+
* Products unique identifier
|
|
3221
|
+
* @type {string}
|
|
3222
|
+
* @memberof ProductsApiUpdateProduct
|
|
3223
|
+
*/
|
|
3224
|
+
readonly productId: string;
|
|
3225
|
+
/**
|
|
3226
|
+
* Update a platform warehouse product
|
|
3227
|
+
* @type {UpdateProductRequest}
|
|
3228
|
+
* @memberof ProductsApiUpdateProduct
|
|
3229
|
+
*/
|
|
3230
|
+
readonly updateProductRequest: UpdateProductRequest;
|
|
3231
|
+
}
|
|
3232
|
+
/**
|
|
3233
|
+
* ProductsApi - object-oriented interface
|
|
3234
|
+
* @export
|
|
3235
|
+
* @class ProductsApi
|
|
3236
|
+
* @extends {BaseAPI}
|
|
3237
|
+
*/
|
|
3238
|
+
export declare class ProductsApi extends BaseAPI {
|
|
3239
|
+
/**
|
|
3240
|
+
* Updates the warehouse product and its variants
|
|
3241
|
+
* @summary Update warehouse product
|
|
3242
|
+
* @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
|
|
3243
|
+
* @param {*} [options] Override http request option.
|
|
3244
|
+
* @throws {RequiredError}
|
|
3245
|
+
* @memberof ProductsApi
|
|
3246
|
+
*/
|
|
3247
|
+
updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
3248
|
+
}
|
|
3249
|
+
/**
|
|
3250
|
+
* VariantsApi - axios parameter creator
|
|
3251
|
+
* @export
|
|
3252
|
+
*/
|
|
3253
|
+
export declare const VariantsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3254
|
+
/**
|
|
3255
|
+
* Updates the warehouse variant
|
|
3256
|
+
* @summary Update warehouse variant
|
|
3257
|
+
* @param {string} project Project unique identifier
|
|
3258
|
+
* @param {string} platformId The platform identifier
|
|
3259
|
+
* @param {string} variantId Variants unique identifier
|
|
3260
|
+
* @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
|
|
3261
|
+
* @param {*} [options] Override http request option.
|
|
3262
|
+
* @throws {RequiredError}
|
|
3263
|
+
*/
|
|
3264
|
+
updateVariant: (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3265
|
+
};
|
|
3266
|
+
/**
|
|
3267
|
+
* VariantsApi - functional programming interface
|
|
3268
|
+
* @export
|
|
3269
|
+
*/
|
|
3270
|
+
export declare const VariantsApiFp: (configuration?: Configuration) => {
|
|
3271
|
+
/**
|
|
3272
|
+
* Updates the warehouse variant
|
|
3273
|
+
* @summary Update warehouse variant
|
|
3274
|
+
* @param {string} project Project unique identifier
|
|
3275
|
+
* @param {string} platformId The platform identifier
|
|
3276
|
+
* @param {string} variantId Variants unique identifier
|
|
3277
|
+
* @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
|
|
3278
|
+
* @param {*} [options] Override http request option.
|
|
3279
|
+
* @throws {RequiredError}
|
|
3280
|
+
*/
|
|
3281
|
+
updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>>;
|
|
3282
|
+
};
|
|
3283
|
+
/**
|
|
3284
|
+
* VariantsApi - factory interface
|
|
3285
|
+
* @export
|
|
3286
|
+
*/
|
|
3287
|
+
export declare const VariantsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3288
|
+
/**
|
|
3289
|
+
* Updates the warehouse variant
|
|
3290
|
+
* @summary Update warehouse variant
|
|
3291
|
+
* @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
|
|
3292
|
+
* @param {*} [options] Override http request option.
|
|
3293
|
+
* @throws {RequiredError}
|
|
3294
|
+
*/
|
|
3295
|
+
updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
|
|
3296
|
+
};
|
|
3297
|
+
/**
|
|
3298
|
+
* Request parameters for updateVariant operation in VariantsApi.
|
|
3299
|
+
* @export
|
|
3300
|
+
* @interface VariantsApiUpdateVariantRequest
|
|
3301
|
+
*/
|
|
3302
|
+
export interface VariantsApiUpdateVariantRequest {
|
|
3303
|
+
/**
|
|
3304
|
+
* Project unique identifier
|
|
3305
|
+
* @type {string}
|
|
3306
|
+
* @memberof VariantsApiUpdateVariant
|
|
3307
|
+
*/
|
|
3308
|
+
readonly project: string;
|
|
3309
|
+
/**
|
|
3310
|
+
* The platform identifier
|
|
3311
|
+
* @type {string}
|
|
3312
|
+
* @memberof VariantsApiUpdateVariant
|
|
3313
|
+
*/
|
|
3314
|
+
readonly platformId: string;
|
|
3315
|
+
/**
|
|
3316
|
+
* Variants unique identifier
|
|
3317
|
+
* @type {string}
|
|
3318
|
+
* @memberof VariantsApiUpdateVariant
|
|
3319
|
+
*/
|
|
3320
|
+
readonly variantId: string;
|
|
3321
|
+
/**
|
|
3322
|
+
* Update a platform warehouse variant
|
|
3323
|
+
* @type {UpdateVariantRequest}
|
|
3324
|
+
* @memberof VariantsApiUpdateVariant
|
|
3325
|
+
*/
|
|
3326
|
+
readonly updateVariantRequest: UpdateVariantRequest;
|
|
3327
|
+
}
|
|
3328
|
+
/**
|
|
3329
|
+
* VariantsApi - object-oriented interface
|
|
3330
|
+
* @export
|
|
3331
|
+
* @class VariantsApi
|
|
3332
|
+
* @extends {BaseAPI}
|
|
3333
|
+
*/
|
|
3334
|
+
export declare class VariantsApi extends BaseAPI {
|
|
3335
|
+
/**
|
|
3336
|
+
* Updates the warehouse variant
|
|
3337
|
+
* @summary Update warehouse variant
|
|
3338
|
+
* @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
|
|
3339
|
+
* @param {*} [options] Override http request option.
|
|
3340
|
+
* @throws {RequiredError}
|
|
3341
|
+
* @memberof VariantsApi
|
|
3342
|
+
*/
|
|
3343
|
+
updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
|
|
1809
3344
|
}
|