@teemill/platform 0.14.4 → 0.16.0

package/dist/esm/configuration.js

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

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.14.4
+ * The version of the OpenAPI document: 0.16.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.14.4
+ * The version of the OpenAPI document: 0.16.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.14.4
+ * The version of the OpenAPI document: 0.16.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/Address.md

@@ -0,0 +1,35 @@
+# Address
+
+A person\'s address.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contactName** | **string** |  | [default to undefined]
+**company** | **string** |  | [optional] [default to undefined]
+**line1** | **string** | First line of the address. | [default to undefined]
+**line2** | **string** | Second line of the address. | [optional] [default to undefined]
+**city** | **string** | City of the address. | [default to undefined]
+**postalCode** | **string** | Postal code of the address. | [optional] [default to undefined]
+**country** | **string** | Country of the address (ISO 3166-1 alpha-2). | [default to undefined]
+**state** | **string** | State of the address. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Address } from '@teemill/platform';
+
+const instance: Address = {
+    contactName,
+    company,
+    line1,
+    line2,
+    city,
+    postalCode,
+    country,
+    state,
+};
+```
+
+[[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/ApiError.md

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

@@ -0,0 +1,20 @@
+# AuthorizeStripe200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redirect_url** | **string** | The URL to redirect to | [default to undefined]
+
+## Example
+
+```typescript
+import { AuthorizeStripe200Response } from '@teemill/platform';
+
+const instance: AuthorizeStripe200Response = {
+    redirect_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/ContactInformation.md

@@ -0,0 +1,23 @@
+# ContactInformation
+
+Order recipient contact information, used only for courier tracking/updates.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ContactInformation } from '@teemill/platform';
+
+const instance: ContactInformation = {
+    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/Customer.md

@@ -0,0 +1,33 @@
+# Customer
+
+The customer that has placed an order on your platform
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**email** | **string** |  | [default to undefined]
+**firstName** | **string** |  | [default to undefined]
+**lastName** | **string** |  | [default to undefined]
+**gender** | **string** |  | [default to undefined]
+**country** | **string** |  | [default to undefined]
+**statistics** | [**Statistics**](Statistics.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Customer } from '@teemill/platform';
+
+const instance: Customer = {
+    id,
+    email,
+    firstName,
+    lastName,
+    gender,
+    country,
+    statistics,
+};
+```
+
+[[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/CustomersApi.md

@@ -0,0 +1,229 @@
+# CustomersApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**exportCustomers**](#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers|
+|[**getCustomer**](#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer|
+|[**listCustomers**](#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers|
+
+# **exportCustomers**
+> File exportCustomers()
+
+Export customers as a CSV file
+
+### Example
+
+```typescript
+import {
+    CustomersApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new CustomersApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let totalOrderCount: number; //Filter customers by total order count equal to the value provided (optional) (default to undefined)
+let lifetimeValue: number; //Filter customers by lifetime value less than or equal to the value provided (optional) (default to undefined)
+let sortBy: Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
+let lastPurchasedStart: string; //Start of date range to filter customers by last purchase date (optional) (default to undefined)
+let lastPurchasedEnd: string; //End of date range to filter customers by last purchase date (optional) (default to undefined)
+
+const { status, data } = await apiInstance.exportCustomers(
+    project,
+    platformId,
+    totalOrderCount,
+    lifetimeValue,
+    sortBy,
+    lastPurchasedStart,
+    lastPurchasedEnd
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **totalOrderCount** | [**number**] | Filter customers by total order count equal to the value provided | (optional) defaults to undefined|
+| **lifetimeValue** | [**number**] | Filter customers by lifetime value less than or equal to the value provided | (optional) defaults to undefined|
+| **sortBy** | **Array<&#39;+lifetimeValue&#39; &#124; &#39;-lifetimeValue&#39; &#124; &#39;+totalOrderCount&#39; &#124; &#39;-totalOrderCount&#39; &#124; &#39;+lastPurchased&#39; &#124; &#39;-lastPurchased&#39;>** | 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|
+| **lastPurchasedStart** | [**string**] | Start of date range to filter customers by last purchase date | (optional) defaults to undefined|
+| **lastPurchasedEnd** | [**string**] | End of date range to filter customers by last purchase date | (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)
+
+# **getCustomer**
+> Customer getCustomer()
+
+Get a customer for a platform by a given customer ID.
+
+### Example
+
+```typescript
+import {
+    CustomersApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new CustomersApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let customerId: string; //The customer identifier (default to undefined)
+
+const { status, data } = await apiInstance.getCustomer(
+    project,
+    platformId,
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **customerId** | [**string**] | The customer identifier | defaults to undefined|
+
+
+### Return type
+
+**Customer**
+
+### 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** | Customer response |  -  |
+|**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)
+
+# **listCustomers**
+> CustomersResponse listCustomers()
+
+List customers for a platform
+
+### Example
+
+```typescript
+import {
+    CustomersApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new CustomersApi(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 results (optional) (default to undefined)
+let sortBy: Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
+let totalOrderCount: number; //Filter customers by total order count equal to the value provided (optional) (default to undefined)
+let lifetimeValue: number; //Filter customers by lifetime value less than or equal to the value provided (optional) (default to undefined)
+let lastPurchasedStart: string; //Start of date range to filter customers by last purchase date (optional) (default to undefined)
+let lastPurchasedEnd: string; //End of date range to filter customers by last purchase date (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listCustomers(
+    project,
+    platformId,
+    pageToken,
+    pageSize,
+    search,
+    sortBy,
+    totalOrderCount,
+    lifetimeValue,
+    lastPurchasedStart,
+    lastPurchasedEnd
+);
+```
+
+### 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 results | (optional) defaults to undefined|
+| **sortBy** | **Array<&#39;+lifetimeValue&#39; &#124; &#39;-lifetimeValue&#39; &#124; &#39;+totalOrderCount&#39; &#124; &#39;-totalOrderCount&#39; &#124; &#39;+lastPurchased&#39; &#124; &#39;-lastPurchased&#39;>** | 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|
+| **totalOrderCount** | [**number**] | Filter customers by total order count equal to the value provided | (optional) defaults to undefined|
+| **lifetimeValue** | [**number**] | Filter customers by lifetime value less than or equal to the value provided | (optional) defaults to undefined|
+| **lastPurchasedStart** | [**string**] | Start of date range to filter customers by last purchase date | (optional) defaults to undefined|
+| **lastPurchasedEnd** | [**string**] | End of date range to filter customers by last purchase date | (optional) defaults to undefined|
+
+
+### Return type
+
+**CustomersResponse**
+
+### 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** | Customers response |  -  |
+|**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/CustomersResponse.md

@@ -0,0 +1,22 @@
+# CustomersResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customers** | [**Array<Customer>**](Customer.md) |  | [default to undefined]
+**nextPageToken** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomersResponse } from '@teemill/platform';
+
+const instance: CustomersResponse = {
+    customers,
+    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/DeliveryEstimates.md

@@ -0,0 +1,22 @@
+# DeliveryEstimates
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**min** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+**max** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeliveryEstimates } from '@teemill/platform';
+
+const instance: DeliveryEstimates = {
+    min,
+    max,
+};
+```
+
+[[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/ExportOrders202Response.md

@@ -0,0 +1,20 @@
+# ExportOrders202Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message describing the export status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ExportOrders202Response } from '@teemill/platform';
+
+const instance: ExportOrders202Response = {
+    message,
+};
+```
+
+[[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/Fulfiller.md

@@ -0,0 +1,23 @@
+# Fulfiller
+
+The fulfiller that will be processing this order.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**location** | [**FulfillerLocation**](FulfillerLocation.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Fulfiller } from '@teemill/platform';
+
+const instance: Fulfiller = {
+    id,
+    location,
+};
+```
+
+[[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/FulfillerLocation.md

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

@@ -0,0 +1,22 @@
+# FulfillersResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fulfillers** | [**Array<Fulfiller>**](Fulfiller.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FulfillersResponse } from '@teemill/platform';
+
+const instance: FulfillersResponse = {
+    fulfillers,
+    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/Fulfillment.md

@@ -0,0 +1,34 @@
+# Fulfillment
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique fulfillment id | [optional] [default to undefined]
+**status** | [**OrderStatus**](OrderStatus.md) |  | [optional] [default to undefined]
+**fulfiller** | [**Fulfiller**](Fulfiller.md) |  | [optional] [default to undefined]
+**items** | [**Array<FulfillmentItem>**](FulfillmentItem.md) |  | [optional] [default to undefined]
+**tracking** | [**OrderTracking**](OrderTracking.md) |  | [optional] [default to undefined]
+**shippingMethod** | [**ShippingMethod**](ShippingMethod.md) | Shipping method currently set | [optional] [default to undefined]
+**availableShippingMethods** | [**Array<ShippingMethod>**](ShippingMethod.md) | Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment. | [optional] [default to undefined]
+**packageWeight** | **number** | Weight of the package being shipped in grams | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Fulfillment } from '@teemill/platform';
+
+const instance: Fulfillment = {
+    id,
+    status,
+    fulfiller,
+    items,
+    tracking,
+    shippingMethod,
+    availableShippingMethods,
+    packageWeight,
+};
+```
+
+[[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/FulfillmentItem.md

@@ -0,0 +1,24 @@
+# FulfillmentItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique fulfillment item id | [optional] [default to undefined]
+**itemId** | **string** | Id of the order item being fulfilled | [optional] [default to undefined]
+**quantity** | **number** | Number of this item being fulfilled | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FulfillmentItem } from '@teemill/platform';
+
+const instance: FulfillmentItem = {
+    id,
+    itemId,
+    quantity,
+};
+```
+
+[[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/Image.md

@@ -0,0 +1,27 @@
+# Image
+
+Image description
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**src** | **string** |  | [optional] [default to undefined]
+**alt** | **string** |  | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Image } from '@teemill/platform';
+
+const instance: Image = {
+    id,
+    src,
+    alt,
+    sortOrder,
+};
+```
+
+[[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/ModerateReviewRequest.md

@@ -0,0 +1,20 @@
+# ModerateReviewRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **boolean** | Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ModerateReviewRequest } from '@teemill/platform';
+
+const instance: ModerateReviewRequest = {
+    enabled,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)