yellowgrid-api-ts 3.0.79

package/docs/SIPTrunksApi.md

@@ -0,0 +1,1258 @@
+# SIPTrunksApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteGetSipTrunk**](#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk|
+|[**getCanDivert**](#getcandivert) | **GET** /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed|
+|[**getGetAddress**](#getgetaddress) | **GET** /sip/trunks/{id}/address | Get SIP Trunk Address|
+|[**getGetAreaCodes**](#getgetareacodes) | **GET** /sip/trunks/area/codes | Get UK National Area Codes|
+|[**getGetCliFlexibility**](#getgetcliflexibility) | **GET** /sip/trunks/{id}/cli/flexibility | Get SIP Trunk CLI Flexibility Status|
+|[**getGetDdis**](#getgetddis) | **GET** /sip/trunks/{id}/ddis | Get SIP Trunk DDIs|
+|[**getGetDiverts**](#getgetdiverts) | **GET** /sip/trunks/{id}/diverts | Get SIP Trunk Diverts|
+|[**getGetSipTrunk**](#getgetsiptrunk) | **GET** /sip/trunks/{id} | Get SIP Trunk|
+|[**getGetSipTrunks**](#getgetsiptrunks) | **GET** /sip/trunks | Get SIP Trunks|
+|[**patchGetCliFlexibility**](#patchgetcliflexibility) | **PATCH** /sip/trunks/{id}/cli/flexibility | Update Get SIP Trunk CLI Flexibility Status|
+|[**patchSetAsAvailable**](#patchsetasavailable) | **PATCH** /sip/trunks/{id}/available | Set a SIP trunk as \'AVAILABLE\' for repurposing|
+|[**patchSetOwnership**](#patchsetownership) | **PATCH** /sip/trunks/{id}/owner | Change SIP Trunk Owner|
+|[**patchUpdateChannelCount**](#patchupdatechannelcount) | **PATCH** /sip/trunks/{id}/channels | Increase SIP Trunk Channels|
+|[**patchUpdateCompanyName**](#patchupdatecompanyname) | **PATCH** /sip/trunks/{id}/company | Update SIP Trunk Company Name|
+|[**patchUpdateMainTrunkNumber**](#patchupdatemaintrunknumber) | **PATCH** /sip/trunks/{id}/number | Update SIP Trunk Main Trunk Number|
+|[**patchUpdatePbxIPAddress**](#patchupdatepbxipaddress) | **PATCH** /sip/trunks/{id}/pbx/ip | Update SIP Trunk PBX IP Address|
+|[**postGetDdis**](#postgetddis) | **POST** /sip/trunks/{id}/ddis | Add SIP Trunk DDIs|
+|[**postGetRequestedDdis**](#postgetrequestedddis) | **POST** /sip/trunks/changes/ddis | Get Requested DDIs|
+|[**postGetSipTrunks**](#postgetsiptrunks) | **POST** /sip/trunks | Create New SIP Trunk|
+|[**postTrackChange**](#posttrackchange) | **POST** /sip/trunks/changes/track | Track SIP Trunk Change Request|
+|[**putGetAddress**](#putgetaddress) | **PUT** /sip/trunks/{id}/address | Update SIP Trunk Address|
+|[**putGetDiverts**](#putgetdiverts) | **PUT** /sip/trunks/{id}/diverts | Update SIP Trunk Diverts|
+
+# **deleteGetSipTrunk**
+> SipTrunkChangeResponseModel deleteGetSipTrunk()
+
+Delete SIP Trunk
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteGetSipTrunk(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+
+
+### Return type
+
+**SipTrunkChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Change 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)
+
+# **getCanDivert**
+> boolean getCanDivert()
+
+SIP Trunk Diverts Allowed
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+
+const { status, data } = await apiInstance.getCanDivert(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | boolean |  -  |
+|**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)
+
+# **getGetAddress**
+> AddressRequestModel getGetAddress()
+
+Get SIP Trunk Address
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetAddress(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+
+
+### Return type
+
+**AddressRequestModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Address |  -  |
+|**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)
+
+# **getGetAreaCodes**
+> Array<AreaCodeModel> getGetAreaCodes()
+
+Get UK National Area Codes
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+const { status, data } = await apiInstance.getGetAreaCodes();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<AreaCodeModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Area Codes |  -  |
+|**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)
+
+# **getGetCliFlexibility**
+> boolean getGetCliFlexibility()
+
+Get SIP Trunk CLI Flexibility Status
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetCliFlexibility(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | boolean |  -  |
+|**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)
+
+# **getGetDdis**
+> Array<string> getGetDdis()
+
+Get SIP Trunk DDIs
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetDdis(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+
+
+### Return type
+
+**Array<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] |  -  |
+|**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)
+
+# **getGetDiverts**
+> Array<DivertResponseModel> getGetDiverts()
+
+Get SIP Trunk Diverts
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+let enabled: boolean; //Enabled Diverts (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetDiverts(
+    id,
+    enabled
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+| **enabled** | [**boolean**] | Enabled Diverts | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<DivertResponseModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Diverts |  -  |
+|**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)
+
+# **getGetSipTrunk**
+> SipTrunkEntity getGetSipTrunk()
+
+Get SIP Trunk
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetSipTrunk(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+
+
+### Return type
+
+**SipTrunkEntity**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | SIP Trunk |  -  |
+|**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)
+
+# **getGetSipTrunks**
+> SipTrunksResponseModel getGetSipTrunks()
+
+Get SIP Trunks
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let pageSize: number; //Number Of Results (optional) (default to 20)
+let page: number; //Page Number (optional) (default to 1)
+let search: string; //Search (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetSipTrunks(
+    pageSize,
+    page,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
+| **page** | [**number**] | Page Number | (optional) defaults to 1|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+
+
+### Return type
+
+**SipTrunksResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | SIP Trunks |  -  |
+|**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)
+
+# **patchGetCliFlexibility**
+> SipTrunkChangeResponseModel patchGetCliFlexibility()
+
+Update Get SIP Trunk CLI Flexibility Status
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+let enabled: boolean; //Enabled (default to undefined)
+
+const { status, data } = await apiInstance.patchGetCliFlexibility(
+    id,
+    enabled
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+| **enabled** | [**boolean**] | Enabled | defaults to undefined|
+
+
+### Return type
+
+**SipTrunkChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Change 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)
+
+# **patchSetAsAvailable**
+> patchSetAsAvailable()
+
+Set a SIP trunk as \'AVAILABLE\' for repurposing
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+
+const { status, data } = await apiInstance.patchSetAsAvailable(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk 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)
+
+# **patchSetOwnership**
+> patchSetOwnership()
+
+Change SIP Trunk Owner
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+let ownerId: number; //Owner Customer ID (default to undefined)
+let billingCustomerId: number; //Billing Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.patchSetOwnership(
+    id,
+    ownerId,
+    billingCustomerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+| **ownerId** | [**number**] | Owner Customer ID | defaults to undefined|
+| **billingCustomerId** | [**number**] | Billing Customer ID | (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)
+
+# **patchUpdateChannelCount**
+> SipTrunkChangeResponseModel patchUpdateChannelCount()
+
+Increase SIP Trunk Channels
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+let channels: number; //SIP Channels (default to undefined)
+
+const { status, data } = await apiInstance.patchUpdateChannelCount(
+    id,
+    channels
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+| **channels** | [**number**] | SIP Channels | defaults to undefined|
+
+
+### Return type
+
+**SipTrunkChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Change 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)
+
+# **patchUpdateCompanyName**
+> SipTrunkChangeResponseModel patchUpdateCompanyName()
+
+Update SIP Trunk Company Name
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+let company: string; //Company Name (default to undefined)
+
+const { status, data } = await apiInstance.patchUpdateCompanyName(
+    id,
+    company
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+| **company** | [**string**] | Company Name | defaults to undefined|
+
+
+### Return type
+
+**SipTrunkChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Change 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)
+
+# **patchUpdateMainTrunkNumber**
+> SipTrunkChangeResponseModel patchUpdateMainTrunkNumber()
+
+Update SIP Trunk Main Trunk Number
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+let number: string; //Main Trunk Number (default to undefined)
+
+const { status, data } = await apiInstance.patchUpdateMainTrunkNumber(
+    id,
+    number
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+| **number** | [**string**] | Main Trunk Number | defaults to undefined|
+
+
+### Return type
+
+**SipTrunkChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Change 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)
+
+# **patchUpdatePbxIPAddress**
+> SipTrunkChangeResponseModel patchUpdatePbxIPAddress()
+
+Update SIP Trunk PBX IP Address
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+let ipAddress: string; //PBX IP Address (default to undefined)
+
+const { status, data } = await apiInstance.patchUpdatePbxIPAddress(
+    id,
+    ipAddress
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+| **ipAddress** | [**string**] | PBX IP Address | defaults to undefined|
+
+
+### Return type
+
+**SipTrunkChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Change 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)
+
+# **postGetDdis**
+> SipTrunkChangeResponseModel postGetDdis()
+
+Add SIP Trunk DDIs
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration,
+    DdiRangesRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+let ddiRangesRequestModel: DdiRangesRequestModel; //DDI Request (optional)
+
+const { status, data } = await apiInstance.postGetDdis(
+    id,
+    ddiRangesRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ddiRangesRequestModel** | **DdiRangesRequestModel**| DDI Request | |
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+
+
+### Return type
+
+**SipTrunkChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Change 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)
+
+# **postGetRequestedDdis**
+> Array<Array<string>> postGetRequestedDdis()
+
+Get Requested DDIs
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration,
+    SipTrunkChangeResponseModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let sipTrunkChangeResponseModel: SipTrunkChangeResponseModel; //Change Request (optional)
+
+const { status, data } = await apiInstance.postGetRequestedDdis(
+    sipTrunkChangeResponseModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sipTrunkChangeResponseModel** | **SipTrunkChangeResponseModel**| Change Request | |
+
+
+### Return type
+
+**Array<Array<string>>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | New DDIs |  -  |
+|**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)
+
+# **postGetSipTrunks**
+> SipTrunkChangeResponseModel postGetSipTrunks()
+
+Create New SIP Trunk
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration,
+    SipTrunkCreationRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let sipTrunkCreationRequestModel: SipTrunkCreationRequestModel; //New SIP Trunk Request (optional)
+
+const { status, data } = await apiInstance.postGetSipTrunks(
+    sipTrunkCreationRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sipTrunkCreationRequestModel** | **SipTrunkCreationRequestModel**| New SIP Trunk Request | |
+
+
+### Return type
+
+**SipTrunkChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Change 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)
+
+# **postTrackChange**
+> SipTrunkChangeResponseModel postTrackChange()
+
+Track SIP Trunk Change Request
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration,
+    SipTrunkChangeResponseModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let sipTrunkChangeResponseModel: SipTrunkChangeResponseModel; //Change Request (optional)
+
+const { status, data } = await apiInstance.postTrackChange(
+    sipTrunkChangeResponseModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sipTrunkChangeResponseModel** | **SipTrunkChangeResponseModel**| Change Request | |
+
+
+### Return type
+
+**SipTrunkChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Change 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)
+
+# **putGetAddress**
+> SipTrunkChangeResponseModel putGetAddress()
+
+Update SIP Trunk Address
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration,
+    AddressRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+let addressRequestModel: AddressRequestModel; //Address Request (optional)
+
+const { status, data } = await apiInstance.putGetAddress(
+    id,
+    addressRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **addressRequestModel** | **AddressRequestModel**| Address Request | |
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+
+
+### Return type
+
+**SipTrunkChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Change 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)
+
+# **putGetDiverts**
+> SipTrunkChangeResponseModel putGetDiverts()
+
+SIP Trunk Diverts
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration,
+    DivertRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let id: number; //SIP Trunk ID (default to undefined)
+let enabled: boolean; //Enable Divert (default to undefined)
+let divertRequestModel: DivertRequestModel; //Divert Request (optional)
+
+const { status, data } = await apiInstance.putGetDiverts(
+    id,
+    enabled,
+    divertRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **divertRequestModel** | **DivertRequestModel**| Divert Request | |
+| **id** | [**number**] | SIP Trunk ID | defaults to undefined|
+| **enabled** | [**boolean**] | Enable Divert | defaults to undefined|
+
+
+### Return type
+
+**SipTrunkChangeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Change 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)
+