doc_out/TelephonyProvidersEdgeApi.html.md in purecloud-0.36.1 vs doc_out/TelephonyProvidersEdgeApi.html.md in purecloud-0.37.1
- old
+ new
@@ -69,15 +69,17 @@
|[**get_providers_edges_timezones**](TelephonyProvidersEdgeApi.html#get_providers_edges_timezones) | **GET** /api/v2/telephony/providers/edges/timezones | Get a list of Edge-compatible time zones|
|[**get_providers_edges_trunkbasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings) | **GET** /api/v2/telephony/providers/edges/trunkbasesettings | Get Trunk Base Settings listing|
|[**get_providers_edges_trunkbasesettings_availablemetabases**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_availablemetabases) | **GET** /api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases | Get a list of available makes and models to create a new Trunk Base Settings|
|[**get_providers_edges_trunkbasesettings_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_template) | **GET** /api/v2/telephony/providers/edges/trunkbasesettings/template | Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance|
|[**get_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_trunkbasesettings_id) | **GET** /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} | Get a Trunk Base Settings object by ID|
+|[**get_providers_edges_trunks**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks) | **GET** /api/v2/telephony/providers/edges/trunks | Get the list of available trunks.|
+|[**get_providers_edges_trunks_trunk_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks_trunk_id) | **GET** /api/v2/telephony/providers/edges/trunks/{trunkId} | Get a Trunk by ID|
|[**get_schemas_edges_vnext**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext) | **GET** /api/v2/configuration/schemas/edges/vnext | Lists available schema categories|
|[**get_schemas_edges_vnext_schemacategory**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory} | List schemas of a specific category|
|[**get_schemas_edges_vnext_schemacategory_schematype**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType} | List schemas of a specific category|
|[**get_schemas_edges_vnext_schemacategory_schematype_schema_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId} | Get a json schema|
-|[**get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extension}/{metadataId} | Get metadata for a schema|
+|[**get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId} | Get metadata for a schema|
|[**post_providers_edges**](TelephonyProvidersEdgeApi.html#post_providers_edges) | **POST** /api/v2/telephony/providers/edges | Create a edge.|
|[**post_providers_edges_addressvalidation**](TelephonyProvidersEdgeApi.html#post_providers_edges_addressvalidation) | **POST** /api/v2/telephony/providers/edges/addressvalidation | Validates a street address|
|[**post_providers_edges_certificateauthorities**](TelephonyProvidersEdgeApi.html#post_providers_edges_certificateauthorities) | **POST** /api/v2/telephony/providers/edges/certificateauthorities | Create a certificate authority.|
|[**post_providers_edges_didpools**](TelephonyProvidersEdgeApi.html#post_providers_edges_didpools) | **POST** /api/v2/telephony/providers/edges/didpools | Create a new DID pool|
|[**post_providers_edges_edge_id_logicalinterfaces**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logicalinterfaces) | **POST** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces | Create an edge logical interface.|
@@ -3789,10 +3791,135 @@
- **Content-Type**: application/json
- **Accept**: application/json
+<a name="get_providers_edges_trunks"></a>
+
+## -[**TrunkEntityListing**](TrunkEntityListing.html) get_providers_edges_trunks(opts)
+
+Get the list of available trunks.
+
+Trunks are created by assigning trunk base settings to an Edge or Edge Group.
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+ config.access_token = @authToken
+end
+
+api_instance = PureCloud::TelephonyProvidersEdgeApi.new
+
+opts = {
+ page_number: 1, # Integer | Page number
+ page_size: 25, # Integer | Page size
+ sort_by: "name", # String | Value by which to sort
+ sort_order: "ASC", # String | Sort order
+ edge_id: "edge_id_example", # String | Filter by Edge Ids
+ trunk_base_id: "trunk_base_id_example", # String | Filter by Trunk Base Ids
+ trunk_type: "trunk_type_example" # String | Filter by a Trunk type
+}
+
+begin
+ #Get the list of available trunks.
+ result = api_instance.get_providers_edges_trunks(opts)
+ p result
+rescue PureCloud::ApiError => e
+ puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunks: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
+ **sort_by** | **String**| Value by which to sort | [optional] [default to name]
+ **sort_order** | **String**| Sort order | [optional] [default to ASC]
+ **edge_id** | **String**| Filter by Edge Ids | [optional]
+ **trunk_base_id** | **String**| Filter by Trunk Base Ids | [optional]
+ **trunk_type** | **String**| Filter by a Trunk type | [optional]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**TrunkEntityListing**](TrunkEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_providers_edges_trunks_trunk_id"></a>
+
+## -[**Trunk**](Trunk.html) get_providers_edges_trunks_trunk_id(trunk_id)
+
+Get a Trunk by ID
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+ config.access_token = @authToken
+end
+
+api_instance = PureCloud::TelephonyProvidersEdgeApi.new
+
+trunk_id = "trunk_id_example" # String | Trunk ID
+
+
+begin
+ #Get a Trunk by ID
+ result = api_instance.get_providers_edges_trunks_trunk_id(trunk_id)
+ p result
+rescue PureCloud::ApiError => e
+ puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunks_trunk_id: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **trunk_id** | **String**| Trunk ID |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**Trunk**](Trunk.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
<a name="get_schemas_edges_vnext"></a>
## -[**SchemaCategoryEntityListing**](SchemaCategoryEntityListing.html) get_schemas_edges_vnext(opts)
Lists available schema categories
@@ -4037,13 +4164,13 @@
- **Content-Type**: application/json
- **Accept**: application/json
-<a name="get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id"></a>
+<a name="get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id"></a>
-## -[**Organization**](Organization.html) get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id(schema_category, schema_type, schema_id, extension, metadata_id, opts)
+## -[**Organization**](Organization.html) get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id(schema_category, schema_type, schema_id, extension_type, metadata_id, opts)
Get metadata for a schema
@@ -4068,34 +4195,34 @@
schema_type = "schema_type_example" # String | Schema type
schema_id = "schema_id_example" # String | Schema ID
-extension = "extension_example" # String | extension
+extension_type = "extension_type_example" # String | extension
metadata_id = "metadata_id_example" # String | Metadata ID
opts = {
type: "type_example" # String | Type
}
begin
#Get metadata for a schema
- result = api_instance.get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id(schema_category, schema_type, schema_id, extension, metadata_id, opts)
+ result = api_instance.get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id(schema_category, schema_type, schema_id, extension_type, metadata_id, opts)
p result
rescue PureCloud::ApiError => e
- puts "Exception when calling TelephonyProvidersEdgeApi->get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id: #{e}"
+ puts "Exception when calling TelephonyProvidersEdgeApi->get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id: #{e}"
end
~~~
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**schema_category** | **String**| Schema category |
**schema_type** | **String**| Schema type |
**schema_id** | **String**| Schema ID |
- **extension** | **String**| extension |
+ **extension_type** | **String**| extension |
**metadata_id** | **String**| Metadata ID |
**type** | **String**| Type | [optional]
{: class="table table-striped"}