yellowgrid-api-ts 3.2.215 → 3.2.217-dev.0

package/docs/ReasonRequestModel.md

@@ -0,0 +1,21 @@
+# ReasonRequestModel
+
+RMA Reason Request Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reason** | **number** | RMA Reason | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReasonRequestModel } from 'yellowgrid-api-ts';
+
+const instance: ReasonRequestModel = {
+    reason,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReportRequestDTO.md

@@ -0,0 +1,37 @@
+# ReportRequestDTO
+
+Report Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**report** | **string** | Report | [optional] [default to undefined]
+**start** | **string** | Start | [optional] [default to undefined]
+**end** | **string** | End | [optional] [default to undefined]
+**month** | **number** | Month | [optional] [default to undefined]
+**year** | **number** | Year | [optional] [default to undefined]
+**sku** | **string** | SKU | [optional] [default to undefined]
+**price** | **number** | Price | [optional] [default to undefined]
+**recipients** | **Array<string>** | Recipients | [optional] [default to undefined]
+**graphType** | **string** | Graph Type | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReportRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: ReportRequestDTO = {
+    report,
+    start,
+    end,
+    month,
+    year,
+    sku,
+    price,
+    recipients,
+    graphType,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReportsApi.md

@@ -0,0 +1,107 @@
+# ReportsApi
+
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetStockReport**](#getgetstockreport) | **GET** /reports/stock | |
+|[**postGenerateReport**](#postgeneratereport) | **POST** /reports | Generate Reports|
+
+# **getGetStockReport**
+> StockReportModel getGetStockReport()
+
+
+### Example
+
+```typescript
+import {
+    ReportsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ReportsApi(configuration);
+
+const { status, data } = await apiInstance.getGetStockReport();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**StockReportModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Report |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+
+# **postGenerateReport**
+> PostGenerateReport200Response postGenerateReport()
+
+Generate Reports
+
+### Example
+
+```typescript
+import {
+    ReportsApi,
+    Configuration,
+    ReportRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ReportsApi(configuration);
+
+let reportRequestDTO: ReportRequestDTO; //Report Request (optional)
+
+const { status, data } = await apiInstance.postGenerateReport(
+    reportRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reportRequestDTO** | **ReportRequestDTO**| Report Request | |
+
+
+### Return type
+
+**PostGenerateReport200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Report generated |  -  |
+|**204** | No Response |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+

package/docs/ResolutionRequestModel.md

@@ -0,0 +1,21 @@
+# ResolutionRequestModel
+
+RMA Resolution Request Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resolution** | **number** | RMA Reason | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ResolutionRequestModel } from 'yellowgrid-api-ts';
+
+const instance: ResolutionRequestModel = {
+    resolution,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RmaCollectionDTO.md

@@ -0,0 +1,27 @@
+# RmaCollectionDTO
+
+RMA Collection Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | [**AddressDTO**](AddressDTO.md) |  | [optional] [default to undefined]
+**boxes** | **number** | Number of boxes | [optional] [default to undefined]
+**collectionTimeFrom** | **string** | Date Time | [optional] [default to undefined]
+**collectionTimeTo** | **string** | Date Time | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaCollectionDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaCollectionDTO = {
+    address,
+    boxes,
+    collectionTimeFrom,
+    collectionTimeTo,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RmaCreditItemRequestDTO.md

@@ -0,0 +1,25 @@
+# RmaCreditItemRequestDTO
+
+RMA Credit Request Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rmaItemId** | **number** | RMA Item ID | [optional] [default to undefined]
+**refundPercentage** | **number** | Refund Percentage | [optional] [default to undefined]
+**returnStock** | **boolean** | Return Item to Stock | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaCreditItemRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaCreditItemRequestDTO = {
+    rmaItemId,
+    refundPercentage,
+    returnStock,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RmaDTO.md

@@ -0,0 +1,43 @@
+# RmaDTO
+
+RMA
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | RMA ID | [optional] [default to undefined]
+**contactName** | **string** | Contact Name | [optional] [default to undefined]
+**contactEmail** | **string** | Contact Email | [optional] [default to undefined]
+**orderId** | **number** | Associated Order ID | [optional] [default to undefined]
+**reason** | **number** | RMA Reason | [optional] [default to undefined]
+**faultReport** | **string** | Fault Report | [optional] [default to undefined]
+**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
+**resolution** | **number** | RMA Resolution | [optional] [default to undefined]
+**status** | **number** | RMA Status | [optional] [default to undefined]
+**approved** | **boolean** | RMA Approval Status | [optional] [default to undefined]
+**address** | [**AddressDTO**](AddressDTO.md) | RMA Return Address | [optional] [default to undefined]
+**items** | [**Array<RmaItemDTO>**](RmaItemDTO.md) | RMA Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaDTO = {
+    id,
+    contactName,
+    contactEmail,
+    orderId,
+    reason,
+    faultReport,
+    ticketId,
+    resolution,
+    status,
+    approved,
+    address,
+    items,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RmaItemDTO.md

@@ -0,0 +1,33 @@
+# RmaItemDTO
+
+RMA Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | RMA Item ID | [optional] [default to undefined]
+**itemId** | **number** | RMA Order Item ID | [optional] [default to undefined]
+**itemName** | **string** | RMA Item Name | [optional] [default to undefined]
+**macAddress** | **string** | RMA Item MAC Address | [optional] [default to undefined]
+**serialNumber** | **string** | RMA Item Serial Number | [optional] [default to undefined]
+**received** | **boolean** | RMA Item Received Status | [optional] [default to undefined]
+**status** | **number** | RMA Item Status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaItemDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaItemDTO = {
+    id,
+    itemId,
+    itemName,
+    macAddress,
+    serialNumber,
+    received,
+    status,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RmaItemRequestDTO.md

@@ -0,0 +1,25 @@
+# RmaItemRequestDTO
+
+RMA Request Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**itemId** | **number** | RMA Item ID | [optional] [default to undefined]
+**macAddress** | **string** | RMA Item MAC Address | [optional] [default to undefined]
+**serialNumber** | **string** | RMA Item Serial Number | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaItemRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaItemRequestDTO = {
+    itemId,
+    macAddress,
+    serialNumber,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RmaReplacementOrderItemDTO.md

@@ -0,0 +1,23 @@
+# RmaReplacementOrderItemDTO
+
+RMA Replacement Order Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Replaced RMA Item ID | [optional] [default to undefined]
+**sku** | **string** | Replacement RMA Item SKU | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaReplacementOrderItemDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaReplacementOrderItemDTO = {
+    id,
+    sku,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RmaReplacementOrderRequestDTO.md

@@ -0,0 +1,21 @@
+# RmaReplacementOrderRequestDTO
+
+RMA Replacement Order Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<RmaReplacementOrderItemDTO>**](RmaReplacementOrderItemDTO.md) | RMA Replacement Order Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaReplacementOrderRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaReplacementOrderRequestDTO = {
+    items,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RmaRequestDTO.md

@@ -0,0 +1,34 @@
+# RmaRequestDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contactName** | **string** | Contact Name | [optional] [default to undefined]
+**contactEmail** | **string** | Contact Email | [optional] [default to undefined]
+**orderId** | **number** | Associated Order ID | [optional] [default to undefined]
+**reason** | **number** | RMA Reason | [optional] [default to undefined]
+**faultReport** | **string** | Fault Report | [optional] [default to undefined]
+**requestedResolution** | **number** | RMA Resolution | [optional] [default to undefined]
+**items** | [**Array<RmaItemRequestDTO>**](RmaItemRequestDTO.md) | RMA Items | [optional] [default to undefined]
+**address** | [**AddressDTO**](AddressDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaRequestDTO = {
+    contactName,
+    contactEmail,
+    orderId,
+    reason,
+    faultReport,
+    requestedResolution,
+    items,
+    address,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RmaReturnDTO.md

@@ -0,0 +1,31 @@
+# RmaReturnDTO
+
+RMA Return Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | [**AddressDTO**](AddressDTO.md) |  | [optional] [default to undefined]
+**items** | **Array<number>** | RMA Item IDs | [optional] [default to undefined]
+**service** | **string** | Shipping Service Code | [optional] [default to undefined]
+**boxes** | **number** | Number of boxes to ship | [optional] [default to undefined]
+**contactEmail** | **string** | Contact Email | [optional] [default to undefined]
+**contactTelephone** | **string** | Contact Telephone | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaReturnDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaReturnDTO = {
+    address,
+    items,
+    service,
+    boxes,
+    contactEmail,
+    contactTelephone,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RmaSummaryDTO.md

@@ -0,0 +1,29 @@
+# RmaSummaryDTO
+
+RMA Summary DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | RMA ID | [optional] [default to undefined]
+**orderId** | **number** | Order ID | [optional] [default to undefined]
+**orderReference** | **string** | Order Reference | [optional] [default to undefined]
+**status** | **number** | RMA Status | [optional] [default to undefined]
+**items** | [**Array<RmaSummaryItemDTO>**](RmaSummaryItemDTO.md) | RMA Summary Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaSummaryDTO = {
+    id,
+    orderId,
+    orderReference,
+    status,
+    items,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RmaSummaryItemDTO.md

@@ -0,0 +1,23 @@
+# RmaSummaryItemDTO
+
+RMA Item Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**itemName** | **string** | RMA Item Name | [optional] [default to undefined]
+**quantity** | **number** | RMA Item Quantity | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RmaSummaryItemDTO } from 'yellowgrid-api-ts';
+
+const instance: RmaSummaryItemDTO = {
+    itemName,
+    quantity,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SIPTrunksApi.md

@@ -1,6 +1,6 @@
 # SIPTrunksApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SMSApi.md

@@ -1,6 +1,6 @@
 # SMSApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SerialNumberRequestModel.md

@@ -0,0 +1,21 @@
+# SerialNumberRequestModel
+
+Serial Number Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**serialNumber** | **string** | Serial Number | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SerialNumberRequestModel } from 'yellowgrid-api-ts';
+
+const instance: SerialNumberRequestModel = {
+    serialNumber,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SeriesDTO.md

@@ -0,0 +1,27 @@
+# SeriesDTO
+
+Graph Series Data
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name | [optional] [default to undefined]
+**type** | **string** | Type | [optional] [default to undefined]
+**stack** | **string** | Stack | [optional] [default to undefined]
+**data** | **Array<string>** | Data | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesDTO } from 'yellowgrid-api-ts';
+
+const instance: SeriesDTO = {
+    name,
+    type,
+    stack,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ServicesApi.md

@@ -1,6 +1,6 @@
 # ServicesApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ShippingApi.md

@@ -1,6 +1,6 @@
 # ShippingApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/StockManagementApi.md

@@ -1,6 +1,6 @@
 # StockManagementApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/StockReportItemModel.md

@@ -0,0 +1,31 @@
+# StockReportItemModel
+
+Stock Report Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Title | [optional] [default to undefined]
+**sku** | **string** | SKU | [optional] [default to undefined]
+**quantity** | **number** | In Stock | [optional] [default to undefined]
+**currency** | **string** | Currency | [optional] [default to undefined]
+**basePrice** | **number** | Cost Price | [optional] [default to undefined]
+**totalValue** | **number** | Line Total | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockReportItemModel } from 'yellowgrid-api-ts';
+
+const instance: StockReportItemModel = {
+    title,
+    sku,
+    quantity,
+    currency,
+    basePrice,
+    totalValue,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockReportModel.md

@@ -0,0 +1,29 @@
+# StockReportModel
+
+Stock Report
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**products** | [**Array<StockReportItemModel>**](StockReportItemModel.md) | Items | [optional] [default to undefined]
+**unitsInStock** | **number** | Units In Stock | [optional] [default to undefined]
+**usdStock** | **number** | Value Of USD Stock | [optional] [default to undefined]
+**gbpStock** | **number** | Value Of GBP Stock | [optional] [default to undefined]
+**totalStockGbp** | **number** | Total value of stock in GBP | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockReportModel } from 'yellowgrid-api-ts';
+
+const instance: StockReportModel = {
+    products,
+    unitsInStock,
+    usdStock,
+    gbpStock,
+    totalStockGbp,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)