@teemill/website 0.20.0 → 0.22.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 +203 -6
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +125 -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 +125 -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 +38 -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/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.22.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -676,6 +676,13 @@ export interface Page {
|
|
|
676
676
|
* @memberof Page
|
|
677
677
|
*/
|
|
678
678
|
'slug'?: string;
|
|
679
|
+
/**
|
|
680
|
+
*
|
|
681
|
+
* @type {boolean}
|
|
682
|
+
* @memberof Page
|
|
683
|
+
* @deprecated
|
|
684
|
+
*/
|
|
685
|
+
'published'?: boolean;
|
|
679
686
|
/**
|
|
680
687
|
*
|
|
681
688
|
* @type {TargetSearchPhraseData}
|
|
@@ -1007,6 +1014,12 @@ export interface Review {
|
|
|
1007
1014
|
* @memberof Review
|
|
1008
1015
|
*/
|
|
1009
1016
|
'text': string;
|
|
1017
|
+
/**
|
|
1018
|
+
*
|
|
1019
|
+
* @type {ReviewProduct}
|
|
1020
|
+
* @memberof Review
|
|
1021
|
+
*/
|
|
1022
|
+
'product'?: ReviewProduct;
|
|
1010
1023
|
/**
|
|
1011
1024
|
*
|
|
1012
1025
|
* @type {ReviewAuthor}
|
|
@@ -1088,6 +1101,25 @@ export interface ReviewImagesInner {
|
|
|
1088
1101
|
*/
|
|
1089
1102
|
'alt'?: string;
|
|
1090
1103
|
}
|
|
1104
|
+
/**
|
|
1105
|
+
* The product that the review is for
|
|
1106
|
+
* @export
|
|
1107
|
+
* @interface ReviewProduct
|
|
1108
|
+
*/
|
|
1109
|
+
export interface ReviewProduct {
|
|
1110
|
+
/**
|
|
1111
|
+
* Unique object identifier
|
|
1112
|
+
* @type {string}
|
|
1113
|
+
* @memberof ReviewProduct
|
|
1114
|
+
*/
|
|
1115
|
+
'id'?: string;
|
|
1116
|
+
/**
|
|
1117
|
+
* The title of the product
|
|
1118
|
+
* @type {string}
|
|
1119
|
+
* @memberof ReviewProduct
|
|
1120
|
+
*/
|
|
1121
|
+
'title'?: string;
|
|
1122
|
+
}
|
|
1091
1123
|
/**
|
|
1092
1124
|
*
|
|
1093
1125
|
* @export
|
|
@@ -1269,6 +1301,12 @@ export interface SeoOptimiseCollectionsRequest {
|
|
|
1269
1301
|
* @memberof SeoOptimiseCollectionsRequest
|
|
1270
1302
|
*/
|
|
1271
1303
|
'ids'?: Array<string>;
|
|
1304
|
+
/**
|
|
1305
|
+
* If provided, only the specified fields will be updated.
|
|
1306
|
+
* @type {Array<string>}
|
|
1307
|
+
* @memberof SeoOptimiseCollectionsRequest
|
|
1308
|
+
*/
|
|
1309
|
+
'fields'?: Array<string>;
|
|
1272
1310
|
}
|
|
1273
1311
|
/**
|
|
1274
1312
|
*
|
|
@@ -1295,6 +1333,12 @@ export interface SeoOptimisePagesRequest {
|
|
|
1295
1333
|
* @memberof SeoOptimisePagesRequest
|
|
1296
1334
|
*/
|
|
1297
1335
|
'ids'?: Array<string>;
|
|
1336
|
+
/**
|
|
1337
|
+
* If provided, only the specified fields will be updated.
|
|
1338
|
+
* @type {Array<string>}
|
|
1339
|
+
* @memberof SeoOptimisePagesRequest
|
|
1340
|
+
*/
|
|
1341
|
+
'fields'?: Array<string>;
|
|
1298
1342
|
}
|
|
1299
1343
|
/**
|
|
1300
1344
|
*
|
|
@@ -4298,6 +4342,16 @@ export declare class PaymentApi extends BaseAPI {
|
|
|
4298
4342
|
* @export
|
|
4299
4343
|
*/
|
|
4300
4344
|
export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4345
|
+
/**
|
|
4346
|
+
* Export reviews as a CSV file.
|
|
4347
|
+
* @summary Export reviews
|
|
4348
|
+
* @param {string} project What project it is
|
|
4349
|
+
* @param {string} [start] Start of date range to filter by
|
|
4350
|
+
* @param {string} [end] End of date range to filter by
|
|
4351
|
+
* @param {*} [options] Override http request option.
|
|
4352
|
+
* @throws {RequiredError}
|
|
4353
|
+
*/
|
|
4354
|
+
exportReviews: (project: string, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4301
4355
|
/**
|
|
4302
4356
|
*
|
|
4303
4357
|
* @summary Get review
|
|
@@ -4315,10 +4369,12 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4315
4369
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4316
4370
|
* @param {string} [search] Search term to filter results
|
|
4317
4371
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4372
|
+
* @param {string} [start] Start of date range to filter by
|
|
4373
|
+
* @param {string} [end] End of date range to filter by
|
|
4318
4374
|
* @param {*} [options] Override http request option.
|
|
4319
4375
|
* @throws {RequiredError}
|
|
4320
4376
|
*/
|
|
4321
|
-
listReviews: (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4377
|
+
listReviews: (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4322
4378
|
/**
|
|
4323
4379
|
*
|
|
4324
4380
|
* @summary Moderate review
|
|
@@ -4335,6 +4391,16 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4335
4391
|
* @export
|
|
4336
4392
|
*/
|
|
4337
4393
|
export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
4394
|
+
/**
|
|
4395
|
+
* Export reviews as a CSV file.
|
|
4396
|
+
* @summary Export reviews
|
|
4397
|
+
* @param {string} project What project it is
|
|
4398
|
+
* @param {string} [start] Start of date range to filter by
|
|
4399
|
+
* @param {string} [end] End of date range to filter by
|
|
4400
|
+
* @param {*} [options] Override http request option.
|
|
4401
|
+
* @throws {RequiredError}
|
|
4402
|
+
*/
|
|
4403
|
+
exportReviews(project: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
4338
4404
|
/**
|
|
4339
4405
|
*
|
|
4340
4406
|
* @summary Get review
|
|
@@ -4352,10 +4418,12 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
|
4352
4418
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4353
4419
|
* @param {string} [search] Search term to filter results
|
|
4354
4420
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4421
|
+
* @param {string} [start] Start of date range to filter by
|
|
4422
|
+
* @param {string} [end] End of date range to filter by
|
|
4355
4423
|
* @param {*} [options] Override http request option.
|
|
4356
4424
|
* @throws {RequiredError}
|
|
4357
4425
|
*/
|
|
4358
|
-
listReviews(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>>;
|
|
4426
|
+
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
4427
|
/**
|
|
4360
4428
|
*
|
|
4361
4429
|
* @summary Moderate review
|
|
@@ -4372,6 +4440,14 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
|
4372
4440
|
* @export
|
|
4373
4441
|
*/
|
|
4374
4442
|
export declare const ReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4443
|
+
/**
|
|
4444
|
+
* Export reviews as a CSV file.
|
|
4445
|
+
* @summary Export reviews
|
|
4446
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
4447
|
+
* @param {*} [options] Override http request option.
|
|
4448
|
+
* @throws {RequiredError}
|
|
4449
|
+
*/
|
|
4450
|
+
exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
4375
4451
|
/**
|
|
4376
4452
|
*
|
|
4377
4453
|
* @summary Get review
|
|
@@ -4397,6 +4473,31 @@ export declare const ReviewsApiFactory: (configuration?: Configuration, basePath
|
|
|
4397
4473
|
*/
|
|
4398
4474
|
moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<Review>;
|
|
4399
4475
|
};
|
|
4476
|
+
/**
|
|
4477
|
+
* Request parameters for exportReviews operation in ReviewsApi.
|
|
4478
|
+
* @export
|
|
4479
|
+
* @interface ReviewsApiExportReviewsRequest
|
|
4480
|
+
*/
|
|
4481
|
+
export interface ReviewsApiExportReviewsRequest {
|
|
4482
|
+
/**
|
|
4483
|
+
* What project it is
|
|
4484
|
+
* @type {string}
|
|
4485
|
+
* @memberof ReviewsApiExportReviews
|
|
4486
|
+
*/
|
|
4487
|
+
readonly project: string;
|
|
4488
|
+
/**
|
|
4489
|
+
* Start of date range to filter by
|
|
4490
|
+
* @type {string}
|
|
4491
|
+
* @memberof ReviewsApiExportReviews
|
|
4492
|
+
*/
|
|
4493
|
+
readonly start?: string;
|
|
4494
|
+
/**
|
|
4495
|
+
* End of date range to filter by
|
|
4496
|
+
* @type {string}
|
|
4497
|
+
* @memberof ReviewsApiExportReviews
|
|
4498
|
+
*/
|
|
4499
|
+
readonly end?: string;
|
|
4500
|
+
}
|
|
4400
4501
|
/**
|
|
4401
4502
|
* Request parameters for getReview operation in ReviewsApi.
|
|
4402
4503
|
* @export
|
|
@@ -4452,6 +4553,18 @@ export interface ReviewsApiListReviewsRequest {
|
|
|
4452
4553
|
* @memberof ReviewsApiListReviews
|
|
4453
4554
|
*/
|
|
4454
4555
|
readonly sortBy?: Array<string>;
|
|
4556
|
+
/**
|
|
4557
|
+
* Start of date range to filter by
|
|
4558
|
+
* @type {string}
|
|
4559
|
+
* @memberof ReviewsApiListReviews
|
|
4560
|
+
*/
|
|
4561
|
+
readonly start?: string;
|
|
4562
|
+
/**
|
|
4563
|
+
* End of date range to filter by
|
|
4564
|
+
* @type {string}
|
|
4565
|
+
* @memberof ReviewsApiListReviews
|
|
4566
|
+
*/
|
|
4567
|
+
readonly end?: string;
|
|
4455
4568
|
}
|
|
4456
4569
|
/**
|
|
4457
4570
|
* Request parameters for moderateReview operation in ReviewsApi.
|
|
@@ -4485,6 +4598,15 @@ export interface ReviewsApiModerateReviewRequest {
|
|
|
4485
4598
|
* @extends {BaseAPI}
|
|
4486
4599
|
*/
|
|
4487
4600
|
export declare class ReviewsApi extends BaseAPI {
|
|
4601
|
+
/**
|
|
4602
|
+
* Export reviews as a CSV file.
|
|
4603
|
+
* @summary Export reviews
|
|
4604
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
4605
|
+
* @param {*} [options] Override http request option.
|
|
4606
|
+
* @throws {RequiredError}
|
|
4607
|
+
* @memberof ReviewsApi
|
|
4608
|
+
*/
|
|
4609
|
+
exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
4488
4610
|
/**
|
|
4489
4611
|
*
|
|
4490
4612
|
* @summary Get review
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Website API
|
|
5
5
|
* Manage your PodOS Website
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.22.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2612,6 +2612,54 @@ export class PaymentApi extends BaseAPI {
|
|
|
2612
2612
|
*/
|
|
2613
2613
|
export const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
2614
2614
|
return {
|
|
2615
|
+
/**
|
|
2616
|
+
* Export reviews as a CSV file.
|
|
2617
|
+
* @summary Export reviews
|
|
2618
|
+
* @param {string} project What project it is
|
|
2619
|
+
* @param {string} [start] Start of date range to filter by
|
|
2620
|
+
* @param {string} [end] End of date range to filter by
|
|
2621
|
+
* @param {*} [options] Override http request option.
|
|
2622
|
+
* @throws {RequiredError}
|
|
2623
|
+
*/
|
|
2624
|
+
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 = {}) {
|
|
2625
|
+
// verify required parameter 'project' is not null or undefined
|
|
2626
|
+
assertParamExists('exportReviews', 'project', project);
|
|
2627
|
+
const localVarPath = `/v1/website/reviews/export`;
|
|
2628
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2629
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2630
|
+
let baseOptions;
|
|
2631
|
+
if (configuration) {
|
|
2632
|
+
baseOptions = configuration.baseOptions;
|
|
2633
|
+
}
|
|
2634
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2635
|
+
const localVarHeaderParameter = {};
|
|
2636
|
+
const localVarQueryParameter = {};
|
|
2637
|
+
// authentication session-oauth required
|
|
2638
|
+
// oauth required
|
|
2639
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
2640
|
+
// authentication api-key required
|
|
2641
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2642
|
+
if (project !== undefined) {
|
|
2643
|
+
localVarQueryParameter['project'] = project;
|
|
2644
|
+
}
|
|
2645
|
+
if (start !== undefined) {
|
|
2646
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
2647
|
+
start.toISOString() :
|
|
2648
|
+
start;
|
|
2649
|
+
}
|
|
2650
|
+
if (end !== undefined) {
|
|
2651
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
2652
|
+
end.toISOString() :
|
|
2653
|
+
end;
|
|
2654
|
+
}
|
|
2655
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2656
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2657
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2658
|
+
return {
|
|
2659
|
+
url: toPathString(localVarUrlObj),
|
|
2660
|
+
options: localVarRequestOptions,
|
|
2661
|
+
};
|
|
2662
|
+
}),
|
|
2615
2663
|
/**
|
|
2616
2664
|
*
|
|
2617
2665
|
* @summary Get review
|
|
@@ -2660,10 +2708,12 @@ export const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
|
2660
2708
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2661
2709
|
* @param {string} [search] Search term to filter results
|
|
2662
2710
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2711
|
+
* @param {string} [start] Start of date range to filter by
|
|
2712
|
+
* @param {string} [end] End of date range to filter by
|
|
2663
2713
|
* @param {*} [options] Override http request option.
|
|
2664
2714
|
* @throws {RequiredError}
|
|
2665
2715
|
*/
|
|
2666
|
-
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 = {}) {
|
|
2716
|
+
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 = {}) {
|
|
2667
2717
|
// verify required parameter 'project' is not null or undefined
|
|
2668
2718
|
assertParamExists('listReviews', 'project', project);
|
|
2669
2719
|
const localVarPath = `/v1/website/reviews`;
|
|
@@ -2696,6 +2746,16 @@ export const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
|
2696
2746
|
if (sortBy) {
|
|
2697
2747
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
2698
2748
|
}
|
|
2749
|
+
if (start !== undefined) {
|
|
2750
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
2751
|
+
start.toISOString() :
|
|
2752
|
+
start;
|
|
2753
|
+
}
|
|
2754
|
+
if (end !== undefined) {
|
|
2755
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
2756
|
+
end.toISOString() :
|
|
2757
|
+
end;
|
|
2758
|
+
}
|
|
2699
2759
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2700
2760
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2701
2761
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -2756,6 +2816,24 @@ export const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
|
2756
2816
|
export const ReviewsApiFp = function (configuration) {
|
|
2757
2817
|
const localVarAxiosParamCreator = ReviewsApiAxiosParamCreator(configuration);
|
|
2758
2818
|
return {
|
|
2819
|
+
/**
|
|
2820
|
+
* Export reviews as a CSV file.
|
|
2821
|
+
* @summary Export reviews
|
|
2822
|
+
* @param {string} project What project it is
|
|
2823
|
+
* @param {string} [start] Start of date range to filter by
|
|
2824
|
+
* @param {string} [end] End of date range to filter by
|
|
2825
|
+
* @param {*} [options] Override http request option.
|
|
2826
|
+
* @throws {RequiredError}
|
|
2827
|
+
*/
|
|
2828
|
+
exportReviews(project, start, end, options) {
|
|
2829
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2830
|
+
var _a, _b, _c;
|
|
2831
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportReviews(project, start, end, options);
|
|
2832
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2833
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.exportReviews']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2834
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2835
|
+
});
|
|
2836
|
+
},
|
|
2759
2837
|
/**
|
|
2760
2838
|
*
|
|
2761
2839
|
* @summary Get review
|
|
@@ -2781,13 +2859,15 @@ export const ReviewsApiFp = function (configuration) {
|
|
|
2781
2859
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2782
2860
|
* @param {string} [search] Search term to filter results
|
|
2783
2861
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2862
|
+
* @param {string} [start] Start of date range to filter by
|
|
2863
|
+
* @param {string} [end] End of date range to filter by
|
|
2784
2864
|
* @param {*} [options] Override http request option.
|
|
2785
2865
|
* @throws {RequiredError}
|
|
2786
2866
|
*/
|
|
2787
|
-
listReviews(project, pageToken, pageSize, search, sortBy, options) {
|
|
2867
|
+
listReviews(project, pageToken, pageSize, search, sortBy, start, end, options) {
|
|
2788
2868
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2789
2869
|
var _a, _b, _c;
|
|
2790
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listReviews(project, pageToken, pageSize, search, sortBy, options);
|
|
2870
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listReviews(project, pageToken, pageSize, search, sortBy, start, end, options);
|
|
2791
2871
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2792
2872
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReviewsApi.listReviews']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2793
2873
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2820,6 +2900,16 @@ export const ReviewsApiFp = function (configuration) {
|
|
|
2820
2900
|
export const ReviewsApiFactory = function (configuration, basePath, axios) {
|
|
2821
2901
|
const localVarFp = ReviewsApiFp(configuration);
|
|
2822
2902
|
return {
|
|
2903
|
+
/**
|
|
2904
|
+
* Export reviews as a CSV file.
|
|
2905
|
+
* @summary Export reviews
|
|
2906
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
2907
|
+
* @param {*} [options] Override http request option.
|
|
2908
|
+
* @throws {RequiredError}
|
|
2909
|
+
*/
|
|
2910
|
+
exportReviews(requestParameters, options) {
|
|
2911
|
+
return localVarFp.exportReviews(requestParameters.project, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
2912
|
+
},
|
|
2823
2913
|
/**
|
|
2824
2914
|
*
|
|
2825
2915
|
* @summary Get review
|
|
@@ -2838,7 +2928,7 @@ export const ReviewsApiFactory = function (configuration, basePath, axios) {
|
|
|
2838
2928
|
* @throws {RequiredError}
|
|
2839
2929
|
*/
|
|
2840
2930
|
listReviews(requestParameters, options) {
|
|
2841
|
-
return localVarFp.listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, options).then((request) => request(axios, basePath));
|
|
2931
|
+
return localVarFp.listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
2842
2932
|
},
|
|
2843
2933
|
/**
|
|
2844
2934
|
*
|
|
@@ -2859,6 +2949,17 @@ export const ReviewsApiFactory = function (configuration, basePath, axios) {
|
|
|
2859
2949
|
* @extends {BaseAPI}
|
|
2860
2950
|
*/
|
|
2861
2951
|
export class ReviewsApi extends BaseAPI {
|
|
2952
|
+
/**
|
|
2953
|
+
* Export reviews as a CSV file.
|
|
2954
|
+
* @summary Export reviews
|
|
2955
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
2956
|
+
* @param {*} [options] Override http request option.
|
|
2957
|
+
* @throws {RequiredError}
|
|
2958
|
+
* @memberof ReviewsApi
|
|
2959
|
+
*/
|
|
2960
|
+
exportReviews(requestParameters, options) {
|
|
2961
|
+
return ReviewsApiFp(this.configuration).exportReviews(requestParameters.project, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
2962
|
+
}
|
|
2862
2963
|
/**
|
|
2863
2964
|
*
|
|
2864
2965
|
* @summary Get review
|
|
@@ -2879,7 +2980,7 @@ export class ReviewsApi extends BaseAPI {
|
|
|
2879
2980
|
* @memberof ReviewsApi
|
|
2880
2981
|
*/
|
|
2881
2982
|
listReviews(requestParameters, options) {
|
|
2882
|
-
return ReviewsApiFp(this.configuration).listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
|
|
2983
|
+
return 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));
|
|
2883
2984
|
}
|
|
2884
2985
|
/**
|
|
2885
2986
|
*
|
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/ApiError.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ApiError } from '@teemill/website';
|
|
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,28 @@
|
|
|
1
|
+
# Application
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique object identifier | [optional] [default to undefined]
|
|
9
|
+
**technology** | **string** | Technology to use for the application. | [default to undefined]
|
|
10
|
+
**placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
|
|
11
|
+
**src** | **string** | Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area. Accepts PNG and JPEG files. | [default to undefined]
|
|
12
|
+
**mockup** | [**ApplicationMockup**](ApplicationMockup.md) | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { Application } from '@teemill/website';
|
|
18
|
+
|
|
19
|
+
const instance: Application = {
|
|
20
|
+
id,
|
|
21
|
+
technology,
|
|
22
|
+
placement,
|
|
23
|
+
src,
|
|
24
|
+
mockup,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[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,22 @@
|
|
|
1
|
+
# ApplicationMockup
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**file** | **string** | Drive image URL. If provided, this will be used as the mockup image for the variant application rather than generating a new one. | [default to undefined]
|
|
9
|
+
**preview** | **string** | Publicly available mockup image URL. This is a preview of the mockup image for the given application. | [optional] [readonly] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ApplicationMockup } from '@teemill/website';
|
|
15
|
+
|
|
16
|
+
const instance: ApplicationMockup = {
|
|
17
|
+
file,
|
|
18
|
+
preview,
|
|
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
|
+
# AttachCrossSellProductsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**products** | **Array<string>** | A list of product IDs to attach as cross-sell products. The order in which they are sent is the order they will be saved in. | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AttachCrossSellProductsRequest } from '@teemill/website';
|
|
14
|
+
|
|
15
|
+
const instance: AttachCrossSellProductsRequest = {
|
|
16
|
+
products,
|
|
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,26 @@
|
|
|
1
|
+
# Attribute
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | Attribute name | [default to undefined]
|
|
9
|
+
**value** | **string** | Attribute value | [default to undefined]
|
|
10
|
+
**thumbnail** | [**AttributeThumbnail**](AttributeThumbnail.md) | | [optional] [default to undefined]
|
|
11
|
+
**tags** | **Array<string>** | Attribute tags | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { Attribute } from '@teemill/website';
|
|
17
|
+
|
|
18
|
+
const instance: Attribute = {
|
|
19
|
+
name,
|
|
20
|
+
value,
|
|
21
|
+
thumbnail,
|
|
22
|
+
tags,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[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
|
+
# AttributeThumbnail
|
|
2
|
+
|
|
3
|
+
Attribute thumbnail, intended for interfaces like storefront colour selector.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**type** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**value** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AttributeThumbnail } from '@teemill/website';
|
|
16
|
+
|
|
17
|
+
const instance: AttributeThumbnail = {
|
|
18
|
+
type,
|
|
19
|
+
value,
|
|
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)
|