@teemill/platform 0.26.0 → 0.28.0

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,6 +26,9 @@ import globalAxios from 'axios';
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
 // @ts-ignore
 import { BASE_PATH, BaseAPI, operationServerMap } from './base';
+export const CustomsInformationPreRegistrationTypeEnum = {
+    Ioss: 'IOSS'
+};
 export const EnquiryStatusEnum = {
     New: 'New',
     Archived: 'Archived',
@@ -954,6 +957,100 @@ export class EnquiriesApi extends BaseAPI {
  */
 export const OrdersApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         *
+         * @summary Confirm order
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        confirmOrder: (project_1, platformId_1, orderId_1, confirmOrderRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, confirmOrderRequest_1, ...args_1], void 0, function* (project, platformId, orderId, confirmOrderRequest, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('confirmOrder', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('confirmOrder', 'platformId', platformId);
+            // verify required parameter 'orderId' is not null or undefined
+            assertParamExists('confirmOrder', 'orderId', orderId);
+            // verify required parameter 'confirmOrderRequest' is not null or undefined
+            assertParamExists('confirmOrder', 'confirmOrderRequest', confirmOrderRequest);
+            const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/confirm`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
+                .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(confirmOrderRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Create order
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {CreateOrder} createOrder Create Order schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createOrder: (project_1, platformId_1, createOrder_1, ...args_1) => __awaiter(this, [project_1, platformId_1, createOrder_1, ...args_1], void 0, function* (project, platformId, createOrder, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('createOrder', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('createOrder', 'platformId', platformId);
+            // verify required parameter 'createOrder' is not null or undefined
+            assertParamExists('createOrder', 'createOrder', createOrder);
+            const localVarPath = `/v1/platform/{platformId}/orders`
+                .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(createOrder, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Export orders as a CSV file
          * @summary Export orders
@@ -1199,10 +1296,12 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
          * @param {string} [start] Start of date range to filter when orders were placed
          * @param {string} [end] End of date range to filter when orders were placed
          * @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
+         * @param {number} [maxOrderTotal] The maximum value of the order
+         * @param {number} [minOrderTotal] The minimum value of the order
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listOrders: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, start, end, dateFilterType, options = {}) {
+        listOrders: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options = {}) {
             // verify required parameter 'project' is not null or undefined
             assertParamExists('listOrders', 'project', project);
             // verify required parameter 'platformId' is not null or undefined
@@ -1248,6 +1347,12 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
             if (dateFilterType !== undefined) {
                 localVarQueryParameter['dateFilterType'] = dateFilterType;
             }
+            if (maxOrderTotal !== undefined) {
+                localVarQueryParameter['maxOrderTotal'] = maxOrderTotal;
+            }
+            if (minOrderTotal !== undefined) {
+                localVarQueryParameter['minOrderTotal'] = minOrderTotal;
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -1402,6 +1507,43 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
 export const OrdersApiFp = function (configuration) {
     const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration);
     return {
+        /**
+         *
+         * @summary Confirm order
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        confirmOrder(project, platformId, orderId, confirmOrderRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.confirmOrder(project, platformId, orderId, confirmOrderRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.confirmOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         *
+         * @summary Create order
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {CreateOrder} createOrder Create Order schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createOrder(project, platformId, createOrder, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createOrder(project, platformId, createOrder, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.createOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Export orders as a CSV file
          * @summary Export orders
@@ -1505,13 +1647,15 @@ export const OrdersApiFp = function (configuration) {
          * @param {string} [start] Start of date range to filter when orders were placed
          * @param {string} [end] End of date range to filter when orders were placed
          * @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
+         * @param {number} [maxOrderTotal] The maximum value of the order
+         * @param {number} [minOrderTotal] The minimum value of the order
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, options) {
+        listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrdersApi.listOrders']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1581,6 +1725,26 @@ export const OrdersApiFp = function (configuration) {
 export const OrdersApiFactory = function (configuration, basePath, axios) {
     const localVarFp = OrdersApiFp(configuration);
     return {
+        /**
+         *
+         * @summary Confirm order
+         * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        confirmOrder(requestParameters, options) {
+            return localVarFp.confirmOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.confirmOrderRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Create order
+         * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createOrder(requestParameters, options) {
+            return localVarFp.createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(axios, basePath));
+        },
         /**
          * Export orders as a CSV file
          * @summary Export orders
@@ -1639,7 +1803,7 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         listOrders(requestParameters, options) {
-            return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
+            return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(axios, basePath));
         },
         /**
          * Retries failed platform payment, so fulfillment can proceed.
@@ -1680,6 +1844,28 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
  * @extends {BaseAPI}
  */
 export class OrdersApi extends BaseAPI {
+    /**
+     *
+     * @summary Confirm order
+     * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    confirmOrder(requestParameters, options) {
+        return OrdersApiFp(this.configuration).confirmOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.confirmOrderRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Create order
+     * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    createOrder(requestParameters, options) {
+        return OrdersApiFp(this.configuration).createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Export orders as a CSV file
      * @summary Export orders
@@ -1744,7 +1930,7 @@ export class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     listOrders(requestParameters, options) {
-        return OrdersApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
+        return OrdersApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Retries failed platform payment, so fulfillment can proceed.

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.26.0
+ * The version of the OpenAPI document: 0.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/ConfirmOrderFulfillment.md

@@ -0,0 +1,24 @@
+# ConfirmOrderFulfillment
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fulfillmentId** | **string** | Unique object identifier | [default to undefined]
+**shippingMethodId** | **string** | Unique object identifier | [optional] [default to undefined]
+**shipment** | [**ConfirmOrderFulfillmentShipment**](ConfirmOrderFulfillmentShipment.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConfirmOrderFulfillment } from '@teemill/platform';
+
+const instance: ConfirmOrderFulfillment = {
+    fulfillmentId,
+    shippingMethodId,
+    shipment,
+};
+```
+
+[[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/ConfirmOrderFulfillmentShipment.md

@@ -0,0 +1,21 @@
+# ConfirmOrderFulfillmentShipment
+
+This field is only required if you are using your own shipping label.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | **string** | Only required if you are generating shipping labels outside of PodOS | [default to undefined]
+
+## Example
+
+```typescript
+import { ConfirmOrderFulfillmentShipment } from '@teemill/platform';
+
+const instance: ConfirmOrderFulfillmentShipment = {
+    image,
+};
+```
+
+[[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/ConfirmOrderRequest.md

@@ -0,0 +1,20 @@
+# ConfirmOrderRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fulfillments** | [**Array<ConfirmOrderFulfillment>**](ConfirmOrderFulfillment.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ConfirmOrderRequest } from '@teemill/platform';
+
+const instance: ConfirmOrderRequest = {
+    fulfillments,
+};
+```
+
+[[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/CreateOrder.md

@@ -0,0 +1,33 @@
+# CreateOrder
+
+Create an order
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchantReference** | **string** | A custom reference to the merchant\'s order. | [optional] [default to undefined]
+**contactInformation** | [**CreateOrderContactInformation**](CreateOrderContactInformation.md) |  | [default to undefined]
+**shippingAddress** | [**Address**](Address.md) |  | [default to undefined]
+**customsInformation** | [**CustomsInformation**](CustomsInformation.md) |  | [optional] [default to undefined]
+**items** | [**Array<OrderItem1>**](OrderItem1.md) | Items to be ordered | [default to undefined]
+**preferredFulfillers** | **Array<string>** |  | [optional] [default to undefined]
+**originalOrderRef** | **string** | A reference to the resource location | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateOrder } from '@teemill/platform';
+
+const instance: CreateOrder = {
+    merchantReference,
+    contactInformation,
+    shippingAddress,
+    customsInformation,
+    items,
+    preferredFulfillers,
+    originalOrderRef,
+};
+```
+
+[[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/CreateOrderContactInformation.md

@@ -0,0 +1,23 @@
+# CreateOrderContactInformation
+
+Contact information for the order
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateOrderContactInformation } from '@teemill/platform';
+
+const instance: CreateOrderContactInformation = {
+    email,
+    phone,
+};
+```
+
+[[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/CustomsInformation.md

@@ -0,0 +1,27 @@
+# CustomsInformation
+
+Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**preRegistrationType** | **string** | Pre-registration type | [optional] [default to undefined]
+**preRegistrationNumber** | **string** | Pre-registration number | [optional] [default to undefined]
+**vatNumber** | **string** | VAT number | [optional] [default to undefined]
+**eoriNumber** | **string** | EORI number | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomsInformation } from '@teemill/platform';
+
+const instance: CustomsInformation = {
+    preRegistrationType,
+    preRegistrationNumber,
+    vatNumber,
+    eoriNumber,
+};
+```
+
+[[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/OrderItem1.md

@@ -0,0 +1,24 @@
+# OrderItem1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
+**quantity** | **number** |  | [default to undefined]
+**recipientCost** | [**OrderItem1RecipientCost**](OrderItem1RecipientCost.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderItem1 } from '@teemill/platform';
+
+const instance: OrderItem1 = {
+    variantRef,
+    quantity,
+    recipientCost,
+};
+```
+
+[[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/OrderItem1RecipientCost.md

@@ -0,0 +1,22 @@
+# OrderItem1RecipientCost
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **string** |  | [default to undefined]
+**currencyCode** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { OrderItem1RecipientCost } from '@teemill/platform';
+
+const instance: OrderItem1RecipientCost = {
+    amount,
+    currencyCode,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)