@teemill/website 0.20.0 → 0.22.0

package/docs/CollectionsApi.md

@@ -0,0 +1,378 @@
+# CollectionsApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**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|
+|[**seoOptimiseCollections**](#seooptimisecollections) | **POST** /v1/website/collections/ai-seo-optimise | AI SEO optimise collections|
+|[**updateCollection**](#updatecollection) | **PATCH** /v1/website/collections/{collectionId} | Update website collection|
+|[**updateCollections**](#updatecollections) | **PATCH** /v1/website/collections | Update website collections|
+
+# **exportCollections**
+> File exportCollections()
+
+Export collections as a CSV file.
+
+### 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)
+
+const { status, data } = await apiInstance.exportCollections(
+    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)
+
+# **getCollection**
+> Collection getCollection()
+
+
+### 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.getCollection(
+    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
+
+**Collection**
+
+### 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 collection. |  -  |
+|**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)
+
+# **listCollections**
+> CollectionsResponse listCollections()
+
+
+### 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 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.listCollections(
+    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
+
+**CollectionsResponse**
+
+### 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 collections. |  -  |
+|**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)
+
+# **seoOptimiseCollections**
+> SeoOptimisePages202Response seoOptimiseCollections()
+
+AI SEO optimises collections by a set of given IDs.
+
+### Example
+
+```typescript
+import {
+    CollectionsApi,
+    Configuration,
+    SeoOptimiseCollectionsRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let seoOptimiseCollectionsRequest: SeoOptimiseCollectionsRequest; //A set of collection IDs to AI SEO optimise. (optional)
+
+const { status, data } = await apiInstance.seoOptimiseCollections(
+    project,
+    seoOptimiseCollectionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seoOptimiseCollectionsRequest** | **SeoOptimiseCollectionsRequest**| A set of collection IDs to AI SEO optimise. | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**SeoOptimisePages202Response**
+
+### 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 |
+|-------------|-------------|------------------|
+|**202** | Collections queued for optimisation. |  -  |
+|**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)
+
+# **updateCollection**
+> Collection updateCollection()
+
+
+### Example
+
+```typescript
+import {
+    CollectionsApi,
+    Configuration,
+    UpdateCollectionRequest
+} 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)
+let updateCollectionRequest: UpdateCollectionRequest; // (optional)
+
+const { status, data } = await apiInstance.updateCollection(
+    project,
+    collectionId,
+    updateCollectionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateCollectionRequest** | **UpdateCollectionRequest**|  | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **collectionId** | [**string**] | Collection\'s unique identifier | 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 |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a website collection. |  -  |
+|**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)
+
+# **updateCollections**
+> CollectionsResponse updateCollections()
+
+
+### Example
+
+```typescript
+import {
+    CollectionsApi,
+    Configuration,
+    UpdateCollectionsRequest
+} 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 updateCollectionsRequest: UpdateCollectionsRequest; //Update collections in bulk. (optional)
+
+const { status, data } = await apiInstance.updateCollections(
+    project,
+    pageToken,
+    pageSize,
+    search,
+    updateCollectionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateCollectionsRequest** | **UpdateCollectionsRequest**| Update collections 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
+
+**CollectionsResponse**
+
+### 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 collections. |  -  |
+|**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/CollectionsResponse.md

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

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

@@ -0,0 +1,128 @@
+# CrossSellApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**attachCrossSellProducts**](#attachcrosssellproducts) | **PUT** /v1/website/products/{productId}/cross-sell/products | Attach cross-sell products|
+|[**getCrossSellProducts**](#getcrosssellproducts) | **GET** /v1/website/products/{productId}/cross-sell/products | Get cross-sell products linked to a product|
+
+# **attachCrossSellProducts**
+> Array<Product> attachCrossSellProducts()
+
+Attaches a list of products to the given product as cross-sell products.
+
+### Example
+
+```typescript
+import {
+    CrossSellApi,
+    Configuration,
+    AttachCrossSellProductsRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new CrossSellApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let productId: string; //Product\'s unique identifier (default to undefined)
+let attachCrossSellProductsRequest: AttachCrossSellProductsRequest; // (optional)
+
+const { status, data } = await apiInstance.attachCrossSellProducts(
+    project,
+    productId,
+    attachCrossSellProductsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **attachCrossSellProductsRequest** | **AttachCrossSellProductsRequest**|  | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **productId** | [**string**] | Product\&#39;s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**Array<Product>**
+
+### 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** | A list of the products that are attached as cross-sell products. |  -  |
+|**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)
+
+# **getCrossSellProducts**
+> Array<Product> getCrossSellProducts()
+
+
+### Example
+
+```typescript
+import {
+    CrossSellApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new CrossSellApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let productId: string; //Product\'s unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.getCrossSellProducts(
+    project,
+    productId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **productId** | [**string**] | Product\&#39;s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**Array<Product>**
+
+### 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 the products that are attached as cross-sell products. |  -  |
+|**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/DefaultApi.md

@@ -0,0 +1,123 @@
+# DefaultApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getBrand**](#getbrand) | **GET** /v1/website/brand | Get brand|
+|[**updateBrand**](#updatebrand) | **PATCH** /v1/website/brand | Update brand|
+
+# **getBrand**
+> Brand getBrand()
+
+Get the brand for the project
+
+### Example
+
+```typescript
+import {
+    DefaultApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new DefaultApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+
+const { status, data } = await apiInstance.getBrand(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**Brand**
+
+### 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** | Brand |  -  |
+|**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)
+
+# **updateBrand**
+> Brand updateBrand()
+
+Update the brand for the project
+
+### Example
+
+```typescript
+import {
+    DefaultApi,
+    Configuration,
+    UpdateBrandRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new DefaultApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let updateBrandRequest: UpdateBrandRequest; //Update brand request (optional)
+
+const { status, data } = await apiInstance.updateBrand(
+    project,
+    updateBrandRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateBrandRequest** | **UpdateBrandRequest**| Update brand request | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**Brand**
+
+### 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** | Brand |  -  |
+|**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/ExportPages202Response.md

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