@teemill/platform 0.39.0 → 0.41.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.
- package/README.md +5 -4
- package/api.ts +139 -22
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +77 -15
- package/dist/api.js +96 -14
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +77 -15
- package/dist/esm/api.js +96 -14
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/CreateOrderChatChannel200Response.md +20 -0
- package/docs/EnquiriesApi.md +5 -5
- package/docs/Order.md +2 -0
- package/docs/OrdersApi.md +63 -0
- package/docs/Platform.md +2 -0
- package/docs/UpdatePlatformRequest.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CreateOrderChatChannel200Response
|
|
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 { CreateOrderChatChannel200Response } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: CreateOrderChatChannel200Response = {
|
|
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,14 +4,14 @@ All URIs are relative to *https://localhost:8080*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
7
|
+
|[**createCustomerEnquiryChatChannel**](#createcustomerenquirychatchannel) | **POST** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel | Create chat channel|
|
|
8
8
|
|[**getCustomerEnquiry**](#getcustomerenquiry) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Get customer enquiry|
|
|
9
9
|
|[**listCustomerEnquiries**](#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries|
|
|
10
10
|
|[**listCustomerEnquiryLogs**](#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs|
|
|
11
11
|
|[**updateCustomerEnquiry**](#updatecustomerenquiry) | **PATCH** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Update customer enquiry|
|
|
12
12
|
|
|
13
|
-
# **
|
|
14
|
-
>
|
|
13
|
+
# **createCustomerEnquiryChatChannel**
|
|
14
|
+
> CreateOrderChatChannel200Response createCustomerEnquiryChatChannel()
|
|
15
15
|
|
|
16
16
|
Create a chat channel for a customer enquiry if it doesn\'t exist
|
|
17
17
|
|
|
@@ -30,7 +30,7 @@ let project: string; //Project unique identifier (default to undefined)
|
|
|
30
30
|
let platformId: string; //The platform identifier (default to undefined)
|
|
31
31
|
let enquiryId: string; //The enquiry identifier (default to undefined)
|
|
32
32
|
|
|
33
|
-
const { status, data } = await apiInstance.
|
|
33
|
+
const { status, data } = await apiInstance.createCustomerEnquiryChatChannel(
|
|
34
34
|
project,
|
|
35
35
|
platformId,
|
|
36
36
|
enquiryId
|
|
@@ -48,7 +48,7 @@ const { status, data } = await apiInstance.createChatChannel(
|
|
|
48
48
|
|
|
49
49
|
### Return type
|
|
50
50
|
|
|
51
|
-
**
|
|
51
|
+
**CreateOrderChatChannel200Response**
|
|
52
52
|
|
|
53
53
|
### Authorization
|
|
54
54
|
|
package/docs/Order.md
CHANGED
|
@@ -27,6 +27,7 @@ Name | Type | Description | Notes
|
|
|
27
27
|
**project** | [**Project**](Project.md) | | [default to undefined]
|
|
28
28
|
**paymentAttempts** | [**Array<PaymentAttempt>**](PaymentAttempt.md) | | [optional] [default to undefined]
|
|
29
29
|
**integrationType** | **string** | The integration type of the order, e.g. \"website\" or \"shopify\" | [optional] [default to undefined]
|
|
30
|
+
**chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
|
|
30
31
|
|
|
31
32
|
## Example
|
|
32
33
|
|
|
@@ -56,6 +57,7 @@ const instance: Order = {
|
|
|
56
57
|
project,
|
|
57
58
|
paymentAttempts,
|
|
58
59
|
integrationType,
|
|
60
|
+
chatChannelRef,
|
|
59
61
|
};
|
|
60
62
|
```
|
|
61
63
|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
7
7
|
|[**amendOrder**](#amendorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId}/amend | Amend the contents of an order|
|
|
8
8
|
|[**confirmOrder**](#confirmorder) | **POST** /v1/platform/{platformId}/orders/{orderId}/confirm | Confirm order|
|
|
9
9
|
|[**createOrder**](#createorder) | **POST** /v1/platform/{platformId}/orders | Create order|
|
|
10
|
+
|[**createOrderChatChannel**](#createorderchatchannel) | **POST** /v1/platform/{platformId}/orders/{orderId}/chat-channel | Create chat channel|
|
|
10
11
|
|[**exportOrders**](#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders|
|
|
11
12
|
|[**getFulfillment**](#getfulfillment) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Get fulfillment|
|
|
12
13
|
|[**getOrder**](#getorder) | **GET** /v1/platform/{platformId}/orders/{orderId} | Get order|
|
|
@@ -209,6 +210,68 @@ const { status, data } = await apiInstance.createOrder(
|
|
|
209
210
|
|
|
210
211
|
[[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)
|
|
211
212
|
|
|
213
|
+
# **createOrderChatChannel**
|
|
214
|
+
> CreateOrderChatChannel200Response createOrderChatChannel()
|
|
215
|
+
|
|
216
|
+
Create a chat channel for a platform order if it doesn\'t exist
|
|
217
|
+
|
|
218
|
+
### Example
|
|
219
|
+
|
|
220
|
+
```typescript
|
|
221
|
+
import {
|
|
222
|
+
OrdersApi,
|
|
223
|
+
Configuration
|
|
224
|
+
} from '@teemill/platform';
|
|
225
|
+
|
|
226
|
+
const configuration = new Configuration();
|
|
227
|
+
const apiInstance = new OrdersApi(configuration);
|
|
228
|
+
|
|
229
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
230
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
231
|
+
let orderId: string; //The order identifier (default to undefined)
|
|
232
|
+
|
|
233
|
+
const { status, data } = await apiInstance.createOrderChatChannel(
|
|
234
|
+
project,
|
|
235
|
+
platformId,
|
|
236
|
+
orderId
|
|
237
|
+
);
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### Parameters
|
|
241
|
+
|
|
242
|
+
|Name | Type | Description | Notes|
|
|
243
|
+
|------------- | ------------- | ------------- | -------------|
|
|
244
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
245
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
246
|
+
| **orderId** | [**string**] | The order identifier | defaults to undefined|
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
### Return type
|
|
250
|
+
|
|
251
|
+
**CreateOrderChatChannel200Response**
|
|
252
|
+
|
|
253
|
+
### Authorization
|
|
254
|
+
|
|
255
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
256
|
+
|
|
257
|
+
### HTTP request headers
|
|
258
|
+
|
|
259
|
+
- **Content-Type**: Not defined
|
|
260
|
+
- **Accept**: application/json
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
### HTTP response details
|
|
264
|
+
| Status code | Description | Response headers |
|
|
265
|
+
|-------------|-------------|------------------|
|
|
266
|
+
|**200** | Chat channel created | - |
|
|
267
|
+
|**400** | Failed validation | - |
|
|
268
|
+
|**401** | Not authorised to access this resource | - |
|
|
269
|
+
|**403** | Refuse to authorize | - |
|
|
270
|
+
|**404** | Resource not found | - |
|
|
271
|
+
|**500** | Unknown server error | - |
|
|
272
|
+
|
|
273
|
+
[[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)
|
|
274
|
+
|
|
212
275
|
# **exportOrders**
|
|
213
276
|
> File exportOrders()
|
|
214
277
|
|
package/docs/Platform.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**itemHandlingFee** | **number** | The item handling fee for the platform | [default to undefined]
|
|
17
17
|
**neckPrintFee** | **number** | The neck print fee for the platform | [default to undefined]
|
|
18
18
|
**chargeClients** | **boolean** | Whether the platform can charge clients for orders | [default to undefined]
|
|
19
|
+
**customerServiceEmail** | **string** | Recipient of customer service emails | [default to undefined]
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -34,6 +35,7 @@ const instance: Platform = {
|
|
|
34
35
|
itemHandlingFee,
|
|
35
36
|
neckPrintFee,
|
|
36
37
|
chargeClients,
|
|
38
|
+
customerServiceEmail,
|
|
37
39
|
};
|
|
38
40
|
```
|
|
39
41
|
|
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**itemHandlingFee** | **number** | | [optional] [default to undefined]
|
|
14
14
|
**neckPrintFee** | **number** | | [optional] [default to undefined]
|
|
15
15
|
**chargeClients** | **boolean** | | [optional] [default to undefined]
|
|
16
|
+
**customerServiceEmail** | **string** | | [optional] [default to undefined]
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -28,6 +29,7 @@ const instance: UpdatePlatformRequest = {
|
|
|
28
29
|
itemHandlingFee,
|
|
29
30
|
neckPrintFee,
|
|
30
31
|
chargeClients,
|
|
32
|
+
customerServiceEmail,
|
|
31
33
|
};
|
|
32
34
|
```
|
|
33
35
|
|
package/index.ts
CHANGED