yellowgrid-api-ts 3.2.202 → 3.2.203-dev.0

package/docs/PatchUpdateAccountNameRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateAccountNameRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Company Name | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateAccountNameRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateAccountNameRequest = {
+    name,
+};
+```
+
+[[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/PostAddAdminNoteRequest.md

@@ -0,0 +1,20 @@
+# PostAddAdminNoteRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**note** | **string** | Note | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostAddAdminNoteRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddAdminNoteRequest = {
+    note,
+};
+```
+
+[[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/PostGetProductRequest.md

@@ -0,0 +1,24 @@
+# PostGetProductRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **number** | Quantity | [optional] [default to undefined]
+**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
+**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetProductRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetProductRequest = {
+    quantity,
+    licenceKey,
+    hosting,
+};
+```
+
+[[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/PricingApi.md

@@ -1,6 +1,6 @@
 # PricingApi
 
-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/ProductDetailedSummaryDTO.md

@@ -0,0 +1,41 @@
+# ProductDetailedSummaryDTO
+
+Product Detailed Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**title** | **string** | Title | [optional] [default to undefined]
+**quantity** | **number** | Stock Quantity | [optional] [default to undefined]
+**stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
+**price** | **number** | Price | [optional] [default to undefined]
+**cartonSize** | **number** | Carton Size | [optional] [default to undefined]
+**rrp** | **number** | RRP Price | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
+**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+**dueDate** | **string** | Date Time | [optional] [default to undefined]
+**onOrder** | **number** | On Order | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductDetailedSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: ProductDetailedSummaryDTO = {
+    sku,
+    title,
+    quantity,
+    stockProduct,
+    price,
+    cartonSize,
+    rrp,
+    licenceDetails,
+    hosting,
+    dueDate,
+    onOrder,
+};
+```
+
+[[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/ProductSearchDTO.md

@@ -0,0 +1,37 @@
+# ProductSearchDTO
+
+Product Search
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**quantity** | **number** | Quantity | [optional] [default to undefined]
+**licenceKey** | **string** | Licence Key | [optional] [default to undefined]
+**hosting** | **boolean** | Hosting | [optional] [default to undefined]
+**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
+**renewalYears** | **number** | 3CX Renewal Years | [optional] [default to undefined]
+**orderId** | **number** | Order ID | [optional] [default to undefined]
+**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
+**discount** | **number** | Discount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductSearchDTO } from 'yellowgrid-api-ts';
+
+const instance: ProductSearchDTO = {
+    sku,
+    quantity,
+    licenceKey,
+    hosting,
+    tcxSalesCode,
+    renewalYears,
+    orderId,
+    items,
+    discount,
+};
+```
+
+[[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/ProductSummaryDTO.md

@@ -10,12 +10,10 @@ Name | Type | Description | Notes
 **title** | **string** | Title | [optional] [default to undefined]
 **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
 **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
-**dueDate** | **string** | Due Date | [optional] [default to undefined]
-**onOrder** | **number** | On Order | [optional] [default to undefined]
 **price** | **number** | Price | [optional] [default to undefined]
 **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
 **rrp** | **number** | RRP Price | [optional] [default to undefined]
-**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
 
 ## Example
@@ -28,8 +26,6 @@ const instance: ProductSummaryDTO = {
     title,
     quantity,
     stockProduct,
-    dueDate,
-    onOrder,
     price,
     cartonSize,
     rrp,

package/docs/ProductsApi.md

@@ -1,6 +1,6 @@
 # ProductsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -422,7 +422,7 @@ 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)
 
 # **postGetProduct**
-> ProductSummaryDTO postGetProduct(postGetProductForCustomerRequest)
+> ProductDetailedSummaryDTO postGetProduct(postGetProductForCustomerRequest)
 
 Get Product
 
@@ -460,7 +460,7 @@ const { status, data } = await apiInstance.postGetProduct(
 
 ### Return type
 
-**ProductSummaryDTO**
+**ProductDetailedSummaryDTO**
 
 ### Authorization
 
@@ -483,7 +483,7 @@ 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)
 
 # **postGetProductForCustomer**
-> ProductSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
+> ProductDetailedSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
 
 Get Product For Customer
 
@@ -524,7 +524,7 @@ const { status, data } = await apiInstance.postGetProductForCustomer(
 
 ### Return type
 
-**ProductSummaryDTO**
+**ProductDetailedSummaryDTO**
 
 ### Authorization
 

package/docs/ProspectDTO.md

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **companyName** | **string** | Company Name | [optional] [default to undefined]
 **telephone** | **string** | Telephone | [optional] [default to undefined]
-**lastOrderDate** | **string** | Last Order Date | [optional] [default to undefined]
-**callbackDate** | **string** | Call Back Date | [optional] [default to undefined]
+**lastOrderDate** | **string** | Date Time | [optional] [default to undefined]
+**callbackDate** | **string** | Date Time | [optional] [default to undefined]
 **xeroId** | **string** | Xero ID | [optional] [default to undefined]
 **removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
 **status** | **string** | Status | [optional] [default to undefined]

package/docs/ProspectsApi.md

@@ -1,6 +1,6 @@
 # ProspectsApi
 
-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/ProvisioningApi.md

@@ -1,6 +1,6 @@
 # ProvisioningApi
 
-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/RecordingsBackupInfoDTO.md

@@ -6,8 +6,8 @@ Recordings Backup Info
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | Azure Backup Storage | [optional] [default to undefined]
-**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [optional] [default to undefined]
+**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) |  | [optional] [default to undefined]
+**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) |  | [optional] [default to undefined]
 
 ## Example
 

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** | Date Time | [optional] [default to undefined]
+**end** | **string** | Date Time | [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**
+> GraphDTO 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
+
+**GraphDTO**
+
+### 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/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/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/ShipmentRequestDTO.md

@@ -7,10 +7,10 @@ Shipment Request
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **courier** | **string** | Courier | [optional] [default to undefined]
-**address** | [**AddressModel**](AddressModel.md) | Address | [optional] [default to undefined]
+**address** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
 **scannedLines** | **Array<string>** | Scanned Lines | [optional] [default to undefined]
 **service** | **string** | Service | [optional] [default to undefined]
-**shipDate** | **string** | Ship Date | [optional] [default to undefined]
+**shipDate** | **string** | Date Time | [optional] [default to undefined]
 **items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [optional] [default to undefined]
 
 ## Example

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)

package/docs/SupplierItemModel.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **itemPrice** | **number** | itemPrice | [optional] [default to undefined]
 **itemType** | **number** | itemType | [optional] [default to undefined]
 **supplierSku** | **string** | supplierSku | [optional] [default to undefined]
+**supplier** | [**SupplierModel**](SupplierModel.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -29,6 +30,7 @@ const instance: SupplierItemModel = {
     itemPrice,
     itemType,
     supplierSku,
+    supplier,
 };
 ```
 

package/docs/SupplierItemsResultsDTO.md

@@ -0,0 +1,21 @@
+# SupplierItemsResultsDTO
+
+Supplier Item Results
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SupplierItemsResultsDTO } from 'yellowgrid-api-ts';
+
+const instance: SupplierItemsResultsDTO = {
+    results,
+};
+```
+
+[[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/SupplierProductModel.md

@@ -0,0 +1,25 @@
+# SupplierProductModel
+
+Supplier Product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**description** | **string** | Description | [optional] [default to undefined]
+**items** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SupplierProductModel } from 'yellowgrid-api-ts';
+
+const instance: SupplierProductModel = {
+    sku,
+    description,
+    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/SupplierProductResultsModel.md

@@ -0,0 +1,27 @@
+# SupplierProductResultsModel
+
+Supplier Product Results
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<SupplierProductModel>**](SupplierProductModel.md) | Results | [optional] [default to undefined]
+**page** | **number** | Page | [optional] [default to undefined]
+**perPage** | **number** | Per Page | [optional] [default to undefined]
+**totalResults** | **number** | Total Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SupplierProductResultsModel } from 'yellowgrid-api-ts';
+
+const instance: SupplierProductResultsModel = {
+    results,
+    page,
+    perPage,
+    totalResults,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)