yellowgrid-api-ts 3.2.233-dev.0 → 3.2.234-dev.0

package/docs/NumberPortingApi.md

@@ -472,20 +472,22 @@ import {
 const configuration = new Configuration();
 const apiInstance = new NumberPortingApi(configuration);
 
-let companyName: string; //Company Name (default to undefined)
-let addressLine1: string; //Address Line 1 (default to undefined)
-let addressLine2: string; //Address Line 2 (default to undefined)
-let city: string; //City (default to undefined)
-let postCode: string; //Post Code (default to undefined)
-let trunkId: number; //Trunk ID (default to undefined)
-let tenantId: string; //Starter Bundle ID (default to undefined)
-let requestedPortDate: string; //Requested Port Date (default to undefined)
-let asap: boolean; //Port Date ASAP (default to undefined)
-let comment: string; //Comment (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)
+let city: string; //City (optional) (default to undefined)
+let postCode: string; //Post Code (optional) (default to undefined)
+let trunkId: number; //Trunk ID (optional) (default to undefined)
+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)
 
 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,18 +505,18 @@ const { status, data } = await apiInstance.postCreateNumberPort(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **companyName** | [**string**] | Company Name | defaults to undefined|
-| **addressLine1** | [**string**] | Address Line 1 | defaults to undefined|
-| **addressLine2** | [**string**] | Address Line 2 | defaults to undefined|
-| **city** | [**string**] | City | defaults to undefined|
-| **postCode** | [**string**] | Post Code | defaults to undefined|
-| **trunkId** | [**number**] | Trunk ID | defaults to undefined|
-| **tenantId** | [**string**] | Starter Bundle ID | defaults to undefined|
-| **requestedPortDate** | [**string**] | Requested Port Date | defaults to undefined|
-| **asap** | [**boolean**] | Port Date ASAP | defaults to undefined|
-| **comment** | [**string**] | Comment | 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|
+| **city** | [**string**] | City | (optional) defaults to undefined|
+| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
+| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
+| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
+| **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|
 
 
 ### Return type
@@ -559,21 +559,23 @@ const configuration = new Configuration();
 const apiInstance = new NumberPortingApi(configuration);
 
 let id: number; //Number Port ID (default to undefined)
-let companyName: string; //Company Name (default to undefined)
-let addressLine1: string; //Address Line 1 (default to undefined)
-let addressLine2: string; //Address Line 2 (default to undefined)
-let city: string; //City (default to undefined)
-let postCode: string; //Post Code (default to undefined)
-let trunkId: number; //Trunk ID (default to undefined)
-let tenantId: string; //Starter Bundle ID (default to undefined)
-let requestedPortDate: string; //Requested Port Date (default to undefined)
-let asap: boolean; //Port Date ASAP (default to undefined)
-let comment: string; //Comment (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)
+let city: string; //City (optional) (default to undefined)
+let postCode: string; //Post Code (optional) (default to undefined)
+let trunkId: number; //Trunk ID (optional) (default to undefined)
+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)
 
 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,18 +594,18 @@ const { status, data } = await apiInstance.postSubmitNumberPort(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Number Port ID | defaults to undefined|
-| **companyName** | [**string**] | Company Name | defaults to undefined|
-| **addressLine1** | [**string**] | Address Line 1 | defaults to undefined|
-| **addressLine2** | [**string**] | Address Line 2 | defaults to undefined|
-| **city** | [**string**] | City | defaults to undefined|
-| **postCode** | [**string**] | Post Code | defaults to undefined|
-| **trunkId** | [**number**] | Trunk ID | defaults to undefined|
-| **tenantId** | [**string**] | Starter Bundle ID | defaults to undefined|
-| **requestedPortDate** | [**string**] | Requested Port Date | defaults to undefined|
-| **asap** | [**boolean**] | Port Date ASAP | defaults to undefined|
-| **comment** | [**string**] | Comment | 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|
+| **city** | [**string**] | City | (optional) defaults to undefined|
+| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
+| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
+| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
+| **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|
 
 
 ### Return type
@@ -648,21 +648,23 @@ const configuration = new Configuration();
 const apiInstance = new NumberPortingApi(configuration);
 
 let id: number; //Number Port ID (default to undefined)
-let companyName: string; //Company Name (default to undefined)
-let addressLine1: string; //Address Line 1 (default to undefined)
-let addressLine2: string; //Address Line 2 (default to undefined)
-let city: string; //City (default to undefined)
-let postCode: string; //Post Code (default to undefined)
-let trunkId: number; //Trunk ID (default to undefined)
-let tenantId: string; //Starter Bundle ID (default to undefined)
-let requestedPortDate: string; //Requested Port Date (default to undefined)
-let asap: boolean; //Port Date ASAP (default to undefined)
-let comment: string; //Comment (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)
+let city: string; //City (optional) (default to undefined)
+let postCode: string; //Post Code (optional) (default to undefined)
+let trunkId: number; //Trunk ID (optional) (default to undefined)
+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)
 
 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,18 +683,18 @@ const { status, data } = await apiInstance.postUpdateNumberPort(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Number Port ID | defaults to undefined|
-| **companyName** | [**string**] | Company Name | defaults to undefined|
-| **addressLine1** | [**string**] | Address Line 1 | defaults to undefined|
-| **addressLine2** | [**string**] | Address Line 2 | defaults to undefined|
-| **city** | [**string**] | City | defaults to undefined|
-| **postCode** | [**string**] | Post Code | defaults to undefined|
-| **trunkId** | [**number**] | Trunk ID | defaults to undefined|
-| **tenantId** | [**string**] | Starter Bundle ID | defaults to undefined|
-| **requestedPortDate** | [**string**] | Requested Port Date | defaults to undefined|
-| **asap** | [**boolean**] | Port Date ASAP | defaults to undefined|
-| **comment** | [**string**] | Comment | 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|
+| **city** | [**string**] | City | (optional) defaults to undefined|
+| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
+| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
+| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
+| **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|
 
 
 ### Return type

package/docs/OAuth20Api.md

@@ -122,18 +122,18 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OAuth20Api(configuration);
 
-let clientId: string; //OAuth 2.0 Client ID (default to undefined)
-let clientSecret: string; //OAuth 2.0 Client Secret (default to undefined)
-let grantType: string; //OAuth 2.0 Grant Type (default to undefined)
-let scope: string; //OAuth 2.0 Scope (default to undefined)
-let redirectUri: string; //OAuth 2.0 Redirect URI (default to undefined)
-let code: string; //OAuth 2.0 Auth Code (default to undefined)
-let refreshToken: string; //OAuth 2.0 Refresh Token (default to undefined)
-let codeVerifier: string; //OAuth 2.0 Code Verifier (default to undefined)
-let token: string; //OAuth 2.0 Token (Only used in Token Exchange) (default to undefined)
-let tokenExchangeType: string; //Token Exchange Type (Only used in Token Exchange) (default to undefined)
-let licenceKey: string; //3CX Licence Key (Only used in Token Exchange) (default to undefined)
-let endUser: boolean; //End User (Only used in Token Exchange) (default to undefined)
+let clientId: string; //OAuth 2.0 Client ID (optional) (default to undefined)
+let clientSecret: string; //OAuth 2.0 Client Secret (optional) (default to undefined)
+let grantType: string; //OAuth 2.0 Grant Type (optional) (default to undefined)
+let scope: string; //OAuth 2.0 Scope (optional) (default to undefined)
+let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
+let code: string; //OAuth 2.0 Auth Code (optional) (default to undefined)
+let refreshToken: string; //OAuth 2.0 Refresh Token (optional) (default to undefined)
+let codeVerifier: string; //OAuth 2.0 Code Verifier (optional) (default to undefined)
+let token: string; //OAuth 2.0 Token (Only used in Token Exchange) (optional) (default to undefined)
+let tokenExchangeType: string; //Token Exchange Type (Only used in Token Exchange) (optional) (default to undefined)
+let licenceKey: string; //3CX Licence Key (Only used in Token Exchange) (optional) (default to undefined)
+let endUser: boolean; //End User (Only used in Token Exchange) (optional) (default to undefined)
 
 const { status, data } = await apiInstance.postAccessToken(
     clientId,
@@ -155,18 +155,18 @@ const { status, data } = await apiInstance.postAccessToken(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
-| **clientSecret** | [**string**] | OAuth 2.0 Client Secret | defaults to undefined|
-| **grantType** | [**string**]**Array<&#39;client_credentials&#39; &#124; &#39;code&#39; &#124; &#39;refresh_token&#39; &#124; &#39;authorization_code&#39; &#124; &#39;ms_auth&#39; &#124; &#39;token_exchange&#39; &#124; &#39;password&#39;>** | OAuth 2.0 Grant Type | defaults to undefined|
-| **scope** | [**string**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;rma.read&#39; &#124; &#39;rma.write&#39; &#124; &#39;sms.read&#39; &#124; &#39;sms.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | defaults to undefined|
-| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | defaults to undefined|
-| **code** | [**string**] | OAuth 2.0 Auth Code | defaults to undefined|
-| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | defaults to undefined|
-| **codeVerifier** | [**string**] | OAuth 2.0 Code Verifier | defaults to undefined|
-| **token** | [**string**] | OAuth 2.0 Token (Only used in Token Exchange) | defaults to undefined|
-| **tokenExchangeType** | [**string**]**Array<&#39;tcx_wizard&#39; &#124; &#39;portal&#39;>** | Token Exchange Type (Only used in Token Exchange) | defaults to undefined|
-| **licenceKey** | [**string**] | 3CX Licence Key (Only used in Token Exchange) | defaults to undefined|
-| **endUser** | [**boolean**] | End User (Only used in Token Exchange) | defaults to undefined|
+| **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
+| **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
+| **grantType** | [**string**]**Array<&#39;client_credentials&#39; &#124; &#39;code&#39; &#124; &#39;refresh_token&#39; &#124; &#39;authorization_code&#39; &#124; &#39;ms_auth&#39; &#124; &#39;token_exchange&#39; &#124; &#39;password&#39;>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
+| **scope** | [**string**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;rma.read&#39; &#124; &#39;rma.write&#39; &#124; &#39;sms.read&#39; &#124; &#39;sms.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | (optional) defaults to undefined|
+| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
+| **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
+| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
+| **codeVerifier** | [**string**] | OAuth 2.0 Code Verifier | (optional) defaults to undefined|
+| **token** | [**string**] | OAuth 2.0 Token (Only used in Token Exchange) | (optional) defaults to undefined|
+| **tokenExchangeType** | [**string**]**Array<&#39;tcx_wizard&#39; &#124; &#39;portal&#39;>** | Token Exchange Type (Only used in Token Exchange) | (optional) defaults to undefined|
+| **licenceKey** | [**string**] | 3CX Licence Key (Only used in Token Exchange) | (optional) defaults to undefined|
+| **endUser** | [**boolean**] | End User (Only used in Token Exchange) | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/OpayoRedirectDTO.md

@@ -6,11 +6,11 @@ Opayo Redirect
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**acsUrl** | **string** | acsUrl | [default to undefined]
-**paReq** | **string** | paReq | [default to undefined]
-**transactionId** | **string** | Transaction ID | [default to undefined]
-**dsTranId** | **string** | dsTranId | [default to undefined]
-**cReq** | **string** | cReq | [default to undefined]
+**acsUrl** | **string** | acsUrl | [optional] [default to undefined]
+**paReq** | **string** | paReq | [optional] [default to undefined]
+**transactionId** | **string** | Transaction ID | [optional] [default to undefined]
+**dsTranId** | **string** | dsTranId | [optional] [default to undefined]
+**cReq** | **string** | cReq | [optional] [default to undefined]
 
 ## Example
 

package/docs/OrderDetailsDTO.md

@@ -7,20 +7,20 @@ Order Details
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **number** | ID | [default to undefined]
-**reference** | **string** | Reference | [default to undefined]
+**reference** | **string** | Reference | [optional] [default to undefined]
 **invoiceNumber** | **string** | Invoice Number | [default to undefined]
-**invoiceId** | **string** | Invoice ID | [default to undefined]
+**invoiceId** | **string** | Invoice ID | [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) |  | [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
 **items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [default to undefined]
 **carriageCharge** | **number** | Carriage Charge | [default to undefined]
-**fulfillable** | **boolean** | Fulfillable | [default to undefined]
-**provisioningUrl** | **string** | Provisioning URL | [default to undefined]
-**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [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 | [default to undefined]
 **detailedItems** | [**Array<OrderItemDTO>**](OrderItemDTO.md) | Detailed Items | [optional] [default to undefined]
 **batches** | [**Array<BatchDTO>**](BatchDTO.md) | Batches | [optional] [default to undefined]

package/docs/OrderEntity.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **reference** | **string** | externalId | [default to undefined]
 **sourceId** | **number** | sourceId | [default to undefined]
 **invoiceNumber** | **string** | sageInv | [default to undefined]
-**invoiceId** | **string** | invoiceId | [default to undefined]
+**invoiceId** | **string** | invoiceId | [optional] [default to undefined]
 **customerId** | **number** | creditAccountId | [default to undefined]
 **orderDate** | **string** | orderDate | [default to undefined]
 **orderPostedDate** | **string** | orderPostedDate | [default to undefined]
@@ -63,7 +63,7 @@ Name | Type | Description | Notes
 **uniqueId** | **string** | uniqueId | [default to undefined]
 **notes** | **string** | notes | [default to undefined]
 **promocode** | **string** | promocode | [default to undefined]
-**fulfillable** | **boolean** | fulfillable | [default to undefined]
+**fulfillable** | **boolean** | fulfillable | [optional] [default to undefined]
 
 ## Example
 

package/docs/OrderRequestModel.md

@@ -6,19 +6,19 @@ EdTechPro Order Request
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**clientId** | **number** | Client/Trust ID | [default to undefined]
-**clientName** | **string** | Client/Trust Name | [default to undefined]
-**clientContactName** | **string** | Client/Trust Contact Name | [default to undefined]
-**clientContactEmail** | **string** | Client/Trust Contact Email | [default to undefined]
-**terms** | **boolean** | Agreed to Terms and Conditions | [default to undefined]
+**clientId** | **number** | Client/Trust ID | [optional] [default to undefined]
+**clientName** | **string** | Client/Trust Name | [optional] [default to undefined]
+**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 | [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 | [default to undefined]
-**orderReference** | **string** | Order Reference | [default to undefined]
+**instanceId** | **string** | InstanceId | [optional] [default to undefined]
+**orderReference** | **string** | Order Reference | [optional] [default to undefined]
 
 ## Example
 

package/docs/OrderResponseDTO.md

@@ -6,9 +6,9 @@ Legacy Portal Response
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**url** | **string** | URL | [default to undefined]
-**orderID** | **string** | Order ID | [default to undefined]
-**uniqueID** | **string** | Unique ID | [default to undefined]
+**url** | **string** | URL | [optional] [default to undefined]
+**orderID** | **string** | Order ID | [optional] [default to undefined]
+**uniqueID** | **string** | Unique ID | [optional] [default to undefined]
 
 ## Example
 

package/docs/OrderSummaryDTO.md

@@ -7,20 +7,20 @@ Order Summary
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **number** | ID | [default to undefined]
-**reference** | **string** | Reference | [default to undefined]
+**reference** | **string** | Reference | [optional] [default to undefined]
 **invoiceNumber** | **string** | Invoice Number | [default to undefined]
-**invoiceId** | **string** | Invoice ID | [default to undefined]
+**invoiceId** | **string** | Invoice ID | [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) |  | [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
 **items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [default to undefined]
 **carriageCharge** | **number** | Carriage Charge | [default to undefined]
-**fulfillable** | **boolean** | Fulfillable | [default to undefined]
-**provisioningUrl** | **string** | Provisioning URL | [default to undefined]
-**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [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 | [default to undefined]
 
 ## Example

package/docs/OrderTotalModel.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **vatRate** | **number** | VAT Rate | [default to undefined]
 **credit** | **number** | Credit | [default to undefined]
 **currency** | **string** | Currency | [default to undefined]
-**delivery** | **number** | Delivery | [default to undefined]
+**delivery** | **number** | Delivery | [optional] [default to undefined]
 
 ## Example
 

package/docs/PartnerDTO.md

@@ -6,7 +6,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**partnerId** | **string** | 3CX Partner ID | [default to undefined]
+**partnerId** | **string** | 3CX Partner ID | [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]
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **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 | [default to undefined]
+**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [optional] [default to undefined]
 
 ## Example
 

package/docs/PasswordSenderDTO.md

@@ -7,14 +7,14 @@ Password Sender Request
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **username** | **string** | Username | [default to undefined]
-**password** | **string** | Password | [default to undefined]
-**expiryInterval** | **number** | Expiry Interval | [default to undefined]
-**intervalType** | **string** | Interval Type | [default to undefined]
-**expiry** | **string** | Expiry | [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 | [default to undefined]
-**url** | **string** | URL | [default to undefined]
-**description** | **string** | Description | [default to undefined]
-**passwordUrl** | **string** | Password URL | [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]
 
 ## Example
 

package/docs/PostGenerateReport200Response.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **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 | [default to undefined]
+**currency** | **string** | Currency | [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]

package/docs/PriceListItemModel.md

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

package/docs/ProductPriceListItemModel.md

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

package/docs/ProductSerialInfoModel.md

@@ -9,7 +9,7 @@ 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]
-**serial_prefixes** | **Array<string>** | Serial Prefix | [default to undefined]
+**serial_prefixes** | **Array<string>** | Serial Prefix | [optional] [default to undefined]
 
 ## Example
 

package/docs/ProspectDTO.md

@@ -7,9 +7,9 @@ Prospect
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **companyName** | **string** | Company Name | [default to undefined]
-**telephone** | **string** | Telephone | [default to undefined]
-**lastOrderDate** | **string** | Last Order Date | [default to undefined]
-**callbackDate** | **string** | Call Back Date | [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]

package/docs/RecordingBackupAzureModel.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **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]
-**recordings_path** | **string** | Recordings Path | [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 | [default to undefined]
-**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [default to undefined]
+**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | Azure Backup Storage | [optional] [default to undefined]
+**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [optional] [default to undefined]
 
 ## Example
 

package/docs/ReportRequestDTO.md

@@ -7,14 +7,14 @@ Report Request
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **report** | **string** | Report | [default to undefined]
-**start** | **string** | Start | [default to undefined]
-**end** | **string** | End | [default to undefined]
-**month** | **number** | Month | [default to undefined]
-**year** | **number** | Year | [default to undefined]
-**sku** | **string** | SKU | [default to undefined]
-**price** | **number** | Price | [default to undefined]
-**recipients** | **Array<string>** | Recipients | [default to undefined]
-**graphType** | **string** | Graph Type | [default to undefined]
+**start** | **string** | Start | [optional] [default to undefined]
+**end** | **string** | End | [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]
+**price** | **number** | Price | [optional] [default to undefined]
+**recipients** | **Array<string>** | Recipients | [optional] [default to undefined]
+**graphType** | **string** | Graph Type | [optional] [default to undefined]
 
 ## Example
 

package/docs/RmaItemDTO.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **id** | **number** | RMA Item ID | [default to undefined]
 **itemId** | **number** | RMA Order Item ID | [default to undefined]
 **itemName** | **string** | RMA Item Name | [default to undefined]
-**macAddress** | **string** | RMA Item MAC Address | [default to undefined]
-**serialNumber** | **string** | RMA Item Serial Number | [default to undefined]
+**macAddress** | **string** | RMA Item MAC Address | [optional] [default to undefined]
+**serialNumber** | **string** | RMA Item Serial Number | [optional] [default to undefined]
 **received** | **boolean** | RMA Item Received Status | [default to undefined]
 **status** | **number** | RMA Item Status | [default to undefined]
 **statusText** | **string** | RMA Item Status Text | [default to undefined]

package/docs/RmaItemRequestDTO.md

@@ -7,8 +7,8 @@ RMA Request Item
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **itemId** | **number** | RMA Item ID | [default to undefined]
-**macAddress** | **string** | RMA Item MAC Address | [default to undefined]
-**serialNumber** | **string** | RMA Item Serial Number | [default to undefined]
+**macAddress** | **string** | RMA Item MAC Address | [optional] [default to undefined]
+**serialNumber** | **string** | RMA Item Serial Number | [optional] [default to undefined]
 
 ## Example
 

package/docs/SbcDTO.md

@@ -6,14 +6,14 @@ Legacy Portal SBC
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**noConfig** | **boolean** | No Config | [default to undefined]
-**dhcp** | **boolean** | DHCP | [default to undefined]
-**url** | **boolean** | 3CX URL | [default to undefined]
-**authKey** | **boolean** | 3CX SBC Auth Key | [default to undefined]
-**ipAddress** | **boolean** | LAN IP Address | [default to undefined]
-**subnetMask** | **boolean** | LAN Subnet Mask | [default to undefined]
-**defaultGateway** | **boolean** | LAN Default Gateway | [default to undefined]
-**dns** | **boolean** | DNS | [default to undefined]
+**noConfig** | **boolean** | No Config | [optional] [default to undefined]
+**dhcp** | **boolean** | DHCP | [optional] [default to undefined]
+**url** | **boolean** | 3CX URL | [optional] [default to undefined]
+**authKey** | **boolean** | 3CX SBC Auth Key | [optional] [default to undefined]
+**ipAddress** | **boolean** | LAN IP Address | [optional] [default to undefined]
+**subnetMask** | **boolean** | LAN Subnet Mask | [optional] [default to undefined]
+**defaultGateway** | **boolean** | LAN Default Gateway | [optional] [default to undefined]
+**dns** | **boolean** | DNS | [optional] [default to undefined]
 
 ## Example