yellowgrid-api-ts 3.2.262 → 3.2.264-dev.0

package/docs/OrdersApi.md

@@ -1,6 +1,6 @@
 # OrdersApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -10,6 +10,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
 |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
 |[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
+|[**getGetCustomerOrderSummary**](#getgetcustomerordersummary) | **GET** /orders/{id}/summary | |
 |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
 |[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
 |[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
@@ -21,6 +22,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
 |[**postCreatePortalOrderLegacy**](#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal|
 |[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
+|[**postCreateWizardFromOrder**](#postcreatewizardfromorder) | **POST** /admin/orders/{id}/wizard | |
 |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
 |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
 |[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
@@ -375,6 +377,60 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getGetCustomerOrderSummary**
+> OrderSummaryDTO getGetCustomerOrderSummary()
+
+Get Order
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let id: number; //Order ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetCustomerOrderSummary(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**OrderSummaryDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Summary |  -  |
+|**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)
+
 # **getGetEditableOrder**
 > DetailedOrderRequestDTO getGetEditableOrder()
 
@@ -1016,6 +1072,64 @@ 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)
 
+# **postCreateWizardFromOrder**
+> TcxSummaryDTO postCreateWizardFromOrder()
+
+Create Engineered Wizard
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    EngineeredWizardRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let id: number; //Order ID (default to undefined)
+let engineeredWizardRequestModel: EngineeredWizardRequestModel; //Engineered Wizard Request (optional)
+
+const { status, data } = await apiInstance.postCreateWizardFromOrder(
+    id,
+    engineeredWizardRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **engineeredWizardRequestModel** | **EngineeredWizardRequestModel**| Engineered Wizard Request | |
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**TcxSummaryDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Wizard Details |  -  |
+|**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)
+
 # **postGetOrders**
 > Array<OrderSummaryDTO> postGetOrders()
 
@@ -1437,19 +1551,18 @@ Split Order
 ```typescript
 import {
     OrdersApi,
-    Configuration,
-    PostSplitOrderRequest
+    Configuration
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
 let id: number; //Order ID (default to undefined)
-let postSplitOrderRequest: PostSplitOrderRequest; // (optional)
+let customerItemRequestDTO: Array<CustomerItemRequestDTO>; // (optional)
 
 const { status, data } = await apiInstance.postSplitOrder(
     id,
-    postSplitOrderRequest
+    customerItemRequestDTO
 );
 ```
 
@@ -1457,7 +1570,7 @@ const { status, data } = await apiInstance.postSplitOrder(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **postSplitOrderRequest** | **PostSplitOrderRequest**|  | |
+| **customerItemRequestDTO** | **Array<CustomerItemRequestDTO>**|  | |
 | **id** | [**number**] | Order ID | defaults to undefined|
 
 

package/docs/PartnerDTO.md

@@ -7,16 +7,17 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **partnerId** | **string** | 3CX Partner ID | [optional] [default to undefined]
-**companyName** | **string** | 3CX Partner Company Name | [optional] [default to undefined]
-**contactName** | **string** | 3CX Partner Contact Name | [optional] [default to undefined]
-**contactPhone** | **string** | 3CX Partner Contact Phone | [optional] [default to undefined]
-**contactEmail** | **string** | 3CX Partner Contact Email | [optional] [default to undefined]
-**partnerLevel** | **string** | 3CX Partner Level | [optional] [default to undefined]
-**licenceDiscountPercent** | **number** | 3CX Partner Licence Discount Percent | [optional] [default to undefined]
-**hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [optional] [default to undefined]
-**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
-**installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
-**aligned** | **boolean** | Aligned | [optional] [default to undefined]
+**companyName** | **string** | 3CX Partner Company Name | [default to undefined]
+**contactName** | **string** | 3CX Partner Contact Name | [default to undefined]
+**contactPhone** | **string** | 3CX Partner Contact Phone | [default to undefined]
+**contactEmail** | **string** | 3CX Partner Contact Email | [default to undefined]
+**partnerLevel** | **string** | 3CX Partner Level | [default to undefined]
+**licenceDiscountPercent** | **number** | 3CX Partner Licence Discount Percent | [default to undefined]
+**hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [default to undefined]
+**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [default to undefined]
+**installationUrl** | **string** | 3CX Installation URL | [default to undefined]
+**aligned** | **boolean** | Aligned | [default to undefined]
+**dateAligned** | **string** | Date Aligned | [optional] [default to undefined]
 **customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [optional] [default to undefined]
 
 ## Example
@@ -36,6 +37,7 @@ const instance: PartnerDTO = {
     hostingPriceListId,
     installationUrl,
     aligned,
+    dateAligned,
     customer,
 };
 ```

package/docs/PasswordSenderDTO.md

@@ -6,12 +6,12 @@ Password Sender Request
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**username** | **string** | Username | [optional] [default to undefined]
+**username** | **string** | Username | [default to undefined]
 **password** | **string** | Password | [optional] [default to undefined]
 **expiryInterval** | **number** | Expiry Interval | [optional] [default to undefined]
 **intervalType** | **string** | Interval Type | [optional] [default to undefined]
 **expiry** | **string** | Expiry | [optional] [default to undefined]
-**recipient** | **Array<string>** | Recipient | [optional] [default to undefined]
+**recipient** | **Array<string>** | Recipient | [default to undefined]
 **url** | **string** | URL | [optional] [default to undefined]
 **description** | **string** | Description | [optional] [default to undefined]
 **passwordUrl** | **string** | Password URL | [optional] [default to undefined]

package/docs/PasswordSenderEntity.md

@@ -6,13 +6,13 @@ PasswordSenderEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**uniqueId** | **string** | uniqueId | [optional] [default to undefined]
-**url** | **string** | url | [optional] [default to undefined]
-**username** | **string** | username | [optional] [default to undefined]
-**password** | **string** | password | [optional] [default to undefined]
-**expiryTime** | **string** | expiryTime | [optional] [default to undefined]
-**emailRecipient** | **string** | emailRecipient | [optional] [default to undefined]
-**description** | **string** | description | [optional] [default to undefined]
+**uniqueId** | **string** | uniqueId | [default to undefined]
+**url** | **string** | url | [default to undefined]
+**username** | **string** | username | [default to undefined]
+**password** | **string** | password | [default to undefined]
+**expiryTime** | **string** | expiryTime | [default to undefined]
+**emailRecipient** | **string** | emailRecipient | [default to undefined]
+**description** | **string** | description | [default to undefined]
 
 ## Example
 

package/docs/PatchApproveRmaRequest.md

@@ -0,0 +1,20 @@
+# PatchApproveRmaRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sendEmail** | **boolean** | Send email to customer | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchApproveRmaRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchApproveRmaRequest = {
+    sendEmail,
+};
+```
+
+[[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/PortalAccountModel.md

@@ -6,29 +6,30 @@ Customer Account
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | ID | [optional] [default to undefined]
-**name** | **string** | Contact Name | [optional] [default to undefined]
-**email** | **string** | Email | [optional] [default to undefined]
-**phone** | **string** | Phone Number | [optional] [default to undefined]
-**company** | **string** | Company Name | [optional] [default to undefined]
-**companyNumber** | **string** | Company Registration Number | [optional] [default to undefined]
-**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
-**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
-**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
-**city** | **string** | City | [optional] [default to undefined]
-**county** | **string** | County | [optional] [default to undefined]
-**iso** | **string** | Country ISO Code | [optional] [default to undefined]
-**postalCode** | **string** | Post Code | [optional] [default to undefined]
-**accountNumber** | **string** | Account Number | [optional] [default to undefined]
-**xeroId** | **string** | Xero Contact ID | [optional] [default to undefined]
-**creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
-**paymentMethod** | **string** | Payment Method | [optional] [default to undefined]
-**servicePaymentMethod** | **string** | Service Payment Method | [optional] [default to undefined]
-**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
-**creationDate** | **string** | Creation Date | [optional] [default to undefined]
-**prizePromo** | **boolean** | Prize Promo Enabled | [optional] [default to undefined]
-**portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
-**cname** | **string** | Wizard CNAME | [optional] [default to undefined]
+**id** | **number** | ID | [default to undefined]
+**name** | **string** | Contact Name | [default to undefined]
+**email** | **string** | Email | [default to undefined]
+**phone** | **string** | Phone Number | [default to undefined]
+**company** | **string** | Company Name | [default to undefined]
+**companyNumber** | **string** | Company Registration Number | [default to undefined]
+**vatNumber** | **string** | VAT Number | [default to undefined]
+**addressLine1** | **string** | Address Line 1 | [default to undefined]
+**addressLine2** | **string** | Address Line 2 | [default to undefined]
+**city** | **string** | City | [default to undefined]
+**county** | **string** | County | [default to undefined]
+**iso** | **string** | Country ISO Code | [default to undefined]
+**postalCode** | **string** | Post Code | [default to undefined]
+**accountNumber** | **string** | Account Number | [default to undefined]
+**xeroId** | **string** | Xero Contact ID | [default to undefined]
+**creditLimit** | **number** | Credit Limit | [default to undefined]
+**paymentMethod** | **string** | Payment Method | [default to undefined]
+**servicePaymentMethod** | **string** | Service Payment Method | [default to undefined]
+**resellerId** | **string** | 3CX Reseller ID | [default to undefined]
+**dateAligned** | **string** | Date Aligned At 3CX | [default to undefined]
+**creationDate** | **string** | Creation Date | [default to undefined]
+**prizePromo** | **boolean** | Prize Promo Enabled | [default to undefined]
+**portalAccess** | **boolean** | Portal Access | [default to undefined]
+**cname** | **string** | Wizard CNAME | [default to undefined]
 **directDebitMandate** | **boolean** | Active Direct Debit Mandate | [optional] [default to undefined]
 **navigation** | [**Array<NavigationModel>**](NavigationModel.md) | Portal Navigation | [optional] [default to undefined]
 
@@ -57,6 +58,7 @@ const instance: PortalAccountModel = {
     paymentMethod,
     servicePaymentMethod,
     resellerId,
+    dateAligned,
     creationDate,
     prizePromo,
     portalAccess,

package/docs/PortalLoginModel.md

@@ -6,13 +6,13 @@ Portal Login
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **string** | Email Address | [optional] [default to undefined]
-**password** | **string** | Password | [optional] [default to undefined]
-**code** | **string** | MFA Code | [optional] [default to undefined]
-**secret** | **string** | MFA Secret | [optional] [default to undefined]
-**codeChallenge** | **string** | Oauth 2.0 code challenge | [optional] [default to undefined]
-**codeVerifier** | **string** | Oauth 2.0 code verifier | [optional] [default to undefined]
-**redirect_uri** | **string** | Oauth 2.0 code redirect uri | [optional] [default to undefined]
+**email** | **string** | Email Address | [default to undefined]
+**password** | **string** | Password | [default to undefined]
+**code** | **string** | MFA Code | [default to undefined]
+**secret** | **string** | MFA Secret | [default to undefined]
+**codeChallenge** | **string** | Oauth 2.0 code challenge | [default to undefined]
+**codeVerifier** | **string** | Oauth 2.0 code verifier | [default to undefined]
+**redirect_uri** | **string** | Oauth 2.0 code redirect uri | [default to undefined]
 
 ## Example
 

package/docs/PostGenerateReport200Response.md

@@ -5,15 +5,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **string** | Title | [optional] [default to undefined]
-**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [optional] [default to undefined]
-**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [optional] [default to undefined]
-**legend** | **Array<string>** | Legend | [optional] [default to undefined]
-**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [optional] [default to undefined]
+**title** | **string** | Title | [default to undefined]
+**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [default to undefined]
+**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [default to undefined]
+**legend** | **Array<string>** | Legend | [default to undefined]
+**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [default to undefined]
 **currency** | **string** | Currency | [optional] [default to undefined]
-**locale** | **string** | Locale | [optional] [default to undefined]
-**headers** | [**TableRowDTO**](TableRowDTO.md) |  | [optional] [default to undefined]
-**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [optional] [default to undefined]
+**locale** | **string** | Locale | [default to undefined]
+**headers** | [**TableRowDTO**](TableRowDTO.md) |  | [default to undefined]
+**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [default to undefined]
 
 ## Example
 

package/docs/PriceListItemModel.md

@@ -6,9 +6,9 @@ Price & Stock List
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **string** | Title | [optional] [default to undefined]
+**title** | **string** | Title | [default to undefined]
 **sku** | **string** | SKU | [optional] [default to undefined]
-**price** | **number** | Price | [optional] [default to undefined]
+**price** | **number** | Price | [default to undefined]
 **rrp** | **number** | RRP | [optional] [default to undefined]
 **stock** | **number** | Stock | [optional] [default to undefined]
 

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|
 |------------- | ------------- | -------------|
@@ -25,7 +25,7 @@ const apiInstance = new PricingApi(configuration);
 
 let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks' | 'CRM Integrations' | 'Jedware'; //Price List Type (default to undefined)
 let format: 'pdf' | 'json' | 'csv' | 'xml' | 'html'; //Document Format (default to undefined)
-let category: 'Yealink' | 'Mairdi' | 'Jabra' | '3CX' | 'Fanvil' | 'VT' | 'Netgear' | 'Algo' | 'Yealink Headsets' | 'Yealink DECT Handsets' | 'Yealink DECT Headsets' | 'Yealink BT Headsets' | 'Yealink USB Wired Headsets' | 'Yealink Meeting Rooms' | 'Fanvil Phones' | 'Fanvil Headsets' | 'Fanvil Wireless Phones' | 'Fanvil Security Products' | 'Fanvil Accessories' | 'Fanvil Hotel Phones'; //Product Category (optional) (default to undefined)
+let category: 'VoIP Phones' | 'Yealink' | 'Mairdi' | 'Jabra' | '3CX' | 'Fanvil' | 'VT' | 'Netgear' | 'Algo' | 'Yealink Headsets' | 'Yealink DECT Handsets' | 'Yealink DECT Headsets' | 'Yealink BT Headsets' | 'Yealink USB Wired Headsets' | 'Yealink Meeting Rooms' | 'Fanvil Phones' | 'Fanvil Headsets' | 'Fanvil Wireless Phones' | 'Fanvil Security Products' | 'Fanvil Accessories' | 'Fanvil Hotel Phones'; //Product Category (optional) (default to undefined)
 let customerId: string; //Customer ID (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getGetPriceList(
@@ -42,7 +42,7 @@ const { status, data } = await apiInstance.getGetPriceList(
 |------------- | ------------- | ------------- | -------------|
 | **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39; | &#39;CRM Integrations&#39; | &#39;Jedware&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39; &#124; &#39;CRM Integrations&#39; &#124; &#39;Jedware&#39;>** | Price List Type | defaults to undefined|
 | **format** | [**&#39;pdf&#39; | &#39;json&#39; | &#39;csv&#39; | &#39;xml&#39; | &#39;html&#39;**]**Array<&#39;pdf&#39; &#124; &#39;json&#39; &#124; &#39;csv&#39; &#124; &#39;xml&#39; &#124; &#39;html&#39;>** | Document Format | defaults to undefined|
-| **category** | [**&#39;Yealink&#39; | &#39;Mairdi&#39; | &#39;Jabra&#39; | &#39;3CX&#39; | &#39;Fanvil&#39; | &#39;VT&#39; | &#39;Netgear&#39; | &#39;Algo&#39; | &#39;Yealink Headsets&#39; | &#39;Yealink DECT Handsets&#39; | &#39;Yealink DECT Headsets&#39; | &#39;Yealink BT Headsets&#39; | &#39;Yealink USB Wired Headsets&#39; | &#39;Yealink Meeting Rooms&#39; | &#39;Fanvil Phones&#39; | &#39;Fanvil Headsets&#39; | &#39;Fanvil Wireless Phones&#39; | &#39;Fanvil Security Products&#39; | &#39;Fanvil Accessories&#39; | &#39;Fanvil Hotel Phones&#39;**]**Array<&#39;Yealink&#39; &#124; &#39;Mairdi&#39; &#124; &#39;Jabra&#39; &#124; &#39;3CX&#39; &#124; &#39;Fanvil&#39; &#124; &#39;VT&#39; &#124; &#39;Netgear&#39; &#124; &#39;Algo&#39; &#124; &#39;Yealink Headsets&#39; &#124; &#39;Yealink DECT Handsets&#39; &#124; &#39;Yealink DECT Headsets&#39; &#124; &#39;Yealink BT Headsets&#39; &#124; &#39;Yealink USB Wired Headsets&#39; &#124; &#39;Yealink Meeting Rooms&#39; &#124; &#39;Fanvil Phones&#39; &#124; &#39;Fanvil Headsets&#39; &#124; &#39;Fanvil Wireless Phones&#39; &#124; &#39;Fanvil Security Products&#39; &#124; &#39;Fanvil Accessories&#39; &#124; &#39;Fanvil Hotel Phones&#39;>** | Product Category | (optional) defaults to undefined|
+| **category** | [**&#39;VoIP Phones&#39; | &#39;Yealink&#39; | &#39;Mairdi&#39; | &#39;Jabra&#39; | &#39;3CX&#39; | &#39;Fanvil&#39; | &#39;VT&#39; | &#39;Netgear&#39; | &#39;Algo&#39; | &#39;Yealink Headsets&#39; | &#39;Yealink DECT Handsets&#39; | &#39;Yealink DECT Headsets&#39; | &#39;Yealink BT Headsets&#39; | &#39;Yealink USB Wired Headsets&#39; | &#39;Yealink Meeting Rooms&#39; | &#39;Fanvil Phones&#39; | &#39;Fanvil Headsets&#39; | &#39;Fanvil Wireless Phones&#39; | &#39;Fanvil Security Products&#39; | &#39;Fanvil Accessories&#39; | &#39;Fanvil Hotel Phones&#39;**]**Array<&#39;VoIP Phones&#39; &#124; &#39;Yealink&#39; &#124; &#39;Mairdi&#39; &#124; &#39;Jabra&#39; &#124; &#39;3CX&#39; &#124; &#39;Fanvil&#39; &#124; &#39;VT&#39; &#124; &#39;Netgear&#39; &#124; &#39;Algo&#39; &#124; &#39;Yealink Headsets&#39; &#124; &#39;Yealink DECT Handsets&#39; &#124; &#39;Yealink DECT Headsets&#39; &#124; &#39;Yealink BT Headsets&#39; &#124; &#39;Yealink USB Wired Headsets&#39; &#124; &#39;Yealink Meeting Rooms&#39; &#124; &#39;Fanvil Phones&#39; &#124; &#39;Fanvil Headsets&#39; &#124; &#39;Fanvil Wireless Phones&#39; &#124; &#39;Fanvil Security Products&#39; &#124; &#39;Fanvil Accessories&#39; &#124; &#39;Fanvil Hotel Phones&#39;>** | Product Category | (optional) defaults to undefined|
 | **customerId** | [**string**] | Customer ID | (optional) defaults to undefined|
 
 
@@ -90,7 +90,7 @@ let email: string; //Email Address (default to undefined)
 let customerId: string; //Customer ID (default to undefined)
 let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks' | 'CRM Integrations' | 'Jedware'; //Price List Type (default to undefined)
 let format: 'pdf' | 'json' | 'csv' | 'xml' | 'html'; //Document Format (default to undefined)
-let category: 'Yealink' | 'Mairdi' | 'Jabra' | '3CX' | 'Fanvil' | 'VT' | 'Netgear' | 'Algo' | 'Yealink Headsets' | 'Yealink DECT Handsets' | 'Yealink DECT Headsets' | 'Yealink BT Headsets' | 'Yealink USB Wired Headsets' | 'Yealink Meeting Rooms' | 'Fanvil Phones' | 'Fanvil Headsets' | 'Fanvil Wireless Phones' | 'Fanvil Security Products' | 'Fanvil Accessories' | 'Fanvil Hotel Phones'; //Product Category (optional) (default to undefined)
+let category: 'VoIP Phones' | 'Yealink' | 'Mairdi' | 'Jabra' | '3CX' | 'Fanvil' | 'VT' | 'Netgear' | 'Algo' | 'Yealink Headsets' | 'Yealink DECT Handsets' | 'Yealink DECT Headsets' | 'Yealink BT Headsets' | 'Yealink USB Wired Headsets' | 'Yealink Meeting Rooms' | 'Fanvil Phones' | 'Fanvil Headsets' | 'Fanvil Wireless Phones' | 'Fanvil Security Products' | 'Fanvil Accessories' | 'Fanvil Hotel Phones'; //Product Category (optional) (default to undefined)
 
 const { status, data } = await apiInstance.postSendPriceList(
     email,
@@ -109,7 +109,7 @@ const { status, data } = await apiInstance.postSendPriceList(
 | **customerId** | [**string**] | Customer ID | defaults to undefined|
 | **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39; | &#39;CRM Integrations&#39; | &#39;Jedware&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39; &#124; &#39;CRM Integrations&#39; &#124; &#39;Jedware&#39;>** | Price List Type | defaults to undefined|
 | **format** | [**&#39;pdf&#39; | &#39;json&#39; | &#39;csv&#39; | &#39;xml&#39; | &#39;html&#39;**]**Array<&#39;pdf&#39; &#124; &#39;json&#39; &#124; &#39;csv&#39; &#124; &#39;xml&#39; &#124; &#39;html&#39;>** | Document Format | defaults to undefined|
-| **category** | [**&#39;Yealink&#39; | &#39;Mairdi&#39; | &#39;Jabra&#39; | &#39;3CX&#39; | &#39;Fanvil&#39; | &#39;VT&#39; | &#39;Netgear&#39; | &#39;Algo&#39; | &#39;Yealink Headsets&#39; | &#39;Yealink DECT Handsets&#39; | &#39;Yealink DECT Headsets&#39; | &#39;Yealink BT Headsets&#39; | &#39;Yealink USB Wired Headsets&#39; | &#39;Yealink Meeting Rooms&#39; | &#39;Fanvil Phones&#39; | &#39;Fanvil Headsets&#39; | &#39;Fanvil Wireless Phones&#39; | &#39;Fanvil Security Products&#39; | &#39;Fanvil Accessories&#39; | &#39;Fanvil Hotel Phones&#39;**]**Array<&#39;Yealink&#39; &#124; &#39;Mairdi&#39; &#124; &#39;Jabra&#39; &#124; &#39;3CX&#39; &#124; &#39;Fanvil&#39; &#124; &#39;VT&#39; &#124; &#39;Netgear&#39; &#124; &#39;Algo&#39; &#124; &#39;Yealink Headsets&#39; &#124; &#39;Yealink DECT Handsets&#39; &#124; &#39;Yealink DECT Headsets&#39; &#124; &#39;Yealink BT Headsets&#39; &#124; &#39;Yealink USB Wired Headsets&#39; &#124; &#39;Yealink Meeting Rooms&#39; &#124; &#39;Fanvil Phones&#39; &#124; &#39;Fanvil Headsets&#39; &#124; &#39;Fanvil Wireless Phones&#39; &#124; &#39;Fanvil Security Products&#39; &#124; &#39;Fanvil Accessories&#39; &#124; &#39;Fanvil Hotel Phones&#39;>** | Product Category | (optional) defaults to undefined|
+| **category** | [**&#39;VoIP Phones&#39; | &#39;Yealink&#39; | &#39;Mairdi&#39; | &#39;Jabra&#39; | &#39;3CX&#39; | &#39;Fanvil&#39; | &#39;VT&#39; | &#39;Netgear&#39; | &#39;Algo&#39; | &#39;Yealink Headsets&#39; | &#39;Yealink DECT Handsets&#39; | &#39;Yealink DECT Headsets&#39; | &#39;Yealink BT Headsets&#39; | &#39;Yealink USB Wired Headsets&#39; | &#39;Yealink Meeting Rooms&#39; | &#39;Fanvil Phones&#39; | &#39;Fanvil Headsets&#39; | &#39;Fanvil Wireless Phones&#39; | &#39;Fanvil Security Products&#39; | &#39;Fanvil Accessories&#39; | &#39;Fanvil Hotel Phones&#39;**]**Array<&#39;VoIP Phones&#39; &#124; &#39;Yealink&#39; &#124; &#39;Mairdi&#39; &#124; &#39;Jabra&#39; &#124; &#39;3CX&#39; &#124; &#39;Fanvil&#39; &#124; &#39;VT&#39; &#124; &#39;Netgear&#39; &#124; &#39;Algo&#39; &#124; &#39;Yealink Headsets&#39; &#124; &#39;Yealink DECT Handsets&#39; &#124; &#39;Yealink DECT Headsets&#39; &#124; &#39;Yealink BT Headsets&#39; &#124; &#39;Yealink USB Wired Headsets&#39; &#124; &#39;Yealink Meeting Rooms&#39; &#124; &#39;Fanvil Phones&#39; &#124; &#39;Fanvil Headsets&#39; &#124; &#39;Fanvil Wireless Phones&#39; &#124; &#39;Fanvil Security Products&#39; &#124; &#39;Fanvil Accessories&#39; &#124; &#39;Fanvil Hotel Phones&#39;>** | Product Category | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/PrinterEntity.md

@@ -6,11 +6,11 @@ PrintersEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**brand** | **string** | brand | [optional] [default to undefined]
-**model** | **string** | model | [optional] [default to undefined]
-**sn** | **string** | sn | [optional] [default to undefined]
-**location** | **string** | location | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**brand** | **string** | brand | [default to undefined]
+**model** | **string** | model | [default to undefined]
+**sn** | **string** | sn | [default to undefined]
+**location** | **string** | location | [default to undefined]
 
 ## Example
 

package/docs/PrizesEntity.md

@@ -6,12 +6,12 @@ PrizesEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**year** | **number** | year | [optional] [default to undefined]
-**sku** | **string** | sku | [optional] [default to undefined]
-**title** | **string** | title | [optional] [default to undefined]
-**target** | **number** | target | [optional] [default to undefined]
-**image** | **string** | image | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**year** | **number** | year | [default to undefined]
+**sku** | **string** | sku | [default to undefined]
+**title** | **string** | title | [default to undefined]
+**target** | **number** | target | [default to undefined]
+**image** | **string** | image | [default to undefined]
 
 ## Example
 

package/docs/ProductDetailedSummaryDTO.md

@@ -6,8 +6,8 @@ Product Detailed Summary
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**title** | **string** | Title | [optional] [default to undefined]
+**sku** | **string** | SKU | [default to undefined]
+**title** | **string** | Title | [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]

package/docs/ProductPriceListItemModel.md

@@ -6,9 +6,9 @@ Product Price List Item
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **string** | Title | [optional] [default to undefined]
+**title** | **string** | Title | [default to undefined]
 **sku** | **string** | SKU | [optional] [default to undefined]
-**price** | **number** | Price | [optional] [default to undefined]
+**price** | **number** | Price | [default to undefined]
 **rrp** | **number** | RRP | [optional] [default to undefined]
 **stock** | **number** | Stock | [optional] [default to undefined]
 **brand** | **string** | Brand | [optional] [default to undefined]

package/docs/{StockProductPriceModel.md → ProductPriceModel.md}

@@ -1,20 +1,20 @@
-# StockProductPriceModel
+# ProductPriceModel
 
-Stock Product Price
+Product Price
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) |  | [optional] [default to undefined]
+**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) |  | [default to undefined]
 **price** | **number** | Price (£) | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { StockProductPriceModel } from 'yellowgrid-api-ts';
+import { ProductPriceModel } from 'yellowgrid-api-ts';
 
-const instance: StockProductPriceModel = {
+const instance: ProductPriceModel = {
     priceList,
     price,
 };

package/docs/ProductSearchResultsModel.md

@@ -6,7 +6,7 @@ Product Search Results
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**results** | [**Array<ProductSummaryDTO>**](ProductSummaryDTO.md) | Results | [optional] [default to undefined]
+**results** | [**Array<ProductSummaryDTO>**](ProductSummaryDTO.md) | Results | [default to undefined]
 
 ## Example
 

package/docs/ProductSerialInfoDTO.md

@@ -0,0 +1,27 @@
+# ProductSerialInfoDTO
+
+Product Serial Info Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [default to undefined]
+**title** | **string** | Product Title | [default to undefined]
+**mac** | **boolean** | Has MAC Address | [default to undefined]
+**serialPrefixes** | **Array<string>** | Serial Prefix | [default to undefined]
+
+## Example
+
+```typescript
+import { ProductSerialInfoDTO } from 'yellowgrid-api-ts';
+
+const instance: ProductSerialInfoDTO = {
+    sku,
+    title,
+    mac,
+    serialPrefixes,
+};
+```
+
+[[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/ProductSerialInfoModel.md

@@ -6,9 +6,9 @@ Product Serial Info
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**title** | **string** | Product Title | [optional] [default to undefined]
-**mac** | **boolean** | Has MAC Address | [optional] [default to undefined]
+**sku** | **string** | SKU | [default to undefined]
+**title** | **string** | Product Title | [default to undefined]
+**mac** | **boolean** | Has MAC Address | [default to undefined]
 **serial_prefixes** | **Array<string>** | Serial Prefix | [optional] [default to undefined]
 
 ## Example

package/docs/ProductSummaryDTO.md

@@ -6,8 +6,8 @@ Product Summary
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**title** | **string** | Title | [optional] [default to undefined]
+**sku** | **string** | SKU | [default to undefined]
+**title** | **string** | Title | [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]

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|
 |------------- | ------------- | -------------|