@teemill/website 0.20.0 → 0.21.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 +151 -2
- package/api.ts +196 -6
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +118 -3
- package/dist/api.js +107 -6
- 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 +118 -3
- package/dist/esm/api.js +107 -6
- 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/ApiError.md +22 -0
- package/docs/Application.md +28 -0
- package/docs/ApplicationMockup.md +22 -0
- package/docs/AttachCrossSellProductsRequest.md +20 -0
- package/docs/Attribute.md +26 -0
- package/docs/AttributeThumbnail.md +23 -0
- package/docs/AuthorizeStripe200Response.md +20 -0
- package/docs/Blog.md +34 -0
- package/docs/BlogsApi.md +317 -0
- package/docs/BlogsResponse.md +22 -0
- package/docs/Brand.md +20 -0
- package/docs/Collection.md +36 -0
- package/docs/CollectionsApi.md +378 -0
- package/docs/CollectionsResponse.md +22 -0
- package/docs/CreateSearchRedirectRequest.md +22 -0
- package/docs/CrossSellApi.md +128 -0
- package/docs/DefaultApi.md +123 -0
- package/docs/ExportPages202Response.md +20 -0
- package/docs/Footer.md +20 -0
- package/docs/FooterApi.md +123 -0
- package/docs/FooterItem.md +26 -0
- package/docs/Image.md +35 -0
- package/docs/ListRoutesResponse.md +22 -0
- package/docs/Menu.md +20 -0
- package/docs/MenuApi.md +122 -0
- package/docs/MenuItem.md +32 -0
- package/docs/MetaField.md +23 -0
- package/docs/MetaImage.md +23 -0
- package/docs/ModerateReviewRequest.md +20 -0
- package/docs/OptimisationHistoryItem.md +22 -0
- package/docs/Page.md +36 -0
- package/docs/PagesApi.md +378 -0
- package/docs/PagesResponse.md +22 -0
- package/docs/PaymentAccount.md +24 -0
- package/docs/PaymentApi.md +178 -0
- package/docs/Price.md +23 -0
- package/docs/Product.md +66 -0
- package/docs/ProductAdditionalFilesInner.md +22 -0
- package/docs/ProductApplicationSetsInner.md +24 -0
- package/docs/ProductWarehouseProduct.md +22 -0
- package/docs/Review.md +38 -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 +263 -0
- package/docs/ReviewsResponse.md +22 -0
- package/docs/Route.md +28 -0
- package/docs/RoutesApi.md +70 -0
- package/docs/SearchApi.md +319 -0
- package/docs/SearchRedirect.md +26 -0
- package/docs/SearchRedirectsResponse.md +22 -0
- package/docs/SeoMetadata.md +23 -0
- package/docs/SeoOptimiseCollectionsRequest.md +22 -0
- package/docs/SeoOptimisePages202Response.md +20 -0
- package/docs/SeoOptimisePagesRequest.md +22 -0
- package/docs/Stock.md +20 -0
- package/docs/SubmenuInner.md +32 -0
- package/docs/SubmenuInnerImage.md +36 -0
- package/docs/SubmenuInnerImageButton.md +30 -0
- package/docs/SubmenuInnerImageText.md +24 -0
- package/docs/SubmenuItem.md +30 -0
- package/docs/TargetSearchPhraseData.md +22 -0
- package/docs/UpdateBlogRequest.md +30 -0
- package/docs/UpdateBlogsRequest.md +20 -0
- package/docs/UpdateBlogsRequestBlogsInner.md +32 -0
- package/docs/UpdateBlogsRequestBlogsInnerSeoMetadata.md +22 -0
- package/docs/UpdateBrandRequest.md +20 -0
- package/docs/UpdateCollectionRequest.md +32 -0
- package/docs/UpdateCollectionsRequest.md +20 -0
- package/docs/UpdateCollectionsRequestCollectionsInner.md +34 -0
- package/docs/UpdateCollectionsRequestCollectionsInnerSeoMetadata.md +22 -0
- package/docs/UpdateFooterRequest.md +20 -0
- package/docs/UpdateFooterRequestItemsInner.md +24 -0
- package/docs/UpdateMenuRequest.md +20 -0
- package/docs/UpdateMenuRequestItem.md +32 -0
- package/docs/UpdateMenuRequestItemSubmenuInner.md +32 -0
- package/docs/UpdateMenuRequestItemSubmenuInnerImage.md +36 -0
- package/docs/UpdateMenuRequestItemSubmenuInnerImageButton.md +30 -0
- package/docs/UpdateMenuRequestItemSubmenuInnerImageText.md +24 -0
- package/docs/UpdateMenuRequestSubmenuItem.md +30 -0
- package/docs/UpdatePageRequest.md +28 -0
- package/docs/UpdatePagesRequest.md +20 -0
- package/docs/UpdatePagesRequestPagesInner.md +30 -0
- package/docs/UpdateSearchRedirectRequest.md +22 -0
- package/docs/Variant.md +52 -0
- package/docs/VariantProduct.md +22 -0
- package/docs/Video.md +31 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Website API
|
|
3
3
|
* Manage your PodOS Website
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.21.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1007,6 +1007,12 @@ export interface Review {
|
|
|
1007
1007
|
* @memberof Review
|
|
1008
1008
|
*/
|
|
1009
1009
|
'text': string;
|
|
1010
|
+
/**
|
|
1011
|
+
*
|
|
1012
|
+
* @type {ReviewProduct}
|
|
1013
|
+
* @memberof Review
|
|
1014
|
+
*/
|
|
1015
|
+
'product'?: ReviewProduct;
|
|
1010
1016
|
/**
|
|
1011
1017
|
*
|
|
1012
1018
|
* @type {ReviewAuthor}
|
|
@@ -1088,6 +1094,25 @@ export interface ReviewImagesInner {
|
|
|
1088
1094
|
*/
|
|
1089
1095
|
'alt'?: string;
|
|
1090
1096
|
}
|
|
1097
|
+
/**
|
|
1098
|
+
* The product that the review is for
|
|
1099
|
+
* @export
|
|
1100
|
+
* @interface ReviewProduct
|
|
1101
|
+
*/
|
|
1102
|
+
export interface ReviewProduct {
|
|
1103
|
+
/**
|
|
1104
|
+
* Unique object identifier
|
|
1105
|
+
* @type {string}
|
|
1106
|
+
* @memberof ReviewProduct
|
|
1107
|
+
*/
|
|
1108
|
+
'id'?: string;
|
|
1109
|
+
/**
|
|
1110
|
+
* The title of the product
|
|
1111
|
+
* @type {string}
|
|
1112
|
+
* @memberof ReviewProduct
|
|
1113
|
+
*/
|
|
1114
|
+
'title'?: string;
|
|
1115
|
+
}
|
|
1091
1116
|
/**
|
|
1092
1117
|
*
|
|
1093
1118
|
* @export
|
|
@@ -1269,6 +1294,12 @@ export interface SeoOptimiseCollectionsRequest {
|
|
|
1269
1294
|
* @memberof SeoOptimiseCollectionsRequest
|
|
1270
1295
|
*/
|
|
1271
1296
|
'ids'?: Array<string>;
|
|
1297
|
+
/**
|
|
1298
|
+
* If provided, only the specified fields will be updated.
|
|
1299
|
+
* @type {Array<string>}
|
|
1300
|
+
* @memberof SeoOptimiseCollectionsRequest
|
|
1301
|
+
*/
|
|
1302
|
+
'fields'?: Array<string>;
|
|
1272
1303
|
}
|
|
1273
1304
|
/**
|
|
1274
1305
|
*
|
|
@@ -1295,6 +1326,12 @@ export interface SeoOptimisePagesRequest {
|
|
|
1295
1326
|
* @memberof SeoOptimisePagesRequest
|
|
1296
1327
|
*/
|
|
1297
1328
|
'ids'?: Array<string>;
|
|
1329
|
+
/**
|
|
1330
|
+
* If provided, only the specified fields will be updated.
|
|
1331
|
+
* @type {Array<string>}
|
|
1332
|
+
* @memberof SeoOptimisePagesRequest
|
|
1333
|
+
*/
|
|
1334
|
+
'fields'?: Array<string>;
|
|
1298
1335
|
}
|
|
1299
1336
|
/**
|
|
1300
1337
|
*
|
|
@@ -4298,6 +4335,16 @@ export declare class PaymentApi extends BaseAPI {
|
|
|
4298
4335
|
* @export
|
|
4299
4336
|
*/
|
|
4300
4337
|
export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4338
|
+
/**
|
|
4339
|
+
* Export reviews as a CSV file.
|
|
4340
|
+
* @summary Export reviews
|
|
4341
|
+
* @param {string} project What project it is
|
|
4342
|
+
* @param {string} [start] Start of date range to filter by
|
|
4343
|
+
* @param {string} [end] End of date range to filter by
|
|
4344
|
+
* @param {*} [options] Override http request option.
|
|
4345
|
+
* @throws {RequiredError}
|
|
4346
|
+
*/
|
|
4347
|
+
exportReviews: (project: string, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4301
4348
|
/**
|
|
4302
4349
|
*
|
|
4303
4350
|
* @summary Get review
|
|
@@ -4315,10 +4362,12 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4315
4362
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4316
4363
|
* @param {string} [search] Search term to filter results
|
|
4317
4364
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4365
|
+
* @param {string} [start] Start of date range to filter by
|
|
4366
|
+
* @param {string} [end] End of date range to filter by
|
|
4318
4367
|
* @param {*} [options] Override http request option.
|
|
4319
4368
|
* @throws {RequiredError}
|
|
4320
4369
|
*/
|
|
4321
|
-
listReviews: (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4370
|
+
listReviews: (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4322
4371
|
/**
|
|
4323
4372
|
*
|
|
4324
4373
|
* @summary Moderate review
|
|
@@ -4335,6 +4384,16 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4335
4384
|
* @export
|
|
4336
4385
|
*/
|
|
4337
4386
|
export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
4387
|
+
/**
|
|
4388
|
+
* Export reviews as a CSV file.
|
|
4389
|
+
* @summary Export reviews
|
|
4390
|
+
* @param {string} project What project it is
|
|
4391
|
+
* @param {string} [start] Start of date range to filter by
|
|
4392
|
+
* @param {string} [end] End of date range to filter by
|
|
4393
|
+
* @param {*} [options] Override http request option.
|
|
4394
|
+
* @throws {RequiredError}
|
|
4395
|
+
*/
|
|
4396
|
+
exportReviews(project: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
4338
4397
|
/**
|
|
4339
4398
|
*
|
|
4340
4399
|
* @summary Get review
|
|
@@ -4352,10 +4411,12 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
|
4352
4411
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4353
4412
|
* @param {string} [search] Search term to filter results
|
|
4354
4413
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4414
|
+
* @param {string} [start] Start of date range to filter by
|
|
4415
|
+
* @param {string} [end] End of date range to filter by
|
|
4355
4416
|
* @param {*} [options] Override http request option.
|
|
4356
4417
|
* @throws {RequiredError}
|
|
4357
4418
|
*/
|
|
4358
|
-
listReviews(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>>;
|
|
4419
|
+
listReviews(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>>;
|
|
4359
4420
|
/**
|
|
4360
4421
|
*
|
|
4361
4422
|
* @summary Moderate review
|
|
@@ -4372,6 +4433,14 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
|
4372
4433
|
* @export
|
|
4373
4434
|
*/
|
|
4374
4435
|
export declare const ReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4436
|
+
/**
|
|
4437
|
+
* Export reviews as a CSV file.
|
|
4438
|
+
* @summary Export reviews
|
|
4439
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
4440
|
+
* @param {*} [options] Override http request option.
|
|
4441
|
+
* @throws {RequiredError}
|
|
4442
|
+
*/
|
|
4443
|
+
exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
4375
4444
|
/**
|
|
4376
4445
|
*
|
|
4377
4446
|
* @summary Get review
|
|
@@ -4397,6 +4466,31 @@ export declare const ReviewsApiFactory: (configuration?: Configuration, basePath
|
|
|
4397
4466
|
*/
|
|
4398
4467
|
moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review>;
|
|
4399
4468
|
};
|
|
4469
|
+
/**
|
|
4470
|
+
* Request parameters for exportReviews operation in ReviewsApi.
|
|
4471
|
+
* @export
|
|
4472
|
+
* @interface ReviewsApiExportReviewsRequest
|
|
4473
|
+
*/
|
|
4474
|
+
export interface ReviewsApiExportReviewsRequest {
|
|
4475
|
+
/**
|
|
4476
|
+
* What project it is
|
|
4477
|
+
* @type {string}
|
|
4478
|
+
* @memberof ReviewsApiExportReviews
|
|
4479
|
+
*/
|
|
4480
|
+
readonly project: string;
|
|
4481
|
+
/**
|
|
4482
|
+
* Start of date range to filter by
|
|
4483
|
+
* @type {string}
|
|
4484
|
+
* @memberof ReviewsApiExportReviews
|
|
4485
|
+
*/
|
|
4486
|
+
readonly start?: string;
|
|
4487
|
+
/**
|
|
4488
|
+
* End of date range to filter by
|
|
4489
|
+
* @type {string}
|
|
4490
|
+
* @memberof ReviewsApiExportReviews
|
|
4491
|
+
*/
|
|
4492
|
+
readonly end?: string;
|
|
4493
|
+
}
|
|
4400
4494
|
/**
|
|
4401
4495
|
* Request parameters for getReview operation in ReviewsApi.
|
|
4402
4496
|
* @export
|
|
@@ -4452,6 +4546,18 @@ export interface ReviewsApiListReviewsRequest {
|
|
|
4452
4546
|
* @memberof ReviewsApiListReviews
|
|
4453
4547
|
*/
|
|
4454
4548
|
readonly sortBy?: Array<string>;
|
|
4549
|
+
/**
|
|
4550
|
+
* Start of date range to filter by
|
|
4551
|
+
* @type {string}
|
|
4552
|
+
* @memberof ReviewsApiListReviews
|
|
4553
|
+
*/
|
|
4554
|
+
readonly start?: string;
|
|
4555
|
+
/**
|
|
4556
|
+
* End of date range to filter by
|
|
4557
|
+
* @type {string}
|
|
4558
|
+
* @memberof ReviewsApiListReviews
|
|
4559
|
+
*/
|
|
4560
|
+
readonly end?: string;
|
|
4455
4561
|
}
|
|
4456
4562
|
/**
|
|
4457
4563
|
* Request parameters for moderateReview operation in ReviewsApi.
|
|
@@ -4485,6 +4591,15 @@ export interface ReviewsApiModerateReviewRequest {
|
|
|
4485
4591
|
* @extends {BaseAPI}
|
|
4486
4592
|
*/
|
|
4487
4593
|
export declare class ReviewsApi extends BaseAPI {
|
|
4594
|
+
/**
|
|
4595
|
+
* Export reviews as a CSV file.
|
|
4596
|
+
* @summary Export reviews
|
|
4597
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
4598
|
+
* @param {*} [options] Override http request option.
|
|
4599
|
+
* @throws {RequiredError}
|
|
4600
|
+
* @memberof ReviewsApi
|
|
4601
|
+
*/
|
|
4602
|
+
exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
4488
4603
|
/**
|
|
4489
4604
|
*
|
|
4490
4605
|
* @summary Get review
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Website API
|
|
6
6
|
* Manage your PodOS Website
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
8
|
+
* The version of the OpenAPI document: 0.21.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2648,6 +2648,54 @@ exports.PaymentApi = PaymentApi;
|
|
|
2648
2648
|
*/
|
|
2649
2649
|
const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
2650
2650
|
return {
|
|
2651
|
+
/**
|
|
2652
|
+
* Export reviews as a CSV file.
|
|
2653
|
+
* @summary Export reviews
|
|
2654
|
+
* @param {string} project What project it is
|
|
2655
|
+
* @param {string} [start] Start of date range to filter by
|
|
2656
|
+
* @param {string} [end] End of date range to filter by
|
|
2657
|
+
* @param {*} [options] Override http request option.
|
|
2658
|
+
* @throws {RequiredError}
|
|
2659
|
+
*/
|
|
2660
|
+
exportReviews: (project_1, start_1, end_1, ...args_1) => __awaiter(this, [project_1, start_1, end_1, ...args_1], void 0, function* (project, start, end, options = {}) {
|
|
2661
|
+
// verify required parameter 'project' is not null or undefined
|
|
2662
|
+
(0, common_1.assertParamExists)('exportReviews', 'project', project);
|
|
2663
|
+
const localVarPath = `/v1/website/reviews/export`;
|
|
2664
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2665
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2666
|
+
let baseOptions;
|
|
2667
|
+
if (configuration) {
|
|
2668
|
+
baseOptions = configuration.baseOptions;
|
|
2669
|
+
}
|
|
2670
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2671
|
+
const localVarHeaderParameter = {};
|
|
2672
|
+
const localVarQueryParameter = {};
|
|
2673
|
+
// authentication session-oauth required
|
|
2674
|
+
// oauth required
|
|
2675
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
2676
|
+
// authentication api-key required
|
|
2677
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
2678
|
+
if (project !== undefined) {
|
|
2679
|
+
localVarQueryParameter['project'] = project;
|
|
2680
|
+
}
|
|
2681
|
+
if (start !== undefined) {
|
|
2682
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
2683
|
+
start.toISOString() :
|
|
2684
|
+
start;
|
|
2685
|
+
}
|
|
2686
|
+
if (end !== undefined) {
|
|
2687
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
2688
|
+
end.toISOString() :
|
|
2689
|
+
end;
|
|
2690
|
+
}
|
|
2691
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2692
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2693
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2694
|
+
return {
|
|
2695
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2696
|
+
options: localVarRequestOptions,
|
|
2697
|
+
};
|
|
2698
|
+
}),
|
|
2651
2699
|
/**
|
|
2652
2700
|
*
|
|
2653
2701
|
* @summary Get review
|
|
@@ -2696,10 +2744,12 @@ const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
|
2696
2744
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2697
2745
|
* @param {string} [search] Search term to filter results
|
|
2698
2746
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2747
|
+
* @param {string} [start] Start of date range to filter by
|
|
2748
|
+
* @param {string} [end] End of date range to filter by
|
|
2699
2749
|
* @param {*} [options] Override http request option.
|
|
2700
2750
|
* @throws {RequiredError}
|
|
2701
2751
|
*/
|
|
2702
|
-
listReviews: (project_1, pageToken_1, pageSize_1, search_1, sortBy_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, search_1, sortBy_1, ...args_1], void 0, function* (project, pageToken, pageSize, search, sortBy, options = {}) {
|
|
2752
|
+
listReviews: (project_1, pageToken_1, pageSize_1, search_1, sortBy_1, start_1, end_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, search_1, sortBy_1, start_1, end_1, ...args_1], void 0, function* (project, pageToken, pageSize, search, sortBy, start, end, options = {}) {
|
|
2703
2753
|
// verify required parameter 'project' is not null or undefined
|
|
2704
2754
|
(0, common_1.assertParamExists)('listReviews', 'project', project);
|
|
2705
2755
|
const localVarPath = `/v1/website/reviews`;
|
|
@@ -2732,6 +2782,16 @@ const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
|
2732
2782
|
if (sortBy) {
|
|
2733
2783
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
2734
2784
|
}
|
|
2785
|
+
if (start !== undefined) {
|
|
2786
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
2787
|
+
start.toISOString() :
|
|
2788
|
+
start;
|
|
2789
|
+
}
|
|
2790
|
+
if (end !== undefined) {
|
|
2791
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
2792
|
+
end.toISOString() :
|
|
2793
|
+
end;
|
|
2794
|
+
}
|
|
2735
2795
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2736
2796
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2737
2797
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -2793,6 +2853,24 @@ exports.ReviewsApiAxiosParamCreator = ReviewsApiAxiosParamCreator;
|
|
|
2793
2853
|
const ReviewsApiFp = function (configuration) {
|
|
2794
2854
|
const localVarAxiosParamCreator = (0, exports.ReviewsApiAxiosParamCreator)(configuration);
|
|
2795
2855
|
return {
|
|
2856
|
+
/**
|
|
2857
|
+
* Export reviews as a CSV file.
|
|
2858
|
+
* @summary Export reviews
|
|
2859
|
+
* @param {string} project What project it is
|
|
2860
|
+
* @param {string} [start] Start of date range to filter by
|
|
2861
|
+
* @param {string} [end] End of date range to filter by
|
|
2862
|
+
* @param {*} [options] Override http request option.
|
|
2863
|
+
* @throws {RequiredError}
|
|
2864
|
+
*/
|
|
2865
|
+
exportReviews(project, start, end, options) {
|
|
2866
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2867
|
+
var _a, _b, _c;
|
|
2868
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportReviews(project, start, end, options);
|
|
2869
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2870
|
+
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;
|
|
2871
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2872
|
+
});
|
|
2873
|
+
},
|
|
2796
2874
|
/**
|
|
2797
2875
|
*
|
|
2798
2876
|
* @summary Get review
|
|
@@ -2818,13 +2896,15 @@ const ReviewsApiFp = function (configuration) {
|
|
|
2818
2896
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2819
2897
|
* @param {string} [search] Search term to filter results
|
|
2820
2898
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2899
|
+
* @param {string} [start] Start of date range to filter by
|
|
2900
|
+
* @param {string} [end] End of date range to filter by
|
|
2821
2901
|
* @param {*} [options] Override http request option.
|
|
2822
2902
|
* @throws {RequiredError}
|
|
2823
2903
|
*/
|
|
2824
|
-
listReviews(project, pageToken, pageSize, search, sortBy, options) {
|
|
2904
|
+
listReviews(project, pageToken, pageSize, search, sortBy, start, end, options) {
|
|
2825
2905
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2826
2906
|
var _a, _b, _c;
|
|
2827
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listReviews(project, pageToken, pageSize, search, sortBy, options);
|
|
2907
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listReviews(project, pageToken, pageSize, search, sortBy, start, end, options);
|
|
2828
2908
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2829
2909
|
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;
|
|
2830
2910
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2858,6 +2938,16 @@ exports.ReviewsApiFp = ReviewsApiFp;
|
|
|
2858
2938
|
const ReviewsApiFactory = function (configuration, basePath, axios) {
|
|
2859
2939
|
const localVarFp = (0, exports.ReviewsApiFp)(configuration);
|
|
2860
2940
|
return {
|
|
2941
|
+
/**
|
|
2942
|
+
* Export reviews as a CSV file.
|
|
2943
|
+
* @summary Export reviews
|
|
2944
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
2945
|
+
* @param {*} [options] Override http request option.
|
|
2946
|
+
* @throws {RequiredError}
|
|
2947
|
+
*/
|
|
2948
|
+
exportReviews(requestParameters, options) {
|
|
2949
|
+
return localVarFp.exportReviews(requestParameters.project, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
2950
|
+
},
|
|
2861
2951
|
/**
|
|
2862
2952
|
*
|
|
2863
2953
|
* @summary Get review
|
|
@@ -2876,7 +2966,7 @@ const ReviewsApiFactory = function (configuration, basePath, axios) {
|
|
|
2876
2966
|
* @throws {RequiredError}
|
|
2877
2967
|
*/
|
|
2878
2968
|
listReviews(requestParameters, options) {
|
|
2879
|
-
return localVarFp.listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, options).then((request) => request(axios, basePath));
|
|
2969
|
+
return localVarFp.listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
2880
2970
|
},
|
|
2881
2971
|
/**
|
|
2882
2972
|
*
|
|
@@ -2898,6 +2988,17 @@ exports.ReviewsApiFactory = ReviewsApiFactory;
|
|
|
2898
2988
|
* @extends {BaseAPI}
|
|
2899
2989
|
*/
|
|
2900
2990
|
class ReviewsApi extends base_1.BaseAPI {
|
|
2991
|
+
/**
|
|
2992
|
+
* Export reviews as a CSV file.
|
|
2993
|
+
* @summary Export reviews
|
|
2994
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
2995
|
+
* @param {*} [options] Override http request option.
|
|
2996
|
+
* @throws {RequiredError}
|
|
2997
|
+
* @memberof ReviewsApi
|
|
2998
|
+
*/
|
|
2999
|
+
exportReviews(requestParameters, options) {
|
|
3000
|
+
return (0, exports.ReviewsApiFp)(this.configuration).exportReviews(requestParameters.project, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
3001
|
+
}
|
|
2901
3002
|
/**
|
|
2902
3003
|
*
|
|
2903
3004
|
* @summary Get review
|
|
@@ -2918,7 +3019,7 @@ class ReviewsApi extends base_1.BaseAPI {
|
|
|
2918
3019
|
* @memberof ReviewsApi
|
|
2919
3020
|
*/
|
|
2920
3021
|
listReviews(requestParameters, options) {
|
|
2921
|
-
return (0, exports.ReviewsApiFp)(this.configuration).listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
|
|
3022
|
+
return (0, exports.ReviewsApiFp)(this.configuration).listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
2922
3023
|
}
|
|
2923
3024
|
/**
|
|
2924
3025
|
*
|
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
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Website API
|
|
3
3
|
* Manage your PodOS Website
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.21.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1007,6 +1007,12 @@ export interface Review {
|
|
|
1007
1007
|
* @memberof Review
|
|
1008
1008
|
*/
|
|
1009
1009
|
'text': string;
|
|
1010
|
+
/**
|
|
1011
|
+
*
|
|
1012
|
+
* @type {ReviewProduct}
|
|
1013
|
+
* @memberof Review
|
|
1014
|
+
*/
|
|
1015
|
+
'product'?: ReviewProduct;
|
|
1010
1016
|
/**
|
|
1011
1017
|
*
|
|
1012
1018
|
* @type {ReviewAuthor}
|
|
@@ -1088,6 +1094,25 @@ export interface ReviewImagesInner {
|
|
|
1088
1094
|
*/
|
|
1089
1095
|
'alt'?: string;
|
|
1090
1096
|
}
|
|
1097
|
+
/**
|
|
1098
|
+
* The product that the review is for
|
|
1099
|
+
* @export
|
|
1100
|
+
* @interface ReviewProduct
|
|
1101
|
+
*/
|
|
1102
|
+
export interface ReviewProduct {
|
|
1103
|
+
/**
|
|
1104
|
+
* Unique object identifier
|
|
1105
|
+
* @type {string}
|
|
1106
|
+
* @memberof ReviewProduct
|
|
1107
|
+
*/
|
|
1108
|
+
'id'?: string;
|
|
1109
|
+
/**
|
|
1110
|
+
* The title of the product
|
|
1111
|
+
* @type {string}
|
|
1112
|
+
* @memberof ReviewProduct
|
|
1113
|
+
*/
|
|
1114
|
+
'title'?: string;
|
|
1115
|
+
}
|
|
1091
1116
|
/**
|
|
1092
1117
|
*
|
|
1093
1118
|
* @export
|
|
@@ -1269,6 +1294,12 @@ export interface SeoOptimiseCollectionsRequest {
|
|
|
1269
1294
|
* @memberof SeoOptimiseCollectionsRequest
|
|
1270
1295
|
*/
|
|
1271
1296
|
'ids'?: Array<string>;
|
|
1297
|
+
/**
|
|
1298
|
+
* If provided, only the specified fields will be updated.
|
|
1299
|
+
* @type {Array<string>}
|
|
1300
|
+
* @memberof SeoOptimiseCollectionsRequest
|
|
1301
|
+
*/
|
|
1302
|
+
'fields'?: Array<string>;
|
|
1272
1303
|
}
|
|
1273
1304
|
/**
|
|
1274
1305
|
*
|
|
@@ -1295,6 +1326,12 @@ export interface SeoOptimisePagesRequest {
|
|
|
1295
1326
|
* @memberof SeoOptimisePagesRequest
|
|
1296
1327
|
*/
|
|
1297
1328
|
'ids'?: Array<string>;
|
|
1329
|
+
/**
|
|
1330
|
+
* If provided, only the specified fields will be updated.
|
|
1331
|
+
* @type {Array<string>}
|
|
1332
|
+
* @memberof SeoOptimisePagesRequest
|
|
1333
|
+
*/
|
|
1334
|
+
'fields'?: Array<string>;
|
|
1298
1335
|
}
|
|
1299
1336
|
/**
|
|
1300
1337
|
*
|
|
@@ -4298,6 +4335,16 @@ export declare class PaymentApi extends BaseAPI {
|
|
|
4298
4335
|
* @export
|
|
4299
4336
|
*/
|
|
4300
4337
|
export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4338
|
+
/**
|
|
4339
|
+
* Export reviews as a CSV file.
|
|
4340
|
+
* @summary Export reviews
|
|
4341
|
+
* @param {string} project What project it is
|
|
4342
|
+
* @param {string} [start] Start of date range to filter by
|
|
4343
|
+
* @param {string} [end] End of date range to filter by
|
|
4344
|
+
* @param {*} [options] Override http request option.
|
|
4345
|
+
* @throws {RequiredError}
|
|
4346
|
+
*/
|
|
4347
|
+
exportReviews: (project: string, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4301
4348
|
/**
|
|
4302
4349
|
*
|
|
4303
4350
|
* @summary Get review
|
|
@@ -4315,10 +4362,12 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4315
4362
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4316
4363
|
* @param {string} [search] Search term to filter results
|
|
4317
4364
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4365
|
+
* @param {string} [start] Start of date range to filter by
|
|
4366
|
+
* @param {string} [end] End of date range to filter by
|
|
4318
4367
|
* @param {*} [options] Override http request option.
|
|
4319
4368
|
* @throws {RequiredError}
|
|
4320
4369
|
*/
|
|
4321
|
-
listReviews: (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4370
|
+
listReviews: (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4322
4371
|
/**
|
|
4323
4372
|
*
|
|
4324
4373
|
* @summary Moderate review
|
|
@@ -4335,6 +4384,16 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4335
4384
|
* @export
|
|
4336
4385
|
*/
|
|
4337
4386
|
export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
4387
|
+
/**
|
|
4388
|
+
* Export reviews as a CSV file.
|
|
4389
|
+
* @summary Export reviews
|
|
4390
|
+
* @param {string} project What project it is
|
|
4391
|
+
* @param {string} [start] Start of date range to filter by
|
|
4392
|
+
* @param {string} [end] End of date range to filter by
|
|
4393
|
+
* @param {*} [options] Override http request option.
|
|
4394
|
+
* @throws {RequiredError}
|
|
4395
|
+
*/
|
|
4396
|
+
exportReviews(project: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
4338
4397
|
/**
|
|
4339
4398
|
*
|
|
4340
4399
|
* @summary Get review
|
|
@@ -4352,10 +4411,12 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
|
4352
4411
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4353
4412
|
* @param {string} [search] Search term to filter results
|
|
4354
4413
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4414
|
+
* @param {string} [start] Start of date range to filter by
|
|
4415
|
+
* @param {string} [end] End of date range to filter by
|
|
4355
4416
|
* @param {*} [options] Override http request option.
|
|
4356
4417
|
* @throws {RequiredError}
|
|
4357
4418
|
*/
|
|
4358
|
-
listReviews(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>>;
|
|
4419
|
+
listReviews(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>>;
|
|
4359
4420
|
/**
|
|
4360
4421
|
*
|
|
4361
4422
|
* @summary Moderate review
|
|
@@ -4372,6 +4433,14 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
|
4372
4433
|
* @export
|
|
4373
4434
|
*/
|
|
4374
4435
|
export declare const ReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4436
|
+
/**
|
|
4437
|
+
* Export reviews as a CSV file.
|
|
4438
|
+
* @summary Export reviews
|
|
4439
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
4440
|
+
* @param {*} [options] Override http request option.
|
|
4441
|
+
* @throws {RequiredError}
|
|
4442
|
+
*/
|
|
4443
|
+
exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
4375
4444
|
/**
|
|
4376
4445
|
*
|
|
4377
4446
|
* @summary Get review
|
|
@@ -4397,6 +4466,31 @@ export declare const ReviewsApiFactory: (configuration?: Configuration, basePath
|
|
|
4397
4466
|
*/
|
|
4398
4467
|
moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review>;
|
|
4399
4468
|
};
|
|
4469
|
+
/**
|
|
4470
|
+
* Request parameters for exportReviews operation in ReviewsApi.
|
|
4471
|
+
* @export
|
|
4472
|
+
* @interface ReviewsApiExportReviewsRequest
|
|
4473
|
+
*/
|
|
4474
|
+
export interface ReviewsApiExportReviewsRequest {
|
|
4475
|
+
/**
|
|
4476
|
+
* What project it is
|
|
4477
|
+
* @type {string}
|
|
4478
|
+
* @memberof ReviewsApiExportReviews
|
|
4479
|
+
*/
|
|
4480
|
+
readonly project: string;
|
|
4481
|
+
/**
|
|
4482
|
+
* Start of date range to filter by
|
|
4483
|
+
* @type {string}
|
|
4484
|
+
* @memberof ReviewsApiExportReviews
|
|
4485
|
+
*/
|
|
4486
|
+
readonly start?: string;
|
|
4487
|
+
/**
|
|
4488
|
+
* End of date range to filter by
|
|
4489
|
+
* @type {string}
|
|
4490
|
+
* @memberof ReviewsApiExportReviews
|
|
4491
|
+
*/
|
|
4492
|
+
readonly end?: string;
|
|
4493
|
+
}
|
|
4400
4494
|
/**
|
|
4401
4495
|
* Request parameters for getReview operation in ReviewsApi.
|
|
4402
4496
|
* @export
|
|
@@ -4452,6 +4546,18 @@ export interface ReviewsApiListReviewsRequest {
|
|
|
4452
4546
|
* @memberof ReviewsApiListReviews
|
|
4453
4547
|
*/
|
|
4454
4548
|
readonly sortBy?: Array<string>;
|
|
4549
|
+
/**
|
|
4550
|
+
* Start of date range to filter by
|
|
4551
|
+
* @type {string}
|
|
4552
|
+
* @memberof ReviewsApiListReviews
|
|
4553
|
+
*/
|
|
4554
|
+
readonly start?: string;
|
|
4555
|
+
/**
|
|
4556
|
+
* End of date range to filter by
|
|
4557
|
+
* @type {string}
|
|
4558
|
+
* @memberof ReviewsApiListReviews
|
|
4559
|
+
*/
|
|
4560
|
+
readonly end?: string;
|
|
4455
4561
|
}
|
|
4456
4562
|
/**
|
|
4457
4563
|
* Request parameters for moderateReview operation in ReviewsApi.
|
|
@@ -4485,6 +4591,15 @@ export interface ReviewsApiModerateReviewRequest {
|
|
|
4485
4591
|
* @extends {BaseAPI}
|
|
4486
4592
|
*/
|
|
4487
4593
|
export declare class ReviewsApi extends BaseAPI {
|
|
4594
|
+
/**
|
|
4595
|
+
* Export reviews as a CSV file.
|
|
4596
|
+
* @summary Export reviews
|
|
4597
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
4598
|
+
* @param {*} [options] Override http request option.
|
|
4599
|
+
* @throws {RequiredError}
|
|
4600
|
+
* @memberof ReviewsApi
|
|
4601
|
+
*/
|
|
4602
|
+
exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
4488
4603
|
/**
|
|
4489
4604
|
*
|
|
4490
4605
|
* @summary Get review
|