yellowgrid-api-ts 3.2.105-dev.0 → 3.2.107-dev.0

package/docs/AccountsApi.md

@@ -1,6 +1,6 @@
 # AccountsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -9,15 +9,11 @@ All URIs are relative to *https://localhost*
 |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
 |[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
 |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
-|[**getGetAccountPageInfo**](#getgetaccountpageinfo) | **GET** /admin/accounts/{id} | |
 |[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
 |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
 |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
 |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
-|[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
-|[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
 |[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
-|[**patchUpdateAccountCname**](#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname | |
 |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
 |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
 |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
@@ -27,8 +23,6 @@ All URIs are relative to *https://localhost*
 |[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
 |[**postSubmitResellerApplication**](#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application|
 |[**putUpdateAccountContact**](#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact|
-|[**putUpdateBillingAddress**](#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address | |
-|[**putUpdateShippingAddress**](#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address | |
 
 # **deleteDeleteClientCredentials**
 > deleteDeleteClientCredentials()
@@ -293,60 +287,6 @@ 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)
 
-# **getGetAccountPageInfo**
-> AccountPageDetailsDTO getGetAccountPageInfo()
-
-Get Account Page Details
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-
-const { status, data } = await apiInstance.getGetAccountPageInfo(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### Return type
-
-**AccountPageDetailsDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Accounts Page 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)
-
 # **getGetAccounts**
 > AccountsResponseModel getGetAccounts()
 
@@ -558,120 +498,6 @@ 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)
 
-# **patchSetPortalAccess**
-> patchSetPortalAccess()
-
-Set Account Portal Access
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let state: 'enable' | 'disable'; //Portal Access State (default to undefined)
-
-const { status, data } = await apiInstance.patchSetPortalAccess(
-    id,
-    state
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] | Xero ID | defaults to undefined|
-| **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Portal Access State | 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 |
-|-------------|-------------|------------------|
-|**204** | 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)
-
-# **patchSetPrizePromo**
-> patchSetPrizePromo()
-
-Set Account Prize Promo
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let state: 'enable' | 'disable'; //Prize Promo State (default to undefined)
-
-const { status, data } = await apiInstance.patchSetPrizePromo(
-    id,
-    state
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] | Xero ID | defaults to undefined|
-| **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Prize Promo State | 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 |
-|-------------|-------------|------------------|
-|**204** | 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)
-
 # **patchSetTcxWizardCname**
 > patchSetTcxWizardCname()
 
@@ -683,16 +509,16 @@ Set 3CX Wizard CNAME
 import {
     AccountsApi,
     Configuration,
-    PatchUpdateAccountCnameRequest
+    PatchSetTcxWizardCnameRequest
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new AccountsApi(configuration);
 
-let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
+let patchSetTcxWizardCnameRequest: PatchSetTcxWizardCnameRequest; //CNAME Request (optional)
 
 const { status, data } = await apiInstance.patchSetTcxWizardCname(
-    patchUpdateAccountCnameRequest
+    patchSetTcxWizardCnameRequest
 );
 ```
 
@@ -700,7 +526,7 @@ const { status, data } = await apiInstance.patchSetTcxWizardCname(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
+| **patchSetTcxWizardCnameRequest** | **PatchSetTcxWizardCnameRequest**| CNAME Request | |
 
 
 ### Return type
@@ -727,64 +553,6 @@ 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)
 
-# **patchUpdateAccountCname**
-> patchUpdateAccountCname()
-
-Set Account Prize Promo
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration,
-    PatchUpdateAccountCnameRequest
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
-
-const { status, data } = await apiInstance.patchUpdateAccountCname(
-    id,
-    patchUpdateAccountCnameRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### 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 |
-|-------------|-------------|------------------|
-|**204** | 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)
-
 # **patchUpdateAccountContactPassword**
 > patchUpdateAccountContactPassword()
 
@@ -1281,119 +1049,3 @@ 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)
 
-# **putUpdateBillingAddress**
-> putUpdateBillingAddress()
-
-Update Account Billing Address
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration,
-    AddressModel
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let addressModel: AddressModel; //Updated Billing Address (optional)
-
-const { status, data } = await apiInstance.putUpdateBillingAddress(
-    id,
-    addressModel
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **addressModel** | **AddressModel**| Updated Billing Address | |
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### 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 |
-|-------------|-------------|------------------|
-|**204** | 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)
-
-# **putUpdateShippingAddress**
-> putUpdateShippingAddress()
-
-Update Account Shipping Address
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration,
-    AddressModel
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let addressModel: AddressModel; //Updated Shipping Address (optional)
-
-const { status, data } = await apiInstance.putUpdateShippingAddress(
-    id,
-    addressModel
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **addressModel** | **AddressModel**| Updated Shipping Address | |
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### 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 |
-|-------------|-------------|------------------|
-|**204** | 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)
-

package/docs/CRMApi.md

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

package/docs/Class3CXApi.md

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

package/docs/Class3CXInstallationWizardApi.md

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

package/docs/Class3CXInstallationsApi.md

@@ -1,17 +1,19 @@
 # Class3CXInstallationsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |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|
 |[**postSuspendInstance**](#postsuspendinstance) | **POST** /tcx/installations/{instance_id}/suspend | Suspend 3CX Instance|
@@ -144,6 +146,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()
 
@@ -486,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/Class3CXIntegrationsApi.md

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

package/docs/Class3CXMultiTenantApi.md

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