@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/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.14.3
7
+ * The version of the OpenAPI document: 0.15.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -97,62 +97,6 @@ export interface ApiError {
97
97
  */
98
98
  'message': string;
99
99
  }
100
- /**
101
- * Application of a variant
102
- * @export
103
- * @interface Application
104
- */
105
- export interface Application {
106
- /**
107
- * Placement of the application
108
- * @type {string}
109
- * @memberof Application
110
- */
111
- 'placement': string;
112
- /**
113
- *
114
- * @type {ApplicationTechnology}
115
- * @memberof Application
116
- */
117
- 'technology'?: ApplicationTechnology | null;
118
- /**
119
- *
120
- * @type {Mockup}
121
- * @memberof Application
122
- */
123
- 'mockup': Mockup;
124
- /**
125
- *
126
- * @type {Output}
127
- * @memberof Application
128
- */
129
- 'output'?: Output;
130
- /**
131
- * Whether the application requires pretreatment
132
- * @type {boolean}
133
- * @memberof Application
134
- */
135
- 'requiresPretreat'?: boolean;
136
- }
137
- /**
138
- * Technology to be used for the application
139
- * @export
140
- * @interface ApplicationTechnology
141
- */
142
- export interface ApplicationTechnology {
143
- /**
144
- * Unique object identifier
145
- * @type {string}
146
- * @memberof ApplicationTechnology
147
- */
148
- 'id'?: string;
149
- /**
150
- * A reference to the resource location
151
- * @type {string}
152
- * @memberof ApplicationTechnology
153
- */
154
- 'ref'?: string;
155
- }
156
100
  /**
157
101
  *
158
102
  * @export
@@ -455,87 +399,6 @@ export interface Image {
455
399
  */
456
400
  'sortOrder'?: number;
457
401
  }
458
- /**
459
- *
460
- * @export
461
- * @interface Metafield
462
- */
463
- export interface Metafield {
464
- /**
465
- * The unique identifier for a meta field
466
- * @type {string}
467
- * @memberof Metafield
468
- */
469
- 'key': string;
470
- /**
471
- * The data stored in the meta field. Always stored as a string, regardless of the meta field\'s type.
472
- * @type {string}
473
- * @memberof Metafield
474
- */
475
- 'value': string;
476
- }
477
- /**
478
- * Configuration of the product mockup
479
- * @export
480
- * @interface Mockup
481
- */
482
- export interface Mockup {
483
- /**
484
- * Base image of the mockup
485
- * @type {string}
486
- * @memberof Mockup
487
- */
488
- 'baseImage': string;
489
- /**
490
- *
491
- * @type {MockupDesignPlacement}
492
- * @memberof Mockup
493
- */
494
- 'designPlacement'?: MockupDesignPlacement | null;
495
- /**
496
- * Optional mask applied to the design. Used for products with non-rectangular print areas
497
- * @type {string}
498
- * @memberof Mockup
499
- */
500
- 'designMask'?: string | null;
501
- /**
502
- * 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.
503
- * @type {string}
504
- * @memberof Mockup
505
- */
506
- 'overlayImage'?: string | null;
507
- }
508
- /**
509
- * Design placement
510
- * @export
511
- * @interface MockupDesignPlacement
512
- */
513
- export interface MockupDesignPlacement {
514
- /**
515
- * X coordinate in pixels
516
- * @type {number}
517
- * @memberof MockupDesignPlacement
518
- */
519
- 'x': number;
520
- /**
521
- * Y coordinate in pixels
522
- * @type {number}
523
- * @memberof MockupDesignPlacement
524
- */
525
- 'y': number;
526
- /**
527
- * Width in pixels
528
- * @type {number}
529
- * @memberof MockupDesignPlacement
530
- */
531
- 'width': number;
532
- /**
533
- * Height in pixels
534
- * @type {number}
535
- * @memberof MockupDesignPlacement
536
- */
537
- 'height': number;
538
- }
539
402
  /**
540
403
  *
541
404
  * @export
@@ -693,10 +556,10 @@ export interface OrderItem {
693
556
  'variantRef': string;
694
557
  /**
695
558
  *
696
- * @type {Variant1}
559
+ * @type {Variant}
697
560
  * @memberof OrderItem
698
561
  */
699
- 'variant': Variant1;
562
+ 'variant': Variant;
700
563
  /**
701
564
  * Options associated to an order item\'s variant, such as color and size.
702
565
  * @type {Array<Option>}
@@ -832,178 +695,6 @@ export interface Origin {
832
695
  */
833
696
  'isPaid'?: boolean;
834
697
  }
835
- /**
836
- * Configuration of the files output for this application
837
- * @export
838
- * @interface Output
839
- */
840
- export interface Output {
841
- /**
842
- * Width of the print file in pixels
843
- * @type {number}
844
- * @memberof Output
845
- */
846
- 'width': number;
847
- /**
848
- * Height of the print file in pixels
849
- * @type {number}
850
- * @memberof Output
851
- */
852
- 'height': number;
853
- /**
854
- * DPI of the print file in pixels
855
- * @type {number}
856
- * @memberof Output
857
- */
858
- 'dpi': number;
859
- /**
860
- *
861
- * @type {OutputPadding}
862
- * @memberof Output
863
- */
864
- 'padding'?: OutputPadding;
865
- /**
866
- * Position of the print
867
- * @type {string}
868
- * @memberof Output
869
- */
870
- 'position': OutputPositionEnum;
871
- /**
872
- * Whether the print should be mirrored horizontally
873
- * @type {boolean}
874
- * @memberof Output
875
- */
876
- 'mirrorX'?: boolean;
877
- /**
878
- * Whether the print should be mirrored vertically
879
- * @type {boolean}
880
- * @memberof Output
881
- */
882
- 'mirrorY'?: boolean;
883
- /**
884
- * Amount of reflection in pixels
885
- * @type {number}
886
- * @memberof Output
887
- */
888
- 'reflect'?: number;
889
- /**
890
- * Amount to extend the print in pixels
891
- * @type {number}
892
- * @memberof Output
893
- */
894
- 'extend'?: number;
895
- /**
896
- * Rotation in degrees
897
- * @type {number}
898
- * @memberof Output
899
- */
900
- 'rotate'?: number;
901
- /**
902
- * Format of the print file
903
- * @type {string}
904
- * @memberof Output
905
- */
906
- 'fileFormat': OutputFileFormatEnum;
907
- /**
908
- *
909
- * @type {Array<OutputDeviceConfigsInner>}
910
- * @memberof Output
911
- */
912
- 'deviceConfigs'?: Array<OutputDeviceConfigsInner>;
913
- }
914
-
915
- export const OutputPositionEnum = {
916
- Center: 'center',
917
- Top: 'top',
918
- Left: 'left',
919
- Bottom: 'bottom',
920
- Right: 'right',
921
- RightTop: 'right-top',
922
- RightBottom: 'right-bottom',
923
- LeftTop: 'left-top',
924
- LeftBottom: 'left-bottom'
925
- } as const;
926
-
927
- export type OutputPositionEnum = typeof OutputPositionEnum[keyof typeof OutputPositionEnum];
928
- export const OutputFileFormatEnum = {
929
- Png: 'png',
930
- Jpg: 'jpg',
931
- Jpeg: 'jpeg',
932
- Webp: 'webp',
933
- Pdf: 'pdf'
934
- } as const;
935
-
936
- export type OutputFileFormatEnum = typeof OutputFileFormatEnum[keyof typeof OutputFileFormatEnum];
937
-
938
- /**
939
- *
940
- * @export
941
- * @interface OutputDeviceConfigsInner
942
- */
943
- export interface OutputDeviceConfigsInner {
944
- /**
945
- * Unique object identifier
946
- * @type {string}
947
- * @memberof OutputDeviceConfigsInner
948
- */
949
- 'modelId'?: string;
950
- /**
951
- *
952
- * @type {Array<OutputDeviceConfigsInnerPropertiesInner>}
953
- * @memberof OutputDeviceConfigsInner
954
- */
955
- 'properties'?: Array<OutputDeviceConfigsInnerPropertiesInner>;
956
- }
957
- /**
958
- *
959
- * @export
960
- * @interface OutputDeviceConfigsInnerPropertiesInner
961
- */
962
- export interface OutputDeviceConfigsInnerPropertiesInner {
963
- /**
964
- *
965
- * @type {string}
966
- * @memberof OutputDeviceConfigsInnerPropertiesInner
967
- */
968
- 'name'?: string;
969
- /**
970
- *
971
- * @type {string}
972
- * @memberof OutputDeviceConfigsInnerPropertiesInner
973
- */
974
- 'option'?: string;
975
- }
976
- /**
977
- * Padding to be applied to the print file
978
- * @export
979
- * @interface OutputPadding
980
- */
981
- export interface OutputPadding {
982
- /**
983
- * Top padding in pixels
984
- * @type {number}
985
- * @memberof OutputPadding
986
- */
987
- 'top': number;
988
- /**
989
- * Right padding in pixels
990
- * @type {number}
991
- * @memberof OutputPadding
992
- */
993
- 'right': number;
994
- /**
995
- * Bottom padding in pixels
996
- * @type {number}
997
- * @memberof OutputPadding
998
- */
999
- 'bottom': number;
1000
- /**
1001
- * Left padding in pixels
1002
- * @type {number}
1003
- * @memberof OutputPadding
1004
- */
1005
- 'left': number;
1006
- }
1007
698
  /**
1008
699
  *
1009
700
  * @export
@@ -1096,6 +787,12 @@ export interface Platform {
1096
787
  * @memberof Platform
1097
788
  */
1098
789
  'itemHandlingFee': number;
790
+ /**
791
+ * Whether the platform can charge clients for orders
792
+ * @type {boolean}
793
+ * @memberof Platform
794
+ */
795
+ 'chargeClients': boolean;
1099
796
  }
1100
797
  /**
1101
798
  *
@@ -1135,243 +832,6 @@ export interface Price {
1135
832
  */
1136
833
  'currencyCode'?: string;
1137
834
  }
1138
- /**
1139
- *
1140
- * @export
1141
- * @interface Product
1142
- */
1143
- export interface Product {
1144
- /**
1145
- * Unique object identifier
1146
- * @type {string}
1147
- * @memberof Product
1148
- */
1149
- 'id': string;
1150
- /**
1151
- * A reference to the resource location
1152
- * @type {string}
1153
- * @memberof Product
1154
- */
1155
- 'ref': string;
1156
- /**
1157
- *
1158
- * @type {string}
1159
- * @memberof Product
1160
- */
1161
- 'title': string;
1162
- /**
1163
- * Whether the product is enabled
1164
- * @type {boolean}
1165
- * @memberof Product
1166
- */
1167
- 'enabled'?: boolean;
1168
- /**
1169
- * Whether stock levels should be tracked for this product
1170
- * @type {boolean}
1171
- * @memberof Product
1172
- */
1173
- 'trackInventory'?: boolean;
1174
- /**
1175
- * Whether this product should always be purchasable, regardless of factory stock levels
1176
- * @type {boolean}
1177
- * @memberof Product
1178
- */
1179
- 'alwaysInStock'?: boolean;
1180
- /**
1181
- *
1182
- * @type {string}
1183
- * @memberof Product
1184
- */
1185
- 'sku'?: string;
1186
- /**
1187
- * Tariff code of the product
1188
- * @type {number}
1189
- * @memberof Product
1190
- */
1191
- 'tariffCode'?: number;
1192
- /**
1193
- * Brand of the product
1194
- * @type {string}
1195
- * @memberof Product
1196
- */
1197
- 'brand'?: string;
1198
- /**
1199
- * The owner of the product
1200
- * @type {string}
1201
- * @memberof Product
1202
- */
1203
- 'ownerId': string;
1204
- /**
1205
- * Description of the product
1206
- * @type {string}
1207
- * @memberof Product
1208
- */
1209
- 'description'?: string;
1210
- /**
1211
- * Specifications of the product
1212
- * @type {string}
1213
- * @memberof Product
1214
- */
1215
- 'specifications'?: string;
1216
- /**
1217
- *
1218
- * @type {ProductType}
1219
- * @memberof Product
1220
- */
1221
- 'productType': ProductType;
1222
- /**
1223
- * Attributes associated to a product such as Colour and Size.
1224
- * @type {Array<ProductAttribute>}
1225
- * @memberof Product
1226
- */
1227
- 'attributes': Array<ProductAttribute>;
1228
- /**
1229
- * Additional data to be stored with the product
1230
- * @type {Array<Metafield>}
1231
- * @memberof Product
1232
- */
1233
- 'metafields': Array<Metafield>;
1234
- /**
1235
- * Variants
1236
- * @type {Array<ProductVariantsInner>}
1237
- * @memberof Product
1238
- */
1239
- 'variants': Array<ProductVariantsInner>;
1240
- /**
1241
- * ISO 8601 Timestamp
1242
- * @type {string}
1243
- * @memberof Product
1244
- */
1245
- 'createdAt'?: string;
1246
- /**
1247
- * ISO 8601 Timestamp
1248
- * @type {string}
1249
- * @memberof Product
1250
- */
1251
- 'updatedAt'?: string;
1252
- /**
1253
- * Images
1254
- * @type {Array<Image>}
1255
- * @memberof Product
1256
- */
1257
- 'images'?: Array<Image>;
1258
- }
1259
- /**
1260
- *
1261
- * @export
1262
- * @interface ProductAttribute
1263
- */
1264
- export interface ProductAttribute {
1265
- /**
1266
- * Attribute name
1267
- * @type {string}
1268
- * @memberof ProductAttribute
1269
- */
1270
- 'name': string;
1271
- /**
1272
- * Position of the attribute when ordered
1273
- * @type {number}
1274
- * @memberof ProductAttribute
1275
- */
1276
- 'sortOrder': number;
1277
- /**
1278
- * Attribute values
1279
- * @type {Array<ProductAttributeValuesInner>}
1280
- * @memberof ProductAttribute
1281
- */
1282
- 'values': Array<ProductAttributeValuesInner>;
1283
- }
1284
- /**
1285
- *
1286
- * @export
1287
- * @interface ProductAttributeValuesInner
1288
- */
1289
- export interface ProductAttributeValuesInner {
1290
- /**
1291
- * Position of the attribute value when ordered
1292
- * @type {number}
1293
- * @memberof ProductAttributeValuesInner
1294
- */
1295
- 'sortOrder': number;
1296
- /**
1297
- * Value of the attribute
1298
- * @type {string}
1299
- * @memberof ProductAttributeValuesInner
1300
- */
1301
- 'value': string;
1302
- /**
1303
- *
1304
- * @type {ProductAttributeValuesInnerThumbnail}
1305
- * @memberof ProductAttributeValuesInner
1306
- */
1307
- 'thumbnail'?: ProductAttributeValuesInnerThumbnail;
1308
- }
1309
- /**
1310
- *
1311
- * @export
1312
- * @interface ProductAttributeValuesInnerThumbnail
1313
- */
1314
- export interface ProductAttributeValuesInnerThumbnail {
1315
- /**
1316
- *
1317
- * @type {string}
1318
- * @memberof ProductAttributeValuesInnerThumbnail
1319
- */
1320
- 'type'?: ProductAttributeValuesInnerThumbnailTypeEnum;
1321
- /**
1322
- *
1323
- * @type {string}
1324
- * @memberof ProductAttributeValuesInnerThumbnail
1325
- */
1326
- 'value'?: string;
1327
- }
1328
-
1329
- export const ProductAttributeValuesInnerThumbnailTypeEnum = {
1330
- Text: 'text',
1331
- Color: 'color',
1332
- Image: 'image'
1333
- } as const;
1334
-
1335
- export type ProductAttributeValuesInnerThumbnailTypeEnum = typeof ProductAttributeValuesInnerThumbnailTypeEnum[keyof typeof ProductAttributeValuesInnerThumbnailTypeEnum];
1336
-
1337
- /**
1338
- *
1339
- * @export
1340
- * @interface ProductType
1341
- */
1342
- export interface ProductType {
1343
- /**
1344
- * Id of the product type
1345
- * @type {number}
1346
- * @memberof ProductType
1347
- */
1348
- 'id'?: number;
1349
- /**
1350
- * Name of the product type
1351
- * @type {string}
1352
- * @memberof ProductType
1353
- */
1354
- 'name'?: string;
1355
- }
1356
- /**
1357
- *
1358
- * @export
1359
- * @interface ProductVariantsInner
1360
- */
1361
- export interface ProductVariantsInner {
1362
- /**
1363
- * Unique object identifier
1364
- * @type {string}
1365
- * @memberof ProductVariantsInner
1366
- */
1367
- 'id'?: string;
1368
- /**
1369
- * A reference to the resource location
1370
- * @type {string}
1371
- * @memberof ProductVariantsInner
1372
- */
1373
- 'ref'?: string;
1374
- }
1375
835
  /**
1376
836
  *
1377
837
  * @export
@@ -1547,295 +1007,50 @@ export interface UpdatePlatformRequest {
1547
1007
  * @memberof UpdatePlatformRequest
1548
1008
  */
1549
1009
  'itemHandlingFee'?: number;
1550
- }
1551
- /**
1552
- *
1553
- * @export
1554
- * @interface UpdateProductRequest
1555
- */
1556
- export interface UpdateProductRequest {
1557
- /**
1558
- * The warehouse variants of the product to update
1559
- * @type {Array<UpdateProductRequestVariantsInner>}
1560
- * @memberof UpdateProductRequest
1561
- */
1562
- 'variants'?: Array<UpdateProductRequestVariantsInner>;
1563
- /**
1564
- * Whether the platform warehouse product should be enabled or not
1565
- * @type {boolean}
1566
- * @memberof UpdateProductRequest
1567
- */
1568
- 'enabled'?: boolean;
1569
- }
1570
- /**
1571
- *
1572
- * @export
1573
- * @interface UpdateProductRequestVariantsInner
1574
- */
1575
- export interface UpdateProductRequestVariantsInner {
1576
- /**
1577
- * The ID of the variant to update
1578
- * @type {string}
1579
- * @memberof UpdateProductRequestVariantsInner
1580
- */
1581
- 'id': string;
1582
- /**
1583
- * Whether the warehouse variant should be enabled or not
1584
- * @type {boolean}
1585
- * @memberof UpdateProductRequestVariantsInner
1586
- */
1587
- 'enabled'?: boolean;
1588
- }
1589
- /**
1590
- *
1591
- * @export
1592
- * @interface UpdateVariantRequest
1593
- */
1594
- export interface UpdateVariantRequest {
1595
- /**
1596
- * Whether the platform warehouse variant is enabled or not
1597
- * @type {boolean}
1598
- * @memberof UpdateVariantRequest
1599
- */
1600
- 'enabled'?: boolean;
1601
- }
1602
- /**
1603
- *
1604
- * @export
1605
- * @interface ValidationError
1606
- */
1607
- export interface ValidationError {
1608
1010
  /**
1609
1011
  *
1610
- * @type {string}
1611
- * @memberof ValidationError
1612
- */
1613
- 'message': string;
1614
- }
1615
- /**
1616
- *
1617
- * @export
1618
- * @interface Variant
1619
- */
1620
- export interface Variant {
1621
- /**
1622
- * Unique object identifier
1623
- * @type {string}
1624
- * @memberof Variant
1625
- */
1626
- 'id': string;
1627
- /**
1628
- * A reference to the resource location
1629
- * @type {string}
1630
- * @memberof Variant
1631
- */
1632
- 'ref': string;
1633
- /**
1634
- *
1635
- * @type {ProductVariantsInner}
1636
- * @memberof Variant
1637
- */
1638
- 'product'?: ProductVariantsInner;
1639
- /**
1640
- *
1641
- * @type {string}
1642
- * @memberof Variant
1643
- */
1644
- 'sku': string;
1645
- /**
1646
- * ISO 8601 Timestamp
1647
- * @type {string}
1648
- * @memberof Variant
1649
- */
1650
- 'createdAt'?: string;
1651
- /**
1652
- * ISO 8601 Timestamp
1653
- * @type {string}
1654
- * @memberof Variant
1655
- */
1656
- 'updatedAt'?: string;
1657
- /**
1658
- * Images
1659
- * @type {Array<Image>}
1660
- * @memberof Variant
1661
- */
1662
- 'images'?: Array<Image>;
1663
- /**
1664
- * Weight in kg
1665
- * @type {number}
1666
- * @memberof Variant
1667
- */
1668
- 'weight'?: number;
1669
- /**
1670
- * The number of units that can be packed in a single pickface
1671
- * @type {number}
1672
- * @memberof Variant
1673
- */
1674
- 'packVolume'?: number;
1675
- /**
1676
- *
1677
- * @type {VariantPackedDimensions}
1678
- * @memberof Variant
1679
- */
1680
- 'packedDimensions'?: VariantPackedDimensions;
1681
- /**
1682
- * Whether the variant can be pre-ordered
1683
1012
  * @type {boolean}
1684
- * @memberof Variant
1685
- */
1686
- 'preOrderable'?: boolean;
1687
- /**
1688
- * Whether the variant is enabled
1689
- * @type {boolean}
1690
- * @memberof Variant
1691
- */
1692
- 'enabled'?: boolean;
1693
- /**
1694
- * Whether the variant is discontinued
1695
- * @type {boolean}
1696
- * @memberof Variant
1697
- */
1698
- 'discontinued'?: boolean;
1699
- /**
1700
- *
1701
- * @type {VariantManufacturerOrigin}
1702
- * @memberof Variant
1703
- */
1704
- 'manufacturerOrigin'?: VariantManufacturerOrigin;
1705
- /**
1706
- * 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.
1707
- * @type {Array<VariantAttribute>}
1708
- * @memberof Variant
1709
- */
1710
- 'attributes': Array<VariantAttribute>;
1711
- /**
1712
- * Applications of the variant
1713
- * @type {Array<Application>}
1714
- * @memberof Variant
1715
- */
1716
- 'applications'?: Array<Application>;
1717
- }
1718
- /**
1719
- *
1720
- * @export
1721
- * @interface Variant1
1722
- */
1723
- export interface Variant1 {
1724
- /**
1725
- * Unique object identifier
1726
- * @type {string}
1727
- * @memberof Variant1
1728
- */
1729
- 'id': string;
1730
- /**
1731
- * A reference to the resource location
1732
- * @type {string}
1733
- * @memberof Variant1
1734
- */
1735
- 'ref': string;
1736
- /**
1737
- * A reference to the resource location
1738
- * @type {string}
1739
- * @memberof Variant1
1740
- */
1741
- 'warehouseVariantRef': string;
1742
- }
1743
- /**
1744
- *
1745
- * @export
1746
- * @interface VariantAttribute
1747
- */
1748
- export interface VariantAttribute {
1749
- /**
1750
- * Attribute name
1751
- * @type {string}
1752
- * @memberof VariantAttribute
1753
- */
1754
- 'name': string;
1755
- /**
1756
- * Attribute value
1757
- * @type {string}
1758
- * @memberof VariantAttribute
1759
- */
1760
- 'value': string;
1761
- /**
1762
- *
1763
- * @type {VariantAttributeThumbnail}
1764
- * @memberof VariantAttribute
1765
- */
1766
- 'thumbnail'?: VariantAttributeThumbnail;
1767
- /**
1768
- * Attribute tags
1769
- * @type {Array<string>}
1770
- * @memberof VariantAttribute
1771
- */
1772
- 'tags'?: Array<string>;
1773
- }
1774
- /**
1775
- * Attribute thumbnail
1776
- * @export
1777
- * @interface VariantAttributeThumbnail
1778
- */
1779
- export interface VariantAttributeThumbnail {
1780
- /**
1781
- *
1782
- * @type {string}
1783
- * @memberof VariantAttributeThumbnail
1784
- */
1785
- 'type'?: VariantAttributeThumbnailTypeEnum;
1786
- /**
1787
- *
1788
- * @type {string}
1789
- * @memberof VariantAttributeThumbnail
1790
- */
1791
- 'value'?: string;
1792
- }
1793
-
1794
- export const VariantAttributeThumbnailTypeEnum = {
1795
- Text: 'text',
1796
- Color: 'color',
1797
- Image: 'image'
1798
- } as const;
1799
-
1800
- export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
1801
-
1013
+ * @memberof UpdatePlatformRequest
1014
+ */
1015
+ 'chargeClients'?: boolean;
1016
+ }
1802
1017
  /**
1803
- * Where the product was originally produced or manufactured
1018
+ *
1804
1019
  * @export
1805
- * @interface VariantManufacturerOrigin
1020
+ * @interface ValidationError
1806
1021
  */
1807
- export interface VariantManufacturerOrigin {
1022
+ export interface ValidationError {
1808
1023
  /**
1809
- * Country of origin (ISO 3166-1 alpha-2).
1024
+ *
1810
1025
  * @type {string}
1811
- * @memberof VariantManufacturerOrigin
1026
+ * @memberof ValidationError
1812
1027
  */
1813
- 'country'?: string;
1028
+ 'message': string;
1814
1029
  }
1815
1030
  /**
1816
1031
  *
1817
1032
  * @export
1818
- * @interface VariantPackedDimensions
1033
+ * @interface Variant
1819
1034
  */
1820
- export interface VariantPackedDimensions {
1035
+ export interface Variant {
1821
1036
  /**
1822
- * Length in mm
1823
- * @type {number}
1824
- * @memberof VariantPackedDimensions
1037
+ * Unique object identifier
1038
+ * @type {string}
1039
+ * @memberof Variant
1825
1040
  */
1826
- 'length'?: number;
1041
+ 'id': string;
1827
1042
  /**
1828
- * Width in mm
1829
- * @type {number}
1830
- * @memberof VariantPackedDimensions
1043
+ * A reference to the resource location
1044
+ * @type {string}
1045
+ * @memberof Variant
1831
1046
  */
1832
- 'width'?: number;
1047
+ 'ref': string;
1833
1048
  /**
1834
- * Depth in mm
1835
- * @type {number}
1836
- * @memberof VariantPackedDimensions
1049
+ * A reference to the resource location
1050
+ * @type {string}
1051
+ * @memberof Variant
1837
1052
  */
1838
- 'depth'?: number;
1053
+ 'warehouseVariantRef': string;
1839
1054
  }
1840
1055
 
1841
1056
  /**
@@ -3825,343 +3040,3 @@ export class PlatformApi extends BaseAPI {
3825
3040
 
3826
3041
 
3827
3042
 
3828
- /**
3829
- * ProductsApi - axios parameter creator
3830
- * @export
3831
- */
3832
- export const ProductsApiAxiosParamCreator = function (configuration?: Configuration) {
3833
- return {
3834
- /**
3835
- * Updates the warehouse product and its variants
3836
- * @summary Update warehouse product
3837
- * @param {string} project Project unique identifier
3838
- * @param {string} platformId The platform identifier
3839
- * @param {string} productId Products unique identifier
3840
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
3841
- * @param {*} [options] Override http request option.
3842
- * @throws {RequiredError}
3843
- */
3844
- updateProduct: async (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3845
- // verify required parameter 'project' is not null or undefined
3846
- assertParamExists('updateProduct', 'project', project)
3847
- // verify required parameter 'platformId' is not null or undefined
3848
- assertParamExists('updateProduct', 'platformId', platformId)
3849
- // verify required parameter 'productId' is not null or undefined
3850
- assertParamExists('updateProduct', 'productId', productId)
3851
- // verify required parameter 'updateProductRequest' is not null or undefined
3852
- assertParamExists('updateProduct', 'updateProductRequest', updateProductRequest)
3853
- const localVarPath = `/v1/platform/{platformId}/warehouse/products/{productId}`
3854
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3855
- .replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
3856
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3857
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3858
- let baseOptions;
3859
- if (configuration) {
3860
- baseOptions = configuration.baseOptions;
3861
- }
3862
-
3863
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
3864
- const localVarHeaderParameter = {} as any;
3865
- const localVarQueryParameter = {} as any;
3866
-
3867
- // authentication session-oauth required
3868
- // oauth required
3869
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3870
-
3871
- // authentication api-key required
3872
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3873
-
3874
- if (project !== undefined) {
3875
- localVarQueryParameter['project'] = project;
3876
- }
3877
-
3878
-
3879
-
3880
- localVarHeaderParameter['Content-Type'] = 'application/json';
3881
-
3882
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3883
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3884
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3885
- localVarRequestOptions.data = serializeDataIfNeeded(updateProductRequest, localVarRequestOptions, configuration)
3886
-
3887
- return {
3888
- url: toPathString(localVarUrlObj),
3889
- options: localVarRequestOptions,
3890
- };
3891
- },
3892
- }
3893
- };
3894
-
3895
- /**
3896
- * ProductsApi - functional programming interface
3897
- * @export
3898
- */
3899
- export const ProductsApiFp = function(configuration?: Configuration) {
3900
- const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration)
3901
- return {
3902
- /**
3903
- * Updates the warehouse product and its variants
3904
- * @summary Update warehouse product
3905
- * @param {string} project Project unique identifier
3906
- * @param {string} platformId The platform identifier
3907
- * @param {string} productId Products unique identifier
3908
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
3909
- * @param {*} [options] Override http request option.
3910
- * @throws {RequiredError}
3911
- */
3912
- async updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>> {
3913
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateProduct(project, platformId, productId, updateProductRequest, options);
3914
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3915
- const localVarOperationServerBasePath = operationServerMap['ProductsApi.updateProduct']?.[localVarOperationServerIndex]?.url;
3916
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3917
- },
3918
- }
3919
- };
3920
-
3921
- /**
3922
- * ProductsApi - factory interface
3923
- * @export
3924
- */
3925
- export const ProductsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3926
- const localVarFp = ProductsApiFp(configuration)
3927
- return {
3928
- /**
3929
- * Updates the warehouse product and its variants
3930
- * @summary Update warehouse product
3931
- * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
3932
- * @param {*} [options] Override http request option.
3933
- * @throws {RequiredError}
3934
- */
3935
- updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product> {
3936
- return localVarFp.updateProduct(requestParameters.project, requestParameters.platformId, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(axios, basePath));
3937
- },
3938
- };
3939
- };
3940
-
3941
- /**
3942
- * Request parameters for updateProduct operation in ProductsApi.
3943
- * @export
3944
- * @interface ProductsApiUpdateProductRequest
3945
- */
3946
- export interface ProductsApiUpdateProductRequest {
3947
- /**
3948
- * Project unique identifier
3949
- * @type {string}
3950
- * @memberof ProductsApiUpdateProduct
3951
- */
3952
- readonly project: string
3953
-
3954
- /**
3955
- * The platform identifier
3956
- * @type {string}
3957
- * @memberof ProductsApiUpdateProduct
3958
- */
3959
- readonly platformId: string
3960
-
3961
- /**
3962
- * Products unique identifier
3963
- * @type {string}
3964
- * @memberof ProductsApiUpdateProduct
3965
- */
3966
- readonly productId: string
3967
-
3968
- /**
3969
- * Update a platform warehouse product
3970
- * @type {UpdateProductRequest}
3971
- * @memberof ProductsApiUpdateProduct
3972
- */
3973
- readonly updateProductRequest: UpdateProductRequest
3974
- }
3975
-
3976
- /**
3977
- * ProductsApi - object-oriented interface
3978
- * @export
3979
- * @class ProductsApi
3980
- * @extends {BaseAPI}
3981
- */
3982
- export class ProductsApi extends BaseAPI {
3983
- /**
3984
- * Updates the warehouse product and its variants
3985
- * @summary Update warehouse product
3986
- * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
3987
- * @param {*} [options] Override http request option.
3988
- * @throws {RequiredError}
3989
- * @memberof ProductsApi
3990
- */
3991
- public updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig) {
3992
- return ProductsApiFp(this.configuration).updateProduct(requestParameters.project, requestParameters.platformId, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(this.axios, this.basePath));
3993
- }
3994
- }
3995
-
3996
-
3997
-
3998
- /**
3999
- * VariantsApi - axios parameter creator
4000
- * @export
4001
- */
4002
- export const VariantsApiAxiosParamCreator = function (configuration?: Configuration) {
4003
- return {
4004
- /**
4005
- * Updates the warehouse variant
4006
- * @summary Update warehouse variant
4007
- * @param {string} project Project unique identifier
4008
- * @param {string} platformId The platform identifier
4009
- * @param {string} variantId Variants unique identifier
4010
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
4011
- * @param {*} [options] Override http request option.
4012
- * @throws {RequiredError}
4013
- */
4014
- updateVariant: async (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4015
- // verify required parameter 'project' is not null or undefined
4016
- assertParamExists('updateVariant', 'project', project)
4017
- // verify required parameter 'platformId' is not null or undefined
4018
- assertParamExists('updateVariant', 'platformId', platformId)
4019
- // verify required parameter 'variantId' is not null or undefined
4020
- assertParamExists('updateVariant', 'variantId', variantId)
4021
- // verify required parameter 'updateVariantRequest' is not null or undefined
4022
- assertParamExists('updateVariant', 'updateVariantRequest', updateVariantRequest)
4023
- const localVarPath = `/v1/platform/{platformId}/warehouse/variants/{variantId}`
4024
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
4025
- .replace(`{${"variantId"}}`, encodeURIComponent(String(variantId)));
4026
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
4027
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4028
- let baseOptions;
4029
- if (configuration) {
4030
- baseOptions = configuration.baseOptions;
4031
- }
4032
-
4033
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
4034
- const localVarHeaderParameter = {} as any;
4035
- const localVarQueryParameter = {} as any;
4036
-
4037
- // authentication session-oauth required
4038
- // oauth required
4039
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
4040
-
4041
- // authentication api-key required
4042
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4043
-
4044
- if (project !== undefined) {
4045
- localVarQueryParameter['project'] = project;
4046
- }
4047
-
4048
-
4049
-
4050
- localVarHeaderParameter['Content-Type'] = 'application/json';
4051
-
4052
- setSearchParams(localVarUrlObj, localVarQueryParameter);
4053
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4054
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4055
- localVarRequestOptions.data = serializeDataIfNeeded(updateVariantRequest, localVarRequestOptions, configuration)
4056
-
4057
- return {
4058
- url: toPathString(localVarUrlObj),
4059
- options: localVarRequestOptions,
4060
- };
4061
- },
4062
- }
4063
- };
4064
-
4065
- /**
4066
- * VariantsApi - functional programming interface
4067
- * @export
4068
- */
4069
- export const VariantsApiFp = function(configuration?: Configuration) {
4070
- const localVarAxiosParamCreator = VariantsApiAxiosParamCreator(configuration)
4071
- return {
4072
- /**
4073
- * Updates the warehouse variant
4074
- * @summary Update warehouse variant
4075
- * @param {string} project Project unique identifier
4076
- * @param {string} platformId The platform identifier
4077
- * @param {string} variantId Variants unique identifier
4078
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
4079
- * @param {*} [options] Override http request option.
4080
- * @throws {RequiredError}
4081
- */
4082
- async updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>> {
4083
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateVariant(project, platformId, variantId, updateVariantRequest, options);
4084
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4085
- const localVarOperationServerBasePath = operationServerMap['VariantsApi.updateVariant']?.[localVarOperationServerIndex]?.url;
4086
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4087
- },
4088
- }
4089
- };
4090
-
4091
- /**
4092
- * VariantsApi - factory interface
4093
- * @export
4094
- */
4095
- export const VariantsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
4096
- const localVarFp = VariantsApiFp(configuration)
4097
- return {
4098
- /**
4099
- * Updates the warehouse variant
4100
- * @summary Update warehouse variant
4101
- * @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
4102
- * @param {*} [options] Override http request option.
4103
- * @throws {RequiredError}
4104
- */
4105
- updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant> {
4106
- return localVarFp.updateVariant(requestParameters.project, requestParameters.platformId, requestParameters.variantId, requestParameters.updateVariantRequest, options).then((request) => request(axios, basePath));
4107
- },
4108
- };
4109
- };
4110
-
4111
- /**
4112
- * Request parameters for updateVariant operation in VariantsApi.
4113
- * @export
4114
- * @interface VariantsApiUpdateVariantRequest
4115
- */
4116
- export interface VariantsApiUpdateVariantRequest {
4117
- /**
4118
- * Project unique identifier
4119
- * @type {string}
4120
- * @memberof VariantsApiUpdateVariant
4121
- */
4122
- readonly project: string
4123
-
4124
- /**
4125
- * The platform identifier
4126
- * @type {string}
4127
- * @memberof VariantsApiUpdateVariant
4128
- */
4129
- readonly platformId: string
4130
-
4131
- /**
4132
- * Variants unique identifier
4133
- * @type {string}
4134
- * @memberof VariantsApiUpdateVariant
4135
- */
4136
- readonly variantId: string
4137
-
4138
- /**
4139
- * Update a platform warehouse variant
4140
- * @type {UpdateVariantRequest}
4141
- * @memberof VariantsApiUpdateVariant
4142
- */
4143
- readonly updateVariantRequest: UpdateVariantRequest
4144
- }
4145
-
4146
- /**
4147
- * VariantsApi - object-oriented interface
4148
- * @export
4149
- * @class VariantsApi
4150
- * @extends {BaseAPI}
4151
- */
4152
- export class VariantsApi extends BaseAPI {
4153
- /**
4154
- * Updates the warehouse variant
4155
- * @summary Update warehouse variant
4156
- * @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
4157
- * @param {*} [options] Override http request option.
4158
- * @throws {RequiredError}
4159
- * @memberof VariantsApi
4160
- */
4161
- public updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig) {
4162
- return VariantsApiFp(this.configuration).updateVariant(requestParameters.project, requestParameters.platformId, requestParameters.variantId, requestParameters.updateVariantRequest, options).then((request) => request(this.axios, this.basePath));
4163
- }
4164
- }
4165
-
4166
-
4167
-