@teemill/platform 0.51.1 → 0.53.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.
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
14
14
  **shippingMethod** | [**ShippingMethod**](ShippingMethod.md) | Shipping method currently set | [optional] [default to undefined]
15
15
  **availableShippingMethods** | [**Array<ShippingMethod>**](ShippingMethod.md) | Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment. | [optional] [default to undefined]
16
16
  **packageWeight** | **number** | Weight of the package being shipped in grams | [optional] [default to undefined]
17
+ **platformRef** | **string** | A reference to the resource location | [optional] [default to undefined]
17
18
 
18
19
  ## Example
19
20
 
@@ -30,6 +31,7 @@ const instance: Fulfillment = {
30
31
  shippingMethod,
31
32
  availableShippingMethods,
32
33
  packageWeight,
34
+ platformRef,
33
35
  };
34
36
  ```
35
37
 
package/docs/Order.md CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
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
11
  **approvalItemId** | **string** | | [optional] [default to undefined]
12
+ **customerRef** | **string** | | [default to undefined]
12
13
  **contactInformation** | [**ContactInformation**](ContactInformation.md) | | [default to undefined]
13
14
  **paymentMethod** | [**OrderPaymentMethod**](OrderPaymentMethod.md) | | [optional] [default to undefined]
14
15
  **shippingAddress** | [**Address**](Address.md) | | [default to undefined]
@@ -32,6 +33,8 @@ Name | Type | Description | Notes
32
33
  **integrationType** | **string** | The integration type of the order, e.g. \"website\" or \"shopify\" | [optional] [default to undefined]
33
34
  **chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
34
35
  **bulk** | **boolean** | Whether this order will go through the bulk production flow or not | [optional] [default to undefined]
36
+ **priorityLevel** | [**PriorityLevel**](PriorityLevel.md) | | [default to undefined]
37
+ **warnings** | **Array<string>** | | [optional] [default to undefined]
35
38
 
36
39
  ## Example
37
40
 
@@ -43,6 +46,7 @@ const instance: Order = {
43
46
  ref,
44
47
  status,
45
48
  approvalItemId,
49
+ customerRef,
46
50
  contactInformation,
47
51
  paymentMethod,
48
52
  shippingAddress,
@@ -66,6 +70,8 @@ const instance: Order = {
66
70
  integrationType,
67
71
  chatChannelRef,
68
72
  bulk,
73
+ priorityLevel,
74
+ warnings,
69
75
  };
70
76
  ```
71
77
 
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
+ |[**updateOrder**](#updateorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId} | Update order|
21
22
  |[**updatePlatformFulfillmentStyleApplication**](#updateplatformfulfillmentstyleapplication) | **PATCH** /v1/platform/{platformId}/styles/{styleId}/applications/{applicationId} | Update platform fulfillment style application|
22
23
 
23
24
  # **amendOrder**
@@ -934,6 +935,71 @@ const { status, data } = await apiInstance.updateFulfillment(
934
935
 
935
936
  [[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)
936
937
 
938
+ # **updateOrder**
939
+ > Order updateOrder()
940
+
941
+
942
+ ### Example
943
+
944
+ ```typescript
945
+ import {
946
+ OrdersApi,
947
+ Configuration,
948
+ UpdateOrderRequest
949
+ } from '@teemill/platform';
950
+
951
+ const configuration = new Configuration();
952
+ const apiInstance = new OrdersApi(configuration);
953
+
954
+ let project: string; //Project unique identifier (default to undefined)
955
+ let platformId: string; //The platform identifier (default to undefined)
956
+ let orderId: string; //The order identifier (default to undefined)
957
+ let updateOrderRequest: UpdateOrderRequest; // (optional)
958
+
959
+ const { status, data } = await apiInstance.updateOrder(
960
+ project,
961
+ platformId,
962
+ orderId,
963
+ updateOrderRequest
964
+ );
965
+ ```
966
+
967
+ ### Parameters
968
+
969
+ |Name | Type | Description | Notes|
970
+ |------------- | ------------- | ------------- | -------------|
971
+ | **updateOrderRequest** | **UpdateOrderRequest**| | |
972
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
973
+ | **platformId** | [**string**] | The platform identifier | defaults to undefined|
974
+ | **orderId** | [**string**] | The order identifier | defaults to undefined|
975
+
976
+
977
+ ### Return type
978
+
979
+ **Order**
980
+
981
+ ### Authorization
982
+
983
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
984
+
985
+ ### HTTP request headers
986
+
987
+ - **Content-Type**: application/json
988
+ - **Accept**: application/json
989
+
990
+
991
+ ### HTTP response details
992
+ | Status code | Description | Response headers |
993
+ |-------------|-------------|------------------|
994
+ |**200** | Order schema | - |
995
+ |**400** | Failed validation | - |
996
+ |**401** | Not authorised to access this resource | - |
997
+ |**403** | Refuse to authorize | - |
998
+ |**404** | Resource not found | - |
999
+ |**500** | Unknown server error | - |
1000
+
1001
+ [[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)
1002
+
937
1003
  # **updatePlatformFulfillmentStyleApplication**
938
1004
  > Application updatePlatformFulfillmentStyleApplication(updatePlatformFulfillmentStyleApplicationRequest)
939
1005
 
@@ -0,0 +1,10 @@
1
+ # PriorityLevel
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Standard` (value: `'standard'`)
7
+
8
+ * `Priority` (value: `'priority'`)
9
+
10
+ [[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,24 @@
1
+ # UpdateOrderRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **email** | **string** | | [optional] [default to undefined]
9
+ **shippingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
10
+ **priorityLevel** | [**PriorityLevel**](PriorityLevel.md) | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { UpdateOrderRequest } from '@teemill/platform';
16
+
17
+ const instance: UpdateOrderRequest = {
18
+ email,
19
+ shippingAddress,
20
+ priorityLevel,
21
+ };
22
+ ```
23
+
24
+ [[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
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.51.1
7
+ * The version of the OpenAPI document: 0.53.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.51.1",
3
+ "version": "0.53.0",
4
4
  "description": "OpenAPI client for @teemill/platform",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {