@teemill/platform 0.53.0 → 0.55.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 +7 -2
- package/api.ts +361 -2
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +193 -2
- package/dist/api.js +254 -1
- 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 +193 -2
- package/dist/esm/api.js +254 -1
- 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/Customer.md +2 -0
- package/docs/CustomersApi.md +190 -0
- package/docs/DataDeletionRequest.md +27 -0
- package/docs/Order.md +1 -1
- package/docs/UpdateCustomerRequest.md +26 -0
- package/docs/UpdateOrderRequest.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/docs/CustomersApi.md
CHANGED
|
@@ -5,10 +5,13 @@ All URIs are relative to *https://localhost:8080*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**createCustomerChatChannel**](#createcustomerchatchannel) | **POST** /v1/platform/{platformId}/customers/{customerId}/chat-channel | Create chat channel|
|
|
8
|
+
|[**createCustomerDataDeletionRequest**](#createcustomerdatadeletionrequest) | **POST** /v1/platform/{platformId}/customers/{customerId}/data-deletion-request | Create data deletion request|
|
|
8
9
|
|[**exportCustomers**](#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers|
|
|
9
10
|
|[**getCustomer**](#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer|
|
|
11
|
+
|[**getCustomerDataDeletionRequest**](#getcustomerdatadeletionrequest) | **GET** /v1/platform/{platformId}/customers/{customerId}/data-deletion-request | Get data deletion request|
|
|
10
12
|
|[**listCustomerTags**](#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags|
|
|
11
13
|
|[**listCustomers**](#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers|
|
|
14
|
+
|[**updateCustomer**](#updatecustomer) | **PATCH** /v1/platform/{platformId}/customers/{customerId} | Update the customer with the given customer ID|
|
|
12
15
|
|
|
13
16
|
# **createCustomerChatChannel**
|
|
14
17
|
> CreateOrderChatChannel200Response createCustomerChatChannel()
|
|
@@ -72,6 +75,67 @@ const { status, data } = await apiInstance.createCustomerChatChannel(
|
|
|
72
75
|
|
|
73
76
|
[[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)
|
|
74
77
|
|
|
78
|
+
# **createCustomerDataDeletionRequest**
|
|
79
|
+
> DataDeletionRequest createCustomerDataDeletionRequest()
|
|
80
|
+
|
|
81
|
+
Create a data deletion request for a customer
|
|
82
|
+
|
|
83
|
+
### Example
|
|
84
|
+
|
|
85
|
+
```typescript
|
|
86
|
+
import {
|
|
87
|
+
CustomersApi,
|
|
88
|
+
Configuration
|
|
89
|
+
} from '@teemill/platform';
|
|
90
|
+
|
|
91
|
+
const configuration = new Configuration();
|
|
92
|
+
const apiInstance = new CustomersApi(configuration);
|
|
93
|
+
|
|
94
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
95
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
96
|
+
let customerId: string; //The customer identifier (default to undefined)
|
|
97
|
+
|
|
98
|
+
const { status, data } = await apiInstance.createCustomerDataDeletionRequest(
|
|
99
|
+
project,
|
|
100
|
+
platformId,
|
|
101
|
+
customerId
|
|
102
|
+
);
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Parameters
|
|
106
|
+
|
|
107
|
+
|Name | Type | Description | Notes|
|
|
108
|
+
|------------- | ------------- | ------------- | -------------|
|
|
109
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
110
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
111
|
+
| **customerId** | [**string**] | The customer identifier | defaults to undefined|
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
### Return type
|
|
115
|
+
|
|
116
|
+
**DataDeletionRequest**
|
|
117
|
+
|
|
118
|
+
### Authorization
|
|
119
|
+
|
|
120
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
121
|
+
|
|
122
|
+
### HTTP request headers
|
|
123
|
+
|
|
124
|
+
- **Content-Type**: Not defined
|
|
125
|
+
- **Accept**: application/json
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
### HTTP response details
|
|
129
|
+
| Status code | Description | Response headers |
|
|
130
|
+
|-------------|-------------|------------------|
|
|
131
|
+
|**201** | Data deletion request | - |
|
|
132
|
+
|**401** | Not authorised to access this resource | - |
|
|
133
|
+
|**403** | Refuse to authorize | - |
|
|
134
|
+
|**404** | Resource not found | - |
|
|
135
|
+
|**500** | Unknown server error | - |
|
|
136
|
+
|
|
137
|
+
[[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)
|
|
138
|
+
|
|
75
139
|
# **exportCustomers**
|
|
76
140
|
> File exportCustomers()
|
|
77
141
|
|
|
@@ -242,6 +306,67 @@ const { status, data } = await apiInstance.getCustomer(
|
|
|
242
306
|
|
|
243
307
|
[[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)
|
|
244
308
|
|
|
309
|
+
# **getCustomerDataDeletionRequest**
|
|
310
|
+
> DataDeletionRequest getCustomerDataDeletionRequest()
|
|
311
|
+
|
|
312
|
+
Get a data deletion request for a customer
|
|
313
|
+
|
|
314
|
+
### Example
|
|
315
|
+
|
|
316
|
+
```typescript
|
|
317
|
+
import {
|
|
318
|
+
CustomersApi,
|
|
319
|
+
Configuration
|
|
320
|
+
} from '@teemill/platform';
|
|
321
|
+
|
|
322
|
+
const configuration = new Configuration();
|
|
323
|
+
const apiInstance = new CustomersApi(configuration);
|
|
324
|
+
|
|
325
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
326
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
327
|
+
let customerId: string; //The customer identifier (default to undefined)
|
|
328
|
+
|
|
329
|
+
const { status, data } = await apiInstance.getCustomerDataDeletionRequest(
|
|
330
|
+
project,
|
|
331
|
+
platformId,
|
|
332
|
+
customerId
|
|
333
|
+
);
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
### Parameters
|
|
337
|
+
|
|
338
|
+
|Name | Type | Description | Notes|
|
|
339
|
+
|------------- | ------------- | ------------- | -------------|
|
|
340
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
341
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
342
|
+
| **customerId** | [**string**] | The customer identifier | defaults to undefined|
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
### Return type
|
|
346
|
+
|
|
347
|
+
**DataDeletionRequest**
|
|
348
|
+
|
|
349
|
+
### Authorization
|
|
350
|
+
|
|
351
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
352
|
+
|
|
353
|
+
### HTTP request headers
|
|
354
|
+
|
|
355
|
+
- **Content-Type**: Not defined
|
|
356
|
+
- **Accept**: application/json
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
### HTTP response details
|
|
360
|
+
| Status code | Description | Response headers |
|
|
361
|
+
|-------------|-------------|------------------|
|
|
362
|
+
|**200** | Data deletion request | - |
|
|
363
|
+
|**401** | Not authorised to access this resource | - |
|
|
364
|
+
|**403** | Refuse to authorize | - |
|
|
365
|
+
|**404** | Resource not found | - |
|
|
366
|
+
|**500** | Unknown server error | - |
|
|
367
|
+
|
|
368
|
+
[[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)
|
|
369
|
+
|
|
245
370
|
# **listCustomerTags**
|
|
246
371
|
> ListCustomerTags200Response listCustomerTags()
|
|
247
372
|
|
|
@@ -426,3 +551,68 @@ const { status, data } = await apiInstance.listCustomers(
|
|
|
426
551
|
|
|
427
552
|
[[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)
|
|
428
553
|
|
|
554
|
+
# **updateCustomer**
|
|
555
|
+
> Customer updateCustomer()
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
### Example
|
|
559
|
+
|
|
560
|
+
```typescript
|
|
561
|
+
import {
|
|
562
|
+
CustomersApi,
|
|
563
|
+
Configuration,
|
|
564
|
+
UpdateCustomerRequest
|
|
565
|
+
} from '@teemill/platform';
|
|
566
|
+
|
|
567
|
+
const configuration = new Configuration();
|
|
568
|
+
const apiInstance = new CustomersApi(configuration);
|
|
569
|
+
|
|
570
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
571
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
572
|
+
let customerId: string; //The customer identifier (default to undefined)
|
|
573
|
+
let updateCustomerRequest: UpdateCustomerRequest; // (optional)
|
|
574
|
+
|
|
575
|
+
const { status, data } = await apiInstance.updateCustomer(
|
|
576
|
+
project,
|
|
577
|
+
platformId,
|
|
578
|
+
customerId,
|
|
579
|
+
updateCustomerRequest
|
|
580
|
+
);
|
|
581
|
+
```
|
|
582
|
+
|
|
583
|
+
### Parameters
|
|
584
|
+
|
|
585
|
+
|Name | Type | Description | Notes|
|
|
586
|
+
|------------- | ------------- | ------------- | -------------|
|
|
587
|
+
| **updateCustomerRequest** | **UpdateCustomerRequest**| | |
|
|
588
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
589
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
590
|
+
| **customerId** | [**string**] | The customer identifier | defaults to undefined|
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
### Return type
|
|
594
|
+
|
|
595
|
+
**Customer**
|
|
596
|
+
|
|
597
|
+
### Authorization
|
|
598
|
+
|
|
599
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
600
|
+
|
|
601
|
+
### HTTP request headers
|
|
602
|
+
|
|
603
|
+
- **Content-Type**: application/json
|
|
604
|
+
- **Accept**: application/json
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
### HTTP response details
|
|
608
|
+
| Status code | Description | Response headers |
|
|
609
|
+
|-------------|-------------|------------------|
|
|
610
|
+
|**200** | Customer response | - |
|
|
611
|
+
|**400** | Failed validation | - |
|
|
612
|
+
|**401** | Not authorised to access this resource | - |
|
|
613
|
+
|**403** | Refuse to authorize | - |
|
|
614
|
+
|**404** | Resource not found | - |
|
|
615
|
+
|**500** | Unknown server error | - |
|
|
616
|
+
|
|
617
|
+
[[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)
|
|
618
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# DataDeletionRequest
|
|
2
|
+
|
|
3
|
+
Data deletion request
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
10
|
+
**customerRef** | **string** | Reference to the customer resource | [default to undefined]
|
|
11
|
+
**requestedBy** | **string** | Reference to the user resource | [default to undefined]
|
|
12
|
+
**requestedAt** | **string** | ISO 8601 Timestamp | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { DataDeletionRequest } from '@teemill/platform';
|
|
18
|
+
|
|
19
|
+
const instance: DataDeletionRequest = {
|
|
20
|
+
id,
|
|
21
|
+
customerRef,
|
|
22
|
+
requestedBy,
|
|
23
|
+
requestedAt,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[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/Order.md
CHANGED
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**contactInformation** | [**ContactInformation**](ContactInformation.md) | | [default to undefined]
|
|
14
14
|
**paymentMethod** | [**OrderPaymentMethod**](OrderPaymentMethod.md) | | [optional] [default to undefined]
|
|
15
15
|
**shippingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
16
|
-
**billingAddress** | [**Address**](Address.md) | | [
|
|
16
|
+
**billingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
17
17
|
**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
|
|
18
18
|
**updatedAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
|
|
19
19
|
**merchantReference** | **string** | A custom reference to the merchant\'s order that will be displayed on the shipping label. | [optional] [default to undefined]
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UpdateCustomerRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
11
|
+
**shippingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { UpdateCustomerRequest } from '@teemill/platform';
|
|
17
|
+
|
|
18
|
+
const instance: UpdateCustomerRequest = {
|
|
19
|
+
email,
|
|
20
|
+
name,
|
|
21
|
+
billingAddress,
|
|
22
|
+
shippingAddress,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**email** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
9
10
|
**shippingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
10
11
|
**priorityLevel** | [**PriorityLevel**](PriorityLevel.md) | | [optional] [default to undefined]
|
|
11
12
|
|
|
@@ -16,6 +17,7 @@ import { UpdateOrderRequest } from '@teemill/platform';
|
|
|
16
17
|
|
|
17
18
|
const instance: UpdateOrderRequest = {
|
|
18
19
|
email,
|
|
20
|
+
billingAddress,
|
|
19
21
|
shippingAddress,
|
|
20
22
|
priorityLevel,
|
|
21
23
|
};
|
package/index.ts
CHANGED