@teemill/website 0.22.2 → 0.23.0

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.22.2
+ * The version of the OpenAPI document: 0.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -565,6 +565,97 @@ export class BlogsApi extends BaseAPI {
  */
 export const CollectionsApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         * Create a new website collection.
+         * @summary Create website collection
+         * @param {string} project What project it is
+         * @param {number} [pageToken] Page reference token
+         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+         * @param {string} [search] Search term to filter results
+         * @param {CreateCollectionRequest} [createCollectionRequest] Create a new collection
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createCollection: (project_1, pageToken_1, pageSize_1, search_1, createCollectionRequest_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, search_1, createCollectionRequest_1, ...args_1], void 0, function* (project, pageToken, pageSize, search, createCollectionRequest, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('createCollection', 'project', project);
+            const localVarPath = `/v1/website/collections`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(createCollectionRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Delete website collection
+         * @param {string} project What project it is
+         * @param {string} collectionId Collection\'s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteCollection: (project_1, collectionId_1, ...args_1) => __awaiter(this, [project_1, collectionId_1, ...args_1], void 0, function* (project, collectionId, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('deleteCollection', 'project', project);
+            // verify required parameter 'collectionId' is not null or undefined
+            assertParamExists('deleteCollection', 'collectionId', collectionId);
+            const localVarPath = `/v1/website/collections/{collectionId}`
+                .replace(`{${"collectionId"}}`, encodeURIComponent(String(collectionId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Export collections as a CSV file.
          * @summary Export collections
@@ -772,7 +863,7 @@ export const CollectionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
+         * Update a website collection.
          * @summary Update website collections
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
@@ -831,6 +922,43 @@ export const CollectionsApiAxiosParamCreator = function (configuration) {
 export const CollectionsApiFp = function (configuration) {
     const localVarAxiosParamCreator = CollectionsApiAxiosParamCreator(configuration);
     return {
+        /**
+         * Create a new website collection.
+         * @summary Create website collection
+         * @param {string} project What project it is
+         * @param {number} [pageToken] Page reference token
+         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+         * @param {string} [search] Search term to filter results
+         * @param {CreateCollectionRequest} [createCollectionRequest] Create a new collection
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createCollection(project, pageToken, pageSize, search, createCollectionRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createCollection(project, pageToken, pageSize, search, createCollectionRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CollectionsApi.createCollection']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         *
+         * @summary Delete website collection
+         * @param {string} project What project it is
+         * @param {string} collectionId Collection\'s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteCollection(project, collectionId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteCollection(project, collectionId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CollectionsApi.deleteCollection']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Export collections as a CSV file.
          * @summary Export collections
@@ -919,7 +1047,7 @@ export const CollectionsApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * Update a website collection.
          * @summary Update website collections
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
@@ -947,6 +1075,26 @@ export const CollectionsApiFp = function (configuration) {
 export const CollectionsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = CollectionsApiFp(configuration);
     return {
+        /**
+         * Create a new website collection.
+         * @summary Create website collection
+         * @param {CollectionsApiCreateCollectionRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createCollection(requestParameters, options) {
+            return localVarFp.createCollection(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.createCollectionRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Delete website collection
+         * @param {CollectionsApiDeleteCollectionRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteCollection(requestParameters, options) {
+            return localVarFp.deleteCollection(requestParameters.project, requestParameters.collectionId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Export collections as a CSV file.
          * @summary Export collections
@@ -998,7 +1146,7 @@ export const CollectionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.updateCollection(requestParameters.project, requestParameters.collectionId, requestParameters.updateCollectionRequest, options).then((request) => request(axios, basePath));
         },
         /**
-         *
+         * Update a website collection.
          * @summary Update website collections
          * @param {CollectionsApiUpdateCollectionsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -1016,6 +1164,28 @@ export const CollectionsApiFactory = function (configuration, basePath, axios) {
  * @extends {BaseAPI}
  */
 export class CollectionsApi extends BaseAPI {
+    /**
+     * Create a new website collection.
+     * @summary Create website collection
+     * @param {CollectionsApiCreateCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    createCollection(requestParameters, options) {
+        return CollectionsApiFp(this.configuration).createCollection(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.createCollectionRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Delete website collection
+     * @param {CollectionsApiDeleteCollectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    deleteCollection(requestParameters, options) {
+        return CollectionsApiFp(this.configuration).deleteCollection(requestParameters.project, requestParameters.collectionId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Export collections as a CSV file.
      * @summary Export collections
@@ -1072,7 +1242,7 @@ export class CollectionsApi extends BaseAPI {
         return CollectionsApiFp(this.configuration).updateCollection(requestParameters.project, requestParameters.collectionId, requestParameters.updateCollectionRequest, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
+     * Update a website collection.
      * @summary Update website collections
      * @param {CollectionsApiUpdateCollectionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.22.2
+ * The version of the OpenAPI document: 0.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.22.2
+ * The version of the OpenAPI document: 0.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.22.2
+ * The version of the OpenAPI document: 0.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.22.2
+ * The version of the OpenAPI document: 0.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.22.2
+ * The version of the OpenAPI document: 0.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.22.2
+ * The version of the OpenAPI document: 0.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.d.ts

@@ -2,7 +2,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.22.2
+ * The version of the OpenAPI document: 0.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.22.2
+ * The version of the OpenAPI document: 0.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.22.2
+ * The version of the OpenAPI document: 0.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.22.2
+ * The version of the OpenAPI document: 0.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/Banner.md

@@ -0,0 +1,23 @@
+# Banner
+
+The banner image that is used to display the collection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**overlay** | [**Overlay**](Overlay.md) |  | [optional] [default to undefined]
+**image** | [**BannerImage**](BannerImage.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Banner } from '@teemill/website';
+
+const instance: Banner = {
+    overlay,
+    image,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BannerImage.md

@@ -0,0 +1,22 @@
+# BannerImage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**src** | **string** |  | [default to undefined]
+**alt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BannerImage } from '@teemill/website';
+
+const instance: BannerImage = {
+    src,
+    alt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Collection.md

@@ -6,14 +6,16 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **string** | Unique object identifier | [optional] [default to undefined]
-**title** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to undefined]
-**slug** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**slug** | **string** |  | [default to undefined]
 **longDescription** | **string** |  | [optional] [default to undefined]
+**banner** | [**Banner**](Banner.md) |  | [default to undefined]
 **seoMetadata** | [**SeoMetadata**](SeoMetadata.md) |  | [optional] [default to undefined]
-**targetSearchPhraseData** | [**TargetSearchPhraseData**](TargetSearchPhraseData.md) |  | [optional] [default to undefined]
+**targetSearchPhraseData** | [**TargetSearchPhraseData**](TargetSearchPhraseData.md) |  | [default to undefined]
 **optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the collection | [optional] [default to undefined]
-**metaImage** | [**MetaImage**](MetaImage.md) |  | [optional] [default to undefined]
+**navigationTags** | [**Array<NavigationTag>**](NavigationTag.md) | Tags that are used to link to other collections, pages and products. | [optional] [default to undefined]
+**products** | [**Array<CollectionProduct>**](CollectionProduct.md) | A set of products to include in the collection. | [default to undefined]
 
 ## Example
 
@@ -26,10 +28,12 @@ const instance: Collection = {
     description,
     slug,
     longDescription,
+    banner,
     seoMetadata,
     targetSearchPhraseData,
     optimisationHistory,
-    metaImage,
+    navigationTags,
+    products,
 };
 ```
 

package/docs/CollectionProduct.md

@@ -0,0 +1,24 @@
+# CollectionProduct
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ref** | **string** | A reference to the catalog product | [default to undefined]
+**image** | [**CollectionProductImage**](CollectionProductImage.md) |  | [default to undefined]
+**order** | **number** | The sort order of the product in the collection | [default to undefined]
+
+## Example
+
+```typescript
+import { CollectionProduct } from '@teemill/website';
+
+const instance: CollectionProduct = {
+    ref,
+    image,
+    order,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CollectionProductImage.md

@@ -0,0 +1,22 @@
+# CollectionProductImage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**src** | **string** | An image for the product to be used in the collection | [default to undefined]
+**alt** | **string** | Alternative text for the image | [default to undefined]
+
+## Example
+
+```typescript
+import { CollectionProductImage } from '@teemill/website';
+
+const instance: CollectionProductImage = {
+    src,
+    alt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CollectionsApi.md

@@ -4,6 +4,8 @@ All URIs are relative to *https://api.localhost:8080*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**createCollection**](#createcollection) | **POST** /v1/website/collections | Create website collection|
+|[**deleteCollection**](#deletecollection) | **DELETE** /v1/website/collections/{collectionId} | Delete website collection|
 |[**exportCollections**](#exportcollections) | **GET** /v1/website/collections/export | Export collections|
 |[**getCollection**](#getcollection) | **GET** /v1/website/collections/{collectionId} | Get website collection|
 |[**listCollections**](#listcollections) | **GET** /v1/website/collections | List website collections|
@@ -11,6 +13,131 @@ All URIs are relative to *https://api.localhost:8080*
 |[**updateCollection**](#updatecollection) | **PATCH** /v1/website/collections/{collectionId} | Update website collection|
 |[**updateCollections**](#updatecollections) | **PATCH** /v1/website/collections | Update website collections|
 
+# **createCollection**
+> Collection createCollection()
+
+Create a new website collection.
+
+### Example
+
+```typescript
+import {
+    CollectionsApi,
+    Configuration,
+    CreateCollectionRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let pageToken: number; //Page reference token (optional) (default to 1)
+let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
+let search: string; //Search term to filter results (optional) (default to undefined)
+let createCollectionRequest: CreateCollectionRequest; //Create a new collection (optional)
+
+const { status, data } = await apiInstance.createCollection(
+    project,
+    pageToken,
+    pageSize,
+    search,
+    createCollectionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createCollectionRequest** | **CreateCollectionRequest**| Create a new collection | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
+| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
+
+
+### Return type
+
+**Collection**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Successfully retrieved a website collection. |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteCollection**
+> deleteCollection()
+
+
+### Example
+
+```typescript
+import {
+    CollectionsApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let collectionId: string; //Collection\'s unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteCollection(
+    project,
+    collectionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **collectionId** | [**string**] | Collection\'s unique identifier | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Collection deleted |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **exportCollections**
 > File exportCollections()
 
@@ -311,6 +438,7 @@ const { status, data } = await apiInstance.updateCollection(
 # **updateCollections**
 > CollectionsResponse updateCollections()
 
+Update a website collection.
 
 ### Example
 

package/docs/CreateCollectionRequest.md

@@ -0,0 +1,38 @@
+# CreateCollectionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**banner** | [**CreateCollectionRequestBanner**](CreateCollectionRequestBanner.md) |  | [default to undefined]
+**title** | **string** | Collection title | [default to undefined]
+**description** | **string** | Collection description | [default to undefined]
+**slug** | **string** | URL slug. This must be unique for each collection on the website. | [default to undefined]
+**longDescription** | **string** | Long-form description for the collection used for SEO. | [optional] [default to undefined]
+**seoMetadata** | [**CreateCollectionRequestSeoMetadata**](CreateCollectionRequestSeoMetadata.md) |  | [optional] [default to undefined]
+**targetSearchPhrase** | **string** | The primary target search phrase for the collection that you wish to rank for in search engine results. | [optional] [default to undefined]
+**targetSearchPhraseSynonyms** | **Array<string>** | Synonyms for the target search phrase. | [optional] [default to undefined]
+**products** | [**Array<CreateCollectionRequestProductsInner>**](CreateCollectionRequestProductsInner.md) | A set of products to include in the collection. | [default to undefined]
+**navigationTags** | [**Array<NavigationTag>**](NavigationTag.md) | Tags that are used to link to other collections, pages and products. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCollectionRequest } from '@teemill/website';
+
+const instance: CreateCollectionRequest = {
+    banner,
+    title,
+    description,
+    slug,
+    longDescription,
+    seoMetadata,
+    targetSearchPhrase,
+    targetSearchPhraseSynonyms,
+    products,
+    navigationTags,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)