@teemill/platform 0.14.4 → 0.16.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.
Files changed (73) hide show
  1. package/README.md +94 -2
  2. package/api.ts +571 -893
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +460 -903
  7. package/dist/api.js +296 -164
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +1 -1
  14. package/dist/esm/api.d.ts +460 -903
  15. package/dist/esm/api.js +291 -155
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +1 -1
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/docs/Address.md +35 -0
  27. package/docs/ApiError.md +22 -0
  28. package/docs/AuthorizeStripe200Response.md +20 -0
  29. package/docs/ContactInformation.md +23 -0
  30. package/docs/Customer.md +33 -0
  31. package/docs/CustomersApi.md +229 -0
  32. package/docs/CustomersResponse.md +22 -0
  33. package/docs/DeliveryEstimates.md +22 -0
  34. package/docs/ExportOrders202Response.md +20 -0
  35. package/docs/Fulfiller.md +23 -0
  36. package/docs/FulfillerLocation.md +22 -0
  37. package/docs/FulfillersResponse.md +22 -0
  38. package/docs/Fulfillment.md +34 -0
  39. package/docs/FulfillmentItem.md +24 -0
  40. package/docs/Image.md +27 -0
  41. package/docs/ModerateReviewRequest.md +20 -0
  42. package/docs/Option.md +22 -0
  43. package/docs/Order.md +54 -0
  44. package/docs/OrderItem.md +42 -0
  45. package/docs/OrderStatus.md +16 -0
  46. package/docs/OrderTracking.md +24 -0
  47. package/docs/OrdersApi.md +410 -0
  48. package/docs/OrdersResponse.md +22 -0
  49. package/docs/Origin.md +22 -0
  50. package/docs/PaymentAccount.md +24 -0
  51. package/docs/PaymentApi.md +178 -0
  52. package/docs/Platform.md +38 -0
  53. package/docs/PlatformApi.md +122 -0
  54. package/docs/PlatformLogo.md +22 -0
  55. package/docs/Price.md +23 -0
  56. package/docs/Project.md +22 -0
  57. package/docs/Review.md +40 -0
  58. package/docs/ReviewAuthor.md +22 -0
  59. package/docs/ReviewImagesInner.md +22 -0
  60. package/docs/ReviewProduct.md +23 -0
  61. package/docs/ReviewReply.md +26 -0
  62. package/docs/ReviewReplyAuthor.md +20 -0
  63. package/docs/ReviewsApi.md +278 -0
  64. package/docs/ReviewsResponse.md +22 -0
  65. package/docs/ShippingMethod.md +34 -0
  66. package/docs/Statistics.md +24 -0
  67. package/docs/StatusHistoryItem.md +22 -0
  68. package/docs/UpdateFulfillmentRequest.md +20 -0
  69. package/docs/UpdatePlatformRequest.md +32 -0
  70. package/docs/ValidationError.md +20 -0
  71. package/docs/Variant.md +24 -0
  72. package/index.ts +1 -1
  73. package/package.json +1 -1
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.4
5
+ * The version of the OpenAPI document: 0.16.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
@@ -446,83 +390,15 @@ export interface Image {
446
390
  /**
447
391
  *
448
392
  * @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
393
+ * @interface ModerateReviewRequest
469
394
  */
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;
395
+ export interface ModerateReviewRequest {
514
396
  /**
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
397
+ * Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
398
+ * @type {boolean}
399
+ * @memberof ModerateReviewRequest
524
400
  */
525
- 'height': number;
401
+ 'enabled'?: boolean;
526
402
  }
527
403
  /**
528
404
  *
@@ -679,10 +555,10 @@ export interface OrderItem {
679
555
  'variantRef': string;
680
556
  /**
681
557
  *
682
- * @type {Variant1}
558
+ * @type {Variant}
683
559
  * @memberof OrderItem
684
560
  */
685
- 'variant': Variant1;
561
+ 'variant': Variant;
686
562
  /**
687
563
  * Options associated to an order item\'s variant, such as color and size.
688
564
  * @type {Array<Option>}
@@ -814,174 +690,6 @@ export interface Origin {
814
690
  */
815
691
  'isPaid'?: boolean;
816
692
  }
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
693
  /**
986
694
  *
987
695
  * @export
@@ -1123,255 +831,214 @@ export interface Price {
1123
831
  /**
1124
832
  *
1125
833
  * @export
1126
- * @interface Product
834
+ * @interface Project
1127
835
  */
1128
- export interface Product {
836
+ export interface Project {
1129
837
  /**
1130
- * Unique object identifier
838
+ *
1131
839
  * @type {string}
1132
- * @memberof Product
840
+ * @memberof Project
1133
841
  */
1134
842
  'id': string;
1135
843
  /**
1136
- * A reference to the resource location
844
+ * The name of the project
1137
845
  * @type {string}
1138
- * @memberof Product
846
+ * @memberof Project
1139
847
  */
1140
- 'ref': string;
848
+ 'name': string;
849
+ }
850
+ /**
851
+ *
852
+ * @export
853
+ * @interface Review
854
+ */
855
+ export interface Review {
1141
856
  /**
1142
- *
857
+ * Unique object identifier
1143
858
  * @type {string}
1144
- * @memberof Product
1145
- */
1146
- 'title': string;
1147
- /**
1148
- * Whether the product is enabled
1149
- * @type {boolean}
1150
- * @memberof Product
859
+ * @memberof Review
1151
860
  */
1152
- 'enabled'?: boolean;
861
+ 'id': string;
1153
862
  /**
1154
- * Whether stock levels should be tracked for this product
1155
- * @type {boolean}
1156
- * @memberof Product
863
+ * Text content of the review
864
+ * @type {string}
865
+ * @memberof Review
1157
866
  */
1158
- 'trackInventory'?: boolean;
867
+ 'text': string;
1159
868
  /**
1160
- * Whether this product should always be purchasable, regardless of factory stock levels
1161
- * @type {boolean}
1162
- * @memberof Product
869
+ *
870
+ * @type {ReviewProduct}
871
+ * @memberof Review
1163
872
  */
1164
- 'alwaysInStock'?: boolean;
873
+ 'product'?: ReviewProduct;
1165
874
  /**
1166
875
  *
1167
- * @type {string}
1168
- * @memberof Product
876
+ * @type {ReviewAuthor}
877
+ * @memberof Review
1169
878
  */
1170
- 'sku'?: string;
879
+ 'author'?: ReviewAuthor;
1171
880
  /**
1172
- * Tariff code of the product
881
+ * Rating of the review
1173
882
  * @type {number}
1174
- * @memberof Product
1175
- */
1176
- 'tariffCode'?: number;
1177
- /**
1178
- * Brand of the product
1179
- * @type {string}
1180
- * @memberof Product
883
+ * @memberof Review
1181
884
  */
1182
- 'brand'?: string;
885
+ 'rating'?: number;
1183
886
  /**
1184
- * The owner of the product
1185
- * @type {string}
1186
- * @memberof Product
887
+ * Google\'s sentiment analysis score
888
+ * @type {number}
889
+ * @memberof Review
1187
890
  */
1188
- 'ownerId': string;
891
+ 'sentiment'?: number;
1189
892
  /**
1190
- * Description of the product
1191
- * @type {string}
1192
- * @memberof Product
893
+ * Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
894
+ * @type {boolean}
895
+ * @memberof Review
1193
896
  */
1194
- 'description'?: string;
897
+ 'enabled': boolean;
1195
898
  /**
1196
- * Specifications of the product
899
+ *
1197
900
  * @type {string}
1198
- * @memberof Product
901
+ * @memberof Review
1199
902
  */
1200
- 'specifications'?: string;
903
+ 'createdAt'?: string;
1201
904
  /**
1202
905
  *
1203
- * @type {ProductType}
1204
- * @memberof Product
1205
- */
1206
- 'productType': ProductType;
1207
- /**
1208
- * Attributes associated to a product such as Colour and Size.
1209
- * @type {Array<ProductAttribute>}
1210
- * @memberof Product
906
+ * @type {Project}
907
+ * @memberof Review
1211
908
  */
1212
- 'attributes': Array<ProductAttribute>;
909
+ 'project': Project;
1213
910
  /**
1214
- * Additional data to be stored with the product
1215
- * @type {Array<Metafield>}
1216
- * @memberof Product
911
+ *
912
+ * @type {Array<ReviewImagesInner>}
913
+ * @memberof Review
1217
914
  */
1218
- 'metafields': Array<Metafield>;
915
+ 'images'?: Array<ReviewImagesInner>;
1219
916
  /**
1220
- * Variants
1221
- * @type {Array<ProductVariantsInner>}
1222
- * @memberof Product
917
+ *
918
+ * @type {Array<ReviewReply>}
919
+ * @memberof Review
1223
920
  */
1224
- 'variants': Array<ProductVariantsInner>;
921
+ 'replies'?: Array<ReviewReply>;
922
+ }
923
+ /**
924
+ *
925
+ * @export
926
+ * @interface ReviewAuthor
927
+ */
928
+ export interface ReviewAuthor {
1225
929
  /**
1226
- * ISO 8601 Timestamp
930
+ * Name of the review\'s author
1227
931
  * @type {string}
1228
- * @memberof Product
932
+ * @memberof ReviewAuthor
1229
933
  */
1230
- 'createdAt'?: string;
934
+ 'name'?: string;
1231
935
  /**
1232
- * ISO 8601 Timestamp
936
+ * Email of the review\'s author
1233
937
  * @type {string}
1234
- * @memberof Product
938
+ * @memberof ReviewAuthor
1235
939
  */
1236
- 'updatedAt'?: string;
1237
- /**
1238
- * Images
1239
- * @type {Array<Image>}
1240
- * @memberof Product
1241
- */
1242
- 'images'?: Array<Image>;
940
+ 'email'?: string;
1243
941
  }
1244
942
  /**
1245
943
  *
1246
944
  * @export
1247
- * @interface ProductAttribute
945
+ * @interface ReviewImagesInner
1248
946
  */
1249
- export interface ProductAttribute {
947
+ export interface ReviewImagesInner {
1250
948
  /**
1251
- * Attribute name
949
+ * URL of the image
1252
950
  * @type {string}
1253
- * @memberof ProductAttribute
951
+ * @memberof ReviewImagesInner
1254
952
  */
1255
- 'name': string;
1256
- /**
1257
- * Position of the attribute when ordered
1258
- * @type {number}
1259
- * @memberof ProductAttribute
1260
- */
1261
- 'sortOrder': number;
953
+ 'src'?: string;
1262
954
  /**
1263
- * Attribute values
1264
- * @type {Array<ProductAttributeValuesInner>}
1265
- * @memberof ProductAttribute
955
+ * Alternative text for the image
956
+ * @type {string}
957
+ * @memberof ReviewImagesInner
1266
958
  */
1267
- 'values': Array<ProductAttributeValuesInner>;
959
+ 'alt'?: string;
1268
960
  }
1269
961
  /**
1270
- *
962
+ * The product that the review is for
1271
963
  * @export
1272
- * @interface ProductAttributeValuesInner
964
+ * @interface ReviewProduct
1273
965
  */
1274
- export interface ProductAttributeValuesInner {
1275
- /**
1276
- * Position of the attribute value when ordered
1277
- * @type {number}
1278
- * @memberof ProductAttributeValuesInner
1279
- */
1280
- 'sortOrder': number;
966
+ export interface ReviewProduct {
1281
967
  /**
1282
- * Value of the attribute
968
+ * Unique object identifier
1283
969
  * @type {string}
1284
- * @memberof ProductAttributeValuesInner
970
+ * @memberof ReviewProduct
1285
971
  */
1286
- 'value': string;
972
+ 'id'?: string;
1287
973
  /**
1288
- *
1289
- * @type {ProductAttributeValuesInnerThumbnail}
1290
- * @memberof ProductAttributeValuesInner
974
+ * The title of the product
975
+ * @type {string}
976
+ * @memberof ReviewProduct
1291
977
  */
1292
- 'thumbnail'?: ProductAttributeValuesInnerThumbnail;
978
+ 'title'?: string;
1293
979
  }
1294
980
  /**
1295
981
  *
1296
982
  * @export
1297
- * @interface ProductAttributeValuesInnerThumbnail
983
+ * @interface ReviewReply
1298
984
  */
1299
- export interface ProductAttributeValuesInnerThumbnail {
985
+ export interface ReviewReply {
1300
986
  /**
1301
- *
987
+ * Unique object identifier
1302
988
  * @type {string}
1303
- * @memberof ProductAttributeValuesInnerThumbnail
989
+ * @memberof ReviewReply
1304
990
  */
1305
- 'type'?: ProductAttributeValuesInnerThumbnailTypeEnum;
991
+ 'id': string;
1306
992
  /**
1307
- *
993
+ * Text content of the reply
1308
994
  * @type {string}
1309
- * @memberof ProductAttributeValuesInnerThumbnail
995
+ * @memberof ReviewReply
1310
996
  */
1311
- 'value'?: string;
1312
- }
1313
- export declare const ProductAttributeValuesInnerThumbnailTypeEnum: {
1314
- readonly Text: "text";
1315
- readonly Color: "color";
1316
- readonly Image: "image";
1317
- };
1318
- export type ProductAttributeValuesInnerThumbnailTypeEnum = typeof ProductAttributeValuesInnerThumbnailTypeEnum[keyof typeof ProductAttributeValuesInnerThumbnailTypeEnum];
1319
- /**
1320
- *
1321
- * @export
1322
- * @interface ProductType
1323
- */
1324
- export interface ProductType {
997
+ 'text': string;
1325
998
  /**
1326
- * Id of the product type
1327
- * @type {number}
1328
- * @memberof ProductType
999
+ *
1000
+ * @type {ReviewReplyAuthor}
1001
+ * @memberof ReviewReply
1329
1002
  */
1330
- 'id'?: number;
1003
+ 'author'?: ReviewReplyAuthor;
1331
1004
  /**
1332
- * Name of the product type
1005
+ *
1333
1006
  * @type {string}
1334
- * @memberof ProductType
1007
+ * @memberof ReviewReply
1335
1008
  */
1336
- 'name'?: string;
1009
+ 'createdAt'?: string;
1337
1010
  }
1338
1011
  /**
1339
1012
  *
1340
1013
  * @export
1341
- * @interface ProductVariantsInner
1014
+ * @interface ReviewReplyAuthor
1342
1015
  */
1343
- export interface ProductVariantsInner {
1016
+ export interface ReviewReplyAuthor {
1344
1017
  /**
1345
- * Unique object identifier
1018
+ * Name of the reply\'s author
1346
1019
  * @type {string}
1347
- * @memberof ProductVariantsInner
1020
+ * @memberof ReviewReplyAuthor
1348
1021
  */
1349
- 'id'?: string;
1350
- /**
1351
- * A reference to the resource location
1352
- * @type {string}
1353
- * @memberof ProductVariantsInner
1354
- */
1355
- 'ref'?: string;
1022
+ 'name'?: string;
1356
1023
  }
1357
1024
  /**
1358
1025
  *
1359
1026
  * @export
1360
- * @interface Project
1027
+ * @interface ReviewsResponse
1361
1028
  */
1362
- export interface Project {
1029
+ export interface ReviewsResponse {
1363
1030
  /**
1364
1031
  *
1365
- * @type {string}
1366
- * @memberof Project
1032
+ * @type {Array<Review>}
1033
+ * @memberof ReviewsResponse
1367
1034
  */
1368
- 'id': string;
1035
+ 'reviews'?: Array<Review>;
1369
1036
  /**
1370
- * The name of the project
1371
- * @type {string}
1372
- * @memberof Project
1037
+ * The token referencing the next page number
1038
+ * @type {number}
1039
+ * @memberof ReviewsResponse
1373
1040
  */
1374
- 'name': string;
1041
+ 'nextPageToken'?: number | null;
1375
1042
  }
1376
1043
  /**
1377
1044
  *
@@ -1415,410 +1082,162 @@ export interface ShippingMethod {
1415
1082
  * @memberof ShippingMethod
1416
1083
  */
1417
1084
  'taxPrice'?: Price;
1418
- /**
1419
- *
1420
- * @type {Price}
1421
- * @memberof ShippingMethod
1422
- */
1423
- 'subtotalPrice'?: Price;
1424
- /**
1425
- *
1426
- * @type {Price}
1427
- * @memberof ShippingMethod
1428
- */
1429
- 'discountPrice'?: Price;
1430
- }
1431
- /**
1432
- *
1433
- * @export
1434
- * @interface Statistics
1435
- */
1436
- export interface Statistics {
1437
- /**
1438
- *
1439
- * @type {number}
1440
- * @memberof Statistics
1441
- */
1442
- 'lifetimeValue': number;
1443
- /**
1444
- *
1445
- * @type {number}
1446
- * @memberof Statistics
1447
- */
1448
- 'totalOrderCount': number;
1449
- /**
1450
- *
1451
- * @type {string}
1452
- * @memberof Statistics
1453
- */
1454
- 'lastPurchased': string | null;
1455
- }
1456
- /**
1457
- *
1458
- * @export
1459
- * @interface StatusHistoryItem
1460
- */
1461
- export interface StatusHistoryItem {
1462
- /**
1463
- *
1464
- * @type {OrderStatus}
1465
- * @memberof StatusHistoryItem
1466
- */
1467
- 'status'?: OrderStatus;
1468
- /**
1469
- * ISO 8601 Timestamp
1470
- * @type {string}
1471
- * @memberof StatusHistoryItem
1472
- */
1473
- 'createdAt'?: string;
1474
- }
1475
- /**
1476
- *
1477
- * @export
1478
- * @interface UpdateFulfillmentRequest
1479
- */
1480
- export interface UpdateFulfillmentRequest {
1481
- /**
1482
- * Unique object identifier
1483
- * @type {string}
1484
- * @memberof UpdateFulfillmentRequest
1485
- */
1486
- 'fulfillerId'?: string;
1487
- }
1488
- /**
1489
- *
1490
- * @export
1491
- * @interface UpdatePlatformRequest
1492
- */
1493
- export interface UpdatePlatformRequest {
1494
- /**
1495
- *
1496
- * @type {Array<PlatformLogo>}
1497
- * @memberof UpdatePlatformRequest
1498
- */
1499
- 'logos'?: Array<PlatformLogo>;
1500
- /**
1501
- *
1502
- * @type {string}
1503
- * @memberof UpdatePlatformRequest
1504
- */
1505
- 'favicon'?: string;
1506
- /**
1507
- *
1508
- * @type {boolean}
1509
- * @memberof UpdatePlatformRequest
1510
- */
1511
- 'clientGiftWrapAvailable'?: boolean;
1512
- /**
1513
- *
1514
- * @type {number}
1515
- * @memberof UpdatePlatformRequest
1516
- */
1517
- 'storeSubscriptionFee'?: number;
1518
- /**
1519
- *
1520
- * @type {number}
1521
- * @memberof UpdatePlatformRequest
1522
- */
1523
- 'orderHandlingFee'?: number;
1524
- /**
1525
- *
1526
- * @type {number}
1527
- * @memberof UpdatePlatformRequest
1528
- */
1529
- 'itemHandlingFee'?: number;
1530
- /**
1531
- *
1532
- * @type {boolean}
1533
- * @memberof UpdatePlatformRequest
1534
- */
1535
- 'chargeClients'?: boolean;
1536
- }
1537
- /**
1538
- *
1539
- * @export
1540
- * @interface UpdateProductRequest
1541
- */
1542
- export interface UpdateProductRequest {
1543
- /**
1544
- * The warehouse variants of the product to update
1545
- * @type {Array<UpdateProductRequestVariantsInner>}
1546
- * @memberof UpdateProductRequest
1547
- */
1548
- 'variants'?: Array<UpdateProductRequestVariantsInner>;
1549
- /**
1550
- * Whether the platform warehouse product should be enabled or not
1551
- * @type {boolean}
1552
- * @memberof UpdateProductRequest
1553
- */
1554
- 'enabled'?: boolean;
1555
- }
1556
- /**
1557
- *
1558
- * @export
1559
- * @interface UpdateProductRequestVariantsInner
1560
- */
1561
- export interface UpdateProductRequestVariantsInner {
1562
- /**
1563
- * The ID of the variant to update
1564
- * @type {string}
1565
- * @memberof UpdateProductRequestVariantsInner
1566
- */
1567
- 'id': string;
1568
- /**
1569
- * Whether the warehouse variant should be enabled or not
1570
- * @type {boolean}
1571
- * @memberof UpdateProductRequestVariantsInner
1572
- */
1573
- 'enabled'?: boolean;
1574
- }
1575
- /**
1576
- *
1577
- * @export
1578
- * @interface UpdateVariantRequest
1579
- */
1580
- export interface UpdateVariantRequest {
1581
- /**
1582
- * Whether the platform warehouse variant is enabled or not
1583
- * @type {boolean}
1584
- * @memberof UpdateVariantRequest
1585
- */
1586
- 'enabled'?: boolean;
1587
- }
1588
- /**
1589
- *
1590
- * @export
1591
- * @interface ValidationError
1592
- */
1593
- export interface ValidationError {
1594
- /**
1595
- *
1596
- * @type {string}
1597
- * @memberof ValidationError
1598
- */
1599
- 'message': string;
1600
- }
1601
- /**
1602
- *
1603
- * @export
1604
- * @interface Variant
1605
- */
1606
- export interface Variant {
1607
- /**
1608
- * Unique object identifier
1609
- * @type {string}
1610
- * @memberof Variant
1611
- */
1612
- 'id': string;
1613
- /**
1614
- * A reference to the resource location
1615
- * @type {string}
1616
- * @memberof Variant
1617
- */
1618
- 'ref': string;
1619
- /**
1620
- *
1621
- * @type {ProductVariantsInner}
1622
- * @memberof Variant
1623
- */
1624
- 'product'?: ProductVariantsInner;
1625
- /**
1626
- *
1627
- * @type {string}
1628
- * @memberof Variant
1629
- */
1630
- 'sku': string;
1631
- /**
1632
- * ISO 8601 Timestamp
1633
- * @type {string}
1634
- * @memberof Variant
1635
- */
1636
- 'createdAt'?: string;
1637
- /**
1638
- * ISO 8601 Timestamp
1639
- * @type {string}
1640
- * @memberof Variant
1641
- */
1642
- 'updatedAt'?: string;
1643
- /**
1644
- * Images
1645
- * @type {Array<Image>}
1646
- * @memberof Variant
1647
- */
1648
- 'images'?: Array<Image>;
1649
- /**
1650
- * Weight in kg
1651
- * @type {number}
1652
- * @memberof Variant
1653
- */
1654
- 'weight'?: number;
1655
- /**
1656
- * The number of units that can be packed in a single pickface
1657
- * @type {number}
1658
- * @memberof Variant
1659
- */
1660
- 'packVolume'?: number;
1661
- /**
1662
- *
1663
- * @type {VariantPackedDimensions}
1664
- * @memberof Variant
1665
- */
1666
- 'packedDimensions'?: VariantPackedDimensions;
1667
- /**
1668
- * Whether the variant can be pre-ordered
1669
- * @type {boolean}
1670
- * @memberof Variant
1671
- */
1672
- 'preOrderable'?: boolean;
1673
- /**
1674
- * Whether the variant is enabled
1675
- * @type {boolean}
1676
- * @memberof Variant
1085
+ /**
1086
+ *
1087
+ * @type {Price}
1088
+ * @memberof ShippingMethod
1677
1089
  */
1678
- 'enabled'?: boolean;
1090
+ 'subtotalPrice'?: Price;
1679
1091
  /**
1680
- * Whether the variant is discontinued
1681
- * @type {boolean}
1682
- * @memberof Variant
1092
+ *
1093
+ * @type {Price}
1094
+ * @memberof ShippingMethod
1683
1095
  */
1684
- 'discontinued'?: boolean;
1096
+ 'discountPrice'?: Price;
1097
+ }
1098
+ /**
1099
+ *
1100
+ * @export
1101
+ * @interface Statistics
1102
+ */
1103
+ export interface Statistics {
1685
1104
  /**
1686
1105
  *
1687
- * @type {VariantManufacturerOrigin}
1688
- * @memberof Variant
1106
+ * @type {number}
1107
+ * @memberof Statistics
1689
1108
  */
1690
- 'manufacturerOrigin'?: VariantManufacturerOrigin;
1109
+ 'lifetimeValue': number;
1691
1110
  /**
1692
- * Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours.
1693
- * @type {Array<VariantAttribute>}
1694
- * @memberof Variant
1111
+ *
1112
+ * @type {number}
1113
+ * @memberof Statistics
1695
1114
  */
1696
- 'attributes': Array<VariantAttribute>;
1115
+ 'totalOrderCount': number;
1697
1116
  /**
1698
- * Applications of the variant
1699
- * @type {Array<Application>}
1700
- * @memberof Variant
1117
+ *
1118
+ * @type {string}
1119
+ * @memberof Statistics
1701
1120
  */
1702
- 'applications'?: Array<Application>;
1121
+ 'lastPurchased': string | null;
1703
1122
  }
1704
1123
  /**
1705
1124
  *
1706
1125
  * @export
1707
- * @interface Variant1
1126
+ * @interface StatusHistoryItem
1708
1127
  */
1709
- export interface Variant1 {
1128
+ export interface StatusHistoryItem {
1710
1129
  /**
1711
- * Unique object identifier
1712
- * @type {string}
1713
- * @memberof Variant1
1130
+ *
1131
+ * @type {OrderStatus}
1132
+ * @memberof StatusHistoryItem
1714
1133
  */
1715
- 'id': string;
1134
+ 'status'?: OrderStatus;
1716
1135
  /**
1717
- * A reference to the resource location
1136
+ * ISO 8601 Timestamp
1718
1137
  * @type {string}
1719
- * @memberof Variant1
1138
+ * @memberof StatusHistoryItem
1720
1139
  */
1721
- 'ref': string;
1140
+ 'createdAt'?: string;
1141
+ }
1142
+ /**
1143
+ *
1144
+ * @export
1145
+ * @interface UpdateFulfillmentRequest
1146
+ */
1147
+ export interface UpdateFulfillmentRequest {
1722
1148
  /**
1723
- * A reference to the resource location
1149
+ * Unique object identifier
1724
1150
  * @type {string}
1725
- * @memberof Variant1
1151
+ * @memberof UpdateFulfillmentRequest
1726
1152
  */
1727
- 'warehouseVariantRef': string;
1153
+ 'fulfillerId'?: string;
1728
1154
  }
1729
1155
  /**
1730
1156
  *
1731
1157
  * @export
1732
- * @interface VariantAttribute
1158
+ * @interface UpdatePlatformRequest
1733
1159
  */
1734
- export interface VariantAttribute {
1160
+ export interface UpdatePlatformRequest {
1735
1161
  /**
1736
- * Attribute name
1737
- * @type {string}
1738
- * @memberof VariantAttribute
1162
+ *
1163
+ * @type {Array<PlatformLogo>}
1164
+ * @memberof UpdatePlatformRequest
1739
1165
  */
1740
- 'name': string;
1166
+ 'logos'?: Array<PlatformLogo>;
1741
1167
  /**
1742
- * Attribute value
1168
+ *
1743
1169
  * @type {string}
1744
- * @memberof VariantAttribute
1170
+ * @memberof UpdatePlatformRequest
1745
1171
  */
1746
- 'value': string;
1172
+ 'favicon'?: string;
1747
1173
  /**
1748
1174
  *
1749
- * @type {VariantAttributeThumbnail}
1750
- * @memberof VariantAttribute
1175
+ * @type {boolean}
1176
+ * @memberof UpdatePlatformRequest
1751
1177
  */
1752
- 'thumbnail'?: VariantAttributeThumbnail;
1178
+ 'clientGiftWrapAvailable'?: boolean;
1753
1179
  /**
1754
- * Attribute tags
1755
- * @type {Array<string>}
1756
- * @memberof VariantAttribute
1180
+ *
1181
+ * @type {number}
1182
+ * @memberof UpdatePlatformRequest
1757
1183
  */
1758
- 'tags'?: Array<string>;
1759
- }
1760
- /**
1761
- * Attribute thumbnail
1762
- * @export
1763
- * @interface VariantAttributeThumbnail
1764
- */
1765
- export interface VariantAttributeThumbnail {
1184
+ 'storeSubscriptionFee'?: number;
1766
1185
  /**
1767
1186
  *
1768
- * @type {string}
1769
- * @memberof VariantAttributeThumbnail
1187
+ * @type {number}
1188
+ * @memberof UpdatePlatformRequest
1770
1189
  */
1771
- 'type'?: VariantAttributeThumbnailTypeEnum;
1190
+ 'orderHandlingFee'?: number;
1772
1191
  /**
1773
1192
  *
1774
- * @type {string}
1775
- * @memberof VariantAttributeThumbnail
1193
+ * @type {number}
1194
+ * @memberof UpdatePlatformRequest
1195
+ */
1196
+ 'itemHandlingFee'?: number;
1197
+ /**
1198
+ *
1199
+ * @type {boolean}
1200
+ * @memberof UpdatePlatformRequest
1776
1201
  */
1777
- 'value'?: string;
1202
+ 'chargeClients'?: boolean;
1778
1203
  }
1779
- export declare const VariantAttributeThumbnailTypeEnum: {
1780
- readonly Text: "text";
1781
- readonly Color: "color";
1782
- readonly Image: "image";
1783
- };
1784
- export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
1785
1204
  /**
1786
- * Where the product was originally produced or manufactured
1205
+ *
1787
1206
  * @export
1788
- * @interface VariantManufacturerOrigin
1207
+ * @interface ValidationError
1789
1208
  */
1790
- export interface VariantManufacturerOrigin {
1209
+ export interface ValidationError {
1791
1210
  /**
1792
- * Country of origin (ISO 3166-1 alpha-2).
1211
+ *
1793
1212
  * @type {string}
1794
- * @memberof VariantManufacturerOrigin
1213
+ * @memberof ValidationError
1795
1214
  */
1796
- 'country'?: string;
1215
+ 'message': string;
1797
1216
  }
1798
1217
  /**
1799
1218
  *
1800
1219
  * @export
1801
- * @interface VariantPackedDimensions
1220
+ * @interface Variant
1802
1221
  */
1803
- export interface VariantPackedDimensions {
1222
+ export interface Variant {
1804
1223
  /**
1805
- * Length in mm
1806
- * @type {number}
1807
- * @memberof VariantPackedDimensions
1224
+ * Unique object identifier
1225
+ * @type {string}
1226
+ * @memberof Variant
1808
1227
  */
1809
- 'length'?: number;
1228
+ 'id': string;
1810
1229
  /**
1811
- * Width in mm
1812
- * @type {number}
1813
- * @memberof VariantPackedDimensions
1230
+ * A reference to the resource location
1231
+ * @type {string}
1232
+ * @memberof Variant
1814
1233
  */
1815
- 'width'?: number;
1234
+ 'ref': string;
1816
1235
  /**
1817
- * Depth in mm
1818
- * @type {number}
1819
- * @memberof VariantPackedDimensions
1236
+ * A reference to the resource location
1237
+ * @type {string}
1238
+ * @memberof Variant
1820
1239
  */
1821
- 'depth'?: number;
1240
+ 'warehouseVariantRef': string;
1822
1241
  }
1823
1242
  /**
1824
1243
  * CustomersApi - axios parameter creator
@@ -1856,7 +1275,7 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
1856
1275
  * @param {string} platformId The platform identifier
1857
1276
  * @param {number} [pageToken] Page reference token
1858
1277
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1859
- * @param {string} [search] Search term to filter based on order reference, customer name and email
1278
+ * @param {string} [search] Search term to filter results
1860
1279
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1861
1280
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1862
1281
  * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
@@ -1903,7 +1322,7 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
1903
1322
  * @param {string} platformId The platform identifier
1904
1323
  * @param {number} [pageToken] Page reference token
1905
1324
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1906
- * @param {string} [search] Search term to filter based on order reference, customer name and email
1325
+ * @param {string} [search] Search term to filter results
1907
1326
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1908
1327
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1909
1328
  * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
@@ -2049,7 +1468,7 @@ export interface CustomersApiListCustomersRequest {
2049
1468
  */
2050
1469
  readonly pageSize?: number;
2051
1470
  /**
2052
- * Search term to filter based on order reference, customer name and email
1471
+ * Search term to filter results
2053
1472
  * @type {string}
2054
1473
  * @memberof CustomersApiListCustomers
2055
1474
  */
@@ -2906,194 +2325,332 @@ export declare class PlatformApi extends BaseAPI {
2906
2325
  updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
2907
2326
  }
2908
2327
  /**
2909
- * ProductsApi - axios parameter creator
2328
+ * ReviewsApi - axios parameter creator
2910
2329
  * @export
2911
2330
  */
2912
- export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
2331
+ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
2332
+ /**
2333
+ * Export reviews as a CSV file.
2334
+ * @summary Export reviews
2335
+ * @param {string} project Project unique identifier
2336
+ * @param {string} platformId The platform identifier
2337
+ * @param {string} start Start of date range to filter by
2338
+ * @param {string} [end] End of date range to filter by
2339
+ * @param {*} [options] Override http request option.
2340
+ * @throws {RequiredError}
2341
+ */
2342
+ exportReviews: (project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2343
+ /**
2344
+ * Get a review left on a platform by a given review ID.
2345
+ * @summary Get review
2346
+ * @param {string} project Project unique identifier
2347
+ * @param {string} platformId The platform identifier
2348
+ * @param {string} reviewId The review identifier
2349
+ * @param {*} [options] Override http request option.
2350
+ * @throws {RequiredError}
2351
+ */
2352
+ getReview: (project: string, platformId: string, reviewId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2353
+ /**
2354
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
2355
+ * @summary List reviews
2356
+ * @param {string} project Project unique identifier
2357
+ * @param {string} platformId The platform identifier
2358
+ * @param {number} [pageToken] Page reference token
2359
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2360
+ * @param {string} [search] Search term to filter results
2361
+ * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2362
+ * @param {string} [start] Start of date range to filter by
2363
+ * @param {string} [end] End of date range to filter by
2364
+ * @param {*} [options] Override http request option.
2365
+ * @throws {RequiredError}
2366
+ */
2367
+ listReviews: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2913
2368
  /**
2914
- * Updates the warehouse product and its variants
2915
- * @summary Update warehouse product
2369
+ * Moderate a review left on a platform.
2370
+ * @summary Moderate review
2916
2371
  * @param {string} project Project unique identifier
2917
2372
  * @param {string} platformId The platform identifier
2918
- * @param {string} productId Products unique identifier
2919
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
2373
+ * @param {string} reviewId The review identifier
2374
+ * @param {ModerateReviewRequest} [moderateReviewRequest]
2920
2375
  * @param {*} [options] Override http request option.
2921
2376
  * @throws {RequiredError}
2922
2377
  */
2923
- updateProduct: (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2378
+ moderateReview: (project: string, platformId: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2924
2379
  };
2925
2380
  /**
2926
- * ProductsApi - functional programming interface
2381
+ * ReviewsApi - functional programming interface
2927
2382
  * @export
2928
2383
  */
2929
- export declare const ProductsApiFp: (configuration?: Configuration) => {
2384
+ export declare const ReviewsApiFp: (configuration?: Configuration) => {
2385
+ /**
2386
+ * Export reviews as a CSV file.
2387
+ * @summary Export reviews
2388
+ * @param {string} project Project unique identifier
2389
+ * @param {string} platformId The platform identifier
2390
+ * @param {string} start Start of date range to filter by
2391
+ * @param {string} [end] End of date range to filter by
2392
+ * @param {*} [options] Override http request option.
2393
+ * @throws {RequiredError}
2394
+ */
2395
+ exportReviews(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
2396
+ /**
2397
+ * Get a review left on a platform by a given review ID.
2398
+ * @summary Get review
2399
+ * @param {string} project Project unique identifier
2400
+ * @param {string} platformId The platform identifier
2401
+ * @param {string} reviewId The review identifier
2402
+ * @param {*} [options] Override http request option.
2403
+ * @throws {RequiredError}
2404
+ */
2405
+ getReview(project: string, platformId: string, reviewId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>>;
2406
+ /**
2407
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
2408
+ * @summary List reviews
2409
+ * @param {string} project Project unique identifier
2410
+ * @param {string} platformId The platform identifier
2411
+ * @param {number} [pageToken] Page reference token
2412
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2413
+ * @param {string} [search] Search term to filter results
2414
+ * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2415
+ * @param {string} [start] Start of date range to filter by
2416
+ * @param {string} [end] End of date range to filter by
2417
+ * @param {*} [options] Override http request option.
2418
+ * @throws {RequiredError}
2419
+ */
2420
+ listReviews(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>>;
2930
2421
  /**
2931
- * Updates the warehouse product and its variants
2932
- * @summary Update warehouse product
2422
+ * Moderate a review left on a platform.
2423
+ * @summary Moderate review
2933
2424
  * @param {string} project Project unique identifier
2934
2425
  * @param {string} platformId The platform identifier
2935
- * @param {string} productId Products unique identifier
2936
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
2426
+ * @param {string} reviewId The review identifier
2427
+ * @param {ModerateReviewRequest} [moderateReviewRequest]
2937
2428
  * @param {*} [options] Override http request option.
2938
2429
  * @throws {RequiredError}
2939
2430
  */
2940
- updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
2431
+ moderateReview(project: string, platformId: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>>;
2941
2432
  };
2942
2433
  /**
2943
- * ProductsApi - factory interface
2434
+ * ReviewsApi - factory interface
2944
2435
  * @export
2945
2436
  */
2946
- export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2437
+ export declare const ReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2438
+ /**
2439
+ * Export reviews as a CSV file.
2440
+ * @summary Export reviews
2441
+ * @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
2442
+ * @param {*} [options] Override http request option.
2443
+ * @throws {RequiredError}
2444
+ */
2445
+ exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
2446
+ /**
2447
+ * Get a review left on a platform by a given review ID.
2448
+ * @summary Get review
2449
+ * @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
2450
+ * @param {*} [options] Override http request option.
2451
+ * @throws {RequiredError}
2452
+ */
2453
+ getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review>;
2454
+ /**
2455
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
2456
+ * @summary List reviews
2457
+ * @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
2458
+ * @param {*} [options] Override http request option.
2459
+ * @throws {RequiredError}
2460
+ */
2461
+ listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReviewsResponse>;
2947
2462
  /**
2948
- * Updates the warehouse product and its variants
2949
- * @summary Update warehouse product
2950
- * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
2463
+ * Moderate a review left on a platform.
2464
+ * @summary Moderate review
2465
+ * @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
2951
2466
  * @param {*} [options] Override http request option.
2952
2467
  * @throws {RequiredError}
2953
2468
  */
2954
- updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
2469
+ moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review>;
2955
2470
  };
2956
2471
  /**
2957
- * Request parameters for updateProduct operation in ProductsApi.
2472
+ * Request parameters for exportReviews operation in ReviewsApi.
2958
2473
  * @export
2959
- * @interface ProductsApiUpdateProductRequest
2474
+ * @interface ReviewsApiExportReviewsRequest
2960
2475
  */
2961
- export interface ProductsApiUpdateProductRequest {
2476
+ export interface ReviewsApiExportReviewsRequest {
2962
2477
  /**
2963
2478
  * Project unique identifier
2964
2479
  * @type {string}
2965
- * @memberof ProductsApiUpdateProduct
2480
+ * @memberof ReviewsApiExportReviews
2966
2481
  */
2967
2482
  readonly project: string;
2968
2483
  /**
2969
2484
  * The platform identifier
2970
2485
  * @type {string}
2971
- * @memberof ProductsApiUpdateProduct
2486
+ * @memberof ReviewsApiExportReviews
2972
2487
  */
2973
2488
  readonly platformId: string;
2974
2489
  /**
2975
- * Products unique identifier
2490
+ * Start of date range to filter by
2976
2491
  * @type {string}
2977
- * @memberof ProductsApiUpdateProduct
2492
+ * @memberof ReviewsApiExportReviews
2978
2493
  */
2979
- readonly productId: string;
2494
+ readonly start: string;
2980
2495
  /**
2981
- * Update a platform warehouse product
2982
- * @type {UpdateProductRequest}
2983
- * @memberof ProductsApiUpdateProduct
2496
+ * End of date range to filter by
2497
+ * @type {string}
2498
+ * @memberof ReviewsApiExportReviews
2984
2499
  */
2985
- readonly updateProductRequest: UpdateProductRequest;
2500
+ readonly end?: string;
2986
2501
  }
2987
2502
  /**
2988
- * ProductsApi - object-oriented interface
2503
+ * Request parameters for getReview operation in ReviewsApi.
2989
2504
  * @export
2990
- * @class ProductsApi
2991
- * @extends {BaseAPI}
2505
+ * @interface ReviewsApiGetReviewRequest
2992
2506
  */
2993
- export declare class ProductsApi extends BaseAPI {
2507
+ export interface ReviewsApiGetReviewRequest {
2994
2508
  /**
2995
- * Updates the warehouse product and its variants
2996
- * @summary Update warehouse product
2997
- * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
2998
- * @param {*} [options] Override http request option.
2999
- * @throws {RequiredError}
3000
- * @memberof ProductsApi
2509
+ * Project unique identifier
2510
+ * @type {string}
2511
+ * @memberof ReviewsApiGetReview
2512
+ */
2513
+ readonly project: string;
2514
+ /**
2515
+ * The platform identifier
2516
+ * @type {string}
2517
+ * @memberof ReviewsApiGetReview
2518
+ */
2519
+ readonly platformId: string;
2520
+ /**
2521
+ * The review identifier
2522
+ * @type {string}
2523
+ * @memberof ReviewsApiGetReview
3001
2524
  */
3002
- updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
2525
+ readonly reviewId: string;
3003
2526
  }
3004
2527
  /**
3005
- * VariantsApi - axios parameter creator
2528
+ * Request parameters for listReviews operation in ReviewsApi.
3006
2529
  * @export
2530
+ * @interface ReviewsApiListReviewsRequest
3007
2531
  */
3008
- export declare const VariantsApiAxiosParamCreator: (configuration?: Configuration) => {
2532
+ export interface ReviewsApiListReviewsRequest {
3009
2533
  /**
3010
- * Updates the warehouse variant
3011
- * @summary Update warehouse variant
3012
- * @param {string} project Project unique identifier
3013
- * @param {string} platformId The platform identifier
3014
- * @param {string} variantId Variants unique identifier
3015
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
3016
- * @param {*} [options] Override http request option.
3017
- * @throws {RequiredError}
2534
+ * Project unique identifier
2535
+ * @type {string}
2536
+ * @memberof ReviewsApiListReviews
3018
2537
  */
3019
- updateVariant: (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3020
- };
3021
- /**
3022
- * VariantsApi - functional programming interface
3023
- * @export
3024
- */
3025
- export declare const VariantsApiFp: (configuration?: Configuration) => {
2538
+ readonly project: string;
3026
2539
  /**
3027
- * Updates the warehouse variant
3028
- * @summary Update warehouse variant
3029
- * @param {string} project Project unique identifier
3030
- * @param {string} platformId The platform identifier
3031
- * @param {string} variantId Variants unique identifier
3032
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
3033
- * @param {*} [options] Override http request option.
3034
- * @throws {RequiredError}
2540
+ * The platform identifier
2541
+ * @type {string}
2542
+ * @memberof ReviewsApiListReviews
3035
2543
  */
3036
- updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>>;
3037
- };
3038
- /**
3039
- * VariantsApi - factory interface
3040
- * @export
3041
- */
3042
- export declare const VariantsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2544
+ readonly platformId: string;
3043
2545
  /**
3044
- * Updates the warehouse variant
3045
- * @summary Update warehouse variant
3046
- * @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
3047
- * @param {*} [options] Override http request option.
3048
- * @throws {RequiredError}
2546
+ * Page reference token
2547
+ * @type {number}
2548
+ * @memberof ReviewsApiListReviews
3049
2549
  */
3050
- updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
3051
- };
2550
+ readonly pageToken?: number;
2551
+ /**
2552
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2553
+ * @type {number}
2554
+ * @memberof ReviewsApiListReviews
2555
+ */
2556
+ readonly pageSize?: number;
2557
+ /**
2558
+ * Search term to filter results
2559
+ * @type {string}
2560
+ * @memberof ReviewsApiListReviews
2561
+ */
2562
+ readonly search?: string;
2563
+ /**
2564
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2565
+ * @type {Array<string>}
2566
+ * @memberof ReviewsApiListReviews
2567
+ */
2568
+ readonly sortBy?: Array<string>;
2569
+ /**
2570
+ * Start of date range to filter by
2571
+ * @type {string}
2572
+ * @memberof ReviewsApiListReviews
2573
+ */
2574
+ readonly start?: string;
2575
+ /**
2576
+ * End of date range to filter by
2577
+ * @type {string}
2578
+ * @memberof ReviewsApiListReviews
2579
+ */
2580
+ readonly end?: string;
2581
+ }
3052
2582
  /**
3053
- * Request parameters for updateVariant operation in VariantsApi.
2583
+ * Request parameters for moderateReview operation in ReviewsApi.
3054
2584
  * @export
3055
- * @interface VariantsApiUpdateVariantRequest
2585
+ * @interface ReviewsApiModerateReviewRequest
3056
2586
  */
3057
- export interface VariantsApiUpdateVariantRequest {
2587
+ export interface ReviewsApiModerateReviewRequest {
3058
2588
  /**
3059
2589
  * Project unique identifier
3060
2590
  * @type {string}
3061
- * @memberof VariantsApiUpdateVariant
2591
+ * @memberof ReviewsApiModerateReview
3062
2592
  */
3063
2593
  readonly project: string;
3064
2594
  /**
3065
2595
  * The platform identifier
3066
2596
  * @type {string}
3067
- * @memberof VariantsApiUpdateVariant
2597
+ * @memberof ReviewsApiModerateReview
3068
2598
  */
3069
2599
  readonly platformId: string;
3070
2600
  /**
3071
- * Variants unique identifier
2601
+ * The review identifier
3072
2602
  * @type {string}
3073
- * @memberof VariantsApiUpdateVariant
2603
+ * @memberof ReviewsApiModerateReview
3074
2604
  */
3075
- readonly variantId: string;
2605
+ readonly reviewId: string;
3076
2606
  /**
3077
- * Update a platform warehouse variant
3078
- * @type {UpdateVariantRequest}
3079
- * @memberof VariantsApiUpdateVariant
2607
+ *
2608
+ * @type {ModerateReviewRequest}
2609
+ * @memberof ReviewsApiModerateReview
3080
2610
  */
3081
- readonly updateVariantRequest: UpdateVariantRequest;
2611
+ readonly moderateReviewRequest?: ModerateReviewRequest;
3082
2612
  }
3083
2613
  /**
3084
- * VariantsApi - object-oriented interface
2614
+ * ReviewsApi - object-oriented interface
3085
2615
  * @export
3086
- * @class VariantsApi
2616
+ * @class ReviewsApi
3087
2617
  * @extends {BaseAPI}
3088
2618
  */
3089
- export declare class VariantsApi extends BaseAPI {
2619
+ export declare class ReviewsApi extends BaseAPI {
2620
+ /**
2621
+ * Export reviews as a CSV file.
2622
+ * @summary Export reviews
2623
+ * @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
2624
+ * @param {*} [options] Override http request option.
2625
+ * @throws {RequiredError}
2626
+ * @memberof ReviewsApi
2627
+ */
2628
+ exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
2629
+ /**
2630
+ * Get a review left on a platform by a given review ID.
2631
+ * @summary Get review
2632
+ * @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
2633
+ * @param {*} [options] Override http request option.
2634
+ * @throws {RequiredError}
2635
+ * @memberof ReviewsApi
2636
+ */
2637
+ getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Review, any>>;
2638
+ /**
2639
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
2640
+ * @summary List reviews
2641
+ * @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
2642
+ * @param {*} [options] Override http request option.
2643
+ * @throws {RequiredError}
2644
+ * @memberof ReviewsApi
2645
+ */
2646
+ listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReviewsResponse, any>>;
3090
2647
  /**
3091
- * Updates the warehouse variant
3092
- * @summary Update warehouse variant
3093
- * @param {VariantsApiUpdateVariantRequest} requestParameters Request parameters.
2648
+ * Moderate a review left on a platform.
2649
+ * @summary Moderate review
2650
+ * @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
3094
2651
  * @param {*} [options] Override http request option.
3095
2652
  * @throws {RequiredError}
3096
- * @memberof VariantsApi
2653
+ * @memberof ReviewsApi
3097
2654
  */
3098
- updateVariant(requestParameters: VariantsApiUpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
2655
+ moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Review, any>>;
3099
2656
  }