@teemill/orders 1.15.1 → 1.16.0

package/docs/OrdersApi.md

@@ -0,0 +1,475 @@
+# OrdersApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**cancelOrder**](#cancelorder) | **DELETE** /v1/orders/{orderId} | Cancel order|
+|[**confirmOrder**](#confirmorder) | **POST** /v1/orders/{orderId}/confirm | Confirm order|
+|[**createOrder**](#createorder) | **POST** /v1/orders | Create order|
+|[**exportOrders**](#exportorders) | **GET** /v1/orders/export | Export orders|
+|[**getOrder**](#getorder) | **GET** /v1/orders/{orderId} | Get order|
+|[**getOrders**](#getorders) | **GET** /v1/orders | List orders|
+|[**retryPlatformPayment**](#retryplatformpayment) | **POST** /v1/orders/{orderId}/retryPlatformPayment | Retry|
+
+# **cancelOrder**
+> cancelOrder()
+
+Cancels an order if it has not yet started processing.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@teemill/orders';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let orderId: string; //Unique identifier of an order (default to undefined)
+let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
+
+const { status, data } = await apiInstance.cancelOrder(
+    project,
+    orderId,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
+| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) 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** | Order has been cancelled |  -  |
+|**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)
+
+Confirms an order, and submits it as ready to take payment and begin processing.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    ConfirmOrderRequest
+} from '@teemill/orders';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let orderId: string; //Unique identifier of an order (default to undefined)
+let confirmOrderRequest: ConfirmOrderRequest; //ConfirmFulfillment schema
+let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
+
+const { status, data } = await apiInstance.confirmOrder(
+    project,
+    orderId,
+    confirmOrderRequest,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **confirmOrderRequest** | **ConfirmOrderRequest**| ConfirmFulfillment schema | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
+| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) 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)
+
+Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    CreateOrder
+} from '@teemill/orders';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let createOrder: CreateOrder; //Create Order schema
+let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
+
+const { status, data } = await apiInstance.createOrder(
+    project,
+    createOrder,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createOrder** | **CreateOrder**| Create Order schema | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) 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()
+
+Export orders as a CSV file
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@teemill/orders';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let start: string; //Start of date range to filter by when orders were placed (default to undefined)
+let end: string; //End of date range (optional) (default to undefined)
+let search: string; //Search term to filter based on order reference, customer name and email (optional) (default to undefined)
+
+const { status, data } = await apiInstance.exportOrders(
+    project,
+    start,
+    end,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **start** | [**string**] | Start of date range to filter by when orders were placed | defaults to undefined|
+| **end** | [**string**] | End of date range | (optional) defaults to undefined|
+| **search** | [**string**] | Search term to filter based on order reference, customer name and email | (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)
+
+# **getOrder**
+> Order getOrder()
+
+Get an order by a given ID.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@teemill/orders';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let orderId: string; //Unique identifier of an order (default to undefined)
+let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getOrder(
+    project,
+    orderId,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
+| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
+
+
+### Return type
+
+**Order**
+
+### 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** | 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)
+
+# **getOrders**
+> OrdersResponse getOrders()
+
+Lists all orders placed on this project, paginated into configurable chunks.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@teemill/orders';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let fields: string; //Specifies which fields to return, separated by commas (optional) (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 based on order reference, customer name and email (optional) (default to undefined)
+let ids: Array<string>; //Specify fulfillment IDs to list (optional) (default to undefined)
+let statuses: Array<Status>; //Filter by fulfillment status (optional) (default to undefined)
+let start: string; //Start of date range (optional) (default to undefined)
+let end: string; //End of date range (optional) (default to undefined)
+let dateFilterType: 'createdAt' | 'updatedAt' | 'statusChangedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
+
+const { status, data } = await apiInstance.getOrders(
+    project,
+    fields,
+    pageToken,
+    pageSize,
+    search,
+    ids,
+    statuses,
+    start,
+    end,
+    dateFilterType
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) 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 based on order reference, customer name and email | (optional) defaults to undefined|
+| **ids** | **Array&lt;string&gt;** | Specify fulfillment IDs to list | (optional) defaults to undefined|
+| **statuses** | **Array&lt;Status&gt;** | Filter by fulfillment status | (optional) defaults to undefined|
+| **start** | [**string**] | Start of date range | (optional) defaults to undefined|
+| **end** | [**string**] | End of date range | (optional) defaults to undefined|
+| **dateFilterType** | [**&#39;createdAt&#39; | &#39;updatedAt&#39; | &#39;statusChangedAt&#39;**]**Array<&#39;createdAt&#39; &#124; &#39;updatedAt&#39; &#124; &#39;statusChangedAt&#39;>** | Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query. | (optional) defaults to 'createdAt'|
+
+
+### Return type
+
+**OrdersResponse**
+
+### 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** | List of orders and pagination metadata |  -  |
+|**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)
+
+# **retryPlatformPayment**
+> Order retryPlatformPayment()
+
+Retries failed platform payment, so fulfillment can proceed.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@teemill/orders';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let orderId: string; //Unique identifier of an order (default to undefined)
+let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
+
+const { status, data } = await apiInstance.retryPlatformPayment(
+    project,
+    orderId,
+    fields
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
+| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
+
+
+### Return type
+
+**Order**
+
+### 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** | 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)
+

package/docs/OrdersResponse.md

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

@@ -0,0 +1,22 @@
+# Origin
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**isPaid** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Origin } from '@teemill/orders';
+
+const instance: Origin = {
+    code,
+    isPaid,
+};
+```
+
+[[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/PaymentAttempt.md

@@ -0,0 +1,32 @@
+# PaymentAttempt
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**invoiceId** | **string** | Unique object identifier | [optional] [default to undefined]
+**paymentMethodType** | **string** |  | [optional] [default to undefined]
+**status** | [**Status**](Status.md) |  | [optional] [default to undefined]
+**transactionId** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaymentAttempt } from '@teemill/orders';
+
+const instance: PaymentAttempt = {
+    id,
+    invoiceId,
+    paymentMethodType,
+    status,
+    transactionId,
+    message,
+    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/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/orders';
+
+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/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/orders';
+
+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/Status.md

@@ -0,0 +1,18 @@
+# Status
+
+
+## Enum
+
+* `New` (value: `'new'`)
+
+* `Paid` (value: `'paid'`)
+
+* `Processing` (value: `'processing'`)
+
+* `Complete` (value: `'complete'`)
+
+* `Refunded` (value: `'refunded'`)
+
+* `Quote` (value: `'quote'`)
+
+[[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** | [**Status**](Status.md) |  | [optional] [default to undefined]
+**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StatusHistoryItem } from '@teemill/orders';
+
+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/index.ts

@@ -4,7 +4,7 @@
  * Orders API
  * Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
  *
- * The version of the OpenAPI document: 1.15.1
+ * The version of the OpenAPI document: 1.16.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/orders",
-  "version": "1.15.1",
+  "version": "1.16.0",
   "description": "OpenAPI client for @teemill/orders",
   "author": "OpenAPI-Generator Contributors",
   "repository": {