@teemill/website 0.20.0 → 0.21.0

package/docs/PagesApi.md

@@ -0,0 +1,378 @@
+# PagesApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**exportPages**](#exportpages) | **GET** /v1/website/pages/export | Export pages|
+|[**getPage**](#getpage) | **GET** /v1/website/pages/{pageId} | Get website page|
+|[**listPages**](#listpages) | **GET** /v1/website/pages | List website pages|
+|[**seoOptimisePages**](#seooptimisepages) | **POST** /v1/website/pages/ai-seo-optimise | AI SEO optimise pages|
+|[**updatePage**](#updatepage) | **PATCH** /v1/website/pages/{pageId} | Update website page|
+|[**updatePages**](#updatepages) | **PATCH** /v1/website/pages | Update website pages|
+
+# **exportPages**
+> File exportPages()
+
+Export pages as a CSV file.
+
+### Example
+
+```typescript
+import {
+    PagesApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new PagesApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+
+const { status, data } = await apiInstance.exportPages(
+    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)
+
+# **getPage**
+> Page getPage()
+
+
+### Example
+
+```typescript
+import {
+    PagesApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new PagesApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let pageId: string; //Page\'s unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.getPage(
+    project,
+    pageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **pageId** | [**string**] | Page\'s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**Page**
+
+### 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 page. |  -  |
+|**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)
+
+# **listPages**
+> PagesResponse listPages()
+
+
+### Example
+
+```typescript
+import {
+    PagesApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new PagesApi(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.listPages(
+    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
+
+**PagesResponse**
+
+### 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 pages. |  -  |
+|**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)
+
+# **seoOptimisePages**
+> SeoOptimisePages202Response seoOptimisePages()
+
+AI SEO optimises pages by a set of given IDs.
+
+### Example
+
+```typescript
+import {
+    PagesApi,
+    Configuration,
+    SeoOptimisePagesRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new PagesApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let seoOptimisePagesRequest: SeoOptimisePagesRequest; //A set of page IDs to AI SEO optimise. (optional)
+
+const { status, data } = await apiInstance.seoOptimisePages(
+    project,
+    seoOptimisePagesRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seoOptimisePagesRequest** | **SeoOptimisePagesRequest**| A set of page 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** | Pages 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)
+
+# **updatePage**
+> Page updatePage()
+
+
+### Example
+
+```typescript
+import {
+    PagesApi,
+    Configuration,
+    UpdatePageRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new PagesApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let pageId: string; //Page\'s unique identifier (default to undefined)
+let updatePageRequest: UpdatePageRequest; // (optional)
+
+const { status, data } = await apiInstance.updatePage(
+    project,
+    pageId,
+    updatePageRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updatePageRequest** | **UpdatePageRequest**|  | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **pageId** | [**string**] | Page\'s unique identifier | defaults to undefined|
+
+
+### Return type
+
+**Page**
+
+### 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 page. |  -  |
+|**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)
+
+# **updatePages**
+> PagesResponse updatePages()
+
+
+### Example
+
+```typescript
+import {
+    PagesApi,
+    Configuration,
+    UpdatePagesRequest
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new PagesApi(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 updatePagesRequest: UpdatePagesRequest; //Update pages in bulk. (optional)
+
+const { status, data } = await apiInstance.updatePages(
+    project,
+    pageToken,
+    pageSize,
+    search,
+    updatePagesRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updatePagesRequest** | **UpdatePagesRequest**| Update pages 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
+
+**PagesResponse**
+
+### 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 pages. |  -  |
+|**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/PagesResponse.md

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

@@ -0,0 +1,24 @@
+# PaymentAccount
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The name of the payment account | [default to undefined]
+**method** | **string** | The payment method | [default to undefined]
+**config** | **{ [key: string]: string; }** | The configuration for the payment account | [default to undefined]
+
+## Example
+
+```typescript
+import { PaymentAccount } from '@teemill/website';
+
+const instance: PaymentAccount = {
+    name,
+    method,
+    config,
+};
+```
+
+[[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/PaymentApi.md

@@ -0,0 +1,178 @@
+# PaymentApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**authorizeStripe**](#authorizestripe) | **GET** /v1/website/payment/stripe/authorize | Authorize Stripe|
+|[**deauthorizeStripe**](#deauthorizestripe) | **DELETE** /v1/website/payment/stripe/deauthorize | Deauthorize Stripe|
+|[**getStripePaymentAccount**](#getstripepaymentaccount) | **GET** /v1/website/payment/stripe | Get Stripe Payment Account|
+
+# **authorizeStripe**
+> AuthorizeStripe200Response authorizeStripe()
+
+Authorize a Stripe payment account
+
+### Example
+
+```typescript
+import {
+    PaymentApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new PaymentApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+
+const { status, data } = await apiInstance.authorizeStripe(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**AuthorizeStripe200Response**
+
+### 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** | Redirect to authorize Stripe |  -  |
+|**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)
+
+# **deauthorizeStripe**
+> deauthorizeStripe()
+
+Deauthorize a Stripe payment account
+
+### Example
+
+```typescript
+import {
+    PaymentApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new PaymentApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+
+const { status, data } = await apiInstance.deauthorizeStripe(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | 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** | Successfully deauthorized Stripe payment account |  -  |
+|**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)
+
+# **getStripePaymentAccount**
+> PaymentAccount getStripePaymentAccount()
+
+Get the Stripe payment account for the project
+
+### Example
+
+```typescript
+import {
+    PaymentApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+const apiInstance = new PaymentApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+
+const { status, data } = await apiInstance.getStripePaymentAccount(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**PaymentAccount**
+
+### 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 connected Stripe payment account |  -  |
+|**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/Price.md

@@ -0,0 +1,23 @@
+# Price
+
+Standard price definition that defines the amount, tax rate and currency.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **number** | Price including tax in the specified currency. | [optional] [default to undefined]
+**currencyCode** | **string** | Currency code for the currency the price is valued in. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Price } from '@teemill/website';
+
+const instance: Price = {
+    amount,
+    currencyCode,
+};
+```
+
+[[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/Product.md

@@ -0,0 +1,66 @@
+# Product
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
+**title** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**slug** | **string** |  | [optional] [readonly] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**seoMetadata** | [**SeoMetadata**](SeoMetadata.md) |  | [optional] [default to undefined]
+**tags** | **Array<string>** |  | [optional] [default to undefined]
+**internalTags** | **Array<string>** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**publishedAt** | **string** |  | [optional] [default to undefined]
+**images** | [**Array<Image>**](Image.md) | Images | [optional] [default to undefined]
+**videos** | [**Array<Video>**](Video.md) | Videos | [optional] [default to undefined]
+**variants** | [**Array<Variant>**](Variant.md) | Variants | [optional] [default to undefined]
+**additionalFiles** | [**Array<ProductAdditionalFilesInner>**](ProductAdditionalFilesInner.md) | Additional files attached to the product. | [optional] [default to undefined]
+**applicationSets** | [**Array<ProductApplicationSetsInner>**](ProductApplicationSetsInner.md) | List of application sets associated with this product | [optional] [default to undefined]
+**reviewScore** | **number** | The average review rating. This field is only present if included in the fields query parameter | [optional] [default to undefined]
+**reviewCount** | **number** | A count of reviews. This field is only present if included in the fields query parameter | [optional] [default to undefined]
+**sku** | **string** |  | [optional] [default to undefined]
+**sales** | **number** | A count of sales. This field is only present if included in the fields query parameter | [optional] [default to undefined]
+**includeInDataFeeds** | **boolean** |  | [optional] [default to undefined]
+**warehouseProduct** | [**ProductWarehouseProduct**](ProductWarehouseProduct.md) |  | [optional] [default to undefined]
+**metafields** | [**Array<MetaField>**](MetaField.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Product } from '@teemill/website';
+
+const instance: Product = {
+    id,
+    ref,
+    title,
+    description,
+    slug,
+    enabled,
+    seoMetadata,
+    tags,
+    internalTags,
+    createdAt,
+    updatedAt,
+    publishedAt,
+    images,
+    videos,
+    variants,
+    additionalFiles,
+    applicationSets,
+    reviewScore,
+    reviewCount,
+    sku,
+    sales,
+    includeInDataFeeds,
+    warehouseProduct,
+    metafields,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)