@teemill/platform 0.23.0 → 0.24.0

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.23.0
+ * The version of the OpenAPI document: 0.24.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -963,6 +963,50 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get an order receipt for a platform by a given order ID.
+         * @summary Get order receipt
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOrderReceipt: (project_1, platformId_1, orderId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, ...args_1], void 0, function* (project, platformId, orderId, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('getOrderReceipt', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('getOrderReceipt', 'platformId', platformId);
+            // verify required parameter 'orderId' is not null or undefined
+            assertParamExists('getOrderReceipt', 'orderId', orderId);
+            const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/receipt`
+                .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: 'GET' }, 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;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * List available fulfillers for a given fulfillment
          * @summary List available fulfillers
@@ -1119,6 +1163,50 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
+         * @summary Send order receipt
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sendOrderReceipt: (project_1, platformId_1, orderId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, ...args_1], void 0, function* (project, platformId, orderId, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('sendOrderReceipt', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('sendOrderReceipt', 'platformId', platformId);
+            // verify required parameter 'orderId' is not null or undefined
+            assertParamExists('sendOrderReceipt', 'orderId', orderId);
+            const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/receipt/send`
+                .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;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Update a fulfillment that belongs to an order placed through the platform
          * @summary Update fulfillment
@@ -1233,6 +1321,24 @@ export const OrdersApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Get an order receipt for a platform by a given order ID.
+         * @summary Get order receipt
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOrderReceipt(project, platformId, orderId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrderReceipt(project, platformId, orderId, 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.getOrderReceipt']) === 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);
+            });
+        },
         /**
          * List available fulfillers for a given fulfillment
          * @summary List available fulfillers
@@ -1292,6 +1398,24 @@ export const OrdersApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
+         * @summary Send order receipt
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sendOrderReceipt(project, platformId, orderId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.sendOrderReceipt(project, platformId, orderId, 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.sendOrderReceipt']) === 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);
+            });
+        },
         /**
          * Update a fulfillment that belongs to an order placed through the platform
          * @summary Update fulfillment
@@ -1350,6 +1474,16 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
         getOrder(requestParameters, options) {
             return localVarFp.getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get an order receipt for a platform by a given order ID.
+         * @summary Get order receipt
+         * @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOrderReceipt(requestParameters, options) {
+            return localVarFp.getOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
+        },
         /**
          * List available fulfillers for a given fulfillment
          * @summary List available fulfillers
@@ -1380,6 +1514,16 @@ export const OrdersApiFactory = function (configuration, basePath, axios) {
         retryPlatformPayment(requestParameters, options) {
             return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
+         * @summary Send order receipt
+         * @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sendOrderReceipt(requestParameters, options) {
+            return localVarFp.sendOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Update a fulfillment that belongs to an order placed through the platform
          * @summary Update fulfillment
@@ -1432,6 +1576,17 @@ export class OrdersApi extends BaseAPI {
     getOrder(requestParameters, options) {
         return OrdersApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get an order receipt for a platform by a given order ID.
+     * @summary Get order receipt
+     * @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    getOrderReceipt(requestParameters, options) {
+        return OrdersApiFp(this.configuration).getOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * List available fulfillers for a given fulfillment
      * @summary List available fulfillers
@@ -1465,6 +1620,17 @@ export class OrdersApi extends BaseAPI {
     retryPlatformPayment(requestParameters, options) {
         return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
+     * @summary Send order receipt
+     * @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    sendOrderReceipt(requestParameters, options) {
+        return OrdersApiFp(this.configuration).sendOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Update a fulfillment that belongs to an order placed through the platform
      * @summary Update fulfillment

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.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.23.0
+ * The version of the OpenAPI document: 0.24.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/Order.md

@@ -25,6 +25,7 @@ Name | Type | Description | Notes
 **statusHistory** | [**Array<StatusHistoryItem>**](StatusHistoryItem.md) |  | [optional] [default to undefined]
 **project** | [**Project**](Project.md) |  | [default to undefined]
 **paymentAttempts** | [**Array<PaymentAttempt>**](PaymentAttempt.md) |  | [optional] [default to undefined]
+**integrationType** | **string** | The integration type of the order, e.g. \"website\" or \"shopify\" | [optional] [default to undefined]
 
 ## Example
 
@@ -52,6 +53,7 @@ const instance: Order = {
     statusHistory,
     project,
     paymentAttempts,
+    integrationType,
 };
 ```
 

package/docs/OrdersApi.md

@@ -7,9 +7,11 @@ All URIs are relative to *https://localhost:8080*
 |[**exportOrders**](#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders|
 |[**getFulfillment**](#getfulfillment) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Get fulfillment|
 |[**getOrder**](#getorder) | **GET** /v1/platform/{platformId}/orders/{orderId} | Get order|
+|[**getOrderReceipt**](#getorderreceipt) | **GET** /v1/platform/{platformId}/orders/{orderId}/receipt | Get order receipt|
 |[**listAvailableFulfillers**](#listavailablefulfillers) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers | List available fulfillers|
 |[**listOrders**](#listorders) | **GET** /v1/platform/{platformId}/orders | List orders|
 |[**retryPlatformPayment**](#retryplatformpayment) | **POST** /v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment | Retry|
+|[**sendOrderReceipt**](#sendorderreceipt) | **POST** /v1/platform/{platformId}/orders/{orderId}/receipt/send | Send order receipt|
 |[**updateFulfillment**](#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment|
 
 # **exportOrders**
@@ -204,6 +206,68 @@ const { status, data } = await apiInstance.getOrder(
 
 [[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)
 
+# **getOrderReceipt**
+> string getOrderReceipt()
+
+Get an order receipt for a platform by a given order ID.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let orderId: string; //The order identifier (default to undefined)
+
+const { status, data } = await apiInstance.getOrderReceipt(
+    project,
+    platformId,
+    orderId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **orderId** | [**string**] | The order identifier | defaults to undefined|
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/html, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Returns the order receipt as an HTML page |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[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)
+
 # **listAvailableFulfillers**
 > FulfillersResponse listAvailableFulfillers()
 
@@ -405,6 +469,68 @@ const { status, data } = await apiInstance.retryPlatformPayment(
 
 [[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)
 
+# **sendOrderReceipt**
+> sendOrderReceipt()
+
+Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let orderId: string; //The order identifier (default to undefined)
+
+const { status, data } = await apiInstance.sendOrderReceipt(
+    project,
+    platformId,
+    orderId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **orderId** | [**string**] | The order identifier | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Successfully sent order receipt to customer |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[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)
+
 # **updateFulfillment**
 > Fulfillment updateFulfillment(updateFulfillmentRequest)
 

package/index.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/platform",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "OpenAPI client for @teemill/platform",
   "author": "OpenAPI-Generator Contributors",
   "repository": {