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

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

@@ -1,6 +1,6 @@
 # OAuth20Api
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -158,7 +158,7 @@ const { status, data } = await apiInstance.postAccessToken(
 | **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;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|
+| **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|
@@ -211,7 +211,7 @@ const apiInstance = new OAuth20Api(configuration);
 
 let clientId: string; //OAuth 2.0 Client ID (default to undefined)
 let responseType: string; //OAuth 2.0 Response Type (default to 'code')
-let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
+let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
 let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
 let state: string; //OAuth 2.0 State (optional) (default to undefined)
 let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
@@ -234,7 +234,7 @@ const { status, data } = await apiInstance.postAuthorise(
 |------------- | ------------- | ------------- | -------------|
 | **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
 | **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
-| **scope** | [**&#39;*&#39; | &#39;fdps&#39; | &#39;scope&#39; | &#39;portal&#39; | &#39;tcx_wizard&#39; | &#39;accounts.read&#39; | &#39;accounts.write&#39; | &#39;number_porting.read&#39; | &#39;number_porting.write&#39; | &#39;pricing.read&#39; | &#39;orders.read&#39; | &#39;orders.write&#39; | &#39;products.read&#39; | &#39;provisioning.read&#39; | &#39;provisioning.write&#39; | &#39;sms.read&#39; | &#39;sms.write&#39; | &#39;trunks.read&#39; | &#39;trunks.write&#39; | &#39;tcx_integrations.read&#39; | &#39;tcx_integrations.write&#39; | &#39;tcx_licence_details.read&#39; | &#39;tcx_installations.read&#39; | &#39;tcx_installations.write&#39; | &#39;tcx_mt.read&#39; | &#39;tcx_mt.write&#39; | &#39;tickets.read&#39; | &#39;tickets.write&#39;**]**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;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|
+| **scope** | [**&#39;*&#39; | &#39;fdps&#39; | &#39;scope&#39; | &#39;portal&#39; | &#39;tcx_wizard&#39; | &#39;accounts.read&#39; | &#39;accounts.write&#39; | &#39;number_porting.read&#39; | &#39;number_porting.write&#39; | &#39;pricing.read&#39; | &#39;orders.read&#39; | &#39;orders.write&#39; | &#39;products.read&#39; | &#39;provisioning.read&#39; | &#39;provisioning.write&#39; | &#39;rma.read&#39; | &#39;rma.write&#39; | &#39;sms.read&#39; | &#39;sms.write&#39; | &#39;trunks.read&#39; | &#39;trunks.write&#39; | &#39;tcx_integrations.read&#39; | &#39;tcx_integrations.write&#39; | &#39;tcx_licence_details.read&#39; | &#39;tcx_installations.read&#39; | &#39;tcx_installations.write&#39; | &#39;tcx_mt.read&#39; | &#39;tcx_mt.write&#39; | &#39;tickets.read&#39; | &#39;tickets.write&#39;**]**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 | (optional) defaults to undefined|
 | **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
 | **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|

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
 

package/docs/OrderSummaryDTO.md

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

package/docs/OrderTotalModel.md

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

package/docs/OrderedItemEntity.md

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

package/docs/OrderedItemModel.md

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

package/docs/OrdersApi.md

@@ -1,6 +1,6 @@
 # OrdersApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/OutboundCli.md

@@ -0,0 +1,70 @@
+# OutboundCli
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**cli** | **string** |  | [default to undefined]
+**customerId** | **number** |  | [optional] [default to undefined]
+**customer** | [**Customer**](Customer.md) |  | [optional] [default to undefined]
+**operator** | **string** |  | [optional] [default to undefined]
+**callTariffPlanId** | **number** |  | [optional] [default to undefined]
+**callTariffPlan** | [**CallTariffPlan**](CallTariffPlan.md) |  | [optional] [default to undefined]
+**servicePlanId** | **number** |  | [optional] [default to undefined]
+**servicePlan** | [**ServicePlan**](ServicePlan.md) |  | [optional] [default to undefined]
+**invoiceDescription** | **string** |  | [optional] [default to undefined]
+**inboundTariffPlanId** | **number** |  | [optional] [default to undefined]
+**inboundTariffPlan** | [**InboundTariffPlan**](InboundTariffPlan.md) |  | [optional] [default to undefined]
+**inboundInvoiceDescription** | **string** |  | [optional] [default to undefined]
+**serviceID** | **string** |  | [optional] [default to undefined]
+**connectedDate** | **string** |  | [optional] [default to undefined]
+**disconnectedDate** | **string** |  | [optional] [default to undefined]
+**lastTrafficPeriod** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**sipTrunkSdrRefId** | **number** |  | [optional] [default to undefined]
+**isMtPrimarySipTrunk** | **boolean** |  | [optional] [default to undefined]
+**mtPrimarySipTrunkId** | **number** |  | [optional] [default to undefined]
+**zeroRated** | **boolean** |  | [optional] [default to undefined]
+**connected** | **boolean** |  | [optional] [readonly] [default to undefined]
+**futureConnection** | **boolean** |  | [optional] [readonly] [default to undefined]
+**sdrRefType** | [**SdrReferenceType**](SdrReferenceType.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OutboundCli } from 'yellowgrid-api-ts';
+
+const instance: OutboundCli = {
+    createdDate,
+    id,
+    cli,
+    customerId,
+    customer,
+    operator,
+    callTariffPlanId,
+    callTariffPlan,
+    servicePlanId,
+    servicePlan,
+    invoiceDescription,
+    inboundTariffPlanId,
+    inboundTariffPlan,
+    inboundInvoiceDescription,
+    serviceID,
+    connectedDate,
+    disconnectedDate,
+    lastTrafficPeriod,
+    filePeriod,
+    sipTrunkSdrRefId,
+    isMtPrimarySipTrunk,
+    mtPrimarySipTrunkId,
+    zeroRated,
+    connected,
+    futureConnection,
+    sdrRefType,
+};
+```
+
+[[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/PartnerDTO.md

@@ -7,16 +7,16 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **partnerId** | **string** | 3CX Partner ID | [optional] [default to undefined]
-**companyName** | **string** | 3CX Partner Company Name | [optional] [default to undefined]
-**contactName** | **string** | 3CX Partner Contact Name | [optional] [default to undefined]
-**contactPhone** | **string** | 3CX Partner Contact Phone | [optional] [default to undefined]
-**contactEmail** | **string** | 3CX Partner Contact Email | [optional] [default to undefined]
-**partnerLevel** | **string** | 3CX Partner Level | [optional] [default to undefined]
-**licenceDiscountPercent** | **number** | 3CX Partner Licence Discount Percent | [optional] [default to undefined]
-**hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [optional] [default to undefined]
-**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
-**installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
-**aligned** | **boolean** | Aligned | [optional] [default to undefined]
+**companyName** | **string** | 3CX Partner Company Name | [default to undefined]
+**contactName** | **string** | 3CX Partner Contact Name | [default to undefined]
+**contactPhone** | **string** | 3CX Partner Contact Phone | [default to undefined]
+**contactEmail** | **string** | 3CX Partner Contact Email | [default to undefined]
+**partnerLevel** | **string** | 3CX Partner Level | [default to undefined]
+**licenceDiscountPercent** | **number** | 3CX Partner Licence Discount Percent | [default to undefined]
+**hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [default to undefined]
+**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [default to undefined]
+**installationUrl** | **string** | 3CX Installation URL | [default to undefined]
+**aligned** | **boolean** | Aligned | [default to undefined]
 **customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [optional] [default to undefined]
 
 ## Example

package/docs/PasswordSenderDTO.md

@@ -0,0 +1,37 @@
+# PasswordSenderDTO
+
+Password Sender Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** | Username | [default to undefined]
+**password** | **string** | Password | [optional] [default to undefined]
+**expiryInterval** | **number** | Expiry Interval | [optional] [default to undefined]
+**intervalType** | **string** | Interval Type | [optional] [default to undefined]
+**expiry** | **string** | Expiry | [optional] [default to undefined]
+**recipient** | **Array<string>** | Recipient | [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
+
+```typescript
+import { PasswordSenderDTO } from 'yellowgrid-api-ts';
+
+const instance: PasswordSenderDTO = {
+    username,
+    password,
+    expiryInterval,
+    intervalType,
+    expiry,
+    recipient,
+    url,
+    description,
+    passwordUrl,
+};
+```
+
+[[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/PasswordSenderEntity.md

@@ -0,0 +1,33 @@
+# PasswordSenderEntity
+
+PasswordSenderEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uniqueId** | **string** | uniqueId | [default to undefined]
+**url** | **string** | url | [default to undefined]
+**username** | **string** | username | [default to undefined]
+**password** | **string** | password | [default to undefined]
+**expiryTime** | **string** | expiryTime | [default to undefined]
+**emailRecipient** | **string** | emailRecipient | [default to undefined]
+**description** | **string** | description | [default to undefined]
+
+## Example
+
+```typescript
+import { PasswordSenderEntity } from 'yellowgrid-api-ts';
+
+const instance: PasswordSenderEntity = {
+    uniqueId,
+    url,
+    username,
+    password,
+    expiryTime,
+    emailRecipient,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)