@teemill/platform 0.52.0 → 0.54.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.
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.52.0
5
+ * The version of the OpenAPI document: 0.54.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.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.52.0
7
+ * The version of the OpenAPI document: 0.54.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.52.0
5
+ * The version of the OpenAPI document: 0.54.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.52.0
7
+ * The version of the OpenAPI document: 0.54.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.52.0
5
+ * The version of the OpenAPI document: 0.54.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Platform API
4
4
  * Manage Your podOS platform
5
5
  *
6
- * The version of the OpenAPI document: 0.52.0
6
+ * The version of the OpenAPI document: 0.54.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.52.0
5
+ * The version of the OpenAPI document: 0.54.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.52.0
7
+ * The version of the OpenAPI document: 0.54.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.52.0
5
+ * The version of the OpenAPI document: 0.54.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.52.0
8
+ * The version of the OpenAPI document: 0.54.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/docs/Customer.md CHANGED
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
14
14
  **country** | **string** | | [default to undefined]
15
15
  **statistics** | [**Statistics**](Statistics.md) | | [default to undefined]
16
16
  **shippingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
17
+ **billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
17
18
  **chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
18
19
 
19
20
  ## Example
@@ -30,6 +31,7 @@ const instance: Customer = {
30
31
  country,
31
32
  statistics,
32
33
  shippingAddress,
34
+ billingAddress,
33
35
  chatChannelRef,
34
36
  };
35
37
  ```
@@ -9,6 +9,7 @@ All URIs are relative to *https://localhost:8080*
9
9
  |[**getCustomer**](#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer|
10
10
  |[**listCustomerTags**](#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags|
11
11
  |[**listCustomers**](#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers|
12
+ |[**updateCustomer**](#updatecustomer) | **PATCH** /v1/platform/{platformId}/customers/{customerId} | Update the customer with the given customer ID|
12
13
 
13
14
  # **createCustomerChatChannel**
14
15
  > CreateOrderChatChannel200Response createCustomerChatChannel()
@@ -426,3 +427,68 @@ const { status, data } = await apiInstance.listCustomers(
426
427
 
427
428
  [[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
429
 
430
+ # **updateCustomer**
431
+ > Customer updateCustomer()
432
+
433
+
434
+ ### Example
435
+
436
+ ```typescript
437
+ import {
438
+ CustomersApi,
439
+ Configuration,
440
+ UpdateCustomerRequest
441
+ } from '@teemill/platform';
442
+
443
+ const configuration = new Configuration();
444
+ const apiInstance = new CustomersApi(configuration);
445
+
446
+ let project: string; //Project unique identifier (default to undefined)
447
+ let platformId: string; //The platform identifier (default to undefined)
448
+ let customerId: string; //The customer identifier (default to undefined)
449
+ let updateCustomerRequest: UpdateCustomerRequest; // (optional)
450
+
451
+ const { status, data } = await apiInstance.updateCustomer(
452
+ project,
453
+ platformId,
454
+ customerId,
455
+ updateCustomerRequest
456
+ );
457
+ ```
458
+
459
+ ### Parameters
460
+
461
+ |Name | Type | Description | Notes|
462
+ |------------- | ------------- | ------------- | -------------|
463
+ | **updateCustomerRequest** | **UpdateCustomerRequest**| | |
464
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
465
+ | **platformId** | [**string**] | The platform identifier | defaults to undefined|
466
+ | **customerId** | [**string**] | The customer identifier | defaults to undefined|
467
+
468
+
469
+ ### Return type
470
+
471
+ **Customer**
472
+
473
+ ### Authorization
474
+
475
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
476
+
477
+ ### HTTP request headers
478
+
479
+ - **Content-Type**: application/json
480
+ - **Accept**: application/json
481
+
482
+
483
+ ### HTTP response details
484
+ | Status code | Description | Response headers |
485
+ |-------------|-------------|------------------|
486
+ |**200** | Customer response | - |
487
+ |**400** | Failed validation | - |
488
+ |**401** | Not authorised to access this resource | - |
489
+ |**403** | Refuse to authorize | - |
490
+ |**404** | Resource not found | - |
491
+ |**500** | Unknown server error | - |
492
+
493
+ [[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)
494
+
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) | | [optional] [default to undefined]
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]
@@ -33,6 +33,8 @@ Name | Type | Description | Notes
33
33
  **integrationType** | **string** | The integration type of the order, e.g. \"website\" or \"shopify\" | [optional] [default to undefined]
34
34
  **chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
35
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]
36
38
 
37
39
  ## Example
38
40
 
@@ -68,6 +70,8 @@ const instance: Order = {
68
70
  integrationType,
69
71
  chatChannelRef,
70
72
  bulk,
73
+ priorityLevel,
74
+ warnings,
71
75
  };
72
76
  ```
73
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,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)
@@ -0,0 +1,26 @@
1
+ # UpdateOrderRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **email** | **string** | | [optional] [default to undefined]
9
+ **billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
10
+ **shippingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
11
+ **priorityLevel** | [**PriorityLevel**](PriorityLevel.md) | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { UpdateOrderRequest } from '@teemill/platform';
17
+
18
+ const instance: UpdateOrderRequest = {
19
+ email,
20
+ billingAddress,
21
+ shippingAddress,
22
+ priorityLevel,
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)
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.52.0
7
+ * The version of the OpenAPI document: 0.54.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.52.0",
3
+ "version": "0.54.0",
4
4
  "description": "OpenAPI client for @teemill/platform",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {