@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/esm/api.js
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.
|
|
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).
|
|
@@ -38,37 +38,9 @@ export const OrderStatus = {
|
|
|
38
38
|
Complete: 'complete',
|
|
39
39
|
Refunded: 'refunded'
|
|
40
40
|
};
|
|
41
|
-
export const OutputPositionEnum = {
|
|
42
|
-
Center: 'center',
|
|
43
|
-
Top: 'top',
|
|
44
|
-
Left: 'left',
|
|
45
|
-
Bottom: 'bottom',
|
|
46
|
-
Right: 'right',
|
|
47
|
-
RightTop: 'right-top',
|
|
48
|
-
RightBottom: 'right-bottom',
|
|
49
|
-
LeftTop: 'left-top',
|
|
50
|
-
LeftBottom: 'left-bottom'
|
|
51
|
-
};
|
|
52
|
-
export const OutputFileFormatEnum = {
|
|
53
|
-
Png: 'png',
|
|
54
|
-
Jpg: 'jpg',
|
|
55
|
-
Jpeg: 'jpeg',
|
|
56
|
-
Webp: 'webp',
|
|
57
|
-
Pdf: 'pdf'
|
|
58
|
-
};
|
|
59
41
|
export const PaymentAccountMethodEnum = {
|
|
60
42
|
Stripe: 'stripe'
|
|
61
43
|
};
|
|
62
|
-
export const ProductAttributeValuesInnerThumbnailTypeEnum = {
|
|
63
|
-
Text: 'text',
|
|
64
|
-
Color: 'color',
|
|
65
|
-
Image: 'image'
|
|
66
|
-
};
|
|
67
|
-
export const VariantAttributeThumbnailTypeEnum = {
|
|
68
|
-
Text: 'text',
|
|
69
|
-
Color: 'color',
|
|
70
|
-
Image: 'image'
|
|
71
|
-
};
|
|
72
44
|
/**
|
|
73
45
|
* CustomersApi - axios parameter creator
|
|
74
46
|
* @export
|
|
@@ -188,7 +160,7 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
188
160
|
* @param {string} platformId The platform identifier
|
|
189
161
|
* @param {number} [pageToken] Page reference token
|
|
190
162
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
191
|
-
* @param {string} [search] Search term to filter
|
|
163
|
+
* @param {string} [search] Search term to filter results
|
|
192
164
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
193
165
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
194
166
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
@@ -311,7 +283,7 @@ export const CustomersApiFp = function (configuration) {
|
|
|
311
283
|
* @param {string} platformId The platform identifier
|
|
312
284
|
* @param {number} [pageToken] Page reference token
|
|
313
285
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
314
|
-
* @param {string} [search] Search term to filter
|
|
286
|
+
* @param {string} [search] Search term to filter results
|
|
315
287
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
316
288
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
317
289
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
@@ -1464,40 +1436,37 @@ export class PlatformApi extends BaseAPI {
|
|
|
1464
1436
|
}
|
|
1465
1437
|
}
|
|
1466
1438
|
/**
|
|
1467
|
-
*
|
|
1439
|
+
* ReviewsApi - axios parameter creator
|
|
1468
1440
|
* @export
|
|
1469
1441
|
*/
|
|
1470
|
-
export const
|
|
1442
|
+
export const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
1471
1443
|
return {
|
|
1472
1444
|
/**
|
|
1473
|
-
*
|
|
1474
|
-
* @summary
|
|
1445
|
+
* Export reviews as a CSV file.
|
|
1446
|
+
* @summary Export reviews
|
|
1475
1447
|
* @param {string} project Project unique identifier
|
|
1476
1448
|
* @param {string} platformId The platform identifier
|
|
1477
|
-
* @param {string}
|
|
1478
|
-
* @param {
|
|
1449
|
+
* @param {string} start Start of date range to filter by
|
|
1450
|
+
* @param {string} [end] End of date range to filter by
|
|
1479
1451
|
* @param {*} [options] Override http request option.
|
|
1480
1452
|
* @throws {RequiredError}
|
|
1481
1453
|
*/
|
|
1482
|
-
|
|
1454
|
+
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 = {}) {
|
|
1483
1455
|
// verify required parameter 'project' is not null or undefined
|
|
1484
|
-
assertParamExists('
|
|
1456
|
+
assertParamExists('exportReviews', 'project', project);
|
|
1485
1457
|
// verify required parameter 'platformId' is not null or undefined
|
|
1486
|
-
assertParamExists('
|
|
1487
|
-
// verify required parameter '
|
|
1488
|
-
assertParamExists('
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
const localVarPath = `/v1/platform/{platformId}/warehouse/products/{productId}`
|
|
1492
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1493
|
-
.replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
|
|
1458
|
+
assertParamExists('exportReviews', 'platformId', platformId);
|
|
1459
|
+
// verify required parameter 'start' is not null or undefined
|
|
1460
|
+
assertParamExists('exportReviews', 'start', start);
|
|
1461
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/export`
|
|
1462
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1494
1463
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1495
1464
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1496
1465
|
let baseOptions;
|
|
1497
1466
|
if (configuration) {
|
|
1498
1467
|
baseOptions = configuration.baseOptions;
|
|
1499
1468
|
}
|
|
1500
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1469
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1501
1470
|
const localVarHeaderParameter = {};
|
|
1502
1471
|
const localVarQueryParameter = {};
|
|
1503
1472
|
// authentication session-oauth required
|
|
@@ -1508,112 +1477,156 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
1508
1477
|
if (project !== undefined) {
|
|
1509
1478
|
localVarQueryParameter['project'] = project;
|
|
1510
1479
|
}
|
|
1511
|
-
|
|
1480
|
+
if (start !== undefined) {
|
|
1481
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
1482
|
+
start.toISOString() :
|
|
1483
|
+
start;
|
|
1484
|
+
}
|
|
1485
|
+
if (end !== undefined) {
|
|
1486
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
1487
|
+
end.toISOString() :
|
|
1488
|
+
end;
|
|
1489
|
+
}
|
|
1512
1490
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1513
1491
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1514
1492
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1515
|
-
localVarRequestOptions.data = serializeDataIfNeeded(updateProductRequest, localVarRequestOptions, configuration);
|
|
1516
1493
|
return {
|
|
1517
1494
|
url: toPathString(localVarUrlObj),
|
|
1518
1495
|
options: localVarRequestOptions,
|
|
1519
1496
|
};
|
|
1520
1497
|
}),
|
|
1521
|
-
};
|
|
1522
|
-
};
|
|
1523
|
-
/**
|
|
1524
|
-
* ProductsApi - functional programming interface
|
|
1525
|
-
* @export
|
|
1526
|
-
*/
|
|
1527
|
-
export const ProductsApiFp = function (configuration) {
|
|
1528
|
-
const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration);
|
|
1529
|
-
return {
|
|
1530
1498
|
/**
|
|
1531
|
-
*
|
|
1532
|
-
* @summary
|
|
1499
|
+
* Get a review left on a platform by a given review ID.
|
|
1500
|
+
* @summary Get review
|
|
1533
1501
|
* @param {string} project Project unique identifier
|
|
1534
1502
|
* @param {string} platformId The platform identifier
|
|
1535
|
-
* @param {string}
|
|
1536
|
-
* @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
|
|
1503
|
+
* @param {string} reviewId The review identifier
|
|
1537
1504
|
* @param {*} [options] Override http request option.
|
|
1538
1505
|
* @throws {RequiredError}
|
|
1539
1506
|
*/
|
|
1540
|
-
|
|
1541
|
-
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
}
|
|
1548
|
-
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
|
|
1507
|
+
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 = {}) {
|
|
1508
|
+
// verify required parameter 'project' is not null or undefined
|
|
1509
|
+
assertParamExists('getReview', 'project', project);
|
|
1510
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1511
|
+
assertParamExists('getReview', 'platformId', platformId);
|
|
1512
|
+
// verify required parameter 'reviewId' is not null or undefined
|
|
1513
|
+
assertParamExists('getReview', 'reviewId', reviewId);
|
|
1514
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}`
|
|
1515
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1516
|
+
.replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
|
|
1517
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1518
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1519
|
+
let baseOptions;
|
|
1520
|
+
if (configuration) {
|
|
1521
|
+
baseOptions = configuration.baseOptions;
|
|
1522
|
+
}
|
|
1523
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1524
|
+
const localVarHeaderParameter = {};
|
|
1525
|
+
const localVarQueryParameter = {};
|
|
1526
|
+
// authentication session-oauth required
|
|
1527
|
+
// oauth required
|
|
1528
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1529
|
+
// authentication api-key required
|
|
1530
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1531
|
+
if (project !== undefined) {
|
|
1532
|
+
localVarQueryParameter['project'] = project;
|
|
1533
|
+
}
|
|
1534
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1535
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1536
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1537
|
+
return {
|
|
1538
|
+
url: toPathString(localVarUrlObj),
|
|
1539
|
+
options: localVarRequestOptions,
|
|
1540
|
+
};
|
|
1541
|
+
}),
|
|
1558
1542
|
/**
|
|
1559
|
-
*
|
|
1560
|
-
* @summary
|
|
1561
|
-
* @param {
|
|
1543
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1544
|
+
* @summary List reviews
|
|
1545
|
+
* @param {string} project Project unique identifier
|
|
1546
|
+
* @param {string} platformId The platform identifier
|
|
1547
|
+
* @param {number} [pageToken] Page reference token
|
|
1548
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1549
|
+
* @param {string} [search] Search term to filter results
|
|
1550
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1551
|
+
* @param {string} [start] Start of date range to filter by
|
|
1552
|
+
* @param {string} [end] End of date range to filter by
|
|
1562
1553
|
* @param {*} [options] Override http request option.
|
|
1563
1554
|
* @throws {RequiredError}
|
|
1564
1555
|
*/
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
}
|
|
1589
|
-
|
|
1590
|
-
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
|
|
1556
|
+
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 = {}) {
|
|
1557
|
+
// verify required parameter 'project' is not null or undefined
|
|
1558
|
+
assertParamExists('listReviews', 'project', project);
|
|
1559
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1560
|
+
assertParamExists('listReviews', 'platformId', platformId);
|
|
1561
|
+
const localVarPath = `/v1/platform/{platformId}/reviews`
|
|
1562
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1563
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1564
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1565
|
+
let baseOptions;
|
|
1566
|
+
if (configuration) {
|
|
1567
|
+
baseOptions = configuration.baseOptions;
|
|
1568
|
+
}
|
|
1569
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1570
|
+
const localVarHeaderParameter = {};
|
|
1571
|
+
const localVarQueryParameter = {};
|
|
1572
|
+
// authentication session-oauth required
|
|
1573
|
+
// oauth required
|
|
1574
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1575
|
+
// authentication api-key required
|
|
1576
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1577
|
+
if (project !== undefined) {
|
|
1578
|
+
localVarQueryParameter['project'] = project;
|
|
1579
|
+
}
|
|
1580
|
+
if (pageToken !== undefined) {
|
|
1581
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1582
|
+
}
|
|
1583
|
+
if (pageSize !== undefined) {
|
|
1584
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1585
|
+
}
|
|
1586
|
+
if (search !== undefined) {
|
|
1587
|
+
localVarQueryParameter['search'] = search;
|
|
1588
|
+
}
|
|
1589
|
+
if (sortBy) {
|
|
1590
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1591
|
+
}
|
|
1592
|
+
if (start !== undefined) {
|
|
1593
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
1594
|
+
start.toISOString() :
|
|
1595
|
+
start;
|
|
1596
|
+
}
|
|
1597
|
+
if (end !== undefined) {
|
|
1598
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
1599
|
+
end.toISOString() :
|
|
1600
|
+
end;
|
|
1601
|
+
}
|
|
1602
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1603
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1604
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1605
|
+
return {
|
|
1606
|
+
url: toPathString(localVarUrlObj),
|
|
1607
|
+
options: localVarRequestOptions,
|
|
1608
|
+
};
|
|
1609
|
+
}),
|
|
1595
1610
|
/**
|
|
1596
|
-
*
|
|
1597
|
-
* @summary
|
|
1611
|
+
* Moderate a review left on a platform.
|
|
1612
|
+
* @summary Moderate review
|
|
1598
1613
|
* @param {string} project Project unique identifier
|
|
1599
1614
|
* @param {string} platformId The platform identifier
|
|
1600
|
-
* @param {string}
|
|
1601
|
-
* @param {
|
|
1615
|
+
* @param {string} reviewId The review identifier
|
|
1616
|
+
* @param {ModerateReviewRequest} [moderateReviewRequest]
|
|
1602
1617
|
* @param {*} [options] Override http request option.
|
|
1603
1618
|
* @throws {RequiredError}
|
|
1604
1619
|
*/
|
|
1605
|
-
|
|
1620
|
+
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 = {}) {
|
|
1606
1621
|
// verify required parameter 'project' is not null or undefined
|
|
1607
|
-
assertParamExists('
|
|
1622
|
+
assertParamExists('moderateReview', 'project', project);
|
|
1608
1623
|
// verify required parameter 'platformId' is not null or undefined
|
|
1609
|
-
assertParamExists('
|
|
1610
|
-
// verify required parameter '
|
|
1611
|
-
assertParamExists('
|
|
1612
|
-
|
|
1613
|
-
assertParamExists('updateVariant', 'updateVariantRequest', updateVariantRequest);
|
|
1614
|
-
const localVarPath = `/v1/platform/{platformId}/warehouse/variants/{variantId}`
|
|
1624
|
+
assertParamExists('moderateReview', 'platformId', platformId);
|
|
1625
|
+
// verify required parameter 'reviewId' is not null or undefined
|
|
1626
|
+
assertParamExists('moderateReview', 'reviewId', reviewId);
|
|
1627
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}/moderate`
|
|
1615
1628
|
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1616
|
-
.replace(`{${"
|
|
1629
|
+
.replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
|
|
1617
1630
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1618
1631
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1619
1632
|
let baseOptions;
|
|
@@ -1635,7 +1648,7 @@ export const VariantsApiAxiosParamCreator = function (configuration) {
|
|
|
1635
1648
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1636
1649
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1637
1650
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1638
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
1651
|
+
localVarRequestOptions.data = serializeDataIfNeeded(moderateReviewRequest, localVarRequestOptions, configuration);
|
|
1639
1652
|
return {
|
|
1640
1653
|
url: toPathString(localVarUrlObj),
|
|
1641
1654
|
options: localVarRequestOptions,
|
|
@@ -1644,68 +1657,191 @@ export const VariantsApiAxiosParamCreator = function (configuration) {
|
|
|
1644
1657
|
};
|
|
1645
1658
|
};
|
|
1646
1659
|
/**
|
|
1647
|
-
*
|
|
1660
|
+
* ReviewsApi - functional programming interface
|
|
1648
1661
|
* @export
|
|
1649
1662
|
*/
|
|
1650
|
-
export const
|
|
1651
|
-
const localVarAxiosParamCreator =
|
|
1663
|
+
export const ReviewsApiFp = function (configuration) {
|
|
1664
|
+
const localVarAxiosParamCreator = ReviewsApiAxiosParamCreator(configuration);
|
|
1652
1665
|
return {
|
|
1653
1666
|
/**
|
|
1654
|
-
*
|
|
1655
|
-
* @summary
|
|
1667
|
+
* Export reviews as a CSV file.
|
|
1668
|
+
* @summary Export reviews
|
|
1669
|
+
* @param {string} project Project unique identifier
|
|
1670
|
+
* @param {string} platformId The platform identifier
|
|
1671
|
+
* @param {string} start Start of date range to filter by
|
|
1672
|
+
* @param {string} [end] End of date range to filter by
|
|
1673
|
+
* @param {*} [options] Override http request option.
|
|
1674
|
+
* @throws {RequiredError}
|
|
1675
|
+
*/
|
|
1676
|
+
exportReviews(project, platformId, start, end, options) {
|
|
1677
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1678
|
+
var _a, _b, _c;
|
|
1679
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportReviews(project, platformId, start, end, options);
|
|
1680
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1681
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.exportReviews']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1682
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1683
|
+
});
|
|
1684
|
+
},
|
|
1685
|
+
/**
|
|
1686
|
+
* Get a review left on a platform by a given review ID.
|
|
1687
|
+
* @summary Get review
|
|
1656
1688
|
* @param {string} project Project unique identifier
|
|
1657
1689
|
* @param {string} platformId The platform identifier
|
|
1658
|
-
* @param {string}
|
|
1659
|
-
* @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
|
|
1690
|
+
* @param {string} reviewId The review identifier
|
|
1660
1691
|
* @param {*} [options] Override http request option.
|
|
1661
1692
|
* @throws {RequiredError}
|
|
1662
1693
|
*/
|
|
1663
|
-
|
|
1694
|
+
getReview(project, platformId, reviewId, options) {
|
|
1664
1695
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1665
1696
|
var _a, _b, _c;
|
|
1666
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1697
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReview(project, platformId, reviewId, options);
|
|
1667
1698
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1668
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['
|
|
1699
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.getReview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1700
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1701
|
+
});
|
|
1702
|
+
},
|
|
1703
|
+
/**
|
|
1704
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1705
|
+
* @summary List reviews
|
|
1706
|
+
* @param {string} project Project unique identifier
|
|
1707
|
+
* @param {string} platformId The platform identifier
|
|
1708
|
+
* @param {number} [pageToken] Page reference token
|
|
1709
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1710
|
+
* @param {string} [search] Search term to filter results
|
|
1711
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1712
|
+
* @param {string} [start] Start of date range to filter by
|
|
1713
|
+
* @param {string} [end] End of date range to filter by
|
|
1714
|
+
* @param {*} [options] Override http request option.
|
|
1715
|
+
* @throws {RequiredError}
|
|
1716
|
+
*/
|
|
1717
|
+
listReviews(project, platformId, pageToken, pageSize, search, sortBy, start, end, options) {
|
|
1718
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1719
|
+
var _a, _b, _c;
|
|
1720
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listReviews(project, platformId, pageToken, pageSize, search, sortBy, start, end, options);
|
|
1721
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1722
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.listReviews']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1723
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1724
|
+
});
|
|
1725
|
+
},
|
|
1726
|
+
/**
|
|
1727
|
+
* Moderate a review left on a platform.
|
|
1728
|
+
* @summary Moderate review
|
|
1729
|
+
* @param {string} project Project unique identifier
|
|
1730
|
+
* @param {string} platformId The platform identifier
|
|
1731
|
+
* @param {string} reviewId The review identifier
|
|
1732
|
+
* @param {ModerateReviewRequest} [moderateReviewRequest]
|
|
1733
|
+
* @param {*} [options] Override http request option.
|
|
1734
|
+
* @throws {RequiredError}
|
|
1735
|
+
*/
|
|
1736
|
+
moderateReview(project, platformId, reviewId, moderateReviewRequest, options) {
|
|
1737
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1738
|
+
var _a, _b, _c;
|
|
1739
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.moderateReview(project, platformId, reviewId, moderateReviewRequest, options);
|
|
1740
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1741
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.moderateReview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1669
1742
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1670
1743
|
});
|
|
1671
1744
|
},
|
|
1672
1745
|
};
|
|
1673
1746
|
};
|
|
1674
1747
|
/**
|
|
1675
|
-
*
|
|
1748
|
+
* ReviewsApi - factory interface
|
|
1676
1749
|
* @export
|
|
1677
1750
|
*/
|
|
1678
|
-
export const
|
|
1679
|
-
const localVarFp =
|
|
1751
|
+
export const ReviewsApiFactory = function (configuration, basePath, axios) {
|
|
1752
|
+
const localVarFp = ReviewsApiFp(configuration);
|
|
1680
1753
|
return {
|
|
1681
1754
|
/**
|
|
1682
|
-
*
|
|
1683
|
-
* @summary
|
|
1684
|
-
* @param {
|
|
1755
|
+
* Export reviews as a CSV file.
|
|
1756
|
+
* @summary Export reviews
|
|
1757
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
1758
|
+
* @param {*} [options] Override http request option.
|
|
1759
|
+
* @throws {RequiredError}
|
|
1760
|
+
*/
|
|
1761
|
+
exportReviews(requestParameters, options) {
|
|
1762
|
+
return localVarFp.exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
1763
|
+
},
|
|
1764
|
+
/**
|
|
1765
|
+
* Get a review left on a platform by a given review ID.
|
|
1766
|
+
* @summary Get review
|
|
1767
|
+
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
1685
1768
|
* @param {*} [options] Override http request option.
|
|
1686
1769
|
* @throws {RequiredError}
|
|
1687
1770
|
*/
|
|
1688
|
-
|
|
1689
|
-
return localVarFp.
|
|
1771
|
+
getReview(requestParameters, options) {
|
|
1772
|
+
return localVarFp.getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(axios, basePath));
|
|
1773
|
+
},
|
|
1774
|
+
/**
|
|
1775
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1776
|
+
* @summary List reviews
|
|
1777
|
+
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
1778
|
+
* @param {*} [options] Override http request option.
|
|
1779
|
+
* @throws {RequiredError}
|
|
1780
|
+
*/
|
|
1781
|
+
listReviews(requestParameters, options) {
|
|
1782
|
+
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));
|
|
1783
|
+
},
|
|
1784
|
+
/**
|
|
1785
|
+
* Moderate a review left on a platform.
|
|
1786
|
+
* @summary Moderate review
|
|
1787
|
+
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
1788
|
+
* @param {*} [options] Override http request option.
|
|
1789
|
+
* @throws {RequiredError}
|
|
1790
|
+
*/
|
|
1791
|
+
moderateReview(requestParameters, options) {
|
|
1792
|
+
return localVarFp.moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(axios, basePath));
|
|
1690
1793
|
},
|
|
1691
1794
|
};
|
|
1692
1795
|
};
|
|
1693
1796
|
/**
|
|
1694
|
-
*
|
|
1797
|
+
* ReviewsApi - object-oriented interface
|
|
1695
1798
|
* @export
|
|
1696
|
-
* @class
|
|
1799
|
+
* @class ReviewsApi
|
|
1697
1800
|
* @extends {BaseAPI}
|
|
1698
1801
|
*/
|
|
1699
|
-
export class
|
|
1802
|
+
export class ReviewsApi extends BaseAPI {
|
|
1803
|
+
/**
|
|
1804
|
+
* Export reviews as a CSV file.
|
|
1805
|
+
* @summary Export reviews
|
|
1806
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
1807
|
+
* @param {*} [options] Override http request option.
|
|
1808
|
+
* @throws {RequiredError}
|
|
1809
|
+
* @memberof ReviewsApi
|
|
1810
|
+
*/
|
|
1811
|
+
exportReviews(requestParameters, options) {
|
|
1812
|
+
return ReviewsApiFp(this.configuration).exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
1813
|
+
}
|
|
1814
|
+
/**
|
|
1815
|
+
* Get a review left on a platform by a given review ID.
|
|
1816
|
+
* @summary Get review
|
|
1817
|
+
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
1818
|
+
* @param {*} [options] Override http request option.
|
|
1819
|
+
* @throws {RequiredError}
|
|
1820
|
+
* @memberof ReviewsApi
|
|
1821
|
+
*/
|
|
1822
|
+
getReview(requestParameters, options) {
|
|
1823
|
+
return ReviewsApiFp(this.configuration).getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(this.axios, this.basePath));
|
|
1824
|
+
}
|
|
1825
|
+
/**
|
|
1826
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1827
|
+
* @summary List reviews
|
|
1828
|
+
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
1829
|
+
* @param {*} [options] Override http request option.
|
|
1830
|
+
* @throws {RequiredError}
|
|
1831
|
+
* @memberof ReviewsApi
|
|
1832
|
+
*/
|
|
1833
|
+
listReviews(requestParameters, options) {
|
|
1834
|
+
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));
|
|
1835
|
+
}
|
|
1700
1836
|
/**
|
|
1701
|
-
*
|
|
1702
|
-
* @summary
|
|
1703
|
-
* @param {
|
|
1837
|
+
* Moderate a review left on a platform.
|
|
1838
|
+
* @summary Moderate review
|
|
1839
|
+
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
1704
1840
|
* @param {*} [options] Override http request option.
|
|
1705
1841
|
* @throws {RequiredError}
|
|
1706
|
-
* @memberof
|
|
1842
|
+
* @memberof ReviewsApi
|
|
1707
1843
|
*/
|
|
1708
|
-
|
|
1709
|
-
return
|
|
1844
|
+
moderateReview(requestParameters, options) {
|
|
1845
|
+
return ReviewsApiFp(this.configuration).moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1710
1846
|
}
|
|
1711
1847
|
}
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED