@teemill/platform 0.19.0 → 0.21.0

package/docs/EnquiriesApi.md

@@ -0,0 +1,204 @@
+# EnquiriesApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**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|
+
+# **getCustomerEnquiry**
+> Enquiry getCustomerEnquiry()
+
+Get a customer enquiry
+
+### Example
+
+```typescript
+import {
+    EnquiriesApi,
+    Configuration
+} 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; // (default to undefined)
+
+const { status, data } = await apiInstance.getCustomerEnquiry(
+    project,
+    platformId,
+    enquiryId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **enquiryId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Enquiry**
+
+### 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 customer enquiry |  -  |
+|**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)
+
+# **listCustomerEnquiries**
+> ListCustomerEnquiries200Response listCustomerEnquiries()
+
+List customer enquiries
+
+### Example
+
+```typescript
+import {
+    EnquiriesApi,
+    Configuration
+} 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 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 enquiry title, content, customer name and customer email. (optional) (default to undefined)
+let start: string; //Start of date range to filter by (optional) (default to undefined)
+let end: string; //End of date range to filter by (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listCustomerEnquiries(
+    project,
+    platformId,
+    pageToken,
+    pageSize,
+    search,
+    start,
+    end
+);
+```
+
+### 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 enquiry title, content, customer name and customer email. | (optional) defaults to undefined|
+| **start** | [**string**] | Start of date range to filter by | (optional) defaults to undefined|
+| **end** | [**string**] | End of date range to filter by | (optional) defaults to undefined|
+
+
+### Return type
+
+**ListCustomerEnquiries200Response**
+
+### 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 list of customer enquiries |  -  |
+|**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)
+
+# **listCustomerEnquiryLogs**
+> ListCustomerEnquiryLogs200Response listCustomerEnquiryLogs()
+
+Lists all customer enquiry Logs
+
+### Example
+
+```typescript
+import {
+    EnquiriesApi,
+    Configuration
+} 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; // (default to undefined)
+
+const { status, data } = await apiInstance.listCustomerEnquiryLogs(
+    project,
+    platformId,
+    enquiryId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **enquiryId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ListCustomerEnquiryLogs200Response**
+
+### 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 list of customer enquiry logs belonging to the enquiry |  -  |
+|**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)
+

package/docs/Enquiry.md

@@ -0,0 +1,42 @@
+# Enquiry
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**ref** | **string** | API reference for the enquiry | [default to undefined]
+**customer** | [**ListCustomerEnquiryLogs200ResponseLogsInnerCustomer**](ListCustomerEnquiryLogs200ResponseLogsInnerCustomer.md) |  | [default to undefined]
+**client** | [**Client**](Client.md) |  | [default to undefined]
+**subject** | **string** |  | [default to undefined]
+**body** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+**tags** | **Array<string>** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**read** | **boolean** |  | [default to undefined]
+**extraInputs** | [**Array<EnquiryExtraInputsInner>**](EnquiryExtraInputsInner.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Enquiry } from '@teemill/platform';
+
+const instance: Enquiry = {
+    id,
+    ref,
+    customer,
+    client,
+    subject,
+    body,
+    createdAt,
+    updatedAt,
+    tags,
+    status,
+    read,
+    extraInputs,
+};
+```
+
+[[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/EnquiryExtraInputsInner.md

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

@@ -0,0 +1,18 @@
+# EnquiryExtraInputsInnerValue
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { EnquiryExtraInputsInnerValue } from '@teemill/platform';
+
+const instance: EnquiryExtraInputsInnerValue = {
+};
+```
+
+[[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/ListCustomerEnquiries200Response.md

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

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

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

@@ -0,0 +1,28 @@
+# ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**ref** | **string** | API reference for the customer | [optional] [default to undefined]
+**firstName** | **string** |  | [optional] [default to undefined]
+**lastName** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ListCustomerEnquiryLogs200ResponseLogsInnerCustomer } from '@teemill/platform';
+
+const instance: ListCustomerEnquiryLogs200ResponseLogsInnerCustomer = {
+    id,
+    ref,
+    firstName,
+    lastName,
+    email,
+};
+```
+
+[[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/SaveTermsRequest.md

@@ -0,0 +1,24 @@
+# SaveTermsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** |  | [default to undefined]
+**content** | **string** |  | [default to undefined]
+**enabled** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SaveTermsRequest } from '@teemill/platform';
+
+const instance: SaveTermsRequest = {
+    title,
+    content,
+    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)

package/docs/Terms.md

@@ -0,0 +1,32 @@
+# Terms
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**content** | **string** |  | [default to undefined]
+**version** | **number** |  | [default to undefined]
+**enabled** | **boolean** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Terms } from '@teemill/platform';
+
+const instance: Terms = {
+    id,
+    title,
+    content,
+    version,
+    enabled,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/TermsApi.md

@@ -0,0 +1,127 @@
+# TermsApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getTerms**](#getterms) | **GET** /v1/platform/{platformId}/terms | Get the platform\'s terms|
+|[**saveTerms**](#saveterms) | **POST** /v1/platform/{platformId}/terms | Save the platform\'s terms|
+
+# **getTerms**
+> Terms getTerms()
+
+
+### Example
+
+```typescript
+import {
+    TermsApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new TermsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+
+const { status, data } = await apiInstance.getTerms(
+    project,
+    platformId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+
+
+### Return type
+
+**Terms**
+
+### 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** | Successfully retrieved the terms. |  -  |
+|**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)
+
+# **saveTerms**
+> Terms saveTerms(saveTermsRequest)
+
+
+### Example
+
+```typescript
+import {
+    TermsApi,
+    Configuration,
+    SaveTermsRequest
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new TermsApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let saveTermsRequest: SaveTermsRequest; //Save terms
+
+const { status, data } = await apiInstance.saveTerms(
+    project,
+    platformId,
+    saveTermsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **saveTermsRequest** | **SaveTermsRequest**| Save terms | |
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+
+
+### Return type
+
+**Terms**
+
+### 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** | Successfully retrieved the terms. |  -  |
+|**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/index.ts

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