@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/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.17.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -41,6 +41,17 @@ export const OrderStatus = {
|
|
|
41
41
|
export const PaymentAccountMethodEnum = {
|
|
42
42
|
Stripe: 'stripe'
|
|
43
43
|
};
|
|
44
|
+
export const PaymentAttemptPaymentProviderEnum = {
|
|
45
|
+
Stripe: 'stripe',
|
|
46
|
+
Paypal: 'paypal',
|
|
47
|
+
Wallet: 'wallet'
|
|
48
|
+
};
|
|
49
|
+
export const PaymentAttemptStatusEnum = {
|
|
50
|
+
Success: 'success',
|
|
51
|
+
Failed: 'failed',
|
|
52
|
+
Pending: 'pending',
|
|
53
|
+
Cancelled: 'cancelled'
|
|
54
|
+
};
|
|
44
55
|
/**
|
|
45
56
|
* CustomersApi - axios parameter creator
|
|
46
57
|
* @export
|
|
@@ -160,7 +171,7 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
160
171
|
* @param {string} platformId The platform identifier
|
|
161
172
|
* @param {number} [pageToken] Page reference token
|
|
162
173
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
163
|
-
* @param {string} [search] Search term to filter
|
|
174
|
+
* @param {string} [search] Search term to filter results
|
|
164
175
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
165
176
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
166
177
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
@@ -283,7 +294,7 @@ export const CustomersApiFp = function (configuration) {
|
|
|
283
294
|
* @param {string} platformId The platform identifier
|
|
284
295
|
* @param {number} [pageToken] Page reference token
|
|
285
296
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
286
|
-
* @param {string} [search] Search term to filter
|
|
297
|
+
* @param {string} [search] Search term to filter results
|
|
287
298
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
288
299
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
289
300
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
@@ -1435,3 +1446,413 @@ export class PlatformApi extends BaseAPI {
|
|
|
1435
1446
|
return PlatformApiFp(this.configuration).updatePlatform(requestParameters.project, requestParameters.updatePlatformRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1436
1447
|
}
|
|
1437
1448
|
}
|
|
1449
|
+
/**
|
|
1450
|
+
* ReviewsApi - axios parameter creator
|
|
1451
|
+
* @export
|
|
1452
|
+
*/
|
|
1453
|
+
export const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
1454
|
+
return {
|
|
1455
|
+
/**
|
|
1456
|
+
* Export reviews as a CSV file.
|
|
1457
|
+
* @summary Export reviews
|
|
1458
|
+
* @param {string} project Project unique identifier
|
|
1459
|
+
* @param {string} platformId The platform identifier
|
|
1460
|
+
* @param {string} start Start of date range to filter by
|
|
1461
|
+
* @param {string} [end] End of date range to filter by
|
|
1462
|
+
* @param {*} [options] Override http request option.
|
|
1463
|
+
* @throws {RequiredError}
|
|
1464
|
+
*/
|
|
1465
|
+
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 = {}) {
|
|
1466
|
+
// verify required parameter 'project' is not null or undefined
|
|
1467
|
+
assertParamExists('exportReviews', 'project', project);
|
|
1468
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1469
|
+
assertParamExists('exportReviews', 'platformId', platformId);
|
|
1470
|
+
// verify required parameter 'start' is not null or undefined
|
|
1471
|
+
assertParamExists('exportReviews', 'start', start);
|
|
1472
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/export`
|
|
1473
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1474
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1475
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1476
|
+
let baseOptions;
|
|
1477
|
+
if (configuration) {
|
|
1478
|
+
baseOptions = configuration.baseOptions;
|
|
1479
|
+
}
|
|
1480
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1481
|
+
const localVarHeaderParameter = {};
|
|
1482
|
+
const localVarQueryParameter = {};
|
|
1483
|
+
// authentication session-oauth required
|
|
1484
|
+
// oauth required
|
|
1485
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1486
|
+
// authentication api-key required
|
|
1487
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1488
|
+
if (project !== undefined) {
|
|
1489
|
+
localVarQueryParameter['project'] = project;
|
|
1490
|
+
}
|
|
1491
|
+
if (start !== undefined) {
|
|
1492
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
1493
|
+
start.toISOString() :
|
|
1494
|
+
start;
|
|
1495
|
+
}
|
|
1496
|
+
if (end !== undefined) {
|
|
1497
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
1498
|
+
end.toISOString() :
|
|
1499
|
+
end;
|
|
1500
|
+
}
|
|
1501
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1502
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1503
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1504
|
+
return {
|
|
1505
|
+
url: toPathString(localVarUrlObj),
|
|
1506
|
+
options: localVarRequestOptions,
|
|
1507
|
+
};
|
|
1508
|
+
}),
|
|
1509
|
+
/**
|
|
1510
|
+
* Get a review left on a platform by a given review ID.
|
|
1511
|
+
* @summary Get review
|
|
1512
|
+
* @param {string} project Project unique identifier
|
|
1513
|
+
* @param {string} platformId The platform identifier
|
|
1514
|
+
* @param {string} reviewId The review identifier
|
|
1515
|
+
* @param {*} [options] Override http request option.
|
|
1516
|
+
* @throws {RequiredError}
|
|
1517
|
+
*/
|
|
1518
|
+
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 = {}) {
|
|
1519
|
+
// verify required parameter 'project' is not null or undefined
|
|
1520
|
+
assertParamExists('getReview', 'project', project);
|
|
1521
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1522
|
+
assertParamExists('getReview', 'platformId', platformId);
|
|
1523
|
+
// verify required parameter 'reviewId' is not null or undefined
|
|
1524
|
+
assertParamExists('getReview', 'reviewId', reviewId);
|
|
1525
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}`
|
|
1526
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1527
|
+
.replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
|
|
1528
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1529
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1530
|
+
let baseOptions;
|
|
1531
|
+
if (configuration) {
|
|
1532
|
+
baseOptions = configuration.baseOptions;
|
|
1533
|
+
}
|
|
1534
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1535
|
+
const localVarHeaderParameter = {};
|
|
1536
|
+
const localVarQueryParameter = {};
|
|
1537
|
+
// authentication session-oauth required
|
|
1538
|
+
// oauth required
|
|
1539
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1540
|
+
// authentication api-key required
|
|
1541
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1542
|
+
if (project !== undefined) {
|
|
1543
|
+
localVarQueryParameter['project'] = project;
|
|
1544
|
+
}
|
|
1545
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1546
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1547
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1548
|
+
return {
|
|
1549
|
+
url: toPathString(localVarUrlObj),
|
|
1550
|
+
options: localVarRequestOptions,
|
|
1551
|
+
};
|
|
1552
|
+
}),
|
|
1553
|
+
/**
|
|
1554
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1555
|
+
* @summary List reviews
|
|
1556
|
+
* @param {string} project Project unique identifier
|
|
1557
|
+
* @param {string} platformId The platform identifier
|
|
1558
|
+
* @param {number} [pageToken] Page reference token
|
|
1559
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1560
|
+
* @param {string} [search] Search term to filter results
|
|
1561
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1562
|
+
* @param {string} [start] Start of date range to filter by
|
|
1563
|
+
* @param {string} [end] End of date range to filter by
|
|
1564
|
+
* @param {*} [options] Override http request option.
|
|
1565
|
+
* @throws {RequiredError}
|
|
1566
|
+
*/
|
|
1567
|
+
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 = {}) {
|
|
1568
|
+
// verify required parameter 'project' is not null or undefined
|
|
1569
|
+
assertParamExists('listReviews', 'project', project);
|
|
1570
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1571
|
+
assertParamExists('listReviews', 'platformId', platformId);
|
|
1572
|
+
const localVarPath = `/v1/platform/{platformId}/reviews`
|
|
1573
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1574
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1575
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1576
|
+
let baseOptions;
|
|
1577
|
+
if (configuration) {
|
|
1578
|
+
baseOptions = configuration.baseOptions;
|
|
1579
|
+
}
|
|
1580
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1581
|
+
const localVarHeaderParameter = {};
|
|
1582
|
+
const localVarQueryParameter = {};
|
|
1583
|
+
// authentication session-oauth required
|
|
1584
|
+
// oauth required
|
|
1585
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1586
|
+
// authentication api-key required
|
|
1587
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1588
|
+
if (project !== undefined) {
|
|
1589
|
+
localVarQueryParameter['project'] = project;
|
|
1590
|
+
}
|
|
1591
|
+
if (pageToken !== undefined) {
|
|
1592
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1593
|
+
}
|
|
1594
|
+
if (pageSize !== undefined) {
|
|
1595
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1596
|
+
}
|
|
1597
|
+
if (search !== undefined) {
|
|
1598
|
+
localVarQueryParameter['search'] = search;
|
|
1599
|
+
}
|
|
1600
|
+
if (sortBy) {
|
|
1601
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1602
|
+
}
|
|
1603
|
+
if (start !== undefined) {
|
|
1604
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
1605
|
+
start.toISOString() :
|
|
1606
|
+
start;
|
|
1607
|
+
}
|
|
1608
|
+
if (end !== undefined) {
|
|
1609
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
1610
|
+
end.toISOString() :
|
|
1611
|
+
end;
|
|
1612
|
+
}
|
|
1613
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1614
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1615
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1616
|
+
return {
|
|
1617
|
+
url: toPathString(localVarUrlObj),
|
|
1618
|
+
options: localVarRequestOptions,
|
|
1619
|
+
};
|
|
1620
|
+
}),
|
|
1621
|
+
/**
|
|
1622
|
+
* Moderate a review left on a platform.
|
|
1623
|
+
* @summary Moderate review
|
|
1624
|
+
* @param {string} project Project unique identifier
|
|
1625
|
+
* @param {string} platformId The platform identifier
|
|
1626
|
+
* @param {string} reviewId The review identifier
|
|
1627
|
+
* @param {ModerateReviewRequest} [moderateReviewRequest]
|
|
1628
|
+
* @param {*} [options] Override http request option.
|
|
1629
|
+
* @throws {RequiredError}
|
|
1630
|
+
*/
|
|
1631
|
+
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 = {}) {
|
|
1632
|
+
// verify required parameter 'project' is not null or undefined
|
|
1633
|
+
assertParamExists('moderateReview', 'project', project);
|
|
1634
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1635
|
+
assertParamExists('moderateReview', 'platformId', platformId);
|
|
1636
|
+
// verify required parameter 'reviewId' is not null or undefined
|
|
1637
|
+
assertParamExists('moderateReview', 'reviewId', reviewId);
|
|
1638
|
+
const localVarPath = `/v1/platform/{platformId}/reviews/{reviewId}/moderate`
|
|
1639
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1640
|
+
.replace(`{${"reviewId"}}`, encodeURIComponent(String(reviewId)));
|
|
1641
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1642
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1643
|
+
let baseOptions;
|
|
1644
|
+
if (configuration) {
|
|
1645
|
+
baseOptions = configuration.baseOptions;
|
|
1646
|
+
}
|
|
1647
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
1648
|
+
const localVarHeaderParameter = {};
|
|
1649
|
+
const localVarQueryParameter = {};
|
|
1650
|
+
// authentication session-oauth required
|
|
1651
|
+
// oauth required
|
|
1652
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1653
|
+
// authentication api-key required
|
|
1654
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1655
|
+
if (project !== undefined) {
|
|
1656
|
+
localVarQueryParameter['project'] = project;
|
|
1657
|
+
}
|
|
1658
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1659
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1660
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1661
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1662
|
+
localVarRequestOptions.data = serializeDataIfNeeded(moderateReviewRequest, localVarRequestOptions, configuration);
|
|
1663
|
+
return {
|
|
1664
|
+
url: toPathString(localVarUrlObj),
|
|
1665
|
+
options: localVarRequestOptions,
|
|
1666
|
+
};
|
|
1667
|
+
}),
|
|
1668
|
+
};
|
|
1669
|
+
};
|
|
1670
|
+
/**
|
|
1671
|
+
* ReviewsApi - functional programming interface
|
|
1672
|
+
* @export
|
|
1673
|
+
*/
|
|
1674
|
+
export const ReviewsApiFp = function (configuration) {
|
|
1675
|
+
const localVarAxiosParamCreator = ReviewsApiAxiosParamCreator(configuration);
|
|
1676
|
+
return {
|
|
1677
|
+
/**
|
|
1678
|
+
* Export reviews as a CSV file.
|
|
1679
|
+
* @summary Export reviews
|
|
1680
|
+
* @param {string} project Project unique identifier
|
|
1681
|
+
* @param {string} platformId The platform identifier
|
|
1682
|
+
* @param {string} start Start of date range to filter by
|
|
1683
|
+
* @param {string} [end] End of date range to filter by
|
|
1684
|
+
* @param {*} [options] Override http request option.
|
|
1685
|
+
* @throws {RequiredError}
|
|
1686
|
+
*/
|
|
1687
|
+
exportReviews(project, platformId, start, end, options) {
|
|
1688
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1689
|
+
var _a, _b, _c;
|
|
1690
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportReviews(project, platformId, start, end, options);
|
|
1691
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1692
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.exportReviews']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1693
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1694
|
+
});
|
|
1695
|
+
},
|
|
1696
|
+
/**
|
|
1697
|
+
* Get a review left on a platform by a given review ID.
|
|
1698
|
+
* @summary Get review
|
|
1699
|
+
* @param {string} project Project unique identifier
|
|
1700
|
+
* @param {string} platformId The platform identifier
|
|
1701
|
+
* @param {string} reviewId The review identifier
|
|
1702
|
+
* @param {*} [options] Override http request option.
|
|
1703
|
+
* @throws {RequiredError}
|
|
1704
|
+
*/
|
|
1705
|
+
getReview(project, platformId, reviewId, options) {
|
|
1706
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1707
|
+
var _a, _b, _c;
|
|
1708
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReview(project, platformId, reviewId, options);
|
|
1709
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1710
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.getReview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1711
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1712
|
+
});
|
|
1713
|
+
},
|
|
1714
|
+
/**
|
|
1715
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1716
|
+
* @summary List reviews
|
|
1717
|
+
* @param {string} project Project unique identifier
|
|
1718
|
+
* @param {string} platformId The platform identifier
|
|
1719
|
+
* @param {number} [pageToken] Page reference token
|
|
1720
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1721
|
+
* @param {string} [search] Search term to filter results
|
|
1722
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1723
|
+
* @param {string} [start] Start of date range to filter by
|
|
1724
|
+
* @param {string} [end] End of date range to filter by
|
|
1725
|
+
* @param {*} [options] Override http request option.
|
|
1726
|
+
* @throws {RequiredError}
|
|
1727
|
+
*/
|
|
1728
|
+
listReviews(project, platformId, pageToken, pageSize, search, sortBy, start, end, options) {
|
|
1729
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1730
|
+
var _a, _b, _c;
|
|
1731
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listReviews(project, platformId, pageToken, pageSize, search, sortBy, start, end, options);
|
|
1732
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1733
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.listReviews']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1734
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1735
|
+
});
|
|
1736
|
+
},
|
|
1737
|
+
/**
|
|
1738
|
+
* Moderate a review left on a platform.
|
|
1739
|
+
* @summary Moderate review
|
|
1740
|
+
* @param {string} project Project unique identifier
|
|
1741
|
+
* @param {string} platformId The platform identifier
|
|
1742
|
+
* @param {string} reviewId The review identifier
|
|
1743
|
+
* @param {ModerateReviewRequest} [moderateReviewRequest]
|
|
1744
|
+
* @param {*} [options] Override http request option.
|
|
1745
|
+
* @throws {RequiredError}
|
|
1746
|
+
*/
|
|
1747
|
+
moderateReview(project, platformId, reviewId, moderateReviewRequest, options) {
|
|
1748
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1749
|
+
var _a, _b, _c;
|
|
1750
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.moderateReview(project, platformId, reviewId, moderateReviewRequest, options);
|
|
1751
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1752
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.moderateReview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1753
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1754
|
+
});
|
|
1755
|
+
},
|
|
1756
|
+
};
|
|
1757
|
+
};
|
|
1758
|
+
/**
|
|
1759
|
+
* ReviewsApi - factory interface
|
|
1760
|
+
* @export
|
|
1761
|
+
*/
|
|
1762
|
+
export const ReviewsApiFactory = function (configuration, basePath, axios) {
|
|
1763
|
+
const localVarFp = ReviewsApiFp(configuration);
|
|
1764
|
+
return {
|
|
1765
|
+
/**
|
|
1766
|
+
* Export reviews as a CSV file.
|
|
1767
|
+
* @summary Export reviews
|
|
1768
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
1769
|
+
* @param {*} [options] Override http request option.
|
|
1770
|
+
* @throws {RequiredError}
|
|
1771
|
+
*/
|
|
1772
|
+
exportReviews(requestParameters, options) {
|
|
1773
|
+
return localVarFp.exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
1774
|
+
},
|
|
1775
|
+
/**
|
|
1776
|
+
* Get a review left on a platform by a given review ID.
|
|
1777
|
+
* @summary Get review
|
|
1778
|
+
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
1779
|
+
* @param {*} [options] Override http request option.
|
|
1780
|
+
* @throws {RequiredError}
|
|
1781
|
+
*/
|
|
1782
|
+
getReview(requestParameters, options) {
|
|
1783
|
+
return localVarFp.getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(axios, basePath));
|
|
1784
|
+
},
|
|
1785
|
+
/**
|
|
1786
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1787
|
+
* @summary List reviews
|
|
1788
|
+
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
1789
|
+
* @param {*} [options] Override http request option.
|
|
1790
|
+
* @throws {RequiredError}
|
|
1791
|
+
*/
|
|
1792
|
+
listReviews(requestParameters, options) {
|
|
1793
|
+
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));
|
|
1794
|
+
},
|
|
1795
|
+
/**
|
|
1796
|
+
* Moderate a review left on a platform.
|
|
1797
|
+
* @summary Moderate review
|
|
1798
|
+
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
1799
|
+
* @param {*} [options] Override http request option.
|
|
1800
|
+
* @throws {RequiredError}
|
|
1801
|
+
*/
|
|
1802
|
+
moderateReview(requestParameters, options) {
|
|
1803
|
+
return localVarFp.moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(axios, basePath));
|
|
1804
|
+
},
|
|
1805
|
+
};
|
|
1806
|
+
};
|
|
1807
|
+
/**
|
|
1808
|
+
* ReviewsApi - object-oriented interface
|
|
1809
|
+
* @export
|
|
1810
|
+
* @class ReviewsApi
|
|
1811
|
+
* @extends {BaseAPI}
|
|
1812
|
+
*/
|
|
1813
|
+
export class ReviewsApi extends BaseAPI {
|
|
1814
|
+
/**
|
|
1815
|
+
* Export reviews as a CSV file.
|
|
1816
|
+
* @summary Export reviews
|
|
1817
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
1818
|
+
* @param {*} [options] Override http request option.
|
|
1819
|
+
* @throws {RequiredError}
|
|
1820
|
+
* @memberof ReviewsApi
|
|
1821
|
+
*/
|
|
1822
|
+
exportReviews(requestParameters, options) {
|
|
1823
|
+
return ReviewsApiFp(this.configuration).exportReviews(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
1824
|
+
}
|
|
1825
|
+
/**
|
|
1826
|
+
* Get a review left on a platform by a given review ID.
|
|
1827
|
+
* @summary Get review
|
|
1828
|
+
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
1829
|
+
* @param {*} [options] Override http request option.
|
|
1830
|
+
* @throws {RequiredError}
|
|
1831
|
+
* @memberof ReviewsApi
|
|
1832
|
+
*/
|
|
1833
|
+
getReview(requestParameters, options) {
|
|
1834
|
+
return ReviewsApiFp(this.configuration).getReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, options).then((request) => request(this.axios, this.basePath));
|
|
1835
|
+
}
|
|
1836
|
+
/**
|
|
1837
|
+
* List reviews left on projects belonging to this platform, paginated into configurable chunks.
|
|
1838
|
+
* @summary List reviews
|
|
1839
|
+
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
1840
|
+
* @param {*} [options] Override http request option.
|
|
1841
|
+
* @throws {RequiredError}
|
|
1842
|
+
* @memberof ReviewsApi
|
|
1843
|
+
*/
|
|
1844
|
+
listReviews(requestParameters, options) {
|
|
1845
|
+
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));
|
|
1846
|
+
}
|
|
1847
|
+
/**
|
|
1848
|
+
* Moderate a review left on a platform.
|
|
1849
|
+
* @summary Moderate review
|
|
1850
|
+
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
1851
|
+
* @param {*} [options] Override http request option.
|
|
1852
|
+
* @throws {RequiredError}
|
|
1853
|
+
* @memberof ReviewsApi
|
|
1854
|
+
*/
|
|
1855
|
+
moderateReview(requestParameters, options) {
|
|
1856
|
+
return ReviewsApiFp(this.configuration).moderateReview(requestParameters.project, requestParameters.platformId, requestParameters.reviewId, requestParameters.moderateReviewRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1857
|
+
}
|
|
1858
|
+
}
|
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
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/docs/Address.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Address
|
|
2
|
+
|
|
3
|
+
A person\'s address.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**contactName** | **string** | | [default to undefined]
|
|
10
|
+
**company** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**line1** | **string** | First line of the address. | [default to undefined]
|
|
12
|
+
**line2** | **string** | Second line of the address. | [optional] [default to undefined]
|
|
13
|
+
**city** | **string** | City of the address. | [default to undefined]
|
|
14
|
+
**postalCode** | **string** | Postal code of the address. | [optional] [default to undefined]
|
|
15
|
+
**country** | **string** | Country of the address (ISO 3166-1 alpha-2). | [default to undefined]
|
|
16
|
+
**state** | **string** | State of the address. | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { Address } from '@teemill/platform';
|
|
22
|
+
|
|
23
|
+
const instance: Address = {
|
|
24
|
+
contactName,
|
|
25
|
+
company,
|
|
26
|
+
line1,
|
|
27
|
+
line2,
|
|
28
|
+
city,
|
|
29
|
+
postalCode,
|
|
30
|
+
country,
|
|
31
|
+
state,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/ApiError.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ApiError } from '@teemill/platform';
|
|
15
|
+
|
|
16
|
+
const instance: ApiError = {
|
|
17
|
+
code,
|
|
18
|
+
message,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AuthorizeStripe200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**redirect_url** | **string** | The URL to redirect to | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AuthorizeStripe200Response } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: AuthorizeStripe200Response = {
|
|
16
|
+
redirect_url,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ContactInformation
|
|
2
|
+
|
|
3
|
+
Order recipient contact information, used only for courier tracking/updates.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**email** | **string** | | [default to undefined]
|
|
10
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ContactInformation } from '@teemill/platform';
|
|
16
|
+
|
|
17
|
+
const instance: ContactInformation = {
|
|
18
|
+
email,
|
|
19
|
+
phone,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|