@teemill/platform 0.43.0 → 0.45.2
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 +9 -2
- package/api.ts +318 -2
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +25 -2
- package/dist/api.d.ts +178 -1
- package/dist/api.js +219 -4
- 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 +25 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +178 -1
- package/dist/esm/api.js +213 -2
- 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 +25 -1
- package/dist/esm/configuration.js +2 -2
- 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/Application.md +32 -0
- package/docs/AttachedFile.md +22 -0
- package/docs/ModerationApi.md +71 -0
- package/docs/Order.md +2 -0
- package/docs/OrderStatus.md +2 -0
- package/docs/OrdersApi.md +70 -0
- package/docs/PrintArea.md +23 -0
- package/docs/UpdateModerationItemRequest.md +22 -0
- package/docs/UpdatePlatformFulfillmentStyleApplicationRequest.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Application
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique object identifier | [optional] [default to undefined]
|
|
9
|
+
**styleId** | **string** | Unique object identifier | [optional] [default to undefined]
|
|
10
|
+
**placement** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**mockup** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**design** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**printArea** | [**PrintArea**](PrintArea.md) | | [optional] [default to undefined]
|
|
14
|
+
**files** | [**Array<AttachedFile>**](AttachedFile.md) | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { Application } from '@teemill/platform';
|
|
20
|
+
|
|
21
|
+
const instance: Application = {
|
|
22
|
+
id,
|
|
23
|
+
styleId,
|
|
24
|
+
placement,
|
|
25
|
+
mockup,
|
|
26
|
+
design,
|
|
27
|
+
printArea,
|
|
28
|
+
files,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AttachedFile
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**url** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AttachedFile } from '@teemill/platform';
|
|
15
|
+
|
|
16
|
+
const instance: AttachedFile = {
|
|
17
|
+
url,
|
|
18
|
+
name,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# ModerationApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**updateModerationItem**](#updatemoderationitem) | **PATCH** /v1/platform/moderate/{moderationItemId} | Update a moderation item|
|
|
8
|
+
|
|
9
|
+
# **updateModerationItem**
|
|
10
|
+
> updateModerationItem()
|
|
11
|
+
|
|
12
|
+
Update a moderation item
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
ModerationApi,
|
|
19
|
+
Configuration,
|
|
20
|
+
UpdateModerationItemRequest
|
|
21
|
+
} from '@teemill/platform';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new ModerationApi(configuration);
|
|
25
|
+
|
|
26
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
27
|
+
let moderationItemId: string; //The moderation item identifier (default to undefined)
|
|
28
|
+
let updateModerationItemRequest: UpdateModerationItemRequest; // (optional)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.updateModerationItem(
|
|
31
|
+
project,
|
|
32
|
+
moderationItemId,
|
|
33
|
+
updateModerationItemRequest
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
|Name | Type | Description | Notes|
|
|
40
|
+
|------------- | ------------- | ------------- | -------------|
|
|
41
|
+
| **updateModerationItemRequest** | **UpdateModerationItemRequest**| | |
|
|
42
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
43
|
+
| **moderationItemId** | [**string**] | The moderation item identifier | defaults to undefined|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
void (empty response body)
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: application/json
|
|
57
|
+
- **Accept**: application/json
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### HTTP response details
|
|
61
|
+
| Status code | Description | Response headers |
|
|
62
|
+
|-------------|-------------|------------------|
|
|
63
|
+
|**204** | Item has been moderated | - |
|
|
64
|
+
|**400** | Failed validation | - |
|
|
65
|
+
|**401** | Not authorised to access this resource | - |
|
|
66
|
+
|**403** | Refuse to authorize | - |
|
|
67
|
+
|**404** | Resource not found | - |
|
|
68
|
+
|**500** | Unknown server error | - |
|
|
69
|
+
|
|
70
|
+
[[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)
|
|
71
|
+
|
package/docs/Order.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | Unique object identifier | [optional] [default to undefined]
|
|
9
9
|
**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
|
|
10
10
|
**status** | [**OrderStatus**](OrderStatus.md) | | [optional] [default to undefined]
|
|
11
|
+
**approvalItemId** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**contactInformation** | [**ContactInformation**](ContactInformation.md) | | [default to undefined]
|
|
12
13
|
**shippingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
13
14
|
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
@@ -39,6 +40,7 @@ const instance: Order = {
|
|
|
39
40
|
id,
|
|
40
41
|
ref,
|
|
41
42
|
status,
|
|
43
|
+
approvalItemId,
|
|
42
44
|
contactInformation,
|
|
43
45
|
shippingAddress,
|
|
44
46
|
billingAddress,
|
package/docs/OrderStatus.md
CHANGED
package/docs/OrdersApi.md
CHANGED
|
@@ -18,6 +18,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
18
18
|
|[**returnOrder**](#returnorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId}/return | Return the contents of an order for a refund or exchange|
|
|
19
19
|
|[**sendOrderReceipt**](#sendorderreceipt) | **POST** /v1/platform/{platformId}/orders/{orderId}/receipt/send | Send order receipt|
|
|
20
20
|
|[**updateFulfillment**](#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment|
|
|
21
|
+
|[**updatePlatformFulfillmentStyleApplication**](#updateplatformfulfillmentstyleapplication) | **PATCH** /v1/platform/{platformId}/styles/{styleId}/applications/{applicationId} | Update platform fulfillment style application|
|
|
21
22
|
|
|
22
23
|
# **amendOrder**
|
|
23
24
|
> Order amendOrder(amendOrderRequest)
|
|
@@ -929,3 +930,72 @@ const { status, data } = await apiInstance.updateFulfillment(
|
|
|
929
930
|
|
|
930
931
|
[[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)
|
|
931
932
|
|
|
933
|
+
# **updatePlatformFulfillmentStyleApplication**
|
|
934
|
+
> Application updatePlatformFulfillmentStyleApplication(updatePlatformFulfillmentStyleApplicationRequest)
|
|
935
|
+
|
|
936
|
+
Update a fulfillment style application for a fulfillment for a platform order
|
|
937
|
+
|
|
938
|
+
### Example
|
|
939
|
+
|
|
940
|
+
```typescript
|
|
941
|
+
import {
|
|
942
|
+
OrdersApi,
|
|
943
|
+
Configuration,
|
|
944
|
+
UpdatePlatformFulfillmentStyleApplicationRequest
|
|
945
|
+
} from '@teemill/platform';
|
|
946
|
+
|
|
947
|
+
const configuration = new Configuration();
|
|
948
|
+
const apiInstance = new OrdersApi(configuration);
|
|
949
|
+
|
|
950
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
951
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
952
|
+
let styleId: string; //Unique identifier of a fulfillment style (default to undefined)
|
|
953
|
+
let applicationId: string; //Unique identifier of a fulfillment style application (default to undefined)
|
|
954
|
+
let updatePlatformFulfillmentStyleApplicationRequest: UpdatePlatformFulfillmentStyleApplicationRequest; //
|
|
955
|
+
|
|
956
|
+
const { status, data } = await apiInstance.updatePlatformFulfillmentStyleApplication(
|
|
957
|
+
project,
|
|
958
|
+
platformId,
|
|
959
|
+
styleId,
|
|
960
|
+
applicationId,
|
|
961
|
+
updatePlatformFulfillmentStyleApplicationRequest
|
|
962
|
+
);
|
|
963
|
+
```
|
|
964
|
+
|
|
965
|
+
### Parameters
|
|
966
|
+
|
|
967
|
+
|Name | Type | Description | Notes|
|
|
968
|
+
|------------- | ------------- | ------------- | -------------|
|
|
969
|
+
| **updatePlatformFulfillmentStyleApplicationRequest** | **UpdatePlatformFulfillmentStyleApplicationRequest**| | |
|
|
970
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
971
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
972
|
+
| **styleId** | [**string**] | Unique identifier of a fulfillment style | defaults to undefined|
|
|
973
|
+
| **applicationId** | [**string**] | Unique identifier of a fulfillment style application | defaults to undefined|
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
### Return type
|
|
977
|
+
|
|
978
|
+
**Application**
|
|
979
|
+
|
|
980
|
+
### Authorization
|
|
981
|
+
|
|
982
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
983
|
+
|
|
984
|
+
### HTTP request headers
|
|
985
|
+
|
|
986
|
+
- **Content-Type**: application/json
|
|
987
|
+
- **Accept**: application/json
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
### HTTP response details
|
|
991
|
+
| Status code | Description | Response headers |
|
|
992
|
+
|-------------|-------------|------------------|
|
|
993
|
+
|**200** | Fulfillment style application updated | - |
|
|
994
|
+
|**400** | Failed validation | - |
|
|
995
|
+
|**401** | Not authorised to access this resource | - |
|
|
996
|
+
|**403** | Refuse to authorize | - |
|
|
997
|
+
|**404** | Resource not found | - |
|
|
998
|
+
|**500** | Unknown server error | - |
|
|
999
|
+
|
|
1000
|
+
[[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)
|
|
1001
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# PrintArea
|
|
2
|
+
|
|
3
|
+
Print area dimensions in mm
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**width** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**height** | **number** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PrintArea } from '@teemill/platform';
|
|
16
|
+
|
|
17
|
+
const instance: PrintArea = {
|
|
18
|
+
width,
|
|
19
|
+
height,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UpdateModerationItemRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**judgement** | **string** | | [default to undefined]
|
|
9
|
+
**denialReason** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UpdateModerationItemRequest } from '@teemill/platform';
|
|
15
|
+
|
|
16
|
+
const instance: UpdateModerationItemRequest = {
|
|
17
|
+
judgement,
|
|
18
|
+
denialReason,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpdatePlatformFulfillmentStyleApplicationRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**design** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdatePlatformFulfillmentStyleApplicationRequest } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: UpdatePlatformFulfillmentStyleApplicationRequest = {
|
|
16
|
+
design,
|
|
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/index.ts
CHANGED