yellowgrid-api-ts 3.2.237-dev.0 → 3.2.238-dev.0

package/docs/PrinterEntity.md

@@ -6,11 +6,11 @@ PrintersEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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]
+**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]
 
 ## Example
 

package/docs/PrizesEntity.md

@@ -6,12 +6,12 @@ PrizesEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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]
+**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]
 
 ## Example
 

package/docs/ProductDetailedSummaryDTO.md

@@ -6,16 +6,16 @@ Product Detailed Summary
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [default to undefined]
-**title** | **string** | Title | [default to undefined]
+**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) | 3CX Licence Details | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
-**dueDate** | **string** | Due Date | [optional] [default to undefined]
+**dueDate** | **string** | Date Time | [optional] [default to undefined]
 **onOrder** | **number** | On Order | [optional] [default to undefined]
 
 ## Example

package/docs/ProductPriceListItemModel.md

@@ -6,9 +6,9 @@ Product Price List Item
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **string** | Title | [default to undefined]
+**title** | **string** | Title | [optional] [default to undefined]
 **sku** | **string** | SKU | [optional] [default to undefined]
-**price** | **number** | Price | [default to undefined]
+**price** | **number** | Price | [optional] [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/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/ProductSearchResultsModel.md

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

package/docs/ProductSerialInfoModel.md

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

package/docs/ProductSummaryDTO.md

@@ -6,14 +6,14 @@ Product Summary
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [default to undefined]
-**title** | **string** | Title | [default to undefined]
+**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) | 3CX Licence Details | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
 
 ## Example

package/docs/PromoCodesEntity.md

@@ -6,18 +6,18 @@ PromoCodesEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [default to undefined]
-**code** | **string** | code | [default to undefined]
-**description** | **string** | description | [default to undefined]
-**banner** | **string** | banner | [default to undefined]
-**start** | **string** | start | [default to undefined]
-**expiry** | **string** | expiry | [default to undefined]
-**customerLimit** | **number** | customerLimit | [default to undefined]
-**globalLimit** | **number** | globalLimit | [default to undefined]
-**orderRestrictions** | **string** | orderRestrictions | [default to undefined]
-**includeDistribution** | **number** | includeDistribution | [default to undefined]
-**distributionOnly** | **number** | distributionOnly | [default to undefined]
-**note** | **string** | note | [default to undefined]
+**id** | **number** | id | [optional] [default to undefined]
+**code** | **string** | code | [optional] [default to undefined]
+**description** | **string** | description | [optional] [default to undefined]
+**banner** | **string** | banner | [optional] [default to undefined]
+**start** | **string** | start | [optional] [default to undefined]
+**expiry** | **string** | expiry | [optional] [default to undefined]
+**customerLimit** | **number** | customerLimit | [optional] [default to undefined]
+**globalLimit** | **number** | globalLimit | [optional] [default to undefined]
+**orderRestrictions** | **string** | orderRestrictions | [optional] [default to undefined]
+**includeDistribution** | **number** | includeDistribution | [optional] [default to undefined]
+**distributionOnly** | **number** | distributionOnly | [optional] [default to undefined]
+**note** | **string** | note | [optional] [default to undefined]
 
 ## Example
 

package/docs/PromoItemsEntity.md

@@ -6,14 +6,14 @@ PromoItemsEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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]
+**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]
 
 ## Example
 

package/docs/PromoSummariesModel.md

@@ -0,0 +1,27 @@
+# PromoSummariesModel
+
+Promotions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<PromoSummaryDTO>**](PromoSummaryDTO.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 { PromoSummariesModel } from 'yellowgrid-api-ts';
+
+const instance: PromoSummariesModel = {
+    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/PromoSummaryDTO.md

@@ -0,0 +1,29 @@
+# PromoSummaryDTO
+
+Promo Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** | Description | [optional] [default to undefined]
+**code** | **string** | Promo Code | [optional] [default to undefined]
+**startDate** | **string** | Date Time | [optional] [default to undefined]
+**endDate** | **string** | Date Time | [optional] [default to undefined]
+**orders** | **number** | Orders | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromoSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: PromoSummaryDTO = {
+    description,
+    code,
+    startDate,
+    endDate,
+    orders,
+};
+```
+
+[[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/PromotionsApi.md

@@ -0,0 +1,71 @@
+# PromotionsApi
+
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetPromos**](#getgetpromos) | **GET** /marketing/promos | |
+
+# **getGetPromos**
+> PromoSummariesModel getGetPromos()
+
+Get Promos
+
+### Example
+
+```typescript
+import {
+    PromotionsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionsApi(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)
+let expired: boolean; //Expired (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetPromos(
+    pageSize,
+    page,
+    search,
+    expired
+);
+```
+
+### 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|
+| **expired** | [**boolean**] | Expired | (optional) defaults to undefined|
+
+
+### Return type
+
+**PromoSummariesModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Promo Summaries |  -  |
+|**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/ProspectDTO.md

@@ -6,16 +6,16 @@ Prospect
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**companyName** | **string** | Company Name | [default to undefined]
+**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]
-**xeroId** | **string** | Xero ID | [default to undefined]
-**removed** | **boolean** | Removed From Prospects | [default to undefined]
-**status** | **string** | Status | [default to undefined]
-**orderCount** | **number** | Order Count | [default to undefined]
-**tcxOrderCount** | **number** | 3CX Order Count | [default to undefined]
-**videoCount** | **number** | Branded Video Count | [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]
+**orderCount** | **number** | Order Count | [optional] [default to undefined]
+**tcxOrderCount** | **number** | 3CX Order Count | [optional] [default to undefined]
+**videoCount** | **number** | Branded Video Count | [optional] [default to undefined]
 
 ## Example
 

package/docs/ProspectEntity.md

@@ -6,17 +6,17 @@ ProspectEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [default to undefined]
-**status** | **number** | status | [default to undefined]
-**customerId** | **number** | customerId | [default to undefined]
-**companyName** | **string** | companyName | [default to undefined]
-**contactName** | **string** | contactName | [default to undefined]
-**telephone** | **string** | telephone | [default to undefined]
-**email** | **string** | email | [default to undefined]
-**reason** | **string** | reason | [default to undefined]
-**lastOrderDate** | **string** | lastOrderDate | [default to undefined]
-**followUpDate** | **string** | followUpDate | [default to undefined]
-**notes** | **string** | notes | [default to undefined]
+**id** | **number** | id | [optional] [default to undefined]
+**status** | **number** | status | [optional] [default to undefined]
+**customerId** | **number** | customerId | [optional] [default to undefined]
+**companyName** | **string** | companyName | [optional] [default to undefined]
+**contactName** | **string** | contactName | [optional] [default to undefined]
+**telephone** | **string** | telephone | [optional] [default to undefined]
+**email** | **string** | email | [optional] [default to undefined]
+**reason** | **string** | reason | [optional] [default to undefined]
+**lastOrderDate** | **string** | lastOrderDate | [optional] [default to undefined]
+**followUpDate** | **string** | followUpDate | [optional] [default to undefined]
+**notes** | **string** | notes | [optional] [default to undefined]
 
 ## Example
 

package/docs/ProvisioningModel.md

@@ -6,9 +6,9 @@ Provisioning Group
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**groupName** | **string** | Provisioning Group Name | [default to undefined]
-**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [default to undefined]
-**auth** | **string** | Additional Authentication Secret | [default to undefined]
+**groupName** | **string** | Provisioning Group Name | [optional] [default to undefined]
+**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [optional] [default to undefined]
+**auth** | **string** | Additional Authentication Secret | [optional] [default to undefined]
 **id** | **number** | Provisioning Group ID | [optional] [default to undefined]
 **customerId** | **number** | Owner ID | [optional] [default to undefined]
 

package/docs/ProvisioningRequestEntity.md

@@ -6,9 +6,9 @@ Provisioning Group Request
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**groupName** | **string** | Provisioning Group Name | [default to undefined]
-**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [default to undefined]
-**auth** | **string** | Additional Authentication Secret | [default to undefined]
+**groupName** | **string** | Provisioning Group Name | [optional] [default to undefined]
+**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [optional] [default to undefined]
+**auth** | **string** | Additional Authentication Secret | [optional] [default to undefined]
 
 ## Example
 

package/docs/RecordingBackupAzureModel.md

@@ -6,10 +6,10 @@ Azure Recordings Backup
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** | Storage Account Name | [default to undefined]
-**key** | **string** | Storage Account Key | [default to undefined]
-**connection_string** | **string** | Storage Account Connection String | [default to undefined]
-**sasUrl** | **string** | SAS Url | [default to undefined]
+**name** | **string** | Storage Account Name | [optional] [default to undefined]
+**key** | **string** | Storage Account Key | [optional] [default to undefined]
+**connection_string** | **string** | Storage Account Connection String | [optional] [default to undefined]
+**sasUrl** | **string** | SAS Url | [optional] [default to undefined]
 **recordings_path** | **string** | Recordings Path | [optional] [default to undefined]
 
 ## Example

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

@@ -6,10 +6,10 @@ Remote Storage
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | AWS ID | [default to undefined]
-**secret** | **string** | AWS Secret | [default to undefined]
-**name** | **string** | AWS Bucket Name | [default to undefined]
-**region** | **string** | AWS Region | [default to undefined]
+**id** | **string** | AWS ID | [optional] [default to undefined]
+**secret** | **string** | AWS Secret | [optional] [default to undefined]
+**name** | **string** | AWS Bucket Name | [optional] [default to undefined]
+**region** | **string** | AWS Region | [optional] [default to undefined]
 
 ## Example
 

package/docs/ReportRequestDTO.md

@@ -6,9 +6,9 @@ Report Request
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**report** | **string** | Report | [default to undefined]
-**start** | **string** | Start | [optional] [default to undefined]
-**end** | **string** | End | [optional] [default to undefined]
+**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]

package/docs/ResourceNotReadyException.md

@@ -6,9 +6,9 @@ Resource Not Ready
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**message** | **string** | Message | [default to undefined]
-**resourceId** | **string** | Resource ID | [default to undefined]
-**status** | **string** | Status | [default to undefined]
+**message** | **string** | Message | [optional] [default to undefined]
+**resourceId** | **string** | Resource ID | [optional] [default to undefined]
+**status** | **string** | Status | [optional] [default to undefined]
 
 ## Example
 

package/docs/RootAccessModel.md

@@ -6,9 +6,9 @@ Root Access Model
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**username** | **string** | Username | [default to undefined]
-**password** | **string** | Password | [default to undefined]
-**expiryDate** | **string** | Expiry Date | [default to undefined]
+**username** | **string** | Username | [optional] [default to undefined]
+**password** | **string** | Password | [optional] [default to undefined]
+**expiryDate** | **string** | Expiry Date | [optional] [default to undefined]
 
 ## Example
 

package/docs/S3BucketEntity.md

@@ -6,10 +6,10 @@ S3 Bucket
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** | name | [default to undefined]
-**region** | **string** | region | [default to undefined]
-**accessKeyId** | **string** | accessKeyId | [default to undefined]
-**secretAccessKey** | **string** | secretAccessKey | [default to undefined]
+**name** | **string** | name | [optional] [default to undefined]
+**region** | **string** | region | [optional] [default to undefined]
+**accessKeyId** | **string** | accessKeyId | [optional] [default to undefined]
+**secretAccessKey** | **string** | secretAccessKey | [optional] [default to undefined]
 
 ## Example
 

package/docs/ScannedItemModel.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **title** | **string** | Title | [optional] [default to undefined]
 **sku** | **string** | SKU | [optional] [default to undefined]
 **tcxLabel** | **string** | 3CX Label | [optional] [default to undefined]
-**serialNumbers** | **Array<string>** | Serial Numbers | [default to undefined]
+**serialNumbers** | **Array<string>** | Serial Numbers | [optional] [default to undefined]
 **macAddress** | **string** | MAC Address | [optional] [default to undefined]
 
 ## Example

package/docs/ScopeModel.md

@@ -6,8 +6,8 @@ OAuth2 Scope
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | ID | [default to undefined]
-**description** | **string** | Description | [default to undefined]
+**id** | **string** | ID | [optional] [default to undefined]
+**description** | **string** | Description | [optional] [default to undefined]
 
 ## Example
 

package/docs/SeriesDTO.md

@@ -6,10 +6,10 @@ Graph Series Data
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** | Name | [default to undefined]
-**type** | **string** | Type | [default to undefined]
+**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 | [default to undefined]
+**data** | **Array<string>** | Data | [optional] [default to undefined]
 
 ## Example
 

package/docs/ServiceHealthDTO.md

@@ -6,8 +6,8 @@ Service Health DTO
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**services** | [**Array<ServiceStatusDTO>**](ServiceStatusDTO.md) |  | [default to undefined]
-**globalStatus** | **number** |  | [default to undefined]
+**services** | [**Array<ServiceStatusDTO>**](ServiceStatusDTO.md) |  | [optional] [default to undefined]
+**globalStatus** | **number** |  | [optional] [default to undefined]
 
 ## Example
 

package/docs/ServiceStatusDTO.md

@@ -6,10 +6,10 @@ Service Status DTO
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**statusName** | **string** | Service Status Description | [default to undefined]
-**name** | **string** | Service Name | [default to undefined]
-**status** | **string** | Service Status | [default to undefined]
-**events** | [**Array<EventDTO>**](EventDTO.md) | Service Events | [default to undefined]
+**statusName** | **string** | Service Status Description | [optional] [default to undefined]
+**name** | **string** | Service Name | [optional] [default to undefined]
+**status** | **string** | Service Status | [optional] [default to undefined]
+**events** | [**Array<EventDTO>**](EventDTO.md) | Service Events | [optional] [default to undefined]
 
 ## Example
 

package/docs/ShipmentAddressEntity.md

@@ -6,17 +6,17 @@ ShipmentAddressEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [default to undefined]
-**shipmentId** | **number** | shipmentId | [default to undefined]
-**shipName** | **string** | shipName | [default to undefined]
-**shipCompany** | **string** | shipCompany | [default to undefined]
-**shipAddress1** | **string** | shipAddress1 | [default to undefined]
-**shipAddress2** | **string** | shipAddress2 | [default to undefined]
-**shipCity** | **string** | shipCity | [default to undefined]
-**shipStateRegion** | **string** | shipStateRegion | [default to undefined]
-**shipPostalCode** | **string** | shipPostalCode | [default to undefined]
-**shipCountry** | **string** | shipCountry | [default to undefined]
-**shipPhoneNumber** | **string** | shipPhoneNumber | [default to undefined]
+**id** | **number** | id | [optional] [default to undefined]
+**shipmentId** | **number** | shipmentId | [optional] [default to undefined]
+**shipName** | **string** | shipName | [optional] [default to undefined]
+**shipCompany** | **string** | shipCompany | [optional] [default to undefined]
+**shipAddress1** | **string** | shipAddress1 | [optional] [default to undefined]
+**shipAddress2** | **string** | shipAddress2 | [optional] [default to undefined]
+**shipCity** | **string** | shipCity | [optional] [default to undefined]
+**shipStateRegion** | **string** | shipStateRegion | [optional] [default to undefined]
+**shipPostalCode** | **string** | shipPostalCode | [optional] [default to undefined]
+**shipCountry** | **string** | shipCountry | [optional] [default to undefined]
+**shipPhoneNumber** | **string** | shipPhoneNumber | [optional] [default to undefined]
 
 ## Example
 

package/docs/ShipmentDTO.md

@@ -12,10 +12,10 @@ Name | Type | Description | Notes
 **reference** | **string** | Courier Reference | [optional] [default to undefined]
 **tracking** | **string** | Courier Tracking | [optional] [default to undefined]
 **trackingUrl** | **string** | Courier Tracking URL | [optional] [default to undefined]
-**requestedDate** | **string** | Date Time | [default to undefined]
-**scannedItems** | [**Array<ScannedItemModel>**](ScannedItemModel.md) | Scanned Items | [default to undefined]
-**items** | [**Array<ShipmentItemModel>**](ShipmentItemModel.md) | Items | [default to undefined]
-**address** | [**AddressModel**](AddressModel.md) |  | [default to undefined]
+**requestedDate** | **string** | Date Time | [optional] [default to undefined]
+**scannedItems** | [**Array<ScannedItemModel>**](ScannedItemModel.md) | Scanned Items | [optional] [default to undefined]
+**items** | [**Array<ShipmentItemModel>**](ShipmentItemModel.md) | Items | [optional] [default to undefined]
+**address** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
 **boxes** | **number** | Boxes Shipped | [optional] [default to undefined]
 
 ## Example