@teemill/platform 0.23.0 → 0.26.0

package/docs/CustomersApi.md

@@ -26,16 +26,22 @@ const apiInstance = new CustomersApi(configuration);
 
 let project: string; //Project unique identifier (default to undefined)
 let platformId: string; //The platform identifier (default to undefined)
+let countries: Array<string>; //Filter customers by country code (optional) (default to undefined)
+let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
 let totalOrderCount: number; //Filter customers by total order count equal to the value provided (optional) (default to undefined)
+let refundedOrderCount: number; //Filter customers by refunded 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 sortBy: Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+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,
+    countries,
+    gender,
     totalOrderCount,
+    refundedOrderCount,
     lifetimeValue,
     sortBy,
     lastPurchasedStart,
@@ -49,9 +55,12 @@ const { status, data } = await apiInstance.exportCustomers(
 |------------- | ------------- | ------------- | -------------|
 | **project** | [**string**] | Project unique identifier | defaults to undefined|
 | **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **countries** | **Array&lt;string&gt;** | Filter customers by country code | (optional) defaults to undefined|
+| **gender** | [**&#39;male&#39; | &#39;female&#39;**]**Array<&#39;male&#39; &#124; &#39;female&#39;>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
 | **totalOrderCount** | [**number**] | Filter customers by total order count equal to the value provided | (optional) defaults to undefined|
+| **refundedOrderCount** | [**number**] | Filter customers by refunded 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|
+| **sortBy** | **Array<&#39;+lifetimeValue&#39; &#124; &#39;-lifetimeValue&#39; &#124; &#39;+totalOrderCount&#39; &#124; &#39;-totalOrderCount&#39; &#124; &#39;+refundedOrderCount&#39; &#124; &#39;-refundedOrderCount&#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|
 
@@ -165,8 +174,11 @@ 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 sortBy: Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+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 countries: Array<string>; //Filter customers by country code (optional) (default to undefined)
+let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
 let totalOrderCount: number; //Filter customers by total order count equal to the value provided (optional) (default to undefined)
+let refundedOrderCount: number; //Filter customers by refunded 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)
@@ -178,7 +190,10 @@ const { status, data } = await apiInstance.listCustomers(
     pageSize,
     search,
     sortBy,
+    countries,
+    gender,
     totalOrderCount,
+    refundedOrderCount,
     lifetimeValue,
     lastPurchasedStart,
     lastPurchasedEnd
@@ -194,8 +209,11 @@ const { status, data } = await apiInstance.listCustomers(
 | **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|
+| **sortBy** | **Array<&#39;+lifetimeValue&#39; &#124; &#39;-lifetimeValue&#39; &#124; &#39;+totalOrderCount&#39; &#124; &#39;-totalOrderCount&#39; &#124; &#39;+refundedOrderCount&#39; &#124; &#39;-refundedOrderCount&#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|
+| **countries** | **Array&lt;string&gt;** | Filter customers by country code | (optional) defaults to undefined|
+| **gender** | [**&#39;male&#39; | &#39;female&#39;**]**Array<&#39;male&#39; &#124; &#39;female&#39;>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
 | **totalOrderCount** | [**number**] | Filter customers by total order count equal to the value provided | (optional) defaults to undefined|
+| **refundedOrderCount** | [**number**] | Filter customers by refunded 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|

package/docs/EnquiriesApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://localhost:8080*
 |[**getCustomerEnquiry**](#getcustomerenquiry) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Get customer enquiry|
 |[**listCustomerEnquiries**](#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries|
 |[**listCustomerEnquiryLogs**](#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs|
+|[**updateCustomerEnquiry**](#updatecustomerenquiry) | **PATCH** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Update customer enquiry|
 
 # **createChatChannel**
 > CreateChatChannel200Response createChatChannel()
@@ -265,3 +266,69 @@ const { status, data } = await apiInstance.listCustomerEnquiryLogs(
 
 [[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)
 
+# **updateCustomerEnquiry**
+> Enquiry updateCustomerEnquiry(updateCustomerEnquiryRequest)
+
+Update a customer enquiry
+
+### Example
+
+```typescript
+import {
+    EnquiriesApi,
+    Configuration,
+    UpdateCustomerEnquiryRequest
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new EnquiriesApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let enquiryId: string; //The enquiry identifier (default to undefined)
+let updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest; //Enquiry update
+
+const { status, data } = await apiInstance.updateCustomerEnquiry(
+    project,
+    platformId,
+    enquiryId,
+    updateCustomerEnquiryRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateCustomerEnquiryRequest** | **UpdateCustomerEnquiryRequest**| Enquiry update | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **enquiryId** | [**string**] | The enquiry identifier | defaults to undefined|
+
+
+### Return type
+
+**Enquiry**
+
+### 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** | Enquiry updated successfully |  -  |
+|**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/Enquiry.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **read** | **boolean** |  | [default to undefined]
 **extraInputs** | [**Array<EnquiryExtraInputsInner>**](EnquiryExtraInputsInner.md) |  | [default to undefined]
 **chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
+**owner** | **string** | The unique id of the user who owns the enquiry | [default to undefined]
 
 ## Example
 
@@ -38,6 +39,7 @@ const instance: Enquiry = {
     read,
     extraInputs,
     chatChannelRef,
+    owner,
 };
 ```
 

package/docs/Order.md

@@ -25,6 +25,7 @@ Name | Type | Description | Notes
 **statusHistory** | [**Array<StatusHistoryItem>**](StatusHistoryItem.md) |  | [optional] [default to undefined]
 **project** | [**Project**](Project.md) |  | [default to undefined]
 **paymentAttempts** | [**Array<PaymentAttempt>**](PaymentAttempt.md) |  | [optional] [default to undefined]
+**integrationType** | **string** | The integration type of the order, e.g. \"website\" or \"shopify\" | [optional] [default to undefined]
 
 ## Example
 
@@ -52,6 +53,7 @@ const instance: Order = {
     statusHistory,
     project,
     paymentAttempts,
+    integrationType,
 };
 ```
 

package/docs/OrdersApi.md

@@ -7,9 +7,11 @@ All URIs are relative to *https://localhost:8080*
 |[**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|
+|[**getOrderReceipt**](#getorderreceipt) | **GET** /v1/platform/{platformId}/orders/{orderId}/receipt | Get order receipt|
 |[**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|
+|[**sendOrderReceipt**](#sendorderreceipt) | **POST** /v1/platform/{platformId}/orders/{orderId}/receipt/send | Send order receipt|
 |[**updateFulfillment**](#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment|
 
 # **exportOrders**
@@ -204,6 +206,68 @@ const { status, data } = await apiInstance.getOrder(
 
 [[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)
 
+# **getOrderReceipt**
+> string getOrderReceipt()
+
+Get an order receipt 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.getOrderReceipt(
+    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
+
+**string**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/html, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Returns the order receipt as an HTML page |  -  |
+|**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()
 
@@ -405,6 +469,68 @@ const { status, data } = await apiInstance.retryPlatformPayment(
 
 [[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)
 
+# **sendOrderReceipt**
+> sendOrderReceipt()
+
+Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
+
+### 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.sendOrderReceipt(
+    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
+
+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** | Successfully sent order receipt to customer |  -  |
+|**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)
 

package/docs/Statistics.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **lifetimeValue** | **number** |  | [default to undefined]
 **totalOrderCount** | **number** |  | [default to undefined]
+**refundedOrderCount** | **number** |  | [default to undefined]
 **lastPurchased** | **string** |  | [default to undefined]
 
 ## Example
@@ -17,6 +18,7 @@ import { Statistics } from '@teemill/platform';
 const instance: Statistics = {
     lifetimeValue,
     totalOrderCount,
+    refundedOrderCount,
     lastPurchased,
 };
 ```

package/docs/UpdateCustomerEnquiryRequest.md

@@ -0,0 +1,20 @@
+# UpdateCustomerEnquiryRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**owner** | **string** | The unique id of the user who owns the enquiry | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateCustomerEnquiryRequest } from '@teemill/platform';
+
+const instance: UpdateCustomerEnquiryRequest = {
+    owner,
+};
+```
+
+[[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.23.0
+ * The version of the OpenAPI document: 0.26.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.23.0",
+  "version": "0.26.0",
   "description": "OpenAPI client for @teemill/platform",
   "author": "OpenAPI-Generator Contributors",
   "repository": {