@teemill/website 0.19.1 → 0.21.0

package/docs/ApiError.md

@@ -0,0 +1,22 @@
+# ApiError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiError } from '@teemill/website';
+
+const instance: ApiError = {
+    code,
+    message,
+};
+```
+
+[[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/Application.md

@@ -0,0 +1,28 @@
+# Application
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**technology** | **string** | Technology to use for the application. | [default to undefined]
+**placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
+**src** | **string** | Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area. Accepts PNG and JPEG files. | [default to undefined]
+**mockup** | [**ApplicationMockup**](ApplicationMockup.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Application } from '@teemill/website';
+
+const instance: Application = {
+    id,
+    technology,
+    placement,
+    src,
+    mockup,
+};
+```
+
+[[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/ApplicationMockup.md

@@ -0,0 +1,22 @@
+# ApplicationMockup
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **string** | Drive image URL. If provided, this will be used as the mockup image for the variant application rather than generating a new one. | [default to undefined]
+**preview** | **string** | Publicly available mockup image URL. This is a preview of the mockup image for the given application. | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { ApplicationMockup } from '@teemill/website';
+
+const instance: ApplicationMockup = {
+    file,
+    preview,
+};
+```
+
+[[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/AttachCrossSellProductsRequest.md

@@ -0,0 +1,20 @@
+# AttachCrossSellProductsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**products** | **Array<string>** | A list of product IDs to attach as cross-sell products. The order in which they are sent is the order they will be saved in. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AttachCrossSellProductsRequest } from '@teemill/website';
+
+const instance: AttachCrossSellProductsRequest = {
+    products,
+};
+```
+
+[[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/Attribute.md

@@ -0,0 +1,26 @@
+# Attribute
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Attribute name | [default to undefined]
+**value** | **string** | Attribute value | [default to undefined]
+**thumbnail** | [**AttributeThumbnail**](AttributeThumbnail.md) |  | [optional] [default to undefined]
+**tags** | **Array<string>** | Attribute tags | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Attribute } from '@teemill/website';
+
+const instance: Attribute = {
+    name,
+    value,
+    thumbnail,
+    tags,
+};
+```
+
+[[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/AttributeThumbnail.md

@@ -0,0 +1,23 @@
+# AttributeThumbnail
+
+Attribute thumbnail, intended for interfaces like storefront colour selector.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AttributeThumbnail } from '@teemill/website';
+
+const instance: AttributeThumbnail = {
+    type,
+    value,
+};
+```
+
+[[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/AuthorizeStripe200Response.md

@@ -0,0 +1,20 @@
+# AuthorizeStripe200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redirect_url** | **string** | The URL to redirect to | [default to undefined]
+
+## Example
+
+```typescript
+import { AuthorizeStripe200Response } from '@teemill/website';
+
+const instance: AuthorizeStripe200Response = {
+    redirect_url,
+};
+```
+
+[[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/Blog.md

@@ -0,0 +1,34 @@
+# Blog
+
+
+## Properties
+
+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]
+**seoMetadata** | [**SeoMetadata**](SeoMetadata.md) |  | [optional] [default to undefined]
+**targetSearchPhraseData** | [**TargetSearchPhraseData**](TargetSearchPhraseData.md) |  | [optional] [default to undefined]
+**metaImage** | [**MetaImage**](MetaImage.md) |  | [optional] [default to undefined]
+**publishedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Blog } from '@teemill/website';
+
+const instance: Blog = {
+    id,
+    title,
+    description,
+    slug,
+    seoMetadata,
+    targetSearchPhraseData,
+    metaImage,
+    publishedAt,
+};
+```
+
+[[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/BlogsApi.md

@@ -0,0 +1,317 @@
+# BlogsApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**exportBlogs**](#exportblogs) | **GET** /v1/website/blogs/export | Export blogs|
+|[**getBlog**](#getblog) | **GET** /v1/website/blogs/{blogId} | Get website blog post|
+|[**listBlogs**](#listblogs) | **GET** /v1/website/blogs | List website blog posts|
+|[**updateBlog**](#updateblog) | **PATCH** /v1/website/blogs/{blogId} | Update website blog post|
+|[**updateBlogs**](#updateblogs) | **PATCH** /v1/website/blogs | Update website blog posts|
+
+# **exportBlogs**
+> File exportBlogs()
+
+Export blogs as a CSV file.
+
+### Example
+
+```typescript
+import {
+    BlogsApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new BlogsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+
+const { status, data } = await apiInstance.exportBlogs(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**File**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/csv; charset=utf-8, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Returns the CSV export |  -  |
+|**202** | Export started. When complete, the export will be available for download from a notification within PodOS Dashboard. |  -  |
+|**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)
+
+# **getBlog**
+> Blog getBlog()
+
+
+### Example
+
+```typescript
+import {
+    BlogsApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new BlogsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let blogId: string; //Blog\'s unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.getBlog(
+    project,
+    blogId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **blogId** | [**string**] | Blog\'s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**Blog**
+
+### 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 |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a website blog post. |  -  |
+|**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)
+
+# **listBlogs**
+> BlogsResponse listBlogs()
+
+
+### Example
+
+```typescript
+import {
+    BlogsApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new BlogsApi(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)
+
+const { status, data } = await apiInstance.listBlogs(
+    project,
+    pageToken,
+    pageSize,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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
+
+**BlogsResponse**
+
+### 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 |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all website blog posts. |  -  |
+|**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)
+
+# **updateBlog**
+> Blog updateBlog()
+
+
+### Example
+
+```typescript
+import {
+    BlogsApi,
+    Configuration,
+    UpdateBlogRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new BlogsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let blogId: string; //Blog\'s unique identifier (default to undefined)
+let updateBlogRequest: UpdateBlogRequest; // (optional)
+
+const { status, data } = await apiInstance.updateBlog(
+    project,
+    blogId,
+    updateBlogRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateBlogRequest** | **UpdateBlogRequest**|  | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **blogId** | [**string**] | Blog\'s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**Blog**
+
+### 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 |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a website blog post. |  -  |
+|**400** | Failed validation |  -  |
+|**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)
+
+# **updateBlogs**
+> BlogsResponse updateBlogs()
+
+
+### Example
+
+```typescript
+import {
+    BlogsApi,
+    Configuration,
+    UpdateBlogsRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new BlogsApi(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 updateBlogsRequest: UpdateBlogsRequest; //Update blogs in bulk. (optional)
+
+const { status, data } = await apiInstance.updateBlogs(
+    project,
+    pageToken,
+    pageSize,
+    search,
+    updateBlogsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateBlogsRequest** | **UpdateBlogsRequest**| Update blogs in bulk. | |
+| **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
+
+**BlogsResponse**
+
+### 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 |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved all website blog posts. |  -  |
+|**400** | Failed validation |  -  |
+|**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)
+

package/docs/BlogsResponse.md

@@ -0,0 +1,22 @@
+# BlogsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**blogs** | [**Array<Blog>**](Blog.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** | The token referencing the next page number | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BlogsResponse } from '@teemill/website';
+
+const instance: BlogsResponse = {
+    blogs,
+    nextPageToken,
+};
+```
+
+[[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/Brand.md

@@ -0,0 +1,20 @@
+# Brand
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**favicon** | **string** | The URL of the favicon | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Brand } from '@teemill/website';
+
+const instance: Brand = {
+    favicon,
+};
+```
+
+[[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

@@ -0,0 +1,36 @@
+# Collection
+
+
+## Properties
+
+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]
+**longDescription** | **string** |  | [optional] [default to undefined]
+**seoMetadata** | [**SeoMetadata**](SeoMetadata.md) |  | [optional] [default to undefined]
+**targetSearchPhraseData** | [**TargetSearchPhraseData**](TargetSearchPhraseData.md) |  | [optional] [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]
+
+## Example
+
+```typescript
+import { Collection } from '@teemill/website';
+
+const instance: Collection = {
+    id,
+    title,
+    description,
+    slug,
+    longDescription,
+    seoMetadata,
+    targetSearchPhraseData,
+    optimisationHistory,
+    metaImage,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)