@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/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/website@0.
|
|
1
|
+
## @teemill/website@0.22.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/website@0.
|
|
39
|
+
npm install @teemill/website@0.22.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -44,3 +44,152 @@ _unPublished (not recommended):_
|
|
|
44
44
|
```
|
|
45
45
|
npm install PATH_TO_GENERATED_PACKAGE --save
|
|
46
46
|
```
|
|
47
|
+
|
|
48
|
+
### Documentation for API Endpoints
|
|
49
|
+
|
|
50
|
+
All URIs are relative to *https://api.localhost:8080*
|
|
51
|
+
|
|
52
|
+
Class | Method | HTTP request | Description
|
|
53
|
+
------------ | ------------- | ------------- | -------------
|
|
54
|
+
*BlogsApi* | [**exportBlogs**](docs/BlogsApi.md#exportblogs) | **GET** /v1/website/blogs/export | Export blogs
|
|
55
|
+
*BlogsApi* | [**getBlog**](docs/BlogsApi.md#getblog) | **GET** /v1/website/blogs/{blogId} | Get website blog post
|
|
56
|
+
*BlogsApi* | [**listBlogs**](docs/BlogsApi.md#listblogs) | **GET** /v1/website/blogs | List website blog posts
|
|
57
|
+
*BlogsApi* | [**updateBlog**](docs/BlogsApi.md#updateblog) | **PATCH** /v1/website/blogs/{blogId} | Update website blog post
|
|
58
|
+
*BlogsApi* | [**updateBlogs**](docs/BlogsApi.md#updateblogs) | **PATCH** /v1/website/blogs | Update website blog posts
|
|
59
|
+
*CollectionsApi* | [**exportCollections**](docs/CollectionsApi.md#exportcollections) | **GET** /v1/website/collections/export | Export collections
|
|
60
|
+
*CollectionsApi* | [**getCollection**](docs/CollectionsApi.md#getcollection) | **GET** /v1/website/collections/{collectionId} | Get website collection
|
|
61
|
+
*CollectionsApi* | [**listCollections**](docs/CollectionsApi.md#listcollections) | **GET** /v1/website/collections | List website collections
|
|
62
|
+
*CollectionsApi* | [**seoOptimiseCollections**](docs/CollectionsApi.md#seooptimisecollections) | **POST** /v1/website/collections/ai-seo-optimise | AI SEO optimise collections
|
|
63
|
+
*CollectionsApi* | [**updateCollection**](docs/CollectionsApi.md#updatecollection) | **PATCH** /v1/website/collections/{collectionId} | Update website collection
|
|
64
|
+
*CollectionsApi* | [**updateCollections**](docs/CollectionsApi.md#updatecollections) | **PATCH** /v1/website/collections | Update website collections
|
|
65
|
+
*CrossSellApi* | [**attachCrossSellProducts**](docs/CrossSellApi.md#attachcrosssellproducts) | **PUT** /v1/website/products/{productId}/cross-sell/products | Attach cross-sell products
|
|
66
|
+
*CrossSellApi* | [**getCrossSellProducts**](docs/CrossSellApi.md#getcrosssellproducts) | **GET** /v1/website/products/{productId}/cross-sell/products | Get cross-sell products linked to a product
|
|
67
|
+
*DefaultApi* | [**getBrand**](docs/DefaultApi.md#getbrand) | **GET** /v1/website/brand | Get brand
|
|
68
|
+
*DefaultApi* | [**updateBrand**](docs/DefaultApi.md#updatebrand) | **PATCH** /v1/website/brand | Update brand
|
|
69
|
+
*FooterApi* | [**getFooter**](docs/FooterApi.md#getfooter) | **GET** /v1/website/footer | Get footer
|
|
70
|
+
*FooterApi* | [**updateFooter**](docs/FooterApi.md#updatefooter) | **PUT** /v1/website/footer | Update footer
|
|
71
|
+
*MenuApi* | [**getMenu**](docs/MenuApi.md#getmenu) | **GET** /v1/website/menu | Get menu
|
|
72
|
+
*MenuApi* | [**updateMenu**](docs/MenuApi.md#updatemenu) | **PUT** /v1/website/menu | Update menu
|
|
73
|
+
*PagesApi* | [**exportPages**](docs/PagesApi.md#exportpages) | **GET** /v1/website/pages/export | Export pages
|
|
74
|
+
*PagesApi* | [**getPage**](docs/PagesApi.md#getpage) | **GET** /v1/website/pages/{pageId} | Get website page
|
|
75
|
+
*PagesApi* | [**listPages**](docs/PagesApi.md#listpages) | **GET** /v1/website/pages | List website pages
|
|
76
|
+
*PagesApi* | [**seoOptimisePages**](docs/PagesApi.md#seooptimisepages) | **POST** /v1/website/pages/ai-seo-optimise | AI SEO optimise pages
|
|
77
|
+
*PagesApi* | [**updatePage**](docs/PagesApi.md#updatepage) | **PATCH** /v1/website/pages/{pageId} | Update website page
|
|
78
|
+
*PagesApi* | [**updatePages**](docs/PagesApi.md#updatepages) | **PATCH** /v1/website/pages | Update website pages
|
|
79
|
+
*PaymentApi* | [**authorizeStripe**](docs/PaymentApi.md#authorizestripe) | **GET** /v1/website/payment/stripe/authorize | Authorize Stripe
|
|
80
|
+
*PaymentApi* | [**deauthorizeStripe**](docs/PaymentApi.md#deauthorizestripe) | **DELETE** /v1/website/payment/stripe/deauthorize | Deauthorize Stripe
|
|
81
|
+
*PaymentApi* | [**getStripePaymentAccount**](docs/PaymentApi.md#getstripepaymentaccount) | **GET** /v1/website/payment/stripe | Get Stripe Payment Account
|
|
82
|
+
*ReviewsApi* | [**exportReviews**](docs/ReviewsApi.md#exportreviews) | **GET** /v1/website/reviews/export | Export reviews
|
|
83
|
+
*ReviewsApi* | [**getReview**](docs/ReviewsApi.md#getreview) | **GET** /v1/website/reviews/{reviewId} | Get review
|
|
84
|
+
*ReviewsApi* | [**listReviews**](docs/ReviewsApi.md#listreviews) | **GET** /v1/website/reviews | List Reviews
|
|
85
|
+
*ReviewsApi* | [**moderateReview**](docs/ReviewsApi.md#moderatereview) | **PATCH** /v1/website/reviews/{reviewId}/moderate | Moderate review
|
|
86
|
+
*RoutesApi* | [**listRoutes**](docs/RoutesApi.md#listroutes) | **GET** /v1/website/routes | List routes
|
|
87
|
+
*SearchApi* | [**createSearchRedirect**](docs/SearchApi.md#createsearchredirect) | **POST** /v1/website/search/redirects | Create search redirect
|
|
88
|
+
*SearchApi* | [**deleteSearchRedirect**](docs/SearchApi.md#deletesearchredirect) | **DELETE** /v1/website/search/redirects/{redirectId} | Delete search redirect
|
|
89
|
+
*SearchApi* | [**getSearchRedirect**](docs/SearchApi.md#getsearchredirect) | **GET** /v1/website/search/redirects/{redirectId} | Get search redirect
|
|
90
|
+
*SearchApi* | [**listSearchRedirects**](docs/SearchApi.md#listsearchredirects) | **GET** /v1/website/search/redirects | List search redirects
|
|
91
|
+
*SearchApi* | [**updateSearchRedirect**](docs/SearchApi.md#updatesearchredirect) | **PATCH** /v1/website/search/redirects/{redirectId} | Update search redirect
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
### Documentation For Models
|
|
95
|
+
|
|
96
|
+
- [ApiError](docs/ApiError.md)
|
|
97
|
+
- [Application](docs/Application.md)
|
|
98
|
+
- [ApplicationMockup](docs/ApplicationMockup.md)
|
|
99
|
+
- [AttachCrossSellProductsRequest](docs/AttachCrossSellProductsRequest.md)
|
|
100
|
+
- [Attribute](docs/Attribute.md)
|
|
101
|
+
- [AttributeThumbnail](docs/AttributeThumbnail.md)
|
|
102
|
+
- [AuthorizeStripe200Response](docs/AuthorizeStripe200Response.md)
|
|
103
|
+
- [Blog](docs/Blog.md)
|
|
104
|
+
- [BlogsResponse](docs/BlogsResponse.md)
|
|
105
|
+
- [Brand](docs/Brand.md)
|
|
106
|
+
- [Collection](docs/Collection.md)
|
|
107
|
+
- [CollectionsResponse](docs/CollectionsResponse.md)
|
|
108
|
+
- [CreateSearchRedirectRequest](docs/CreateSearchRedirectRequest.md)
|
|
109
|
+
- [ExportPages202Response](docs/ExportPages202Response.md)
|
|
110
|
+
- [Footer](docs/Footer.md)
|
|
111
|
+
- [FooterItem](docs/FooterItem.md)
|
|
112
|
+
- [Image](docs/Image.md)
|
|
113
|
+
- [ListRoutesResponse](docs/ListRoutesResponse.md)
|
|
114
|
+
- [Menu](docs/Menu.md)
|
|
115
|
+
- [MenuItem](docs/MenuItem.md)
|
|
116
|
+
- [MetaField](docs/MetaField.md)
|
|
117
|
+
- [MetaImage](docs/MetaImage.md)
|
|
118
|
+
- [ModerateReviewRequest](docs/ModerateReviewRequest.md)
|
|
119
|
+
- [OptimisationHistoryItem](docs/OptimisationHistoryItem.md)
|
|
120
|
+
- [Page](docs/Page.md)
|
|
121
|
+
- [PagesResponse](docs/PagesResponse.md)
|
|
122
|
+
- [PaymentAccount](docs/PaymentAccount.md)
|
|
123
|
+
- [Price](docs/Price.md)
|
|
124
|
+
- [Product](docs/Product.md)
|
|
125
|
+
- [ProductAdditionalFilesInner](docs/ProductAdditionalFilesInner.md)
|
|
126
|
+
- [ProductApplicationSetsInner](docs/ProductApplicationSetsInner.md)
|
|
127
|
+
- [ProductWarehouseProduct](docs/ProductWarehouseProduct.md)
|
|
128
|
+
- [Review](docs/Review.md)
|
|
129
|
+
- [ReviewAuthor](docs/ReviewAuthor.md)
|
|
130
|
+
- [ReviewImagesInner](docs/ReviewImagesInner.md)
|
|
131
|
+
- [ReviewProduct](docs/ReviewProduct.md)
|
|
132
|
+
- [ReviewReply](docs/ReviewReply.md)
|
|
133
|
+
- [ReviewReplyAuthor](docs/ReviewReplyAuthor.md)
|
|
134
|
+
- [ReviewsResponse](docs/ReviewsResponse.md)
|
|
135
|
+
- [Route](docs/Route.md)
|
|
136
|
+
- [SearchRedirect](docs/SearchRedirect.md)
|
|
137
|
+
- [SearchRedirectsResponse](docs/SearchRedirectsResponse.md)
|
|
138
|
+
- [SeoMetadata](docs/SeoMetadata.md)
|
|
139
|
+
- [SeoOptimiseCollectionsRequest](docs/SeoOptimiseCollectionsRequest.md)
|
|
140
|
+
- [SeoOptimisePages202Response](docs/SeoOptimisePages202Response.md)
|
|
141
|
+
- [SeoOptimisePagesRequest](docs/SeoOptimisePagesRequest.md)
|
|
142
|
+
- [Stock](docs/Stock.md)
|
|
143
|
+
- [SubmenuInner](docs/SubmenuInner.md)
|
|
144
|
+
- [SubmenuInnerImage](docs/SubmenuInnerImage.md)
|
|
145
|
+
- [SubmenuInnerImageButton](docs/SubmenuInnerImageButton.md)
|
|
146
|
+
- [SubmenuInnerImageText](docs/SubmenuInnerImageText.md)
|
|
147
|
+
- [SubmenuItem](docs/SubmenuItem.md)
|
|
148
|
+
- [TargetSearchPhraseData](docs/TargetSearchPhraseData.md)
|
|
149
|
+
- [UpdateBlogRequest](docs/UpdateBlogRequest.md)
|
|
150
|
+
- [UpdateBlogsRequest](docs/UpdateBlogsRequest.md)
|
|
151
|
+
- [UpdateBlogsRequestBlogsInner](docs/UpdateBlogsRequestBlogsInner.md)
|
|
152
|
+
- [UpdateBlogsRequestBlogsInnerSeoMetadata](docs/UpdateBlogsRequestBlogsInnerSeoMetadata.md)
|
|
153
|
+
- [UpdateBrandRequest](docs/UpdateBrandRequest.md)
|
|
154
|
+
- [UpdateCollectionRequest](docs/UpdateCollectionRequest.md)
|
|
155
|
+
- [UpdateCollectionsRequest](docs/UpdateCollectionsRequest.md)
|
|
156
|
+
- [UpdateCollectionsRequestCollectionsInner](docs/UpdateCollectionsRequestCollectionsInner.md)
|
|
157
|
+
- [UpdateCollectionsRequestCollectionsInnerSeoMetadata](docs/UpdateCollectionsRequestCollectionsInnerSeoMetadata.md)
|
|
158
|
+
- [UpdateFooterRequest](docs/UpdateFooterRequest.md)
|
|
159
|
+
- [UpdateFooterRequestItemsInner](docs/UpdateFooterRequestItemsInner.md)
|
|
160
|
+
- [UpdateMenuRequest](docs/UpdateMenuRequest.md)
|
|
161
|
+
- [UpdateMenuRequestItem](docs/UpdateMenuRequestItem.md)
|
|
162
|
+
- [UpdateMenuRequestItemSubmenuInner](docs/UpdateMenuRequestItemSubmenuInner.md)
|
|
163
|
+
- [UpdateMenuRequestItemSubmenuInnerImage](docs/UpdateMenuRequestItemSubmenuInnerImage.md)
|
|
164
|
+
- [UpdateMenuRequestItemSubmenuInnerImageButton](docs/UpdateMenuRequestItemSubmenuInnerImageButton.md)
|
|
165
|
+
- [UpdateMenuRequestItemSubmenuInnerImageText](docs/UpdateMenuRequestItemSubmenuInnerImageText.md)
|
|
166
|
+
- [UpdateMenuRequestSubmenuItem](docs/UpdateMenuRequestSubmenuItem.md)
|
|
167
|
+
- [UpdatePageRequest](docs/UpdatePageRequest.md)
|
|
168
|
+
- [UpdatePagesRequest](docs/UpdatePagesRequest.md)
|
|
169
|
+
- [UpdatePagesRequestPagesInner](docs/UpdatePagesRequestPagesInner.md)
|
|
170
|
+
- [UpdateSearchRedirectRequest](docs/UpdateSearchRedirectRequest.md)
|
|
171
|
+
- [Variant](docs/Variant.md)
|
|
172
|
+
- [VariantProduct](docs/VariantProduct.md)
|
|
173
|
+
- [Video](docs/Video.md)
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<a id="documentation-for-authorization"></a>
|
|
177
|
+
## Documentation For Authorization
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
Authentication schemes defined for the API:
|
|
181
|
+
<a id="api-key"></a>
|
|
182
|
+
### api-key
|
|
183
|
+
|
|
184
|
+
- **Type**: API key
|
|
185
|
+
- **API key parameter name**: Authorization
|
|
186
|
+
- **Location**: HTTP header
|
|
187
|
+
|
|
188
|
+
<a id="session-oauth"></a>
|
|
189
|
+
### session-oauth
|
|
190
|
+
|
|
191
|
+
- **Type**: OAuth
|
|
192
|
+
- **Flow**: password
|
|
193
|
+
- **Authorization URL**:
|
|
194
|
+
- **Scopes**: N/A
|
|
195
|
+
|
package/api.ts
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).
|
|
@@ -693,6 +693,13 @@ export interface Page {
|
|
|
693
693
|
* @memberof Page
|
|
694
694
|
*/
|
|
695
695
|
'slug'?: string;
|
|
696
|
+
/**
|
|
697
|
+
*
|
|
698
|
+
* @type {boolean}
|
|
699
|
+
* @memberof Page
|
|
700
|
+
* @deprecated
|
|
701
|
+
*/
|
|
702
|
+
'published'?: boolean;
|
|
696
703
|
/**
|
|
697
704
|
*
|
|
698
705
|
* @type {TargetSearchPhraseData}
|
|
@@ -1028,6 +1035,12 @@ export interface Review {
|
|
|
1028
1035
|
* @memberof Review
|
|
1029
1036
|
*/
|
|
1030
1037
|
'text': string;
|
|
1038
|
+
/**
|
|
1039
|
+
*
|
|
1040
|
+
* @type {ReviewProduct}
|
|
1041
|
+
* @memberof Review
|
|
1042
|
+
*/
|
|
1043
|
+
'product'?: ReviewProduct;
|
|
1031
1044
|
/**
|
|
1032
1045
|
*
|
|
1033
1046
|
* @type {ReviewAuthor}
|
|
@@ -1109,6 +1122,25 @@ export interface ReviewImagesInner {
|
|
|
1109
1122
|
*/
|
|
1110
1123
|
'alt'?: string;
|
|
1111
1124
|
}
|
|
1125
|
+
/**
|
|
1126
|
+
* The product that the review is for
|
|
1127
|
+
* @export
|
|
1128
|
+
* @interface ReviewProduct
|
|
1129
|
+
*/
|
|
1130
|
+
export interface ReviewProduct {
|
|
1131
|
+
/**
|
|
1132
|
+
* Unique object identifier
|
|
1133
|
+
* @type {string}
|
|
1134
|
+
* @memberof ReviewProduct
|
|
1135
|
+
*/
|
|
1136
|
+
'id'?: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* The title of the product
|
|
1139
|
+
* @type {string}
|
|
1140
|
+
* @memberof ReviewProduct
|
|
1141
|
+
*/
|
|
1142
|
+
'title'?: string;
|
|
1143
|
+
}
|
|
1112
1144
|
/**
|
|
1113
1145
|
*
|
|
1114
1146
|
* @export
|
|
@@ -1290,6 +1322,12 @@ export interface SeoOptimiseCollectionsRequest {
|
|
|
1290
1322
|
* @memberof SeoOptimiseCollectionsRequest
|
|
1291
1323
|
*/
|
|
1292
1324
|
'ids'?: Array<string>;
|
|
1325
|
+
/**
|
|
1326
|
+
* If provided, only the specified fields will be updated.
|
|
1327
|
+
* @type {Array<string>}
|
|
1328
|
+
* @memberof SeoOptimiseCollectionsRequest
|
|
1329
|
+
*/
|
|
1330
|
+
'fields'?: Array<string>;
|
|
1293
1331
|
}
|
|
1294
1332
|
/**
|
|
1295
1333
|
*
|
|
@@ -1316,6 +1354,12 @@ export interface SeoOptimisePagesRequest {
|
|
|
1316
1354
|
* @memberof SeoOptimisePagesRequest
|
|
1317
1355
|
*/
|
|
1318
1356
|
'ids'?: Array<string>;
|
|
1357
|
+
/**
|
|
1358
|
+
* If provided, only the specified fields will be updated.
|
|
1359
|
+
* @type {Array<string>}
|
|
1360
|
+
* @memberof SeoOptimisePagesRequest
|
|
1361
|
+
*/
|
|
1362
|
+
'fields'?: Array<string>;
|
|
1319
1363
|
}
|
|
1320
1364
|
/**
|
|
1321
1365
|
*
|
|
@@ -5936,6 +5980,64 @@ export class PaymentApi extends BaseAPI {
|
|
|
5936
5980
|
*/
|
|
5937
5981
|
export const ReviewsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
5938
5982
|
return {
|
|
5983
|
+
/**
|
|
5984
|
+
* Export reviews as a CSV file.
|
|
5985
|
+
* @summary Export reviews
|
|
5986
|
+
* @param {string} project What project it is
|
|
5987
|
+
* @param {string} [start] Start of date range to filter by
|
|
5988
|
+
* @param {string} [end] End of date range to filter by
|
|
5989
|
+
* @param {*} [options] Override http request option.
|
|
5990
|
+
* @throws {RequiredError}
|
|
5991
|
+
*/
|
|
5992
|
+
exportReviews: async (project: string, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5993
|
+
// verify required parameter 'project' is not null or undefined
|
|
5994
|
+
assertParamExists('exportReviews', 'project', project)
|
|
5995
|
+
const localVarPath = `/v1/website/reviews/export`;
|
|
5996
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5997
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5998
|
+
let baseOptions;
|
|
5999
|
+
if (configuration) {
|
|
6000
|
+
baseOptions = configuration.baseOptions;
|
|
6001
|
+
}
|
|
6002
|
+
|
|
6003
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
6004
|
+
const localVarHeaderParameter = {} as any;
|
|
6005
|
+
const localVarQueryParameter = {} as any;
|
|
6006
|
+
|
|
6007
|
+
// authentication session-oauth required
|
|
6008
|
+
// oauth required
|
|
6009
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
6010
|
+
|
|
6011
|
+
// authentication api-key required
|
|
6012
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
6013
|
+
|
|
6014
|
+
if (project !== undefined) {
|
|
6015
|
+
localVarQueryParameter['project'] = project;
|
|
6016
|
+
}
|
|
6017
|
+
|
|
6018
|
+
if (start !== undefined) {
|
|
6019
|
+
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
6020
|
+
(start as any).toISOString() :
|
|
6021
|
+
start;
|
|
6022
|
+
}
|
|
6023
|
+
|
|
6024
|
+
if (end !== undefined) {
|
|
6025
|
+
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
6026
|
+
(end as any).toISOString() :
|
|
6027
|
+
end;
|
|
6028
|
+
}
|
|
6029
|
+
|
|
6030
|
+
|
|
6031
|
+
|
|
6032
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6033
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6034
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
6035
|
+
|
|
6036
|
+
return {
|
|
6037
|
+
url: toPathString(localVarUrlObj),
|
|
6038
|
+
options: localVarRequestOptions,
|
|
6039
|
+
};
|
|
6040
|
+
},
|
|
5939
6041
|
/**
|
|
5940
6042
|
*
|
|
5941
6043
|
* @summary Get review
|
|
@@ -5992,10 +6094,12 @@ export const ReviewsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
5992
6094
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
5993
6095
|
* @param {string} [search] Search term to filter results
|
|
5994
6096
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
6097
|
+
* @param {string} [start] Start of date range to filter by
|
|
6098
|
+
* @param {string} [end] End of date range to filter by
|
|
5995
6099
|
* @param {*} [options] Override http request option.
|
|
5996
6100
|
* @throws {RequiredError}
|
|
5997
6101
|
*/
|
|
5998
|
-
listReviews: async (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6102
|
+
listReviews: async (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5999
6103
|
// verify required parameter 'project' is not null or undefined
|
|
6000
6104
|
assertParamExists('listReviews', 'project', project)
|
|
6001
6105
|
const localVarPath = `/v1/website/reviews`;
|
|
@@ -6037,6 +6141,18 @@ export const ReviewsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
6037
6141
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
6038
6142
|
}
|
|
6039
6143
|
|
|
6144
|
+
if (start !== undefined) {
|
|
6145
|
+
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
6146
|
+
(start as any).toISOString() :
|
|
6147
|
+
start;
|
|
6148
|
+
}
|
|
6149
|
+
|
|
6150
|
+
if (end !== undefined) {
|
|
6151
|
+
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
6152
|
+
(end as any).toISOString() :
|
|
6153
|
+
end;
|
|
6154
|
+
}
|
|
6155
|
+
|
|
6040
6156
|
|
|
6041
6157
|
|
|
6042
6158
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6110,6 +6226,21 @@ export const ReviewsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
6110
6226
|
export const ReviewsApiFp = function(configuration?: Configuration) {
|
|
6111
6227
|
const localVarAxiosParamCreator = ReviewsApiAxiosParamCreator(configuration)
|
|
6112
6228
|
return {
|
|
6229
|
+
/**
|
|
6230
|
+
* Export reviews as a CSV file.
|
|
6231
|
+
* @summary Export reviews
|
|
6232
|
+
* @param {string} project What project it is
|
|
6233
|
+
* @param {string} [start] Start of date range to filter by
|
|
6234
|
+
* @param {string} [end] End of date range to filter by
|
|
6235
|
+
* @param {*} [options] Override http request option.
|
|
6236
|
+
* @throws {RequiredError}
|
|
6237
|
+
*/
|
|
6238
|
+
async exportReviews(project: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
6239
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportReviews(project, start, end, options);
|
|
6240
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6241
|
+
const localVarOperationServerBasePath = operationServerMap['ReviewsApi.exportReviews']?.[localVarOperationServerIndex]?.url;
|
|
6242
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6243
|
+
},
|
|
6113
6244
|
/**
|
|
6114
6245
|
*
|
|
6115
6246
|
* @summary Get review
|
|
@@ -6132,11 +6263,13 @@ export const ReviewsApiFp = function(configuration?: Configuration) {
|
|
|
6132
6263
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
6133
6264
|
* @param {string} [search] Search term to filter results
|
|
6134
6265
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
6266
|
+
* @param {string} [start] Start of date range to filter by
|
|
6267
|
+
* @param {string} [end] End of date range to filter by
|
|
6135
6268
|
* @param {*} [options] Override http request option.
|
|
6136
6269
|
* @throws {RequiredError}
|
|
6137
6270
|
*/
|
|
6138
|
-
async listReviews(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReviewsResponse>> {
|
|
6139
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listReviews(project, pageToken, pageSize, search, sortBy, options);
|
|
6271
|
+
async 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>> {
|
|
6272
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listReviews(project, pageToken, pageSize, search, sortBy, start, end, options);
|
|
6140
6273
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6141
6274
|
const localVarOperationServerBasePath = operationServerMap['ReviewsApi.listReviews']?.[localVarOperationServerIndex]?.url;
|
|
6142
6275
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -6166,6 +6299,16 @@ export const ReviewsApiFp = function(configuration?: Configuration) {
|
|
|
6166
6299
|
export const ReviewsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
6167
6300
|
const localVarFp = ReviewsApiFp(configuration)
|
|
6168
6301
|
return {
|
|
6302
|
+
/**
|
|
6303
|
+
* Export reviews as a CSV file.
|
|
6304
|
+
* @summary Export reviews
|
|
6305
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
6306
|
+
* @param {*} [options] Override http request option.
|
|
6307
|
+
* @throws {RequiredError}
|
|
6308
|
+
*/
|
|
6309
|
+
exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
6310
|
+
return localVarFp.exportReviews(requestParameters.project, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
6311
|
+
},
|
|
6169
6312
|
/**
|
|
6170
6313
|
*
|
|
6171
6314
|
* @summary Get review
|
|
@@ -6184,7 +6327,7 @@ export const ReviewsApiFactory = function (configuration?: Configuration, basePa
|
|
|
6184
6327
|
* @throws {RequiredError}
|
|
6185
6328
|
*/
|
|
6186
6329
|
listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReviewsResponse> {
|
|
6187
|
-
return localVarFp.listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, options).then((request) => request(axios, basePath));
|
|
6330
|
+
return localVarFp.listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
6188
6331
|
},
|
|
6189
6332
|
/**
|
|
6190
6333
|
*
|
|
@@ -6199,6 +6342,34 @@ export const ReviewsApiFactory = function (configuration?: Configuration, basePa
|
|
|
6199
6342
|
};
|
|
6200
6343
|
};
|
|
6201
6344
|
|
|
6345
|
+
/**
|
|
6346
|
+
* Request parameters for exportReviews operation in ReviewsApi.
|
|
6347
|
+
* @export
|
|
6348
|
+
* @interface ReviewsApiExportReviewsRequest
|
|
6349
|
+
*/
|
|
6350
|
+
export interface ReviewsApiExportReviewsRequest {
|
|
6351
|
+
/**
|
|
6352
|
+
* What project it is
|
|
6353
|
+
* @type {string}
|
|
6354
|
+
* @memberof ReviewsApiExportReviews
|
|
6355
|
+
*/
|
|
6356
|
+
readonly project: string
|
|
6357
|
+
|
|
6358
|
+
/**
|
|
6359
|
+
* Start of date range to filter by
|
|
6360
|
+
* @type {string}
|
|
6361
|
+
* @memberof ReviewsApiExportReviews
|
|
6362
|
+
*/
|
|
6363
|
+
readonly start?: string
|
|
6364
|
+
|
|
6365
|
+
/**
|
|
6366
|
+
* End of date range to filter by
|
|
6367
|
+
* @type {string}
|
|
6368
|
+
* @memberof ReviewsApiExportReviews
|
|
6369
|
+
*/
|
|
6370
|
+
readonly end?: string
|
|
6371
|
+
}
|
|
6372
|
+
|
|
6202
6373
|
/**
|
|
6203
6374
|
* Request parameters for getReview operation in ReviewsApi.
|
|
6204
6375
|
* @export
|
|
@@ -6260,6 +6431,20 @@ export interface ReviewsApiListReviewsRequest {
|
|
|
6260
6431
|
* @memberof ReviewsApiListReviews
|
|
6261
6432
|
*/
|
|
6262
6433
|
readonly sortBy?: Array<string>
|
|
6434
|
+
|
|
6435
|
+
/**
|
|
6436
|
+
* Start of date range to filter by
|
|
6437
|
+
* @type {string}
|
|
6438
|
+
* @memberof ReviewsApiListReviews
|
|
6439
|
+
*/
|
|
6440
|
+
readonly start?: string
|
|
6441
|
+
|
|
6442
|
+
/**
|
|
6443
|
+
* End of date range to filter by
|
|
6444
|
+
* @type {string}
|
|
6445
|
+
* @memberof ReviewsApiListReviews
|
|
6446
|
+
*/
|
|
6447
|
+
readonly end?: string
|
|
6263
6448
|
}
|
|
6264
6449
|
|
|
6265
6450
|
/**
|
|
@@ -6297,6 +6482,18 @@ export interface ReviewsApiModerateReviewRequest {
|
|
|
6297
6482
|
* @extends {BaseAPI}
|
|
6298
6483
|
*/
|
|
6299
6484
|
export class ReviewsApi extends BaseAPI {
|
|
6485
|
+
/**
|
|
6486
|
+
* Export reviews as a CSV file.
|
|
6487
|
+
* @summary Export reviews
|
|
6488
|
+
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
6489
|
+
* @param {*} [options] Override http request option.
|
|
6490
|
+
* @throws {RequiredError}
|
|
6491
|
+
* @memberof ReviewsApi
|
|
6492
|
+
*/
|
|
6493
|
+
public exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig) {
|
|
6494
|
+
return ReviewsApiFp(this.configuration).exportReviews(requestParameters.project, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
6495
|
+
}
|
|
6496
|
+
|
|
6300
6497
|
/**
|
|
6301
6498
|
*
|
|
6302
6499
|
* @summary Get review
|
|
@@ -6318,7 +6515,7 @@ export class ReviewsApi extends BaseAPI {
|
|
|
6318
6515
|
* @memberof ReviewsApi
|
|
6319
6516
|
*/
|
|
6320
6517
|
public listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig) {
|
|
6321
|
-
return ReviewsApiFp(this.configuration).listReviews(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
|
|
6518
|
+
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));
|
|
6322
6519
|
}
|
|
6323
6520
|
|
|
6324
6521
|
/**
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED