@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.
- package/README.md +94 -2
- package/api.ts +571 -893
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +460 -903
- package/dist/api.js +296 -164
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +460 -903
- package/dist/esm/api.js +291 -155
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Address.md +35 -0
- package/docs/ApiError.md +22 -0
- package/docs/AuthorizeStripe200Response.md +20 -0
- package/docs/ContactInformation.md +23 -0
- package/docs/Customer.md +33 -0
- package/docs/CustomersApi.md +229 -0
- package/docs/CustomersResponse.md +22 -0
- package/docs/DeliveryEstimates.md +22 -0
- package/docs/ExportOrders202Response.md +20 -0
- package/docs/Fulfiller.md +23 -0
- package/docs/FulfillerLocation.md +22 -0
- package/docs/FulfillersResponse.md +22 -0
- package/docs/Fulfillment.md +34 -0
- package/docs/FulfillmentItem.md +24 -0
- package/docs/Image.md +27 -0
- package/docs/ModerateReviewRequest.md +20 -0
- package/docs/Option.md +22 -0
- package/docs/Order.md +54 -0
- package/docs/OrderItem.md +42 -0
- package/docs/OrderStatus.md +16 -0
- package/docs/OrderTracking.md +24 -0
- package/docs/OrdersApi.md +410 -0
- package/docs/OrdersResponse.md +22 -0
- package/docs/Origin.md +22 -0
- package/docs/PaymentAccount.md +24 -0
- package/docs/PaymentApi.md +178 -0
- package/docs/Platform.md +38 -0
- package/docs/PlatformApi.md +122 -0
- package/docs/PlatformLogo.md +22 -0
- package/docs/Price.md +23 -0
- package/docs/Project.md +22 -0
- package/docs/Review.md +40 -0
- package/docs/ReviewAuthor.md +22 -0
- package/docs/ReviewImagesInner.md +22 -0
- package/docs/ReviewProduct.md +23 -0
- package/docs/ReviewReply.md +26 -0
- package/docs/ReviewReplyAuthor.md +20 -0
- package/docs/ReviewsApi.md +278 -0
- package/docs/ReviewsResponse.md +22 -0
- package/docs/ShippingMethod.md +34 -0
- package/docs/Statistics.md +24 -0
- package/docs/StatusHistoryItem.md +22 -0
- package/docs/UpdateFulfillmentRequest.md +20 -0
- package/docs/UpdatePlatformRequest.md +32 -0
- package/docs/ValidationError.md +20 -0
- package/docs/Variant.md +24 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Platform API
|
|
6
6
|
* Manage Your podOS platform
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
8
|
+
* The version of the OpenAPI document: 0.16.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
25
|
+
exports.ReviewsApi = exports.ReviewsApiFactory = exports.ReviewsApiFp = exports.ReviewsApiAxiosParamCreator = exports.PlatformApi = exports.PlatformApiFactory = exports.PlatformApiFp = exports.PlatformApiAxiosParamCreator = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.ListOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.ListCustomersSortByEnum = exports.ExportCustomersSortByEnum = exports.CustomersApi = exports.CustomersApiFactory = exports.CustomersApiFp = exports.CustomersApiAxiosParamCreator = exports.PaymentAccountMethodEnum = exports.OrderStatus = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -41,37 +41,9 @@ exports.OrderStatus = {
|
|
|
41
41
|
Complete: 'complete',
|
|
42
42
|
Refunded: 'refunded'
|
|
43
43
|
};
|
|
44
|
-
exports.OutputPositionEnum = {
|
|
45
|
-
Center: 'center',
|
|
46
|
-
Top: 'top',
|
|
47
|
-
Left: 'left',
|
|
48
|
-
Bottom: 'bottom',
|
|
49
|
-
Right: 'right',
|
|
50
|
-
RightTop: 'right-top',
|
|
51
|
-
RightBottom: 'right-bottom',
|
|
52
|
-
LeftTop: 'left-top',
|
|
53
|
-
LeftBottom: 'left-bottom'
|
|
54
|
-
};
|
|
55
|
-
exports.OutputFileFormatEnum = {
|
|
56
|
-
Png: 'png',
|
|
57
|
-
Jpg: 'jpg',
|
|
58
|
-
Jpeg: 'jpeg',
|
|
59
|
-
Webp: 'webp',
|
|
60
|
-
Pdf: 'pdf'
|
|
61
|
-
};
|
|
62
44
|
exports.PaymentAccountMethodEnum = {
|
|
63
45
|
Stripe: 'stripe'
|
|
64
46
|
};
|
|
65
|
-
exports.ProductAttributeValuesInnerThumbnailTypeEnum = {
|
|
66
|
-
Text: 'text',
|
|
67
|
-
Color: 'color',
|
|
68
|
-
Image: 'image'
|
|
69
|
-
};
|
|
70
|
-
exports.VariantAttributeThumbnailTypeEnum = {
|
|
71
|
-
Text: 'text',
|
|
72
|
-
Color: 'color',
|
|
73
|
-
Image: 'image'
|
|
74
|
-
};
|
|
75
47
|
/**
|
|
76
48
|
* CustomersApi - axios parameter creator
|
|
77
49
|
* @export
|
|
@@ -191,7 +163,7 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
191
163
|
* @param {string} platformId The platform identifier
|
|
192
164
|
* @param {number} [pageToken] Page reference token
|
|
193
165
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
194
|
-
* @param {string} [search] Search term to filter
|
|
166
|
+
* @param {string} [search] Search term to filter results
|
|
195
167
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
196
168
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
197
169
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
@@ -315,7 +287,7 @@ const CustomersApiFp = function (configuration) {
|
|
|
315
287
|
* @param {string} platformId The platform identifier
|
|
316
288
|
* @param {number} [pageToken] Page reference token
|
|
317
289
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
318
|
-
* @param {string} [search] Search term to filter
|
|
290
|
+
* @param {string} [search] Search term to filter results
|
|
319
291
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
320
292
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
321
293
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
@@ -1483,40 +1455,37 @@ class PlatformApi extends base_1.BaseAPI {
|
|
|
1483
1455
|
}
|
|
1484
1456
|
exports.PlatformApi = PlatformApi;
|
|
1485
1457
|
/**
|
|
1486
|
-
*
|
|
1458
|
+
* ReviewsApi - axios parameter creator
|
|
1487
1459
|
* @export
|
|
1488
1460
|
*/
|
|
1489
|
-
const
|
|
1461
|
+
const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
1490
1462
|
return {
|
|
1491
1463
|
/**
|
|
1492
|
-
*
|
|
1493
|
-
* @summary
|
|
1464
|
+
* Export reviews as a CSV file.
|
|
1465
|
+
* @summary Export reviews
|
|
1494
1466
|
* @param {string} project Project unique identifier
|
|
1495
1467
|
* @param {string} platformId The platform identifier
|
|
1496
|
-
* @param {string}
|
|
1497
|
-
* @param {
|
|
1468
|
+
* @param {string} start Start of date range to filter by
|
|
1469
|
+
* @param {string} [end] End of date range to filter by
|
|
1498
1470
|
* @param {*} [options] Override http request option.
|
|
1499
1471
|
* @throws {RequiredError}
|
|
1500
1472
|
*/
|
|
1501
|
-
|
|
1473
|
+
exportReviews: (project_1, platformId_1, start_1, end_1, ...args_1) => __awaiter(this, [project_1, platformId_1, start_1, end_1, ...args_1], void 0, function* (project, platformId, start, end, options = {}) {
|
|
1502
1474
|
// verify required parameter 'project' is not null or undefined
|
|
1503
|
-
(0, common_1.assertParamExists)('
|
|
1475
|
+
(0, common_1.assertParamExists)('exportReviews', 'project', project);
|
|
1504
1476
|
// verify required parameter 'platformId' is not null or undefined
|
|
1505
|
-
(0, common_1.assertParamExists)('
|
|
1506
|
-
// verify required parameter '
|
|
1507
|
-
(0, common_1.assertParamExists)('
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
const localVarPath = `/v1/platform/{platformId}/warehouse/products/{productId}`
|
|
1511
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1512
|
-
.replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
|
|
1477
|
+
(0, common_1.assertParamExists)('exportReviews', 'platformId', platformId);
|
|
1478
|
+
// verify required parameter 'start' is not null or undefined
|
|
1479
|
+
(0, common_1.assertParamExists)('exportReviews', 'start', start);
|
|
1480
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/export`
|
|
1481
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1513
1482
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1514
1483
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1515
1484
|
let baseOptions;
|
|
1516
1485
|
if (configuration) {
|
|
1517
1486
|
baseOptions = configuration.baseOptions;
|
|
1518
1487
|
}
|
|
1519
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1488
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1520
1489
|
const localVarHeaderParameter = {};
|
|
1521
1490
|
const localVarQueryParameter = {};
|
|
1522
1491
|
// authentication session-oauth required
|
|
@@ -1527,116 +1496,156 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
1527
1496
|
if (project !== undefined) {
|
|
1528
1497
|
localVarQueryParameter['project'] = project;
|
|
1529
1498
|
}
|
|
1530
|
-
|
|
1499
|
+
if (start !== undefined) {
|
|
1500
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
1501
|
+
start.toISOString() :
|
|
1502
|
+
start;
|
|
1503
|
+
}
|
|
1504
|
+
if (end !== undefined) {
|
|
1505
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
1506
|
+
end.toISOString() :
|
|
1507
|
+
end;
|
|
1508
|
+
}
|
|
1531
1509
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1532
1510
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1533
1511
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1534
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateProductRequest, localVarRequestOptions, configuration);
|
|
1535
1512
|
return {
|
|
1536
1513
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1537
1514
|
options: localVarRequestOptions,
|
|
1538
1515
|
};
|
|
1539
1516
|
}),
|
|
1540
|
-
};
|
|
1541
|
-
};
|
|
1542
|
-
exports.ProductsApiAxiosParamCreator = ProductsApiAxiosParamCreator;
|
|
1543
|
-
/**
|
|
1544
|
-
* ProductsApi - functional programming interface
|
|
1545
|
-
* @export
|
|
1546
|
-
*/
|
|
1547
|
-
const ProductsApiFp = function (configuration) {
|
|
1548
|
-
const localVarAxiosParamCreator = (0, exports.ProductsApiAxiosParamCreator)(configuration);
|
|
1549
|
-
return {
|
|
1550
1517
|
/**
|
|
1551
|
-
*
|
|
1552
|
-
* @summary
|
|
1518
|
+
* Get a review left on a platform by a given review ID.
|
|
1519
|
+
* @summary Get review
|
|
1553
1520
|
* @param {string} project Project unique identifier
|
|
1554
1521
|
* @param {string} platformId The platform identifier
|
|
1555
|
-
* @param {string}
|
|
1556
|
-
* @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
|
|
1522
|
+
* @param {string} reviewId The review identifier
|
|
1557
1523
|
* @param {*} [options] Override http request option.
|
|
1558
1524
|
* @throws {RequiredError}
|
|
1559
1525
|
*/
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
}
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
const
|
|
1577
|
-
|
|
1578
|
-
|
|
1526
|
+
getReview: (project_1, platformId_1, reviewId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, reviewId_1, ...args_1], void 0, function* (project, platformId, reviewId, options = {}) {
|
|
1527
|
+
// verify required parameter 'project' is not null or undefined
|
|
1528
|
+
(0, common_1.assertParamExists)('getReview', 'project', project);
|
|
1529
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1530
|
+
(0, common_1.assertParamExists)('getReview', 'platformId', platformId);
|
|
1531
|
+
// verify required parameter 'reviewId' is not null or undefined
|
|
1532
|
+
(0, common_1.assertParamExists)('getReview', 'reviewId', reviewId);
|
|
1533
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}`
|
|
1534
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1535
|
+
.replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
|
|
1536
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1537
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1538
|
+
let baseOptions;
|
|
1539
|
+
if (configuration) {
|
|
1540
|
+
baseOptions = configuration.baseOptions;
|
|
1541
|
+
}
|
|
1542
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1543
|
+
const localVarHeaderParameter = {};
|
|
1544
|
+
const localVarQueryParameter = {};
|
|
1545
|
+
// authentication session-oauth required
|
|
1546
|
+
// oauth required
|
|
1547
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1548
|
+
// authentication api-key required
|
|
1549
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1550
|
+
if (project !== undefined) {
|
|
1551
|
+
localVarQueryParameter['project'] = project;
|
|
1552
|
+
}
|
|
1553
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1554
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1555
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1556
|
+
return {
|
|
1557
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1558
|
+
options: localVarRequestOptions,
|
|
1559
|
+
};
|
|
1560
|
+
}),
|
|
1579
1561
|
/**
|
|
1580
|
-
*
|
|
1581
|
-
* @summary
|
|
1582
|
-
* @param {
|
|
1562
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1563
|
+
* @summary List reviews
|
|
1564
|
+
* @param {string} project Project unique identifier
|
|
1565
|
+
* @param {string} platformId The platform identifier
|
|
1566
|
+
* @param {number} [pageToken] Page reference token
|
|
1567
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1568
|
+
* @param {string} [search] Search term to filter results
|
|
1569
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1570
|
+
* @param {string} [start] Start of date range to filter by
|
|
1571
|
+
* @param {string} [end] End of date range to filter by
|
|
1583
1572
|
* @param {*} [options] Override http request option.
|
|
1584
1573
|
* @throws {RequiredError}
|
|
1585
1574
|
*/
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1575
|
+
listReviews: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, start_1, end_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, start_1, end_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, sortBy, start, end, options = {}) {
|
|
1576
|
+
// verify required parameter 'project' is not null or undefined
|
|
1577
|
+
(0, common_1.assertParamExists)('listReviews', 'project', project);
|
|
1578
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1579
|
+
(0, common_1.assertParamExists)('listReviews', 'platformId', platformId);
|
|
1580
|
+
const localVarPath = `/v1/platform/{platformId}/reviews`
|
|
1581
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1582
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1583
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1584
|
+
let baseOptions;
|
|
1585
|
+
if (configuration) {
|
|
1586
|
+
baseOptions = configuration.baseOptions;
|
|
1587
|
+
}
|
|
1588
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1589
|
+
const localVarHeaderParameter = {};
|
|
1590
|
+
const localVarQueryParameter = {};
|
|
1591
|
+
// authentication session-oauth required
|
|
1592
|
+
// oauth required
|
|
1593
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1594
|
+
// authentication api-key required
|
|
1595
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1596
|
+
if (project !== undefined) {
|
|
1597
|
+
localVarQueryParameter['project'] = project;
|
|
1598
|
+
}
|
|
1599
|
+
if (pageToken !== undefined) {
|
|
1600
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1601
|
+
}
|
|
1602
|
+
if (pageSize !== undefined) {
|
|
1603
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1604
|
+
}
|
|
1605
|
+
if (search !== undefined) {
|
|
1606
|
+
localVarQueryParameter['search'] = search;
|
|
1607
|
+
}
|
|
1608
|
+
if (sortBy) {
|
|
1609
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1610
|
+
}
|
|
1611
|
+
if (start !== undefined) {
|
|
1612
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
1613
|
+
start.toISOString() :
|
|
1614
|
+
start;
|
|
1615
|
+
}
|
|
1616
|
+
if (end !== undefined) {
|
|
1617
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
1618
|
+
end.toISOString() :
|
|
1619
|
+
end;
|
|
1620
|
+
}
|
|
1621
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1622
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1623
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1624
|
+
return {
|
|
1625
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1626
|
+
options: localVarRequestOptions,
|
|
1627
|
+
};
|
|
1628
|
+
}),
|
|
1618
1629
|
/**
|
|
1619
|
-
*
|
|
1620
|
-
* @summary
|
|
1630
|
+
* Moderate a review left on a platform.
|
|
1631
|
+
* @summary Moderate review
|
|
1621
1632
|
* @param {string} project Project unique identifier
|
|
1622
1633
|
* @param {string} platformId The platform identifier
|
|
1623
|
-
* @param {string}
|
|
1624
|
-
* @param {
|
|
1634
|
+
* @param {string} reviewId The review identifier
|
|
1635
|
+
* @param {ModerateReviewRequest} [moderateReviewRequest]
|
|
1625
1636
|
* @param {*} [options] Override http request option.
|
|
1626
1637
|
* @throws {RequiredError}
|
|
1627
1638
|
*/
|
|
1628
|
-
|
|
1639
|
+
moderateReview: (project_1, platformId_1, reviewId_1, moderateReviewRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, reviewId_1, moderateReviewRequest_1, ...args_1], void 0, function* (project, platformId, reviewId, moderateReviewRequest, options = {}) {
|
|
1629
1640
|
// verify required parameter 'project' is not null or undefined
|
|
1630
|
-
(0, common_1.assertParamExists)('
|
|
1641
|
+
(0, common_1.assertParamExists)('moderateReview', 'project', project);
|
|
1631
1642
|
// verify required parameter 'platformId' is not null or undefined
|
|
1632
|
-
(0, common_1.assertParamExists)('
|
|
1633
|
-
// verify required parameter '
|
|
1634
|
-
(0, common_1.assertParamExists)('
|
|
1635
|
-
|
|
1636
|
-
(0, common_1.assertParamExists)('updateVariant', 'updateVariantRequest', updateVariantRequest);
|
|
1637
|
-
const localVarPath = `/v1/platform/{platformId}/warehouse/variants/{variantId}`
|
|
1643
|
+
(0, common_1.assertParamExists)('moderateReview', 'platformId', platformId);
|
|
1644
|
+
// verify required parameter 'reviewId' is not null or undefined
|
|
1645
|
+
(0, common_1.assertParamExists)('moderateReview', 'reviewId', reviewId);
|
|
1646
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}/moderate`
|
|
1638
1647
|
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1639
|
-
.replace(`{${"
|
|
1648
|
+
.replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
|
|
1640
1649
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1641
1650
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1642
1651
|
let baseOptions;
|
|
@@ -1658,7 +1667,7 @@ const VariantsApiAxiosParamCreator = function (configuration) {
|
|
|
1658
1667
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1659
1668
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1660
1669
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1661
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
1670
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(moderateReviewRequest, localVarRequestOptions, configuration);
|
|
1662
1671
|
return {
|
|
1663
1672
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1664
1673
|
options: localVarRequestOptions,
|
|
@@ -1666,73 +1675,196 @@ const VariantsApiAxiosParamCreator = function (configuration) {
|
|
|
1666
1675
|
}),
|
|
1667
1676
|
};
|
|
1668
1677
|
};
|
|
1669
|
-
exports.
|
|
1678
|
+
exports.ReviewsApiAxiosParamCreator = ReviewsApiAxiosParamCreator;
|
|
1670
1679
|
/**
|
|
1671
|
-
*
|
|
1680
|
+
* ReviewsApi - functional programming interface
|
|
1672
1681
|
* @export
|
|
1673
1682
|
*/
|
|
1674
|
-
const
|
|
1675
|
-
const localVarAxiosParamCreator = (0, exports.
|
|
1683
|
+
const ReviewsApiFp = function (configuration) {
|
|
1684
|
+
const localVarAxiosParamCreator = (0, exports.ReviewsApiAxiosParamCreator)(configuration);
|
|
1676
1685
|
return {
|
|
1677
1686
|
/**
|
|
1678
|
-
*
|
|
1679
|
-
* @summary
|
|
1687
|
+
* Export reviews as a CSV file.
|
|
1688
|
+
* @summary Export reviews
|
|
1689
|
+
* @param {string} project Project unique identifier
|
|
1690
|
+
* @param {string} platformId The platform identifier
|
|
1691
|
+
* @param {string} start Start of date range to filter by
|
|
1692
|
+
* @param {string} [end] End of date range to filter by
|
|
1693
|
+
* @param {*} [options] Override http request option.
|
|
1694
|
+
* @throws {RequiredError}
|
|
1695
|
+
*/
|
|
1696
|
+
exportReviews(project, platformId, start, end, options) {
|
|
1697
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1698
|
+
var _a, _b, _c;
|
|
1699
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportReviews(project, platformId, start, end, options);
|
|
1700
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1701
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReviewsApi.exportReviews']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1702
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1703
|
+
});
|
|
1704
|
+
},
|
|
1705
|
+
/**
|
|
1706
|
+
* Get a review left on a platform by a given review ID.
|
|
1707
|
+
* @summary Get review
|
|
1680
1708
|
* @param {string} project Project unique identifier
|
|
1681
1709
|
* @param {string} platformId The platform identifier
|
|
1682
|
-
* @param {string}
|
|
1683
|
-
* @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
|
|
1710
|
+
* @param {string} reviewId The review identifier
|
|
1684
1711
|
* @param {*} [options] Override http request option.
|
|
1685
1712
|
* @throws {RequiredError}
|
|
1686
1713
|
*/
|
|
1687
|
-
|
|
1714
|
+
getReview(project, platformId, reviewId, options) {
|
|
1688
1715
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1689
1716
|
var _a, _b, _c;
|
|
1690
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1717
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReview(project, platformId, reviewId, options);
|
|
1691
1718
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1692
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['
|
|
1719
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReviewsApi.getReview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1720
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1721
|
+
});
|
|
1722
|
+
},
|
|
1723
|
+
/**
|
|
1724
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1725
|
+
* @summary List reviews
|
|
1726
|
+
* @param {string} project Project unique identifier
|
|
1727
|
+
* @param {string} platformId The platform identifier
|
|
1728
|
+
* @param {number} [pageToken] Page reference token
|
|
1729
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1730
|
+
* @param {string} [search] Search term to filter results
|
|
1731
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1732
|
+
* @param {string} [start] Start of date range to filter by
|
|
1733
|
+
* @param {string} [end] End of date range to filter by
|
|
1734
|
+
* @param {*} [options] Override http request option.
|
|
1735
|
+
* @throws {RequiredError}
|
|
1736
|
+
*/
|
|
1737
|
+
listReviews(project, platformId, pageToken, pageSize, search, sortBy, start, end, options) {
|
|
1738
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1739
|
+
var _a, _b, _c;
|
|
1740
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listReviews(project, platformId, pageToken, pageSize, search, sortBy, start, end, options);
|
|
1741
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1742
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReviewsApi.listReviews']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1743
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1744
|
+
});
|
|
1745
|
+
},
|
|
1746
|
+
/**
|
|
1747
|
+
* Moderate a review left on a platform.
|
|
1748
|
+
* @summary Moderate review
|
|
1749
|
+
* @param {string} project Project unique identifier
|
|
1750
|
+
* @param {string} platformId The platform identifier
|
|
1751
|
+
* @param {string} reviewId The review identifier
|
|
1752
|
+
* @param {ModerateReviewRequest} [moderateReviewRequest]
|
|
1753
|
+
* @param {*} [options] Override http request option.
|
|
1754
|
+
* @throws {RequiredError}
|
|
1755
|
+
*/
|
|
1756
|
+
moderateReview(project, platformId, reviewId, moderateReviewRequest, options) {
|
|
1757
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1758
|
+
var _a, _b, _c;
|
|
1759
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.moderateReview(project, platformId, reviewId, moderateReviewRequest, options);
|
|
1760
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1761
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReviewsApi.moderateReview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1693
1762
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1694
1763
|
});
|
|
1695
1764
|
},
|
|
1696
1765
|
};
|
|
1697
1766
|
};
|
|
1698
|
-
exports.
|
|
1767
|
+
exports.ReviewsApiFp = ReviewsApiFp;
|
|
1699
1768
|
/**
|
|
1700
|
-
*
|
|
1769
|
+
* ReviewsApi - factory interface
|
|
1701
1770
|
* @export
|
|
1702
1771
|
*/
|
|
1703
|
-
const
|
|
1704
|
-
const localVarFp = (0, exports.
|
|
1772
|
+
const ReviewsApiFactory = function (configuration, basePath, axios) {
|
|
1773
|
+
const localVarFp = (0, exports.ReviewsApiFp)(configuration);
|
|
1705
1774
|
return {
|
|
1706
1775
|
/**
|
|
1707
|
-
*
|
|
1708
|
-
* @summary
|
|
1709
|
-
* @param {
|
|
1776
|
+
* Export reviews as a CSV file.
|
|
1777
|
+
* @summary Export reviews
|
|
1778
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
1779
|
+
* @param {*} [options] Override http request option.
|
|
1780
|
+
* @throws {RequiredError}
|
|
1781
|
+
*/
|
|
1782
|
+
exportReviews(requestParameters, options) {
|
|
1783
|
+
return localVarFp.exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
1784
|
+
},
|
|
1785
|
+
/**
|
|
1786
|
+
* Get a review left on a platform by a given review ID.
|
|
1787
|
+
* @summary Get review
|
|
1788
|
+
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
1710
1789
|
* @param {*} [options] Override http request option.
|
|
1711
1790
|
* @throws {RequiredError}
|
|
1712
1791
|
*/
|
|
1713
|
-
|
|
1714
|
-
return localVarFp.
|
|
1792
|
+
getReview(requestParameters, options) {
|
|
1793
|
+
return localVarFp.getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(axios, basePath));
|
|
1794
|
+
},
|
|
1795
|
+
/**
|
|
1796
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1797
|
+
* @summary List reviews
|
|
1798
|
+
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
1799
|
+
* @param {*} [options] Override http request option.
|
|
1800
|
+
* @throws {RequiredError}
|
|
1801
|
+
*/
|
|
1802
|
+
listReviews(requestParameters, options) {
|
|
1803
|
+
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));
|
|
1804
|
+
},
|
|
1805
|
+
/**
|
|
1806
|
+
* Moderate a review left on a platform.
|
|
1807
|
+
* @summary Moderate review
|
|
1808
|
+
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
1809
|
+
* @param {*} [options] Override http request option.
|
|
1810
|
+
* @throws {RequiredError}
|
|
1811
|
+
*/
|
|
1812
|
+
moderateReview(requestParameters, options) {
|
|
1813
|
+
return localVarFp.moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(axios, basePath));
|
|
1715
1814
|
},
|
|
1716
1815
|
};
|
|
1717
1816
|
};
|
|
1718
|
-
exports.
|
|
1817
|
+
exports.ReviewsApiFactory = ReviewsApiFactory;
|
|
1719
1818
|
/**
|
|
1720
|
-
*
|
|
1819
|
+
* ReviewsApi - object-oriented interface
|
|
1721
1820
|
* @export
|
|
1722
|
-
* @class
|
|
1821
|
+
* @class ReviewsApi
|
|
1723
1822
|
* @extends {BaseAPI}
|
|
1724
1823
|
*/
|
|
1725
|
-
class
|
|
1824
|
+
class ReviewsApi extends base_1.BaseAPI {
|
|
1825
|
+
/**
|
|
1826
|
+
* Export reviews as a CSV file.
|
|
1827
|
+
* @summary Export reviews
|
|
1828
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
1829
|
+
* @param {*} [options] Override http request option.
|
|
1830
|
+
* @throws {RequiredError}
|
|
1831
|
+
* @memberof ReviewsApi
|
|
1832
|
+
*/
|
|
1833
|
+
exportReviews(requestParameters, options) {
|
|
1834
|
+
return (0, exports.ReviewsApiFp)(this.configuration).exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
1835
|
+
}
|
|
1836
|
+
/**
|
|
1837
|
+
* Get a review left on a platform by a given review ID.
|
|
1838
|
+
* @summary Get review
|
|
1839
|
+
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
1840
|
+
* @param {*} [options] Override http request option.
|
|
1841
|
+
* @throws {RequiredError}
|
|
1842
|
+
* @memberof ReviewsApi
|
|
1843
|
+
*/
|
|
1844
|
+
getReview(requestParameters, options) {
|
|
1845
|
+
return (0, exports.ReviewsApiFp)(this.configuration).getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(this.axios, this.basePath));
|
|
1846
|
+
}
|
|
1847
|
+
/**
|
|
1848
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1849
|
+
* @summary List reviews
|
|
1850
|
+
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
1851
|
+
* @param {*} [options] Override http request option.
|
|
1852
|
+
* @throws {RequiredError}
|
|
1853
|
+
* @memberof ReviewsApi
|
|
1854
|
+
*/
|
|
1855
|
+
listReviews(requestParameters, options) {
|
|
1856
|
+
return (0, exports.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));
|
|
1857
|
+
}
|
|
1726
1858
|
/**
|
|
1727
|
-
*
|
|
1728
|
-
* @summary
|
|
1729
|
-
* @param {
|
|
1859
|
+
* Moderate a review left on a platform.
|
|
1860
|
+
* @summary Moderate review
|
|
1861
|
+
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
1730
1862
|
* @param {*} [options] Override http request option.
|
|
1731
1863
|
* @throws {RequiredError}
|
|
1732
|
-
* @memberof
|
|
1864
|
+
* @memberof ReviewsApi
|
|
1733
1865
|
*/
|
|
1734
|
-
|
|
1735
|
-
return (0, exports.
|
|
1866
|
+
moderateReview(requestParameters, options) {
|
|
1867
|
+
return (0, exports.ReviewsApiFp)(this.configuration).moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1736
1868
|
}
|
|
1737
1869
|
}
|
|
1738
|
-
exports.
|
|
1870
|
+
exports.ReviewsApi = ReviewsApi;
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED