@teemill/platform 0.15.0 → 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 +819 -4
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +540 -4
  7. package/dist/api.js +418 -4
  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 +540 -4
  15. package/dist/esm/api.js +413 -3
  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/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.15.0
7
+ * The version of the OpenAPI document: 0.16.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -399,6 +399,19 @@ export interface Image {
399
399
  */
400
400
  'sortOrder'?: number;
401
401
  }
402
+ /**
403
+ *
404
+ * @export
405
+ * @interface ModerateReviewRequest
406
+ */
407
+ export interface ModerateReviewRequest {
408
+ /**
409
+ * Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
410
+ * @type {boolean}
411
+ * @memberof ModerateReviewRequest
412
+ */
413
+ 'enabled'?: boolean;
414
+ }
402
415
  /**
403
416
  *
404
417
  * @export
@@ -851,6 +864,199 @@ export interface Project {
851
864
  */
852
865
  'name': string;
853
866
  }
867
+ /**
868
+ *
869
+ * @export
870
+ * @interface Review
871
+ */
872
+ export interface Review {
873
+ /**
874
+ * Unique object identifier
875
+ * @type {string}
876
+ * @memberof Review
877
+ */
878
+ 'id': string;
879
+ /**
880
+ * Text content of the review
881
+ * @type {string}
882
+ * @memberof Review
883
+ */
884
+ 'text': string;
885
+ /**
886
+ *
887
+ * @type {ReviewProduct}
888
+ * @memberof Review
889
+ */
890
+ 'product'?: ReviewProduct;
891
+ /**
892
+ *
893
+ * @type {ReviewAuthor}
894
+ * @memberof Review
895
+ */
896
+ 'author'?: ReviewAuthor;
897
+ /**
898
+ * Rating of the review
899
+ * @type {number}
900
+ * @memberof Review
901
+ */
902
+ 'rating'?: number;
903
+ /**
904
+ * Google\'s sentiment analysis score
905
+ * @type {number}
906
+ * @memberof Review
907
+ */
908
+ 'sentiment'?: number;
909
+ /**
910
+ * Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
911
+ * @type {boolean}
912
+ * @memberof Review
913
+ */
914
+ 'enabled': boolean;
915
+ /**
916
+ *
917
+ * @type {string}
918
+ * @memberof Review
919
+ */
920
+ 'createdAt'?: string;
921
+ /**
922
+ *
923
+ * @type {Project}
924
+ * @memberof Review
925
+ */
926
+ 'project': Project;
927
+ /**
928
+ *
929
+ * @type {Array<ReviewImagesInner>}
930
+ * @memberof Review
931
+ */
932
+ 'images'?: Array<ReviewImagesInner>;
933
+ /**
934
+ *
935
+ * @type {Array<ReviewReply>}
936
+ * @memberof Review
937
+ */
938
+ 'replies'?: Array<ReviewReply>;
939
+ }
940
+ /**
941
+ *
942
+ * @export
943
+ * @interface ReviewAuthor
944
+ */
945
+ export interface ReviewAuthor {
946
+ /**
947
+ * Name of the review\'s author
948
+ * @type {string}
949
+ * @memberof ReviewAuthor
950
+ */
951
+ 'name'?: string;
952
+ /**
953
+ * Email of the review\'s author
954
+ * @type {string}
955
+ * @memberof ReviewAuthor
956
+ */
957
+ 'email'?: string;
958
+ }
959
+ /**
960
+ *
961
+ * @export
962
+ * @interface ReviewImagesInner
963
+ */
964
+ export interface ReviewImagesInner {
965
+ /**
966
+ * URL of the image
967
+ * @type {string}
968
+ * @memberof ReviewImagesInner
969
+ */
970
+ 'src'?: string;
971
+ /**
972
+ * Alternative text for the image
973
+ * @type {string}
974
+ * @memberof ReviewImagesInner
975
+ */
976
+ 'alt'?: string;
977
+ }
978
+ /**
979
+ * The product that the review is for
980
+ * @export
981
+ * @interface ReviewProduct
982
+ */
983
+ export interface ReviewProduct {
984
+ /**
985
+ * Unique object identifier
986
+ * @type {string}
987
+ * @memberof ReviewProduct
988
+ */
989
+ 'id'?: string;
990
+ /**
991
+ * The title of the product
992
+ * @type {string}
993
+ * @memberof ReviewProduct
994
+ */
995
+ 'title'?: string;
996
+ }
997
+ /**
998
+ *
999
+ * @export
1000
+ * @interface ReviewReply
1001
+ */
1002
+ export interface ReviewReply {
1003
+ /**
1004
+ * Unique object identifier
1005
+ * @type {string}
1006
+ * @memberof ReviewReply
1007
+ */
1008
+ 'id': string;
1009
+ /**
1010
+ * Text content of the reply
1011
+ * @type {string}
1012
+ * @memberof ReviewReply
1013
+ */
1014
+ 'text': string;
1015
+ /**
1016
+ *
1017
+ * @type {ReviewReplyAuthor}
1018
+ * @memberof ReviewReply
1019
+ */
1020
+ 'author'?: ReviewReplyAuthor;
1021
+ /**
1022
+ *
1023
+ * @type {string}
1024
+ * @memberof ReviewReply
1025
+ */
1026
+ 'createdAt'?: string;
1027
+ }
1028
+ /**
1029
+ *
1030
+ * @export
1031
+ * @interface ReviewReplyAuthor
1032
+ */
1033
+ export interface ReviewReplyAuthor {
1034
+ /**
1035
+ * Name of the reply\'s author
1036
+ * @type {string}
1037
+ * @memberof ReviewReplyAuthor
1038
+ */
1039
+ 'name'?: string;
1040
+ }
1041
+ /**
1042
+ *
1043
+ * @export
1044
+ * @interface ReviewsResponse
1045
+ */
1046
+ export interface ReviewsResponse {
1047
+ /**
1048
+ *
1049
+ * @type {Array<Review>}
1050
+ * @memberof ReviewsResponse
1051
+ */
1052
+ 'reviews'?: Array<Review>;
1053
+ /**
1054
+ * The token referencing the next page number
1055
+ * @type {number}
1056
+ * @memberof ReviewsResponse
1057
+ */
1058
+ 'nextPageToken'?: number | null;
1059
+ }
854
1060
  /**
855
1061
  *
856
1062
  * @export
@@ -1193,7 +1399,7 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
1193
1399
  * @param {string} platformId The platform identifier
1194
1400
  * @param {number} [pageToken] Page reference token
1195
1401
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1196
- * @param {string} [search] Search term to filter based on order reference, customer name and email
1402
+ * @param {string} [search] Search term to filter results
1197
1403
  * @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.
1198
1404
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1199
1405
  * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
@@ -1327,7 +1533,7 @@ export const CustomersApiFp = function(configuration?: Configuration) {
1327
1533
  * @param {string} platformId The platform identifier
1328
1534
  * @param {number} [pageToken] Page reference token
1329
1535
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1330
- * @param {string} [search] Search term to filter based on order reference, customer name and email
1536
+ * @param {string} [search] Search term to filter results
1331
1537
  * @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.
1332
1538
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1333
1539
  * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
@@ -1504,7 +1710,7 @@ export interface CustomersApiListCustomersRequest {
1504
1710
  readonly pageSize?: number
1505
1711
 
1506
1712
  /**
1507
- * Search term to filter based on order reference, customer name and email
1713
+ * Search term to filter results
1508
1714
  * @type {string}
1509
1715
  * @memberof CustomersApiListCustomers
1510
1716
  */
@@ -3040,3 +3246,612 @@ export class PlatformApi extends BaseAPI {
3040
3246
 
3041
3247
 
3042
3248
 
3249
+ /**
3250
+ * ReviewsApi - axios parameter creator
3251
+ * @export
3252
+ */
3253
+ export const ReviewsApiAxiosParamCreator = function (configuration?: Configuration) {
3254
+ return {
3255
+ /**
3256
+ * Export reviews as a CSV file.
3257
+ * @summary Export reviews
3258
+ * @param {string} project Project unique identifier
3259
+ * @param {string} platformId The platform identifier
3260
+ * @param {string} start Start of date range to filter by
3261
+ * @param {string} [end] End of date range to filter by
3262
+ * @param {*} [options] Override http request option.
3263
+ * @throws {RequiredError}
3264
+ */
3265
+ exportReviews: async (project: string, platformId: string, start: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3266
+ // verify required parameter 'project' is not null or undefined
3267
+ assertParamExists('exportReviews', 'project', project)
3268
+ // verify required parameter 'platformId' is not null or undefined
3269
+ assertParamExists('exportReviews', 'platformId', platformId)
3270
+ // verify required parameter 'start' is not null or undefined
3271
+ assertParamExists('exportReviews', 'start', start)
3272
+ const localVarPath = `/v1/platform/{platformId}/reviews/export`
3273
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
3274
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3275
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3276
+ let baseOptions;
3277
+ if (configuration) {
3278
+ baseOptions = configuration.baseOptions;
3279
+ }
3280
+
3281
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3282
+ const localVarHeaderParameter = {} as any;
3283
+ const localVarQueryParameter = {} as any;
3284
+
3285
+ // authentication session-oauth required
3286
+ // oauth required
3287
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3288
+
3289
+ // authentication api-key required
3290
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3291
+
3292
+ if (project !== undefined) {
3293
+ localVarQueryParameter['project'] = project;
3294
+ }
3295
+
3296
+ if (start !== undefined) {
3297
+ localVarQueryParameter['start'] = (start as any instanceof Date) ?
3298
+ (start as any).toISOString() :
3299
+ start;
3300
+ }
3301
+
3302
+ if (end !== undefined) {
3303
+ localVarQueryParameter['end'] = (end as any instanceof Date) ?
3304
+ (end as any).toISOString() :
3305
+ end;
3306
+ }
3307
+
3308
+
3309
+
3310
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3311
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3312
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3313
+
3314
+ return {
3315
+ url: toPathString(localVarUrlObj),
3316
+ options: localVarRequestOptions,
3317
+ };
3318
+ },
3319
+ /**
3320
+ * Get a review left on a platform by a given review ID.
3321
+ * @summary Get review
3322
+ * @param {string} project Project unique identifier
3323
+ * @param {string} platformId The platform identifier
3324
+ * @param {string} reviewId The review identifier
3325
+ * @param {*} [options] Override http request option.
3326
+ * @throws {RequiredError}
3327
+ */
3328
+ getReview: async (project: string, platformId: string, reviewId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3329
+ // verify required parameter 'project' is not null or undefined
3330
+ assertParamExists('getReview', 'project', project)
3331
+ // verify required parameter 'platformId' is not null or undefined
3332
+ assertParamExists('getReview', 'platformId', platformId)
3333
+ // verify required parameter 'reviewId' is not null or undefined
3334
+ assertParamExists('getReview', 'reviewId', reviewId)
3335
+ const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}`
3336
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3337
+ .replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
3338
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3339
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3340
+ let baseOptions;
3341
+ if (configuration) {
3342
+ baseOptions = configuration.baseOptions;
3343
+ }
3344
+
3345
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3346
+ const localVarHeaderParameter = {} as any;
3347
+ const localVarQueryParameter = {} as any;
3348
+
3349
+ // authentication session-oauth required
3350
+ // oauth required
3351
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3352
+
3353
+ // authentication api-key required
3354
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3355
+
3356
+ if (project !== undefined) {
3357
+ localVarQueryParameter['project'] = project;
3358
+ }
3359
+
3360
+
3361
+
3362
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3363
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3364
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3365
+
3366
+ return {
3367
+ url: toPathString(localVarUrlObj),
3368
+ options: localVarRequestOptions,
3369
+ };
3370
+ },
3371
+ /**
3372
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
3373
+ * @summary List reviews
3374
+ * @param {string} project Project unique identifier
3375
+ * @param {string} platformId The platform identifier
3376
+ * @param {number} [pageToken] Page reference token
3377
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3378
+ * @param {string} [search] Search term to filter results
3379
+ * @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.
3380
+ * @param {string} [start] Start of date range to filter by
3381
+ * @param {string} [end] End of date range to filter by
3382
+ * @param {*} [options] Override http request option.
3383
+ * @throws {RequiredError}
3384
+ */
3385
+ listReviews: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3386
+ // verify required parameter 'project' is not null or undefined
3387
+ assertParamExists('listReviews', 'project', project)
3388
+ // verify required parameter 'platformId' is not null or undefined
3389
+ assertParamExists('listReviews', 'platformId', platformId)
3390
+ const localVarPath = `/v1/platform/{platformId}/reviews`
3391
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
3392
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3393
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3394
+ let baseOptions;
3395
+ if (configuration) {
3396
+ baseOptions = configuration.baseOptions;
3397
+ }
3398
+
3399
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3400
+ const localVarHeaderParameter = {} as any;
3401
+ const localVarQueryParameter = {} as any;
3402
+
3403
+ // authentication session-oauth required
3404
+ // oauth required
3405
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3406
+
3407
+ // authentication api-key required
3408
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3409
+
3410
+ if (project !== undefined) {
3411
+ localVarQueryParameter['project'] = project;
3412
+ }
3413
+
3414
+ if (pageToken !== undefined) {
3415
+ localVarQueryParameter['pageToken'] = pageToken;
3416
+ }
3417
+
3418
+ if (pageSize !== undefined) {
3419
+ localVarQueryParameter['pageSize'] = pageSize;
3420
+ }
3421
+
3422
+ if (search !== undefined) {
3423
+ localVarQueryParameter['search'] = search;
3424
+ }
3425
+
3426
+ if (sortBy) {
3427
+ localVarQueryParameter['sortBy'] = sortBy;
3428
+ }
3429
+
3430
+ if (start !== undefined) {
3431
+ localVarQueryParameter['start'] = (start as any instanceof Date) ?
3432
+ (start as any).toISOString() :
3433
+ start;
3434
+ }
3435
+
3436
+ if (end !== undefined) {
3437
+ localVarQueryParameter['end'] = (end as any instanceof Date) ?
3438
+ (end as any).toISOString() :
3439
+ end;
3440
+ }
3441
+
3442
+
3443
+
3444
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3445
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3446
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3447
+
3448
+ return {
3449
+ url: toPathString(localVarUrlObj),
3450
+ options: localVarRequestOptions,
3451
+ };
3452
+ },
3453
+ /**
3454
+ * Moderate a review left on a platform.
3455
+ * @summary Moderate review
3456
+ * @param {string} project Project unique identifier
3457
+ * @param {string} platformId The platform identifier
3458
+ * @param {string} reviewId The review identifier
3459
+ * @param {ModerateReviewRequest} [moderateReviewRequest]
3460
+ * @param {*} [options] Override http request option.
3461
+ * @throws {RequiredError}
3462
+ */
3463
+ moderateReview: async (project: string, platformId: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3464
+ // verify required parameter 'project' is not null or undefined
3465
+ assertParamExists('moderateReview', 'project', project)
3466
+ // verify required parameter 'platformId' is not null or undefined
3467
+ assertParamExists('moderateReview', 'platformId', platformId)
3468
+ // verify required parameter 'reviewId' is not null or undefined
3469
+ assertParamExists('moderateReview', 'reviewId', reviewId)
3470
+ const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}/moderate`
3471
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3472
+ .replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
3473
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3474
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3475
+ let baseOptions;
3476
+ if (configuration) {
3477
+ baseOptions = configuration.baseOptions;
3478
+ }
3479
+
3480
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
3481
+ const localVarHeaderParameter = {} as any;
3482
+ const localVarQueryParameter = {} as any;
3483
+
3484
+ // authentication session-oauth required
3485
+ // oauth required
3486
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3487
+
3488
+ // authentication api-key required
3489
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3490
+
3491
+ if (project !== undefined) {
3492
+ localVarQueryParameter['project'] = project;
3493
+ }
3494
+
3495
+
3496
+
3497
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3498
+
3499
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3500
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3501
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3502
+ localVarRequestOptions.data = serializeDataIfNeeded(moderateReviewRequest, localVarRequestOptions, configuration)
3503
+
3504
+ return {
3505
+ url: toPathString(localVarUrlObj),
3506
+ options: localVarRequestOptions,
3507
+ };
3508
+ },
3509
+ }
3510
+ };
3511
+
3512
+ /**
3513
+ * ReviewsApi - functional programming interface
3514
+ * @export
3515
+ */
3516
+ export const ReviewsApiFp = function(configuration?: Configuration) {
3517
+ const localVarAxiosParamCreator = ReviewsApiAxiosParamCreator(configuration)
3518
+ return {
3519
+ /**
3520
+ * Export reviews as a CSV file.
3521
+ * @summary Export reviews
3522
+ * @param {string} project Project unique identifier
3523
+ * @param {string} platformId The platform identifier
3524
+ * @param {string} start Start of date range to filter by
3525
+ * @param {string} [end] End of date range to filter by
3526
+ * @param {*} [options] Override http request option.
3527
+ * @throws {RequiredError}
3528
+ */
3529
+ async exportReviews(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
3530
+ const localVarAxiosArgs = await localVarAxiosParamCreator.exportReviews(project, platformId, start, end, options);
3531
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3532
+ const localVarOperationServerBasePath = operationServerMap['ReviewsApi.exportReviews']?.[localVarOperationServerIndex]?.url;
3533
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3534
+ },
3535
+ /**
3536
+ * Get a review left on a platform by a given review ID.
3537
+ * @summary Get review
3538
+ * @param {string} project Project unique identifier
3539
+ * @param {string} platformId The platform identifier
3540
+ * @param {string} reviewId The review identifier
3541
+ * @param {*} [options] Override http request option.
3542
+ * @throws {RequiredError}
3543
+ */
3544
+ async getReview(project: string, platformId: string, reviewId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>> {
3545
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getReview(project, platformId, reviewId, options);
3546
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3547
+ const localVarOperationServerBasePath = operationServerMap['ReviewsApi.getReview']?.[localVarOperationServerIndex]?.url;
3548
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3549
+ },
3550
+ /**
3551
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
3552
+ * @summary List reviews
3553
+ * @param {string} project Project unique identifier
3554
+ * @param {string} platformId The platform identifier
3555
+ * @param {number} [pageToken] Page reference token
3556
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3557
+ * @param {string} [search] Search term to filter results
3558
+ * @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.
3559
+ * @param {string} [start] Start of date range to filter by
3560
+ * @param {string} [end] End of date range to filter by
3561
+ * @param {*} [options] Override http request option.
3562
+ * @throws {RequiredError}
3563
+ */
3564
+ async 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>> {
3565
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listReviews(project, platformId, pageToken, pageSize, search, sortBy, start, end, options);
3566
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3567
+ const localVarOperationServerBasePath = operationServerMap['ReviewsApi.listReviews']?.[localVarOperationServerIndex]?.url;
3568
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3569
+ },
3570
+ /**
3571
+ * Moderate a review left on a platform.
3572
+ * @summary Moderate review
3573
+ * @param {string} project Project unique identifier
3574
+ * @param {string} platformId The platform identifier
3575
+ * @param {string} reviewId The review identifier
3576
+ * @param {ModerateReviewRequest} [moderateReviewRequest]
3577
+ * @param {*} [options] Override http request option.
3578
+ * @throws {RequiredError}
3579
+ */
3580
+ async moderateReview(project: string, platformId: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>> {
3581
+ const localVarAxiosArgs = await localVarAxiosParamCreator.moderateReview(project, platformId, reviewId, moderateReviewRequest, options);
3582
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3583
+ const localVarOperationServerBasePath = operationServerMap['ReviewsApi.moderateReview']?.[localVarOperationServerIndex]?.url;
3584
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3585
+ },
3586
+ }
3587
+ };
3588
+
3589
+ /**
3590
+ * ReviewsApi - factory interface
3591
+ * @export
3592
+ */
3593
+ export const ReviewsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3594
+ const localVarFp = ReviewsApiFp(configuration)
3595
+ return {
3596
+ /**
3597
+ * Export reviews as a CSV file.
3598
+ * @summary Export reviews
3599
+ * @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
3600
+ * @param {*} [options] Override http request option.
3601
+ * @throws {RequiredError}
3602
+ */
3603
+ exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
3604
+ return localVarFp.exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
3605
+ },
3606
+ /**
3607
+ * Get a review left on a platform by a given review ID.
3608
+ * @summary Get review
3609
+ * @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
3610
+ * @param {*} [options] Override http request option.
3611
+ * @throws {RequiredError}
3612
+ */
3613
+ getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review> {
3614
+ return localVarFp.getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(axios, basePath));
3615
+ },
3616
+ /**
3617
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
3618
+ * @summary List reviews
3619
+ * @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
3620
+ * @param {*} [options] Override http request option.
3621
+ * @throws {RequiredError}
3622
+ */
3623
+ listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReviewsResponse> {
3624
+ return localVarFp.listReviews(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
3625
+ },
3626
+ /**
3627
+ * Moderate a review left on a platform.
3628
+ * @summary Moderate review
3629
+ * @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
3630
+ * @param {*} [options] Override http request option.
3631
+ * @throws {RequiredError}
3632
+ */
3633
+ moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review> {
3634
+ return localVarFp.moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(axios, basePath));
3635
+ },
3636
+ };
3637
+ };
3638
+
3639
+ /**
3640
+ * Request parameters for exportReviews operation in ReviewsApi.
3641
+ * @export
3642
+ * @interface ReviewsApiExportReviewsRequest
3643
+ */
3644
+ export interface ReviewsApiExportReviewsRequest {
3645
+ /**
3646
+ * Project unique identifier
3647
+ * @type {string}
3648
+ * @memberof ReviewsApiExportReviews
3649
+ */
3650
+ readonly project: string
3651
+
3652
+ /**
3653
+ * The platform identifier
3654
+ * @type {string}
3655
+ * @memberof ReviewsApiExportReviews
3656
+ */
3657
+ readonly platformId: string
3658
+
3659
+ /**
3660
+ * Start of date range to filter by
3661
+ * @type {string}
3662
+ * @memberof ReviewsApiExportReviews
3663
+ */
3664
+ readonly start: string
3665
+
3666
+ /**
3667
+ * End of date range to filter by
3668
+ * @type {string}
3669
+ * @memberof ReviewsApiExportReviews
3670
+ */
3671
+ readonly end?: string
3672
+ }
3673
+
3674
+ /**
3675
+ * Request parameters for getReview operation in ReviewsApi.
3676
+ * @export
3677
+ * @interface ReviewsApiGetReviewRequest
3678
+ */
3679
+ export interface ReviewsApiGetReviewRequest {
3680
+ /**
3681
+ * Project unique identifier
3682
+ * @type {string}
3683
+ * @memberof ReviewsApiGetReview
3684
+ */
3685
+ readonly project: string
3686
+
3687
+ /**
3688
+ * The platform identifier
3689
+ * @type {string}
3690
+ * @memberof ReviewsApiGetReview
3691
+ */
3692
+ readonly platformId: string
3693
+
3694
+ /**
3695
+ * The review identifier
3696
+ * @type {string}
3697
+ * @memberof ReviewsApiGetReview
3698
+ */
3699
+ readonly reviewId: string
3700
+ }
3701
+
3702
+ /**
3703
+ * Request parameters for listReviews operation in ReviewsApi.
3704
+ * @export
3705
+ * @interface ReviewsApiListReviewsRequest
3706
+ */
3707
+ export interface ReviewsApiListReviewsRequest {
3708
+ /**
3709
+ * Project unique identifier
3710
+ * @type {string}
3711
+ * @memberof ReviewsApiListReviews
3712
+ */
3713
+ readonly project: string
3714
+
3715
+ /**
3716
+ * The platform identifier
3717
+ * @type {string}
3718
+ * @memberof ReviewsApiListReviews
3719
+ */
3720
+ readonly platformId: string
3721
+
3722
+ /**
3723
+ * Page reference token
3724
+ * @type {number}
3725
+ * @memberof ReviewsApiListReviews
3726
+ */
3727
+ readonly pageToken?: number
3728
+
3729
+ /**
3730
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
3731
+ * @type {number}
3732
+ * @memberof ReviewsApiListReviews
3733
+ */
3734
+ readonly pageSize?: number
3735
+
3736
+ /**
3737
+ * Search term to filter results
3738
+ * @type {string}
3739
+ * @memberof ReviewsApiListReviews
3740
+ */
3741
+ readonly search?: string
3742
+
3743
+ /**
3744
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
3745
+ * @type {Array<string>}
3746
+ * @memberof ReviewsApiListReviews
3747
+ */
3748
+ readonly sortBy?: Array<string>
3749
+
3750
+ /**
3751
+ * Start of date range to filter by
3752
+ * @type {string}
3753
+ * @memberof ReviewsApiListReviews
3754
+ */
3755
+ readonly start?: string
3756
+
3757
+ /**
3758
+ * End of date range to filter by
3759
+ * @type {string}
3760
+ * @memberof ReviewsApiListReviews
3761
+ */
3762
+ readonly end?: string
3763
+ }
3764
+
3765
+ /**
3766
+ * Request parameters for moderateReview operation in ReviewsApi.
3767
+ * @export
3768
+ * @interface ReviewsApiModerateReviewRequest
3769
+ */
3770
+ export interface ReviewsApiModerateReviewRequest {
3771
+ /**
3772
+ * Project unique identifier
3773
+ * @type {string}
3774
+ * @memberof ReviewsApiModerateReview
3775
+ */
3776
+ readonly project: string
3777
+
3778
+ /**
3779
+ * The platform identifier
3780
+ * @type {string}
3781
+ * @memberof ReviewsApiModerateReview
3782
+ */
3783
+ readonly platformId: string
3784
+
3785
+ /**
3786
+ * The review identifier
3787
+ * @type {string}
3788
+ * @memberof ReviewsApiModerateReview
3789
+ */
3790
+ readonly reviewId: string
3791
+
3792
+ /**
3793
+ *
3794
+ * @type {ModerateReviewRequest}
3795
+ * @memberof ReviewsApiModerateReview
3796
+ */
3797
+ readonly moderateReviewRequest?: ModerateReviewRequest
3798
+ }
3799
+
3800
+ /**
3801
+ * ReviewsApi - object-oriented interface
3802
+ * @export
3803
+ * @class ReviewsApi
3804
+ * @extends {BaseAPI}
3805
+ */
3806
+ export class ReviewsApi extends BaseAPI {
3807
+ /**
3808
+ * Export reviews as a CSV file.
3809
+ * @summary Export reviews
3810
+ * @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
3811
+ * @param {*} [options] Override http request option.
3812
+ * @throws {RequiredError}
3813
+ * @memberof ReviewsApi
3814
+ */
3815
+ public exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig) {
3816
+ return ReviewsApiFp(this.configuration).exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
3817
+ }
3818
+
3819
+ /**
3820
+ * Get a review left on a platform by a given review ID.
3821
+ * @summary Get review
3822
+ * @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
3823
+ * @param {*} [options] Override http request option.
3824
+ * @throws {RequiredError}
3825
+ * @memberof ReviewsApi
3826
+ */
3827
+ public getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig) {
3828
+ return ReviewsApiFp(this.configuration).getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(this.axios, this.basePath));
3829
+ }
3830
+
3831
+ /**
3832
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
3833
+ * @summary List reviews
3834
+ * @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
3835
+ * @param {*} [options] Override http request option.
3836
+ * @throws {RequiredError}
3837
+ * @memberof ReviewsApi
3838
+ */
3839
+ public listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig) {
3840
+ return ReviewsApiFp(this.configuration).listReviews(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
3841
+ }
3842
+
3843
+ /**
3844
+ * Moderate a review left on a platform.
3845
+ * @summary Moderate review
3846
+ * @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
3847
+ * @param {*} [options] Override http request option.
3848
+ * @throws {RequiredError}
3849
+ * @memberof ReviewsApi
3850
+ */
3851
+ public moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig) {
3852
+ return ReviewsApiFp(this.configuration).moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(this.axios, this.basePath));
3853
+ }
3854
+ }
3855
+
3856
+
3857
+