@teemill/platform 0.14.4 → 0.16.0

package/docs/Option.md

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

@@ -0,0 +1,54 @@
+# Order
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
+**status** | [**OrderStatus**](OrderStatus.md) |  | [optional] [default to undefined]
+**contactInformation** | [**ContactInformation**](ContactInformation.md) |  | [default to undefined]
+**shippingAddress** | [**Address**](Address.md) |  | [default to undefined]
+**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+**updatedAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+**merchantReference** | **string** | A custom reference to the merchant\'s order that will be displayed on the shipping label. | [optional] [default to undefined]
+**fulfillments** | [**Array<Fulfillment>**](Fulfillment.md) |  | [optional] [readonly] [default to undefined]
+**items** | [**Array<OrderItem>**](OrderItem.md) |  | [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]
+**shippingPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**origin** | [**Origin**](Origin.md) |  | [optional] [default to undefined]
+**statusHistory** | [**Array<StatusHistoryItem>**](StatusHistoryItem.md) |  | [optional] [default to undefined]
+**project** | [**Project**](Project.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Order } from '@teemill/platform';
+
+const instance: Order = {
+    id,
+    ref,
+    status,
+    contactInformation,
+    shippingAddress,
+    createdAt,
+    updatedAt,
+    merchantReference,
+    fulfillments,
+    items,
+    totalPrice,
+    taxPrice,
+    subtotalPrice,
+    discountPrice,
+    shippingPrice,
+    origin,
+    statusHistory,
+    project,
+};
+```
+
+[[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

@@ -0,0 +1,42 @@
+# OrderItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [readonly] [default to undefined]
+**variantRef** | **string** | Reference URL to the order item variant | [default to undefined]
+**variant** | [**Variant**](Variant.md) |  | [default to undefined]
+**_options** | [**Array<Option>**](Option.md) | Options associated to an order item\'s variant, such as color and size. | [optional] [default to undefined]
+**quantity** | **number** |  | [default to undefined]
+**name** | **string** | The name of the product | [optional] [default to undefined]
+**images** | [**Array<Image>**](Image.md) | Images | [optional] [default to undefined]
+**totalPrice** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
+**taxPrice** | [**Price**](Price.md) | This is an estimate until the order has been confirmed | [optional] [readonly] [default to undefined]
+**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]
+
+## Example
+
+```typescript
+import { OrderItem } from '@teemill/platform';
+
+const instance: OrderItem = {
+    id,
+    variantRef,
+    variant,
+    _options,
+    quantity,
+    name,
+    images,
+    totalPrice,
+    taxPrice,
+    subtotalPrice,
+    discountPrice,
+    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/OrderStatus.md

@@ -0,0 +1,16 @@
+# OrderStatus
+
+
+## Enum
+
+* `New` (value: `'new'`)
+
+* `Paid` (value: `'paid'`)
+
+* `Processing` (value: `'processing'`)
+
+* `Complete` (value: `'complete'`)
+
+* `Refunded` (value: `'refunded'`)
+
+[[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/OrderTracking.md

@@ -0,0 +1,24 @@
+# OrderTracking
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**courier** | **string** |  | [optional] [default to undefined]
+**code** | **string** |  | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderTracking } from '@teemill/platform';
+
+const instance: OrderTracking = {
+    courier,
+    code,
+    url,
+};
+```
+
+[[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

@@ -0,0 +1,410 @@
+# OrdersApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**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|
+|[**listAvailableFulfillers**](#listavailablefulfillers) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers | List available fulfillers|
+|[**listOrders**](#listorders) | **GET** /v1/platform/{platformId}/orders | List orders|
+|[**updateFulfillment**](#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment|
+
+# **exportOrders**
+> File exportOrders()
+
+Export orders as a CSV file
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} 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 start: string; //Start of date range to filter by when orders were placed (default to undefined)
+let end: string; //End of date range to filter when orders were placed (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,
+    platformId,
+    start,
+    end,
+    search
+);
+```
+
+### 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 when orders were placed | defaults to undefined|
+| **end** | [**string**] | End of date range to filter when orders were placed | (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)
+
+# **getFulfillment**
+> Fulfillment getFulfillment()
+
+Get a fulfillment for a platform by a given fulfillment ID.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} 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 fulfillmentId: string; //The fulfillment identifier (default to undefined)
+
+const { status, data } = await apiInstance.getFulfillment(
+    project,
+    platformId,
+    fulfillmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **fulfillmentId** | [**string**] | The fulfillment identifier | defaults to undefined|
+
+
+### Return type
+
+**Fulfillment**
+
+### 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** | A fulfillment for an order |  -  |
+|**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)
+
+# **getOrder**
+> Order getOrder()
+
+Get an order for a platform by a given order ID.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} 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)
+
+const { status, data } = await apiInstance.getOrder(
+    project,
+    platformId,
+    orderId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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**: 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)
+
+# **listAvailableFulfillers**
+> FulfillersResponse listAvailableFulfillers()
+
+List available fulfillers for a given fulfillment
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} 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 fulfillmentId: string; //The fulfillment identifier (default to undefined)
+
+const { status, data } = await apiInstance.listAvailableFulfillers(
+    project,
+    platformId,
+    fulfillmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **fulfillmentId** | [**string**] | The fulfillment identifier | defaults to undefined|
+
+
+### Return type
+
+**FulfillersResponse**
+
+### 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 fulfillers for orders |  -  |
+|**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)
+
+# **listOrders**
+> OrdersResponse listOrders()
+
+Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} 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 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 start: string; //Start of date range to filter when orders were placed (optional) (default to undefined)
+let end: string; //End of date range to filter when orders were placed (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.listOrders(
+    project,
+    platformId,
+    pageToken,
+    pageSize,
+    search,
+    start,
+    end,
+    dateFilterType
+);
+```
+
+### 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 based on order reference, customer name and email | (optional) defaults to undefined|
+| **start** | [**string**] | Start of date range to filter when orders were placed | (optional) defaults to undefined|
+| **end** | [**string**] | End of date range to filter when orders were placed | (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 |  -  |
+|**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)
+
+# **updateFulfillment**
+> Fulfillment updateFulfillment(updateFulfillmentRequest)
+
+Update a fulfillment that belongs to an order placed through the platform
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    UpdateFulfillmentRequest
+} 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 fulfillmentId: string; //The fulfillment identifier (default to undefined)
+let updateFulfillmentRequest: UpdateFulfillmentRequest; //
+
+const { status, data } = await apiInstance.updateFulfillment(
+    project,
+    platformId,
+    fulfillmentId,
+    updateFulfillmentRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateFulfillmentRequest** | **UpdateFulfillmentRequest**|  | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **fulfillmentId** | [**string**] | The fulfillment identifier | defaults to undefined|
+
+
+### Return type
+
+**Fulfillment**
+
+### 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** | A fulfillment for an order |  -  |
+|**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** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrdersResponse } from '@teemill/platform';
+
+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/platform';
+
+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/PaymentAccount.md

@@ -0,0 +1,24 @@
+# PaymentAccount
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The name of the payment account | [default to undefined]
+**method** | **string** | The payment method | [default to undefined]
+**config** | **{ [key: string]: string; }** | The configuration for the payment account | [default to undefined]
+
+## Example
+
+```typescript
+import { PaymentAccount } from '@teemill/platform';
+
+const instance: PaymentAccount = {
+    name,
+    method,
+    config,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)