@teemill/platform 0.14.4 → 0.15.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
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.14.4
5
+ * The version of the OpenAPI document: 0.15.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -87,62 +87,6 @@ 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
- }
146
90
  /**
147
91
  *
148
92
  * @export
@@ -443,87 +387,6 @@ export interface Image {
443
387
  */
444
388
  'sortOrder'?: number;
445
389
  }
446
- /**
447
- *
448
- * @export
449
- * @interface Metafield
450
- */
451
- export interface Metafield {
452
- /**
453
- * The unique identifier for a meta field
454
- * @type {string}
455
- * @memberof Metafield
456
- */
457
- 'key': string;
458
- /**
459
- * The data stored in the meta field. Always stored as a string, regardless of the meta field\'s type.
460
- * @type {string}
461
- * @memberof Metafield
462
- */
463
- 'value': string;
464
- }
465
- /**
466
- * Configuration of the product mockup
467
- * @export
468
- * @interface Mockup
469
- */
470
- export interface Mockup {
471
- /**
472
- * Base image of the mockup
473
- * @type {string}
474
- * @memberof Mockup
475
- */
476
- 'baseImage': string;
477
- /**
478
- *
479
- * @type {MockupDesignPlacement}
480
- * @memberof Mockup
481
- */
482
- 'designPlacement'?: MockupDesignPlacement | null;
483
- /**
484
- * Optional mask applied to the design. Used for products with non-rectangular print areas
485
- * @type {string}
486
- * @memberof Mockup
487
- */
488
- 'designMask'?: string | null;
489
- /**
490
- * 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.
491
- * @type {string}
492
- * @memberof Mockup
493
- */
494
- 'overlayImage'?: string | null;
495
- }
496
- /**
497
- * Design placement
498
- * @export
499
- * @interface MockupDesignPlacement
500
- */
501
- export interface MockupDesignPlacement {
502
- /**
503
- * X coordinate in pixels
504
- * @type {number}
505
- * @memberof MockupDesignPlacement
506
- */
507
- 'x': number;
508
- /**
509
- * Y coordinate in pixels
510
- * @type {number}
511
- * @memberof MockupDesignPlacement
512
- */
513
- 'y': number;
514
- /**
515
- * Width in pixels
516
- * @type {number}
517
- * @memberof MockupDesignPlacement
518
- */
519
- 'width': number;
520
- /**
521
- * Height in pixels
522
- * @type {number}
523
- * @memberof MockupDesignPlacement
524
- */
525
- 'height': number;
526
- }
527
390
  /**
528
391
  *
529
392
  * @export
@@ -679,10 +542,10 @@ export interface OrderItem {
679
542
  'variantRef': string;
680
543
  /**
681
544
  *
682
- * @type {Variant1}
545
+ * @type {Variant}
683
546
  * @memberof OrderItem
684
547
  */
685
- 'variant': Variant1;
548
+ 'variant': Variant;
686
549
  /**
687
550
  * Options associated to an order item\'s variant, such as color and size.
688
551
  * @type {Array<Option>}
@@ -814,174 +677,6 @@ export interface Origin {
814
677
  */
815
678
  'isPaid'?: boolean;
816
679
  }
817
- /**
818
- * Configuration of the files output for this application
819
- * @export
820
- * @interface Output
821
- */
822
- export interface Output {
823
- /**
824
- * Width of the print file in pixels
825
- * @type {number}
826
- * @memberof Output
827
- */
828
- 'width': number;
829
- /**
830
- * Height of the print file in pixels
831
- * @type {number}
832
- * @memberof Output
833
- */
834
- 'height': number;
835
- /**
836
- * DPI of the print file in pixels
837
- * @type {number}
838
- * @memberof Output
839
- */
840
- 'dpi': number;
841
- /**
842
- *
843
- * @type {OutputPadding}
844
- * @memberof Output
845
- */
846
- 'padding'?: OutputPadding;
847
- /**
848
- * Position of the print
849
- * @type {string}
850
- * @memberof Output
851
- */
852
- 'position': OutputPositionEnum;
853
- /**
854
- * Whether the print should be mirrored horizontally
855
- * @type {boolean}
856
- * @memberof Output
857
- */
858
- 'mirrorX'?: boolean;
859
- /**
860
- * Whether the print should be mirrored vertically
861
- * @type {boolean}
862
- * @memberof Output
863
- */
864
- 'mirrorY'?: boolean;
865
- /**
866
- * Amount of reflection in pixels
867
- * @type {number}
868
- * @memberof Output
869
- */
870
- 'reflect'?: number;
871
- /**
872
- * Amount to extend the print in pixels
873
- * @type {number}
874
- * @memberof Output
875
- */
876
- 'extend'?: number;
877
- /**
878
- * Rotation in degrees
879
- * @type {number}
880
- * @memberof Output
881
- */
882
- 'rotate'?: number;
883
- /**
884
- * Format of the print file
885
- * @type {string}
886
- * @memberof Output
887
- */
888
- 'fileFormat': OutputFileFormatEnum;
889
- /**
890
- *
891
- * @type {Array<OutputDeviceConfigsInner>}
892
- * @memberof Output
893
- */
894
- 'deviceConfigs'?: Array<OutputDeviceConfigsInner>;
895
- }
896
- export declare const OutputPositionEnum: {
897
- readonly Center: "center";
898
- readonly Top: "top";
899
- readonly Left: "left";
900
- readonly Bottom: "bottom";
901
- readonly Right: "right";
902
- readonly RightTop: "right-top";
903
- readonly RightBottom: "right-bottom";
904
- readonly LeftTop: "left-top";
905
- readonly LeftBottom: "left-bottom";
906
- };
907
- export type OutputPositionEnum = typeof OutputPositionEnum[keyof typeof OutputPositionEnum];
908
- export declare const OutputFileFormatEnum: {
909
- readonly Png: "png";
910
- readonly Jpg: "jpg";
911
- readonly Jpeg: "jpeg";
912
- readonly Webp: "webp";
913
- readonly Pdf: "pdf";
914
- };
915
- export type OutputFileFormatEnum = typeof OutputFileFormatEnum[keyof typeof OutputFileFormatEnum];
916
- /**
917
- *
918
- * @export
919
- * @interface OutputDeviceConfigsInner
920
- */
921
- export interface OutputDeviceConfigsInner {
922
- /**
923
- * Unique object identifier
924
- * @type {string}
925
- * @memberof OutputDeviceConfigsInner
926
- */
927
- 'modelId'?: string;
928
- /**
929
- *
930
- * @type {Array<OutputDeviceConfigsInnerPropertiesInner>}
931
- * @memberof OutputDeviceConfigsInner
932
- */
933
- 'properties'?: Array<OutputDeviceConfigsInnerPropertiesInner>;
934
- }
935
- /**
936
- *
937
- * @export
938
- * @interface OutputDeviceConfigsInnerPropertiesInner
939
- */
940
- export interface OutputDeviceConfigsInnerPropertiesInner {
941
- /**
942
- *
943
- * @type {string}
944
- * @memberof OutputDeviceConfigsInnerPropertiesInner
945
- */
946
- 'name'?: string;
947
- /**
948
- *
949
- * @type {string}
950
- * @memberof OutputDeviceConfigsInnerPropertiesInner
951
- */
952
- 'option'?: string;
953
- }
954
- /**
955
- * Padding to be applied to the print file
956
- * @export
957
- * @interface OutputPadding
958
- */
959
- export interface OutputPadding {
960
- /**
961
- * Top padding in pixels
962
- * @type {number}
963
- * @memberof OutputPadding
964
- */
965
- 'top': number;
966
- /**
967
- * Right padding in pixels
968
- * @type {number}
969
- * @memberof OutputPadding
970
- */
971
- 'right': number;
972
- /**
973
- * Bottom padding in pixels
974
- * @type {number}
975
- * @memberof OutputPadding
976
- */
977
- 'bottom': number;
978
- /**
979
- * Left padding in pixels
980
- * @type {number}
981
- * @memberof OutputPadding
982
- */
983
- 'left': number;
984
- }
985
680
  /**
986
681
  *
987
682
  * @export
@@ -1123,702 +818,220 @@ export interface Price {
1123
818
  /**
1124
819
  *
1125
820
  * @export
1126
- * @interface Product
821
+ * @interface Project
1127
822
  */
1128
- export interface Product {
1129
- /**
1130
- * Unique object identifier
1131
- * @type {string}
1132
- * @memberof Product
1133
- */
1134
- 'id': string;
1135
- /**
1136
- * A reference to the resource location
1137
- * @type {string}
1138
- * @memberof Product
1139
- */
1140
- 'ref': string;
1141
- /**
1142
- *
1143
- * @type {string}
1144
- * @memberof Product
1145
- */
1146
- 'title': string;
1147
- /**
1148
- * Whether the product is enabled
1149
- * @type {boolean}
1150
- * @memberof Product
1151
- */
1152
- 'enabled'?: boolean;
1153
- /**
1154
- * Whether stock levels should be tracked for this product
1155
- * @type {boolean}
1156
- * @memberof Product
1157
- */
1158
- 'trackInventory'?: boolean;
1159
- /**
1160
- * Whether this product should always be purchasable, regardless of factory stock levels
1161
- * @type {boolean}
1162
- * @memberof Product
1163
- */
1164
- 'alwaysInStock'?: boolean;
1165
- /**
1166
- *
1167
- * @type {string}
1168
- * @memberof Product
1169
- */
1170
- 'sku'?: string;
1171
- /**
1172
- * Tariff code of the product
1173
- * @type {number}
1174
- * @memberof Product
1175
- */
1176
- 'tariffCode'?: number;
1177
- /**
1178
- * Brand of the product
1179
- * @type {string}
1180
- * @memberof Product
1181
- */
1182
- 'brand'?: string;
1183
- /**
1184
- * The owner of the product
1185
- * @type {string}
1186
- * @memberof Product
1187
- */
1188
- 'ownerId': string;
1189
- /**
1190
- * Description of the product
1191
- * @type {string}
1192
- * @memberof Product
1193
- */
1194
- 'description'?: string;
1195
- /**
1196
- * Specifications of the product
1197
- * @type {string}
1198
- * @memberof Product
1199
- */
1200
- 'specifications'?: string;
823
+ export interface Project {
1201
824
  /**
1202
825
  *
1203
- * @type {ProductType}
1204
- * @memberof Product
1205
- */
1206
- 'productType': ProductType;
1207
- /**
1208
- * Attributes associated to a product such as Colour and Size.
1209
- * @type {Array<ProductAttribute>}
1210
- * @memberof Product
1211
- */
1212
- 'attributes': Array<ProductAttribute>;
1213
- /**
1214
- * Additional data to be stored with the product
1215
- * @type {Array<Metafield>}
1216
- * @memberof Product
1217
- */
1218
- 'metafields': Array<Metafield>;
1219
- /**
1220
- * Variants
1221
- * @type {Array<ProductVariantsInner>}
1222
- * @memberof Product
1223
- */
1224
- 'variants': Array<ProductVariantsInner>;
1225
- /**
1226
- * ISO 8601 Timestamp
1227
- * @type {string}
1228
- * @memberof Product
1229
- */
1230
- 'createdAt'?: string;
1231
- /**
1232
- * ISO 8601 Timestamp
1233
826
  * @type {string}
1234
- * @memberof Product
1235
- */
1236
- 'updatedAt'?: string;
1237
- /**
1238
- * Images
1239
- * @type {Array<Image>}
1240
- * @memberof Product
827
+ * @memberof Project
1241
828
  */
1242
- 'images'?: Array<Image>;
1243
- }
1244
- /**
1245
- *
1246
- * @export
1247
- * @interface ProductAttribute
1248
- */
1249
- export interface ProductAttribute {
829
+ 'id': string;
1250
830
  /**
1251
- * Attribute name
831
+ * The name of the project
1252
832
  * @type {string}
1253
- * @memberof ProductAttribute
833
+ * @memberof Project
1254
834
  */
1255
835
  'name': string;
1256
- /**
1257
- * Position of the attribute when ordered
1258
- * @type {number}
1259
- * @memberof ProductAttribute
1260
- */
1261
- 'sortOrder': number;
1262
- /**
1263
- * Attribute values
1264
- * @type {Array<ProductAttributeValuesInner>}
1265
- * @memberof ProductAttribute
1266
- */
1267
- 'values': Array<ProductAttributeValuesInner>;
1268
836
  }
1269
837
  /**
1270
838
  *
1271
839
  * @export
1272
- * @interface ProductAttributeValuesInner
840
+ * @interface ShippingMethod
1273
841
  */
1274
- export interface ProductAttributeValuesInner {
1275
- /**
1276
- * Position of the attribute value when ordered
1277
- * @type {number}
1278
- * @memberof ProductAttributeValuesInner
1279
- */
1280
- 'sortOrder': number;
842
+ export interface ShippingMethod {
1281
843
  /**
1282
- * Value of the attribute
844
+ * Unique object identifier
1283
845
  * @type {string}
1284
- * @memberof ProductAttributeValuesInner
846
+ * @memberof ShippingMethod
1285
847
  */
1286
- 'value': string;
848
+ 'id'?: string;
1287
849
  /**
1288
850
  *
1289
- * @type {ProductAttributeValuesInnerThumbnail}
1290
- * @memberof ProductAttributeValuesInner
851
+ * @type {string}
852
+ * @memberof ShippingMethod
1291
853
  */
1292
- 'thumbnail'?: ProductAttributeValuesInnerThumbnail;
1293
- }
1294
- /**
1295
- *
1296
- * @export
1297
- * @interface ProductAttributeValuesInnerThumbnail
1298
- */
1299
- export interface ProductAttributeValuesInnerThumbnail {
1300
- /**
1301
- *
1302
- * @type {string}
1303
- * @memberof ProductAttributeValuesInnerThumbnail
1304
- */
1305
- 'type'?: ProductAttributeValuesInnerThumbnailTypeEnum;
1306
- /**
1307
- *
1308
- * @type {string}
1309
- * @memberof ProductAttributeValuesInnerThumbnail
1310
- */
1311
- 'value'?: string;
1312
- }
1313
- export declare const ProductAttributeValuesInnerThumbnailTypeEnum: {
1314
- readonly Text: "text";
1315
- readonly Color: "color";
1316
- readonly Image: "image";
1317
- };
1318
- export type ProductAttributeValuesInnerThumbnailTypeEnum = typeof ProductAttributeValuesInnerThumbnailTypeEnum[keyof typeof ProductAttributeValuesInnerThumbnailTypeEnum];
1319
- /**
1320
- *
1321
- * @export
1322
- * @interface ProductType
1323
- */
1324
- export interface ProductType {
1325
- /**
1326
- * Id of the product type
1327
- * @type {number}
1328
- * @memberof ProductType
1329
- */
1330
- 'id'?: number;
1331
- /**
1332
- * Name of the product type
1333
- * @type {string}
1334
- * @memberof ProductType
1335
- */
1336
- 'name'?: string;
1337
- }
1338
- /**
1339
- *
1340
- * @export
1341
- * @interface ProductVariantsInner
1342
- */
1343
- export interface ProductVariantsInner {
1344
- /**
1345
- * Unique object identifier
1346
- * @type {string}
1347
- * @memberof ProductVariantsInner
1348
- */
1349
- 'id'?: string;
1350
- /**
1351
- * A reference to the resource location
1352
- * @type {string}
1353
- * @memberof ProductVariantsInner
1354
- */
1355
- 'ref'?: string;
1356
- }
1357
- /**
1358
- *
1359
- * @export
1360
- * @interface Project
1361
- */
1362
- export interface Project {
1363
- /**
1364
- *
1365
- * @type {string}
1366
- * @memberof Project
1367
- */
1368
- 'id': string;
1369
- /**
1370
- * The name of the project
1371
- * @type {string}
1372
- * @memberof Project
1373
- */
1374
- 'name': string;
1375
- }
1376
- /**
1377
- *
1378
- * @export
1379
- * @interface ShippingMethod
1380
- */
1381
- export interface ShippingMethod {
1382
- /**
1383
- * Unique object identifier
1384
- * @type {string}
1385
- * @memberof ShippingMethod
1386
- */
1387
- 'id'?: string;
1388
- /**
1389
- *
1390
- * @type {string}
1391
- * @memberof ShippingMethod
1392
- */
1393
- 'name'?: string;
1394
- /**
1395
- *
1396
- * @type {string}
1397
- * @memberof ShippingMethod
1398
- */
1399
- 'description'?: string;
1400
- /**
1401
- *
1402
- * @type {DeliveryEstimates}
1403
- * @memberof ShippingMethod
1404
- */
1405
- 'deliveryEstimates'?: DeliveryEstimates;
1406
- /**
1407
- *
1408
- * @type {Price}
1409
- * @memberof ShippingMethod
1410
- */
1411
- 'totalPrice'?: Price;
1412
- /**
1413
- *
1414
- * @type {Price}
1415
- * @memberof ShippingMethod
1416
- */
1417
- 'taxPrice'?: Price;
1418
- /**
1419
- *
1420
- * @type {Price}
1421
- * @memberof ShippingMethod
1422
- */
1423
- 'subtotalPrice'?: Price;
1424
- /**
1425
- *
1426
- * @type {Price}
1427
- * @memberof ShippingMethod
1428
- */
1429
- 'discountPrice'?: Price;
1430
- }
1431
- /**
1432
- *
1433
- * @export
1434
- * @interface Statistics
1435
- */
1436
- export interface Statistics {
1437
- /**
1438
- *
1439
- * @type {number}
1440
- * @memberof Statistics
1441
- */
1442
- 'lifetimeValue': number;
1443
- /**
1444
- *
1445
- * @type {number}
1446
- * @memberof Statistics
1447
- */
1448
- 'totalOrderCount': number;
1449
- /**
1450
- *
1451
- * @type {string}
1452
- * @memberof Statistics
1453
- */
1454
- 'lastPurchased': string | null;
1455
- }
1456
- /**
1457
- *
1458
- * @export
1459
- * @interface StatusHistoryItem
1460
- */
1461
- export interface StatusHistoryItem {
1462
- /**
1463
- *
1464
- * @type {OrderStatus}
1465
- * @memberof StatusHistoryItem
1466
- */
1467
- 'status'?: OrderStatus;
1468
- /**
1469
- * ISO 8601 Timestamp
1470
- * @type {string}
1471
- * @memberof StatusHistoryItem
1472
- */
1473
- 'createdAt'?: string;
1474
- }
1475
- /**
1476
- *
1477
- * @export
1478
- * @interface UpdateFulfillmentRequest
1479
- */
1480
- export interface UpdateFulfillmentRequest {
1481
- /**
1482
- * Unique object identifier
1483
- * @type {string}
1484
- * @memberof UpdateFulfillmentRequest
1485
- */
1486
- 'fulfillerId'?: string;
1487
- }
1488
- /**
1489
- *
1490
- * @export
1491
- * @interface UpdatePlatformRequest
1492
- */
1493
- export interface UpdatePlatformRequest {
1494
- /**
1495
- *
1496
- * @type {Array<PlatformLogo>}
1497
- * @memberof UpdatePlatformRequest
1498
- */
1499
- 'logos'?: Array<PlatformLogo>;
1500
- /**
1501
- *
1502
- * @type {string}
1503
- * @memberof UpdatePlatformRequest
1504
- */
1505
- 'favicon'?: string;
1506
- /**
1507
- *
1508
- * @type {boolean}
1509
- * @memberof UpdatePlatformRequest
1510
- */
1511
- 'clientGiftWrapAvailable'?: boolean;
1512
- /**
1513
- *
1514
- * @type {number}
1515
- * @memberof UpdatePlatformRequest
1516
- */
1517
- 'storeSubscriptionFee'?: number;
1518
- /**
1519
- *
1520
- * @type {number}
1521
- * @memberof UpdatePlatformRequest
1522
- */
1523
- 'orderHandlingFee'?: number;
1524
- /**
1525
- *
1526
- * @type {number}
1527
- * @memberof UpdatePlatformRequest
1528
- */
1529
- 'itemHandlingFee'?: number;
1530
- /**
1531
- *
1532
- * @type {boolean}
1533
- * @memberof UpdatePlatformRequest
1534
- */
1535
- 'chargeClients'?: boolean;
1536
- }
1537
- /**
1538
- *
1539
- * @export
1540
- * @interface UpdateProductRequest
1541
- */
1542
- export interface UpdateProductRequest {
1543
- /**
1544
- * The warehouse variants of the product to update
1545
- * @type {Array<UpdateProductRequestVariantsInner>}
1546
- * @memberof UpdateProductRequest
1547
- */
1548
- 'variants'?: Array<UpdateProductRequestVariantsInner>;
1549
- /**
1550
- * Whether the platform warehouse product should be enabled or not
1551
- * @type {boolean}
1552
- * @memberof UpdateProductRequest
1553
- */
1554
- 'enabled'?: boolean;
1555
- }
1556
- /**
1557
- *
1558
- * @export
1559
- * @interface UpdateProductRequestVariantsInner
1560
- */
1561
- export interface UpdateProductRequestVariantsInner {
1562
- /**
1563
- * The ID of the variant to update
1564
- * @type {string}
1565
- * @memberof UpdateProductRequestVariantsInner
1566
- */
1567
- 'id': string;
1568
- /**
1569
- * Whether the warehouse variant should be enabled or not
1570
- * @type {boolean}
1571
- * @memberof UpdateProductRequestVariantsInner
1572
- */
1573
- 'enabled'?: boolean;
1574
- }
1575
- /**
1576
- *
1577
- * @export
1578
- * @interface UpdateVariantRequest
1579
- */
1580
- export interface UpdateVariantRequest {
1581
- /**
1582
- * Whether the platform warehouse variant is enabled or not
1583
- * @type {boolean}
1584
- * @memberof UpdateVariantRequest
1585
- */
1586
- 'enabled'?: boolean;
1587
- }
1588
- /**
1589
- *
1590
- * @export
1591
- * @interface ValidationError
1592
- */
1593
- export interface ValidationError {
1594
- /**
1595
- *
1596
- * @type {string}
1597
- * @memberof ValidationError
1598
- */
1599
- 'message': string;
1600
- }
1601
- /**
1602
- *
1603
- * @export
1604
- * @interface Variant
1605
- */
1606
- export interface Variant {
1607
- /**
1608
- * Unique object identifier
1609
- * @type {string}
1610
- * @memberof Variant
1611
- */
1612
- 'id': string;
1613
- /**
1614
- * A reference to the resource location
1615
- * @type {string}
1616
- * @memberof Variant
1617
- */
1618
- 'ref': string;
1619
- /**
1620
- *
1621
- * @type {ProductVariantsInner}
1622
- * @memberof Variant
1623
- */
1624
- 'product'?: ProductVariantsInner;
1625
- /**
1626
- *
1627
- * @type {string}
1628
- * @memberof Variant
1629
- */
1630
- 'sku': string;
1631
- /**
1632
- * ISO 8601 Timestamp
1633
- * @type {string}
1634
- * @memberof Variant
1635
- */
1636
- 'createdAt'?: string;
1637
- /**
1638
- * ISO 8601 Timestamp
1639
- * @type {string}
1640
- * @memberof Variant
1641
- */
1642
- 'updatedAt'?: string;
1643
- /**
1644
- * Images
1645
- * @type {Array<Image>}
1646
- * @memberof Variant
1647
- */
1648
- 'images'?: Array<Image>;
854
+ 'name'?: string;
1649
855
  /**
1650
- * Weight in kg
1651
- * @type {number}
1652
- * @memberof Variant
856
+ *
857
+ * @type {string}
858
+ * @memberof ShippingMethod
1653
859
  */
1654
- 'weight'?: number;
860
+ 'description'?: string;
1655
861
  /**
1656
- * The number of units that can be packed in a single pickface
1657
- * @type {number}
1658
- * @memberof Variant
862
+ *
863
+ * @type {DeliveryEstimates}
864
+ * @memberof ShippingMethod
1659
865
  */
1660
- 'packVolume'?: number;
866
+ 'deliveryEstimates'?: DeliveryEstimates;
1661
867
  /**
1662
868
  *
1663
- * @type {VariantPackedDimensions}
1664
- * @memberof Variant
869
+ * @type {Price}
870
+ * @memberof ShippingMethod
1665
871
  */
1666
- 'packedDimensions'?: VariantPackedDimensions;
872
+ 'totalPrice'?: Price;
1667
873
  /**
1668
- * Whether the variant can be pre-ordered
1669
- * @type {boolean}
1670
- * @memberof Variant
874
+ *
875
+ * @type {Price}
876
+ * @memberof ShippingMethod
1671
877
  */
1672
- 'preOrderable'?: boolean;
878
+ 'taxPrice'?: Price;
1673
879
  /**
1674
- * Whether the variant is enabled
1675
- * @type {boolean}
1676
- * @memberof Variant
880
+ *
881
+ * @type {Price}
882
+ * @memberof ShippingMethod
1677
883
  */
1678
- 'enabled'?: boolean;
884
+ 'subtotalPrice'?: Price;
1679
885
  /**
1680
- * Whether the variant is discontinued
1681
- * @type {boolean}
1682
- * @memberof Variant
886
+ *
887
+ * @type {Price}
888
+ * @memberof ShippingMethod
1683
889
  */
1684
- 'discontinued'?: boolean;
890
+ 'discountPrice'?: Price;
891
+ }
892
+ /**
893
+ *
894
+ * @export
895
+ * @interface Statistics
896
+ */
897
+ export interface Statistics {
1685
898
  /**
1686
899
  *
1687
- * @type {VariantManufacturerOrigin}
1688
- * @memberof Variant
900
+ * @type {number}
901
+ * @memberof Statistics
1689
902
  */
1690
- 'manufacturerOrigin'?: VariantManufacturerOrigin;
903
+ 'lifetimeValue': number;
1691
904
  /**
1692
- * 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.
1693
- * @type {Array<VariantAttribute>}
1694
- * @memberof Variant
905
+ *
906
+ * @type {number}
907
+ * @memberof Statistics
1695
908
  */
1696
- 'attributes': Array<VariantAttribute>;
909
+ 'totalOrderCount': number;
1697
910
  /**
1698
- * Applications of the variant
1699
- * @type {Array<Application>}
1700
- * @memberof Variant
911
+ *
912
+ * @type {string}
913
+ * @memberof Statistics
1701
914
  */
1702
- 'applications'?: Array<Application>;
915
+ 'lastPurchased': string | null;
1703
916
  }
1704
917
  /**
1705
918
  *
1706
919
  * @export
1707
- * @interface Variant1
920
+ * @interface StatusHistoryItem
1708
921
  */
1709
- export interface Variant1 {
922
+ export interface StatusHistoryItem {
1710
923
  /**
1711
- * Unique object identifier
1712
- * @type {string}
1713
- * @memberof Variant1
924
+ *
925
+ * @type {OrderStatus}
926
+ * @memberof StatusHistoryItem
1714
927
  */
1715
- 'id': string;
928
+ 'status'?: OrderStatus;
1716
929
  /**
1717
- * A reference to the resource location
930
+ * ISO 8601 Timestamp
1718
931
  * @type {string}
1719
- * @memberof Variant1
932
+ * @memberof StatusHistoryItem
1720
933
  */
1721
- 'ref': string;
934
+ 'createdAt'?: string;
935
+ }
936
+ /**
937
+ *
938
+ * @export
939
+ * @interface UpdateFulfillmentRequest
940
+ */
941
+ export interface UpdateFulfillmentRequest {
1722
942
  /**
1723
- * A reference to the resource location
943
+ * Unique object identifier
1724
944
  * @type {string}
1725
- * @memberof Variant1
945
+ * @memberof UpdateFulfillmentRequest
1726
946
  */
1727
- 'warehouseVariantRef': string;
947
+ 'fulfillerId'?: string;
1728
948
  }
1729
949
  /**
1730
950
  *
1731
951
  * @export
1732
- * @interface VariantAttribute
952
+ * @interface UpdatePlatformRequest
1733
953
  */
1734
- export interface VariantAttribute {
954
+ export interface UpdatePlatformRequest {
1735
955
  /**
1736
- * Attribute name
1737
- * @type {string}
1738
- * @memberof VariantAttribute
956
+ *
957
+ * @type {Array<PlatformLogo>}
958
+ * @memberof UpdatePlatformRequest
1739
959
  */
1740
- 'name': string;
960
+ 'logos'?: Array<PlatformLogo>;
1741
961
  /**
1742
- * Attribute value
962
+ *
1743
963
  * @type {string}
1744
- * @memberof VariantAttribute
964
+ * @memberof UpdatePlatformRequest
1745
965
  */
1746
- 'value': string;
966
+ 'favicon'?: string;
967
+ /**
968
+ *
969
+ * @type {boolean}
970
+ * @memberof UpdatePlatformRequest
971
+ */
972
+ 'clientGiftWrapAvailable'?: boolean;
1747
973
  /**
1748
974
  *
1749
- * @type {VariantAttributeThumbnail}
1750
- * @memberof VariantAttribute
975
+ * @type {number}
976
+ * @memberof UpdatePlatformRequest
1751
977
  */
1752
- 'thumbnail'?: VariantAttributeThumbnail;
978
+ 'storeSubscriptionFee'?: number;
1753
979
  /**
1754
- * Attribute tags
1755
- * @type {Array<string>}
1756
- * @memberof VariantAttribute
980
+ *
981
+ * @type {number}
982
+ * @memberof UpdatePlatformRequest
1757
983
  */
1758
- 'tags'?: Array<string>;
1759
- }
1760
- /**
1761
- * Attribute thumbnail
1762
- * @export
1763
- * @interface VariantAttributeThumbnail
1764
- */
1765
- export interface VariantAttributeThumbnail {
984
+ 'orderHandlingFee'?: number;
1766
985
  /**
1767
986
  *
1768
- * @type {string}
1769
- * @memberof VariantAttributeThumbnail
987
+ * @type {number}
988
+ * @memberof UpdatePlatformRequest
1770
989
  */
1771
- 'type'?: VariantAttributeThumbnailTypeEnum;
990
+ 'itemHandlingFee'?: number;
1772
991
  /**
1773
992
  *
1774
- * @type {string}
1775
- * @memberof VariantAttributeThumbnail
993
+ * @type {boolean}
994
+ * @memberof UpdatePlatformRequest
1776
995
  */
1777
- 'value'?: string;
996
+ 'chargeClients'?: boolean;
1778
997
  }
1779
- export declare const VariantAttributeThumbnailTypeEnum: {
1780
- readonly Text: "text";
1781
- readonly Color: "color";
1782
- readonly Image: "image";
1783
- };
1784
- export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
1785
998
  /**
1786
- * Where the product was originally produced or manufactured
999
+ *
1787
1000
  * @export
1788
- * @interface VariantManufacturerOrigin
1001
+ * @interface ValidationError
1789
1002
  */
1790
- export interface VariantManufacturerOrigin {
1003
+ export interface ValidationError {
1791
1004
  /**
1792
- * Country of origin (ISO 3166-1 alpha-2).
1005
+ *
1793
1006
  * @type {string}
1794
- * @memberof VariantManufacturerOrigin
1007
+ * @memberof ValidationError
1795
1008
  */
1796
- 'country'?: string;
1009
+ 'message': string;
1797
1010
  }
1798
1011
  /**
1799
1012
  *
1800
1013
  * @export
1801
- * @interface VariantPackedDimensions
1014
+ * @interface Variant
1802
1015
  */
1803
- export interface VariantPackedDimensions {
1016
+ export interface Variant {
1804
1017
  /**
1805
- * Length in mm
1806
- * @type {number}
1807
- * @memberof VariantPackedDimensions
1018
+ * Unique object identifier
1019
+ * @type {string}
1020
+ * @memberof Variant
1808
1021
  */
1809
- 'length'?: number;
1022
+ 'id': string;
1810
1023
  /**
1811
- * Width in mm
1812
- * @type {number}
1813
- * @memberof VariantPackedDimensions
1024
+ * A reference to the resource location
1025
+ * @type {string}
1026
+ * @memberof Variant
1814
1027
  */
1815
- 'width'?: number;
1028
+ 'ref': string;
1816
1029
  /**
1817
- * Depth in mm
1818
- * @type {number}
1819
- * @memberof VariantPackedDimensions
1030
+ * A reference to the resource location
1031
+ * @type {string}
1032
+ * @memberof Variant
1820
1033
  */
1821
- 'depth'?: number;
1034
+ 'warehouseVariantRef': string;
1822
1035
  }
1823
1036
  /**
1824
1037
  * CustomersApi - axios parameter creator
@@ -2905,195 +2118,3 @@ export declare class PlatformApi extends BaseAPI {
2905
2118
  */
2906
2119
  updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
2907
2120
  }
2908
- /**
2909
- * ProductsApi - axios parameter creator
2910
- * @export
2911
- */
2912
- export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
2913
- /**
2914
- * Updates the warehouse product and its variants
2915
- * @summary Update warehouse product
2916
- * @param {string} project Project unique identifier
2917
- * @param {string} platformId The platform identifier
2918
- * @param {string} productId Products unique identifier
2919
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
2920
- * @param {*} [options] Override http request option.
2921
- * @throws {RequiredError}
2922
- */
2923
- updateProduct: (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2924
- };
2925
- /**
2926
- * ProductsApi - functional programming interface
2927
- * @export
2928
- */
2929
- export declare const ProductsApiFp: (configuration?: Configuration) => {
2930
- /**
2931
- * Updates the warehouse product and its variants
2932
- * @summary Update warehouse product
2933
- * @param {string} project Project unique identifier
2934
- * @param {string} platformId The platform identifier
2935
- * @param {string} productId Products unique identifier
2936
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
2937
- * @param {*} [options] Override http request option.
2938
- * @throws {RequiredError}
2939
- */
2940
- updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
2941
- };
2942
- /**
2943
- * ProductsApi - factory interface
2944
- * @export
2945
- */
2946
- export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2947
- /**
2948
- * Updates the warehouse product and its variants
2949
- * @summary Update warehouse product
2950
- * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
2951
- * @param {*} [options] Override http request option.
2952
- * @throws {RequiredError}
2953
- */
2954
- updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
2955
- };
2956
- /**
2957
- * Request parameters for updateProduct operation in ProductsApi.
2958
- * @export
2959
- * @interface ProductsApiUpdateProductRequest
2960
- */
2961
- export interface ProductsApiUpdateProductRequest {
2962
- /**
2963
- * Project unique identifier
2964
- * @type {string}
2965
- * @memberof ProductsApiUpdateProduct
2966
- */
2967
- readonly project: string;
2968
- /**
2969
- * The platform identifier
2970
- * @type {string}
2971
- * @memberof ProductsApiUpdateProduct
2972
- */
2973
- readonly platformId: string;
2974
- /**
2975
- * Products unique identifier
2976
- * @type {string}
2977
- * @memberof ProductsApiUpdateProduct
2978
- */
2979
- readonly productId: string;
2980
- /**
2981
- * Update a platform warehouse product
2982
- * @type {UpdateProductRequest}
2983
- * @memberof ProductsApiUpdateProduct
2984
- */
2985
- readonly updateProductRequest: UpdateProductRequest;
2986
- }
2987
- /**
2988
- * ProductsApi - object-oriented interface
2989
- * @export
2990
- * @class ProductsApi
2991
- * @extends {BaseAPI}
2992
- */
2993
- export declare class ProductsApi extends BaseAPI {
2994
- /**
2995
- * Updates the warehouse product and its variants
2996
- * @summary Update warehouse product
2997
- * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
2998
- * @param {*} [options] Override http request option.
2999
- * @throws {RequiredError}
3000
- * @memberof ProductsApi
3001
- */
3002
- updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
3003
- }
3004
- /**
3005
- * VariantsApi - axios parameter creator
3006
- * @export
3007
- */
3008
- export declare const VariantsApiAxiosParamCreator: (configuration?: Configuration) => {
3009
- /**
3010
- * Updates the warehouse variant
3011
- * @summary Update warehouse variant
3012
- * @param {string} project Project unique identifier
3013
- * @param {string} platformId The platform identifier
3014
- * @param {string} variantId Variants unique identifier
3015
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
3016
- * @param {*} [options] Override http request option.
3017
- * @throws {RequiredError}
3018
- */
3019
- updateVariant: (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3020
- };
3021
- /**
3022
- * VariantsApi - functional programming interface
3023
- * @export
3024
- */
3025
- export declare const VariantsApiFp: (configuration?: Configuration) => {
3026
- /**
3027
- * Updates the warehouse variant
3028
- * @summary Update warehouse variant
3029
- * @param {string} project Project unique identifier
3030
- * @param {string} platformId The platform identifier
3031
- * @param {string} variantId Variants unique identifier
3032
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
3033
- * @param {*} [options] Override http request option.
3034
- * @throws {RequiredError}
3035
- */
3036
- updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>>;
3037
- };
3038
- /**
3039
- * VariantsApi - factory interface
3040
- * @export
3041
- */
3042
- export declare const VariantsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3043
- /**
3044
- * Updates the warehouse variant
3045
- * @summary Update warehouse variant
3046
- * @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
3047
- * @param {*} [options] Override http request option.
3048
- * @throws {RequiredError}
3049
- */
3050
- updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
3051
- };
3052
- /**
3053
- * Request parameters for updateVariant operation in VariantsApi.
3054
- * @export
3055
- * @interface VariantsApiUpdateVariantRequest
3056
- */
3057
- export interface VariantsApiUpdateVariantRequest {
3058
- /**
3059
- * Project unique identifier
3060
- * @type {string}
3061
- * @memberof VariantsApiUpdateVariant
3062
- */
3063
- readonly project: string;
3064
- /**
3065
- * The platform identifier
3066
- * @type {string}
3067
- * @memberof VariantsApiUpdateVariant
3068
- */
3069
- readonly platformId: string;
3070
- /**
3071
- * Variants unique identifier
3072
- * @type {string}
3073
- * @memberof VariantsApiUpdateVariant
3074
- */
3075
- readonly variantId: string;
3076
- /**
3077
- * Update a platform warehouse variant
3078
- * @type {UpdateVariantRequest}
3079
- * @memberof VariantsApiUpdateVariant
3080
- */
3081
- readonly updateVariantRequest: UpdateVariantRequest;
3082
- }
3083
- /**
3084
- * VariantsApi - object-oriented interface
3085
- * @export
3086
- * @class VariantsApi
3087
- * @extends {BaseAPI}
3088
- */
3089
- export declare class VariantsApi extends BaseAPI {
3090
- /**
3091
- * Updates the warehouse variant
3092
- * @summary Update warehouse variant
3093
- * @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
3094
- * @param {*} [options] Override http request option.
3095
- * @throws {RequiredError}
3096
- * @memberof VariantsApi
3097
- */
3098
- updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
3099
- }