@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.
- package/README.md +95 -2
- package/api.ts +879 -4
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +596 -4
- package/dist/api.js +429 -4
- 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 +596 -4
- package/dist/esm/api.js +424 -3
- 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 +56 -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/PaymentAttempt.md +29 -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.17.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.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;
|
|
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.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = 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
|
|
@@ -44,6 +44,17 @@ exports.OrderStatus = {
|
|
|
44
44
|
exports.PaymentAccountMethodEnum = {
|
|
45
45
|
Stripe: 'stripe'
|
|
46
46
|
};
|
|
47
|
+
exports.PaymentAttemptPaymentProviderEnum = {
|
|
48
|
+
Stripe: 'stripe',
|
|
49
|
+
Paypal: 'paypal',
|
|
50
|
+
Wallet: 'wallet'
|
|
51
|
+
};
|
|
52
|
+
exports.PaymentAttemptStatusEnum = {
|
|
53
|
+
Success: 'success',
|
|
54
|
+
Failed: 'failed',
|
|
55
|
+
Pending: 'pending',
|
|
56
|
+
Cancelled: 'cancelled'
|
|
57
|
+
};
|
|
47
58
|
/**
|
|
48
59
|
* CustomersApi - axios parameter creator
|
|
49
60
|
* @export
|
|
@@ -163,7 +174,7 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
163
174
|
* @param {string} platformId The platform identifier
|
|
164
175
|
* @param {number} [pageToken] Page reference token
|
|
165
176
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
166
|
-
* @param {string} [search] Search term to filter
|
|
177
|
+
* @param {string} [search] Search term to filter results
|
|
167
178
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
168
179
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
169
180
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
@@ -287,7 +298,7 @@ const CustomersApiFp = function (configuration) {
|
|
|
287
298
|
* @param {string} platformId The platform identifier
|
|
288
299
|
* @param {number} [pageToken] Page reference token
|
|
289
300
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
290
|
-
* @param {string} [search] Search term to filter
|
|
301
|
+
* @param {string} [search] Search term to filter results
|
|
291
302
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
292
303
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
293
304
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
@@ -1454,3 +1465,417 @@ class PlatformApi extends base_1.BaseAPI {
|
|
|
1454
1465
|
}
|
|
1455
1466
|
}
|
|
1456
1467
|
exports.PlatformApi = PlatformApi;
|
|
1468
|
+
/**
|
|
1469
|
+
* ReviewsApi - axios parameter creator
|
|
1470
|
+
* @export
|
|
1471
|
+
*/
|
|
1472
|
+
const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
1473
|
+
return {
|
|
1474
|
+
/**
|
|
1475
|
+
* Export reviews as a CSV file.
|
|
1476
|
+
* @summary Export reviews
|
|
1477
|
+
* @param {string} project Project unique identifier
|
|
1478
|
+
* @param {string} platformId The platform identifier
|
|
1479
|
+
* @param {string} start Start of date range to filter by
|
|
1480
|
+
* @param {string} [end] End of date range to filter by
|
|
1481
|
+
* @param {*} [options] Override http request option.
|
|
1482
|
+
* @throws {RequiredError}
|
|
1483
|
+
*/
|
|
1484
|
+
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 = {}) {
|
|
1485
|
+
// verify required parameter 'project' is not null or undefined
|
|
1486
|
+
(0, common_1.assertParamExists)('exportReviews', 'project', project);
|
|
1487
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1488
|
+
(0, common_1.assertParamExists)('exportReviews', 'platformId', platformId);
|
|
1489
|
+
// verify required parameter 'start' is not null or undefined
|
|
1490
|
+
(0, common_1.assertParamExists)('exportReviews', 'start', start);
|
|
1491
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/export`
|
|
1492
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1493
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1494
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1495
|
+
let baseOptions;
|
|
1496
|
+
if (configuration) {
|
|
1497
|
+
baseOptions = configuration.baseOptions;
|
|
1498
|
+
}
|
|
1499
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1500
|
+
const localVarHeaderParameter = {};
|
|
1501
|
+
const localVarQueryParameter = {};
|
|
1502
|
+
// authentication session-oauth required
|
|
1503
|
+
// oauth required
|
|
1504
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1505
|
+
// authentication api-key required
|
|
1506
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1507
|
+
if (project !== undefined) {
|
|
1508
|
+
localVarQueryParameter['project'] = project;
|
|
1509
|
+
}
|
|
1510
|
+
if (start !== undefined) {
|
|
1511
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
1512
|
+
start.toISOString() :
|
|
1513
|
+
start;
|
|
1514
|
+
}
|
|
1515
|
+
if (end !== undefined) {
|
|
1516
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
1517
|
+
end.toISOString() :
|
|
1518
|
+
end;
|
|
1519
|
+
}
|
|
1520
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1521
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1522
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1523
|
+
return {
|
|
1524
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1525
|
+
options: localVarRequestOptions,
|
|
1526
|
+
};
|
|
1527
|
+
}),
|
|
1528
|
+
/**
|
|
1529
|
+
* Get a review left on a platform by a given review ID.
|
|
1530
|
+
* @summary Get review
|
|
1531
|
+
* @param {string} project Project unique identifier
|
|
1532
|
+
* @param {string} platformId The platform identifier
|
|
1533
|
+
* @param {string} reviewId The review identifier
|
|
1534
|
+
* @param {*} [options] Override http request option.
|
|
1535
|
+
* @throws {RequiredError}
|
|
1536
|
+
*/
|
|
1537
|
+
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 = {}) {
|
|
1538
|
+
// verify required parameter 'project' is not null or undefined
|
|
1539
|
+
(0, common_1.assertParamExists)('getReview', 'project', project);
|
|
1540
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1541
|
+
(0, common_1.assertParamExists)('getReview', 'platformId', platformId);
|
|
1542
|
+
// verify required parameter 'reviewId' is not null or undefined
|
|
1543
|
+
(0, common_1.assertParamExists)('getReview', 'reviewId', reviewId);
|
|
1544
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}`
|
|
1545
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1546
|
+
.replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
|
|
1547
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1548
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1549
|
+
let baseOptions;
|
|
1550
|
+
if (configuration) {
|
|
1551
|
+
baseOptions = configuration.baseOptions;
|
|
1552
|
+
}
|
|
1553
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1554
|
+
const localVarHeaderParameter = {};
|
|
1555
|
+
const localVarQueryParameter = {};
|
|
1556
|
+
// authentication session-oauth required
|
|
1557
|
+
// oauth required
|
|
1558
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1559
|
+
// authentication api-key required
|
|
1560
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1561
|
+
if (project !== undefined) {
|
|
1562
|
+
localVarQueryParameter['project'] = project;
|
|
1563
|
+
}
|
|
1564
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1565
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1566
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1567
|
+
return {
|
|
1568
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1569
|
+
options: localVarRequestOptions,
|
|
1570
|
+
};
|
|
1571
|
+
}),
|
|
1572
|
+
/**
|
|
1573
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1574
|
+
* @summary List reviews
|
|
1575
|
+
* @param {string} project Project unique identifier
|
|
1576
|
+
* @param {string} platformId The platform identifier
|
|
1577
|
+
* @param {number} [pageToken] Page reference token
|
|
1578
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1579
|
+
* @param {string} [search] Search term to filter results
|
|
1580
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1581
|
+
* @param {string} [start] Start of date range to filter by
|
|
1582
|
+
* @param {string} [end] End of date range to filter by
|
|
1583
|
+
* @param {*} [options] Override http request option.
|
|
1584
|
+
* @throws {RequiredError}
|
|
1585
|
+
*/
|
|
1586
|
+
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 = {}) {
|
|
1587
|
+
// verify required parameter 'project' is not null or undefined
|
|
1588
|
+
(0, common_1.assertParamExists)('listReviews', 'project', project);
|
|
1589
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1590
|
+
(0, common_1.assertParamExists)('listReviews', 'platformId', platformId);
|
|
1591
|
+
const localVarPath = `/v1/platform/{platformId}/reviews`
|
|
1592
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1593
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1594
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1595
|
+
let baseOptions;
|
|
1596
|
+
if (configuration) {
|
|
1597
|
+
baseOptions = configuration.baseOptions;
|
|
1598
|
+
}
|
|
1599
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1600
|
+
const localVarHeaderParameter = {};
|
|
1601
|
+
const localVarQueryParameter = {};
|
|
1602
|
+
// authentication session-oauth required
|
|
1603
|
+
// oauth required
|
|
1604
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1605
|
+
// authentication api-key required
|
|
1606
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1607
|
+
if (project !== undefined) {
|
|
1608
|
+
localVarQueryParameter['project'] = project;
|
|
1609
|
+
}
|
|
1610
|
+
if (pageToken !== undefined) {
|
|
1611
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1612
|
+
}
|
|
1613
|
+
if (pageSize !== undefined) {
|
|
1614
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1615
|
+
}
|
|
1616
|
+
if (search !== undefined) {
|
|
1617
|
+
localVarQueryParameter['search'] = search;
|
|
1618
|
+
}
|
|
1619
|
+
if (sortBy) {
|
|
1620
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1621
|
+
}
|
|
1622
|
+
if (start !== undefined) {
|
|
1623
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
1624
|
+
start.toISOString() :
|
|
1625
|
+
start;
|
|
1626
|
+
}
|
|
1627
|
+
if (end !== undefined) {
|
|
1628
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
1629
|
+
end.toISOString() :
|
|
1630
|
+
end;
|
|
1631
|
+
}
|
|
1632
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1633
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1634
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1635
|
+
return {
|
|
1636
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1637
|
+
options: localVarRequestOptions,
|
|
1638
|
+
};
|
|
1639
|
+
}),
|
|
1640
|
+
/**
|
|
1641
|
+
* Moderate a review left on a platform.
|
|
1642
|
+
* @summary Moderate review
|
|
1643
|
+
* @param {string} project Project unique identifier
|
|
1644
|
+
* @param {string} platformId The platform identifier
|
|
1645
|
+
* @param {string} reviewId The review identifier
|
|
1646
|
+
* @param {ModerateReviewRequest} [moderateReviewRequest]
|
|
1647
|
+
* @param {*} [options] Override http request option.
|
|
1648
|
+
* @throws {RequiredError}
|
|
1649
|
+
*/
|
|
1650
|
+
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 = {}) {
|
|
1651
|
+
// verify required parameter 'project' is not null or undefined
|
|
1652
|
+
(0, common_1.assertParamExists)('moderateReview', 'project', project);
|
|
1653
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1654
|
+
(0, common_1.assertParamExists)('moderateReview', 'platformId', platformId);
|
|
1655
|
+
// verify required parameter 'reviewId' is not null or undefined
|
|
1656
|
+
(0, common_1.assertParamExists)('moderateReview', 'reviewId', reviewId);
|
|
1657
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}/moderate`
|
|
1658
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1659
|
+
.replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
|
|
1660
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1661
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1662
|
+
let baseOptions;
|
|
1663
|
+
if (configuration) {
|
|
1664
|
+
baseOptions = configuration.baseOptions;
|
|
1665
|
+
}
|
|
1666
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
1667
|
+
const localVarHeaderParameter = {};
|
|
1668
|
+
const localVarQueryParameter = {};
|
|
1669
|
+
// authentication session-oauth required
|
|
1670
|
+
// oauth required
|
|
1671
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1672
|
+
// authentication api-key required
|
|
1673
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1674
|
+
if (project !== undefined) {
|
|
1675
|
+
localVarQueryParameter['project'] = project;
|
|
1676
|
+
}
|
|
1677
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1678
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1679
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1680
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1681
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(moderateReviewRequest, localVarRequestOptions, configuration);
|
|
1682
|
+
return {
|
|
1683
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1684
|
+
options: localVarRequestOptions,
|
|
1685
|
+
};
|
|
1686
|
+
}),
|
|
1687
|
+
};
|
|
1688
|
+
};
|
|
1689
|
+
exports.ReviewsApiAxiosParamCreator = ReviewsApiAxiosParamCreator;
|
|
1690
|
+
/**
|
|
1691
|
+
* ReviewsApi - functional programming interface
|
|
1692
|
+
* @export
|
|
1693
|
+
*/
|
|
1694
|
+
const ReviewsApiFp = function (configuration) {
|
|
1695
|
+
const localVarAxiosParamCreator = (0, exports.ReviewsApiAxiosParamCreator)(configuration);
|
|
1696
|
+
return {
|
|
1697
|
+
/**
|
|
1698
|
+
* Export reviews as a CSV file.
|
|
1699
|
+
* @summary Export reviews
|
|
1700
|
+
* @param {string} project Project unique identifier
|
|
1701
|
+
* @param {string} platformId The platform identifier
|
|
1702
|
+
* @param {string} start Start of date range to filter by
|
|
1703
|
+
* @param {string} [end] End of date range to filter by
|
|
1704
|
+
* @param {*} [options] Override http request option.
|
|
1705
|
+
* @throws {RequiredError}
|
|
1706
|
+
*/
|
|
1707
|
+
exportReviews(project, platformId, start, end, options) {
|
|
1708
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1709
|
+
var _a, _b, _c;
|
|
1710
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportReviews(project, platformId, start, end, options);
|
|
1711
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1712
|
+
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;
|
|
1713
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1714
|
+
});
|
|
1715
|
+
},
|
|
1716
|
+
/**
|
|
1717
|
+
* Get a review left on a platform by a given review ID.
|
|
1718
|
+
* @summary Get review
|
|
1719
|
+
* @param {string} project Project unique identifier
|
|
1720
|
+
* @param {string} platformId The platform identifier
|
|
1721
|
+
* @param {string} reviewId The review identifier
|
|
1722
|
+
* @param {*} [options] Override http request option.
|
|
1723
|
+
* @throws {RequiredError}
|
|
1724
|
+
*/
|
|
1725
|
+
getReview(project, platformId, reviewId, options) {
|
|
1726
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1727
|
+
var _a, _b, _c;
|
|
1728
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReview(project, platformId, reviewId, options);
|
|
1729
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1730
|
+
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;
|
|
1731
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1732
|
+
});
|
|
1733
|
+
},
|
|
1734
|
+
/**
|
|
1735
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1736
|
+
* @summary List reviews
|
|
1737
|
+
* @param {string} project Project unique identifier
|
|
1738
|
+
* @param {string} platformId The platform identifier
|
|
1739
|
+
* @param {number} [pageToken] Page reference token
|
|
1740
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1741
|
+
* @param {string} [search] Search term to filter results
|
|
1742
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1743
|
+
* @param {string} [start] Start of date range to filter by
|
|
1744
|
+
* @param {string} [end] End of date range to filter by
|
|
1745
|
+
* @param {*} [options] Override http request option.
|
|
1746
|
+
* @throws {RequiredError}
|
|
1747
|
+
*/
|
|
1748
|
+
listReviews(project, platformId, pageToken, pageSize, search, sortBy, start, end, options) {
|
|
1749
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1750
|
+
var _a, _b, _c;
|
|
1751
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listReviews(project, platformId, pageToken, pageSize, search, sortBy, start, end, options);
|
|
1752
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1753
|
+
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;
|
|
1754
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1755
|
+
});
|
|
1756
|
+
},
|
|
1757
|
+
/**
|
|
1758
|
+
* Moderate a review left on a platform.
|
|
1759
|
+
* @summary Moderate review
|
|
1760
|
+
* @param {string} project Project unique identifier
|
|
1761
|
+
* @param {string} platformId The platform identifier
|
|
1762
|
+
* @param {string} reviewId The review identifier
|
|
1763
|
+
* @param {ModerateReviewRequest} [moderateReviewRequest]
|
|
1764
|
+
* @param {*} [options] Override http request option.
|
|
1765
|
+
* @throws {RequiredError}
|
|
1766
|
+
*/
|
|
1767
|
+
moderateReview(project, platformId, reviewId, moderateReviewRequest, options) {
|
|
1768
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1769
|
+
var _a, _b, _c;
|
|
1770
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.moderateReview(project, platformId, reviewId, moderateReviewRequest, options);
|
|
1771
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1772
|
+
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;
|
|
1773
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1774
|
+
});
|
|
1775
|
+
},
|
|
1776
|
+
};
|
|
1777
|
+
};
|
|
1778
|
+
exports.ReviewsApiFp = ReviewsApiFp;
|
|
1779
|
+
/**
|
|
1780
|
+
* ReviewsApi - factory interface
|
|
1781
|
+
* @export
|
|
1782
|
+
*/
|
|
1783
|
+
const ReviewsApiFactory = function (configuration, basePath, axios) {
|
|
1784
|
+
const localVarFp = (0, exports.ReviewsApiFp)(configuration);
|
|
1785
|
+
return {
|
|
1786
|
+
/**
|
|
1787
|
+
* Export reviews as a CSV file.
|
|
1788
|
+
* @summary Export reviews
|
|
1789
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
1790
|
+
* @param {*} [options] Override http request option.
|
|
1791
|
+
* @throws {RequiredError}
|
|
1792
|
+
*/
|
|
1793
|
+
exportReviews(requestParameters, options) {
|
|
1794
|
+
return localVarFp.exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
1795
|
+
},
|
|
1796
|
+
/**
|
|
1797
|
+
* Get a review left on a platform by a given review ID.
|
|
1798
|
+
* @summary Get review
|
|
1799
|
+
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
1800
|
+
* @param {*} [options] Override http request option.
|
|
1801
|
+
* @throws {RequiredError}
|
|
1802
|
+
*/
|
|
1803
|
+
getReview(requestParameters, options) {
|
|
1804
|
+
return localVarFp.getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(axios, basePath));
|
|
1805
|
+
},
|
|
1806
|
+
/**
|
|
1807
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1808
|
+
* @summary List reviews
|
|
1809
|
+
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
1810
|
+
* @param {*} [options] Override http request option.
|
|
1811
|
+
* @throws {RequiredError}
|
|
1812
|
+
*/
|
|
1813
|
+
listReviews(requestParameters, options) {
|
|
1814
|
+
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));
|
|
1815
|
+
},
|
|
1816
|
+
/**
|
|
1817
|
+
* Moderate a review left on a platform.
|
|
1818
|
+
* @summary Moderate review
|
|
1819
|
+
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
1820
|
+
* @param {*} [options] Override http request option.
|
|
1821
|
+
* @throws {RequiredError}
|
|
1822
|
+
*/
|
|
1823
|
+
moderateReview(requestParameters, options) {
|
|
1824
|
+
return localVarFp.moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(axios, basePath));
|
|
1825
|
+
},
|
|
1826
|
+
};
|
|
1827
|
+
};
|
|
1828
|
+
exports.ReviewsApiFactory = ReviewsApiFactory;
|
|
1829
|
+
/**
|
|
1830
|
+
* ReviewsApi - object-oriented interface
|
|
1831
|
+
* @export
|
|
1832
|
+
* @class ReviewsApi
|
|
1833
|
+
* @extends {BaseAPI}
|
|
1834
|
+
*/
|
|
1835
|
+
class ReviewsApi extends base_1.BaseAPI {
|
|
1836
|
+
/**
|
|
1837
|
+
* Export reviews as a CSV file.
|
|
1838
|
+
* @summary Export reviews
|
|
1839
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
1840
|
+
* @param {*} [options] Override http request option.
|
|
1841
|
+
* @throws {RequiredError}
|
|
1842
|
+
* @memberof ReviewsApi
|
|
1843
|
+
*/
|
|
1844
|
+
exportReviews(requestParameters, options) {
|
|
1845
|
+
return (0, exports.ReviewsApiFp)(this.configuration).exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
1846
|
+
}
|
|
1847
|
+
/**
|
|
1848
|
+
* Get a review left on a platform by a given review ID.
|
|
1849
|
+
* @summary Get review
|
|
1850
|
+
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
1851
|
+
* @param {*} [options] Override http request option.
|
|
1852
|
+
* @throws {RequiredError}
|
|
1853
|
+
* @memberof ReviewsApi
|
|
1854
|
+
*/
|
|
1855
|
+
getReview(requestParameters, options) {
|
|
1856
|
+
return (0, exports.ReviewsApiFp)(this.configuration).getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(this.axios, this.basePath));
|
|
1857
|
+
}
|
|
1858
|
+
/**
|
|
1859
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1860
|
+
* @summary List reviews
|
|
1861
|
+
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
1862
|
+
* @param {*} [options] Override http request option.
|
|
1863
|
+
* @throws {RequiredError}
|
|
1864
|
+
* @memberof ReviewsApi
|
|
1865
|
+
*/
|
|
1866
|
+
listReviews(requestParameters, options) {
|
|
1867
|
+
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));
|
|
1868
|
+
}
|
|
1869
|
+
/**
|
|
1870
|
+
* Moderate a review left on a platform.
|
|
1871
|
+
* @summary Moderate review
|
|
1872
|
+
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
1873
|
+
* @param {*} [options] Override http request option.
|
|
1874
|
+
* @throws {RequiredError}
|
|
1875
|
+
* @memberof ReviewsApi
|
|
1876
|
+
*/
|
|
1877
|
+
moderateReview(requestParameters, options) {
|
|
1878
|
+
return (0, exports.ReviewsApiFp)(this.configuration).moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1879
|
+
}
|
|
1880
|
+
}
|
|
1881
|
+
exports.ReviewsApi = ReviewsApi;
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED