@teemill/platform 0.14.4 → 0.16.0

package/docs/PaymentApi.md

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

@@ -0,0 +1,38 @@
+# Platform
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**domains** | **Array<string>** |  | [default to undefined]
+**logos** | [**Array<PlatformLogo>**](PlatformLogo.md) |  | [default to undefined]
+**favicon** | **string** |  | [default to undefined]
+**clientGiftWrapAvailable** | **boolean** |  | [default to undefined]
+**storeSubscriptionFee** | **number** | The subscription fee for the platform | [default to undefined]
+**orderHandlingFee** | **number** | The order handling fee for the platform | [default to undefined]
+**itemHandlingFee** | **number** | The item handling fee for the platform | [default to undefined]
+**chargeClients** | **boolean** | Whether the platform can charge clients for orders | [default to undefined]
+
+## Example
+
+```typescript
+import { Platform } from '@teemill/platform';
+
+const instance: Platform = {
+    id,
+    name,
+    domains,
+    logos,
+    favicon,
+    clientGiftWrapAvailable,
+    storeSubscriptionFee,
+    orderHandlingFee,
+    itemHandlingFee,
+    chargeClients,
+};
+```
+
+[[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/PlatformApi.md

@@ -0,0 +1,122 @@
+# PlatformApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getPlatform**](#getplatform) | **GET** /v1/platform | Get platform details|
+|[**updatePlatform**](#updateplatform) | **PATCH** /v1/platform | Update platform|
+
+# **getPlatform**
+> Platform getPlatform()
+
+
+### Example
+
+```typescript
+import {
+    PlatformApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new PlatformApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.getPlatform(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+
+
+### Return type
+
+**Platform**
+
+### 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** | Platform details |  -  |
+|**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)
+
+# **updatePlatform**
+> Platform updatePlatform(updatePlatformRequest)
+
+
+### Example
+
+```typescript
+import {
+    PlatformApi,
+    Configuration,
+    UpdatePlatformRequest
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new PlatformApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let updatePlatformRequest: UpdatePlatformRequest; //
+
+const { status, data } = await apiInstance.updatePlatform(
+    project,
+    updatePlatformRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updatePlatformRequest** | **UpdatePlatformRequest**|  | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+
+
+### Return type
+
+**Platform**
+
+### 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** | Platform details |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**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/PlatformLogo.md

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

@@ -0,0 +1,23 @@
+# Price
+
+Standard price definition that defines the amount and currency.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **string** | 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/platform';
+
+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/Project.md

@@ -0,0 +1,22 @@
+# Project
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** | The name of the project | [default to undefined]
+
+## Example
+
+```typescript
+import { Project } from '@teemill/platform';
+
+const instance: Project = {
+    id,
+    name,
+};
+```
+
+[[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/Review.md

@@ -0,0 +1,40 @@
+# Review
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**text** | **string** | Text content of the review | [default to undefined]
+**product** | [**ReviewProduct**](ReviewProduct.md) |  | [optional] [default to undefined]
+**author** | [**ReviewAuthor**](ReviewAuthor.md) |  | [optional] [default to undefined]
+**rating** | **number** | Rating of the review | [optional] [default to undefined]
+**sentiment** | **number** | Google\'s sentiment analysis score | [optional] [default to undefined]
+**enabled** | **boolean** | Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public. | [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**project** | [**Project**](Project.md) |  | [default to undefined]
+**images** | [**Array<ReviewImagesInner>**](ReviewImagesInner.md) |  | [optional] [default to undefined]
+**replies** | [**Array<ReviewReply>**](ReviewReply.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Review } from '@teemill/platform';
+
+const instance: Review = {
+    id,
+    text,
+    product,
+    author,
+    rating,
+    sentiment,
+    enabled,
+    createdAt,
+    project,
+    images,
+    replies,
+};
+```
+
+[[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/ReviewAuthor.md

@@ -0,0 +1,22 @@
+# ReviewAuthor
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the review\'s author | [optional] [default to undefined]
+**email** | **string** | Email of the review\'s author | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReviewAuthor } from '@teemill/platform';
+
+const instance: ReviewAuthor = {
+    name,
+    email,
+};
+```
+
+[[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/ReviewImagesInner.md

@@ -0,0 +1,22 @@
+# ReviewImagesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**src** | **string** | URL of the image | [optional] [default to undefined]
+**alt** | **string** | Alternative text for the image | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReviewImagesInner } from '@teemill/platform';
+
+const instance: ReviewImagesInner = {
+    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/ReviewProduct.md

@@ -0,0 +1,23 @@
+# ReviewProduct
+
+The product that the review is for
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**title** | **string** | The title of the product | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReviewProduct } from '@teemill/platform';
+
+const instance: ReviewProduct = {
+    id,
+    title,
+};
+```
+
+[[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/ReviewReply.md

@@ -0,0 +1,26 @@
+# ReviewReply
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**text** | **string** | Text content of the reply | [default to undefined]
+**author** | [**ReviewReplyAuthor**](ReviewReplyAuthor.md) |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReviewReply } from '@teemill/platform';
+
+const instance: ReviewReply = {
+    id,
+    text,
+    author,
+    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/ReviewReplyAuthor.md

@@ -0,0 +1,20 @@
+# ReviewReplyAuthor
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the reply\'s author | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReviewReplyAuthor } from '@teemill/platform';
+
+const instance: ReviewReplyAuthor = {
+    name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)