yellowgrid-api-ts 3.2.224-dev.0 → 3.2.225-dev.0

package/README.md

@@ -324,6 +324,7 @@ Class | Method | HTTP request | Description
 *RMAApi* | [**deleteGetAdminRma**](docs/RMAApi.md#deletegetadminrma) | **DELETE** /admin/rma/{id} | 
 *RMAApi* | [**getCreateRma**](docs/RMAApi.md#getcreaterma) | **GET** /rma | 
 *RMAApi* | [**getGetAdminRma**](docs/RMAApi.md#getgetadminrma) | **GET** /admin/rma/{id} | 
+*RMAApi* | [**getGetAdminRmaOrder**](docs/RMAApi.md#getgetadminrmaorder) | **GET** /admin/rma/{id}/order | 
 *RMAApi* | [**getGetAdminRmas**](docs/RMAApi.md#getgetadminrmas) | **GET** /admin/rma | 
 *RMAApi* | [**getGetRma**](docs/RMAApi.md#getgetrma) | **GET** /rma/{id} | 
 *RMAApi* | [**getGetRmaOrder**](docs/RMAApi.md#getgetrmaorder) | **GET** /rma/orders/{id} | 

package/api.ts

@@ -31070,6 +31070,39 @@ export const RMAApiAxiosParamCreator = function (configuration?: Configuration)
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get an RMA\'s Associated Order
+         * @param {number} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetAdminRmaOrder: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getGetAdminRmaOrder', 'id', id)
+            const localVarPath = `/admin/rma/{id}/order`
+                .replace('{id}', encodeURIComponent(String(id)));
+            // 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: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get Admin RMAs
          * @param {number} [pageSize] Number Of Results
@@ -31984,6 +32017,18 @@ export const RMAApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['RMAApi.getGetAdminRma']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get an RMA\'s Associated Order
+         * @param {number} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetAdminRmaOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RmaOrderDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetAdminRmaOrder(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['RMAApi.getGetAdminRmaOrder']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get Admin RMAs
          * @param {number} [pageSize] Number Of Results
@@ -32342,6 +32387,15 @@ export const RMAApiFactory = function (configuration?: Configuration, basePath?:
         getGetAdminRma(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminRmaDTO> {
             return localVarFp.getGetAdminRma(id, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get an RMA\'s Associated Order
+         * @param {number} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetAdminRmaOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<RmaOrderDTO> {
+            return localVarFp.getGetAdminRmaOrder(id, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get Admin RMAs
          * @param {number} [pageSize] Number Of Results
@@ -32630,6 +32684,16 @@ export class RMAApi extends BaseAPI {
         return RMAApiFp(this.configuration).getGetAdminRma(id, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get an RMA\'s Associated Order
+     * @param {number} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetAdminRmaOrder(id: number, options?: RawAxiosRequestConfig) {
+        return RMAApiFp(this.configuration).getGetAdminRmaOrder(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get Admin RMAs
      * @param {number} [pageSize] Number Of Results

package/dist/api.d.ts

@@ -20049,6 +20049,13 @@ export declare const RMAApiAxiosParamCreator: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     getGetAdminRma: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get an RMA\'s Associated Order
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetAdminRmaOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Admin RMAs
      * @param {number} [pageSize] Number Of Results
@@ -20275,6 +20282,13 @@ export declare const RMAApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetAdminRma(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminRmaDTO>>;
+    /**
+     * Get an RMA\'s Associated Order
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetAdminRmaOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RmaOrderDTO>>;
     /**
      * Get Admin RMAs
      * @param {number} [pageSize] Number Of Results
@@ -20501,6 +20515,13 @@ export declare const RMAApiFactory: (configuration?: Configuration, basePath?: s
      * @throws {RequiredError}
      */
     getGetAdminRma(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminRmaDTO>;
+    /**
+     * Get an RMA\'s Associated Order
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetAdminRmaOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<RmaOrderDTO>;
     /**
      * Get Admin RMAs
      * @param {number} [pageSize] Number Of Results
@@ -20727,6 +20748,13 @@ export declare class RMAApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetAdminRma(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminRmaDTO, any, {}>>;
+    /**
+     * Get an RMA\'s Associated Order
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetAdminRmaOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RmaOrderDTO, any, {}>>;
     /**
      * Get Admin RMAs
      * @param {number} [pageSize] Number Of Results

package/dist/api.js

@@ -24688,6 +24688,43 @@ var RMAApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Get an RMA\'s Associated Order
+         * @param {number} id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetAdminRmaOrder: function (id_1) {
+            var args_1 = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'id' is not null or undefined
+                    (0, common_1.assertParamExists)('getGetAdminRmaOrder', 'id', id);
+                    localVarPath = "/admin/rma/{id}/order"
+                        .replace('{id}', encodeURIComponent(String(id)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    localVarHeaderParameter['Accept'] = 'application/json';
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Get Admin RMAs
          * @param {number} [pageSize] Number Of Results
@@ -25734,6 +25771,28 @@ var RMAApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Get an RMA\'s Associated Order
+         * @param {number} id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetAdminRmaOrder: function (id, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                var _a, _b, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetAdminRmaOrder(id, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RMAApi.getGetAdminRmaOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Get Admin RMAs
          * @param {number} [pageSize] Number Of Results
@@ -26332,6 +26391,15 @@ var RMAApiFactory = function (configuration, basePath, axios) {
         getGetAdminRma: function (id, options) {
             return localVarFp.getGetAdminRma(id, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Get an RMA\'s Associated Order
+         * @param {number} id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetAdminRmaOrder: function (id, options) {
+            return localVarFp.getGetAdminRmaOrder(id, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Get Admin RMAs
          * @param {number} [pageSize] Number Of Results
@@ -26624,6 +26692,16 @@ var RMAApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.RMAApiFp)(this.configuration).getGetAdminRma(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Get an RMA\'s Associated Order
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    RMAApi.prototype.getGetAdminRmaOrder = function (id, options) {
+        var _this = this;
+        return (0, exports.RMAApiFp)(this.configuration).getGetAdminRmaOrder(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Get Admin RMAs
      * @param {number} [pageSize] Number Of Results

package/docs/RMAApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**deleteGetAdminRma**](#deletegetadminrma) | **DELETE** /admin/rma/{id} | |
 |[**getCreateRma**](#getcreaterma) | **GET** /rma | |
 |[**getGetAdminRma**](#getgetadminrma) | **GET** /admin/rma/{id} | |
+|[**getGetAdminRmaOrder**](#getgetadminrmaorder) | **GET** /admin/rma/{id}/order | |
 |[**getGetAdminRmas**](#getgetadminrmas) | **GET** /admin/rma | |
 |[**getGetRma**](#getgetrma) | **GET** /rma/{id} | |
 |[**getGetRmaOrder**](#getgetrmaorder) | **GET** /rma/orders/{id} | |
@@ -258,6 +259,60 @@ No authorization required
 
 [[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)
 
+# **getGetAdminRmaOrder**
+> RmaOrderDTO getGetAdminRmaOrder()
+
+Get an RMA\'s Associated Order
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+
+const { status, data } = await apiInstance.getGetAdminRmaOrder(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**RmaOrderDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Admin RMA Order |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
 # **getGetAdminRmas**
 > AdminCustomerRmasModel getGetAdminRmas()
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.224-dev.0",
+  "version": "3.2.225-dev.0",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {