@teemill/platform 0.22.2 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/README.md +7 -5
  2. package/api.ts +146 -10
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +88 -7
  7. package/dist/api.js +91 -8
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +1 -1
  14. package/dist/esm/api.d.ts +88 -7
  15. package/dist/esm/api.js +91 -8
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +1 -1
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/docs/CreateChatChannel200Response.md +20 -0
  27. package/docs/EnquiriesApi.md +67 -4
  28. package/docs/Enquiry.md +2 -0
  29. package/docs/PlatformApi.md +3 -3
  30. package/index.ts +1 -1
  31. package/package.json +1 -1
package/dist/esm/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.22.2
5
+ * The version of the OpenAPI document: 0.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.22.2
7
+ * The version of the OpenAPI document: 0.23.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.22.2
5
+ * The version of the OpenAPI document: 0.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Platform API
6
6
  * Manage Your podOS platform
7
7
  *
8
- * The version of the OpenAPI document: 0.22.2
8
+ * The version of the OpenAPI document: 0.23.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/docs/CreateChatChannel200Response.md ADDED
@@ -0,0 +1,20 @@
1
+ # CreateChatChannel200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **chatChannelRef** | **string** | Reference to the chat channel resource | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { CreateChatChannel200Response } from '@teemill/platform';
14
+
15
+ const instance: CreateChatChannel200Response = {
16
+ chatChannelRef,
17
+ };
18
+ ```
19
+
20
+ [[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/EnquiriesApi.md CHANGED
@@ -4,10 +4,73 @@ All URIs are relative to *https://localhost:8080*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**createChatChannel**](#createchatchannel) | **POST** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel | Create chat channel|
7
8
  |[**getCustomerEnquiry**](#getcustomerenquiry) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Get customer enquiry|
8
9
  |[**listCustomerEnquiries**](#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries|
9
10
  |[**listCustomerEnquiryLogs**](#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs|
10
11
 
12
+ # **createChatChannel**
13
+ > CreateChatChannel200Response createChatChannel()
14
+
15
+ Create a chat channel for a customer enquiry if it doesn\'t exist
16
+
17
+ ### Example
18
+
19
+ ```typescript
20
+ import {
21
+ EnquiriesApi,
22
+ Configuration
23
+ } from '@teemill/platform';
24
+
25
+ const configuration = new Configuration();
26
+ const apiInstance = new EnquiriesApi(configuration);
27
+
28
+ let project: string; //Project unique identifier (default to undefined)
29
+ let platformId: string; //The platform identifier (default to undefined)
30
+ let enquiryId: string; //The enquiry identifier (default to undefined)
31
+
32
+ const { status, data } = await apiInstance.createChatChannel(
33
+ project,
34
+ platformId,
35
+ enquiryId
36
+ );
37
+ ```
38
+
39
+ ### Parameters
40
+
41
+ |Name | Type | Description | Notes|
42
+ |------------- | ------------- | ------------- | -------------|
43
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
44
+ | **platformId** | [**string**] | The platform identifier | defaults to undefined|
45
+ | **enquiryId** | [**string**] | The enquiry identifier | defaults to undefined|
46
+
47
+
48
+ ### Return type
49
+
50
+ **CreateChatChannel200Response**
51
+
52
+ ### Authorization
53
+
54
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: Not defined
59
+ - **Accept**: application/json
60
+
61
+
62
+ ### HTTP response details
63
+ | Status code | Description | Response headers |
64
+ |-------------|-------------|------------------|
65
+ |**200** | Chat channel created | - |
66
+ |**400** | Failed validation | - |
67
+ |**401** | Not authorised to access this resource | - |
68
+ |**403** | Refuse to authorize | - |
69
+ |**404** | Resource not found | - |
70
+ |**500** | Unknown server error | - |
71
+
72
+ [[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)
73
+
11
74
  # **getCustomerEnquiry**
12
75
  > Enquiry getCustomerEnquiry()
13
76
 
@@ -26,7 +89,7 @@ const apiInstance = new EnquiriesApi(configuration);
26
89
 
27
90
  let project: string; //Project unique identifier (default to undefined)
28
91
  let platformId: string; //The platform identifier (default to undefined)
29
- let enquiryId: string; // (default to undefined)
92
+ let enquiryId: string; //The enquiry identifier (default to undefined)
30
93
 
31
94
  const { status, data } = await apiInstance.getCustomerEnquiry(
32
95
  project,
@@ -41,7 +104,7 @@ const { status, data } = await apiInstance.getCustomerEnquiry(
41
104
  |------------- | ------------- | ------------- | -------------|
42
105
  | **project** | [**string**] | Project unique identifier | defaults to undefined|
43
106
  | **platformId** | [**string**] | The platform identifier | defaults to undefined|
44
- | **enquiryId** | [**string**] | | defaults to undefined|
107
+ | **enquiryId** | [**string**] | The enquiry identifier | defaults to undefined|
45
108
 
46
109
 
47
110
  ### Return type
@@ -160,7 +223,7 @@ const apiInstance = new EnquiriesApi(configuration);
160
223
 
161
224
  let project: string; //Project unique identifier (default to undefined)
162
225
  let platformId: string; //The platform identifier (default to undefined)
163
- let enquiryId: string; // (default to undefined)
226
+ let enquiryId: string; //The enquiry identifier (default to undefined)
164
227
 
165
228
  const { status, data } = await apiInstance.listCustomerEnquiryLogs(
166
229
  project,
@@ -175,7 +238,7 @@ const { status, data } = await apiInstance.listCustomerEnquiryLogs(
175
238
  |------------- | ------------- | ------------- | -------------|
176
239
  | **project** | [**string**] | Project unique identifier | defaults to undefined|
177
240
  | **platformId** | [**string**] | The platform identifier | defaults to undefined|
178
- | **enquiryId** | [**string**] | | defaults to undefined|
241
+ | **enquiryId** | [**string**] | The enquiry identifier | defaults to undefined|
179
242
 
180
243
 
181
244
  ### Return type
package/docs/Enquiry.md CHANGED
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
17
17
  **status** | **string** | | [default to undefined]
18
18
  **read** | **boolean** | | [default to undefined]
19
19
  **extraInputs** | [**Array<EnquiryExtraInputsInner>**](EnquiryExtraInputsInner.md) | | [default to undefined]
20
+ **chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
20
21
 
21
22
  ## Example
22
23
 
@@ -36,6 +37,7 @@ const instance: Enquiry = {
36
37
  status,
37
38
  read,
38
39
  extraInputs,
40
+ chatChannelRef,
39
41
  };
40
42
  ```
41
43
 
package/docs/PlatformApi.md CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://localhost:8080*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createClientDomain**](#createclientdomain) | **POST** /v1/platform/clients/domains | Create a platform client domain|
7
+ |[**createClientDomain**](#createclientdomain) | **POST** /v1/platform/client/domains | Create a platform client domain|
8
8
  |[**createDomain**](#createdomain) | **POST** /v1/platform/domains | Create a platform domain|
9
- |[**deleteClientDomain**](#deleteclientdomain) | **DELETE** /v1/platform/clients/domains/{domain} | Delete a platform client domain|
9
+ |[**deleteClientDomain**](#deleteclientdomain) | **DELETE** /v1/platform/client/domains/{domain} | Delete a platform client domain|
10
10
  |[**deleteDomain**](#deletedomain) | **DELETE** /v1/platform/domains/{domain} | Delete a platform domain|
11
11
  |[**getPlatform**](#getplatform) | **GET** /v1/platform | Get platform details|
12
- |[**listClientDomains**](#listclientdomains) | **GET** /v1/platform/clients/domains | List platform client domains|
12
+ |[**listClientDomains**](#listclientdomains) | **GET** /v1/platform/client/domains | List platform client domains|
13
13
  |[**listDomains**](#listdomains) | **GET** /v1/platform/domains | List platform domains|
14
14
  |[**updatePlatform**](#updateplatform) | **PATCH** /v1/platform | Update platform|
15
15
 
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.22.2
7
+ * The version of the OpenAPI document: 0.23.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/platform",
3
- "version": "0.22.2",
3
+ "version": "0.23.0",
4
4
  "description": "OpenAPI client for @teemill/platform",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {