@teemill/platform 0.29.2 → 0.30.1

package/docs/AmendOrderRequestAmendmentsInner.md

@@ -0,0 +1,26 @@
+# AmendOrderRequestAmendmentsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique order item identifier | [default to undefined]
+**action** | **string** |  | [default to undefined]
+**quantity** | **number** | The quantity of the item to refund or exchange. This must be less than or equal to the quantity of the item in the order. | [default to undefined]
+**newVariantRef** | **string** | A reference to the variant being ordered | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AmendOrderRequestAmendmentsInner } from '@teemill/platform';
+
+const instance: AmendOrderRequestAmendmentsInner = {
+    id,
+    action,
+    quantity,
+    newVariantRef,
+};
+```
+
+[[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/OrdersApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://localhost:8080*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**amendOrder**](#amendorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId}/amend | Amend the contents of an order|
 |[**confirmOrder**](#confirmorder) | **POST** /v1/platform/{platformId}/orders/{orderId}/confirm | Confirm order|
 |[**createOrder**](#createorder) | **POST** /v1/platform/{platformId}/orders | Create order|
 |[**exportOrders**](#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders|
@@ -13,9 +14,75 @@ All URIs are relative to *https://localhost:8080*
 |[**listAvailableFulfillers**](#listavailablefulfillers) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers | List available fulfillers|
 |[**listOrders**](#listorders) | **GET** /v1/platform/{platformId}/orders | List orders|
 |[**retryPlatformPayment**](#retryplatformpayment) | **POST** /v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment | Retry|
+|[**returnOrder**](#returnorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId}/return | Return the contents of an order for a refund or exchange|
 |[**sendOrderReceipt**](#sendorderreceipt) | **POST** /v1/platform/{platformId}/orders/{orderId}/receipt/send | Send order receipt|
 |[**updateFulfillment**](#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment|
 
+# **amendOrder**
+> Order amendOrder(amendOrderRequest)
+
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    AmendOrderRequest
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let orderId: string; //The order identifier (default to undefined)
+let amendOrderRequest: AmendOrderRequest; //AmendOrder schema
+
+const { status, data } = await apiInstance.amendOrder(
+    project,
+    platformId,
+    orderId,
+    amendOrderRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **amendOrderRequest** | **AmendOrderRequest**| AmendOrder schema | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **orderId** | [**string**] | The order identifier | defaults to undefined|
+
+
+### Return type
+
+**Order**
+
+### 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** | Order schema |  -  |
+|**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)
+
 # **confirmOrder**
 > Order confirmOrder(confirmOrderRequest)
 
@@ -591,6 +658,71 @@ const { status, data } = await apiInstance.retryPlatformPayment(
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order schema |  -  |
+|**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)
+
+# **returnOrder**
+> Order returnOrder(returnOrderRequest)
+
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    ReturnOrderRequest
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let orderId: string; //The order identifier (default to undefined)
+let returnOrderRequest: ReturnOrderRequest; //ReturnOrder schema
+
+const { status, data } = await apiInstance.returnOrder(
+    project,
+    platformId,
+    orderId,
+    returnOrderRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **returnOrderRequest** | **ReturnOrderRequest**| ReturnOrder schema | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **orderId** | [**string**] | The order identifier | defaults to undefined|
+
+
+### Return type
+
+**Order**
+
+### 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 |
 |-------------|-------------|------------------|

package/docs/ReturnOrderRequest.md

@@ -0,0 +1,20 @@
+# ReturnOrderRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**returns** | [**Array<AmendOrderRequestAmendmentsInner>**](AmendOrderRequestAmendmentsInner.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ReturnOrderRequest } from '@teemill/platform';
+
+const instance: ReturnOrderRequest = {
+    returns,
+};
+```
+
+[[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.29.2
+ * The version of the OpenAPI document: 0.30.1
  * 
  *
  * 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.29.2",
+  "version": "0.30.1",
   "description": "OpenAPI client for @teemill/platform",
   "author": "OpenAPI-Generator Contributors",
   "repository": {