@teemill/platform 0.30.5 → 0.31.0

package/docs/BulkCreatedReviews.md

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

@@ -0,0 +1,42 @@
+# CreateReview201Response
+
+
+## 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]
+**reviews** | [**Array<Review>**](Review.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateReview201Response } from '@teemill/platform';
+
+const instance: CreateReview201Response = {
+    id,
+    text,
+    product,
+    author,
+    rating,
+    sentiment,
+    enabled,
+    createdAt,
+    project,
+    images,
+    replies,
+    reviews,
+};
+```
+
+[[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/CreateReviewPayload.md

@@ -0,0 +1,34 @@
+# CreateReviewPayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**author** | [**CreateReviewPayloadAuthor**](CreateReviewPayloadAuthor.md) |  | [default to undefined]
+**title** | **string** | The title of the review | [optional] [default to undefined]
+**text** | **string** | The text of the review | [default to undefined]
+**productRef** | **string** | A reference to the product being ordered | [default to undefined]
+**rating** | **number** | The rating of the review | [default to undefined]
+**images** | [**Array<Image>**](Image.md) |  | [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 false]
+**projectRef** | **string** | A reference to the project being ordered | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateReviewPayload } from '@teemill/platform';
+
+const instance: CreateReviewPayload = {
+    author,
+    title,
+    text,
+    productRef,
+    rating,
+    images,
+    enabled,
+    projectRef,
+};
+```
+
+[[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/CreateReviewPayloadAuthor.md

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

@@ -0,0 +1,36 @@
+# CreateReviewRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**author** | [**CreateReviewPayloadAuthor**](CreateReviewPayloadAuthor.md) |  | [default to undefined]
+**title** | **string** | The title of the review | [optional] [default to undefined]
+**text** | **string** | The text of the review | [default to undefined]
+**productRef** | **string** | A reference to the product being ordered | [default to undefined]
+**rating** | **number** | The rating of the review | [default to undefined]
+**images** | [**Array<Image>**](Image.md) |  | [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 false]
+**projectRef** | **string** | A reference to the project being ordered | [default to undefined]
+**reviews** | [**Array<CreateReviewPayload>**](CreateReviewPayload.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateReviewRequest } from '@teemill/platform';
+
+const instance: CreateReviewRequest = {
+    author,
+    title,
+    text,
+    productRef,
+    rating,
+    images,
+    enabled,
+    projectRef,
+    reviews,
+};
+```
+
+[[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/OrderItem.md

@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **subtotalPrice** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
 **discountPrice** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
 **recipientCost** | [**Price**](Price.md) | The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues. | [optional] [default to undefined]
+**amendmentLogs** | [**Array<AmendmentLog>**](AmendmentLog.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -36,6 +37,7 @@ const instance: OrderItem = {
     subtotalPrice,
     discountPrice,
     recipientCost,
+    amendmentLogs,
 };
 ```
 

package/docs/ReviewsApi.md

@@ -4,11 +4,92 @@ All URIs are relative to *https://localhost:8080*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**createReview**](#createreview) | **POST** /v1/platform/{platformId}/reviews | Create a review|
 |[**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|
 
+# **createReview**
+> CreateReview201Response createReview(createReviewRequest)
+
+
+### Example
+
+```typescript
+import {
+    ReviewsApi,
+    Configuration,
+    CreateReviewRequest
+} 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 createReviewRequest: CreateReviewRequest; //
+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.createReview(
+    project,
+    platformId,
+    createReviewRequest,
+    pageToken,
+    pageSize,
+    search,
+    sortBy,
+    start,
+    end
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createReviewRequest** | **CreateReviewRequest**|  | |
+| **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
+
+**CreateReview201Response**
+
+### 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 |
+|-------------|-------------|------------------|
+|**201** | Review created |  -  |
+|**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)
+
 # **exportReviews**
 > File exportReviews()
 

package/index.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.30.5
+ * The version of the OpenAPI document: 0.31.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.30.5",
+  "version": "0.31.0",
   "description": "OpenAPI client for @teemill/platform",
   "author": "OpenAPI-Generator Contributors",
   "repository": {