yellowgrid-api-ts 3.2.29 → 3.2.30-dev.0

package/docs/Class3CXInstallationsApi.md

@@ -6,7 +6,6 @@ All URIs are relative to *http://api.yellowgrid.local*
 |------------- | ------------- | -------------|
 |[**getGetDetails**](#getgetdetails) | **GET** /tcx/installations/{wizard_id}/details | Get 3CX Installation Details|
 |[**getGetInstallations**](#getgetinstallations) | **GET** /tcx/installations | Get 3CX Installations|
-|[**patchUpdateAutoFailover**](#patchupdateautofailover) | **PATCH** /tcx/installations/{instance_id}/failover/auto | Update 3CX Instance Auto Failover|
 |[**postCreateSshUser**](#postcreatesshuser) | **POST** /tcx/installations/{instance_id}/create/user/root | Create a root user|
 |[**postDeleteInstance**](#postdeleteinstance) | **POST** /tcx/installations/{instance_id}/delete | Delete 3CX Instance|
 |[**postExtendDisk**](#postextenddisk) | **POST** /tcx/installations/{instance_id}/disk/extend | Extend additional disk on 3CX Instance|
@@ -143,63 +142,6 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **patchUpdateAutoFailover**
-> patchUpdateAutoFailover()
-
-Update 3CX Instance Auto Failover
-
-### Example
-
-```typescript
-import {
-    Class3CXInstallationsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new Class3CXInstallationsApi(configuration);
-
-let instanceId: string; //Instance ID (default to undefined)
-let enable: boolean; //Enable (default to undefined)
-
-const { status, data } = await apiInstance.patchUpdateAutoFailover(
-    instanceId,
-    enable
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **instanceId** | [**string**] | Instance ID | defaults to undefined|
-| **enable** | [**boolean**] | Enable | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
 # **postCreateSshUser**
 > RootAccessModel postCreateSshUser()
 

package/docs/EventDTO.md

@@ -0,0 +1,35 @@
+# EventDTO
+
+Service Event DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Service Event Title | [optional] [default to undefined]
+**type** | **number** | Service Event Type | [optional] [default to undefined]
+**service** | **number** | Service Impacted | [optional] [default to undefined]
+**statusName** | **string** | Event Status Description | [optional] [default to undefined]
+**typeName** | **string** | Event Type Description | [optional] [default to undefined]
+**id** | **number** | Service Event ID | [optional] [default to undefined]
+**status** | **number** | Service Event Status | [optional] [default to undefined]
+**updates** | [**Array<EventUpdateDTO>**](EventUpdateDTO.md) | Service Event Updates | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventDTO } from 'yellowgrid-api-ts';
+
+const instance: EventDTO = {
+    title,
+    type,
+    service,
+    statusName,
+    typeName,
+    id,
+    status,
+    updates,
+};
+```
+
+[[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/EventRequestDTO.md

@@ -0,0 +1,25 @@
+# EventRequestDTO
+
+Service Event Request DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Service Event Title | [optional] [default to undefined]
+**type** | **number** | Service Event Type | [optional] [default to undefined]
+**service** | **number** | Service Impacted | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: EventRequestDTO = {
+    title,
+    type,
+    service,
+};
+```
+
+[[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/EventSubscriptionModel.md

@@ -0,0 +1,23 @@
+# EventSubscriptionModel
+
+Service Event Subscribption Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | id | [optional] [default to undefined]
+**email** | **string** | email | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventSubscriptionModel } from 'yellowgrid-api-ts';
+
+const instance: EventSubscriptionModel = {
+    id,
+    email,
+};
+```
+
+[[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/EventUpdateDTO.md

@@ -0,0 +1,27 @@
+# EventUpdateDTO
+
+Service Event Update DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Service Event Update Message | [optional] [default to undefined]
+**type** | **number** | Service Event Update Type | [optional] [default to undefined]
+**typeName** | **string** | Service Event Update Type Description | [optional] [default to undefined]
+**createdAt** | **string** | Date Time | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventUpdateDTO } from 'yellowgrid-api-ts';
+
+const instance: EventUpdateDTO = {
+    message,
+    type,
+    typeName,
+    createdAt,
+};
+```
+
+[[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/EventUpdateEntity.md

@@ -0,0 +1,29 @@
+# EventUpdateEntity
+
+Event Update Entity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**eventId** | **number** | eventId | [optional] [default to undefined]
+**message** | **string** | message | [optional] [default to undefined]
+**type** | **number** | type | [optional] [default to undefined]
+**createdAt** | **string** | createdAt | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventUpdateEntity } from 'yellowgrid-api-ts';
+
+const instance: EventUpdateEntity = {
+    id,
+    eventId,
+    message,
+    type,
+    createdAt,
+};
+```
+
+[[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/EventUpdateRequestDTO.md

@@ -0,0 +1,23 @@
+# EventUpdateRequestDTO
+
+Service Event Update Request DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Service Event Update Message | [optional] [default to undefined]
+**type** | **number** | Service Event Update Type | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventUpdateRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: EventUpdateRequestDTO = {
+    message,
+    type,
+};
+```
+
+[[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/IncidentDTO.md

@@ -0,0 +1,35 @@
+# IncidentDTO
+
+Incident DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Incident Title | [optional] [default to undefined]
+**severity** | **number** | Incident Severity | [optional] [default to undefined]
+**service** | **number** | Service Impacted | [optional] [default to undefined]
+**statusName** | **string** | Incident Status Description | [optional] [default to undefined]
+**severityName** | **string** | Incident Severity Description | [optional] [default to undefined]
+**id** | **number** | Incident ID | [optional] [default to undefined]
+**status** | **number** | Incident Status | [optional] [default to undefined]
+**updates** | [**Array<IncidentUpdateDTO>**](IncidentUpdateDTO.md) | Incident Updates | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IncidentDTO } from 'yellowgrid-api-ts';
+
+const instance: IncidentDTO = {
+    title,
+    severity,
+    service,
+    statusName,
+    severityName,
+    id,
+    status,
+    updates,
+};
+```
+
+[[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/IncidentRequestDTO.md

@@ -0,0 +1,25 @@
+# IncidentRequestDTO
+
+Incident Request DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Incident Title | [optional] [default to undefined]
+**severity** | **number** | Incident Severity | [optional] [default to undefined]
+**service** | **number** | Service Impacted | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IncidentRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: IncidentRequestDTO = {
+    title,
+    severity,
+    service,
+};
+```
+
+[[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/IncidentSubscriptionModel.md

@@ -0,0 +1,23 @@
+# IncidentSubscriptionModel
+
+Incident Subscribption Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | id | [optional] [default to undefined]
+**email** | **string** | email | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IncidentSubscriptionModel } from 'yellowgrid-api-ts';
+
+const instance: IncidentSubscriptionModel = {
+    id,
+    email,
+};
+```
+
+[[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/IncidentUpdateDTO.md

@@ -0,0 +1,27 @@
+# IncidentUpdateDTO
+
+Incident Update DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Incident Update Message | [optional] [default to undefined]
+**type** | **number** | Incident Update Type | [optional] [default to undefined]
+**typeName** | **string** | Incident Update Type Description | [optional] [default to undefined]
+**createdAt** | **string** | Date Time | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IncidentUpdateDTO } from 'yellowgrid-api-ts';
+
+const instance: IncidentUpdateDTO = {
+    message,
+    type,
+    typeName,
+    createdAt,
+};
+```
+
+[[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/IncidentUpdateEntity.md

@@ -0,0 +1,29 @@
+# IncidentUpdateEntity
+
+IncidentUpdatesEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**incidentId** | **number** | incidentId | [optional] [default to undefined]
+**message** | **string** | message | [optional] [default to undefined]
+**type** | **number** | type | [optional] [default to undefined]
+**createdAt** | **string** | createdAt | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IncidentUpdateEntity } from 'yellowgrid-api-ts';
+
+const instance: IncidentUpdateEntity = {
+    id,
+    incidentId,
+    message,
+    type,
+    createdAt,
+};
+```
+
+[[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/IncidentUpdateRequestDTO.md

@@ -0,0 +1,23 @@
+# IncidentUpdateRequestDTO
+
+Incident Update Request DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Incident Update Message | [optional] [default to undefined]
+**type** | **number** | Incident Update Type | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IncidentUpdateRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: IncidentUpdateRequestDTO = {
+    message,
+    type,
+};
+```
+
+[[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/InstanceEntity.md

@@ -26,7 +26,6 @@ Name | Type | Description | Notes
 **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]
 
 ## Example
 
@@ -54,7 +53,6 @@ const instance: InstanceEntity = {
     scriptFinished,
     creationDate,
     status,
-    autoFailover,
 };
 ```
 

package/docs/NumberPortDTO.md

@@ -0,0 +1,51 @@
+# NumberPortDTO
+
+Number Port Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**companyName** | **string** | Company Name | [optional] [default to undefined]
+**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
+**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
+**city** | **string** | City | [optional] [default to undefined]
+**postCode** | **string** | Post Code | [optional] [default to undefined]
+**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
+**tenantId** | **string** | Starter Bundle ID | [optional] [default to undefined]
+**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]
+**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]
+**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NumberPortDTO } from 'yellowgrid-api-ts';
+
+const instance: NumberPortDTO = {
+    companyName,
+    addressLine1,
+    addressLine2,
+    city,
+    postCode,
+    trunkId,
+    tenantId,
+    requestedPortDate,
+    asap,
+    comment,
+    id,
+    customerName,
+    portDate,
+    numberRanges,
+    status,
+    ticketId,
+};
+```
+
+[[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/NumberPortEntity.md

@@ -0,0 +1,47 @@
+# NumberPortEntity
+
+NumberPortsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Number Port ID | [optional] [default to undefined]
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
+**endUser** | **string** | End User | [optional] [default to undefined]
+**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
+**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
+**city** | **string** | City | [optional] [default to undefined]
+**postCode** | **string** | Post Code | [optional] [default to undefined]
+**trunkId** | **string** | Trunk ID | [optional] [default to undefined]
+**tenantId** | **string** | Tenant ID | [optional] [default to undefined]
+**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
+**portDate** | **string** | Port Date | [optional] [default to undefined]
+**comment** | **string** | Comment | [optional] [default to undefined]
+**status** | **number** | Status | [optional] [default to undefined]
+**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NumberPortEntity } from 'yellowgrid-api-ts';
+
+const instance: NumberPortEntity = {
+    id,
+    customerId,
+    endUser,
+    addressLine1,
+    addressLine2,
+    city,
+    postCode,
+    trunkId,
+    tenantId,
+    requestedPortDate,
+    portDate,
+    comment,
+    status,
+    ticketId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)