yellowgrid-api-ts 3.0.79

package/docs/Class3CXInstallationWizardApi.md

@@ -0,0 +1,1355 @@
+# Class3CXInstallationWizardApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteAddExtensions**](#deleteaddextensions) | **DELETE** /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions|
+|[**deleteAddNumbers**](#deleteaddnumbers) | **DELETE** /tcx/wizards/numbers | Delete 3CX Installation Wizard Numbers|
+|[**deleteAddPhones**](#deleteaddphones) | **DELETE** /tcx/wizards/phones | Delete 3CX Installation Wizard Phone|
+|[**deleteAddSbcs**](#deleteaddsbcs) | **DELETE** /tcx/wizards/sbcs | Delete 3CX Installation Wizard SBCs|
+|[**deleteGetWizard**](#deletegetwizard) | **DELETE** /tcx/wizards | Delete 3CX Installation Wizard|
+|[**getAddPhones**](#getaddphones) | **GET** /tcx/wizards/phones | Get phones on linked order and MAC addresses|
+|[**getGetHostingPrice**](#getgethostingprice) | **GET** /tcx/wizards/price | Get Hosting Price|
+|[**getGetInstallStatus**](#getgetinstallstatus) | **GET** /tcx/wizard/build/status | Get 3CX Instance Install Status|
+|[**getGetInstanceInstallStatus**](#getgetinstanceinstallstatus) | **GET** /tcx/wizards/instances/build/status | Get 3CX Instance Install Status|
+|[**getGetPbxIpAddress**](#getgetpbxipaddress) | **GET** /tcx/wizards/instances/ip | Get PBX IP Address|
+|[**getGetWizard**](#getgetwizard) | **GET** /tcx/wizards | Get 3CX Installation Wizard|
+|[**patchAddExtensions**](#patchaddextensions) | **PATCH** /tcx/wizards/extensions | Update 3CX Installation Wizard Extensions|
+|[**patchAddNumbers**](#patchaddnumbers) | **PATCH** /tcx/wizards/numbers | Update 3CX Installation Wizard Numbers|
+|[**patchAddPhones**](#patchaddphones) | **PATCH** /tcx/wizards/phones | Update 3CX Installation Wizard Phones|
+|[**patchAddSbcs**](#patchaddsbcs) | **PATCH** /tcx/wizards/sbcs | Update 3CX Installation Wizard SBCs|
+|[**patchGetWizard**](#patchgetwizard) | **PATCH** /tcx/wizards | Update 3CX Installation Wizard|
+|[**postAddExtensions**](#postaddextensions) | **POST** /tcx/wizards/extensions | Add Extensions To 3CX Installation Wizard|
+|[**postAddNumbers**](#postaddnumbers) | **POST** /tcx/wizards/numbers | Add Numbers To 3CX Installation Wizard|
+|[**postAddPhones**](#postaddphones) | **POST** /tcx/wizards/phones | Add Phones To 3CX Installation Wizard|
+|[**postAddSbcs**](#postaddsbcs) | **POST** /tcx/wizards/sbcs | Add SBCs To 3CX Installation Wizard|
+|[**postBuildInstance**](#postbuildinstance) | **POST** /tcx/wizards/instances/build | Build Instance From 3CX Installation Wizard|
+|[**postBuildInstanceFromWizard**](#postbuildinstancefromwizard) | **POST** /tcx/wizard/build | Start 3CX Installation Build Process|
+|[**postCreateInstance**](#postcreateinstance) | **POST** /tcx/wizards/instances/create | Create Instance From 3CX Installation Wizard|
+|[**postCreateInstanceFromWizard**](#postcreateinstancefromwizard) | **POST** /tcx/wizard/create | Create Hosted Instance From 3CX Installation Wizard Config|
+|[**postUploadBackup**](#postuploadbackup) | **POST** /tcx/wizards/backup | |
+
+# **deleteAddExtensions**
+> deleteAddExtensions()
+
+Delete 3CX Installation Wizard Extensions
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxExtsEntity: Array<TcxExtsEntity>; //3CX Wizard Extensions (optional)
+
+const { status, data } = await apiInstance.deleteAddExtensions(
+    tcxExtsEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxExtsEntity** | **Array<TcxExtsEntity>**| 3CX Wizard Extensions | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **deleteAddNumbers**
+> deleteAddNumbers()
+
+Delete 3CX Installation Wizard Numbers
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxNumbersEntity: Array<TcxNumbersEntity>; //3CX Wizard Numbers (optional)
+
+const { status, data } = await apiInstance.deleteAddNumbers(
+    tcxNumbersEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxNumbersEntity** | **Array<TcxNumbersEntity>**| 3CX Wizard Numbers | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **deleteAddPhones**
+> deleteAddPhones()
+
+Delete 3CX Installation Wizard Phones
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxPhonesEntity: Array<TcxPhonesEntity>; //3CX Wizard Phones (optional)
+
+const { status, data } = await apiInstance.deleteAddPhones(
+    tcxPhonesEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxPhonesEntity** | **Array<TcxPhonesEntity>**| 3CX Wizard Phones | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **deleteAddSbcs**
+> deleteAddSbcs()
+
+Delete 3CX Installation Wizard SBCs
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxSbcEntity: Array<TcxSbcEntity>; //3CX Wizard SBCs (optional)
+
+const { status, data } = await apiInstance.deleteAddSbcs(
+    tcxSbcEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxSbcEntity** | **Array<TcxSbcEntity>**| 3CX Wizard SBCs | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **deleteGetWizard**
+> deleteGetWizard()
+
+Delete 3CX Installation Wizard
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+const { status, data } = await apiInstance.deleteGetWizard();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### 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)
+
+# **getAddPhones**
+> Array<ScannedItemModel> getAddPhones()
+
+Get phones on linked order and MAC addresses
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+const { status, data } = await apiInstance.getAddPhones();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ScannedItemModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Phone Details |  -  |
+|**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)
+
+# **getGetHostingPrice**
+> number getGetHostingPrice()
+
+Get Hosting Price
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+const { status, data } = await apiInstance.getGetHostingPrice();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**number**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Hosting Price |  -  |
+|**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)
+
+# **getGetInstallStatus**
+> HostingChangeResponseModel getGetInstallStatus()
+
+Get 3CX Instance Install Status
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let id: number; //3CX Installation Wizard ID (default to undefined)
+let u: string; //3CX Installation Wizard Unique ID (default to undefined)
+let c: number; //Customer ID (optional) (default to undefined)
+let p: string; //Customer Authentication key (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetInstallStatus(
+    id,
+    u,
+    c,
+    p
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | 3CX Installation Wizard ID | defaults to undefined|
+| **u** | [**string**] | 3CX Installation Wizard Unique ID | defaults to undefined|
+| **c** | [**number**] | Customer ID | (optional) defaults to undefined|
+| **p** | [**string**] | Customer Authentication key | (optional) defaults to undefined|
+
+
+### Return type
+
+**HostingChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Installation Change Model |  -  |
+|**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)
+
+# **getGetInstanceInstallStatus**
+> HostingChangeResponseModel getGetInstanceInstallStatus()
+
+Get 3CX Instance Install Status
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+const { status, data } = await apiInstance.getGetInstanceInstallStatus();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**HostingChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Installation Change Model |  -  |
+|**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)
+
+# **getGetPbxIpAddress**
+> string getGetPbxIpAddress()
+
+Get PBX IP Address
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+const { status, data } = await apiInstance.getGetPbxIpAddress();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | string |  -  |
+|**202** | Resource Not Ready |  -  |
+|**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)
+
+# **getGetWizard**
+> TcxWizardModel getGetWizard()
+
+Get 3CX Installation Wizard
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+const { status, data } = await apiInstance.getGetWizard();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**TcxWizardModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Wizard |  -  |
+|**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)
+
+# **patchAddExtensions**
+> Array<TcxExtsEntity> patchAddExtensions()
+
+Update 3CX Installation Wizard Extensions
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxExtsEntity: Array<TcxExtsEntity>; //3CX Wizard Extensions (optional)
+
+const { status, data } = await apiInstance.patchAddExtensions(
+    tcxExtsEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxExtsEntity** | **Array<TcxExtsEntity>**| 3CX Wizard Extensions | |
+
+
+### Return type
+
+**Array<TcxExtsEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Wizard Extensions |  -  |
+|**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)
+
+# **patchAddNumbers**
+> Array<TcxNumbersEntity> patchAddNumbers()
+
+Update 3CX Installation Wizard Numbers
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxNumbersEntity: Array<TcxNumbersEntity>; //3CX Wizard Numbers (optional)
+
+const { status, data } = await apiInstance.patchAddNumbers(
+    tcxNumbersEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxNumbersEntity** | **Array<TcxNumbersEntity>**| 3CX Wizard Numbers | |
+
+
+### Return type
+
+**Array<TcxNumbersEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Wizard Numbers |  -  |
+|**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)
+
+# **patchAddPhones**
+> Array<TcxPhonesEntity> patchAddPhones()
+
+Update 3CX Installation Wizard Phones
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxPhonesEntity: Array<TcxPhonesEntity>; //3CX Wizard Phones (optional)
+
+const { status, data } = await apiInstance.patchAddPhones(
+    tcxPhonesEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxPhonesEntity** | **Array<TcxPhonesEntity>**| 3CX Wizard Phones | |
+
+
+### Return type
+
+**Array<TcxPhonesEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Wizard Phones |  -  |
+|**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)
+
+# **patchAddSbcs**
+> Array<TcxSbcEntity> patchAddSbcs()
+
+Update 3CX Installation Wizard SBCs
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxSbcEntity: Array<TcxSbcEntity>; //3CX Wizard SBCs (optional)
+
+const { status, data } = await apiInstance.patchAddSbcs(
+    tcxSbcEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxSbcEntity** | **Array<TcxSbcEntity>**| 3CX Wizard SBCs | |
+
+
+### Return type
+
+**Array<TcxSbcEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Wizard SBCs |  -  |
+|**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)
+
+# **patchGetWizard**
+> TcxWizardModel patchGetWizard()
+
+Update 3CX Installation Wizard
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration,
+    TcxWizardModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxWizardModel: TcxWizardModel; //3CX Wizard (optional)
+
+const { status, data } = await apiInstance.patchGetWizard(
+    tcxWizardModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxWizardModel** | **TcxWizardModel**| 3CX Wizard | |
+
+
+### Return type
+
+**TcxWizardModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Wizard |  -  |
+|**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)
+
+# **postAddExtensions**
+> Array<TcxExtsEntity> postAddExtensions()
+
+Add Extensions To 3CX Installation Wizard
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxExtsEntity: Array<TcxExtsEntity>; //3CX Wizard Extension (optional)
+
+const { status, data } = await apiInstance.postAddExtensions(
+    tcxExtsEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxExtsEntity** | **Array<TcxExtsEntity>**| 3CX Wizard Extension | |
+
+
+### Return type
+
+**Array<TcxExtsEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Wizard Extensions |  -  |
+|**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)
+
+# **postAddNumbers**
+> Array<TcxNumbersEntity> postAddNumbers()
+
+Add Numbers To 3CX Installation Wizard
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxNumbersEntity: Array<TcxNumbersEntity>; //3CX Wizard Numbers (optional)
+
+const { status, data } = await apiInstance.postAddNumbers(
+    tcxNumbersEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxNumbersEntity** | **Array<TcxNumbersEntity>**| 3CX Wizard Numbers | |
+
+
+### Return type
+
+**Array<TcxNumbersEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Wizard Numbers |  -  |
+|**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)
+
+# **postAddPhones**
+> Array<TcxPhonesEntity> postAddPhones()
+
+Add Phones To 3CX Installation Wizard
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxPhonesEntity: Array<TcxPhonesEntity>; //3CX Wizard Phones (optional)
+
+const { status, data } = await apiInstance.postAddPhones(
+    tcxPhonesEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxPhonesEntity** | **Array<TcxPhonesEntity>**| 3CX Wizard Phones | |
+
+
+### Return type
+
+**Array<TcxPhonesEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Wizard Phones |  -  |
+|**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)
+
+# **postAddSbcs**
+> Array<TcxSbcEntity> postAddSbcs()
+
+Add SBCs To 3CX Installation Wizard
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let tcxSbcEntity: Array<TcxSbcEntity>; //3CX Wizard SBCs (optional)
+
+const { status, data } = await apiInstance.postAddSbcs(
+    tcxSbcEntity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tcxSbcEntity** | **Array<TcxSbcEntity>**| 3CX Wizard SBCs | |
+
+
+### Return type
+
+**Array<TcxSbcEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Wizard SBCs |  -  |
+|**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)
+
+# **postBuildInstance**
+> HostingChangeResponseModel postBuildInstance()
+
+Build Instance From 3CX Installation Wizard
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+const { status, data } = await apiInstance.postBuildInstance();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**HostingChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Installation Change Model |  -  |
+|**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)
+
+# **postBuildInstanceFromWizard**
+> HostingChangeResponseModel postBuildInstanceFromWizard()
+
+Start 3CX Installation Build Process
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let id: number; //3CX Installation Wizard ID (default to undefined)
+let u: string; //3CX Installation Wizard Unique ID (default to undefined)
+let c: number; //Customer ID (default to undefined)
+let p: string; //Customer Authentication key (default to undefined)
+
+const { status, data } = await apiInstance.postBuildInstanceFromWizard(
+    id,
+    u,
+    c,
+    p
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | 3CX Installation Wizard ID | defaults to undefined|
+| **u** | [**string**] | 3CX Installation Wizard Unique ID | defaults to undefined|
+| **c** | [**number**] | Customer ID | defaults to undefined|
+| **p** | [**string**] | Customer Authentication key | defaults to undefined|
+
+
+### Return type
+
+**HostingChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Installation Change Model |  -  |
+|**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)
+
+# **postCreateInstance**
+> HostingChangeResponseModel postCreateInstance()
+
+Create Instance From 3CX Installation Wizard
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+const { status, data } = await apiInstance.postCreateInstance();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**HostingChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Installation Change Model |  -  |
+|**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)
+
+# **postCreateInstanceFromWizard**
+> HostingChangeResponseModel postCreateInstanceFromWizard()
+
+Create Hosted Instance From 3CX Installation Wizard Config
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let id: number; //3CX Installation Wizard ID (default to undefined)
+let u: string; //3CX Installation Wizard Unique ID (default to undefined)
+let c: number; //Customer ID (default to undefined)
+let p: string; //Customer Authentication key (default to undefined)
+
+const { status, data } = await apiInstance.postCreateInstanceFromWizard(
+    id,
+    u,
+    c,
+    p
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | 3CX Installation Wizard ID | defaults to undefined|
+| **u** | [**string**] | 3CX Installation Wizard Unique ID | defaults to undefined|
+| **c** | [**number**] | Customer ID | defaults to undefined|
+| **p** | [**string**] | Customer Authentication key | defaults to undefined|
+
+
+### Return type
+
+**HostingChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Installation Change Model |  -  |
+|**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)
+
+# **postUploadBackup**
+> TcxBackupModel postUploadBackup()
+
+Upload 3CX Backup File
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let backup: File; //3CX Backup ZIP File (default to undefined)
+
+const { status, data } = await apiInstance.postUploadBackup(
+    backup
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **backup** | [**File**] | 3CX Backup ZIP File | defaults to undefined|
+
+
+### Return type
+
+**TcxBackupModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Wizard Backup |  -  |
+|**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)
+