@teemill/website 0.19.1 → 0.21.0

package/docs/Footer.md

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

@@ -0,0 +1,123 @@
+# FooterApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getFooter**](#getfooter) | **GET** /v1/website/footer | Get footer|
+|[**updateFooter**](#updatefooter) | **PUT** /v1/website/footer | Update footer|
+
+# **getFooter**
+> Array<Footer> getFooter()
+
+Get the footer for the project
+
+### Example
+
+```typescript
+import {
+    FooterApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new FooterApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+
+const { status, data } = await apiInstance.getFooter(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**Array<Footer>**
+
+### 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** | Footer |  -  |
+|**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)
+
+# **updateFooter**
+> Array<Footer> updateFooter()
+
+Update a footer
+
+### Example
+
+```typescript
+import {
+    FooterApi,
+    Configuration,
+    UpdateFooterRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new FooterApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let updateFooterRequest: UpdateFooterRequest; //Update footer (optional)
+
+const { status, data } = await apiInstance.updateFooter(
+    project,
+    updateFooterRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateFooterRequest** | **UpdateFooterRequest**| Update footer | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**Array<Footer>**
+
+### 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** | Footer |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**400** | Failed validation |  -  |
+|**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/FooterItem.md

@@ -0,0 +1,26 @@
+# FooterItem
+
+
+## Properties
+
+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]
+
+## Example
+
+```typescript
+import { FooterItem } from '@teemill/website';
+
+const instance: FooterItem = {
+    id,
+    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/Image.md

@@ -0,0 +1,35 @@
+# Image
+
+Image description
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**src** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**alt** | **string** |  | [optional] [default to undefined]
+**variantIds** | **Array<string>** | List of variant Ids | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Image } from '@teemill/website';
+
+const instance: Image = {
+    id,
+    src,
+    type,
+    alt,
+    variantIds,
+    sortOrder,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/ListRoutesResponse.md

@@ -0,0 +1,22 @@
+# ListRoutesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**routes** | [**Array<Route>**](Route.md) |  | [default to undefined]
+**nextPageToken** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListRoutesResponse } from '@teemill/website';
+
+const instance: ListRoutesResponse = {
+    routes,
+    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/Menu.md

@@ -0,0 +1,20 @@
+# Menu
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<MenuItem>**](MenuItem.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Menu } from '@teemill/website';
+
+const instance: Menu = {
+    items,
+};
+```
+
+[[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/MenuApi.md

@@ -0,0 +1,122 @@
+# MenuApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getMenu**](#getmenu) | **GET** /v1/website/menu | Get menu|
+|[**updateMenu**](#updatemenu) | **PUT** /v1/website/menu | Update menu|
+
+# **getMenu**
+> Menu getMenu()
+
+Get menu
+
+### Example
+
+```typescript
+import {
+    MenuApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new MenuApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+
+const { status, data } = await apiInstance.getMenu(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**Menu**
+
+### 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** | Website menu |  -  |
+|**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)
+
+# **updateMenu**
+> Menu updateMenu()
+
+Update menu
+
+### Example
+
+```typescript
+import {
+    MenuApi,
+    Configuration,
+    UpdateMenuRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new MenuApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let updateMenuRequest: UpdateMenuRequest; //Update menu request (optional)
+
+const { status, data } = await apiInstance.updateMenu(
+    project,
+    updateMenuRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateMenuRequest** | **UpdateMenuRequest**| Update menu request | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**Menu**
+
+### 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** | Website menu |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**422** | Failed validation |  -  |
+|**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/MenuItem.md

@@ -0,0 +1,32 @@
+# MenuItem
+
+
+## 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]
+**submenu** | [**Array<SubmenuInner>**](SubmenuInner.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MenuItem } from '@teemill/website';
+
+const instance: MenuItem = {
+    id,
+    text,
+    link,
+    color,
+    backgroundColor,
+    order,
+    submenu,
+};
+```
+
+[[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/MetaField.md

@@ -0,0 +1,23 @@
+# MetaField
+
+Key/value pairs that can be used to store additional information on the product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | The key of the property | [default to undefined]
+**value** | **string** | The string value of the property | [default to undefined]
+
+## Example
+
+```typescript
+import { MetaField } from '@teemill/website';
+
+const instance: MetaField = {
+    key,
+    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/MetaImage.md

@@ -0,0 +1,23 @@
+# MetaImage
+
+The image that will 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 { MetaImage } from '@teemill/website';
+
+const instance: MetaImage = {
+    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/ModerateReviewRequest.md

@@ -0,0 +1,20 @@
+# ModerateReviewRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **boolean** | Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ModerateReviewRequest } from '@teemill/website';
+
+const instance: ModerateReviewRequest = {
+    enabled,
+};
+```
+
+[[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/OptimisationHistoryItem.md

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

@@ -0,0 +1,36 @@
+# Page
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**legacyId** | **number** | The legacy ID of the page | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**slug** | **string** |  | [optional] [default to undefined]
+**targetSearchPhraseData** | [**TargetSearchPhraseData**](TargetSearchPhraseData.md) |  | [optional] [default to undefined]
+**optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the page | [optional] [default to undefined]
+**metaImage** | [**MetaImage**](MetaImage.md) |  | [optional] [default to undefined]
+**publishedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Page } from '@teemill/website';
+
+const instance: Page = {
+    id,
+    legacyId,
+    title,
+    description,
+    slug,
+    targetSearchPhraseData,
+    optimisationHistory,
+    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)