yellowgrid-api-ts 3.2.276 → 3.2.278

package/docs/OrderSummariesModel.md

@@ -6,10 +6,10 @@ Sales Orders
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**results** | [**Array<OrderSummaryDTO>**](OrderSummaryDTO.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]
+**results** | [**Array<OrderSummaryDTO>**](OrderSummaryDTO.md) | Results | [default to undefined]
+**page** | **number** | Page | [default to undefined]
+**perPage** | **number** | Per Page | [default to undefined]
+**totalResults** | **number** | Total Results | [default to undefined]
 
 ## Example
 

package/docs/OrderSummaryDTO.md

@@ -6,22 +6,22 @@ Order Summary
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | ID | [optional] [default to undefined]
+**id** | **number** | ID | [default to undefined]
 **reference** | **string** | Reference | [optional] [default to undefined]
-**invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
+**invoiceNumber** | **string** | Invoice Number | [default to undefined]
 **invoiceId** | **string** | Invoice ID | [optional] [default to undefined]
-**orderDate** | **string** | Date Time | [optional] [default to undefined]
-**paid** | **boolean** | Paid | [optional] [default to undefined]
-**complete** | **boolean** | Complete | [optional] [default to undefined]
-**quote** | **boolean** | Quote | [optional] [default to undefined]
-**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) |  | [optional] [default to undefined]
+**orderDate** | **string** | Date Time | [default to undefined]
+**paid** | **boolean** | Paid | [default to undefined]
+**complete** | **boolean** | Complete | [default to undefined]
+**quote** | **boolean** | Quote | [default to undefined]
+**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) |  | [default to undefined]
 **shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
-**items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [optional] [default to undefined]
-**carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
+**items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [default to undefined]
+**carriageCharge** | **number** | Carriage Charge | [default to undefined]
 **fulfillable** | **boolean** | Fulfillable | [optional] [default to undefined]
 **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
 **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [optional] [default to undefined]
-**readonly** | **boolean** | Readonly | [optional] [default to undefined]
+**readonly** | **boolean** | Readonly | [default to undefined]
 
 ## Example
 

package/docs/OrderTotalModel.md

@@ -6,13 +6,13 @@ Order Totals
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subtotal** | **number** | Subtotal | [optional] [default to undefined]
-**vat** | **number** | VAT | [optional] [default to undefined]
-**total** | **number** | Total | [optional] [default to undefined]
-**totalGbp** | **number** | Total in GBP | [optional] [default to undefined]
-**vatRate** | **number** | VAT Rate | [optional] [default to undefined]
-**credit** | **number** | Credit | [optional] [default to undefined]
-**currency** | **string** | Currency | [optional] [default to undefined]
+**subtotal** | **number** | Subtotal | [default to undefined]
+**vat** | **number** | VAT | [default to undefined]
+**total** | **number** | Total | [default to undefined]
+**totalGbp** | **number** | Total in GBP | [default to undefined]
+**vatRate** | **number** | VAT Rate | [default to undefined]
+**credit** | **number** | Credit | [default to undefined]
+**currency** | **string** | Currency | [default to undefined]
 **delivery** | **number** | Delivery | [optional] [default to undefined]
 
 ## Example

package/docs/OrderedItemEntity.md

@@ -6,20 +6,20 @@ OrderedItemsEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**itemId** | **number** | itemId | [optional] [default to undefined]
-**orderedQuantity** | **number** | orderedQuantity | [optional] [default to undefined]
-**itemStatus** | **number** | itemStatus | [optional] [default to undefined]
-**supplierId** | **number** | supplierId | [optional] [default to undefined]
-**supplierItemId** | **number** | supplierItemId | [optional] [default to undefined]
-**supplierPrice** | **number** | supplierPrice | [optional] [default to undefined]
-**statusDate** | **string** | statusDate | [optional] [default to undefined]
-**statusAuthor** | **number** | statusAuthor | [optional] [default to undefined]
-**supplierPaid** | **number** | supplierPaid | [optional] [default to undefined]
-**supplierCreditDue** | **number** | supplierCreditDue | [optional] [default to undefined]
-**supplierCreditReceived** | **number** | supplierCreditReceived | [optional] [default to undefined]
-**supplierSku** | **string** | supplierSku | [optional] [default to undefined]
-**returnedStock** | **number** | returnedStock | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**itemId** | **number** | itemId | [default to undefined]
+**orderedQuantity** | **number** | orderedQuantity | [default to undefined]
+**itemStatus** | **number** | itemStatus | [default to undefined]
+**supplierId** | **number** | supplierId | [default to undefined]
+**supplierItemId** | **number** | supplierItemId | [default to undefined]
+**supplierPrice** | **number** | supplierPrice | [default to undefined]
+**statusDate** | **string** | statusDate | [default to undefined]
+**statusAuthor** | **number** | statusAuthor | [default to undefined]
+**supplierPaid** | **number** | supplierPaid | [default to undefined]
+**supplierCreditDue** | **number** | supplierCreditDue | [default to undefined]
+**supplierCreditReceived** | **number** | supplierCreditReceived | [default to undefined]
+**supplierSku** | **string** | supplierSku | [default to undefined]
+**returnedStock** | **number** | returnedStock | [default to undefined]
 
 ## Example
 

package/docs/OrderedItemModel.md

@@ -6,20 +6,20 @@ Ordered Item Model
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**itemId** | **number** | itemId | [optional] [default to undefined]
-**orderedQuantity** | **number** | orderedQuantity | [optional] [default to undefined]
-**itemStatus** | **number** | itemStatus | [optional] [default to undefined]
-**supplierId** | **number** | supplierId | [optional] [default to undefined]
-**supplierItemId** | **number** | supplierItemId | [optional] [default to undefined]
-**supplierPrice** | **number** | supplierPrice | [optional] [default to undefined]
-**statusDate** | **string** | statusDate | [optional] [default to undefined]
-**statusAuthor** | **number** | statusAuthor | [optional] [default to undefined]
-**supplierPaid** | **number** | supplierPaid | [optional] [default to undefined]
-**supplierCreditDue** | **number** | supplierCreditDue | [optional] [default to undefined]
-**supplierCreditReceived** | **number** | supplierCreditReceived | [optional] [default to undefined]
-**supplierSku** | **string** | supplierSku | [optional] [default to undefined]
-**returnedStock** | **number** | returnedStock | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**itemId** | **number** | itemId | [default to undefined]
+**orderedQuantity** | **number** | orderedQuantity | [default to undefined]
+**itemStatus** | **number** | itemStatus | [default to undefined]
+**supplierId** | **number** | supplierId | [default to undefined]
+**supplierItemId** | **number** | supplierItemId | [default to undefined]
+**supplierPrice** | **number** | supplierPrice | [default to undefined]
+**statusDate** | **string** | statusDate | [default to undefined]
+**statusAuthor** | **number** | statusAuthor | [default to undefined]
+**supplierPaid** | **number** | supplierPaid | [default to undefined]
+**supplierCreditDue** | **number** | supplierCreditDue | [default to undefined]
+**supplierCreditReceived** | **number** | supplierCreditReceived | [default to undefined]
+**supplierSku** | **string** | supplierSku | [default to undefined]
+**returnedStock** | **number** | returnedStock | [default to undefined]
 
 ## Example
 

package/docs/OrdersApi.md

@@ -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|
@@ -375,6 +376,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()
 

package/docs/PartnerDTO.md

@@ -7,16 +7,16 @@
 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]
 **customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [optional] [default to undefined]
 
 ## Example

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

@@ -6,29 +6,29 @@ 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]
+**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]
 

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

@@ -7,16 +7,16 @@ PromoCodesEntity
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **number** | id | [optional] [default to undefined]
-**code** | **string** | code | [optional] [default to undefined]
-**description** | **string** | description | [optional] [default to undefined]
+**code** | **string** | code | [default to undefined]
+**description** | **string** | description | [default to undefined]
 **startDate** | **string** | start | [optional] [default to undefined]
 **endDate** | **string** | expiry | [optional] [default to undefined]
-**customerLimit** | **number** | customerLimit | [optional] [default to undefined]
-**globalLimit** | **number** | globalLimit | [optional] [default to undefined]
-**orderRestrictions** | **Array<string>** | orderRestrictions | [optional] [default to undefined]
-**includeDistribution** | **boolean** | includeDistribution | [optional] [default to undefined]
-**distributionOnly** | **boolean** | distributionOnly | [optional] [default to undefined]
-**nfr** | **boolean** | nfr | [optional] [default to undefined]
+**customerLimit** | **number** | customerLimit | [default to undefined]
+**globalLimit** | **number** | globalLimit | [default to undefined]
+**orderRestrictions** | **Array<string>** | orderRestrictions | [default to undefined]
+**includeDistribution** | **boolean** | includeDistribution | [default to undefined]
+**distributionOnly** | **boolean** | distributionOnly | [default to undefined]
+**nfr** | **boolean** | nfr | [default to undefined]
 **note** | **string** | note | [optional] [default to undefined]
 
 ## Example

package/docs/PromoItemModel.md

@@ -6,14 +6,14 @@ Promo Item
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**promoId** | **number** | promoId | [optional] [default to undefined]
-**price** | **number** | price | [optional] [default to undefined]
-**discount** | **number** | discount | [optional] [default to undefined]
-**sku** | **string** | sku | [optional] [default to undefined]
-**quantity** | **number** | quantity | [optional] [default to undefined]
-**bulkQuantity** | **number** | bulkQuantity | [optional] [default to undefined]
-**bulkAdd** | **number** | bulkAdd | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**promoId** | **number** | promoId | [default to undefined]
+**price** | **number** | price | [default to undefined]
+**discount** | **number** | discount | [default to undefined]
+**sku** | **string** | sku | [default to undefined]
+**quantity** | **number** | quantity | [default to undefined]
+**bulkQuantity** | **number** | bulkQuantity | [default to undefined]
+**bulkAdd** | **number** | bulkAdd | [default to undefined]
 
 ## Example
 

package/docs/PromoItemsEntity.md

@@ -6,14 +6,14 @@ PromoItemsEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**promoId** | **number** | promoId | [optional] [default to undefined]
-**price** | **number** | price | [optional] [default to undefined]
-**discount** | **number** | discount | [optional] [default to undefined]
-**sku** | **string** | sku | [optional] [default to undefined]
-**quantity** | **number** | quantity | [optional] [default to undefined]
-**bulkQuantity** | **number** | bulkQuantity | [optional] [default to undefined]
-**bulkAdd** | **number** | bulkAdd | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**promoId** | **number** | promoId | [default to undefined]
+**price** | **number** | price | [default to undefined]
+**discount** | **number** | discount | [default to undefined]
+**sku** | **string** | sku | [default to undefined]
+**quantity** | **number** | quantity | [default to undefined]
+**bulkQuantity** | **number** | bulkQuantity | [default to undefined]
+**bulkAdd** | **number** | bulkAdd | [default to undefined]
 
 ## Example
 

package/docs/PromoModel.md

@@ -7,16 +7,16 @@ Promotion
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **number** | id | [optional] [default to undefined]
-**code** | **string** | code | [optional] [default to undefined]
-**description** | **string** | description | [optional] [default to undefined]
+**code** | **string** | code | [default to undefined]
+**description** | **string** | description | [default to undefined]
 **startDate** | **string** | start | [optional] [default to undefined]
 **endDate** | **string** | expiry | [optional] [default to undefined]
-**customerLimit** | **number** | customerLimit | [optional] [default to undefined]
-**globalLimit** | **number** | globalLimit | [optional] [default to undefined]
-**orderRestrictions** | **Array<string>** | orderRestrictions | [optional] [default to undefined]
-**includeDistribution** | **boolean** | includeDistribution | [optional] [default to undefined]
-**distributionOnly** | **boolean** | distributionOnly | [optional] [default to undefined]
-**nfr** | **boolean** | nfr | [optional] [default to undefined]
+**customerLimit** | **number** | customerLimit | [default to undefined]
+**globalLimit** | **number** | globalLimit | [default to undefined]
+**orderRestrictions** | **Array<string>** | orderRestrictions | [default to undefined]
+**includeDistribution** | **boolean** | includeDistribution | [default to undefined]
+**distributionOnly** | **boolean** | distributionOnly | [default to undefined]
+**nfr** | **boolean** | nfr | [default to undefined]
 **note** | **string** | note | [optional] [default to undefined]
 **items** | [**Array<PromoItemModel>**](PromoItemModel.md) | Items | [optional] [default to undefined]