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

package/docs/Class3CXInstallationsApi.md

@@ -6,6 +6,7 @@ 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|
@@ -142,6 +143,63 @@ 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()
 
@@ -441,7 +499,7 @@ const configuration = new Configuration();
 const apiInstance = new Class3CXInstallationsApi(configuration);
 
 let instanceId: string; //Instance ID (default to undefined)
-let size: 'd2-4' | 'd2-8' | 'b2-30'; //Instance Spec (default to undefined)
+let size: 'd2-4' | 'd2-8' | 'b2-30' | 's-2vcpu-4gb' | 's-4vcpu-8gb'; //Instance Spec (default to undefined)
 let schedule: string; //Scheduled Task (Date & Time) (optional) (default to undefined)
 
 const { status, data } = await apiInstance.postResizeInstance(
@@ -456,7 +514,7 @@ const { status, data } = await apiInstance.postResizeInstance(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **instanceId** | [**string**] | Instance ID | defaults to undefined|
-| **size** | [**&#39;d2-4&#39; | &#39;d2-8&#39; | &#39;b2-30&#39;**]**Array<&#39;d2-4&#39; &#124; &#39;d2-8&#39; &#124; &#39;b2-30&#39;>** | Instance Spec | defaults to undefined|
+| **size** | [**&#39;d2-4&#39; | &#39;d2-8&#39; | &#39;b2-30&#39; | &#39;s-2vcpu-4gb&#39; | &#39;s-4vcpu-8gb&#39;**]**Array<&#39;d2-4&#39; &#124; &#39;d2-8&#39; &#124; &#39;b2-30&#39; &#124; &#39;s-2vcpu-4gb&#39; &#124; &#39;s-4vcpu-8gb&#39;>** | Instance Spec | defaults to undefined|
 | **schedule** | [**string**] | Scheduled Task (Date &amp; Time) | (optional) defaults to undefined|
 
 

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/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,
 };
 ```
 

package/index.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Yellowgrid
- * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ * Welcome to the Yellowgrid API documentation.    This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.    ## Key Features:   - **Accounts**: View and manage account details, contacts, client credentials, and verification.   - **Provisioning**: Automate setup and configuration of devices and groups.   - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.   - **Messaging**: Send SMS messages securely via the messaging gateway.   - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.    ## Authentication:   The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.          ## Base URL:   `http://api.yellowgrid.local`               For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  * 

package/openapitools.json

@@ -2,6 +2,6 @@
   "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "7.17.0"
+    "version": "7.14.0"
   }
 }