yellowgrid-api-ts 3.2.255 → 3.2.256-dev.0

package/docs/RMAApi.md

@@ -0,0 +1,1749 @@
+# RMAApi
+
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteDeleteRmaItem**](#deletedeletermaitem) | **DELETE** /admin/rma/{id}/items/{item_id} | |
+|[**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} | |
+|[**getSearchAdvanceReplacementOrders**](#getsearchadvancereplacementorders) | **GET** /rma/advance_replacement/orders | |
+|[**getSearchRmaOrders**](#getsearchrmaorders) | **GET** /rma/orders | |
+|[**patchApproveRma**](#patchapproverma) | **PATCH** /admin/rma/{id}/approve | |
+|[**patchMarkRmaItemAsBinned**](#patchmarkrmaitemasbinned) | **PATCH** /admin/rma/{id}/items/{item_id}/bin | |
+|[**patchMarkRmaItemAsReceived**](#patchmarkrmaitemasreceived) | **PATCH** /admin/rma/{id}/items/{item_id}/received | |
+|[**patchMarkRmaItemAsUnresolved**](#patchmarkrmaitemasunresolved) | **PATCH** /admin/rma/{id}/items/{item_id}/unresolved | |
+|[**patchRejectRma**](#patchrejectrma) | **PATCH** /admin/rma/{id}/reject | |
+|[**patchResolveRma**](#patchresolverma) | **PATCH** /admin/rma/{id}/resolve | |
+|[**patchUpdateRmaContactEmail**](#patchupdatermacontactemail) | **PATCH** /admin/rma/{id}/contactEmail | |
+|[**patchUpdateRmaContactName**](#patchupdatermacontactname) | **PATCH** /admin/rma/{id}/contactName | |
+|[**patchUpdateRmaItemMacAddress**](#patchupdatermaitemmacaddress) | **PATCH** /admin/rma/{id}/items/{item_id}/mac | |
+|[**patchUpdateRmaItemNote**](#patchupdatermaitemnote) | **PATCH** /admin/rma/{id}/items/{item_id}/note | |
+|[**patchUpdateRmaItemSerialNumber**](#patchupdatermaitemserialnumber) | **PATCH** /admin/rma/{id}/items/{item_id}/serial | |
+|[**patchUpdateRmaReason**](#patchupdatermareason) | **PATCH** /admin/rma/{id}/reason | |
+|[**patchUpdateRmaResolution**](#patchupdatermaresolution) | **PATCH** /admin/rma/{id}/resolution | |
+|[**patchUpdateRmaReturnAddress**](#patchupdatermareturnaddress) | **PATCH** /admin/rma/{id}/address | |
+|[**postCreateReplacementOrder**](#postcreatereplacementorder) | **POST** /admin/rma/{id}/replacement_order | |
+|[**postCreateRma**](#postcreaterma) | **POST** /rma | |
+|[**postCreateRmaCollection**](#postcreatermacollection) | **POST** /admin/rma/{id}/collection | |
+|[**postCreateRmaCreditNote**](#postcreatermacreditnote) | **POST** /admin/rma/{id}/credit | |
+|[**postCreateRmaNote**](#postcreatermanote) | **POST** /admin/rma/{id}/notes | |
+|[**postCreateRmaReturn**](#postcreatermareturn) | **POST** /admin/rma/{id}/return | |
+
+# **deleteDeleteRmaItem**
+> deleteDeleteRmaItem()
+
+Delete an RMA item
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let itemId: number; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteDeleteRmaItem(
+    id,
+    itemId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] |  | defaults to undefined|
+| **itemId** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **deleteGetAdminRma**
+> deleteGetAdminRma()
+
+Delete an RMA
+
+### 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.deleteGetAdminRma(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **getCreateRma**
+> CustomerRmasModel getCreateRma()
+
+Get Customer RMAs
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let pageSize: number; //Number Of Results (optional) (default to 20)
+let page: number; //Page Number (optional) (default to 1)
+let search: string; //Search (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCreateRma(
+    pageSize,
+    page,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
+| **page** | [**number**] | Page Number | (optional) defaults to 1|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+
+
+### Return type
+
+**CustomerRmasModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Customer RMAs |  -  |
+|**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)
+
+# **getGetAdminRma**
+> AdminRmaDTO getGetAdminRma()
+
+Get Admin RMA by ID
+
+### 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.getGetAdminRma(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**AdminRmaDTO**
+
+### 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 |  -  |
+|**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)
+
+# **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()
+
+Get Admin RMAs
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let pageSize: number; //Number Of Results (optional) (default to 20)
+let page: number; //Page Number (optional) (default to 1)
+let search: string; //Search (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetAdminRmas(
+    pageSize,
+    page,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
+| **page** | [**number**] | Page Number | (optional) defaults to 1|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+
+
+### Return type
+
+**AdminCustomerRmasModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Admin RMAs |  -  |
+|**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)
+
+# **getGetRma**
+> RmaDTO getGetRma()
+
+Get RMA by ID
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; //RMA ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetRma(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | RMA ID | defaults to undefined|
+
+
+### Return type
+
+**RmaDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | RMA |  -  |
+|**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)
+
+# **getGetRmaOrder**
+> RmaOrderDTO getGetRmaOrder()
+
+Get Order by ID
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; //Order ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetRmaOrder(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | 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** | RMA |  -  |
+|**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)
+
+# **getSearchAdvanceReplacementOrders**
+> Array<RmaOrderSummaryDTO> getSearchAdvanceReplacementOrders()
+
+Get suitable advance replacment orders
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let sku: string; //Item SKU (default to undefined)
+let orderId: number; //Order ID (default to undefined)
+
+const { status, data } = await apiInstance.getSearchAdvanceReplacementOrders(
+    sku,
+    orderId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sku** | [**string**] | Item SKU | defaults to undefined|
+| **orderId** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**Array<RmaOrderSummaryDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Customer RMAs |  -  |
+|**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)
+
+# **getSearchRmaOrders**
+> Array<RmaOrderSummaryDTO> getSearchRmaOrders()
+
+Search for Orders to create an RMA
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let search: string; //Search (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getSearchRmaOrders(
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<RmaOrderSummaryDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Customer RMAs |  -  |
+|**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)
+
+# **patchApproveRma**
+> patchApproveRma()
+
+Approve an RMA
+
+### 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.patchApproveRma(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchMarkRmaItemAsBinned**
+> patchMarkRmaItemAsBinned()
+
+Mark RMA item as binned
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let itemId: number; // (default to undefined)
+
+const { status, data } = await apiInstance.patchMarkRmaItemAsBinned(
+    id,
+    itemId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] |  | defaults to undefined|
+| **itemId** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchMarkRmaItemAsReceived**
+> patchMarkRmaItemAsReceived()
+
+Mark RMA item as received
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let itemId: number; // (default to undefined)
+
+const { status, data } = await apiInstance.patchMarkRmaItemAsReceived(
+    id,
+    itemId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] |  | defaults to undefined|
+| **itemId** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchMarkRmaItemAsUnresolved**
+> patchMarkRmaItemAsUnresolved()
+
+Mark RMA item as unresolved
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let itemId: number; // (default to undefined)
+
+const { status, data } = await apiInstance.patchMarkRmaItemAsUnresolved(
+    id,
+    itemId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] |  | defaults to undefined|
+| **itemId** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchRejectRma**
+> patchRejectRma()
+
+Reject an RMA
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    NoteRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let noteRequestModel: NoteRequestModel; //RMA Rejection Request (optional)
+
+const { status, data } = await apiInstance.patchRejectRma(
+    id,
+    noteRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **noteRequestModel** | **NoteRequestModel**| RMA Rejection Request | |
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchResolveRma**
+> patchResolveRma()
+
+Resolve an RMA
+
+### 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.patchResolveRma(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchUpdateRmaContactEmail**
+> patchUpdateRmaContactEmail()
+
+Update contact name for an rma
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    EmailRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let emailRequestModel: EmailRequestModel; //Email Request (optional)
+
+const { status, data } = await apiInstance.patchUpdateRmaContactEmail(
+    id,
+    emailRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **emailRequestModel** | **EmailRequestModel**| Email Request | |
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchUpdateRmaContactName**
+> patchUpdateRmaContactName()
+
+Update contact name for an rma
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    NameRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let nameRequestModel: NameRequestModel; //Name Request (optional)
+
+const { status, data } = await apiInstance.patchUpdateRmaContactName(
+    id,
+    nameRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **nameRequestModel** | **NameRequestModel**| Name Request | |
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchUpdateRmaItemMacAddress**
+> patchUpdateRmaItemMacAddress()
+
+Update RMA item MAC address
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    MacAddressRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let itemId: number; // (default to undefined)
+let macAddressRequestModel: MacAddressRequestModel; //Update RMA item MAC address request (optional)
+
+const { status, data } = await apiInstance.patchUpdateRmaItemMacAddress(
+    id,
+    itemId,
+    macAddressRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **macAddressRequestModel** | **MacAddressRequestModel**| Update RMA item MAC address request | |
+| **id** | [**number**] |  | defaults to undefined|
+| **itemId** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchUpdateRmaItemNote**
+> patchUpdateRmaItemNote()
+
+Update RMA item note
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    NoteRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let itemId: number; // (default to undefined)
+let noteRequestModel: NoteRequestModel; //Update RMA item note request (optional)
+
+const { status, data } = await apiInstance.patchUpdateRmaItemNote(
+    id,
+    itemId,
+    noteRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **noteRequestModel** | **NoteRequestModel**| Update RMA item note request | |
+| **id** | [**number**] |  | defaults to undefined|
+| **itemId** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchUpdateRmaItemSerialNumber**
+> patchUpdateRmaItemSerialNumber()
+
+Update RMA item serial number
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    SerialNumberRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let itemId: number; // (default to undefined)
+let serialNumberRequestModel: SerialNumberRequestModel; //Update RMA item serial number request (optional)
+
+const { status, data } = await apiInstance.patchUpdateRmaItemSerialNumber(
+    id,
+    itemId,
+    serialNumberRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **serialNumberRequestModel** | **SerialNumberRequestModel**| Update RMA item serial number request | |
+| **id** | [**number**] |  | defaults to undefined|
+| **itemId** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchUpdateRmaReason**
+> patchUpdateRmaReason()
+
+Update RMA reason
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    ReasonRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let reasonRequestModel: ReasonRequestModel; //Update RMA Reason Request (optional)
+
+const { status, data } = await apiInstance.patchUpdateRmaReason(
+    id,
+    reasonRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reasonRequestModel** | **ReasonRequestModel**| Update RMA Reason Request | |
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchUpdateRmaResolution**
+> patchUpdateRmaResolution()
+
+Update RMA resolution
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    ResolutionRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let resolutionRequestModel: ResolutionRequestModel; //Update RMA Resolution Request (optional)
+
+const { status, data } = await apiInstance.patchUpdateRmaResolution(
+    id,
+    resolutionRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **resolutionRequestModel** | **ResolutionRequestModel**| Update RMA Resolution Request | |
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **patchUpdateRmaReturnAddress**
+> patchUpdateRmaReturnAddress()
+
+Update RMA return address
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    AddressDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let addressDTO: AddressDTO; //Update RMA return address (optional)
+
+const { status, data } = await apiInstance.patchUpdateRmaReturnAddress(
+    id,
+    addressDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **addressDTO** | **AddressDTO**| Update RMA return address | |
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
+# **postCreateReplacementOrder**
+> AdminRmaDTO postCreateReplacementOrder()
+
+Create a replacement order for an RMA
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    RmaReplacementOrderRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let rmaReplacementOrderRequestDTO: RmaReplacementOrderRequestDTO; //RMA Replacement Order Request (optional)
+
+const { status, data } = await apiInstance.postCreateReplacementOrder(
+    id,
+    rmaReplacementOrderRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rmaReplacementOrderRequestDTO** | **RmaReplacementOrderRequestDTO**| RMA Replacement Order Request | |
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**AdminRmaDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Admin RMA |  -  |
+|**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)
+
+# **postCreateRma**
+> RmaDTO postCreateRma()
+
+Create an RMA
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    RmaRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let rmaRequestDTO: RmaRequestDTO; //RMA Request (optional)
+
+const { status, data } = await apiInstance.postCreateRma(
+    rmaRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rmaRequestDTO** | **RmaRequestDTO**| RMA Request | |
+
+
+### Return type
+
+**RmaDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | RMA |  -  |
+|**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)
+
+# **postCreateRmaCollection**
+> AdminRmaDTO postCreateRmaCollection()
+
+Create a collection for an RMA
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    RmaCollectionDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let rmaCollectionDTO: RmaCollectionDTO; //RMA Collection Request (optional)
+
+const { status, data } = await apiInstance.postCreateRmaCollection(
+    id,
+    rmaCollectionDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rmaCollectionDTO** | **RmaCollectionDTO**| RMA Collection Request | |
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**AdminRmaDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Admin RMA |  -  |
+|**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)
+
+# **postCreateRmaCreditNote**
+> AdminRmaDTO postCreateRmaCreditNote()
+
+Create a credit note for an RMA
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let rmaCreditItemRequestDTO: Array<RmaCreditItemRequestDTO>; //RMA Items to be credited (optional)
+
+const { status, data } = await apiInstance.postCreateRmaCreditNote(
+    id,
+    rmaCreditItemRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rmaCreditItemRequestDTO** | **Array<RmaCreditItemRequestDTO>**| RMA Items to be credited | |
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**AdminRmaDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Admin RMA |  -  |
+|**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)
+
+# **postCreateRmaNote**
+> AdminRmaNoteDTO postCreateRmaNote()
+
+Create an RMA note
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    NoteRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let noteRequestModel: NoteRequestModel; //RMA Note Request (optional)
+
+const { status, data } = await apiInstance.postCreateRmaNote(
+    id,
+    noteRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **noteRequestModel** | **NoteRequestModel**| RMA Note Request | |
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**AdminRmaNoteDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Admin RMA Note |  -  |
+|**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)
+
+# **postCreateRmaReturn**
+> AdminRmaDTO postCreateRmaReturn()
+
+Create a collection for an RMA
+
+### Example
+
+```typescript
+import {
+    RMAApi,
+    Configuration,
+    RmaReturnDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new RMAApi(configuration);
+
+let id: number; // (default to undefined)
+let rmaReturnDTO: RmaReturnDTO; //RMA Return Request (optional)
+
+const { status, data } = await apiInstance.postCreateRmaReturn(
+    id,
+    rmaReturnDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rmaReturnDTO** | **RmaReturnDTO**| RMA Return Request | |
+| **id** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**AdminRmaDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Admin RMA |  -  |
+|**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)
+