@teemill/website 0.22.1 → 0.23.0

package/docs/CreateCollectionRequestBanner.md

@@ -0,0 +1,22 @@
+# CreateCollectionRequestBanner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | [**CreateCollectionRequestBannerImage**](CreateCollectionRequestBannerImage.md) |  | [default to undefined]
+**overlay** | [**CreateCollectionRequestBannerOverlay**](CreateCollectionRequestBannerOverlay.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCollectionRequestBanner } from '@teemill/website';
+
+const instance: CreateCollectionRequestBanner = {
+    image,
+    overlay,
+};
+```
+
+[[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/CreateCollectionRequestBannerImage.md

@@ -0,0 +1,22 @@
+# CreateCollectionRequestBannerImage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**src** | **string** | The source of the image | [default to undefined]
+**alt** | **string** | Alternative text for the image | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCollectionRequestBannerImage } from '@teemill/website';
+
+const instance: CreateCollectionRequestBannerImage = {
+    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/CreateCollectionRequestBannerOverlay.md

@@ -0,0 +1,26 @@
+# CreateCollectionRequestBannerOverlay
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **string** | The start color of the gradient | [optional] [default to undefined]
+**to** | **string** | The end color of the gradient | [optional] [default to undefined]
+**angle** | **number** |  | [optional] [default to undefined]
+**opacity** | **number** | The opacity of the gradient | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCollectionRequestBannerOverlay } from '@teemill/website';
+
+const instance: CreateCollectionRequestBannerOverlay = {
+    from,
+    to,
+    angle,
+    opacity,
+};
+```
+
+[[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/CreateCollectionRequestProductsInner.md

@@ -0,0 +1,24 @@
+# CreateCollectionRequestProductsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ref** | **string** | A reference to the catalog product | [default to undefined]
+**order** | **number** | The sort order of the product in the collection | [default to undefined]
+**src** | **string** | An image for the product to be used in the collection | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCollectionRequestProductsInner } from '@teemill/website';
+
+const instance: CreateCollectionRequestProductsInner = {
+    ref,
+    order,
+    src,
+};
+```
+
+[[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/CreateCollectionRequestSeoMetadata.md

@@ -0,0 +1,24 @@
+# CreateCollectionRequestSeoMetadata
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Meta title for the collection. This appears in search engine results and social shares. If not provided, the collection title will be used. | [optional] [default to undefined]
+**description** | **string** | Meta description for the collection. This appears in search engine results and social shares. If not provided, the collection description will be used. | [optional] [default to undefined]
+**image** | [**MetaImage**](MetaImage.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCollectionRequestSeoMetadata } from '@teemill/website';
+
+const instance: CreateCollectionRequestSeoMetadata = {
+    title,
+    description,
+    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/Footer.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**items** | [**Array<FooterItem>**](FooterItem.md) |  | [optional] [default to undefined]
+**items** | [**Array<FooterItem>**](FooterItem.md) |  | [default to undefined]
 
 ## Example
 

package/docs/FooterItem.md

@@ -5,10 +5,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**text** | **string** |  | [optional] [default to undefined]
-**link** | **string** |  | [optional] [default to undefined]
-**order** | **number** |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**text** | **string** |  | [default to undefined]
+**link** | **string** |  | [default to undefined]
+**order** | **number** |  | [default to undefined]
 
 ## Example
 

package/docs/MetaImage.md

@@ -1,6 +1,6 @@
 # MetaImage
 
-The image that will in links shared on social media platforms
+The image that will be used in links shared on social media platforms
 
 ## Properties
 

package/docs/NavigationTag.md

@@ -0,0 +1,24 @@
+# NavigationTag
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **string** |  | [default to undefined]
+**link** | **string** |  | [default to undefined]
+**order** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { NavigationTag } from '@teemill/website';
+
+const instance: NavigationTag = {
+    text,
+    link,
+    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/NullableMetaImage.md

@@ -0,0 +1,23 @@
+# NullableMetaImage
+
+The image that will be used in links shared on social media platforms
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**src** | **string** |  | [optional] [default to undefined]
+**alt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NullableMetaImage } from '@teemill/website';
+
+const instance: NullableMetaImage = {
+    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/Overlay.md

@@ -0,0 +1,27 @@
+# Overlay
+
+The overlay that is used to display the collection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **string** |  | [default to undefined]
+**to** | **string** |  | [default to undefined]
+**angle** | **number** |  | [default to undefined]
+**opacity** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Overlay } from '@teemill/website';
+
+const instance: Overlay = {
+    from,
+    to,
+    angle,
+    opacity,
+};
+```
+
+[[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/UpdateCollectionRequest.md

@@ -5,13 +5,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**banner** | [**UpdateCollectionRequestBanner**](UpdateCollectionRequestBanner.md) |  | [optional] [default to undefined]
 **title** | **string** | Collection title | [optional] [default to undefined]
 **description** | **string** | Collection description | [optional] [default to undefined]
 **slug** | **string** | URL slug. This must be unique for each collection on the website. Updating this will also break any existing links to this collection. | [optional] [default to undefined]
 **longDescription** | **string** | Long-form description for the collection used for SEO. | [optional] [default to undefined]
-**seoMetadata** | [**UpdateCollectionsRequestCollectionsInnerSeoMetadata**](UpdateCollectionsRequestCollectionsInnerSeoMetadata.md) |  | [optional] [default to undefined]
+**seoMetadata** | [**UpdateCollectionRequestSeoMetadata**](UpdateCollectionRequestSeoMetadata.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<UpdateCollectionRequestProductsInner>**](UpdateCollectionRequestProductsInner.md) | A set of products to include in the collection. | [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]
 
 ## Example
 
@@ -19,6 +22,7 @@ Name | Type | Description | Notes
 import { UpdateCollectionRequest } from '@teemill/website';
 
 const instance: UpdateCollectionRequest = {
+    banner,
     title,
     description,
     slug,
@@ -26,6 +30,8 @@ const instance: UpdateCollectionRequest = {
     seoMetadata,
     targetSearchPhrase,
     targetSearchPhraseSynonyms,
+    products,
+    navigationTags,
 };
 ```
 

package/docs/UpdateCollectionRequestBanner.md

@@ -0,0 +1,22 @@
+# UpdateCollectionRequestBanner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | [**UpdateCollectionRequestBannerImage**](UpdateCollectionRequestBannerImage.md) |  | [optional] [default to undefined]
+**overlay** | [**UpdateCollectionsRequestCollectionsInnerBannerOverlay**](UpdateCollectionsRequestCollectionsInnerBannerOverlay.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCollectionRequestBanner } from '@teemill/website';
+
+const instance: UpdateCollectionRequestBanner = {
+    image,
+    overlay,
+};
+```
+
+[[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/UpdateCollectionRequestBannerImage.md

@@ -0,0 +1,22 @@
+# UpdateCollectionRequestBannerImage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**src** | **string** | Banner image source | [optional] [default to undefined]
+**alt** | **string** | Banner image alt text | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCollectionRequestBannerImage } from '@teemill/website';
+
+const instance: UpdateCollectionRequestBannerImage = {
+    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/UpdateCollectionRequestProductsInner.md

@@ -0,0 +1,24 @@
+# UpdateCollectionRequestProductsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ref** | **string** | A reference to the catalog product | [optional] [default to undefined]
+**order** | **number** | The sort order of the product in the collection | [optional] [default to undefined]
+**src** | **string** | An image for the product to be used in the collection | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCollectionRequestProductsInner } from '@teemill/website';
+
+const instance: UpdateCollectionRequestProductsInner = {
+    ref,
+    order,
+    src,
+};
+```
+
+[[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/UpdateCollectionRequestSeoMetadata.md

@@ -0,0 +1,24 @@
+# UpdateCollectionRequestSeoMetadata
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Meta title for the collection. This appears in search engine results and social shares. If not provided, the collection title will be used. | [optional] [default to undefined]
+**description** | **string** | Meta description for the collection. This appears in search engine results and social shares. If not provided, the collection description will be used. | [optional] [default to undefined]
+**image** | [**MetaImage**](MetaImage.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCollectionRequestSeoMetadata } from '@teemill/website';
+
+const instance: UpdateCollectionRequestSeoMetadata = {
+    title,
+    description,
+    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/UpdateCollectionsRequestCollectionsInner.md

@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **string** | Unique object identifier | [default to undefined]
+**banner** | [**UpdateCollectionsRequestCollectionsInnerBanner**](UpdateCollectionsRequestCollectionsInnerBanner.md) |  | [optional] [default to undefined]
 **title** | **string** | Collection title | [optional] [default to undefined]
 **description** | **string** | Collection description | [optional] [default to undefined]
 **slug** | **string** | URL slug. This must be unique for each collection on the website. Updating this will also break any existing links to this collection. | [optional] [default to undefined]
@@ -13,6 +14,8 @@ Name | Type | Description | Notes
 **seoMetadata** | [**UpdateCollectionsRequestCollectionsInnerSeoMetadata**](UpdateCollectionsRequestCollectionsInnerSeoMetadata.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<UpdateCollectionsRequestCollectionsInnerProductsInner>**](UpdateCollectionsRequestCollectionsInnerProductsInner.md) | A set of products to include in the collection. | [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]
 
 ## Example
 
@@ -21,6 +24,7 @@ import { UpdateCollectionsRequestCollectionsInner } from '@teemill/website';
 
 const instance: UpdateCollectionsRequestCollectionsInner = {
     id,
+    banner,
     title,
     description,
     slug,
@@ -28,6 +32,8 @@ const instance: UpdateCollectionsRequestCollectionsInner = {
     seoMetadata,
     targetSearchPhrase,
     targetSearchPhraseSynonyms,
+    products,
+    navigationTags,
 };
 ```
 

package/docs/UpdateCollectionsRequestCollectionsInnerBanner.md

@@ -0,0 +1,22 @@
+# UpdateCollectionsRequestCollectionsInnerBanner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | [**UpdateCollectionsRequestCollectionsInnerBannerImage**](UpdateCollectionsRequestCollectionsInnerBannerImage.md) |  | [optional] [default to undefined]
+**overlay** | [**UpdateCollectionsRequestCollectionsInnerBannerOverlay**](UpdateCollectionsRequestCollectionsInnerBannerOverlay.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCollectionsRequestCollectionsInnerBanner } from '@teemill/website';
+
+const instance: UpdateCollectionsRequestCollectionsInnerBanner = {
+    image,
+    overlay,
+};
+```
+
+[[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/UpdateCollectionsRequestCollectionsInnerBannerImage.md

@@ -0,0 +1,22 @@
+# UpdateCollectionsRequestCollectionsInnerBannerImage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**src** | **string** | Banner image source | [optional] [default to undefined]
+**alt** | **string** | Alternative text for the image | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCollectionsRequestCollectionsInnerBannerImage } from '@teemill/website';
+
+const instance: UpdateCollectionsRequestCollectionsInnerBannerImage = {
+    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/UpdateCollectionsRequestCollectionsInnerBannerOverlay.md

@@ -0,0 +1,26 @@
+# UpdateCollectionsRequestCollectionsInnerBannerOverlay
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **string** | The start color of the gradient | [optional] [default to undefined]
+**to** | **string** | The end color of the gradient | [optional] [default to undefined]
+**angle** | **number** | The angle of the gradient | [optional] [default to undefined]
+**opacity** | **number** | The opacity of the gradient | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCollectionsRequestCollectionsInnerBannerOverlay } from '@teemill/website';
+
+const instance: UpdateCollectionsRequestCollectionsInnerBannerOverlay = {
+    from,
+    to,
+    angle,
+    opacity,
+};
+```
+
+[[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/UpdateCollectionsRequestCollectionsInnerProductsInner.md

@@ -0,0 +1,24 @@
+# UpdateCollectionsRequestCollectionsInnerProductsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ref** | [**CollectionProduct**](CollectionProduct.md) |  | [optional] [default to undefined]
+**order** | **number** | The sort order of the product in the collection | [optional] [default to undefined]
+**image** | [**NullableMetaImage**](NullableMetaImage.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCollectionsRequestCollectionsInnerProductsInner } from '@teemill/website';
+
+const instance: UpdateCollectionsRequestCollectionsInnerProductsInner = {
+    ref,
+    order,
+    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/index.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/website",
-  "version": "0.22.1",
+  "version": "0.23.0",
   "description": "OpenAPI client for @teemill/website",
   "author": "OpenAPI-Generator Contributors",
   "repository": {