@teemill/platform 0.27.0 → 0.28.0

package/dist/esm/index.js

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

package/dist/index.d.ts

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

package/dist/index.js

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

package/docs/ConfirmOrderFulfillment.md

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

@@ -0,0 +1,21 @@
+# ConfirmOrderFulfillmentShipment
+
+This field is only required if you are using your own shipping label.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | **string** | Only required if you are generating shipping labels outside of PodOS | [default to undefined]
+
+## Example
+
+```typescript
+import { ConfirmOrderFulfillmentShipment } from '@teemill/platform';
+
+const instance: ConfirmOrderFulfillmentShipment = {
+    image,
+};
+```
+
+[[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/ConfirmOrderRequest.md

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

@@ -0,0 +1,33 @@
+# CreateOrder
+
+Create an order
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchantReference** | **string** | A custom reference to the merchant\'s order. | [optional] [default to undefined]
+**contactInformation** | [**CreateOrderContactInformation**](CreateOrderContactInformation.md) |  | [default to undefined]
+**shippingAddress** | [**Address**](Address.md) |  | [default to undefined]
+**customsInformation** | [**CustomsInformation**](CustomsInformation.md) |  | [optional] [default to undefined]
+**items** | [**Array<OrderItem1>**](OrderItem1.md) | Items to be ordered | [default to undefined]
+**preferredFulfillers** | **Array<string>** |  | [optional] [default to undefined]
+**originalOrderRef** | **string** | A reference to the resource location | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateOrder } from '@teemill/platform';
+
+const instance: CreateOrder = {
+    merchantReference,
+    contactInformation,
+    shippingAddress,
+    customsInformation,
+    items,
+    preferredFulfillers,
+    originalOrderRef,
+};
+```
+
+[[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/CreateOrderContactInformation.md

@@ -0,0 +1,23 @@
+# CreateOrderContactInformation
+
+Contact information for the order
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateOrderContactInformation } from '@teemill/platform';
+
+const instance: CreateOrderContactInformation = {
+    email,
+    phone,
+};
+```
+
+[[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/CustomsInformation.md

@@ -0,0 +1,27 @@
+# CustomsInformation
+
+Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**preRegistrationType** | **string** | Pre-registration type | [optional] [default to undefined]
+**preRegistrationNumber** | **string** | Pre-registration number | [optional] [default to undefined]
+**vatNumber** | **string** | VAT number | [optional] [default to undefined]
+**eoriNumber** | **string** | EORI number | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomsInformation } from '@teemill/platform';
+
+const instance: CustomsInformation = {
+    preRegistrationType,
+    preRegistrationNumber,
+    vatNumber,
+    eoriNumber,
+};
+```
+
+[[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/OrderItem1.md

@@ -0,0 +1,24 @@
+# OrderItem1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
+**quantity** | **number** |  | [default to undefined]
+**recipientCost** | [**OrderItem1RecipientCost**](OrderItem1RecipientCost.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderItem1 } from '@teemill/platform';
+
+const instance: OrderItem1 = {
+    variantRef,
+    quantity,
+    recipientCost,
+};
+```
+
+[[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/OrderItem1RecipientCost.md

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

@@ -4,6 +4,8 @@ All URIs are relative to *https://localhost:8080*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**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|
 |[**getFulfillment**](#getfulfillment) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Get fulfillment|
 |[**getOrder**](#getorder) | **GET** /v1/platform/{platformId}/orders/{orderId} | Get order|
@@ -14,6 +16,132 @@ All URIs are relative to *https://localhost:8080*
 |[**sendOrderReceipt**](#sendorderreceipt) | **POST** /v1/platform/{platformId}/orders/{orderId}/receipt/send | Send order receipt|
 |[**updateFulfillment**](#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment|
 
+# **confirmOrder**
+> Order confirmOrder(confirmOrderRequest)
+
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    ConfirmOrderRequest
+} 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 confirmOrderRequest: ConfirmOrderRequest; //ConfirmFulfillment schema
+
+const { status, data } = await apiInstance.confirmOrder(
+    project,
+    platformId,
+    orderId,
+    confirmOrderRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **confirmOrderRequest** | **ConfirmOrderRequest**| ConfirmFulfillment 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)
+
+# **createOrder**
+> Order createOrder(createOrder)
+
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    CreateOrder
+} 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 createOrder: CreateOrder; //Create Order schema
+
+const { status, data } = await apiInstance.createOrder(
+    project,
+    platformId,
+    createOrder
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createOrder** | **CreateOrder**| Create Order schema | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform 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 |
+|-------------|-------------|------------------|
+|**201** | Order schema |  -  |
+|**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)
+
 # **exportOrders**
 > File exportOrders()
 

package/index.ts

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