Merge pull request #19 from team-telnyx/2.3.0-prod

production SDK release
team-telnyx · Dec 17, 2020 · d1b7fda · d1b7fda
2 parents f7a9ad9 + ff6d31f
commit d1b7fda
Show file tree

Hide file tree

Showing 285 changed files with 68,668 additions and 16,168 deletions.
diff --git a/README.md b/README.md
diff --git a/api/openapi.yaml b/api/openapi.yaml
diff --git a/build.gradle b/build.gradle
@@ -2,7 +2,7 @@ apply plugin: 'idea'
 apply plugin: 'eclipse'
 
 group = 'com.telnyx.sdk'
-version = '2.2.0'
+version = '2.3.0'
 
 buildscript {
     repositories {

diff --git a/build.sbt b/build.sbt
@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.telnyx.sdk",
     name := "telnyx",
-    version := "2.2.0",
+    version := "2.3.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

diff --git a/docs/AnchorsiteOverride.md b/docs/AnchorsiteOverride.md
@@ -0,0 +1,29 @@
+
+
+# AnchorsiteOverride
+
+## Enum
+
+
+* `LATENCY` (value: `"Latency"`)
+
+* `CHICAGO_IL` (value: `"Chicago, IL"`)
+
+* `ASHBURN_VA` (value: `"Ashburn, VA"`)
+
+* `SAN_JOSE_CA` (value: `"San Jose, CA"`)
+
+* `SYDNEY_AUSTRALIA` (value: `"Sydney, Australia"`)
+
+* `AMSTERDAM_NETHERLANDS` (value: `"Amsterdam, Netherlands"`)
+
+* `LONDON_UK` (value: `"London, UK"`)
+
+* `TORONTO_CANADA` (value: `"Toronto, Canada"`)
+
+* `VANCOUVER_CANADA` (value: `"Vancouver, Canada"`)
+
+* `FRANKFURT_GERMANY` (value: `"Frankfurt, Germany"`)
+
+
+
diff --git a/docs/CallControlApplicationsApi.md b/docs/CallControlApplicationsApi.md
@@ -158,7 +158,7 @@ Name | Type | Description  | Notes
 
 ## listCallControlApplications
 
-> ListCallControlApplicationsResponse listCallControlApplications().pageNumber(pageNumber).pageSize(pageSize).filterApplicationNameContains(filterApplicationNameContains).filterOutboundOutboundVoiceProfileId(filterOutboundOutboundVoiceProfileId).sort(sort).execute();
+> ListCallControlApplicationsResponse listCallControlApplications().pageNumber(pageNumber).pageSize(pageSize).filterApplicationNameContains(filterApplicationNameContains).filterOutboundVoiceProfileId(filterOutboundVoiceProfileId).sort(sort).execute();
 
 List call control applications
 
@@ -185,17 +185,17 @@ public class Example {
         bearerAuth.setBearerToken("BEARER TOKEN");
 
         CallControlApplicationsApi apiInstance = new CallControlApplicationsApi(defaultClient);
-        Integer pageNumber = 1; // Integer | The page number to load
-        Integer pageSize = 20; // Integer | The size of the page
+        Integer pageNumber = 1; // Integer | The page number to load.
+        Integer pageSize = 20; // Integer | The size of the page.
         String filterApplicationNameContains = "\"null\""; // String | If present, applications with <code>application_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
-        String filterOutboundOutboundVoiceProfileId = 1293384261075731499; // String | Identifies the associated outbound voice profile.
+        String filterOutboundVoiceProfileId = 1293384261075731499; // String | Identifies the associated outbound voice profile.
         String sort = connection_name; // String | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul>   <li>     <code>connection_name</code>: sorts the result by the     <code>connection_name</code> field in ascending order.   </li>    <li>     <code>-connection_name</code>: sorts the result by the     <code>connection_name</code> field in descending order.   </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
         try {
             ListCallControlApplicationsResponse result = api.listCallControlApplications()
                 .pageNumber(pageNumber)
                 .pageSize(pageSize)
                 .filterApplicationNameContains(filterApplicationNameContains)
-                .filterOutboundOutboundVoiceProfileId(filterOutboundOutboundVoiceProfileId)
+                .filterOutboundVoiceProfileId(filterOutboundVoiceProfileId)
                 .sort(sort)
                 .execute();
             System.out.println(result);
@@ -215,10 +215,10 @@ public class Example {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
- **pageSize** | **Integer**| The size of the page | [optional] [default to 20]
+ **pageNumber** | **Integer**| The page number to load. | [optional] [default to 1]
+ **pageSize** | **Integer**| The size of the page. | [optional] [default to 20]
  **filterApplicationNameContains** | **String**| If present, applications with &lt;code&gt;application_name&lt;/code&gt; containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional] [default to &quot;null&quot;]
- **filterOutboundOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
+ **filterOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
  **sort** | **String**| Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the &lt;code&gt; -&lt;/code&gt; prefix.&lt;br/&gt;&lt;br/&gt; That is: &lt;ul&gt;   &lt;li&gt;     &lt;code&gt;connection_name&lt;/code&gt;: sorts the result by the     &lt;code&gt;connection_name&lt;/code&gt; field in ascending order.   &lt;/li&gt;    &lt;li&gt;     &lt;code&gt;-connection_name&lt;/code&gt;: sorts the result by the     &lt;code&gt;connection_name&lt;/code&gt; field in descending order.   &lt;/li&gt; &lt;/ul&gt; &lt;br/&gt; If not given, results are sorted by &lt;code&gt;created_at&lt;/code&gt; in descending order. | [optional] [default to created_at] [enum: created_at, connection_name, active]
 
 ### Return type

diff --git a/docs/ConferenceCommandsApi.md b/docs/ConferenceCommandsApi.md
@@ -907,8 +907,8 @@ public class Example {
         Boolean filterMuted = true; // Boolean | If present, participants will be filtered to those who are/are not muted
         Boolean filterOnHold = true; // Boolean | If present, participants will be filtered to those who are/are not put on hold
         Boolean filterWhispering = true; // Boolean | If present, participants will be filtered to those who are whispering or are not
-        Integer pageNumber = 1; // Integer | The page number to load
-        Integer pageSize = 20; // Integer | The size of the page
+        Integer pageNumber = 1; // Integer | The page number to load.
+        Integer pageSize = 20; // Integer | The size of the page.
         try {
             ListParticipantsResponse result = api.listConferenceParticipants(conferenceId)
                 .filterMuted(filterMuted)
@@ -938,8 +938,8 @@ Name | Type | Description  | Notes
  **filterMuted** | **Boolean**| If present, participants will be filtered to those who are/are not muted | [optional]
  **filterOnHold** | **Boolean**| If present, participants will be filtered to those who are/are not put on hold | [optional]
  **filterWhispering** | **Boolean**| If present, participants will be filtered to those who are whispering or are not | [optional]
- **pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
- **pageSize** | **Integer**| The size of the page | [optional] [default to 20]
+ **pageNumber** | **Integer**| The page number to load. | [optional] [default to 1]
+ **pageSize** | **Integer**| The size of the page. | [optional] [default to 20]
 
 ### Return type
 
@@ -993,8 +993,8 @@ public class Example {
 
         ConferenceCommandsApi apiInstance = new ConferenceCommandsApi(defaultClient);
         String filterName = "filterName_example"; // String | If present, conferences will be filtered to those with a matching `name` attribute. Matching is case-sensitive
-        Integer pageNumber = 1; // Integer | The page number to load
-        Integer pageSize = 20; // Integer | The size of the page
+        Integer pageNumber = 1; // Integer | The page number to load.
+        Integer pageSize = 20; // Integer | The size of the page.
         try {
             ListConferencesResponse result = api.listConferences()
                 .filterName(filterName)
@@ -1019,8 +1019,8 @@ public class Example {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **filterName** | **String**| If present, conferences will be filtered to those with a matching &#x60;name&#x60; attribute. Matching is case-sensitive | [optional]
- **pageNumber** | **Integer**| The page number to load | [optional] [default to 1]
- **pageSize** | **Integer**| The size of the page | [optional] [default to 20]
+ **pageNumber** | **Integer**| The page number to load. | [optional] [default to 1]
+ **pageSize** | **Integer**| The size of the page. | [optional] [default to 20]
 
 ### Return type
 

diff --git a/docs/Connection.md b/docs/Connection.md
@@ -0,0 +1,31 @@
+
+
+# Connection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Identifies the specific resource. |  [optional]
+**recordType** | **String** | Identifies the type of the resource. |  [optional]
+**active** | **Boolean** | Defaults to true |  [optional]
+**anchorsiteOverride** | [**AnchorsiteOverride**](AnchorsiteOverride.md) |  |  [optional]
+**connectionName** | **String** |  |  [optional]
+**createdAt** | **String** | ISO 8601 formatted date indicating when the resource was created. |  [optional]
+**updatedAt** | **String** | ISO 8601 formatted date indicating when the resource was updated. |  [optional]
+**webhookEventUrl** | **String** | The URL where webhooks related to this connection will be sent. |  [optional]
+**webhookEventFailoverUrl** | **String** | The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. |  [optional]
+**webhookApiVersion** | [**WebhookApiVersionEnum**](#WebhookApiVersionEnum) | Determines which webhook format will be used, Telnyx API v1 or v2. |  [optional]
+**outboundVoiceProfileId** | **String** | Identifies the associated outbound voice profile. |  [optional]
+
+
+
+## Enum: WebhookApiVersionEnum
+
+Name | Value
+---- | -----
+_1 | &quot;1&quot;
+_2 | &quot;2&quot;
+
+
+
diff --git a/docs/ConnectionResponse.md b/docs/ConnectionResponse.md
@@ -0,0 +1,12 @@
+
+
+# ConnectionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Connection**](Connection.md) |  |  [optional]
+
+
+
diff --git a/docs/ConnectionRtcpSettings.md b/docs/ConnectionRtcpSettings.md
@@ -0,0 +1,23 @@
+
+
+# ConnectionRtcpSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**port** | [**PortEnum**](#PortEnum) | RTCP port by default is rtp+1, it can also be set to rtcp-mux |  [optional]
+**captureEnabled** | **Boolean** | BETA - Enable the capture and storage of RTCP messages to create QoS reports on the Telnyx Mission Control Portal. |  [optional]
+**reportFrequencySecs** | **Integer** | RTCP reports are sent to customers based on the frequency set. Frequency is in seconds and it can be set to values from 5 to 3000 seconds. |  [optional]
+
+
+
+## Enum: PortEnum
+
+Name | Value
+---- | -----
+RTCP_MUX | &quot;rtcp-mux&quot;
+RTP_1 | &quot;rtp+1&quot;
+
+
+
diff --git a/docs/ConnectionsApi.md b/docs/ConnectionsApi.md
@@ -0,0 +1,170 @@
+# ConnectionsApi
+
+All URIs are relative to *https://api.telnyx.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**listConnections**](ConnectionsApi.md#listConnections) | **GET** /connections | List connections
+[**retrieveConnection**](ConnectionsApi.md#retrieveConnection) | **GET** /connections/{id} | Retrieve a connection
+
+
+
+## listConnections
+
+> ListConnectionsResponse listConnections().pageNumber(pageNumber).pageSize(pageSize).filterConnectionNameContains(filterConnectionNameContains).filterOutboundVoiceProfileId(filterOutboundVoiceProfileId).sort(sort).execute();
+
+List connections
+
+Returns a list of your connections irrespective of type.
+
+### Example
+
+```java
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.ConnectionsApi;
+
+public class Example {
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+        // Configure HTTP bearer authorization: bearerAuth
+        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+        bearerAuth.setBearerToken("BEARER TOKEN");
+
+        ConnectionsApi apiInstance = new ConnectionsApi(defaultClient);
+        Integer pageNumber = 1; // Integer | The page number to load.
+        Integer pageSize = 20; // Integer | The size of the page.
+        String filterConnectionNameContains = "\"null\""; // String | If present, connections with <code>connection_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
+        String filterOutboundVoiceProfileId = 1293384261075731499; // String | Identifies the associated outbound voice profile.
+        String sort = connection_name; // String | Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul>   <li>     <code>connection_name</code>: sorts the result by the     <code>connection_name</code> field in ascending order.   </li>    <li>     <code>-connection_name</code>: sorts the result by the     <code>connection_name</code> field in descending order.   </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
+        try {
+            ListConnectionsResponse result = api.listConnections()
+                .pageNumber(pageNumber)
+                .pageSize(pageSize)
+                .filterConnectionNameContains(filterConnectionNameContains)
+                .filterOutboundVoiceProfileId(filterOutboundVoiceProfileId)
+                .sort(sort)
+                .execute();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ConnectionsApi#listConnections");
+            System.err.println("Status code: " + e.getCode());
+            System.err.println("Reason: " + e.getResponseBody());
+            System.err.println("Response headers: " + e.getResponseHeaders());
+            e.printStackTrace();
+        }
+    }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pageNumber** | **Integer**| The page number to load. | [optional] [default to 1]
+ **pageSize** | **Integer**| The size of the page. | [optional] [default to 20]
+ **filterConnectionNameContains** | **String**| If present, connections with &lt;code&gt;connection_name&lt;/code&gt; containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. | [optional] [default to &quot;null&quot;]
+ **filterOutboundVoiceProfileId** | **String**| Identifies the associated outbound voice profile. | [optional]
+ **sort** | **String**| Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the &lt;code&gt; -&lt;/code&gt; prefix.&lt;br/&gt;&lt;br/&gt; That is: &lt;ul&gt;   &lt;li&gt;     &lt;code&gt;connection_name&lt;/code&gt;: sorts the result by the     &lt;code&gt;connection_name&lt;/code&gt; field in ascending order.   &lt;/li&gt;    &lt;li&gt;     &lt;code&gt;-connection_name&lt;/code&gt;: sorts the result by the     &lt;code&gt;connection_name&lt;/code&gt; field in descending order.   &lt;/li&gt; &lt;/ul&gt; &lt;br/&gt; If not given, results are sorted by &lt;code&gt;created_at&lt;/code&gt; in descending order. | [optional] [default to created_at] [enum: created_at, connection_name, active]
+
+### Return type
+
+[**ListConnectionsResponse**](ListConnectionsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response with a list of connections. |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Resource not found |  -  |
+
+
+## retrieveConnection
+
+> ConnectionResponse retrieveConnection(id)
+
+Retrieve a connection
+
+Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type.
+
+### Example
+
+```java
+// Import classes:
+import com.telnyx.sdk.ApiClient;
+import com.telnyx.sdk.ApiException;
+import com.telnyx.sdk.Configuration;
+import com.telnyx.sdk.auth.*;
+import com.telnyx.sdk.model.*;
+import com.telnyx.sdk.api.ConnectionsApi;
+
+public class Example {
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        defaultClient.setBasePath("https://api.telnyx.com/v2");
+
+        // Configure HTTP bearer authorization: bearerAuth
+        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
+        bearerAuth.setBearerToken("BEARER TOKEN");
+
+        ConnectionsApi apiInstance = new ConnectionsApi(defaultClient);
+        String id = "id_example"; // String | IP Connection ID
+        try {
+            ConnectionResponse result = apiInstance.retrieveConnection(id);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ConnectionsApi#retrieveConnection");
+            System.err.println("Status code: " + e.getCode());
+            System.err.println("Reason: " + e.getResponseBody());
+            System.err.println("Response headers: " + e.getResponseHeaders());
+            e.printStackTrace();
+        }
+    }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| IP Connection ID |
+
+### Return type
+
+[**ConnectionResponse**](ConnectionResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response with details about a connection. |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Resource not found |  -  |
+| **422** | Bad request |  -  |
+