yellowgrid-api-ts 3.2.264 → 3.2.265-dev.0

package/docs/InstanceEntity.md

@@ -6,27 +6,27 @@ InstancesEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**instanceId** | **string** | instanceId | [optional] [default to undefined]
-**project** | **string** | project | [optional] [default to undefined]
-**region** | **string** | region | [optional] [default to undefined]
-**name** | **string** | name | [optional] [default to undefined]
-**hostname** | **string** | hostname | [optional] [default to undefined]
-**ipAddress** | **string** | ipAddress | [optional] [default to undefined]
-**flavor** | **string** | flavor | [optional] [default to undefined]
-**sshPassword** | **string** | sshPassword | [optional] [default to undefined]
-**putty** | **string** | putty | [optional] [default to undefined]
-**pkcs8** | **string** | pkcs8 | [optional] [default to undefined]
-**recordingsPath** | **string** | recordingsPath | [optional] [default to undefined]
-**additionalDisk** | **number** | additionalDisk | [optional] [default to undefined]
-**ahsayUser** | **string** | ahsayUser | [optional] [default to undefined]
-**ahsayPass** | **string** | ahsayPass | [optional] [default to undefined]
-**ahsayKey** | **string** | ahsayKey | [optional] [default to undefined]
-**scriptsStarted** | **string** | scriptsStarted | [optional] [default to undefined]
-**scriptFinished** | **string** | scriptFinished | [optional] [default to undefined]
-**creationDate** | **string** | creationDate | [optional] [default to undefined]
-**status** | **string** | status | [optional] [default to undefined]
-**autoFailover** | **number** | autoFailover | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**instanceId** | **string** | instanceId | [default to undefined]
+**project** | **string** | project | [default to undefined]
+**region** | **string** | region | [default to undefined]
+**name** | **string** | name | [default to undefined]
+**hostname** | **string** | hostname | [default to undefined]
+**ipAddress** | **string** | ipAddress | [default to undefined]
+**flavor** | **string** | flavor | [default to undefined]
+**sshPassword** | **string** | sshPassword | [default to undefined]
+**putty** | **string** | putty | [default to undefined]
+**pkcs8** | **string** | pkcs8 | [default to undefined]
+**recordingsPath** | **string** | recordingsPath | [default to undefined]
+**additionalDisk** | **number** | additionalDisk | [default to undefined]
+**ahsayUser** | **string** | ahsayUser | [default to undefined]
+**ahsayPass** | **string** | ahsayPass | [default to undefined]
+**ahsayKey** | **string** | ahsayKey | [default to undefined]
+**scriptsStarted** | **string** | scriptsStarted | [default to undefined]
+**scriptFinished** | **string** | scriptFinished | [default to undefined]
+**creationDate** | **string** | creationDate | [default to undefined]
+**status** | **string** | status | [default to undefined]
+**autoFailover** | **number** | autoFailover | [default to undefined]
 
 ## Example
 

package/docs/InstanceFailoverEntity.md

@@ -6,17 +6,17 @@ InstanceFailoverEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**creation** | **string** | creation | [optional] [default to undefined]
-**instanceId** | **string** | instanceId | [optional] [default to undefined]
-**failoverInstanceId** | **string** | failoverInstanceId | [optional] [default to undefined]
-**platform** | **string** | platform | [optional] [default to undefined]
-**name** | **string** | name | [optional] [default to undefined]
-**ipAddress** | **string** | ipAddress | [optional] [default to undefined]
-**flavor** | **string** | flavor | [optional] [default to undefined]
-**image** | **string** | image | [optional] [default to undefined]
-**status** | **string** | status | [optional] [default to undefined]
-**failback** | **string** | failback | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**creation** | **string** | creation | [default to undefined]
+**instanceId** | **string** | instanceId | [default to undefined]
+**failoverInstanceId** | **string** | failoverInstanceId | [default to undefined]
+**platform** | **string** | platform | [default to undefined]
+**name** | **string** | name | [default to undefined]
+**ipAddress** | **string** | ipAddress | [default to undefined]
+**flavor** | **string** | flavor | [default to undefined]
+**image** | **string** | image | [default to undefined]
+**status** | **string** | status | [default to undefined]
+**failback** | **string** | failback | [default to undefined]
 
 ## Example
 

package/docs/InstanceMonitoringEntity.md

@@ -6,9 +6,9 @@ InstanceMonitoringEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**instanceId** | **string** | instanceId | [optional] [default to undefined]
-**port** | **number** | port | [optional] [default to undefined]
-**lastConnected** | **string** | lastConnected | [optional] [default to undefined]
+**instanceId** | **string** | instanceId | [default to undefined]
+**port** | **number** | port | [default to undefined]
+**lastConnected** | **string** | lastConnected | [default to undefined]
 
 ## Example
 

package/docs/InstanceMonitoringLogEntity.md

@@ -6,12 +6,12 @@ InstanceMonitoringLogEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**instanceId** | **string** | instanceId | [optional] [default to undefined]
-**code** | **number** | code | [optional] [default to undefined]
-**error** | **string** | error | [optional] [default to undefined]
-**date** | **string** | date | [optional] [default to undefined]
-**timestamp** | **string** | timestamp | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**instanceId** | **string** | instanceId | [default to undefined]
+**code** | **number** | code | [default to undefined]
+**error** | **string** | error | [default to undefined]
+**date** | **string** | date | [default to undefined]
+**timestamp** | **string** | timestamp | [default to undefined]
 
 ## Example
 

package/docs/InstanceScheduledTasksEntity.md

@@ -6,12 +6,12 @@ InstanceScheduledTasksEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**instanceId** | **string** | instanceId | [optional] [default to undefined]
-**task** | **string** | task | [optional] [default to undefined]
-**value** | **string** | value | [optional] [default to undefined]
-**time** | **string** | time | [optional] [default to undefined]
-**status** | **number** | status | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**instanceId** | **string** | instanceId | [default to undefined]
+**task** | **string** | task | [default to undefined]
+**value** | **string** | value | [default to undefined]
+**time** | **string** | time | [default to undefined]
+**status** | **number** | status | [default to undefined]
 
 ## Example
 

package/docs/InstanceTcxDetailsEntity.md

@@ -6,16 +6,16 @@ InstanceTcxDetailsEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**instanceId** | **string** | instanceId | [optional] [default to undefined]
-**version** | **string** | version | [optional] [default to undefined]
-**maxSimCalls** | **number** | maxSimCalls | [optional] [default to undefined]
-**fqdn** | **string** | fqdn | [optional] [default to undefined]
-**productCode** | **string** | productCode | [optional] [default to undefined]
-**resellerName** | **string** | resellerName | [optional] [default to undefined]
-**licenseKey** | **string** | licenseKey | [optional] [default to undefined]
-**adminEMail** | **string** | adminEMail | [optional] [default to undefined]
-**expirationDate** | **string** | expirationDate | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**instanceId** | **string** | instanceId | [default to undefined]
+**version** | **string** | version | [default to undefined]
+**maxSimCalls** | **number** | maxSimCalls | [default to undefined]
+**fqdn** | **string** | fqdn | [default to undefined]
+**productCode** | **string** | productCode | [default to undefined]
+**resellerName** | **string** | resellerName | [default to undefined]
+**licenseKey** | **string** | licenseKey | [default to undefined]
+**adminEMail** | **string** | adminEMail | [default to undefined]
+**expirationDate** | **string** | expirationDate | [default to undefined]
 
 ## Example
 

package/docs/InstanceUserCredentialsEntity.md

@@ -6,11 +6,11 @@ InstanceUserCredentialsEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**instanceId** | **string** | instanceId | [optional] [default to undefined]
-**username** | **string** | username | [optional] [default to undefined]
-**password** | **string** | password | [optional] [default to undefined]
-**creationDate** | **string** | creationDate | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**instanceId** | **string** | instanceId | [default to undefined]
+**username** | **string** | username | [default to undefined]
+**password** | **string** | password | [default to undefined]
+**creationDate** | **string** | creationDate | [default to undefined]
 
 ## Example
 

package/docs/ItemDTO.md

@@ -6,8 +6,8 @@ Order Item
 
 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/ItemDiscountEntity.md

@@ -6,13 +6,13 @@ ItemDiscountsEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**itemId** | **number** | itemId | [optional] [default to undefined]
-**priceList** | **string** | priceList | [optional] [default to undefined]
-**discount** | **number** | discount | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**itemId** | **number** | itemId | [default to undefined]
+**priceList** | **string** | priceList | [default to undefined]
+**discount** | **number** | discount | [default to undefined]
 **type** | **string** | type | [optional] [default to undefined]
-**description** | **string** | description | [optional] [default to undefined]
-**priority** | **number** | priority | [optional] [default to undefined]
+**description** | **string** | description | [default to undefined]
+**priority** | **number** | priority | [default to undefined]
 
 ## Example
 

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

@@ -0,0 +1,21 @@
+# ItemResolutionRequestModel
+
+RMA Item Status Request Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resolution** | **number** | RMA Item Resolution | [default to undefined]
+
+## Example
+
+```typescript
+import { ItemResolutionRequestModel } from 'yellowgrid-api-ts';
+
+const instance: ItemResolutionRequestModel = {
+    resolution,
+};
+```
+
+[[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/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

@@ -0,0 +1,21 @@
+# MacAddressRequestModel
+
+RMA Item MAC Address Request Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**macAddress** | **string** | MAC Address | [default to undefined]
+
+## Example
+
+```typescript
+import { MacAddressRequestModel } from 'yellowgrid-api-ts';
+
+const instance: MacAddressRequestModel = {
+    macAddress,
+};
+```
+
+[[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/MiscApi.md

@@ -1,6 +1,6 @@
 # MiscApi
 
-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/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/MyPBXToolsApi.md

@@ -1,6 +1,6 @@
 # MyPBXToolsApi
 
-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/NameRequestModel.md

@@ -0,0 +1,21 @@
+# NameRequestModel
+
+Name Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name | [default to undefined]
+
+## Example
+
+```typescript
+import { NameRequestModel } from 'yellowgrid-api-ts';
+
+const instance: NameRequestModel = {
+    name,
+};
+```
+
+[[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/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

@@ -0,0 +1,21 @@
+# NoteRequestModel
+
+Note Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**note** | **string** | Note | [default to undefined]
+
+## Example
+
+```typescript
+import { NoteRequestModel } from 'yellowgrid-api-ts';
+
+const instance: NoteRequestModel = {
+    note,
+};
+```
+
+[[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/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