@teemill/platform 0.8.0 → 0.10.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/dist/esm/api.d.ts CHANGED
@@ -1,9 +1,9 @@
1
1
  /**
2
2
  * Platform API
3
- * Manage Your podOS platform Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
3
+ * Manage Your podOS platform
4
+ *
5
+ * The version of the OpenAPI document: 0.10.0
4
6
  *
5
- * The version of the OpenAPI document: 0.8.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
@@ -306,6 +362,87 @@ export interface Image {
306
362
  */
307
363
  'sortOrder'?: number;
308
364
  }
365
+ /**
366
+ *
367
+ * @export
368
+ * @interface Metafield
369
+ */
370
+ export interface Metafield {
371
+ /**
372
+ * The unique identifier for a meta field
373
+ * @type {string}
374
+ * @memberof Metafield
375
+ */
376
+ 'key': string;
377
+ /**
378
+ * The data stored in the meta field. Always stored as a string, regardless of the meta field\'s type.
379
+ * @type {string}
380
+ * @memberof Metafield
381
+ */
382
+ 'value': string;
383
+ }
384
+ /**
385
+ * Configuration of the product mockup
386
+ * @export
387
+ * @interface Mockup
388
+ */
389
+ export interface Mockup {
390
+ /**
391
+ * Base image of the mockup
392
+ * @type {string}
393
+ * @memberof Mockup
394
+ */
395
+ 'baseImage': string;
396
+ /**
397
+ *
398
+ * @type {MockupDesignPlacement}
399
+ * @memberof Mockup
400
+ */
401
+ 'designPlacement'?: MockupDesignPlacement | null;
402
+ /**
403
+ * Optional mask applied to the design. Used for products with non-rectangular print areas
404
+ * @type {string}
405
+ * @memberof Mockup
406
+ */
407
+ 'designMask'?: string | null;
408
+ /**
409
+ * 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.
410
+ * @type {string}
411
+ * @memberof Mockup
412
+ */
413
+ 'overlayImage'?: string | null;
414
+ }
415
+ /**
416
+ * Design placement
417
+ * @export
418
+ * @interface MockupDesignPlacement
419
+ */
420
+ export interface MockupDesignPlacement {
421
+ /**
422
+ * X coordinate in pixels
423
+ * @type {number}
424
+ * @memberof MockupDesignPlacement
425
+ */
426
+ 'x': number;
427
+ /**
428
+ * Y coordinate in pixels
429
+ * @type {number}
430
+ * @memberof MockupDesignPlacement
431
+ */
432
+ 'y': number;
433
+ /**
434
+ * Width in pixels
435
+ * @type {number}
436
+ * @memberof MockupDesignPlacement
437
+ */
438
+ 'width': number;
439
+ /**
440
+ * Height in pixels
441
+ * @type {number}
442
+ * @memberof MockupDesignPlacement
443
+ */
444
+ 'height': number;
445
+ }
309
446
  /**
310
447
  *
311
448
  * @export
@@ -583,6 +720,174 @@ export interface Origin {
583
720
  */
584
721
  'isPaid'?: boolean;
585
722
  }
723
+ /**
724
+ * Configuration of the files output for this application
725
+ * @export
726
+ * @interface Output
727
+ */
728
+ export interface Output {
729
+ /**
730
+ * Width of the print file in pixels
731
+ * @type {number}
732
+ * @memberof Output
733
+ */
734
+ 'width': number;
735
+ /**
736
+ * Height of the print file in pixels
737
+ * @type {number}
738
+ * @memberof Output
739
+ */
740
+ 'height': number;
741
+ /**
742
+ * DPI of the print file in pixels
743
+ * @type {number}
744
+ * @memberof Output
745
+ */
746
+ 'dpi': number;
747
+ /**
748
+ *
749
+ * @type {OutputPadding}
750
+ * @memberof Output
751
+ */
752
+ 'padding'?: OutputPadding;
753
+ /**
754
+ * Position of the print
755
+ * @type {string}
756
+ * @memberof Output
757
+ */
758
+ 'position': OutputPositionEnum;
759
+ /**
760
+ * Whether the print should be mirrored horizontally
761
+ * @type {boolean}
762
+ * @memberof Output
763
+ */
764
+ 'mirrorX'?: boolean;
765
+ /**
766
+ * Whether the print should be mirrored vertically
767
+ * @type {boolean}
768
+ * @memberof Output
769
+ */
770
+ 'mirrorY'?: boolean;
771
+ /**
772
+ * Amount of reflection in pixels
773
+ * @type {number}
774
+ * @memberof Output
775
+ */
776
+ 'reflect'?: number;
777
+ /**
778
+ * Amount to extend the print in pixels
779
+ * @type {number}
780
+ * @memberof Output
781
+ */
782
+ 'extend'?: number;
783
+ /**
784
+ * Rotation in degrees
785
+ * @type {number}
786
+ * @memberof Output
787
+ */
788
+ 'rotate'?: number;
789
+ /**
790
+ * Format of the print file
791
+ * @type {string}
792
+ * @memberof Output
793
+ */
794
+ 'fileFormat': OutputFileFormatEnum;
795
+ /**
796
+ *
797
+ * @type {Array<OutputDeviceConfigsInner>}
798
+ * @memberof Output
799
+ */
800
+ 'deviceConfigs'?: Array<OutputDeviceConfigsInner>;
801
+ }
802
+ export declare const OutputPositionEnum: {
803
+ readonly Center: "center";
804
+ readonly Top: "top";
805
+ readonly Left: "left";
806
+ readonly Bottom: "bottom";
807
+ readonly Right: "right";
808
+ readonly RightTop: "right-top";
809
+ readonly RightBottom: "right-bottom";
810
+ readonly LeftTop: "left-top";
811
+ readonly LeftBottom: "left-bottom";
812
+ };
813
+ export type OutputPositionEnum = typeof OutputPositionEnum[keyof typeof OutputPositionEnum];
814
+ export declare const OutputFileFormatEnum: {
815
+ readonly Png: "png";
816
+ readonly Jpg: "jpg";
817
+ readonly Jpeg: "jpeg";
818
+ readonly Webp: "webp";
819
+ readonly Pdf: "pdf";
820
+ };
821
+ export type OutputFileFormatEnum = typeof OutputFileFormatEnum[keyof typeof OutputFileFormatEnum];
822
+ /**
823
+ *
824
+ * @export
825
+ * @interface OutputDeviceConfigsInner
826
+ */
827
+ export interface OutputDeviceConfigsInner {
828
+ /**
829
+ * Unique object identifier
830
+ * @type {string}
831
+ * @memberof OutputDeviceConfigsInner
832
+ */
833
+ 'modelId'?: string;
834
+ /**
835
+ *
836
+ * @type {Array<OutputDeviceConfigsInnerPropertiesInner>}
837
+ * @memberof OutputDeviceConfigsInner
838
+ */
839
+ 'properties'?: Array<OutputDeviceConfigsInnerPropertiesInner>;
840
+ }
841
+ /**
842
+ *
843
+ * @export
844
+ * @interface OutputDeviceConfigsInnerPropertiesInner
845
+ */
846
+ export interface OutputDeviceConfigsInnerPropertiesInner {
847
+ /**
848
+ *
849
+ * @type {string}
850
+ * @memberof OutputDeviceConfigsInnerPropertiesInner
851
+ */
852
+ 'name'?: string;
853
+ /**
854
+ *
855
+ * @type {string}
856
+ * @memberof OutputDeviceConfigsInnerPropertiesInner
857
+ */
858
+ 'option'?: string;
859
+ }
860
+ /**
861
+ * Padding to be applied to the print file
862
+ * @export
863
+ * @interface OutputPadding
864
+ */
865
+ export interface OutputPadding {
866
+ /**
867
+ * Top padding in pixels
868
+ * @type {number}
869
+ * @memberof OutputPadding
870
+ */
871
+ 'top': number;
872
+ /**
873
+ * Right padding in pixels
874
+ * @type {number}
875
+ * @memberof OutputPadding
876
+ */
877
+ 'right': number;
878
+ /**
879
+ * Bottom padding in pixels
880
+ * @type {number}
881
+ * @memberof OutputPadding
882
+ */
883
+ 'bottom': number;
884
+ /**
885
+ * Left padding in pixels
886
+ * @type {number}
887
+ * @memberof OutputPadding
888
+ */
889
+ 'left': number;
890
+ }
586
891
  /**
587
892
  *
588
893
  * @export
@@ -619,6 +924,12 @@ export interface Platform {
619
924
  * @memberof Platform
620
925
  */
621
926
  'favicon': string | null;
927
+ /**
928
+ *
929
+ * @type {boolean}
930
+ * @memberof Platform
931
+ */
932
+ 'clientGiftWrapAvailable': boolean;
622
933
  }
623
934
  /**
624
935
  *
@@ -660,6 +971,240 @@ export interface Price {
660
971
  */
661
972
  'currencyCode'?: string;
662
973
  }
974
+ /**
975
+ *
976
+ * @export
977
+ * @interface Product
978
+ */
979
+ export interface Product {
980
+ /**
981
+ * Unique object identifier
982
+ * @type {string}
983
+ * @memberof Product
984
+ */
985
+ 'id': string;
986
+ /**
987
+ * A reference to the resource location
988
+ * @type {string}
989
+ * @memberof Product
990
+ */
991
+ 'ref': string;
992
+ /**
993
+ *
994
+ * @type {string}
995
+ * @memberof Product
996
+ */
997
+ 'title': string;
998
+ /**
999
+ * Whether the product is enabled
1000
+ * @type {boolean}
1001
+ * @memberof Product
1002
+ */
1003
+ 'enabled'?: boolean;
1004
+ /**
1005
+ * Whether stock levels should be tracked for this product
1006
+ * @type {boolean}
1007
+ * @memberof Product
1008
+ */
1009
+ 'trackInventory'?: boolean;
1010
+ /**
1011
+ * Whether this product should always be purchasable, regardless of factory stock levels
1012
+ * @type {boolean}
1013
+ * @memberof Product
1014
+ */
1015
+ 'alwaysInStock'?: boolean;
1016
+ /**
1017
+ *
1018
+ * @type {string}
1019
+ * @memberof Product
1020
+ */
1021
+ 'sku'?: string;
1022
+ /**
1023
+ * Tariff code of the product
1024
+ * @type {number}
1025
+ * @memberof Product
1026
+ */
1027
+ 'tariffCode'?: number;
1028
+ /**
1029
+ * Brand of the product
1030
+ * @type {string}
1031
+ * @memberof Product
1032
+ */
1033
+ 'brand'?: string;
1034
+ /**
1035
+ * The owner of the product
1036
+ * @type {string}
1037
+ * @memberof Product
1038
+ */
1039
+ 'ownerId': string;
1040
+ /**
1041
+ * Description of the product
1042
+ * @type {string}
1043
+ * @memberof Product
1044
+ */
1045
+ 'description'?: string;
1046
+ /**
1047
+ * Specifications of the product
1048
+ * @type {string}
1049
+ * @memberof Product
1050
+ */
1051
+ 'specifications'?: string;
1052
+ /**
1053
+ *
1054
+ * @type {ProductType}
1055
+ * @memberof Product
1056
+ */
1057
+ 'productType': ProductType;
1058
+ /**
1059
+ * Attributes associated to a product such as Colour and Size.
1060
+ * @type {Array<ProductAttribute>}
1061
+ * @memberof Product
1062
+ */
1063
+ 'attributes': Array<ProductAttribute>;
1064
+ /**
1065
+ * Additional data to be stored with the product
1066
+ * @type {Array<Metafield>}
1067
+ * @memberof Product
1068
+ */
1069
+ 'metafields': Array<Metafield>;
1070
+ /**
1071
+ * Variants
1072
+ * @type {Array<ProductVariantsInner>}
1073
+ * @memberof Product
1074
+ */
1075
+ 'variants': Array<ProductVariantsInner>;
1076
+ /**
1077
+ * ISO 8601 Timestamp
1078
+ * @type {string}
1079
+ * @memberof Product
1080
+ */
1081
+ 'createdAt'?: string;
1082
+ /**
1083
+ * ISO 8601 Timestamp
1084
+ * @type {string}
1085
+ * @memberof Product
1086
+ */
1087
+ 'updatedAt'?: string;
1088
+ /**
1089
+ * Images
1090
+ * @type {Array<Image>}
1091
+ * @memberof Product
1092
+ */
1093
+ 'images'?: Array<Image>;
1094
+ }
1095
+ /**
1096
+ *
1097
+ * @export
1098
+ * @interface ProductAttribute
1099
+ */
1100
+ export interface ProductAttribute {
1101
+ /**
1102
+ * Attribute name
1103
+ * @type {string}
1104
+ * @memberof ProductAttribute
1105
+ */
1106
+ 'name': string;
1107
+ /**
1108
+ * Position of the attribute when ordered
1109
+ * @type {number}
1110
+ * @memberof ProductAttribute
1111
+ */
1112
+ 'sortOrder': number;
1113
+ /**
1114
+ * Attribute values
1115
+ * @type {Array<ProductAttributeValuesInner>}
1116
+ * @memberof ProductAttribute
1117
+ */
1118
+ 'values': Array<ProductAttributeValuesInner>;
1119
+ }
1120
+ /**
1121
+ *
1122
+ * @export
1123
+ * @interface ProductAttributeValuesInner
1124
+ */
1125
+ export interface ProductAttributeValuesInner {
1126
+ /**
1127
+ * Position of the attribute value when ordered
1128
+ * @type {number}
1129
+ * @memberof ProductAttributeValuesInner
1130
+ */
1131
+ 'sortOrder': number;
1132
+ /**
1133
+ * Value of the attribute
1134
+ * @type {string}
1135
+ * @memberof ProductAttributeValuesInner
1136
+ */
1137
+ 'value': string;
1138
+ /**
1139
+ *
1140
+ * @type {ProductAttributeValuesInnerThumbnail}
1141
+ * @memberof ProductAttributeValuesInner
1142
+ */
1143
+ 'thumbnail'?: ProductAttributeValuesInnerThumbnail;
1144
+ }
1145
+ /**
1146
+ *
1147
+ * @export
1148
+ * @interface ProductAttributeValuesInnerThumbnail
1149
+ */
1150
+ export interface ProductAttributeValuesInnerThumbnail {
1151
+ /**
1152
+ *
1153
+ * @type {string}
1154
+ * @memberof ProductAttributeValuesInnerThumbnail
1155
+ */
1156
+ 'type'?: ProductAttributeValuesInnerThumbnailTypeEnum;
1157
+ /**
1158
+ *
1159
+ * @type {string}
1160
+ * @memberof ProductAttributeValuesInnerThumbnail
1161
+ */
1162
+ 'value'?: string;
1163
+ }
1164
+ export declare const ProductAttributeValuesInnerThumbnailTypeEnum: {
1165
+ readonly Text: "text";
1166
+ readonly Color: "color";
1167
+ readonly Image: "image";
1168
+ };
1169
+ export type ProductAttributeValuesInnerThumbnailTypeEnum = typeof ProductAttributeValuesInnerThumbnailTypeEnum[keyof typeof ProductAttributeValuesInnerThumbnailTypeEnum];
1170
+ /**
1171
+ *
1172
+ * @export
1173
+ * @interface ProductType
1174
+ */
1175
+ export interface ProductType {
1176
+ /**
1177
+ * Id of the product type
1178
+ * @type {number}
1179
+ * @memberof ProductType
1180
+ */
1181
+ 'id'?: number;
1182
+ /**
1183
+ * Name of the product type
1184
+ * @type {string}
1185
+ * @memberof ProductType
1186
+ */
1187
+ 'name'?: string;
1188
+ }
1189
+ /**
1190
+ *
1191
+ * @export
1192
+ * @interface ProductVariantsInner
1193
+ */
1194
+ export interface ProductVariantsInner {
1195
+ /**
1196
+ * Unique object identifier
1197
+ * @type {string}
1198
+ * @memberof ProductVariantsInner
1199
+ */
1200
+ 'id'?: string;
1201
+ /**
1202
+ * A reference to the resource location
1203
+ * @type {string}
1204
+ * @memberof ProductVariantsInner
1205
+ */
1206
+ 'ref'?: string;
1207
+ }
663
1208
  /**
664
1209
  *
665
1210
  * @export
@@ -707,85 +1252,339 @@ export interface ShippingMethod {
707
1252
  * @type {Price}
708
1253
  * @memberof ShippingMethod
709
1254
  */
710
- 'subtotalPrice'?: Price;
1255
+ 'subtotalPrice'?: Price;
1256
+ /**
1257
+ *
1258
+ * @type {Price}
1259
+ * @memberof ShippingMethod
1260
+ */
1261
+ 'discountPrice'?: Price;
1262
+ }
1263
+ /**
1264
+ *
1265
+ * @export
1266
+ * @interface StatusHistoryItem
1267
+ */
1268
+ export interface StatusHistoryItem {
1269
+ /**
1270
+ *
1271
+ * @type {OrderStatus}
1272
+ * @memberof StatusHistoryItem
1273
+ */
1274
+ 'status'?: OrderStatus;
1275
+ /**
1276
+ * ISO 8601 Timestamp
1277
+ * @type {string}
1278
+ * @memberof StatusHistoryItem
1279
+ */
1280
+ 'createdAt'?: string;
1281
+ }
1282
+ /**
1283
+ *
1284
+ * @export
1285
+ * @interface UpdateFulfillmentRequest
1286
+ */
1287
+ export interface UpdateFulfillmentRequest {
1288
+ /**
1289
+ * Unique object identifier
1290
+ * @type {string}
1291
+ * @memberof UpdateFulfillmentRequest
1292
+ */
1293
+ 'fulfillerId'?: string;
1294
+ }
1295
+ /**
1296
+ *
1297
+ * @export
1298
+ * @interface UpdatePlatformRequest
1299
+ */
1300
+ export interface UpdatePlatformRequest {
1301
+ /**
1302
+ *
1303
+ * @type {Array<PlatformLogo>}
1304
+ * @memberof UpdatePlatformRequest
1305
+ */
1306
+ 'logos'?: Array<PlatformLogo>;
1307
+ /**
1308
+ *
1309
+ * @type {string}
1310
+ * @memberof UpdatePlatformRequest
1311
+ */
1312
+ 'favicon'?: string;
1313
+ /**
1314
+ *
1315
+ * @type {boolean}
1316
+ * @memberof UpdatePlatformRequest
1317
+ */
1318
+ 'clientGiftWrapAvailable'?: boolean;
1319
+ }
1320
+ /**
1321
+ *
1322
+ * @export
1323
+ * @interface UpdateProductRequest
1324
+ */
1325
+ export interface UpdateProductRequest {
1326
+ /**
1327
+ * The warehouse variants of the product to update
1328
+ * @type {Array<UpdateProductRequestVariantsInner>}
1329
+ * @memberof UpdateProductRequest
1330
+ */
1331
+ 'variants'?: Array<UpdateProductRequestVariantsInner>;
1332
+ /**
1333
+ * Whether the platform warehouse product should be enabled or not
1334
+ * @type {boolean}
1335
+ * @memberof UpdateProductRequest
1336
+ */
1337
+ 'enabled'?: boolean;
1338
+ }
1339
+ /**
1340
+ *
1341
+ * @export
1342
+ * @interface UpdateProductRequestVariantsInner
1343
+ */
1344
+ export interface UpdateProductRequestVariantsInner {
1345
+ /**
1346
+ * The ID of the variant to update
1347
+ * @type {string}
1348
+ * @memberof UpdateProductRequestVariantsInner
1349
+ */
1350
+ 'id': string;
1351
+ /**
1352
+ * Whether the warehouse variant should be enabled or not
1353
+ * @type {boolean}
1354
+ * @memberof UpdateProductRequestVariantsInner
1355
+ */
1356
+ 'enabled'?: boolean;
1357
+ }
1358
+ /**
1359
+ *
1360
+ * @export
1361
+ * @interface UpdateVariantRequest
1362
+ */
1363
+ export interface UpdateVariantRequest {
1364
+ /**
1365
+ * Whether the platform warehouse variant is enabled or not
1366
+ * @type {boolean}
1367
+ * @memberof UpdateVariantRequest
1368
+ */
1369
+ 'enabled'?: boolean;
1370
+ }
1371
+ /**
1372
+ *
1373
+ * @export
1374
+ * @interface ValidationError
1375
+ */
1376
+ export interface ValidationError {
1377
+ /**
1378
+ *
1379
+ * @type {string}
1380
+ * @memberof ValidationError
1381
+ */
1382
+ 'message': string;
1383
+ /**
1384
+ *
1385
+ * @type {{ [key: string]: Array<string>; }}
1386
+ * @memberof ValidationError
1387
+ */
1388
+ 'errors': {
1389
+ [key: string]: Array<string>;
1390
+ };
1391
+ }
1392
+ /**
1393
+ *
1394
+ * @export
1395
+ * @interface Variant
1396
+ */
1397
+ export interface Variant {
1398
+ /**
1399
+ * Unique object identifier
1400
+ * @type {string}
1401
+ * @memberof Variant
1402
+ */
1403
+ 'id': string;
1404
+ /**
1405
+ * A reference to the resource location
1406
+ * @type {string}
1407
+ * @memberof Variant
1408
+ */
1409
+ 'ref': string;
1410
+ /**
1411
+ *
1412
+ * @type {ProductVariantsInner}
1413
+ * @memberof Variant
1414
+ */
1415
+ 'product'?: ProductVariantsInner;
1416
+ /**
1417
+ *
1418
+ * @type {string}
1419
+ * @memberof Variant
1420
+ */
1421
+ 'sku': string;
1422
+ /**
1423
+ * ISO 8601 Timestamp
1424
+ * @type {string}
1425
+ * @memberof Variant
1426
+ */
1427
+ 'createdAt'?: string;
1428
+ /**
1429
+ * ISO 8601 Timestamp
1430
+ * @type {string}
1431
+ * @memberof Variant
1432
+ */
1433
+ 'updatedAt'?: string;
1434
+ /**
1435
+ * Images
1436
+ * @type {Array<Image>}
1437
+ * @memberof Variant
1438
+ */
1439
+ 'images'?: Array<Image>;
1440
+ /**
1441
+ * Weight in kg
1442
+ * @type {number}
1443
+ * @memberof Variant
1444
+ */
1445
+ 'weight'?: number;
1446
+ /**
1447
+ * The number of units that can be packed in a single pickface
1448
+ * @type {number}
1449
+ * @memberof Variant
1450
+ */
1451
+ 'packVolume'?: number;
1452
+ /**
1453
+ *
1454
+ * @type {VariantPackedDimensions}
1455
+ * @memberof Variant
1456
+ */
1457
+ 'packedDimensions'?: VariantPackedDimensions;
1458
+ /**
1459
+ * Whether the variant can be pre-ordered
1460
+ * @type {boolean}
1461
+ * @memberof Variant
1462
+ */
1463
+ 'preOrderable'?: boolean;
1464
+ /**
1465
+ * Whether the variant is enabled
1466
+ * @type {boolean}
1467
+ * @memberof Variant
1468
+ */
1469
+ 'enabled'?: boolean;
1470
+ /**
1471
+ * Whether the variant is discontinued
1472
+ * @type {boolean}
1473
+ * @memberof Variant
1474
+ */
1475
+ 'discontinued'?: boolean;
1476
+ /**
1477
+ *
1478
+ * @type {VariantManufacturerOrigin}
1479
+ * @memberof Variant
1480
+ */
1481
+ 'manufacturerOrigin'?: VariantManufacturerOrigin;
1482
+ /**
1483
+ * 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.
1484
+ * @type {Array<VariantAttribute>}
1485
+ * @memberof Variant
1486
+ */
1487
+ 'attributes': Array<VariantAttribute>;
711
1488
  /**
712
- *
713
- * @type {Price}
714
- * @memberof ShippingMethod
1489
+ * Applications of the variant
1490
+ * @type {Array<Application>}
1491
+ * @memberof Variant
715
1492
  */
716
- 'discountPrice'?: Price;
1493
+ 'applications'?: Array<Application>;
717
1494
  }
718
1495
  /**
719
1496
  *
720
1497
  * @export
721
- * @interface StatusHistoryItem
1498
+ * @interface VariantAttribute
722
1499
  */
723
- export interface StatusHistoryItem {
1500
+ export interface VariantAttribute {
724
1501
  /**
725
- *
726
- * @type {OrderStatus}
727
- * @memberof StatusHistoryItem
1502
+ * Attribute name
1503
+ * @type {string}
1504
+ * @memberof VariantAttribute
728
1505
  */
729
- 'status'?: OrderStatus;
1506
+ 'name': string;
730
1507
  /**
731
- * ISO 8601 Timestamp
1508
+ * Attribute value
732
1509
  * @type {string}
733
- * @memberof StatusHistoryItem
1510
+ * @memberof VariantAttribute
734
1511
  */
735
- 'createdAt'?: string;
1512
+ 'value': string;
1513
+ /**
1514
+ *
1515
+ * @type {VariantAttributeThumbnail}
1516
+ * @memberof VariantAttribute
1517
+ */
1518
+ 'thumbnail'?: VariantAttributeThumbnail;
1519
+ /**
1520
+ * Attribute tags
1521
+ * @type {Array<string>}
1522
+ * @memberof VariantAttribute
1523
+ */
1524
+ 'tags'?: Array<string>;
736
1525
  }
737
1526
  /**
738
- *
1527
+ * Attribute thumbnail
739
1528
  * @export
740
- * @interface UpdateFulfillmentRequest
1529
+ * @interface VariantAttributeThumbnail
741
1530
  */
742
- export interface UpdateFulfillmentRequest {
1531
+ export interface VariantAttributeThumbnail {
743
1532
  /**
744
- * Unique object identifier
1533
+ *
745
1534
  * @type {string}
746
- * @memberof UpdateFulfillmentRequest
1535
+ * @memberof VariantAttributeThumbnail
747
1536
  */
748
- 'fulfillerId'?: string;
1537
+ 'type'?: VariantAttributeThumbnailTypeEnum;
1538
+ /**
1539
+ *
1540
+ * @type {string}
1541
+ * @memberof VariantAttributeThumbnail
1542
+ */
1543
+ 'value'?: string;
749
1544
  }
1545
+ export declare const VariantAttributeThumbnailTypeEnum: {
1546
+ readonly Text: "text";
1547
+ readonly Color: "color";
1548
+ readonly Image: "image";
1549
+ };
1550
+ export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
750
1551
  /**
751
- *
1552
+ * Where the product was originally produced or manufactured
752
1553
  * @export
753
- * @interface UpdatePlatformRequest
1554
+ * @interface VariantManufacturerOrigin
754
1555
  */
755
- export interface UpdatePlatformRequest {
756
- /**
757
- *
758
- * @type {Array<PlatformLogo>}
759
- * @memberof UpdatePlatformRequest
760
- */
761
- 'logos'?: Array<PlatformLogo>;
1556
+ export interface VariantManufacturerOrigin {
762
1557
  /**
763
- *
1558
+ * Country of origin (ISO 3166-1 alpha-2).
764
1559
  * @type {string}
765
- * @memberof UpdatePlatformRequest
1560
+ * @memberof VariantManufacturerOrigin
766
1561
  */
767
- 'favicon'?: string;
1562
+ 'country'?: string;
768
1563
  }
769
1564
  /**
770
1565
  *
771
1566
  * @export
772
- * @interface ValidationError
1567
+ * @interface VariantPackedDimensions
773
1568
  */
774
- export interface ValidationError {
1569
+ export interface VariantPackedDimensions {
775
1570
  /**
776
- *
777
- * @type {string}
778
- * @memberof ValidationError
1571
+ * Length in mm
1572
+ * @type {number}
1573
+ * @memberof VariantPackedDimensions
779
1574
  */
780
- 'message': string;
1575
+ 'length'?: number;
781
1576
  /**
782
- *
783
- * @type {{ [key: string]: Array<string>; }}
784
- * @memberof ValidationError
1577
+ * Width in mm
1578
+ * @type {number}
1579
+ * @memberof VariantPackedDimensions
785
1580
  */
786
- 'errors': {
787
- [key: string]: Array<string>;
788
- };
1581
+ 'width'?: number;
1582
+ /**
1583
+ * Depth in mm
1584
+ * @type {number}
1585
+ * @memberof VariantPackedDimensions
1586
+ */
1587
+ 'depth'?: number;
789
1588
  }
790
1589
  /**
791
1590
  * OrdersApi - axios parameter creator
@@ -1330,6 +2129,28 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
1330
2129
  * @throws {RequiredError}
1331
2130
  */
1332
2131
  updatePlatform: (project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2132
+ /**
2133
+ * Updates the warehouse product and its variants
2134
+ * @summary Update warehouse product
2135
+ * @param {string} project Project unique identifier
2136
+ * @param {string} platformId The platform identifier
2137
+ * @param {string} productId Products unique identifier
2138
+ * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
2139
+ * @param {*} [options] Override http request option.
2140
+ * @throws {RequiredError}
2141
+ */
2142
+ updateProduct: (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2143
+ /**
2144
+ * Updates the warehouse variant
2145
+ * @summary Update warehouse variant
2146
+ * @param {string} project Project unique identifier
2147
+ * @param {string} platformId The platform identifier
2148
+ * @param {string} variantId Variants unique identifier
2149
+ * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
2150
+ * @param {*} [options] Override http request option.
2151
+ * @throws {RequiredError}
2152
+ */
2153
+ updateVariant: (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1333
2154
  };
1334
2155
  /**
1335
2156
  * PlatformApi - functional programming interface
@@ -1420,6 +2241,28 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
1420
2241
  * @throws {RequiredError}
1421
2242
  */
1422
2243
  updatePlatform(project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
2244
+ /**
2245
+ * Updates the warehouse product and its variants
2246
+ * @summary Update warehouse product
2247
+ * @param {string} project Project unique identifier
2248
+ * @param {string} platformId The platform identifier
2249
+ * @param {string} productId Products unique identifier
2250
+ * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
2251
+ * @param {*} [options] Override http request option.
2252
+ * @throws {RequiredError}
2253
+ */
2254
+ updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
2255
+ /**
2256
+ * Updates the warehouse variant
2257
+ * @summary Update warehouse variant
2258
+ * @param {string} project Project unique identifier
2259
+ * @param {string} platformId The platform identifier
2260
+ * @param {string} variantId Variants unique identifier
2261
+ * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
2262
+ * @param {*} [options] Override http request option.
2263
+ * @throws {RequiredError}
2264
+ */
2265
+ updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>>;
1423
2266
  };
1424
2267
  /**
1425
2268
  * PlatformApi - factory interface
@@ -1490,6 +2333,22 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
1490
2333
  * @throws {RequiredError}
1491
2334
  */
1492
2335
  updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
2336
+ /**
2337
+ * Updates the warehouse product and its variants
2338
+ * @summary Update warehouse product
2339
+ * @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
2340
+ * @param {*} [options] Override http request option.
2341
+ * @throws {RequiredError}
2342
+ */
2343
+ updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
2344
+ /**
2345
+ * Updates the warehouse variant
2346
+ * @summary Update warehouse variant
2347
+ * @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
2348
+ * @param {*} [options] Override http request option.
2349
+ * @throws {RequiredError}
2350
+ */
2351
+ updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
1493
2352
  };
1494
2353
  /**
1495
2354
  * Request parameters for exportOrders operation in PlatformApi.
@@ -1715,6 +2574,68 @@ export interface PlatformApiUpdatePlatformRequest {
1715
2574
  */
1716
2575
  readonly updatePlatformRequest: UpdatePlatformRequest;
1717
2576
  }
2577
+ /**
2578
+ * Request parameters for updateProduct operation in PlatformApi.
2579
+ * @export
2580
+ * @interface PlatformApiUpdateProductRequest
2581
+ */
2582
+ export interface PlatformApiUpdateProductRequest {
2583
+ /**
2584
+ * Project unique identifier
2585
+ * @type {string}
2586
+ * @memberof PlatformApiUpdateProduct
2587
+ */
2588
+ readonly project: string;
2589
+ /**
2590
+ * The platform identifier
2591
+ * @type {string}
2592
+ * @memberof PlatformApiUpdateProduct
2593
+ */
2594
+ readonly platformId: string;
2595
+ /**
2596
+ * Products unique identifier
2597
+ * @type {string}
2598
+ * @memberof PlatformApiUpdateProduct
2599
+ */
2600
+ readonly productId: string;
2601
+ /**
2602
+ * Update a platform warehouse product
2603
+ * @type {UpdateProductRequest}
2604
+ * @memberof PlatformApiUpdateProduct
2605
+ */
2606
+ readonly updateProductRequest: UpdateProductRequest;
2607
+ }
2608
+ /**
2609
+ * Request parameters for updateVariant operation in PlatformApi.
2610
+ * @export
2611
+ * @interface PlatformApiUpdateVariantRequest
2612
+ */
2613
+ export interface PlatformApiUpdateVariantRequest {
2614
+ /**
2615
+ * Project unique identifier
2616
+ * @type {string}
2617
+ * @memberof PlatformApiUpdateVariant
2618
+ */
2619
+ readonly project: string;
2620
+ /**
2621
+ * The platform identifier
2622
+ * @type {string}
2623
+ * @memberof PlatformApiUpdateVariant
2624
+ */
2625
+ readonly platformId: string;
2626
+ /**
2627
+ * Variants unique identifier
2628
+ * @type {string}
2629
+ * @memberof PlatformApiUpdateVariant
2630
+ */
2631
+ readonly variantId: string;
2632
+ /**
2633
+ * Update a platform warehouse variant
2634
+ * @type {UpdateVariantRequest}
2635
+ * @memberof PlatformApiUpdateVariant
2636
+ */
2637
+ readonly updateVariantRequest: UpdateVariantRequest;
2638
+ }
1718
2639
  /**
1719
2640
  * PlatformApi - object-oriented interface
1720
2641
  * @export
@@ -1794,4 +2715,214 @@ export declare class PlatformApi extends BaseAPI {
1794
2715
  * @memberof PlatformApi
1795
2716
  */
1796
2717
  updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
2718
+ /**
2719
+ * Updates the warehouse product and its variants
2720
+ * @summary Update warehouse product
2721
+ * @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
2722
+ * @param {*} [options] Override http request option.
2723
+ * @throws {RequiredError}
2724
+ * @memberof PlatformApi
2725
+ */
2726
+ updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
2727
+ /**
2728
+ * Updates the warehouse variant
2729
+ * @summary Update warehouse variant
2730
+ * @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
2731
+ * @param {*} [options] Override http request option.
2732
+ * @throws {RequiredError}
2733
+ * @memberof PlatformApi
2734
+ */
2735
+ updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
2736
+ }
2737
+ /**
2738
+ * ProductsApi - axios parameter creator
2739
+ * @export
2740
+ */
2741
+ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
2742
+ /**
2743
+ * Updates the warehouse product and its variants
2744
+ * @summary Update warehouse product
2745
+ * @param {string} project Project unique identifier
2746
+ * @param {string} platformId The platform identifier
2747
+ * @param {string} productId Products unique identifier
2748
+ * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
2749
+ * @param {*} [options] Override http request option.
2750
+ * @throws {RequiredError}
2751
+ */
2752
+ updateProduct: (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2753
+ };
2754
+ /**
2755
+ * ProductsApi - functional programming interface
2756
+ * @export
2757
+ */
2758
+ export declare const ProductsApiFp: (configuration?: Configuration) => {
2759
+ /**
2760
+ * Updates the warehouse product and its variants
2761
+ * @summary Update warehouse product
2762
+ * @param {string} project Project unique identifier
2763
+ * @param {string} platformId The platform identifier
2764
+ * @param {string} productId Products unique identifier
2765
+ * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
2766
+ * @param {*} [options] Override http request option.
2767
+ * @throws {RequiredError}
2768
+ */
2769
+ updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
2770
+ };
2771
+ /**
2772
+ * ProductsApi - factory interface
2773
+ * @export
2774
+ */
2775
+ export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2776
+ /**
2777
+ * Updates the warehouse product and its variants
2778
+ * @summary Update warehouse product
2779
+ * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
2780
+ * @param {*} [options] Override http request option.
2781
+ * @throws {RequiredError}
2782
+ */
2783
+ updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
2784
+ };
2785
+ /**
2786
+ * Request parameters for updateProduct operation in ProductsApi.
2787
+ * @export
2788
+ * @interface ProductsApiUpdateProductRequest
2789
+ */
2790
+ export interface ProductsApiUpdateProductRequest {
2791
+ /**
2792
+ * Project unique identifier
2793
+ * @type {string}
2794
+ * @memberof ProductsApiUpdateProduct
2795
+ */
2796
+ readonly project: string;
2797
+ /**
2798
+ * The platform identifier
2799
+ * @type {string}
2800
+ * @memberof ProductsApiUpdateProduct
2801
+ */
2802
+ readonly platformId: string;
2803
+ /**
2804
+ * Products unique identifier
2805
+ * @type {string}
2806
+ * @memberof ProductsApiUpdateProduct
2807
+ */
2808
+ readonly productId: string;
2809
+ /**
2810
+ * Update a platform warehouse product
2811
+ * @type {UpdateProductRequest}
2812
+ * @memberof ProductsApiUpdateProduct
2813
+ */
2814
+ readonly updateProductRequest: UpdateProductRequest;
2815
+ }
2816
+ /**
2817
+ * ProductsApi - object-oriented interface
2818
+ * @export
2819
+ * @class ProductsApi
2820
+ * @extends {BaseAPI}
2821
+ */
2822
+ export declare class ProductsApi extends BaseAPI {
2823
+ /**
2824
+ * Updates the warehouse product and its variants
2825
+ * @summary Update warehouse product
2826
+ * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
2827
+ * @param {*} [options] Override http request option.
2828
+ * @throws {RequiredError}
2829
+ * @memberof ProductsApi
2830
+ */
2831
+ updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
2832
+ }
2833
+ /**
2834
+ * VariantsApi - axios parameter creator
2835
+ * @export
2836
+ */
2837
+ export declare const VariantsApiAxiosParamCreator: (configuration?: Configuration) => {
2838
+ /**
2839
+ * Updates the warehouse variant
2840
+ * @summary Update warehouse variant
2841
+ * @param {string} project Project unique identifier
2842
+ * @param {string} platformId The platform identifier
2843
+ * @param {string} variantId Variants unique identifier
2844
+ * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
2845
+ * @param {*} [options] Override http request option.
2846
+ * @throws {RequiredError}
2847
+ */
2848
+ updateVariant: (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2849
+ };
2850
+ /**
2851
+ * VariantsApi - functional programming interface
2852
+ * @export
2853
+ */
2854
+ export declare const VariantsApiFp: (configuration?: Configuration) => {
2855
+ /**
2856
+ * Updates the warehouse variant
2857
+ * @summary Update warehouse variant
2858
+ * @param {string} project Project unique identifier
2859
+ * @param {string} platformId The platform identifier
2860
+ * @param {string} variantId Variants unique identifier
2861
+ * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
2862
+ * @param {*} [options] Override http request option.
2863
+ * @throws {RequiredError}
2864
+ */
2865
+ updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>>;
2866
+ };
2867
+ /**
2868
+ * VariantsApi - factory interface
2869
+ * @export
2870
+ */
2871
+ export declare const VariantsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2872
+ /**
2873
+ * Updates the warehouse variant
2874
+ * @summary Update warehouse variant
2875
+ * @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
2876
+ * @param {*} [options] Override http request option.
2877
+ * @throws {RequiredError}
2878
+ */
2879
+ updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
2880
+ };
2881
+ /**
2882
+ * Request parameters for updateVariant operation in VariantsApi.
2883
+ * @export
2884
+ * @interface VariantsApiUpdateVariantRequest
2885
+ */
2886
+ export interface VariantsApiUpdateVariantRequest {
2887
+ /**
2888
+ * Project unique identifier
2889
+ * @type {string}
2890
+ * @memberof VariantsApiUpdateVariant
2891
+ */
2892
+ readonly project: string;
2893
+ /**
2894
+ * The platform identifier
2895
+ * @type {string}
2896
+ * @memberof VariantsApiUpdateVariant
2897
+ */
2898
+ readonly platformId: string;
2899
+ /**
2900
+ * Variants unique identifier
2901
+ * @type {string}
2902
+ * @memberof VariantsApiUpdateVariant
2903
+ */
2904
+ readonly variantId: string;
2905
+ /**
2906
+ * Update a platform warehouse variant
2907
+ * @type {UpdateVariantRequest}
2908
+ * @memberof VariantsApiUpdateVariant
2909
+ */
2910
+ readonly updateVariantRequest: UpdateVariantRequest;
2911
+ }
2912
+ /**
2913
+ * VariantsApi - object-oriented interface
2914
+ * @export
2915
+ * @class VariantsApi
2916
+ * @extends {BaseAPI}
2917
+ */
2918
+ export declare class VariantsApi extends BaseAPI {
2919
+ /**
2920
+ * Updates the warehouse variant
2921
+ * @summary Update warehouse variant
2922
+ * @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
2923
+ * @param {*} [options] Override http request option.
2924
+ * @throws {RequiredError}
2925
+ * @memberof VariantsApi
2926
+ */
2927
+ updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
1797
2928
  }