@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/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.4
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
@@ -1141,243 +832,6 @@ export interface Price {
1141
832
  */
1142
833
  'currencyCode'?: string;
1143
834
  }
1144
- /**
1145
- *
1146
- * @export
1147
- * @interface Product
1148
- */
1149
- export interface Product {
1150
- /**
1151
- * Unique object identifier
1152
- * @type {string}
1153
- * @memberof Product
1154
- */
1155
- 'id': string;
1156
- /**
1157
- * A reference to the resource location
1158
- * @type {string}
1159
- * @memberof Product
1160
- */
1161
- 'ref': string;
1162
- /**
1163
- *
1164
- * @type {string}
1165
- * @memberof Product
1166
- */
1167
- 'title': string;
1168
- /**
1169
- * Whether the product is enabled
1170
- * @type {boolean}
1171
- * @memberof Product
1172
- */
1173
- 'enabled'?: boolean;
1174
- /**
1175
- * Whether stock levels should be tracked for this product
1176
- * @type {boolean}
1177
- * @memberof Product
1178
- */
1179
- 'trackInventory'?: boolean;
1180
- /**
1181
- * Whether this product should always be purchasable, regardless of factory stock levels
1182
- * @type {boolean}
1183
- * @memberof Product
1184
- */
1185
- 'alwaysInStock'?: boolean;
1186
- /**
1187
- *
1188
- * @type {string}
1189
- * @memberof Product
1190
- */
1191
- 'sku'?: string;
1192
- /**
1193
- * Tariff code of the product
1194
- * @type {number}
1195
- * @memberof Product
1196
- */
1197
- 'tariffCode'?: number;
1198
- /**
1199
- * Brand of the product
1200
- * @type {string}
1201
- * @memberof Product
1202
- */
1203
- 'brand'?: string;
1204
- /**
1205
- * The owner of the product
1206
- * @type {string}
1207
- * @memberof Product
1208
- */
1209
- 'ownerId': string;
1210
- /**
1211
- * Description of the product
1212
- * @type {string}
1213
- * @memberof Product
1214
- */
1215
- 'description'?: string;
1216
- /**
1217
- * Specifications of the product
1218
- * @type {string}
1219
- * @memberof Product
1220
- */
1221
- 'specifications'?: string;
1222
- /**
1223
- *
1224
- * @type {ProductType}
1225
- * @memberof Product
1226
- */
1227
- 'productType': ProductType;
1228
- /**
1229
- * Attributes associated to a product such as Colour and Size.
1230
- * @type {Array<ProductAttribute>}
1231
- * @memberof Product
1232
- */
1233
- 'attributes': Array<ProductAttribute>;
1234
- /**
1235
- * Additional data to be stored with the product
1236
- * @type {Array<Metafield>}
1237
- * @memberof Product
1238
- */
1239
- 'metafields': Array<Metafield>;
1240
- /**
1241
- * Variants
1242
- * @type {Array<ProductVariantsInner>}
1243
- * @memberof Product
1244
- */
1245
- 'variants': Array<ProductVariantsInner>;
1246
- /**
1247
- * ISO 8601 Timestamp
1248
- * @type {string}
1249
- * @memberof Product
1250
- */
1251
- 'createdAt'?: string;
1252
- /**
1253
- * ISO 8601 Timestamp
1254
- * @type {string}
1255
- * @memberof Product
1256
- */
1257
- 'updatedAt'?: string;
1258
- /**
1259
- * Images
1260
- * @type {Array<Image>}
1261
- * @memberof Product
1262
- */
1263
- 'images'?: Array<Image>;
1264
- }
1265
- /**
1266
- *
1267
- * @export
1268
- * @interface ProductAttribute
1269
- */
1270
- export interface ProductAttribute {
1271
- /**
1272
- * Attribute name
1273
- * @type {string}
1274
- * @memberof ProductAttribute
1275
- */
1276
- 'name': string;
1277
- /**
1278
- * Position of the attribute when ordered
1279
- * @type {number}
1280
- * @memberof ProductAttribute
1281
- */
1282
- 'sortOrder': number;
1283
- /**
1284
- * Attribute values
1285
- * @type {Array<ProductAttributeValuesInner>}
1286
- * @memberof ProductAttribute
1287
- */
1288
- 'values': Array<ProductAttributeValuesInner>;
1289
- }
1290
- /**
1291
- *
1292
- * @export
1293
- * @interface ProductAttributeValuesInner
1294
- */
1295
- export interface ProductAttributeValuesInner {
1296
- /**
1297
- * Position of the attribute value when ordered
1298
- * @type {number}
1299
- * @memberof ProductAttributeValuesInner
1300
- */
1301
- 'sortOrder': number;
1302
- /**
1303
- * Value of the attribute
1304
- * @type {string}
1305
- * @memberof ProductAttributeValuesInner
1306
- */
1307
- 'value': string;
1308
- /**
1309
- *
1310
- * @type {ProductAttributeValuesInnerThumbnail}
1311
- * @memberof ProductAttributeValuesInner
1312
- */
1313
- 'thumbnail'?: ProductAttributeValuesInnerThumbnail;
1314
- }
1315
- /**
1316
- *
1317
- * @export
1318
- * @interface ProductAttributeValuesInnerThumbnail
1319
- */
1320
- export interface ProductAttributeValuesInnerThumbnail {
1321
- /**
1322
- *
1323
- * @type {string}
1324
- * @memberof ProductAttributeValuesInnerThumbnail
1325
- */
1326
- 'type'?: ProductAttributeValuesInnerThumbnailTypeEnum;
1327
- /**
1328
- *
1329
- * @type {string}
1330
- * @memberof ProductAttributeValuesInnerThumbnail
1331
- */
1332
- 'value'?: string;
1333
- }
1334
-
1335
- export const ProductAttributeValuesInnerThumbnailTypeEnum = {
1336
- Text: 'text',
1337
- Color: 'color',
1338
- Image: 'image'
1339
- } as const;
1340
-
1341
- export type ProductAttributeValuesInnerThumbnailTypeEnum = typeof ProductAttributeValuesInnerThumbnailTypeEnum[keyof typeof ProductAttributeValuesInnerThumbnailTypeEnum];
1342
-
1343
- /**
1344
- *
1345
- * @export
1346
- * @interface ProductType
1347
- */
1348
- export interface ProductType {
1349
- /**
1350
- * Id of the product type
1351
- * @type {number}
1352
- * @memberof ProductType
1353
- */
1354
- 'id'?: number;
1355
- /**
1356
- * Name of the product type
1357
- * @type {string}
1358
- * @memberof ProductType
1359
- */
1360
- 'name'?: string;
1361
- }
1362
- /**
1363
- *
1364
- * @export
1365
- * @interface ProductVariantsInner
1366
- */
1367
- export interface ProductVariantsInner {
1368
- /**
1369
- * Unique object identifier
1370
- * @type {string}
1371
- * @memberof ProductVariantsInner
1372
- */
1373
- 'id'?: string;
1374
- /**
1375
- * A reference to the resource location
1376
- * @type {string}
1377
- * @memberof ProductVariantsInner
1378
- */
1379
- 'ref'?: string;
1380
- }
1381
835
  /**
1382
836
  *
1383
837
  * @export
@@ -1557,297 +1011,46 @@ export interface UpdatePlatformRequest {
1557
1011
  *
1558
1012
  * @type {boolean}
1559
1013
  * @memberof UpdatePlatformRequest
1560
- */
1561
- 'chargeClients'?: boolean;
1562
- }
1563
- /**
1564
- *
1565
- * @export
1566
- * @interface UpdateProductRequest
1567
- */
1568
- export interface UpdateProductRequest {
1569
- /**
1570
- * The warehouse variants of the product to update
1571
- * @type {Array<UpdateProductRequestVariantsInner>}
1572
- * @memberof UpdateProductRequest
1573
- */
1574
- 'variants'?: Array<UpdateProductRequestVariantsInner>;
1575
- /**
1576
- * Whether the platform warehouse product should be enabled or not
1577
- * @type {boolean}
1578
- * @memberof UpdateProductRequest
1579
- */
1580
- 'enabled'?: boolean;
1581
- }
1582
- /**
1583
- *
1584
- * @export
1585
- * @interface UpdateProductRequestVariantsInner
1586
- */
1587
- export interface UpdateProductRequestVariantsInner {
1588
- /**
1589
- * The ID of the variant to update
1590
- * @type {string}
1591
- * @memberof UpdateProductRequestVariantsInner
1592
- */
1593
- 'id': string;
1594
- /**
1595
- * Whether the warehouse variant should be enabled or not
1596
- * @type {boolean}
1597
- * @memberof UpdateProductRequestVariantsInner
1598
- */
1599
- 'enabled'?: boolean;
1600
- }
1601
- /**
1602
- *
1603
- * @export
1604
- * @interface UpdateVariantRequest
1605
- */
1606
- export interface UpdateVariantRequest {
1607
- /**
1608
- * Whether the platform warehouse variant is enabled or not
1609
- * @type {boolean}
1610
- * @memberof UpdateVariantRequest
1611
- */
1612
- 'enabled'?: boolean;
1613
- }
1614
- /**
1615
- *
1616
- * @export
1617
- * @interface ValidationError
1618
- */
1619
- export interface ValidationError {
1620
- /**
1621
- *
1622
- * @type {string}
1623
- * @memberof ValidationError
1624
- */
1625
- 'message': string;
1626
- }
1627
- /**
1628
- *
1629
- * @export
1630
- * @interface Variant
1631
- */
1632
- export interface Variant {
1633
- /**
1634
- * Unique object identifier
1635
- * @type {string}
1636
- * @memberof Variant
1637
- */
1638
- 'id': string;
1639
- /**
1640
- * A reference to the resource location
1641
- * @type {string}
1642
- * @memberof Variant
1643
- */
1644
- 'ref': string;
1645
- /**
1646
- *
1647
- * @type {ProductVariantsInner}
1648
- * @memberof Variant
1649
- */
1650
- 'product'?: ProductVariantsInner;
1651
- /**
1652
- *
1653
- * @type {string}
1654
- * @memberof Variant
1655
- */
1656
- 'sku': string;
1657
- /**
1658
- * ISO 8601 Timestamp
1659
- * @type {string}
1660
- * @memberof Variant
1661
- */
1662
- 'createdAt'?: string;
1663
- /**
1664
- * ISO 8601 Timestamp
1665
- * @type {string}
1666
- * @memberof Variant
1667
- */
1668
- 'updatedAt'?: string;
1669
- /**
1670
- * Images
1671
- * @type {Array<Image>}
1672
- * @memberof Variant
1673
- */
1674
- 'images'?: Array<Image>;
1675
- /**
1676
- * Weight in kg
1677
- * @type {number}
1678
- * @memberof Variant
1679
- */
1680
- 'weight'?: number;
1681
- /**
1682
- * The number of units that can be packed in a single pickface
1683
- * @type {number}
1684
- * @memberof Variant
1685
- */
1686
- 'packVolume'?: number;
1687
- /**
1688
- *
1689
- * @type {VariantPackedDimensions}
1690
- * @memberof Variant
1691
- */
1692
- 'packedDimensions'?: VariantPackedDimensions;
1693
- /**
1694
- * Whether the variant can be pre-ordered
1695
- * @type {boolean}
1696
- * @memberof Variant
1697
- */
1698
- 'preOrderable'?: boolean;
1699
- /**
1700
- * Whether the variant is enabled
1701
- * @type {boolean}
1702
- * @memberof Variant
1703
- */
1704
- 'enabled'?: boolean;
1705
- /**
1706
- * Whether the variant is discontinued
1707
- * @type {boolean}
1708
- * @memberof Variant
1709
- */
1710
- 'discontinued'?: boolean;
1711
- /**
1712
- *
1713
- * @type {VariantManufacturerOrigin}
1714
- * @memberof Variant
1715
- */
1716
- 'manufacturerOrigin'?: VariantManufacturerOrigin;
1717
- /**
1718
- * 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.
1719
- * @type {Array<VariantAttribute>}
1720
- * @memberof Variant
1721
- */
1722
- 'attributes': Array<VariantAttribute>;
1723
- /**
1724
- * Applications of the variant
1725
- * @type {Array<Application>}
1726
- * @memberof Variant
1727
- */
1728
- 'applications'?: Array<Application>;
1729
- }
1730
- /**
1731
- *
1732
- * @export
1733
- * @interface Variant1
1734
- */
1735
- export interface Variant1 {
1736
- /**
1737
- * Unique object identifier
1738
- * @type {string}
1739
- * @memberof Variant1
1740
- */
1741
- 'id': string;
1742
- /**
1743
- * A reference to the resource location
1744
- * @type {string}
1745
- * @memberof Variant1
1746
- */
1747
- 'ref': string;
1748
- /**
1749
- * A reference to the resource location
1750
- * @type {string}
1751
- * @memberof Variant1
1752
- */
1753
- 'warehouseVariantRef': string;
1754
- }
1755
- /**
1756
- *
1757
- * @export
1758
- * @interface VariantAttribute
1759
- */
1760
- export interface VariantAttribute {
1761
- /**
1762
- * Attribute name
1763
- * @type {string}
1764
- * @memberof VariantAttribute
1765
- */
1766
- 'name': string;
1767
- /**
1768
- * Attribute value
1769
- * @type {string}
1770
- * @memberof VariantAttribute
1771
- */
1772
- 'value': string;
1773
- /**
1774
- *
1775
- * @type {VariantAttributeThumbnail}
1776
- * @memberof VariantAttribute
1777
- */
1778
- 'thumbnail'?: VariantAttributeThumbnail;
1779
- /**
1780
- * Attribute tags
1781
- * @type {Array<string>}
1782
- * @memberof VariantAttribute
1783
- */
1784
- 'tags'?: Array<string>;
1785
- }
1786
- /**
1787
- * Attribute thumbnail
1788
- * @export
1789
- * @interface VariantAttributeThumbnail
1790
- */
1791
- export interface VariantAttributeThumbnail {
1792
- /**
1793
- *
1794
- * @type {string}
1795
- * @memberof VariantAttributeThumbnail
1796
- */
1797
- 'type'?: VariantAttributeThumbnailTypeEnum;
1798
- /**
1799
- *
1800
- * @type {string}
1801
- * @memberof VariantAttributeThumbnail
1802
- */
1803
- 'value'?: string;
1804
- }
1805
-
1806
- export const VariantAttributeThumbnailTypeEnum = {
1807
- Text: 'text',
1808
- Color: 'color',
1809
- Image: 'image'
1810
- } as const;
1811
-
1812
- export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
1813
-
1014
+ */
1015
+ 'chargeClients'?: boolean;
1016
+ }
1814
1017
  /**
1815
- * Where the product was originally produced or manufactured
1018
+ *
1816
1019
  * @export
1817
- * @interface VariantManufacturerOrigin
1020
+ * @interface ValidationError
1818
1021
  */
1819
- export interface VariantManufacturerOrigin {
1022
+ export interface ValidationError {
1820
1023
  /**
1821
- * Country of origin (ISO 3166-1 alpha-2).
1024
+ *
1822
1025
  * @type {string}
1823
- * @memberof VariantManufacturerOrigin
1026
+ * @memberof ValidationError
1824
1027
  */
1825
- 'country'?: string;
1028
+ 'message': string;
1826
1029
  }
1827
1030
  /**
1828
1031
  *
1829
1032
  * @export
1830
- * @interface VariantPackedDimensions
1033
+ * @interface Variant
1831
1034
  */
1832
- export interface VariantPackedDimensions {
1035
+ export interface Variant {
1833
1036
  /**
1834
- * Length in mm
1835
- * @type {number}
1836
- * @memberof VariantPackedDimensions
1037
+ * Unique object identifier
1038
+ * @type {string}
1039
+ * @memberof Variant
1837
1040
  */
1838
- 'length'?: number;
1041
+ 'id': string;
1839
1042
  /**
1840
- * Width in mm
1841
- * @type {number}
1842
- * @memberof VariantPackedDimensions
1043
+ * A reference to the resource location
1044
+ * @type {string}
1045
+ * @memberof Variant
1843
1046
  */
1844
- 'width'?: number;
1047
+ 'ref': string;
1845
1048
  /**
1846
- * Depth in mm
1847
- * @type {number}
1848
- * @memberof VariantPackedDimensions
1049
+ * A reference to the resource location
1050
+ * @type {string}
1051
+ * @memberof Variant
1849
1052
  */
1850
- 'depth'?: number;
1053
+ 'warehouseVariantRef': string;
1851
1054
  }
1852
1055
 
1853
1056
  /**
@@ -3837,343 +3040,3 @@ export class PlatformApi extends BaseAPI {
3837
3040
 
3838
3041
 
3839
3042
 
3840
- /**
3841
- * ProductsApi - axios parameter creator
3842
- * @export
3843
- */
3844
- export const ProductsApiAxiosParamCreator = function (configuration?: Configuration) {
3845
- return {
3846
- /**
3847
- * Updates the warehouse product and its variants
3848
- * @summary Update warehouse product
3849
- * @param {string} project Project unique identifier
3850
- * @param {string} platformId The platform identifier
3851
- * @param {string} productId Products unique identifier
3852
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
3853
- * @param {*} [options] Override http request option.
3854
- * @throws {RequiredError}
3855
- */
3856
- updateProduct: async (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3857
- // verify required parameter 'project' is not null or undefined
3858
- assertParamExists('updateProduct', 'project', project)
3859
- // verify required parameter 'platformId' is not null or undefined
3860
- assertParamExists('updateProduct', 'platformId', platformId)
3861
- // verify required parameter 'productId' is not null or undefined
3862
- assertParamExists('updateProduct', 'productId', productId)
3863
- // verify required parameter 'updateProductRequest' is not null or undefined
3864
- assertParamExists('updateProduct', 'updateProductRequest', updateProductRequest)
3865
- const localVarPath = `/v1/platform/{platformId}/warehouse/products/{productId}`
3866
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3867
- .replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
3868
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3869
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3870
- let baseOptions;
3871
- if (configuration) {
3872
- baseOptions = configuration.baseOptions;
3873
- }
3874
-
3875
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
3876
- const localVarHeaderParameter = {} as any;
3877
- const localVarQueryParameter = {} as any;
3878
-
3879
- // authentication session-oauth required
3880
- // oauth required
3881
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3882
-
3883
- // authentication api-key required
3884
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3885
-
3886
- if (project !== undefined) {
3887
- localVarQueryParameter['project'] = project;
3888
- }
3889
-
3890
-
3891
-
3892
- localVarHeaderParameter['Content-Type'] = 'application/json';
3893
-
3894
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3895
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3896
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3897
- localVarRequestOptions.data = serializeDataIfNeeded(updateProductRequest, localVarRequestOptions, configuration)
3898
-
3899
- return {
3900
- url: toPathString(localVarUrlObj),
3901
- options: localVarRequestOptions,
3902
- };
3903
- },
3904
- }
3905
- };
3906
-
3907
- /**
3908
- * ProductsApi - functional programming interface
3909
- * @export
3910
- */
3911
- export const ProductsApiFp = function(configuration?: Configuration) {
3912
- const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration)
3913
- return {
3914
- /**
3915
- * Updates the warehouse product and its variants
3916
- * @summary Update warehouse product
3917
- * @param {string} project Project unique identifier
3918
- * @param {string} platformId The platform identifier
3919
- * @param {string} productId Products unique identifier
3920
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
3921
- * @param {*} [options] Override http request option.
3922
- * @throws {RequiredError}
3923
- */
3924
- async updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>> {
3925
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateProduct(project, platformId, productId, updateProductRequest, options);
3926
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3927
- const localVarOperationServerBasePath = operationServerMap['ProductsApi.updateProduct']?.[localVarOperationServerIndex]?.url;
3928
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3929
- },
3930
- }
3931
- };
3932
-
3933
- /**
3934
- * ProductsApi - factory interface
3935
- * @export
3936
- */
3937
- export const ProductsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3938
- const localVarFp = ProductsApiFp(configuration)
3939
- return {
3940
- /**
3941
- * Updates the warehouse product and its variants
3942
- * @summary Update warehouse product
3943
- * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
3944
- * @param {*} [options] Override http request option.
3945
- * @throws {RequiredError}
3946
- */
3947
- updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product> {
3948
- return localVarFp.updateProduct(requestParameters.project, requestParameters.platformId, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(axios, basePath));
3949
- },
3950
- };
3951
- };
3952
-
3953
- /**
3954
- * Request parameters for updateProduct operation in ProductsApi.
3955
- * @export
3956
- * @interface ProductsApiUpdateProductRequest
3957
- */
3958
- export interface ProductsApiUpdateProductRequest {
3959
- /**
3960
- * Project unique identifier
3961
- * @type {string}
3962
- * @memberof ProductsApiUpdateProduct
3963
- */
3964
- readonly project: string
3965
-
3966
- /**
3967
- * The platform identifier
3968
- * @type {string}
3969
- * @memberof ProductsApiUpdateProduct
3970
- */
3971
- readonly platformId: string
3972
-
3973
- /**
3974
- * Products unique identifier
3975
- * @type {string}
3976
- * @memberof ProductsApiUpdateProduct
3977
- */
3978
- readonly productId: string
3979
-
3980
- /**
3981
- * Update a platform warehouse product
3982
- * @type {UpdateProductRequest}
3983
- * @memberof ProductsApiUpdateProduct
3984
- */
3985
- readonly updateProductRequest: UpdateProductRequest
3986
- }
3987
-
3988
- /**
3989
- * ProductsApi - object-oriented interface
3990
- * @export
3991
- * @class ProductsApi
3992
- * @extends {BaseAPI}
3993
- */
3994
- export class ProductsApi extends BaseAPI {
3995
- /**
3996
- * Updates the warehouse product and its variants
3997
- * @summary Update warehouse product
3998
- * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
3999
- * @param {*} [options] Override http request option.
4000
- * @throws {RequiredError}
4001
- * @memberof ProductsApi
4002
- */
4003
- public updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig) {
4004
- return ProductsApiFp(this.configuration).updateProduct(requestParameters.project, requestParameters.platformId, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(this.axios, this.basePath));
4005
- }
4006
- }
4007
-
4008
-
4009
-
4010
- /**
4011
- * VariantsApi - axios parameter creator
4012
- * @export
4013
- */
4014
- export const VariantsApiAxiosParamCreator = function (configuration?: Configuration) {
4015
- return {
4016
- /**
4017
- * Updates the warehouse variant
4018
- * @summary Update warehouse variant
4019
- * @param {string} project Project unique identifier
4020
- * @param {string} platformId The platform identifier
4021
- * @param {string} variantId Variants unique identifier
4022
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
4023
- * @param {*} [options] Override http request option.
4024
- * @throws {RequiredError}
4025
- */
4026
- updateVariant: async (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4027
- // verify required parameter 'project' is not null or undefined
4028
- assertParamExists('updateVariant', 'project', project)
4029
- // verify required parameter 'platformId' is not null or undefined
4030
- assertParamExists('updateVariant', 'platformId', platformId)
4031
- // verify required parameter 'variantId' is not null or undefined
4032
- assertParamExists('updateVariant', 'variantId', variantId)
4033
- // verify required parameter 'updateVariantRequest' is not null or undefined
4034
- assertParamExists('updateVariant', 'updateVariantRequest', updateVariantRequest)
4035
- const localVarPath = `/v1/platform/{platformId}/warehouse/variants/{variantId}`
4036
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
4037
- .replace(`{${"variantId"}}`, encodeURIComponent(String(variantId)));
4038
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
4039
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4040
- let baseOptions;
4041
- if (configuration) {
4042
- baseOptions = configuration.baseOptions;
4043
- }
4044
-
4045
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
4046
- const localVarHeaderParameter = {} as any;
4047
- const localVarQueryParameter = {} as any;
4048
-
4049
- // authentication session-oauth required
4050
- // oauth required
4051
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
4052
-
4053
- // authentication api-key required
4054
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4055
-
4056
- if (project !== undefined) {
4057
- localVarQueryParameter['project'] = project;
4058
- }
4059
-
4060
-
4061
-
4062
- localVarHeaderParameter['Content-Type'] = 'application/json';
4063
-
4064
- setSearchParams(localVarUrlObj, localVarQueryParameter);
4065
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4066
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4067
- localVarRequestOptions.data = serializeDataIfNeeded(updateVariantRequest, localVarRequestOptions, configuration)
4068
-
4069
- return {
4070
- url: toPathString(localVarUrlObj),
4071
- options: localVarRequestOptions,
4072
- };
4073
- },
4074
- }
4075
- };
4076
-
4077
- /**
4078
- * VariantsApi - functional programming interface
4079
- * @export
4080
- */
4081
- export const VariantsApiFp = function(configuration?: Configuration) {
4082
- const localVarAxiosParamCreator = VariantsApiAxiosParamCreator(configuration)
4083
- return {
4084
- /**
4085
- * Updates the warehouse variant
4086
- * @summary Update warehouse variant
4087
- * @param {string} project Project unique identifier
4088
- * @param {string} platformId The platform identifier
4089
- * @param {string} variantId Variants unique identifier
4090
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
4091
- * @param {*} [options] Override http request option.
4092
- * @throws {RequiredError}
4093
- */
4094
- async updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>> {
4095
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateVariant(project, platformId, variantId, updateVariantRequest, options);
4096
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4097
- const localVarOperationServerBasePath = operationServerMap['VariantsApi.updateVariant']?.[localVarOperationServerIndex]?.url;
4098
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4099
- },
4100
- }
4101
- };
4102
-
4103
- /**
4104
- * VariantsApi - factory interface
4105
- * @export
4106
- */
4107
- export const VariantsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
4108
- const localVarFp = VariantsApiFp(configuration)
4109
- return {
4110
- /**
4111
- * Updates the warehouse variant
4112
- * @summary Update warehouse variant
4113
- * @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
4114
- * @param {*} [options] Override http request option.
4115
- * @throws {RequiredError}
4116
- */
4117
- updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant> {
4118
- return localVarFp.updateVariant(requestParameters.project, requestParameters.platformId, requestParameters.variantId, requestParameters.updateVariantRequest, options).then((request) => request(axios, basePath));
4119
- },
4120
- };
4121
- };
4122
-
4123
- /**
4124
- * Request parameters for updateVariant operation in VariantsApi.
4125
- * @export
4126
- * @interface VariantsApiUpdateVariantRequest
4127
- */
4128
- export interface VariantsApiUpdateVariantRequest {
4129
- /**
4130
- * Project unique identifier
4131
- * @type {string}
4132
- * @memberof VariantsApiUpdateVariant
4133
- */
4134
- readonly project: string
4135
-
4136
- /**
4137
- * The platform identifier
4138
- * @type {string}
4139
- * @memberof VariantsApiUpdateVariant
4140
- */
4141
- readonly platformId: string
4142
-
4143
- /**
4144
- * Variants unique identifier
4145
- * @type {string}
4146
- * @memberof VariantsApiUpdateVariant
4147
- */
4148
- readonly variantId: string
4149
-
4150
- /**
4151
- * Update a platform warehouse variant
4152
- * @type {UpdateVariantRequest}
4153
- * @memberof VariantsApiUpdateVariant
4154
- */
4155
- readonly updateVariantRequest: UpdateVariantRequest
4156
- }
4157
-
4158
- /**
4159
- * VariantsApi - object-oriented interface
4160
- * @export
4161
- * @class VariantsApi
4162
- * @extends {BaseAPI}
4163
- */
4164
- export class VariantsApi extends BaseAPI {
4165
- /**
4166
- * Updates the warehouse variant
4167
- * @summary Update warehouse variant
4168
- * @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
4169
- * @param {*} [options] Override http request option.
4170
- * @throws {RequiredError}
4171
- * @memberof VariantsApi
4172
- */
4173
- public updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig) {
4174
- return VariantsApiFp(this.configuration).updateVariant(requestParameters.project, requestParameters.platformId, requestParameters.variantId, requestParameters.updateVariantRequest, options).then((request) => request(this.axios, this.basePath));
4175
- }
4176
- }
4177
-
4178
-
4179
-