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