yellowgrid-api-ts 3.2.88 → 3.2.89

package/.openapi-generator/FILES

@@ -239,6 +239,7 @@ docs/TcxRemoteStorageModel.md
 docs/TcxSbcDTO.md
 docs/TcxSbcEntity.md
 docs/TcxSbcModel.md
+docs/TcxSbcResponseDTO.md
 docs/TcxSetupEntity.md
 docs/TcxSetupsModel.md
 docs/TcxSipTrunksEntity.md

package/README.md

@@ -116,6 +116,7 @@ Class | Method | HTTP request | Description
 *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
 *Class3CXInstallationsApi* | [**postFailoverInstance**](docs/Class3CXInstallationsApi.md#postfailoverinstance) | **POST** /tcx/installations/{instance_id}/failover | Failover 3CX Instance
+*Class3CXInstallationsApi* | [**postInstallTcxSbc**](docs/Class3CXInstallationsApi.md#postinstalltcxsbc) | **POST** /tcx/installations/sbcs/{sbc_id}/install | Install 3CX SBC
 *Class3CXInstallationsApi* | [**postRebootInstance**](docs/Class3CXInstallationsApi.md#postrebootinstance) | **POST** /tcx/installations/{instance_id}/reboot | Reboot 3CX Instance
 *Class3CXInstallationsApi* | [**postResizeInstance**](docs/Class3CXInstallationsApi.md#postresizeinstance) | **POST** /tcx/installations/{instance_id}/resize | Resize 3CX Instance
 *Class3CXInstallationsApi* | [**postSuspendInstance**](docs/Class3CXInstallationsApi.md#postsuspendinstance) | **POST** /tcx/installations/{instance_id}/suspend | Suspend 3CX Instance
@@ -486,6 +487,7 @@ Class | Method | HTTP request | Description
  - [TcxSbcDTO](docs/TcxSbcDTO.md)
  - [TcxSbcEntity](docs/TcxSbcEntity.md)
  - [TcxSbcModel](docs/TcxSbcModel.md)
+ - [TcxSbcResponseDTO](docs/TcxSbcResponseDTO.md)
  - [TcxSetupEntity](docs/TcxSetupEntity.md)
  - [TcxSetupsModel](docs/TcxSetupsModel.md)
  - [TcxSipTrunksEntity](docs/TcxSipTrunksEntity.md)

package/api.ts

@@ -7107,6 +7107,10 @@ export interface TcxSbcDTO {
      * 3CX SBC Key
      */
     'tcxKey'?: string;
+    /**
+     * 3CX SBC Configured
+     */
+    'configured'?: boolean;
 }
 /**
  * 3CX Wizard SBC
@@ -7246,6 +7250,19 @@ export interface TcxSbcModel {
      */
     'technicalContact'?: string;
 }
+/**
+ * 3CX SBC Response
+ */
+export interface TcxSbcResponseDTO {
+    /**
+     * Status
+     */
+    'status'?: string;
+    /**
+     * Message
+     */
+    'message'?: string;
+}
 /**
  * 3CX Wizard Setup Config
  */
@@ -12202,6 +12219,40 @@ 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,
+            };
+        },
+        /**
+         * Install 3CX SBC
+         * @summary Install 3CX SBC
+         * @param {number} sbcId SBC ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postInstallTcxSbc: async (sbcId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'sbcId' is not null or undefined
+            assertParamExists('postInstallTcxSbc', 'sbcId', sbcId)
+            const localVarPath = `/tcx/installations/sbcs/{sbc_id}/install`
+                .replace(`{${"sbc_id"}}`, encodeURIComponent(String(sbcId)));
+            // 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: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -12540,6 +12591,19 @@ export const Class3CXInstallationsApiFp = function(configuration?: Configuration
             const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.postFailoverInstance']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Install 3CX SBC
+         * @summary Install 3CX SBC
+         * @param {number} sbcId SBC ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postInstallTcxSbc(sbcId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxSbcResponseDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postInstallTcxSbc(sbcId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['Class3CXInstallationsApi.postInstallTcxSbc']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Reboot 3CX Instance
          * @summary Reboot 3CX Instance
@@ -12722,6 +12786,16 @@ export const Class3CXInstallationsApiFactory = function (configuration?: Configu
         postFailoverInstance(instanceId: string, type: PostFailoverInstanceTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<void> {
             return localVarFp.postFailoverInstance(instanceId, type, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Install 3CX SBC
+         * @summary Install 3CX SBC
+         * @param {number} sbcId SBC ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postInstallTcxSbc(sbcId: number, options?: RawAxiosRequestConfig): AxiosPromise<TcxSbcResponseDTO> {
+            return localVarFp.postInstallTcxSbc(sbcId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Reboot 3CX Instance
          * @summary Reboot 3CX Instance
@@ -12896,6 +12970,17 @@ export class Class3CXInstallationsApi extends BaseAPI {
         return Class3CXInstallationsApiFp(this.configuration).postFailoverInstance(instanceId, type, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Install 3CX SBC
+     * @summary Install 3CX SBC
+     * @param {number} sbcId SBC ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public postInstallTcxSbc(sbcId: number, options?: RawAxiosRequestConfig) {
+        return Class3CXInstallationsApiFp(this.configuration).postInstallTcxSbc(sbcId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Reboot 3CX Instance
      * @summary Reboot 3CX Instance

package/dist/api.d.ts

@@ -7019,6 +7019,10 @@ export interface TcxSbcDTO {
      * 3CX SBC Key
      */
     'tcxKey'?: string;
+    /**
+     * 3CX SBC Configured
+     */
+    'configured'?: boolean;
 }
 /**
  * 3CX Wizard SBC
@@ -7158,6 +7162,19 @@ export interface TcxSbcModel {
      */
     'technicalContact'?: string;
 }
+/**
+ * 3CX SBC Response
+ */
+export interface TcxSbcResponseDTO {
+    /**
+     * Status
+     */
+    'status'?: string;
+    /**
+     * Message
+     */
+    'message'?: string;
+}
 /**
  * 3CX Wizard Setup Config
  */
@@ -9706,6 +9723,14 @@ export declare const Class3CXInstallationsApiAxiosParamCreator: (configuration?:
      * @throws {RequiredError}
      */
     postFailoverInstance: (instanceId: string, type: PostFailoverInstanceTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Install 3CX SBC
+     * @summary Install 3CX SBC
+     * @param {number} sbcId SBC ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postInstallTcxSbc: (sbcId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Reboot 3CX Instance
      * @summary Reboot 3CX Instance
@@ -9841,6 +9866,14 @@ export declare const Class3CXInstallationsApiFp: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     postFailoverInstance(instanceId: string, type: PostFailoverInstanceTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Install 3CX SBC
+     * @summary Install 3CX SBC
+     * @param {number} sbcId SBC ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postInstallTcxSbc(sbcId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxSbcResponseDTO>>;
     /**
      * Reboot 3CX Instance
      * @summary Reboot 3CX Instance
@@ -9976,6 +10009,14 @@ export declare const Class3CXInstallationsApiFactory: (configuration?: Configura
      * @throws {RequiredError}
      */
     postFailoverInstance(instanceId: string, type: PostFailoverInstanceTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Install 3CX SBC
+     * @summary Install 3CX SBC
+     * @param {number} sbcId SBC ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postInstallTcxSbc(sbcId: number, options?: RawAxiosRequestConfig): AxiosPromise<TcxSbcResponseDTO>;
     /**
      * Reboot 3CX Instance
      * @summary Reboot 3CX Instance
@@ -10111,6 +10152,14 @@ export declare class Class3CXInstallationsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     postFailoverInstance(instanceId: string, type: PostFailoverInstanceTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Install 3CX SBC
+     * @summary Install 3CX SBC
+     * @param {number} sbcId SBC ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postInstallTcxSbc(sbcId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxSbcResponseDTO, any, {}>>;
     /**
      * Reboot 3CX Instance
      * @summary Reboot 3CX Instance

package/dist/api.js

@@ -5593,6 +5593,44 @@ var Class3CXInstallationsApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Install 3CX SBC
+         * @summary Install 3CX SBC
+         * @param {number} sbcId SBC ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postInstallTcxSbc: function (sbcId_1) {
+            var args_1 = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([sbcId_1], args_1, true), void 0, function (sbcId, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'sbcId' is not null or undefined
+                    (0, common_1.assertParamExists)('postInstallTcxSbc', 'sbcId', sbcId);
+                    localVarPath = "/tcx/installations/sbcs/{sbc_id}/install"
+                        .replace("{".concat("sbc_id", "}"), encodeURIComponent(String(sbcId)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    localVarHeaderParameter['Accept'] = 'application/json';
+                    (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,
+                        }];
+                });
+            });
+        },
         /**
          * Reboot 3CX Instance
          * @summary Reboot 3CX Instance
@@ -6028,6 +6066,29 @@ var Class3CXInstallationsApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Install 3CX SBC
+         * @summary Install 3CX SBC
+         * @param {number} sbcId SBC ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postInstallTcxSbc: function (sbcId, 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.postInstallTcxSbc(sbcId, 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.postInstallTcxSbc']) === 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); }];
+                    }
+                });
+            });
+        },
         /**
          * Reboot 3CX Instance
          * @summary Reboot 3CX Instance
@@ -6260,6 +6321,16 @@ var Class3CXInstallationsApiFactory = function (configuration, basePath, axios)
         postFailoverInstance: function (instanceId, type, options) {
             return localVarFp.postFailoverInstance(instanceId, type, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Install 3CX SBC
+         * @summary Install 3CX SBC
+         * @param {number} sbcId SBC ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postInstallTcxSbc: function (sbcId, options) {
+            return localVarFp.postInstallTcxSbc(sbcId, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Reboot 3CX Instance
          * @summary Reboot 3CX Instance
@@ -6438,6 +6509,17 @@ var Class3CXInstallationsApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.Class3CXInstallationsApiFp)(this.configuration).postFailoverInstance(instanceId, type, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Install 3CX SBC
+     * @summary Install 3CX SBC
+     * @param {number} sbcId SBC ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    Class3CXInstallationsApi.prototype.postInstallTcxSbc = function (sbcId, options) {
+        var _this = this;
+        return (0, exports.Class3CXInstallationsApiFp)(this.configuration).postInstallTcxSbc(sbcId, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Reboot 3CX Instance
      * @summary Reboot 3CX Instance

package/docs/Class3CXInstallationsApi.md

@@ -13,6 +13,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**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|
 |[**postFailoverInstance**](#postfailoverinstance) | **POST** /tcx/installations/{instance_id}/failover | Failover 3CX Instance|
+|[**postInstallTcxSbc**](#postinstalltcxsbc) | **POST** /tcx/installations/sbcs/{sbc_id}/install | Install 3CX SBC|
 |[**postRebootInstance**](#postrebootinstance) | **POST** /tcx/installations/{instance_id}/reboot | Reboot 3CX Instance|
 |[**postResizeInstance**](#postresizeinstance) | **POST** /tcx/installations/{instance_id}/resize | Resize 3CX Instance|
 |[**postSuspendInstance**](#postsuspendinstance) | **POST** /tcx/installations/{instance_id}/suspend | Suspend 3CX Instance|
@@ -544,6 +545,60 @@ 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)
 
+# **postInstallTcxSbc**
+> TcxSbcResponseDTO postInstallTcxSbc()
+
+Install 3CX SBC
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationsApi(configuration);
+
+let sbcId: number; //SBC ID (default to undefined)
+
+const { status, data } = await apiInstance.postInstallTcxSbc(
+    sbcId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sbcId** | [**number**] | SBC ID | defaults to undefined|
+
+
+### Return type
+
+**TcxSbcResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX SBC Install 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)
+
 # **postRebootInstance**
 > postRebootInstance()
 

package/docs/TcxSbcDTO.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **dns** | **string** | DNS | [optional] [default to undefined]
 **tcxUrl** | **string** | 3CX URL | [optional] [default to undefined]
 **tcxKey** | **string** | 3CX SBC Key | [optional] [default to undefined]
+**configured** | **boolean** | 3CX SBC Configured | [optional] [default to undefined]
 
 ## Example
 
@@ -27,6 +28,7 @@ const instance: TcxSbcDTO = {
     dns,
     tcxUrl,
     tcxKey,
+    configured,
 };
 ```
 

package/docs/TcxSbcResponseDTO.md

@@ -0,0 +1,23 @@
+# TcxSbcResponseDTO
+
+3CX SBC Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** | Status | [optional] [default to undefined]
+**message** | **string** | Message | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxSbcResponseDTO } from 'yellowgrid-api-ts';
+
+const instance: TcxSbcResponseDTO = {
+    status,
+    message,
+};
+```
+
+[[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/package.json

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