@teemill/platform 0.43.0 → 0.44.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,18 +2,30 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.43.0
5
+ * The version of the OpenAPI document: 0.44.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ interface AWSv4Configuration {
13
+ options?: {
14
+ region?: string;
15
+ service?: string;
16
+ };
17
+ credentials?: {
18
+ accessKeyId?: string;
19
+ secretAccessKey?: string;
20
+ sessionToken?: string;
21
+ };
22
+ }
12
23
  export interface ConfigurationParameters {
13
24
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
25
  username?: string;
15
26
  password?: string;
16
27
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
+ awsv4?: AWSv4Configuration;
17
29
  basePath?: string;
18
30
  serverIndex?: number;
19
31
  baseOptions?: any;
@@ -39,6 +51,17 @@ export declare class Configuration {
39
51
  * @param scopes oauth2 scope
40
52
  */
41
53
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
+ /**
55
+ * parameter for aws4 signature security
56
+ * @param {Object} AWS4Signature - AWS4 Signature security
57
+ * @param {string} options.region - aws region
58
+ * @param {string} options.service - name of the service.
59
+ * @param {string} credentials.accessKeyId - aws access key id
60
+ * @param {string} credentials.secretAccessKey - aws access key
61
+ * @param {string} credentials.sessionToken - aws session token
62
+ * @memberof Configuration
63
+ */
64
+ awsv4?: AWSv4Configuration;
42
65
  /**
43
66
  * override base path
44
67
  */
@@ -72,3 +95,4 @@ export declare class Configuration {
72
95
  */
73
96
  isJsonMime(mime: string): boolean;
74
97
  }
98
+ export {};
@@ -1,10 +1,9 @@
1
1
  /* tslint:disable */
2
- /* eslint-disable */
3
2
  /**
4
3
  * Platform API
5
4
  * Manage Your podOS platform
6
5
  *
7
- * The version of the OpenAPI document: 0.43.0
6
+ * The version of the OpenAPI document: 0.44.0
8
7
  *
9
8
  *
10
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,6 +17,7 @@ export class Configuration {
18
17
  this.username = param.username;
19
18
  this.password = param.password;
20
19
  this.accessToken = param.accessToken;
20
+ this.awsv4 = param.awsv4;
21
21
  this.basePath = param.basePath;
22
22
  this.serverIndex = param.serverIndex;
23
23
  this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.43.0
5
+ * The version of the OpenAPI document: 0.44.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.43.0
7
+ * The version of the OpenAPI document: 0.44.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.43.0
5
+ * The version of the OpenAPI document: 0.44.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.43.0
8
+ * The version of the OpenAPI document: 0.44.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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&lt;AttachedFile&gt;**](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)
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,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
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.43.0
7
+ * The version of the OpenAPI document: 0.44.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.43.0",
3
+ "version": "0.44.0",
4
4
  "description": "OpenAPI client for @teemill/platform",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {