@teemill/website 0.19.1 → 0.21.0

package/docs/SearchApi.md

@@ -0,0 +1,319 @@
+# SearchApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createSearchRedirect**](#createsearchredirect) | **POST** /v1/website/search/redirects | Create search redirect|
+|[**deleteSearchRedirect**](#deletesearchredirect) | **DELETE** /v1/website/search/redirects/{redirectId} | Delete search redirect|
+|[**getSearchRedirect**](#getsearchredirect) | **GET** /v1/website/search/redirects/{redirectId} | Get search redirect|
+|[**listSearchRedirects**](#listsearchredirects) | **GET** /v1/website/search/redirects | List search redirects|
+|[**updateSearchRedirect**](#updatesearchredirect) | **PATCH** /v1/website/search/redirects/{redirectId} | Update search redirect|
+
+# **createSearchRedirect**
+> SearchRedirect createSearchRedirect()
+
+
+### Example
+
+```typescript
+import {
+    SearchApi,
+    Configuration,
+    CreateSearchRedirectRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new SearchApi(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 createSearchRedirectRequest: CreateSearchRedirectRequest; //Create search redirect (optional)
+
+const { status, data } = await apiInstance.createSearchRedirect(
+    project,
+    pageToken,
+    pageSize,
+    search,
+    createSearchRedirectRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createSearchRedirectRequest** | **CreateSearchRedirectRequest**| Create search redirect | |
+| **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
+
+**SearchRedirect**
+
+### 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 search redirect |  -  |
+|**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)
+
+# **deleteSearchRedirect**
+> deleteSearchRedirect()
+
+
+### Example
+
+```typescript
+import {
+    SearchApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new SearchApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let redirectId: string; //Redirect\'s unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteSearchRedirect(
+    project,
+    redirectId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **redirectId** | [**string**] | Redirect\'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** | Search redirect 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)
+
+# **getSearchRedirect**
+> SearchRedirect getSearchRedirect()
+
+
+### Example
+
+```typescript
+import {
+    SearchApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new SearchApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let redirectId: string; //Redirect\'s unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.getSearchRedirect(
+    project,
+    redirectId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **redirectId** | [**string**] | Redirect\'s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**SearchRedirect**
+
+### 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 search redirect |  -  |
+|**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)
+
+# **listSearchRedirects**
+> SearchRedirectsResponse listSearchRedirects()
+
+
+### Example
+
+```typescript
+import {
+    SearchApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new SearchApi(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.listSearchRedirects(
+    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
+
+**SearchRedirectsResponse**
+
+### 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** | A list of search redirects |  -  |
+|**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)
+
+# **updateSearchRedirect**
+> SearchRedirect updateSearchRedirect()
+
+
+### Example
+
+```typescript
+import {
+    SearchApi,
+    Configuration,
+    UpdateSearchRedirectRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new SearchApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let redirectId: string; //Redirect\'s unique identifier (default to undefined)
+let updateSearchRedirectRequest: UpdateSearchRedirectRequest; //Update search redirect (optional)
+
+const { status, data } = await apiInstance.updateSearchRedirect(
+    project,
+    redirectId,
+    updateSearchRedirectRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateSearchRedirectRequest** | **UpdateSearchRedirectRequest**| Update search redirect | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **redirectId** | [**string**] | Redirect\'s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**SearchRedirect**
+
+### 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 search redirect |  -  |
+|**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/SearchRedirect.md

@@ -0,0 +1,26 @@
+# SearchRedirect
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**searchTerm** | **string** |  | [default to undefined]
+**destinationUrl** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SearchRedirect } from '@teemill/website';
+
+const instance: SearchRedirect = {
+    id,
+    searchTerm,
+    destinationUrl,
+    createdAt,
+};
+```
+
+[[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/SearchRedirectsResponse.md

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

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

@@ -0,0 +1,22 @@
+# SeoOptimiseCollectionsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ids** | **Array<string>** | A set of collection IDs to AI SEO optimise. | [optional] [default to undefined]
+**fields** | **Array<string>** | If provided, only the specified fields will be updated. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeoOptimiseCollectionsRequest } from '@teemill/website';
+
+const instance: SeoOptimiseCollectionsRequest = {
+    ids,
+    fields,
+};
+```
+
+[[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/SeoOptimisePages202Response.md

@@ -0,0 +1,20 @@
+# SeoOptimisePages202Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message describing the optimisation status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeoOptimisePages202Response } from '@teemill/website';
+
+const instance: SeoOptimisePages202Response = {
+    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/SeoOptimisePagesRequest.md

@@ -0,0 +1,22 @@
+# SeoOptimisePagesRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ids** | **Array<string>** | A set of page IDs to AI SEO optimise. | [optional] [default to undefined]
+**fields** | **Array<string>** | If provided, only the specified fields will be updated. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeoOptimisePagesRequest } from '@teemill/website';
+
+const instance: SeoOptimisePagesRequest = {
+    ids,
+    fields,
+};
+```
+
+[[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/Stock.md

@@ -0,0 +1,20 @@
+# Stock
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**level** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Stock } from '@teemill/website';
+
+const instance: Stock = {
+    level,
+};
+```
+
+[[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/SubmenuInner.md

@@ -0,0 +1,32 @@
+# SubmenuInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**link** | **string** |  | [optional] [default to undefined]
+**image** | [**SubmenuInnerImage**](SubmenuInnerImage.md) |  | [default to undefined]
+**order** | **number** |  | [default to undefined]
+**items** | [**Array<SubmenuItem>**](SubmenuItem.md) |  | [default to undefined]
+**mode** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SubmenuInner } from '@teemill/website';
+
+const instance: SubmenuInner = {
+    id,
+    title,
+    link,
+    image,
+    order,
+    items,
+    mode,
+};
+```
+
+[[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/SubmenuInnerImage.md

@@ -0,0 +1,36 @@
+# SubmenuInnerImage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**src** | **string** |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**link** | **string** |  | [default to undefined]
+**overlay** | **boolean** |  | [default to false]
+**borderRadius** | **string** |  | [default to undefined]
+**ratio** | **string** |  | [default to undefined]
+**text** | [**SubmenuInnerImageText**](SubmenuInnerImageText.md) |  | [default to undefined]
+**button** | [**SubmenuInnerImageButton**](SubmenuInnerImageButton.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SubmenuInnerImage } from '@teemill/website';
+
+const instance: SubmenuInnerImage = {
+    src,
+    title,
+    description,
+    link,
+    overlay,
+    borderRadius,
+    ratio,
+    text,
+    button,
+};
+```
+
+[[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/SubmenuInnerImageButton.md

@@ -0,0 +1,30 @@
+# SubmenuInnerImageButton
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **string** |  | [default to undefined]
+**textColor** | **string** |  | [default to undefined]
+**backgroundColor** | **string** |  | [default to undefined]
+**borderColor** | **string** |  | [default to undefined]
+**borderRadius** | **string** |  | [default to undefined]
+**width** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SubmenuInnerImageButton } from '@teemill/website';
+
+const instance: SubmenuInnerImageButton = {
+    text,
+    textColor,
+    backgroundColor,
+    borderColor,
+    borderRadius,
+    width,
+};
+```
+
+[[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/SubmenuInnerImageText.md

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

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

@@ -0,0 +1,22 @@
+# TargetSearchPhraseData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**targetSearchPhrase** | **string** | The primary target search phrase for a page 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]
+
+## Example
+
+```typescript
+import { TargetSearchPhraseData } from '@teemill/website';
+
+const instance: TargetSearchPhraseData = {
+    targetSearchPhrase,
+    targetSearchPhraseSynonyms,
+};
+```
+
+[[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/UpdateBlogRequest.md

@@ -0,0 +1,30 @@
+# UpdateBlogRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Blog title | [optional] [default to undefined]
+**description** | **string** | Blog description | [optional] [default to undefined]
+**slug** | **string** | URL slug. This must be unique for each blog post on the website. Updating this will also break any existing links to this blog post. | [optional] [default to undefined]
+**seoMetadata** | [**UpdateBlogsRequestBlogsInnerSeoMetadata**](UpdateBlogsRequestBlogsInnerSeoMetadata.md) |  | [optional] [default to undefined]
+**targetSearchPhrase** | **string** | The primary target search phrase for the blog post 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]
+
+## Example
+
+```typescript
+import { UpdateBlogRequest } from '@teemill/website';
+
+const instance: UpdateBlogRequest = {
+    title,
+    description,
+    slug,
+    seoMetadata,
+    targetSearchPhrase,
+    targetSearchPhraseSynonyms,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)