yellowgrid-api-ts 3.2.231-dev.0 → 3.2.232-dev.0

package/docs/ItemEntity.md

@@ -6,27 +6,27 @@ ItemsEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**orderId** | **number** | orderId | [optional] [default to undefined]
-**sku** | **string** | sku | [optional] [default to undefined]
-**title** | **string** | title | [optional] [default to undefined]
-**itemOptions** | **string** | itemOptions | [optional] [default to undefined]
-**quantity** | **number** | quantity | [optional] [default to undefined]
-**customOption** | **number** | customOption | [optional] [default to undefined]
-**itemPrice** | **number** | itemPrice | [optional] [default to undefined]
-**itemPriceGbp** | **number** | itemPriceGbp | [optional] [default to undefined]
-**itemTax** | **number** | itemTax | [optional] [default to undefined]
-**itemTaxGbp** | **number** | itemTaxGbp | [optional] [default to undefined]
-**itemShipping** | **number** | itemShipping | [optional] [default to undefined]
-**itemShippingGbp** | **number** | itemShippingGbp | [optional] [default to undefined]
-**shippingTax** | **number** | shippingTax | [optional] [default to undefined]
-**shippingTaxGbp** | **number** | shippingTaxGbp | [optional] [default to undefined]
-**customerRefunded** | **number** | customerRefunded | [optional] [default to undefined]
-**licenceKey** | **string** | licencekey | [optional] [default to undefined]
-**addHosting** | **number** | addHosting | [optional] [default to undefined]
-**licenceExpiryDate** | **string** | licenceExpiryDate | [optional] [default to undefined]
-**processDate** | **string** | processDate | [optional] [default to undefined]
-**promoItem** | **number** | promo | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**orderId** | **number** | orderId | [default to undefined]
+**sku** | **string** | sku | [default to undefined]
+**title** | **string** | title | [default to undefined]
+**itemOptions** | **string** | itemOptions | [default to undefined]
+**quantity** | **number** | quantity | [default to undefined]
+**customOption** | **number** | customOption | [default to undefined]
+**itemPrice** | **number** | itemPrice | [default to undefined]
+**itemPriceGbp** | **number** | itemPriceGbp | [default to undefined]
+**itemTax** | **number** | itemTax | [default to undefined]
+**itemTaxGbp** | **number** | itemTaxGbp | [default to undefined]
+**itemShipping** | **number** | itemShipping | [default to undefined]
+**itemShippingGbp** | **number** | itemShippingGbp | [default to undefined]
+**shippingTax** | **number** | shippingTax | [default to undefined]
+**shippingTaxGbp** | **number** | shippingTaxGbp | [default to undefined]
+**customerRefunded** | **number** | customerRefunded | [default to undefined]
+**licenceKey** | **string** | licencekey | [default to undefined]
+**addHosting** | **number** | addHosting | [default to undefined]
+**licenceExpiryDate** | **string** | licenceExpiryDate | [default to undefined]
+**processDate** | **string** | processDate | [default to undefined]
+**promoItem** | **number** | promo | [default to undefined]
 **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
 
 ## Example

package/docs/ItemResolutionRequestModel.md

@@ -6,7 +6,7 @@ RMA Item Status Request Model
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**resolution** | **number** | RMA Item Resolution | [optional] [default to undefined]
+**resolution** | **number** | RMA Item Resolution | [default to undefined]
 
 ## Example
 

package/docs/LinkedOrderEntity.md

@@ -6,8 +6,8 @@ LinkedOrdersEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**orderId** | **number** | orderId | [optional] [default to undefined]
-**linkedOrderId** | **number** | linkedOrderId | [optional] [default to undefined]
+**orderId** | **number** | orderId | [default to undefined]
+**linkedOrderId** | **number** | linkedOrderId | [default to undefined]
 
 ## Example
 

package/docs/MFARequiredModel.md

@@ -6,8 +6,8 @@ MFA Required
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**secret** | **string** | MFA Secret | [optional] [default to undefined]
-**png** | **string** | QR Code | [optional] [default to undefined]
+**secret** | **string** | MFA Secret | [default to undefined]
+**png** | **string** | QR Code | [default to undefined]
 
 ## Example
 

package/docs/MacAddressDTO.md

@@ -6,8 +6,8 @@ MAC Address DTO
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**groupId** | **number** | Group ID | [optional] [default to undefined]
-**macAddress** | **string** | MAC Address | [optional] [default to undefined]
+**groupId** | **number** | Group ID | [default to undefined]
+**macAddress** | **string** | MAC Address | [default to undefined]
 
 ## Example
 

package/docs/MacAddressRequestModel.md

@@ -6,7 +6,7 @@ RMA Item MAC Address Request Model
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**macAddress** | **string** | MAC Address | [optional] [default to undefined]
+**macAddress** | **string** | MAC Address | [default to undefined]
 
 ## Example
 

package/docs/MonthlyUsageModel.md

@@ -6,8 +6,8 @@ Monthly Contract Usage
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**month** | **string** | Month | [optional] [default to undefined]
-**used** | **number** | Used | [optional] [default to undefined]
+**month** | **string** | Month | [default to undefined]
+**used** | **number** | Used | [default to undefined]
 
 ## Example
 

package/docs/MultiTenantChangeResponseModel.md

@@ -6,10 +6,10 @@ Multi-Tenant Change Response
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**progress** | **number** | Progress | [optional] [default to undefined]
-**changeId** | **string** | ID | [optional] [default to undefined]
-**type** | **string** | Type | [optional] [default to undefined]
-**provider** | **number** | Provider | [optional] [default to undefined]
+**progress** | **number** | Progress | [default to undefined]
+**changeId** | **string** | ID | [default to undefined]
+**type** | **string** | Type | [default to undefined]
+**provider** | **number** | Provider | [default to undefined]
 
 ## Example
 

package/docs/NameRequestModel.md

@@ -6,7 +6,7 @@ Name Request
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** | Name | [optional] [default to undefined]
+**name** | **string** | Name | [default to undefined]
 
 ## Example
 

package/docs/NavigationModel.md

@@ -6,10 +6,10 @@ Navigation Endpoint
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **string** | Navigation Endpoint Title | [optional] [default to undefined]
-**path** | **string** | Navigation Endpoint Path | [optional] [default to undefined]
-**icon** | **string** | Navigation Endpoint Icon | [optional] [default to undefined]
-**openNewPage** | **boolean** | Navigation Behaviour | [optional] [default to undefined]
+**title** | **string** | Navigation Endpoint Title | [default to undefined]
+**path** | **string** | Navigation Endpoint Path | [default to undefined]
+**icon** | **string** | Navigation Endpoint Icon | [default to undefined]
+**openNewPage** | **boolean** | Navigation Behaviour | [default to undefined]
 
 ## Example
 

package/docs/NoteRequestModel.md

@@ -6,7 +6,7 @@ Note Request
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**note** | **string** | Note | [optional] [default to undefined]
+**note** | **string** | Note | [default to undefined]
 
 ## Example
 

package/docs/NumberPortDTO.md

@@ -16,13 +16,13 @@ Name | Type | Description | Notes
 **requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
 **asap** | **boolean** | Port Date ASAP | [optional] [default to undefined]
 **comment** | **string** | Comment | [optional] [default to undefined]
-**id** | **number** | Number Port ID | [optional] [default to undefined]
-**customerId** | **number** | Reseller ID | [optional] [default to undefined]
-**customerName** | **string** | Customer Name | [optional] [default to undefined]
-**portDate** | **string** | Porting Date | [optional] [default to undefined]
-**numberRanges** | [**Array<NumberPortRangeDTO>**](NumberPortRangeDTO.md) | Number Ranges | [optional] [default to undefined]
-**status** | **number** | Status | [optional] [default to undefined]
-**statusText** | **string** | Status Text | [optional] [default to undefined]
+**id** | **number** | Number Port ID | [default to undefined]
+**customerId** | **number** | Reseller ID | [default to undefined]
+**customerName** | **string** | Customer Name | [default to undefined]
+**portDate** | **string** | Porting Date | [default to undefined]
+**numberRanges** | [**Array<NumberPortRangeDTO>**](NumberPortRangeDTO.md) | Number Ranges | [default to undefined]
+**status** | **number** | Status | [default to undefined]
+**statusText** | **string** | Status Text | [default to undefined]
 **ticketId** | **number** | Ticket ID | [optional] [default to undefined]
 
 ## Example

package/docs/NumberPortNoteDTO.md

@@ -6,11 +6,11 @@ Number Port Note DTO
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**portId** | **number** | portId | [optional] [default to undefined]
-**note** | **string** | note | [optional] [default to undefined]
-**user** | **string** | user | [optional] [default to undefined]
-**timestamp** | **string** | timestamp | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**portId** | **number** | portId | [default to undefined]
+**note** | **string** | note | [default to undefined]
+**user** | **string** | user | [default to undefined]
+**timestamp** | **string** | timestamp | [default to undefined]
 
 ## Example
 

package/docs/NumberPortRangeDTO.md

@@ -10,8 +10,8 @@ Name | Type | Description | Notes
 **rangeEnd** | **string** | Range End Number | [optional] [default to undefined]
 **lcp** | **string** | Losing Communications Provider | [optional] [default to undefined]
 **postCode** | **string** | Range Post Code | [optional] [default to undefined]
-**id** | **number** | Number Port Range ID | [optional] [default to undefined]
-**portId** | **number** | Number Port ID | [optional] [default to undefined]
+**id** | **number** | Number Port Range ID | [default to undefined]
+**portId** | **number** | Number Port ID | [default to undefined]
 **rangeHolder** | **string** | Range Holder | [optional] [default to undefined]
 
 ## Example

package/docs/NumberPortingApi.md

@@ -472,6 +472,8 @@ import {
 const configuration = new Configuration();
 const apiInstance = new NumberPortingApi(configuration);
 
+let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (default to undefined)
+let cloa: File; //CLOA (only provide on submission) (default to undefined)
 let companyName: string; //Company Name (optional) (default to undefined)
 let addressLine1: string; //Address Line 1 (optional) (default to undefined)
 let addressLine2: string; //Address Line 2 (optional) (default to undefined)
@@ -482,10 +484,10 @@ let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
 let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
 let asap: boolean; //Port Date ASAP (optional) (default to undefined)
 let comment: string; //Comment (optional) (default to undefined)
-let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (optional) (default to undefined)
-let cloa: File; //CLOA (only provide on submission) (optional) (default to undefined)
 
 const { status, data } = await apiInstance.postCreateNumberPort(
+    numberRanges,
+    cloa,
     companyName,
     addressLine1,
     addressLine2,
@@ -495,9 +497,7 @@ const { status, data } = await apiInstance.postCreateNumberPort(
     tenantId,
     requestedPortDate,
     asap,
-    comment,
-    numberRanges,
-    cloa
+    comment
 );
 ```
 
@@ -505,6 +505,8 @@ const { status, data } = await apiInstance.postCreateNumberPort(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **numberRanges** | **Array&lt;NumberPortRangeRequestDTO&gt;** | Number Ranges | defaults to undefined|
+| **cloa** | [**File**] | CLOA (only provide on submission) | defaults to undefined|
 | **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
 | **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
 | **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
@@ -515,8 +517,6 @@ const { status, data } = await apiInstance.postCreateNumberPort(
 | **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
 | **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
 | **comment** | [**string**] | Comment | (optional) defaults to undefined|
-| **numberRanges** | **Array&lt;NumberPortRangeRequestDTO&gt;** | Number Ranges | (optional) defaults to undefined|
-| **cloa** | [**File**] | CLOA (only provide on submission) | (optional) defaults to undefined|
 
 
 ### Return type
@@ -559,6 +559,8 @@ const configuration = new Configuration();
 const apiInstance = new NumberPortingApi(configuration);
 
 let id: number; //Number Port ID (default to undefined)
+let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (default to undefined)
+let cloa: File; //CLOA (only provide on submission) (default to undefined)
 let companyName: string; //Company Name (optional) (default to undefined)
 let addressLine1: string; //Address Line 1 (optional) (default to undefined)
 let addressLine2: string; //Address Line 2 (optional) (default to undefined)
@@ -569,11 +571,11 @@ let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
 let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
 let asap: boolean; //Port Date ASAP (optional) (default to undefined)
 let comment: string; //Comment (optional) (default to undefined)
-let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (optional) (default to undefined)
-let cloa: File; //CLOA (only provide on submission) (optional) (default to undefined)
 
 const { status, data } = await apiInstance.postSubmitNumberPort(
     id,
+    numberRanges,
+    cloa,
     companyName,
     addressLine1,
     addressLine2,
@@ -583,9 +585,7 @@ const { status, data } = await apiInstance.postSubmitNumberPort(
     tenantId,
     requestedPortDate,
     asap,
-    comment,
-    numberRanges,
-    cloa
+    comment
 );
 ```
 
@@ -594,6 +594,8 @@ const { status, data } = await apiInstance.postSubmitNumberPort(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Number Port ID | defaults to undefined|
+| **numberRanges** | **Array&lt;NumberPortRangeRequestDTO&gt;** | Number Ranges | defaults to undefined|
+| **cloa** | [**File**] | CLOA (only provide on submission) | defaults to undefined|
 | **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
 | **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
 | **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
@@ -604,8 +606,6 @@ const { status, data } = await apiInstance.postSubmitNumberPort(
 | **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
 | **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
 | **comment** | [**string**] | Comment | (optional) defaults to undefined|
-| **numberRanges** | **Array&lt;NumberPortRangeRequestDTO&gt;** | Number Ranges | (optional) defaults to undefined|
-| **cloa** | [**File**] | CLOA (only provide on submission) | (optional) defaults to undefined|
 
 
 ### Return type
@@ -648,6 +648,8 @@ const configuration = new Configuration();
 const apiInstance = new NumberPortingApi(configuration);
 
 let id: number; //Number Port ID (default to undefined)
+let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (default to undefined)
+let cloa: File; //CLOA (only provide on submission) (default to undefined)
 let companyName: string; //Company Name (optional) (default to undefined)
 let addressLine1: string; //Address Line 1 (optional) (default to undefined)
 let addressLine2: string; //Address Line 2 (optional) (default to undefined)
@@ -658,11 +660,11 @@ let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
 let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
 let asap: boolean; //Port Date ASAP (optional) (default to undefined)
 let comment: string; //Comment (optional) (default to undefined)
-let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (optional) (default to undefined)
-let cloa: File; //CLOA (only provide on submission) (optional) (default to undefined)
 
 const { status, data } = await apiInstance.postUpdateNumberPort(
     id,
+    numberRanges,
+    cloa,
     companyName,
     addressLine1,
     addressLine2,
@@ -672,9 +674,7 @@ const { status, data } = await apiInstance.postUpdateNumberPort(
     tenantId,
     requestedPortDate,
     asap,
-    comment,
-    numberRanges,
-    cloa
+    comment
 );
 ```
 
@@ -683,6 +683,8 @@ const { status, data } = await apiInstance.postUpdateNumberPort(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Number Port ID | defaults to undefined|
+| **numberRanges** | **Array&lt;NumberPortRangeRequestDTO&gt;** | Number Ranges | defaults to undefined|
+| **cloa** | [**File**] | CLOA (only provide on submission) | defaults to undefined|
 | **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
 | **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
 | **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
@@ -693,8 +695,6 @@ const { status, data } = await apiInstance.postUpdateNumberPort(
 | **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
 | **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
 | **comment** | [**string**] | Comment | (optional) defaults to undefined|
-| **numberRanges** | **Array&lt;NumberPortRangeRequestDTO&gt;** | Number Ranges | (optional) defaults to undefined|
-| **cloa** | [**File**] | CLOA (only provide on submission) | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/NumberPortsModel.md

@@ -6,10 +6,10 @@ Number Ports
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**results** | [**Array<NumberPortDTO>**](NumberPortDTO.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<NumberPortDTO>**](NumberPortDTO.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/OfflineInstancesEntity.md

@@ -6,11 +6,11 @@ OfflineInstancesEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**instanceId** | **string** | instanceId | [optional] [default to undefined]
-**offlineSince** | **string** | offlineSince | [optional] [default to undefined]
-**rebooted** | **number** | rebooted | [optional] [default to undefined]
-**alerted** | **number** | alerted | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**instanceId** | **string** | instanceId | [default to undefined]
+**offlineSince** | **string** | offlineSince | [default to undefined]
+**rebooted** | **number** | rebooted | [default to undefined]
+**alerted** | **number** | alerted | [default to undefined]
 
 ## Example
 

package/docs/OrderDTO.md

@@ -6,9 +6,9 @@ Legacy Portal Order
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**basket** | [**Array<ItemDTO>**](ItemDTO.md) | Basket | [optional] [default to undefined]
-**shippingAddress** | [**ShippingAddressDTO**](ShippingAddressDTO.md) |  | [optional] [default to undefined]
-**orderDetails** | [**OrderDetailsDTO**](OrderDetailsDTO.md) |  | [optional] [default to undefined]
+**basket** | [**Array<ItemDTO>**](ItemDTO.md) | Basket | [default to undefined]
+**shippingAddress** | [**ShippingAddressDTO**](ShippingAddressDTO.md) |  | [default to undefined]
+**orderDetails** | [**OrderDetailsDTO**](OrderDetailsDTO.md) |  | [default to undefined]
 
 ## Example
 

package/docs/OrderDetailsDTO.md

@@ -6,22 +6,22 @@ Order Details
 
 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]
 **detailedItems** | [**Array<OrderItemDTO>**](OrderItemDTO.md) | Detailed Items | [optional] [default to undefined]
 **batches** | [**Array<BatchDTO>**](BatchDTO.md) | Batches | [optional] [default to undefined]
 **logEntries** | [**Array<AuditLogEntity>**](AuditLogEntity.md) | Audit Log | [optional] [default to undefined]

package/docs/OrderEntity.md

@@ -6,63 +6,63 @@ OrdersEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**reference** | **string** | externalId | [optional] [default to undefined]
-**sourceId** | **number** | sourceId | [optional] [default to undefined]
-**invoiceNumber** | **string** | sageInv | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**reference** | **string** | externalId | [default to undefined]
+**sourceId** | **number** | sourceId | [default to undefined]
+**invoiceNumber** | **string** | sageInv | [default to undefined]
 **invoiceId** | **string** | invoiceId | [optional] [default to undefined]
-**customerId** | **number** | creditAccountId | [optional] [default to undefined]
-**orderDate** | **string** | orderDate | [optional] [default to undefined]
-**orderPostedDate** | **string** | orderPostedDate | [optional] [default to undefined]
-**buyerEmail** | **string** | buyerEmail | [optional] [default to undefined]
-**buyerPhone** | **string** | buyerPhone | [optional] [default to undefined]
-**buyerName** | **string** | buyerName | [optional] [default to undefined]
-**buyerCompany** | **string** | buyerCompany | [optional] [default to undefined]
-**billName** | **string** | billName | [optional] [default to undefined]
-**billAddress1** | **string** | billAddress1 | [optional] [default to undefined]
-**billAddress2** | **string** | billAddress2 | [optional] [default to undefined]
-**billAddress3** | **string** | billAddress3 | [optional] [default to undefined]
-**billCity** | **string** | billCity | [optional] [default to undefined]
-**billStateRegion** | **string** | billStateRegion | [optional] [default to undefined]
-**billPostalCode** | **string** | billPostalCode | [optional] [default to undefined]
-**billCountry** | **string** | billCountry | [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]
-**shipAddress3** | **string** | shipAddress3 | [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]
-**shipVatNumber** | **string** | shipVatNumber | [optional] [default to undefined]
-**shipPhoneNumber** | **string** | shipPhoneNumber | [optional] [default to undefined]
-**shipCourier** | **string** | shipCourier | [optional] [default to undefined]
-**shipMethod** | **string** | shipMethod | [optional] [default to undefined]
-**shipServiceLevel** | **string** | shipServiceLevel | [optional] [default to undefined]
-**shipTrackingId** | **string** | shipTrackingId | [optional] [default to undefined]
-**currency** | **string** | currency | [optional] [default to undefined]
-**taxRate** | **number** | taxRate | [optional] [default to undefined]
-**taxAmount** | **number** | taxAmount | [optional] [default to undefined]
-**taxAmountGbp** | **number** | taxAmountGbp | [optional] [default to undefined]
-**paidStatus** | **number** | paidStatus | [optional] [default to undefined]
-**invoicePaid** | **number** | invoicePaid | [optional] [default to undefined]
-**quote** | **number** | quoteStatus | [optional] [default to undefined]
-**sageStatus** | **string** | sageStatus | [optional] [default to undefined]
-**transactionId** | **string** | transactionId | [optional] [default to undefined]
-**customerInvoiceSent** | **number** | customerInvoiceSent | [optional] [default to undefined]
-**supplierOrderedStatus** | **number** | supplierOrderedStatus | [optional] [default to undefined]
-**supplierPaidStatus** | **number** | supplierPaidStatus | [optional] [default to undefined]
-**supplierReceivedStatus** | **number** | supplierRecvdStatus | [optional] [default to undefined]
-**carriageRefunded** | **number** | carriageRefunded | [optional] [default to undefined]
-**amazonMinus** | **number** | amazonMinus | [optional] [default to undefined]
-**currencyRate** | **number** | currencyRate | [optional] [default to undefined]
-**hzStatus** | **number** | hzStatus | [optional] [default to undefined]
-**prospect** | **number** | prospect | [optional] [default to undefined]
-**provisioningUrl** | **number** | provisioningUrl | [optional] [default to undefined]
-**uniqueId** | **string** | uniqueId | [optional] [default to undefined]
-**notes** | **string** | notes | [optional] [default to undefined]
-**promocode** | **string** | promocode | [optional] [default to undefined]
+**customerId** | **number** | creditAccountId | [default to undefined]
+**orderDate** | **string** | orderDate | [default to undefined]
+**orderPostedDate** | **string** | orderPostedDate | [default to undefined]
+**buyerEmail** | **string** | buyerEmail | [default to undefined]
+**buyerPhone** | **string** | buyerPhone | [default to undefined]
+**buyerName** | **string** | buyerName | [default to undefined]
+**buyerCompany** | **string** | buyerCompany | [default to undefined]
+**billName** | **string** | billName | [default to undefined]
+**billAddress1** | **string** | billAddress1 | [default to undefined]
+**billAddress2** | **string** | billAddress2 | [default to undefined]
+**billAddress3** | **string** | billAddress3 | [default to undefined]
+**billCity** | **string** | billCity | [default to undefined]
+**billStateRegion** | **string** | billStateRegion | [default to undefined]
+**billPostalCode** | **string** | billPostalCode | [default to undefined]
+**billCountry** | **string** | billCountry | [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]
+**shipAddress3** | **string** | shipAddress3 | [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]
+**shipVatNumber** | **string** | shipVatNumber | [default to undefined]
+**shipPhoneNumber** | **string** | shipPhoneNumber | [default to undefined]
+**shipCourier** | **string** | shipCourier | [default to undefined]
+**shipMethod** | **string** | shipMethod | [default to undefined]
+**shipServiceLevel** | **string** | shipServiceLevel | [default to undefined]
+**shipTrackingId** | **string** | shipTrackingId | [default to undefined]
+**currency** | **string** | currency | [default to undefined]
+**taxRate** | **number** | taxRate | [default to undefined]
+**taxAmount** | **number** | taxAmount | [default to undefined]
+**taxAmountGbp** | **number** | taxAmountGbp | [default to undefined]
+**paidStatus** | **number** | paidStatus | [default to undefined]
+**invoicePaid** | **number** | invoicePaid | [default to undefined]
+**quote** | **number** | quoteStatus | [default to undefined]
+**sageStatus** | **string** | sageStatus | [default to undefined]
+**transactionId** | **string** | transactionId | [default to undefined]
+**customerInvoiceSent** | **number** | customerInvoiceSent | [default to undefined]
+**supplierOrderedStatus** | **number** | supplierOrderedStatus | [default to undefined]
+**supplierPaidStatus** | **number** | supplierPaidStatus | [default to undefined]
+**supplierReceivedStatus** | **number** | supplierRecvdStatus | [default to undefined]
+**carriageRefunded** | **number** | carriageRefunded | [default to undefined]
+**amazonMinus** | **number** | amazonMinus | [default to undefined]
+**currencyRate** | **number** | currencyRate | [default to undefined]
+**hzStatus** | **number** | hzStatus | [default to undefined]
+**prospect** | **number** | prospect | [default to undefined]
+**provisioningUrl** | **number** | provisioningUrl | [default to undefined]
+**uniqueId** | **string** | uniqueId | [default to undefined]
+**notes** | **string** | notes | [default to undefined]
+**promocode** | **string** | promocode | [default to undefined]
 **fulfillable** | **boolean** | fulfillable | [optional] [default to undefined]
 
 ## Example

package/docs/OrderItemDTO.md

@@ -6,8 +6,8 @@ Order Item Details
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**quantity** | **number** | Quantity | [optional] [default to undefined]
+**sku** | **string** | SKU | [default to undefined]
+**quantity** | **number** | Quantity | [default to undefined]
 **id** | **number** | ID | [optional] [default to undefined]
 **orderId** | **number** | Order ID | [optional] [default to undefined]
 **title** | **string** | Title | [optional] [default to undefined]

package/docs/OrderRequestModel.md

@@ -11,12 +11,12 @@ Name | Type | Description | Notes
 **clientContactName** | **string** | Client/Trust Contact Name | [optional] [default to undefined]
 **clientContactEmail** | **string** | Client/Trust Contact Email | [optional] [default to undefined]
 **terms** | **boolean** | Agreed to Terms and Conditions | [optional] [default to undefined]
-**schoolName** | **string** | School Name | [optional] [default to undefined]
-**dfECode** | **string** | School DfE Code | [optional] [default to undefined]
-**schoolContactName** | **string** | School Technical Contact Name | [optional] [default to undefined]
-**schoolContactEmail** | **string** | School Technical Contact Email | [optional] [default to undefined]
-**licenceType** | **string** | Licence Type | [optional] [default to undefined]
-**schoolType** | **string** | School Type | [optional] [default to undefined]
+**schoolName** | **string** | School Name | [default to undefined]
+**dfECode** | **string** | School DfE Code | [default to undefined]
+**schoolContactName** | **string** | School Technical Contact Name | [default to undefined]
+**schoolContactEmail** | **string** | School Technical Contact Email | [default to undefined]
+**licenceType** | **string** | Licence Type | [default to undefined]
+**schoolType** | **string** | School Type | [default to undefined]
 **instanceId** | **string** | InstanceId | [optional] [default to undefined]
 **orderReference** | **string** | Order Reference | [optional] [default to undefined]
 

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