@teemill/platform 0.29.0 → 0.30.0

package/dist/api.js

@@ -5,7 +5,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.29.0
+ * The version of the OpenAPI document: 0.30.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,13 +22,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TermsApi = exports.TermsApiFactory = exports.TermsApiFp = exports.TermsApiAxiosParamCreator = exports.ReviewsApi = exports.ReviewsApiFactory = exports.ReviewsApiFp = exports.ReviewsApiAxiosParamCreator = exports.PlatformApi = exports.PlatformApiFactory = exports.PlatformApiFp = exports.PlatformApiAxiosParamCreator = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.ListOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.EnquiriesApi = exports.EnquiriesApiFactory = exports.EnquiriesApiFp = exports.EnquiriesApiAxiosParamCreator = exports.ListCustomersGenderEnum = exports.ListCustomersSortByEnum = exports.ExportCustomersGenderEnum = exports.ExportCustomersSortByEnum = exports.CustomersApi = exports.CustomersApiFactory = exports.CustomersApiFp = exports.CustomersApiAxiosParamCreator = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.PaymentAccountMethodEnum = exports.OrderStatus = exports.EnquiryStatusEnum = exports.CustomsInformationPreRegistrationTypeEnum = void 0;
+exports.TermsApi = exports.TermsApiFactory = exports.TermsApiFp = exports.TermsApiAxiosParamCreator = exports.ReviewsApi = exports.ReviewsApiFactory = exports.ReviewsApiFp = exports.ReviewsApiAxiosParamCreator = exports.PlatformApi = exports.PlatformApiFactory = exports.PlatformApiFp = exports.PlatformApiAxiosParamCreator = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.ListOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.EnquiriesApi = exports.EnquiriesApiFactory = exports.EnquiriesApiFp = exports.EnquiriesApiAxiosParamCreator = exports.ListCustomersGenderEnum = exports.ListCustomersSortByEnum = exports.ExportCustomersGenderEnum = exports.ExportCustomersSortByEnum = exports.CustomersApi = exports.CustomersApiFactory = exports.CustomersApiFp = exports.CustomersApiAxiosParamCreator = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.PaymentAccountMethodEnum = exports.OrderStatus = exports.EnquiryStatusEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.AmendOrderRequestAmendmentsInnerActionEnum = void 0;
 const axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
 const common_1 = require("./common");
 // @ts-ignore
 const base_1 = require("./base");
+exports.AmendOrderRequestAmendmentsInnerActionEnum = {
+    Refund: 'refund',
+    Exchange: 'exchange'
+};
 exports.CustomsInformationPreRegistrationTypeEnum = {
     Ioss: 'IOSS'
 };
@@ -78,7 +82,7 @@ const CustomersApiAxiosParamCreator = function (configuration) {
          * @param {Array<string>} [countries] Filter customers by country code
          * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
          * @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
-         * @param {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+         * @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
          * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
          * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
          * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
@@ -223,7 +227,7 @@ const CustomersApiAxiosParamCreator = function (configuration) {
          * @param {Array<string>} [countries] Filter customers by country code
          * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
          * @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
-         * @param {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+         * @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
          * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
          * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
          * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
@@ -340,7 +344,7 @@ const CustomersApiFp = function (configuration) {
          * @param {Array<string>} [countries] Filter customers by country code
          * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
          * @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
-         * @param {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+         * @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
          * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
          * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
          * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
@@ -392,7 +396,7 @@ const CustomersApiFp = function (configuration) {
          * @param {Array<string>} [countries] Filter customers by country code
          * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
          * @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
-         * @param {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
+         * @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
          * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
          * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
          * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
@@ -1032,6 +1036,55 @@ exports.EnquiriesApi = EnquiriesApi;
  */
 const OrdersApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         *
+         * @summary Amend the contents of an order
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {AmendOrderRequest} amendOrderRequest AmendOrder schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        amendOrder: (project_1, platformId_1, orderId_1, amendOrderRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, amendOrderRequest_1, ...args_1], void 0, function* (project, platformId, orderId, amendOrderRequest, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            (0, common_1.assertParamExists)('amendOrder', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            (0, common_1.assertParamExists)('amendOrder', 'platformId', platformId);
+            // verify required parameter 'orderId' is not null or undefined
+            (0, common_1.assertParamExists)('amendOrder', 'orderId', orderId);
+            // verify required parameter 'amendOrderRequest' is not null or undefined
+            (0, common_1.assertParamExists)('amendOrder', 'amendOrderRequest', amendOrderRequest);
+            const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/amend`
+                .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, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(amendOrderRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          *
          * @summary Confirm order
@@ -1480,6 +1533,55 @@ const OrdersApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         *
+         * @summary Return the contents of an order for a refund or exchange
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {ReturnOrderRequest} returnOrderRequest ReturnOrder schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        returnOrder: (project_1, platformId_1, orderId_1, returnOrderRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, orderId_1, returnOrderRequest_1, ...args_1], void 0, function* (project, platformId, orderId, returnOrderRequest, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            (0, common_1.assertParamExists)('returnOrder', 'project', project);
+            // verify required parameter 'platformId' is not null or undefined
+            (0, common_1.assertParamExists)('returnOrder', 'platformId', platformId);
+            // verify required parameter 'orderId' is not null or undefined
+            (0, common_1.assertParamExists)('returnOrder', 'orderId', orderId);
+            // verify required parameter 'returnOrderRequest' is not null or undefined
+            (0, common_1.assertParamExists)('returnOrder', 'returnOrderRequest', returnOrderRequest);
+            const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/return`
+                .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, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(returnOrderRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                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
@@ -1583,6 +1685,25 @@ exports.OrdersApiAxiosParamCreator = OrdersApiAxiosParamCreator;
 const OrdersApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.OrdersApiAxiosParamCreator)(configuration);
     return {
+        /**
+         *
+         * @summary Amend the contents of an order
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {AmendOrderRequest} amendOrderRequest AmendOrder schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        amendOrder(project, platformId, orderId, amendOrderRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.amendOrder(project, platformId, orderId, amendOrderRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.amendOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          *
          * @summary Confirm order
@@ -1755,6 +1876,25 @@ const OrdersApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         *
+         * @summary Return the contents of an order for a refund or exchange
+         * @param {string} project Project unique identifier
+         * @param {string} platformId The platform identifier
+         * @param {string} orderId The order identifier
+         * @param {ReturnOrderRequest} returnOrderRequest ReturnOrder schema
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        returnOrder(project, platformId, orderId, returnOrderRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.returnOrder(project, platformId, orderId, returnOrderRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.returnOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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
@@ -1802,6 +1942,16 @@ exports.OrdersApiFp = OrdersApiFp;
 const OrdersApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.OrdersApiFp)(configuration);
     return {
+        /**
+         *
+         * @summary Amend the contents of an order
+         * @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        amendOrder(requestParameters, options) {
+            return localVarFp.amendOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.amendOrderRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary Confirm order
@@ -1892,6 +2042,16 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
         retryPlatformPayment(requestParameters, options) {
             return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Return the contents of an order for a refund or exchange
+         * @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        returnOrder(requestParameters, options) {
+            return localVarFp.returnOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.returnOrderRequest, 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
@@ -1922,6 +2082,17 @@ exports.OrdersApiFactory = OrdersApiFactory;
  * @extends {BaseAPI}
  */
 class OrdersApi extends base_1.BaseAPI {
+    /**
+     *
+     * @summary Amend the contents of an order
+     * @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    amendOrder(requestParameters, options) {
+        return (0, exports.OrdersApiFp)(this.configuration).amendOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.amendOrderRequest, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Confirm order
@@ -2021,6 +2192,17 @@ class OrdersApi extends base_1.BaseAPI {
     retryPlatformPayment(requestParameters, options) {
         return (0, exports.OrdersApiFp)(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Return the contents of an order for a refund or exchange
+     * @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    returnOrder(requestParameters, options) {
+        return (0, exports.OrdersApiFp)(this.configuration).returnOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.returnOrderRequest, 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

package/dist/base.d.ts

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

package/dist/base.js

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

package/dist/common.d.ts

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

package/dist/common.js

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

package/dist/configuration.d.ts

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

package/dist/configuration.js

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