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

package/docs/Class3CXInstallationsApi.md

@@ -6,6 +6,8 @@ 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|
+|[**postAddDisk**](#postadddisk) | **POST** /tcx/installations/{instance_id}/disk | Add additional disk on 3CX Instance|
 |[**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|
@@ -142,6 +144,120 @@ 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)
+
+# **postAddDisk**
+> postAddDisk()
+
+Add additional disk on 3CX Instance
+
+### 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 gigabytes: number; //Disk Space (GB) (default to undefined)
+
+const { status, data } = await apiInstance.postAddDisk(
+    instanceId,
+    gigabytes
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **instanceId** | [**string**] | Instance ID | defaults to undefined|
+| **gigabytes** | [**number**] | Disk Space (GB) | 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/InstanceEntity.md

@@ -26,6 +26,7 @@ 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
 
@@ -53,6 +54,7 @@ const instance: InstanceEntity = {
     scriptFinished,
     creationDate,
     status,
+    autoFailover,
 };
 ```
 

package/docs/PricingApi.md

@@ -23,7 +23,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new PricingApi(configuration);
 
-let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks'; //Price List Type (default to undefined)
+let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks' | 'CRM Integrations'; //Price List Type (default to undefined)
 let format: 'pdf' | 'json' | 'csv' | 'xml' | 'html'; //Document Format (default to undefined)
 let category: 'Yealink' | 'Mairdi' | 'Jabra' | '3CX' | 'Fanvil' | 'VT' | 'Netgear' | 'Algo' | 'Yealink Headsets' | 'Yealink DECT Handsets' | 'Yealink DECT Headsets' | 'Yealink BT Headsets' | 'Yealink USB Wired Headsets' | 'Yealink Meeting Rooms' | 'Fanvil Phones' | 'Fanvil Headsets' | 'Fanvil Wireless Phones' | 'Fanvil Security Products' | 'Fanvil Accessories' | 'Fanvil Hotel Phones'; //Product Category (optional) (default to undefined)
 let customerId: string; //Customer ID (optional) (default to undefined)
@@ -40,7 +40,7 @@ const { status, data } = await apiInstance.getGetPriceList(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39;>** | Price List Type | defaults to undefined|
+| **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39; | &#39;CRM Integrations&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39; &#124; &#39;CRM Integrations&#39;>** | Price List Type | defaults to undefined|
 | **format** | [**&#39;pdf&#39; | &#39;json&#39; | &#39;csv&#39; | &#39;xml&#39; | &#39;html&#39;**]**Array<&#39;pdf&#39; &#124; &#39;json&#39; &#124; &#39;csv&#39; &#124; &#39;xml&#39; &#124; &#39;html&#39;>** | Document Format | defaults to undefined|
 | **category** | [**&#39;Yealink&#39; | &#39;Mairdi&#39; | &#39;Jabra&#39; | &#39;3CX&#39; | &#39;Fanvil&#39; | &#39;VT&#39; | &#39;Netgear&#39; | &#39;Algo&#39; | &#39;Yealink Headsets&#39; | &#39;Yealink DECT Handsets&#39; | &#39;Yealink DECT Headsets&#39; | &#39;Yealink BT Headsets&#39; | &#39;Yealink USB Wired Headsets&#39; | &#39;Yealink Meeting Rooms&#39; | &#39;Fanvil Phones&#39; | &#39;Fanvil Headsets&#39; | &#39;Fanvil Wireless Phones&#39; | &#39;Fanvil Security Products&#39; | &#39;Fanvil Accessories&#39; | &#39;Fanvil Hotel Phones&#39;**]**Array<&#39;Yealink&#39; &#124; &#39;Mairdi&#39; &#124; &#39;Jabra&#39; &#124; &#39;3CX&#39; &#124; &#39;Fanvil&#39; &#124; &#39;VT&#39; &#124; &#39;Netgear&#39; &#124; &#39;Algo&#39; &#124; &#39;Yealink Headsets&#39; &#124; &#39;Yealink DECT Handsets&#39; &#124; &#39;Yealink DECT Headsets&#39; &#124; &#39;Yealink BT Headsets&#39; &#124; &#39;Yealink USB Wired Headsets&#39; &#124; &#39;Yealink Meeting Rooms&#39; &#124; &#39;Fanvil Phones&#39; &#124; &#39;Fanvil Headsets&#39; &#124; &#39;Fanvil Wireless Phones&#39; &#124; &#39;Fanvil Security Products&#39; &#124; &#39;Fanvil Accessories&#39; &#124; &#39;Fanvil Hotel Phones&#39;>** | Product Category | (optional) defaults to undefined|
 | **customerId** | [**string**] | Customer ID | (optional) defaults to undefined|
@@ -88,7 +88,7 @@ const apiInstance = new PricingApi(configuration);
 
 let email: string; //Email Address (default to undefined)
 let customerId: string; //Customer ID (default to undefined)
-let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks'; //Price List Type (default to undefined)
+let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks' | 'CRM Integrations'; //Price List Type (default to undefined)
 let format: 'pdf' | 'json' | 'csv' | 'xml' | 'html'; //Document Format (default to undefined)
 let category: 'Yealink' | 'Mairdi' | 'Jabra' | '3CX' | 'Fanvil' | 'VT' | 'Netgear' | 'Algo' | 'Yealink Headsets' | 'Yealink DECT Handsets' | 'Yealink DECT Headsets' | 'Yealink BT Headsets' | 'Yealink USB Wired Headsets' | 'Yealink Meeting Rooms' | 'Fanvil Phones' | 'Fanvil Headsets' | 'Fanvil Wireless Phones' | 'Fanvil Security Products' | 'Fanvil Accessories' | 'Fanvil Hotel Phones'; //Product Category (optional) (default to undefined)
 
@@ -107,7 +107,7 @@ const { status, data } = await apiInstance.postSendPriceList(
 |------------- | ------------- | ------------- | -------------|
 | **email** | [**string**] | Email Address | defaults to undefined|
 | **customerId** | [**string**] | Customer ID | defaults to undefined|
-| **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39;>** | Price List Type | defaults to undefined|
+| **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39; | &#39;CRM Integrations&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39; &#124; &#39;CRM Integrations&#39;>** | Price List Type | defaults to undefined|
 | **format** | [**&#39;pdf&#39; | &#39;json&#39; | &#39;csv&#39; | &#39;xml&#39; | &#39;html&#39;**]**Array<&#39;pdf&#39; &#124; &#39;json&#39; &#124; &#39;csv&#39; &#124; &#39;xml&#39; &#124; &#39;html&#39;>** | Document Format | defaults to undefined|
 | **category** | [**&#39;Yealink&#39; | &#39;Mairdi&#39; | &#39;Jabra&#39; | &#39;3CX&#39; | &#39;Fanvil&#39; | &#39;VT&#39; | &#39;Netgear&#39; | &#39;Algo&#39; | &#39;Yealink Headsets&#39; | &#39;Yealink DECT Handsets&#39; | &#39;Yealink DECT Headsets&#39; | &#39;Yealink BT Headsets&#39; | &#39;Yealink USB Wired Headsets&#39; | &#39;Yealink Meeting Rooms&#39; | &#39;Fanvil Phones&#39; | &#39;Fanvil Headsets&#39; | &#39;Fanvil Wireless Phones&#39; | &#39;Fanvil Security Products&#39; | &#39;Fanvil Accessories&#39; | &#39;Fanvil Hotel Phones&#39;**]**Array<&#39;Yealink&#39; &#124; &#39;Mairdi&#39; &#124; &#39;Jabra&#39; &#124; &#39;3CX&#39; &#124; &#39;Fanvil&#39; &#124; &#39;VT&#39; &#124; &#39;Netgear&#39; &#124; &#39;Algo&#39; &#124; &#39;Yealink Headsets&#39; &#124; &#39;Yealink DECT Handsets&#39; &#124; &#39;Yealink DECT Headsets&#39; &#124; &#39;Yealink BT Headsets&#39; &#124; &#39;Yealink USB Wired Headsets&#39; &#124; &#39;Yealink Meeting Rooms&#39; &#124; &#39;Fanvil Phones&#39; &#124; &#39;Fanvil Headsets&#39; &#124; &#39;Fanvil Wireless Phones&#39; &#124; &#39;Fanvil Security Products&#39; &#124; &#39;Fanvil Accessories&#39; &#124; &#39;Fanvil Hotel Phones&#39;>** | Product Category | (optional) defaults to undefined|
 

package/docs/TcxInstallationModel.md

@@ -34,6 +34,7 @@ Name | Type | Description | Notes
 **version** | **string** | 3CX Software Version | [optional] [default to undefined]
 **disk** | **number** | Recordings Disk Size | [optional] [default to undefined]
 **flavour** | **string** | Instance Spec | [optional] [default to undefined]
+**autoFailover** | **boolean** | Auto Failover | [optional] [default to undefined]
 
 ## Example
 
@@ -69,6 +70,7 @@ const instance: TcxInstallationModel = {
     version,
     disk,
     flavour,
+    autoFailover,
 };
 ```