@teemill/platform 0.29.2 → 0.30.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/platform@0.29.2
+## @teemill/platform@0.30.0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/platform@0.29.2 --save
+npm install @teemill/platform@0.30.0 --save
 ```
 
 _unPublished (not recommended):_
@@ -59,6 +59,7 @@ Class | Method | HTTP request | Description
 *EnquiriesApi* | [**listCustomerEnquiries**](docs/EnquiriesApi.md#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries
 *EnquiriesApi* | [**listCustomerEnquiryLogs**](docs/EnquiriesApi.md#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs
 *EnquiriesApi* | [**updateCustomerEnquiry**](docs/EnquiriesApi.md#updatecustomerenquiry) | **PATCH** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Update customer enquiry
+*OrdersApi* | [**amendOrder**](docs/OrdersApi.md#amendorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId}/amend | Amend the contents of an order
 *OrdersApi* | [**confirmOrder**](docs/OrdersApi.md#confirmorder) | **POST** /v1/platform/{platformId}/orders/{orderId}/confirm | Confirm order
 *OrdersApi* | [**createOrder**](docs/OrdersApi.md#createorder) | **POST** /v1/platform/{platformId}/orders | Create order
 *OrdersApi* | [**exportOrders**](docs/OrdersApi.md#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders
@@ -68,6 +69,7 @@ Class | Method | HTTP request | Description
 *OrdersApi* | [**listAvailableFulfillers**](docs/OrdersApi.md#listavailablefulfillers) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers | List available fulfillers
 *OrdersApi* | [**listOrders**](docs/OrdersApi.md#listorders) | **GET** /v1/platform/{platformId}/orders | List orders
 *OrdersApi* | [**retryPlatformPayment**](docs/OrdersApi.md#retryplatformpayment) | **POST** /v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment | Retry
+*OrdersApi* | [**returnOrder**](docs/OrdersApi.md#returnorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId}/return | Return the contents of an order for a refund or exchange
 *OrdersApi* | [**sendOrderReceipt**](docs/OrdersApi.md#sendorderreceipt) | **POST** /v1/platform/{platformId}/orders/{orderId}/receipt/send | Send order receipt
 *OrdersApi* | [**updateFulfillment**](docs/OrdersApi.md#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment
 *PaymentApi* | [**authorizeStripe**](docs/PaymentApi.md#authorizestripe) | **GET** /v1/platform/payment/stripe/authorize | Authorize Stripe
@@ -92,6 +94,8 @@ Class | Method | HTTP request | Description
 ### Documentation For Models
 
  - [Address](docs/Address.md)
+ - [AmendOrderRequest](docs/AmendOrderRequest.md)
+ - [AmendOrderRequestAmendmentsInner](docs/AmendOrderRequestAmendmentsInner.md)
  - [ApiError](docs/ApiError.md)
  - [Client](docs/Client.md)
  - [ConfirmOrderFulfillment](docs/ConfirmOrderFulfillment.md)
@@ -140,6 +144,7 @@ Class | Method | HTTP request | Description
  - [PlatformLogo](docs/PlatformLogo.md)
  - [Price](docs/Price.md)
  - [Project](docs/Project.md)
+ - [ReturnOrderRequest](docs/ReturnOrderRequest.md)
  - [Review](docs/Review.md)
  - [ReviewAuthor](docs/ReviewAuthor.md)
  - [ReviewImagesInner](docs/ReviewImagesInner.md)

package/api.ts

@@ -4,7 +4,7 @@
  * Platform API
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.29.2
+ * The version of the OpenAPI document: 0.30.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -78,6 +78,58 @@ export interface Address {
      */
     'state'?: string;
 }
+/**
+ * 
+ * @export
+ * @interface AmendOrderRequest
+ */
+export interface AmendOrderRequest {
+    /**
+     * 
+     * @type {Array<AmendOrderRequestAmendmentsInner>}
+     * @memberof AmendOrderRequest
+     */
+    'amendments': Array<AmendOrderRequestAmendmentsInner>;
+}
+/**
+ * 
+ * @export
+ * @interface AmendOrderRequestAmendmentsInner
+ */
+export interface AmendOrderRequestAmendmentsInner {
+    /**
+     * Unique order item identifier
+     * @type {string}
+     * @memberof AmendOrderRequestAmendmentsInner
+     */
+    'id': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AmendOrderRequestAmendmentsInner
+     */
+    'action': AmendOrderRequestAmendmentsInnerActionEnum;
+    /**
+     * The quantity of the item to refund or exchange. This must be less than or equal to the quantity of the item in the order.
+     * @type {number}
+     * @memberof AmendOrderRequestAmendmentsInner
+     */
+    'quantity': number;
+    /**
+     * A reference to the variant being ordered
+     * @type {string}
+     * @memberof AmendOrderRequestAmendmentsInner
+     */
+    'newVariantRef'?: string;
+}
+
+export const AmendOrderRequestAmendmentsInnerActionEnum = {
+    Refund: 'refund',
+    Exchange: 'exchange'
+} as const;
+
+export type AmendOrderRequestAmendmentsInnerActionEnum = typeof AmendOrderRequestAmendmentsInnerActionEnum[keyof typeof AmendOrderRequestAmendmentsInnerActionEnum];
+
 /**
  * 
  * @export
@@ -1476,6 +1528,19 @@ export interface Project {
      */
     'name': string;
 }
+/**
+ * 
+ * @export
+ * @interface ReturnOrderRequest
+ */
+export interface ReturnOrderRequest {
+    /**
+     * 
+     * @type {Array<AmendOrderRequestAmendmentsInner>}
+     * @memberof ReturnOrderRequest
+     */
+    'returns': Array<AmendOrderRequestAmendmentsInner>;
+}
 /**
  * 
  * @export
@@ -3492,6 +3557,64 @@ export class EnquiriesApi extends BaseAPI {
  */
 export const OrdersApiAxiosParamCreator = function (configuration?: 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: async (project: string, platformId: string, orderId: string, amendOrderRequest: AmendOrderRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('amendOrder', 'project', project)
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('amendOrder', 'platformId', platformId)
+            // verify required parameter 'orderId' is not null or undefined
+            assertParamExists('amendOrder', 'orderId', orderId)
+            // verify required parameter 'amendOrderRequest' is not null or undefined
+            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, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await 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 = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(amendOrderRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Confirm order
@@ -4025,6 +4148,64 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
                 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: async (project: string, platformId: string, orderId: string, returnOrderRequest: ReturnOrderRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('returnOrder', 'project', project)
+            // verify required parameter 'platformId' is not null or undefined
+            assertParamExists('returnOrder', 'platformId', platformId)
+            // verify required parameter 'orderId' is not null or undefined
+            assertParamExists('returnOrder', 'orderId', orderId)
+            // verify required parameter 'returnOrderRequest' is not null or undefined
+            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, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await 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 = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(returnOrderRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: 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
@@ -4145,6 +4326,22 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
 export const OrdersApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = 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}
+         */
+        async amendOrder(project: string, platformId: string, orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.amendOrder(project, platformId, orderId, amendOrderRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.amendOrder']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Confirm order
@@ -4290,6 +4487,22 @@ export const OrdersApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OrdersApi.retryPlatformPayment']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, 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}
+         */
+        async returnOrder(project: string, platformId: string, orderId: string, returnOrderRequest: ReturnOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.returnOrder(project, platformId, orderId, returnOrderRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.returnOrder']?.[localVarOperationServerIndex]?.url;
+            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
@@ -4331,6 +4544,16 @@ export const OrdersApiFp = function(configuration?: Configuration) {
 export const OrdersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = 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: OrdersApiAmendOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
+            return localVarFp.amendOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.amendOrderRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Confirm order
@@ -4421,6 +4644,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
         retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
             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: OrdersApiReturnOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
+            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
@@ -4444,6 +4677,41 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
     };
 };
 
+/**
+ * Request parameters for amendOrder operation in OrdersApi.
+ * @export
+ * @interface OrdersApiAmendOrderRequest
+ */
+export interface OrdersApiAmendOrderRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof OrdersApiAmendOrder
+     */
+    readonly project: string
+
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof OrdersApiAmendOrder
+     */
+    readonly platformId: string
+
+    /**
+     * The order identifier
+     * @type {string}
+     * @memberof OrdersApiAmendOrder
+     */
+    readonly orderId: string
+
+    /**
+     * AmendOrder schema
+     * @type {AmendOrderRequest}
+     * @memberof OrdersApiAmendOrder
+     */
+    readonly amendOrderRequest: AmendOrderRequest
+}
+
 /**
  * Request parameters for confirmOrder operation in OrdersApi.
  * @export
@@ -4766,6 +5034,41 @@ export interface OrdersApiRetryPlatformPaymentRequest {
     readonly orderId: string
 }
 
+/**
+ * Request parameters for returnOrder operation in OrdersApi.
+ * @export
+ * @interface OrdersApiReturnOrderRequest
+ */
+export interface OrdersApiReturnOrderRequest {
+    /**
+     * Project unique identifier
+     * @type {string}
+     * @memberof OrdersApiReturnOrder
+     */
+    readonly project: string
+
+    /**
+     * The platform identifier
+     * @type {string}
+     * @memberof OrdersApiReturnOrder
+     */
+    readonly platformId: string
+
+    /**
+     * The order identifier
+     * @type {string}
+     * @memberof OrdersApiReturnOrder
+     */
+    readonly orderId: string
+
+    /**
+     * ReturnOrder schema
+     * @type {ReturnOrderRequest}
+     * @memberof OrdersApiReturnOrder
+     */
+    readonly returnOrderRequest: ReturnOrderRequest
+}
+
 /**
  * Request parameters for sendOrderReceipt operation in OrdersApi.
  * @export
@@ -4836,6 +5139,18 @@ export interface OrdersApiUpdateFulfillmentRequest {
  * @extends {BaseAPI}
  */
 export class OrdersApi extends BaseAPI {
+    /**
+     * 
+     * @summary Amend the contents of an order
+     * @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    public amendOrder(requestParameters: OrdersApiAmendOrderRequest, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).amendOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.amendOrderRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Confirm order
@@ -4944,6 +5259,18 @@ export class OrdersApi extends BaseAPI {
         return 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
+     */
+    public returnOrder(requestParameters: OrdersApiReturnOrderRequest, options?: RawAxiosRequestConfig) {
+        return 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/base.ts

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

package/common.ts

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

package/configuration.ts

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