@teemill/platform 0.15.0 → 0.17.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 (74) hide show
  1. package/README.md +95 -2
  2. package/api.ts +879 -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 +596 -4
  7. package/dist/api.js +429 -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 +596 -4
  15. package/dist/esm/api.js +424 -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 +56 -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/PaymentAttempt.md +29 -0
  53. package/docs/Platform.md +38 -0
  54. package/docs/PlatformApi.md +122 -0
  55. package/docs/PlatformLogo.md +22 -0
  56. package/docs/Price.md +23 -0
  57. package/docs/Project.md +22 -0
  58. package/docs/Review.md +40 -0
  59. package/docs/ReviewAuthor.md +22 -0
  60. package/docs/ReviewImagesInner.md +22 -0
  61. package/docs/ReviewProduct.md +23 -0
  62. package/docs/ReviewReply.md +26 -0
  63. package/docs/ReviewReplyAuthor.md +20 -0
  64. package/docs/ReviewsApi.md +278 -0
  65. package/docs/ReviewsResponse.md +22 -0
  66. package/docs/ShippingMethod.md +34 -0
  67. package/docs/Statistics.md +24 -0
  68. package/docs/StatusHistoryItem.md +22 -0
  69. package/docs/UpdateFulfillmentRequest.md +20 -0
  70. package/docs/UpdatePlatformRequest.md +32 -0
  71. package/docs/ValidationError.md +20 -0
  72. package/docs/Variant.md +24 -0
  73. package/index.ts +1 -1
  74. 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.17.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
@@ -532,6 +545,12 @@ export interface Order {
532
545
  * @memberof Order
533
546
  */
534
547
  'project': Project;
548
+ /**
549
+ *
550
+ * @type {Array<PaymentAttempt>}
551
+ * @memberof Order
552
+ */
553
+ 'paymentAttempts'?: Array<PaymentAttempt>;
535
554
  }
536
555
 
537
556
 
@@ -727,6 +746,60 @@ export const PaymentAccountMethodEnum = {
727
746
 
728
747
  export type PaymentAccountMethodEnum = typeof PaymentAccountMethodEnum[keyof typeof PaymentAccountMethodEnum];
729
748
 
749
+ /**
750
+ * List of payment attempts for this order
751
+ * @export
752
+ * @interface PaymentAttempt
753
+ */
754
+ export interface PaymentAttempt {
755
+ /**
756
+ *
757
+ * @type {string}
758
+ * @memberof PaymentAttempt
759
+ */
760
+ 'paymentProvider'?: PaymentAttemptPaymentProviderEnum;
761
+ /**
762
+ *
763
+ * @type {string}
764
+ * @memberof PaymentAttempt
765
+ */
766
+ 'status'?: PaymentAttemptStatusEnum;
767
+ /**
768
+ *
769
+ * @type {string}
770
+ * @memberof PaymentAttempt
771
+ */
772
+ 'transactionId'?: string | null;
773
+ /**
774
+ *
775
+ * @type {string}
776
+ * @memberof PaymentAttempt
777
+ */
778
+ 'message'?: string;
779
+ /**
780
+ * ISO 8601 Timestamp
781
+ * @type {string}
782
+ * @memberof PaymentAttempt
783
+ */
784
+ 'createdAt'?: string;
785
+ }
786
+
787
+ export const PaymentAttemptPaymentProviderEnum = {
788
+ Stripe: 'stripe',
789
+ Paypal: 'paypal',
790
+ Wallet: 'wallet'
791
+ } as const;
792
+
793
+ export type PaymentAttemptPaymentProviderEnum = typeof PaymentAttemptPaymentProviderEnum[keyof typeof PaymentAttemptPaymentProviderEnum];
794
+ export const PaymentAttemptStatusEnum = {
795
+ Success: 'success',
796
+ Failed: 'failed',
797
+ Pending: 'pending',
798
+ Cancelled: 'cancelled'
799
+ } as const;
800
+
801
+ export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
802
+
730
803
  /**
731
804
  *
732
805
  * @export
@@ -851,6 +924,199 @@ export interface Project {
851
924
  */
852
925
  'name': string;
853
926
  }
927
+ /**
928
+ *
929
+ * @export
930
+ * @interface Review
931
+ */
932
+ export interface Review {
933
+ /**
934
+ * Unique object identifier
935
+ * @type {string}
936
+ * @memberof Review
937
+ */
938
+ 'id': string;
939
+ /**
940
+ * Text content of the review
941
+ * @type {string}
942
+ * @memberof Review
943
+ */
944
+ 'text': string;
945
+ /**
946
+ *
947
+ * @type {ReviewProduct}
948
+ * @memberof Review
949
+ */
950
+ 'product'?: ReviewProduct;
951
+ /**
952
+ *
953
+ * @type {ReviewAuthor}
954
+ * @memberof Review
955
+ */
956
+ 'author'?: ReviewAuthor;
957
+ /**
958
+ * Rating of the review
959
+ * @type {number}
960
+ * @memberof Review
961
+ */
962
+ 'rating'?: number;
963
+ /**
964
+ * Google\'s sentiment analysis score
965
+ * @type {number}
966
+ * @memberof Review
967
+ */
968
+ 'sentiment'?: number;
969
+ /**
970
+ * Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
971
+ * @type {boolean}
972
+ * @memberof Review
973
+ */
974
+ 'enabled': boolean;
975
+ /**
976
+ *
977
+ * @type {string}
978
+ * @memberof Review
979
+ */
980
+ 'createdAt'?: string;
981
+ /**
982
+ *
983
+ * @type {Project}
984
+ * @memberof Review
985
+ */
986
+ 'project': Project;
987
+ /**
988
+ *
989
+ * @type {Array<ReviewImagesInner>}
990
+ * @memberof Review
991
+ */
992
+ 'images'?: Array<ReviewImagesInner>;
993
+ /**
994
+ *
995
+ * @type {Array<ReviewReply>}
996
+ * @memberof Review
997
+ */
998
+ 'replies'?: Array<ReviewReply>;
999
+ }
1000
+ /**
1001
+ *
1002
+ * @export
1003
+ * @interface ReviewAuthor
1004
+ */
1005
+ export interface ReviewAuthor {
1006
+ /**
1007
+ * Name of the review\'s author
1008
+ * @type {string}
1009
+ * @memberof ReviewAuthor
1010
+ */
1011
+ 'name'?: string;
1012
+ /**
1013
+ * Email of the review\'s author
1014
+ * @type {string}
1015
+ * @memberof ReviewAuthor
1016
+ */
1017
+ 'email'?: string;
1018
+ }
1019
+ /**
1020
+ *
1021
+ * @export
1022
+ * @interface ReviewImagesInner
1023
+ */
1024
+ export interface ReviewImagesInner {
1025
+ /**
1026
+ * URL of the image
1027
+ * @type {string}
1028
+ * @memberof ReviewImagesInner
1029
+ */
1030
+ 'src'?: string;
1031
+ /**
1032
+ * Alternative text for the image
1033
+ * @type {string}
1034
+ * @memberof ReviewImagesInner
1035
+ */
1036
+ 'alt'?: string;
1037
+ }
1038
+ /**
1039
+ * The product that the review is for
1040
+ * @export
1041
+ * @interface ReviewProduct
1042
+ */
1043
+ export interface ReviewProduct {
1044
+ /**
1045
+ * Unique object identifier
1046
+ * @type {string}
1047
+ * @memberof ReviewProduct
1048
+ */
1049
+ 'id'?: string;
1050
+ /**
1051
+ * The title of the product
1052
+ * @type {string}
1053
+ * @memberof ReviewProduct
1054
+ */
1055
+ 'title'?: string;
1056
+ }
1057
+ /**
1058
+ *
1059
+ * @export
1060
+ * @interface ReviewReply
1061
+ */
1062
+ export interface ReviewReply {
1063
+ /**
1064
+ * Unique object identifier
1065
+ * @type {string}
1066
+ * @memberof ReviewReply
1067
+ */
1068
+ 'id': string;
1069
+ /**
1070
+ * Text content of the reply
1071
+ * @type {string}
1072
+ * @memberof ReviewReply
1073
+ */
1074
+ 'text': string;
1075
+ /**
1076
+ *
1077
+ * @type {ReviewReplyAuthor}
1078
+ * @memberof ReviewReply
1079
+ */
1080
+ 'author'?: ReviewReplyAuthor;
1081
+ /**
1082
+ *
1083
+ * @type {string}
1084
+ * @memberof ReviewReply
1085
+ */
1086
+ 'createdAt'?: string;
1087
+ }
1088
+ /**
1089
+ *
1090
+ * @export
1091
+ * @interface ReviewReplyAuthor
1092
+ */
1093
+ export interface ReviewReplyAuthor {
1094
+ /**
1095
+ * Name of the reply\'s author
1096
+ * @type {string}
1097
+ * @memberof ReviewReplyAuthor
1098
+ */
1099
+ 'name'?: string;
1100
+ }
1101
+ /**
1102
+ *
1103
+ * @export
1104
+ * @interface ReviewsResponse
1105
+ */
1106
+ export interface ReviewsResponse {
1107
+ /**
1108
+ *
1109
+ * @type {Array<Review>}
1110
+ * @memberof ReviewsResponse
1111
+ */
1112
+ 'reviews'?: Array<Review>;
1113
+ /**
1114
+ * The token referencing the next page number
1115
+ * @type {number}
1116
+ * @memberof ReviewsResponse
1117
+ */
1118
+ 'nextPageToken'?: number | null;
1119
+ }
854
1120
  /**
855
1121
  *
856
1122
  * @export
@@ -1193,7 +1459,7 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
1193
1459
  * @param {string} platformId The platform identifier
1194
1460
  * @param {number} [pageToken] Page reference token
1195
1461
  * @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
1462
+ * @param {string} [search] Search term to filter results
1197
1463
  * @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
1464
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1199
1465
  * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
@@ -1327,7 +1593,7 @@ export const CustomersApiFp = function(configuration?: Configuration) {
1327
1593
  * @param {string} platformId The platform identifier
1328
1594
  * @param {number} [pageToken] Page reference token
1329
1595
  * @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
1596
+ * @param {string} [search] Search term to filter results
1331
1597
  * @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
1598
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1333
1599
  * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
@@ -1504,7 +1770,7 @@ export interface CustomersApiListCustomersRequest {
1504
1770
  readonly pageSize?: number
1505
1771
 
1506
1772
  /**
1507
- * Search term to filter based on order reference, customer name and email
1773
+ * Search term to filter results
1508
1774
  * @type {string}
1509
1775
  * @memberof CustomersApiListCustomers
1510
1776
  */
@@ -3040,3 +3306,612 @@ export class PlatformApi extends BaseAPI {
3040
3306
 
3041
3307
 
3042
3308
 
3309
+ /**
3310
+ * ReviewsApi - axios parameter creator
3311
+ * @export
3312
+ */
3313
+ export const ReviewsApiAxiosParamCreator = function (configuration?: Configuration) {
3314
+ return {
3315
+ /**
3316
+ * Export reviews as a CSV file.
3317
+ * @summary Export reviews
3318
+ * @param {string} project Project unique identifier
3319
+ * @param {string} platformId The platform identifier
3320
+ * @param {string} start Start of date range to filter by
3321
+ * @param {string} [end] End of date range to filter by
3322
+ * @param {*} [options] Override http request option.
3323
+ * @throws {RequiredError}
3324
+ */
3325
+ exportReviews: async (project: string, platformId: string, start: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3326
+ // verify required parameter 'project' is not null or undefined
3327
+ assertParamExists('exportReviews', 'project', project)
3328
+ // verify required parameter 'platformId' is not null or undefined
3329
+ assertParamExists('exportReviews', 'platformId', platformId)
3330
+ // verify required parameter 'start' is not null or undefined
3331
+ assertParamExists('exportReviews', 'start', start)
3332
+ const localVarPath = `/v1/platform/{platformId}/reviews/export`
3333
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
3334
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3335
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3336
+ let baseOptions;
3337
+ if (configuration) {
3338
+ baseOptions = configuration.baseOptions;
3339
+ }
3340
+
3341
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3342
+ const localVarHeaderParameter = {} as any;
3343
+ const localVarQueryParameter = {} as any;
3344
+
3345
+ // authentication session-oauth required
3346
+ // oauth required
3347
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3348
+
3349
+ // authentication api-key required
3350
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3351
+
3352
+ if (project !== undefined) {
3353
+ localVarQueryParameter['project'] = project;
3354
+ }
3355
+
3356
+ if (start !== undefined) {
3357
+ localVarQueryParameter['start'] = (start as any instanceof Date) ?
3358
+ (start as any).toISOString() :
3359
+ start;
3360
+ }
3361
+
3362
+ if (end !== undefined) {
3363
+ localVarQueryParameter['end'] = (end as any instanceof Date) ?
3364
+ (end as any).toISOString() :
3365
+ end;
3366
+ }
3367
+
3368
+
3369
+
3370
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3371
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3372
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3373
+
3374
+ return {
3375
+ url: toPathString(localVarUrlObj),
3376
+ options: localVarRequestOptions,
3377
+ };
3378
+ },
3379
+ /**
3380
+ * Get a review left on a platform by a given review ID.
3381
+ * @summary Get review
3382
+ * @param {string} project Project unique identifier
3383
+ * @param {string} platformId The platform identifier
3384
+ * @param {string} reviewId The review identifier
3385
+ * @param {*} [options] Override http request option.
3386
+ * @throws {RequiredError}
3387
+ */
3388
+ getReview: async (project: string, platformId: string, reviewId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3389
+ // verify required parameter 'project' is not null or undefined
3390
+ assertParamExists('getReview', 'project', project)
3391
+ // verify required parameter 'platformId' is not null or undefined
3392
+ assertParamExists('getReview', 'platformId', platformId)
3393
+ // verify required parameter 'reviewId' is not null or undefined
3394
+ assertParamExists('getReview', 'reviewId', reviewId)
3395
+ const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}`
3396
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3397
+ .replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
3398
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3399
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3400
+ let baseOptions;
3401
+ if (configuration) {
3402
+ baseOptions = configuration.baseOptions;
3403
+ }
3404
+
3405
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3406
+ const localVarHeaderParameter = {} as any;
3407
+ const localVarQueryParameter = {} as any;
3408
+
3409
+ // authentication session-oauth required
3410
+ // oauth required
3411
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3412
+
3413
+ // authentication api-key required
3414
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3415
+
3416
+ if (project !== undefined) {
3417
+ localVarQueryParameter['project'] = project;
3418
+ }
3419
+
3420
+
3421
+
3422
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3423
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3424
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3425
+
3426
+ return {
3427
+ url: toPathString(localVarUrlObj),
3428
+ options: localVarRequestOptions,
3429
+ };
3430
+ },
3431
+ /**
3432
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
3433
+ * @summary List reviews
3434
+ * @param {string} project Project unique identifier
3435
+ * @param {string} platformId The platform identifier
3436
+ * @param {number} [pageToken] Page reference token
3437
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3438
+ * @param {string} [search] Search term to filter results
3439
+ * @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.
3440
+ * @param {string} [start] Start of date range to filter by
3441
+ * @param {string} [end] End of date range to filter by
3442
+ * @param {*} [options] Override http request option.
3443
+ * @throws {RequiredError}
3444
+ */
3445
+ listReviews: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3446
+ // verify required parameter 'project' is not null or undefined
3447
+ assertParamExists('listReviews', 'project', project)
3448
+ // verify required parameter 'platformId' is not null or undefined
3449
+ assertParamExists('listReviews', 'platformId', platformId)
3450
+ const localVarPath = `/v1/platform/{platformId}/reviews`
3451
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
3452
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3453
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3454
+ let baseOptions;
3455
+ if (configuration) {
3456
+ baseOptions = configuration.baseOptions;
3457
+ }
3458
+
3459
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3460
+ const localVarHeaderParameter = {} as any;
3461
+ const localVarQueryParameter = {} as any;
3462
+
3463
+ // authentication session-oauth required
3464
+ // oauth required
3465
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3466
+
3467
+ // authentication api-key required
3468
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3469
+
3470
+ if (project !== undefined) {
3471
+ localVarQueryParameter['project'] = project;
3472
+ }
3473
+
3474
+ if (pageToken !== undefined) {
3475
+ localVarQueryParameter['pageToken'] = pageToken;
3476
+ }
3477
+
3478
+ if (pageSize !== undefined) {
3479
+ localVarQueryParameter['pageSize'] = pageSize;
3480
+ }
3481
+
3482
+ if (search !== undefined) {
3483
+ localVarQueryParameter['search'] = search;
3484
+ }
3485
+
3486
+ if (sortBy) {
3487
+ localVarQueryParameter['sortBy'] = sortBy;
3488
+ }
3489
+
3490
+ if (start !== undefined) {
3491
+ localVarQueryParameter['start'] = (start as any instanceof Date) ?
3492
+ (start as any).toISOString() :
3493
+ start;
3494
+ }
3495
+
3496
+ if (end !== undefined) {
3497
+ localVarQueryParameter['end'] = (end as any instanceof Date) ?
3498
+ (end as any).toISOString() :
3499
+ end;
3500
+ }
3501
+
3502
+
3503
+
3504
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3505
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3506
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3507
+
3508
+ return {
3509
+ url: toPathString(localVarUrlObj),
3510
+ options: localVarRequestOptions,
3511
+ };
3512
+ },
3513
+ /**
3514
+ * Moderate a review left on a platform.
3515
+ * @summary Moderate review
3516
+ * @param {string} project Project unique identifier
3517
+ * @param {string} platformId The platform identifier
3518
+ * @param {string} reviewId The review identifier
3519
+ * @param {ModerateReviewRequest} [moderateReviewRequest]
3520
+ * @param {*} [options] Override http request option.
3521
+ * @throws {RequiredError}
3522
+ */
3523
+ moderateReview: async (project: string, platformId: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3524
+ // verify required parameter 'project' is not null or undefined
3525
+ assertParamExists('moderateReview', 'project', project)
3526
+ // verify required parameter 'platformId' is not null or undefined
3527
+ assertParamExists('moderateReview', 'platformId', platformId)
3528
+ // verify required parameter 'reviewId' is not null or undefined
3529
+ assertParamExists('moderateReview', 'reviewId', reviewId)
3530
+ const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}/moderate`
3531
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3532
+ .replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
3533
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3534
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3535
+ let baseOptions;
3536
+ if (configuration) {
3537
+ baseOptions = configuration.baseOptions;
3538
+ }
3539
+
3540
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
3541
+ const localVarHeaderParameter = {} as any;
3542
+ const localVarQueryParameter = {} as any;
3543
+
3544
+ // authentication session-oauth required
3545
+ // oauth required
3546
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3547
+
3548
+ // authentication api-key required
3549
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3550
+
3551
+ if (project !== undefined) {
3552
+ localVarQueryParameter['project'] = project;
3553
+ }
3554
+
3555
+
3556
+
3557
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3558
+
3559
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3560
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3561
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3562
+ localVarRequestOptions.data = serializeDataIfNeeded(moderateReviewRequest, localVarRequestOptions, configuration)
3563
+
3564
+ return {
3565
+ url: toPathString(localVarUrlObj),
3566
+ options: localVarRequestOptions,
3567
+ };
3568
+ },
3569
+ }
3570
+ };
3571
+
3572
+ /**
3573
+ * ReviewsApi - functional programming interface
3574
+ * @export
3575
+ */
3576
+ export const ReviewsApiFp = function(configuration?: Configuration) {
3577
+ const localVarAxiosParamCreator = ReviewsApiAxiosParamCreator(configuration)
3578
+ return {
3579
+ /**
3580
+ * Export reviews as a CSV file.
3581
+ * @summary Export reviews
3582
+ * @param {string} project Project unique identifier
3583
+ * @param {string} platformId The platform identifier
3584
+ * @param {string} start Start of date range to filter by
3585
+ * @param {string} [end] End of date range to filter by
3586
+ * @param {*} [options] Override http request option.
3587
+ * @throws {RequiredError}
3588
+ */
3589
+ async exportReviews(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
3590
+ const localVarAxiosArgs = await localVarAxiosParamCreator.exportReviews(project, platformId, start, end, options);
3591
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3592
+ const localVarOperationServerBasePath = operationServerMap['ReviewsApi.exportReviews']?.[localVarOperationServerIndex]?.url;
3593
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3594
+ },
3595
+ /**
3596
+ * Get a review left on a platform by a given review ID.
3597
+ * @summary Get review
3598
+ * @param {string} project Project unique identifier
3599
+ * @param {string} platformId The platform identifier
3600
+ * @param {string} reviewId The review identifier
3601
+ * @param {*} [options] Override http request option.
3602
+ * @throws {RequiredError}
3603
+ */
3604
+ async getReview(project: string, platformId: string, reviewId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>> {
3605
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getReview(project, platformId, reviewId, options);
3606
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3607
+ const localVarOperationServerBasePath = operationServerMap['ReviewsApi.getReview']?.[localVarOperationServerIndex]?.url;
3608
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3609
+ },
3610
+ /**
3611
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
3612
+ * @summary List reviews
3613
+ * @param {string} project Project unique identifier
3614
+ * @param {string} platformId The platform identifier
3615
+ * @param {number} [pageToken] Page reference token
3616
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3617
+ * @param {string} [search] Search term to filter results
3618
+ * @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.
3619
+ * @param {string} [start] Start of date range to filter by
3620
+ * @param {string} [end] End of date range to filter by
3621
+ * @param {*} [options] Override http request option.
3622
+ * @throws {RequiredError}
3623
+ */
3624
+ 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>> {
3625
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listReviews(project, platformId, pageToken, pageSize, search, sortBy, start, end, options);
3626
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3627
+ const localVarOperationServerBasePath = operationServerMap['ReviewsApi.listReviews']?.[localVarOperationServerIndex]?.url;
3628
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3629
+ },
3630
+ /**
3631
+ * Moderate a review left on a platform.
3632
+ * @summary Moderate review
3633
+ * @param {string} project Project unique identifier
3634
+ * @param {string} platformId The platform identifier
3635
+ * @param {string} reviewId The review identifier
3636
+ * @param {ModerateReviewRequest} [moderateReviewRequest]
3637
+ * @param {*} [options] Override http request option.
3638
+ * @throws {RequiredError}
3639
+ */
3640
+ async moderateReview(project: string, platformId: string, reviewId: string, moderateReviewRequest?: ModerateReviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Review>> {
3641
+ const localVarAxiosArgs = await localVarAxiosParamCreator.moderateReview(project, platformId, reviewId, moderateReviewRequest, options);
3642
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3643
+ const localVarOperationServerBasePath = operationServerMap['ReviewsApi.moderateReview']?.[localVarOperationServerIndex]?.url;
3644
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3645
+ },
3646
+ }
3647
+ };
3648
+
3649
+ /**
3650
+ * ReviewsApi - factory interface
3651
+ * @export
3652
+ */
3653
+ export const ReviewsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3654
+ const localVarFp = ReviewsApiFp(configuration)
3655
+ return {
3656
+ /**
3657
+ * Export reviews as a CSV file.
3658
+ * @summary Export reviews
3659
+ * @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
3660
+ * @param {*} [options] Override http request option.
3661
+ * @throws {RequiredError}
3662
+ */
3663
+ exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
3664
+ return localVarFp.exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
3665
+ },
3666
+ /**
3667
+ * Get a review left on a platform by a given review ID.
3668
+ * @summary Get review
3669
+ * @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
3670
+ * @param {*} [options] Override http request option.
3671
+ * @throws {RequiredError}
3672
+ */
3673
+ getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review> {
3674
+ return localVarFp.getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(axios, basePath));
3675
+ },
3676
+ /**
3677
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
3678
+ * @summary List reviews
3679
+ * @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
3680
+ * @param {*} [options] Override http request option.
3681
+ * @throws {RequiredError}
3682
+ */
3683
+ listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReviewsResponse> {
3684
+ 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));
3685
+ },
3686
+ /**
3687
+ * Moderate a review left on a platform.
3688
+ * @summary Moderate review
3689
+ * @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
3690
+ * @param {*} [options] Override http request option.
3691
+ * @throws {RequiredError}
3692
+ */
3693
+ moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review> {
3694
+ return localVarFp.moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(axios, basePath));
3695
+ },
3696
+ };
3697
+ };
3698
+
3699
+ /**
3700
+ * Request parameters for exportReviews operation in ReviewsApi.
3701
+ * @export
3702
+ * @interface ReviewsApiExportReviewsRequest
3703
+ */
3704
+ export interface ReviewsApiExportReviewsRequest {
3705
+ /**
3706
+ * Project unique identifier
3707
+ * @type {string}
3708
+ * @memberof ReviewsApiExportReviews
3709
+ */
3710
+ readonly project: string
3711
+
3712
+ /**
3713
+ * The platform identifier
3714
+ * @type {string}
3715
+ * @memberof ReviewsApiExportReviews
3716
+ */
3717
+ readonly platformId: string
3718
+
3719
+ /**
3720
+ * Start of date range to filter by
3721
+ * @type {string}
3722
+ * @memberof ReviewsApiExportReviews
3723
+ */
3724
+ readonly start: string
3725
+
3726
+ /**
3727
+ * End of date range to filter by
3728
+ * @type {string}
3729
+ * @memberof ReviewsApiExportReviews
3730
+ */
3731
+ readonly end?: string
3732
+ }
3733
+
3734
+ /**
3735
+ * Request parameters for getReview operation in ReviewsApi.
3736
+ * @export
3737
+ * @interface ReviewsApiGetReviewRequest
3738
+ */
3739
+ export interface ReviewsApiGetReviewRequest {
3740
+ /**
3741
+ * Project unique identifier
3742
+ * @type {string}
3743
+ * @memberof ReviewsApiGetReview
3744
+ */
3745
+ readonly project: string
3746
+
3747
+ /**
3748
+ * The platform identifier
3749
+ * @type {string}
3750
+ * @memberof ReviewsApiGetReview
3751
+ */
3752
+ readonly platformId: string
3753
+
3754
+ /**
3755
+ * The review identifier
3756
+ * @type {string}
3757
+ * @memberof ReviewsApiGetReview
3758
+ */
3759
+ readonly reviewId: string
3760
+ }
3761
+
3762
+ /**
3763
+ * Request parameters for listReviews operation in ReviewsApi.
3764
+ * @export
3765
+ * @interface ReviewsApiListReviewsRequest
3766
+ */
3767
+ export interface ReviewsApiListReviewsRequest {
3768
+ /**
3769
+ * Project unique identifier
3770
+ * @type {string}
3771
+ * @memberof ReviewsApiListReviews
3772
+ */
3773
+ readonly project: string
3774
+
3775
+ /**
3776
+ * The platform identifier
3777
+ * @type {string}
3778
+ * @memberof ReviewsApiListReviews
3779
+ */
3780
+ readonly platformId: string
3781
+
3782
+ /**
3783
+ * Page reference token
3784
+ * @type {number}
3785
+ * @memberof ReviewsApiListReviews
3786
+ */
3787
+ readonly pageToken?: number
3788
+
3789
+ /**
3790
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
3791
+ * @type {number}
3792
+ * @memberof ReviewsApiListReviews
3793
+ */
3794
+ readonly pageSize?: number
3795
+
3796
+ /**
3797
+ * Search term to filter results
3798
+ * @type {string}
3799
+ * @memberof ReviewsApiListReviews
3800
+ */
3801
+ readonly search?: string
3802
+
3803
+ /**
3804
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
3805
+ * @type {Array<string>}
3806
+ * @memberof ReviewsApiListReviews
3807
+ */
3808
+ readonly sortBy?: Array<string>
3809
+
3810
+ /**
3811
+ * Start of date range to filter by
3812
+ * @type {string}
3813
+ * @memberof ReviewsApiListReviews
3814
+ */
3815
+ readonly start?: string
3816
+
3817
+ /**
3818
+ * End of date range to filter by
3819
+ * @type {string}
3820
+ * @memberof ReviewsApiListReviews
3821
+ */
3822
+ readonly end?: string
3823
+ }
3824
+
3825
+ /**
3826
+ * Request parameters for moderateReview operation in ReviewsApi.
3827
+ * @export
3828
+ * @interface ReviewsApiModerateReviewRequest
3829
+ */
3830
+ export interface ReviewsApiModerateReviewRequest {
3831
+ /**
3832
+ * Project unique identifier
3833
+ * @type {string}
3834
+ * @memberof ReviewsApiModerateReview
3835
+ */
3836
+ readonly project: string
3837
+
3838
+ /**
3839
+ * The platform identifier
3840
+ * @type {string}
3841
+ * @memberof ReviewsApiModerateReview
3842
+ */
3843
+ readonly platformId: string
3844
+
3845
+ /**
3846
+ * The review identifier
3847
+ * @type {string}
3848
+ * @memberof ReviewsApiModerateReview
3849
+ */
3850
+ readonly reviewId: string
3851
+
3852
+ /**
3853
+ *
3854
+ * @type {ModerateReviewRequest}
3855
+ * @memberof ReviewsApiModerateReview
3856
+ */
3857
+ readonly moderateReviewRequest?: ModerateReviewRequest
3858
+ }
3859
+
3860
+ /**
3861
+ * ReviewsApi - object-oriented interface
3862
+ * @export
3863
+ * @class ReviewsApi
3864
+ * @extends {BaseAPI}
3865
+ */
3866
+ export class ReviewsApi extends BaseAPI {
3867
+ /**
3868
+ * Export reviews as a CSV file.
3869
+ * @summary Export reviews
3870
+ * @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
3871
+ * @param {*} [options] Override http request option.
3872
+ * @throws {RequiredError}
3873
+ * @memberof ReviewsApi
3874
+ */
3875
+ public exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig) {
3876
+ return ReviewsApiFp(this.configuration).exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
3877
+ }
3878
+
3879
+ /**
3880
+ * Get a review left on a platform by a given review ID.
3881
+ * @summary Get review
3882
+ * @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
3883
+ * @param {*} [options] Override http request option.
3884
+ * @throws {RequiredError}
3885
+ * @memberof ReviewsApi
3886
+ */
3887
+ public getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig) {
3888
+ return ReviewsApiFp(this.configuration).getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(this.axios, this.basePath));
3889
+ }
3890
+
3891
+ /**
3892
+ * List reviews left on projects belonging to this platform, paginated into configurable chunks.
3893
+ * @summary List reviews
3894
+ * @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
3895
+ * @param {*} [options] Override http request option.
3896
+ * @throws {RequiredError}
3897
+ * @memberof ReviewsApi
3898
+ */
3899
+ public listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig) {
3900
+ 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));
3901
+ }
3902
+
3903
+ /**
3904
+ * Moderate a review left on a platform.
3905
+ * @summary Moderate review
3906
+ * @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
3907
+ * @param {*} [options] Override http request option.
3908
+ * @throws {RequiredError}
3909
+ * @memberof ReviewsApi
3910
+ */
3911
+ public moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig) {
3912
+ return ReviewsApiFp(this.configuration).moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(this.axios, this.basePath));
3913
+ }
3914
+ }
3915
+
3916
+
3917
+