yellowgrid-api-ts 3.2.219 → 3.2.220-dev.0

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/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/SdrReferenceType.md

@@ -0,0 +1,24 @@
+# SdrReferenceType
+
+
+## Enum
+
+* `SipTrunk` (value: `'SIP_TRUNK'`)
+
+* `Broadband` (value: `'BROADBAND'`)
+
+* `Ethernet` (value: `'ETHERNET'`)
+
+* `Mobile` (value: `'MOBILE'`)
+
+* `Wlr` (value: `'WLR'`)
+
+* `Hzn` (value: `'HZN'`)
+
+* `Nts` (value: `'NTS'`)
+
+* `Hosting` (value: `'HOSTING'`)
+
+* `Crm` (value: `'CRM'`)
+
+[[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/Service.md

@@ -0,0 +1,42 @@
+# Service
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**servicePlanId** | **number** |  | [optional] [default to undefined]
+**servicePlan** | [**ServicePlan**](ServicePlan.md) |  | [optional] [default to undefined]
+**baseServiceId** | **number** |  | [optional] [default to undefined]
+**baseService** | [**BaseService**](BaseService.md) |  | [optional] [default to undefined]
+**customerRate** | [**CustomerRate**](CustomerRate.md) |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**hideOnInvoice** | **boolean** |  | [optional] [default to undefined]
+**bureauRate** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**common** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Service } from 'yellowgrid-api-ts';
+
+const instance: Service = {
+    createdDate,
+    id,
+    servicePlanId,
+    servicePlan,
+    baseServiceId,
+    baseService,
+    customerRate,
+    description,
+    hideOnInvoice,
+    bureauRate,
+    filePeriod,
+    common,
+};
+```
+
+[[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/ServicePlan.md

@@ -0,0 +1,36 @@
+# ServicePlan
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**services** | [**Array<Service>**](Service.md) |  | [optional] [readonly] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**planGroup** | **string** |  | [optional] [default to undefined]
+**connectionTypeId** | **number** |  | [optional] [default to undefined]
+**connectionType** | [**ConnectionType**](ConnectionType.md) |  | [optional] [default to undefined]
+**closed** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ServicePlan } from 'yellowgrid-api-ts';
+
+const instance: ServicePlan = {
+    createdDate,
+    id,
+    name,
+    services,
+    filePeriod,
+    planGroup,
+    connectionTypeId,
+    connectionType,
+    closed,
+};
+```
+
+[[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)

package/docs/SuppliersApi.md

@@ -0,0 +1,230 @@
+# SuppliersApi
+
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetSupplierItem**](#getgetsupplieritem) | **GET** /suppliers/items/{id} | Get Supplier Item|
+|[**getGetSupplierItems**](#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items|
+|[**getGetSuppliers**](#getgetsuppliers) | **GET** /suppliers | Get Suppliers|
+|[**putGetSupplierItem**](#putgetsupplieritem) | **PUT** /suppliers/items/{id} | Update Supplier Product|
+
+# **getGetSupplierItem**
+> SupplierProductModel getGetSupplierItem()
+
+Get Supplier Item
+
+### Example
+
+```typescript
+import {
+    SuppliersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SuppliersApi(configuration);
+
+let id: string; //ID (SKU) (default to undefined)
+
+const { status, data } = await apiInstance.getGetSupplierItem(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID (SKU) | defaults to undefined|
+
+
+### Return type
+
+**SupplierProductModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Supplier Item |  -  |
+|**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)
+
+# **getGetSupplierItems**
+> SupplierProductResultsModel getGetSupplierItems()
+
+Get Supplier Items
+
+### Example
+
+```typescript
+import {
+    SuppliersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SuppliersApi(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.getGetSupplierItems(
+    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
+
+**SupplierProductResultsModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Supplier Items |  -  |
+|**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)
+
+# **getGetSuppliers**
+> Array<SupplierModel> getGetSuppliers()
+
+Get Suppliers
+
+### Example
+
+```typescript
+import {
+    SuppliersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SuppliersApi(configuration);
+
+const { status, data } = await apiInstance.getGetSuppliers();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<SupplierModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Suppliers |  -  |
+|**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)
+
+# **putGetSupplierItem**
+> SupplierProductModel putGetSupplierItem()
+
+Update Supplier Product
+
+### Example
+
+```typescript
+import {
+    SuppliersApi,
+    Configuration,
+    SupplierProductModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SuppliersApi(configuration);
+
+let id: string; //ID (SKU) (default to undefined)
+let supplierProductModel: SupplierProductModel; //Supplier Product (optional)
+
+const { status, data } = await apiInstance.putGetSupplierItem(
+    id,
+    supplierProductModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **supplierProductModel** | **SupplierProductModel**| Supplier Product | |
+| **id** | [**string**] | ID (SKU) | defaults to undefined|
+
+
+### Return type
+
+**SupplierProductModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Supplier Product Model |  -  |
+|**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)
+

package/docs/SystemApi.md

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