yellowgrid-api-ts 3.2.94-dev.0 → 3.2.94

package/docs/Class3CXInstallationsApi.md

@@ -1,25 +1,31 @@
 # Class3CXInstallationsApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getGetDetails**](#getgetdetails) | **GET** /tcx/installations/{wizard_id}/details | Get 3CX Installation Details|
 |[**getGetInstallations**](#getgetinstallations) | **GET** /tcx/installations | Get 3CX Installations|
+|[**patchChangeInstanceOwner**](#patchchangeinstanceowner) | **PATCH** /tcx/installations/{instance_id}/owner | Change instance owner|
 |[**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|
 |[**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|
+|[**postRestartServices**](#postrestartservices) | **POST** /tcx/installations/{instance_id}/services/restart | Restart 3CX Services|
+|[**postScheduledReboot**](#postscheduledreboot) | **POST** /tcx/installations/{instance_id}/reboot/scheduled | Reboot Instance|
 |[**postSuspendInstance**](#postsuspendinstance) | **POST** /tcx/installations/{instance_id}/suspend | Suspend 3CX Instance|
+|[**postTestLoginCredentials**](#posttestlogincredentials) | **POST** /tcx/installations/{instance_id}/tests/login | Test 3CX Login Credentials|
 |[**postUnsuspendInstance**](#postunsuspendinstance) | **POST** /tcx/installations/{instance_id}/unsuspend | Unsuspend 3CX Instance|
 |[**postUpgradeDebian**](#postupgradedebian) | **POST** /tcx/installations/{instance_id}/debian/upgrade | Install OS update on 3CX Instance|
+|[**putGetDetails**](#putgetdetails) | **PUT** /tcx/installations/{wizard_id}/details | Update 3CX Installation Details|
 
 # **getGetDetails**
-> TcxInstallationDetailsModel getGetDetails()
+> InstallationDetailsDTO getGetDetails()
 
 Get 3CX Installation Details
 
@@ -50,7 +56,7 @@ const { status, data } = await apiInstance.getGetDetails(
 
 ### Return type
 
-**TcxInstallationDetailsModel**
+**InstallationDetailsDTO**
 
 ### Authorization
 
@@ -144,6 +150,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)
 
+# **patchChangeInstanceOwner**
+> patchChangeInstanceOwner()
+
+Change instance owner
+
+### 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 customerId: number; //Customer ID (default to undefined)
+
+const { status, data } = await apiInstance.patchChangeInstanceOwner(
+    instanceId,
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **instanceId** | [**string**] | Instance ID | defaults to undefined|
+| **customerId** | [**number**] | Customer ID | 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)
+
 # **patchUpdateAutoFailover**
 > patchUpdateAutoFailover()
 
@@ -387,7 +450,7 @@ const apiInstance = new Class3CXInstallationsApi(configuration);
 
 let instanceId: string; //Instance ID (default to undefined)
 let gigabytes: number; //Disk Space (GB) (default to undefined)
-let schedule: string; //Scheduled Task (Date & Time) (default to undefined)
+let schedule: string; //Scheduled Task (Date & Time) (optional) (default to undefined)
 
 const { status, data } = await apiInstance.postExtendDisk(
     instanceId,
@@ -402,7 +465,7 @@ const { status, data } = await apiInstance.postExtendDisk(
 |------------- | ------------- | ------------- | -------------|
 | **instanceId** | [**string**] | Instance ID | defaults to undefined|
 | **gigabytes** | [**number**] | Disk Space (GB) | defaults to undefined|
-| **schedule** | [**string**] | Scheduled Task (Date & Time) | defaults to undefined|
+| **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
 
 
 ### Return type
@@ -486,6 +549,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()
 
@@ -576,6 +693,120 @@ const { status, data } = await apiInstance.postResizeInstance(
 | **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) 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)
+
+# **postRestartServices**
+> postRestartServices()
+
+Restart 3CX Services
+
+### 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 schedule: string; //Scheduled Task (Date & Time) (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postRestartServices(
+    instanceId,
+    schedule
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **instanceId** | [**string**] | Instance ID | defaults to undefined|
+| **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) 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)
+
+# **postScheduledReboot**
+> postScheduledReboot()
+
+Reboot 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 schedule: string; //Scheduled Task (Date & Time) (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postScheduledReboot(
+    instanceId,
+    schedule
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **instanceId** | [**string**] | Instance ID | defaults to undefined|
+| **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
+
+
 ### Return type
 
 void (empty response body)
@@ -633,6 +864,60 @@ const { status, data } = await apiInstance.postSuspendInstance(
 | **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) 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)
+
+# **postTestLoginCredentials**
+> postTestLoginCredentials()
+
+Test 3CX Login Credentials
+
+### 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)
+
+const { status, data } = await apiInstance.postTestLoginCredentials(
+    instanceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **instanceId** | [**string**] | Instance ID | defaults to undefined|
+
+
 ### Return type
 
 void (empty response body)
@@ -768,3 +1053,61 @@ 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)
 
+# **putGetDetails**
+> InstallationDetailsDTO putGetDetails()
+
+Update 3CX Installation Details
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationsApi,
+    Configuration,
+    InstallationDetailsDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationsApi(configuration);
+
+let wizardId: number; //Wizard ID (default to undefined)
+let installationDetailsDTO: InstallationDetailsDTO; //Installation Details (optional)
+
+const { status, data } = await apiInstance.putGetDetails(
+    wizardId,
+    installationDetailsDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **installationDetailsDTO** | **InstallationDetailsDTO**| Installation Details | |
+| **wizardId** | [**number**] | Wizard ID | defaults to undefined|
+
+
+### Return type
+
+**InstallationDetailsDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Installation 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)
+

package/docs/Class3CXIntegrationsApi.md

@@ -1,6 +1,6 @@
 # Class3CXIntegrationsApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXMultiTenantApi.md

@@ -1,6 +1,6 @@
 # Class3CXMultiTenantApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/InstallationDetailsDTO.md

@@ -0,0 +1,39 @@
+# InstallationDetailsDTO
+
+Installation Passwords
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
+**failoverIpAddress** | **string** | PBX Failover IP Address | [optional] [default to undefined]
+**instanceId** | **string** | Instance ID | [optional] [default to undefined]
+**project** | **string** | Project ID | [optional] [default to undefined]
+**sshKey** | [**GenericFileModel**](GenericFileModel.md) |  | [optional] [default to undefined]
+**osPassword** | **string** | Root Password | [optional] [default to undefined]
+**systemOwner** | [**TcxUsersEntity**](TcxUsersEntity.md) |  | [optional] [default to undefined]
+**email** | **string** | Admin Email | [optional] [default to undefined]
+**url** | **string** | 3CX Console URL | [optional] [default to undefined]
+**backup** | [**RemoteStorageDTO**](RemoteStorageDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InstallationDetailsDTO } from 'yellowgrid-api-ts';
+
+const instance: InstallationDetailsDTO = {
+    ipAddress,
+    failoverIpAddress,
+    instanceId,
+    project,
+    sshKey,
+    osPassword,
+    systemOwner,
+    email,
+    url,
+    backup,
+};
+```
+
+[[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/docs/MyPBXToolsApi.md

@@ -1,6 +1,6 @@
 # MyPBXToolsApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/NumberPortingApi.md

@@ -1,6 +1,6 @@
 # NumberPortingApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**getGetAdminNumberPort**](#getgetadminnumberport) | **GET** /admin/sip/numbers/ports/{id} | |
 |[**getGetAdminNumberPorts**](#getgetadminnumberports) | **GET** /admin/sip/numbers/ports | |
 |[**getUpdateNumberPort**](#getupdatenumberport) | **GET** /sip/numbers/ports/{id} | |
+|[**patchCancelAdminNumberPort**](#patchcanceladminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/cancel | |
 |[**patchCloseAdminNumberPort**](#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close | |
 |[**postAddAdminNote**](#postaddadminnote) | **POST** /admin/sip/numbers/ports/{id}/notes | |
 |[**postCreateNumberPort**](#postcreatenumberport) | **POST** /sip/numbers/ports | |
@@ -283,6 +284,59 @@ No authorization required
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | NumberPortResponseDTO |  -  |
+|**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)
+
+# **patchCancelAdminNumberPort**
+> AdminNumberPortDTO patchCancelAdminNumberPort()
+
+
+### Example
+
+```typescript
+import {
+    NumberPortingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new NumberPortingApi(configuration);
+
+let id: number; //Number Port ID (default to undefined)
+
+const { status, data } = await apiInstance.patchCancelAdminNumberPort(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Number Port ID | defaults to undefined|
+
+
+### Return type
+
+**AdminNumberPortDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/docs/OAuth20Api.md

@@ -1,6 +1,6 @@
 # OAuth20Api
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|