yellowgrid-api-ts 3.2.27 → 3.2.28

package/README.md

@@ -109,6 +109,7 @@ Class | Method | HTTP request | Description
 *Class3CXInstallationWizardApi* | [**postUploadBackup**](docs/Class3CXInstallationWizardApi.md#postuploadbackup) | **POST** /tcx/wizards/backup | 
 *Class3CXInstallationsApi* | [**getGetDetails**](docs/Class3CXInstallationsApi.md#getgetdetails) | **GET** /tcx/installations/{wizard_id}/details | Get 3CX Installation Details
 *Class3CXInstallationsApi* | [**getGetInstallations**](docs/Class3CXInstallationsApi.md#getgetinstallations) | **GET** /tcx/installations | Get 3CX Installations
+*Class3CXInstallationsApi* | [**patchUpdateAutoFailover**](docs/Class3CXInstallationsApi.md#patchupdateautofailover) | **PATCH** /tcx/installations/{instance_id}/failover/auto | Update 3CX Instance Auto Failover
 *Class3CXInstallationsApi* | [**postCreateSshUser**](docs/Class3CXInstallationsApi.md#postcreatesshuser) | **POST** /tcx/installations/{instance_id}/create/user/root | Create a root user
 *Class3CXInstallationsApi* | [**postDeleteInstance**](docs/Class3CXInstallationsApi.md#postdeleteinstance) | **POST** /tcx/installations/{instance_id}/delete | Delete 3CX Instance
 *Class3CXInstallationsApi* | [**postExtendDisk**](docs/Class3CXInstallationsApi.md#postextenddisk) | **POST** /tcx/installations/{instance_id}/disk/extend | Extend additional disk on 3CX Instance

package/api.ts

@@ -2841,6 +2841,12 @@ export interface InstanceEntity {
      * @memberof InstanceEntity
      */
     'status'?: string;
+    /**
+     * autoFailover
+     * @type {number}
+     * @memberof InstanceEntity
+     */
+    'autoFailover'?: number;
 }
 /**
  * InstanceFailoverEntity
@@ -7821,6 +7827,12 @@ export interface TcxInstallationModel {
      * @memberof TcxInstallationModel
      */
     'flavour'?: string | null;
+    /**
+     * Auto Failover
+     * @type {boolean}
+     * @memberof TcxInstallationModel
+     */
+    'autoFailover'?: boolean;
 }
 /**
  * 3CX Installations
@@ -13881,6 +13893,47 @@ export const Class3CXInstallationsApiAxiosParamCreator = function (configuration
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Update 3CX Instance Auto Failover
+         * @summary Update 3CX Instance Auto Failover
+         * @param {string} instanceId Instance ID
+         * @param {boolean} enable Enable
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchUpdateAutoFailover: async (instanceId: string, enable: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'instanceId' is not null or undefined
+            assertParamExists('patchUpdateAutoFailover', 'instanceId', instanceId)
+            // verify required parameter 'enable' is not null or undefined
+            assertParamExists('patchUpdateAutoFailover', 'enable', enable)
+            const localVarPath = `/tcx/installations/{instance_id}/failover/auto`
+                .replace(`{${"instance_id"}}`, encodeURIComponent(String(instanceId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (enable !== undefined) {
+                localVarQueryParameter['enable'] = enable;
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -14297,6 +14350,20 @@ export const Class3CXInstallationsApiFp = function(configuration?: Configuration
             const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.getGetInstallations']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Update 3CX Instance Auto Failover
+         * @summary Update 3CX Instance Auto Failover
+         * @param {string} instanceId Instance ID
+         * @param {boolean} enable Enable
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async patchUpdateAutoFailover(instanceId: string, enable: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.patchUpdateAutoFailover(instanceId, enable, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.patchUpdateAutoFailover']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Create a root user
          * @summary Create a root user
@@ -14459,6 +14526,17 @@ export const Class3CXInstallationsApiFactory = function (configuration?: Configu
         getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<TcxInstallationsModel> {
             return localVarFp.getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Update 3CX Instance Auto Failover
+         * @summary Update 3CX Instance Auto Failover
+         * @param {string} instanceId Instance ID
+         * @param {boolean} enable Enable
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchUpdateAutoFailover(instanceId: string, enable: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.patchUpdateAutoFailover(instanceId, enable, options).then((request) => request(axios, basePath));
+        },
         /**
          * Create a root user
          * @summary Create a root user
@@ -14598,6 +14676,19 @@ export class Class3CXInstallationsApi extends BaseAPI {
         return Class3CXInstallationsApiFp(this.configuration).getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Update 3CX Instance Auto Failover
+     * @summary Update 3CX Instance Auto Failover
+     * @param {string} instanceId Instance ID
+     * @param {boolean} enable Enable
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Class3CXInstallationsApi
+     */
+    public patchUpdateAutoFailover(instanceId: string, enable: boolean, options?: RawAxiosRequestConfig) {
+        return Class3CXInstallationsApiFp(this.configuration).patchUpdateAutoFailover(instanceId, enable, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Create a root user
      * @summary Create a root user

package/dist/api.d.ts

@@ -2819,6 +2819,12 @@ export interface InstanceEntity {
      * @memberof InstanceEntity
      */
     'status'?: string;
+    /**
+     * autoFailover
+     * @type {number}
+     * @memberof InstanceEntity
+     */
+    'autoFailover'?: number;
 }
 /**
  * InstanceFailoverEntity
@@ -7763,6 +7769,12 @@ export interface TcxInstallationModel {
      * @memberof TcxInstallationModel
      */
     'flavour'?: string | null;
+    /**
+     * Auto Failover
+     * @type {boolean}
+     * @memberof TcxInstallationModel
+     */
+    'autoFailover'?: boolean;
 }
 /**
  * 3CX Installations
@@ -11596,6 +11608,15 @@ export declare const Class3CXInstallationsApiAxiosParamCreator: (configuration?:
      * @throws {RequiredError}
      */
     getGetInstallations: (pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update 3CX Instance Auto Failover
+     * @summary Update 3CX Instance Auto Failover
+     * @param {string} instanceId Instance ID
+     * @param {boolean} enable Enable
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateAutoFailover: (instanceId: string, enable: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create a root user
      * @summary Create a root user
@@ -11705,6 +11726,15 @@ export declare const Class3CXInstallationsApiFp: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxInstallationsModel>>;
+    /**
+     * Update 3CX Instance Auto Failover
+     * @summary Update 3CX Instance Auto Failover
+     * @param {string} instanceId Instance ID
+     * @param {boolean} enable Enable
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateAutoFailover(instanceId: string, enable: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Create a root user
      * @summary Create a root user
@@ -11814,6 +11844,15 @@ export declare const Class3CXInstallationsApiFactory: (configuration?: Configura
      * @throws {RequiredError}
      */
     getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<TcxInstallationsModel>;
+    /**
+     * Update 3CX Instance Auto Failover
+     * @summary Update 3CX Instance Auto Failover
+     * @param {string} instanceId Instance ID
+     * @param {boolean} enable Enable
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateAutoFailover(instanceId: string, enable: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Create a root user
      * @summary Create a root user
@@ -11927,6 +11966,16 @@ export declare class Class3CXInstallationsApi extends BaseAPI {
      * @memberof Class3CXInstallationsApi
      */
     getGetInstallations(pageSize?: number, page?: number, customerId?: string, search?: string, status?: GetGetInstallationsStatusEnum, hosting?: GetGetInstallationsHostingEnum, installType?: GetGetInstallationsInstallTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxInstallationsModel, any, {}>>;
+    /**
+     * Update 3CX Instance Auto Failover
+     * @summary Update 3CX Instance Auto Failover
+     * @param {string} instanceId Instance ID
+     * @param {boolean} enable Enable
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Class3CXInstallationsApi
+     */
+    patchUpdateAutoFailover(instanceId: string, enable: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      * Create a root user
      * @summary Create a root user

package/dist/api.js

@@ -5194,6 +5194,49 @@ var Class3CXInstallationsApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Update 3CX Instance Auto Failover
+         * @summary Update 3CX Instance Auto Failover
+         * @param {string} instanceId Instance ID
+         * @param {boolean} enable Enable
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchUpdateAutoFailover: function (instanceId_1, enable_1) {
+            var args_1 = [];
+            for (var _i = 2; _i < arguments.length; _i++) {
+                args_1[_i - 2] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([instanceId_1, enable_1], args_1, true), void 0, function (instanceId, enable, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'instanceId' is not null or undefined
+                    (0, common_1.assertParamExists)('patchUpdateAutoFailover', 'instanceId', instanceId);
+                    // verify required parameter 'enable' is not null or undefined
+                    (0, common_1.assertParamExists)('patchUpdateAutoFailover', 'enable', enable);
+                    localVarPath = "/tcx/installations/{instance_id}/failover/auto"
+                        .replace("{".concat("instance_id", "}"), encodeURIComponent(String(instanceId)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    if (enable !== undefined) {
+                        localVarQueryParameter['enable'] = enable;
+                    }
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Create a root user
          * @summary Create a root user
@@ -5639,6 +5682,30 @@ var Class3CXInstallationsApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Update 3CX Instance Auto Failover
+         * @summary Update 3CX Instance Auto Failover
+         * @param {string} instanceId Instance ID
+         * @param {boolean} enable Enable
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchUpdateAutoFailover: function (instanceId, enable, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                var _a, _b, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchUpdateAutoFailover(instanceId, enable, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXInstallationsApi.patchUpdateAutoFailover']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Create a root user
          * @summary Create a root user
@@ -5891,6 +5958,17 @@ var Class3CXInstallationsApiFactory = function (configuration, basePath, axios)
         getGetInstallations: function (pageSize, page, customerId, search, status, hosting, installType, options) {
             return localVarFp.getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Update 3CX Instance Auto Failover
+         * @summary Update 3CX Instance Auto Failover
+         * @param {string} instanceId Instance ID
+         * @param {boolean} enable Enable
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchUpdateAutoFailover: function (instanceId, enable, options) {
+            return localVarFp.patchUpdateAutoFailover(instanceId, enable, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Create a root user
          * @summary Create a root user
@@ -6034,6 +6112,19 @@ var Class3CXInstallationsApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.Class3CXInstallationsApiFp)(this.configuration).getGetInstallations(pageSize, page, customerId, search, status, hosting, installType, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Update 3CX Instance Auto Failover
+     * @summary Update 3CX Instance Auto Failover
+     * @param {string} instanceId Instance ID
+     * @param {boolean} enable Enable
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Class3CXInstallationsApi
+     */
+    Class3CXInstallationsApi.prototype.patchUpdateAutoFailover = function (instanceId, enable, options) {
+        var _this = this;
+        return (0, exports.Class3CXInstallationsApiFp)(this.configuration).patchUpdateAutoFailover(instanceId, enable, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Create a root user
      * @summary Create a root user

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()
 

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.27",
+  "version": "3.2.28",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {