@teemill/website 0.19.1 → 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 +924 -145
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +485 -3
- package/dist/api.js +485 -8
- 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 +485 -3
- package/dist/esm/api.js +475 -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/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/website@0.
|
|
1
|
+
## @teemill/website@0.21.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.21.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
|
+
|