@teemill/platform 0.14.4 → 0.16.0

package/docs/ReviewsApi.md

@@ -0,0 +1,278 @@
+# ReviewsApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**exportReviews**](#exportreviews) | **GET** /v1/platform/{platformId}/reviews/export | Export reviews|
+|[**getReview**](#getreview) | **GET** /v1/platform/{platformId}/reviews/{reviewId} | Get review|
+|[**listReviews**](#listreviews) | **GET** /v1/platform/{platformId}/reviews | List reviews|
+|[**moderateReview**](#moderatereview) | **PATCH** /v1/platform/{platformId}/reviews/{reviewId}/moderate | Moderate review|
+
+# **exportReviews**
+> File exportReviews()
+
+Export reviews as a CSV file.
+
+### Example
+
+```typescript
+import {
+    ReviewsApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new ReviewsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let start: string; //Start of date range to filter by (default to undefined)
+let end: string; //End of date range to filter by (optional) (default to undefined)
+
+const { status, data } = await apiInstance.exportReviews(
+    project,
+    platformId,
+    start,
+    end
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **start** | [**string**] | Start of date range to filter by | defaults to undefined|
+| **end** | [**string**] | End of date range to filter by | (optional) 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)
+
+# **getReview**
+> Review getReview()
+
+Get a review left on a platform by a given review ID.
+
+### Example
+
+```typescript
+import {
+    ReviewsApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new ReviewsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let reviewId: string; //The review identifier (default to undefined)
+
+const { status, data } = await apiInstance.getReview(
+    project,
+    platformId,
+    reviewId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **reviewId** | [**string**] | The review identifier | defaults to undefined|
+
+
+### Return type
+
+**Review**
+
+### 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 review. |  -  |
+|**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)
+
+# **listReviews**
+> ReviewsResponse listReviews()
+
+List reviews left on projects belonging to this platform, paginated into configurable chunks.
+
+### Example
+
+```typescript
+import {
+    ReviewsApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new ReviewsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (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 sortBy: Array<string>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
+let start: string; //Start of date range to filter by (optional) (default to undefined)
+let end: string; //End of date range to filter by (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listReviews(
+    project,
+    platformId,
+    pageToken,
+    pageSize,
+    search,
+    sortBy,
+    start,
+    end
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | 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|
+| **sortBy** | **Array&lt;string&gt;** | An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending. | (optional) defaults to undefined|
+| **start** | [**string**] | Start of date range to filter by | (optional) defaults to undefined|
+| **end** | [**string**] | End of date range to filter by | (optional) defaults to undefined|
+
+
+### Return type
+
+**ReviewsResponse**
+
+### 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 reviews. |  -  |
+|**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)
+
+# **moderateReview**
+> Review moderateReview()
+
+Moderate a review left on a platform.
+
+### Example
+
+```typescript
+import {
+    ReviewsApi,
+    Configuration,
+    ModerateReviewRequest
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new ReviewsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let reviewId: string; //The review identifier (default to undefined)
+let moderateReviewRequest: ModerateReviewRequest; // (optional)
+
+const { status, data } = await apiInstance.moderateReview(
+    project,
+    platformId,
+    reviewId,
+    moderateReviewRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **moderateReviewRequest** | **ModerateReviewRequest**|  | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **reviewId** | [**string**] | The review identifier | defaults to undefined|
+
+
+### Return type
+
+**Review**
+
+### 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 review. |  -  |
+|**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/ReviewsResponse.md

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

@@ -0,0 +1,34 @@
+# ShippingMethod
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**deliveryEstimates** | [**DeliveryEstimates**](DeliveryEstimates.md) |  | [optional] [default to undefined]
+**totalPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**taxPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**subtotalPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**discountPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShippingMethod } from '@teemill/platform';
+
+const instance: ShippingMethod = {
+    id,
+    name,
+    description,
+    deliveryEstimates,
+    totalPrice,
+    taxPrice,
+    subtotalPrice,
+    discountPrice,
+};
+```
+
+[[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/Statistics.md

@@ -0,0 +1,24 @@
+# Statistics
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lifetimeValue** | **number** |  | [default to undefined]
+**totalOrderCount** | **number** |  | [default to undefined]
+**lastPurchased** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Statistics } from '@teemill/platform';
+
+const instance: Statistics = {
+    lifetimeValue,
+    totalOrderCount,
+    lastPurchased,
+};
+```
+
+[[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/StatusHistoryItem.md

@@ -0,0 +1,22 @@
+# StatusHistoryItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**OrderStatus**](OrderStatus.md) |  | [optional] [default to undefined]
+**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StatusHistoryItem } from '@teemill/platform';
+
+const instance: StatusHistoryItem = {
+    status,
+    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/UpdateFulfillmentRequest.md

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

@@ -0,0 +1,32 @@
+# UpdatePlatformRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**logos** | [**Array<PlatformLogo>**](PlatformLogo.md) |  | [optional] [default to undefined]
+**favicon** | **string** |  | [optional] [default to undefined]
+**clientGiftWrapAvailable** | **boolean** |  | [optional] [default to undefined]
+**storeSubscriptionFee** | **number** |  | [optional] [default to undefined]
+**orderHandlingFee** | **number** |  | [optional] [default to undefined]
+**itemHandlingFee** | **number** |  | [optional] [default to undefined]
+**chargeClients** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdatePlatformRequest } from '@teemill/platform';
+
+const instance: UpdatePlatformRequest = {
+    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/ValidationError.md

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

@@ -0,0 +1,24 @@
+# Variant
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**ref** | **string** | A reference to the resource location | [default to undefined]
+**warehouseVariantRef** | **string** | A reference to the resource location | [default to undefined]
+
+## Example
+
+```typescript
+import { Variant } from '@teemill/platform';
+
+const instance: Variant = {
+    id,
+    ref,
+    warehouseVariantRef,
+};
+```
+
+[[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/index.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.14.4
+ * The version of the OpenAPI document: 0.16.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/platform",
-  "version": "0.14.4",
+  "version": "0.16.0",
   "description": "OpenAPI client for @teemill/platform",
   "author": "OpenAPI-Generator Contributors",
   "repository": {