doc_out/TelephonyProvidersEdgeApi.html.md in purecloud-0.64.1 vs doc_out/TelephonyProvidersEdgeApi.html.md in purecloud-0.65.1

- old
+ new

@@ -18,10 +18,11 @@ |[**delete_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_extensionpools_extensionpool_id) | **DELETE** /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} | Delete an extension pool by ID| |[**delete_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_outboundroutes_outboundroute_id) | **DELETE** /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} | Delete Outbound Route| |[**delete_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_phonebasesettings_phonebase_id) | **DELETE** /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} | Delete a Phone Base Settings by ID| |[**delete_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_phones_phone_id) | **DELETE** /api/v2/telephony/providers/edges/phones/{phoneId} | Delete a Phone by ID| |[**delete_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_sites_site_id) | **DELETE** /api/v2/telephony/providers/edges/sites/{siteId} | Delete a Site by ID| +|[**delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id) | **DELETE** /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} | Delete Outbound Route| |[**delete_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_trunkbasesettings_trunkbasesettings_id) | **DELETE** /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} | Delete a Trunk Base Settings object by ID| |[**get_providers_edges**](TelephonyProvidersEdgeApi.html#get_providers_edges) | **GET** /api/v2/telephony/providers/edges | Get the list of edges.| |[**get_providers_edges_availablelanguages**](TelephonyProvidersEdgeApi.html#get_providers_edges_availablelanguages) | **GET** /api/v2/telephony/providers/edges/availablelanguages | Get the list of available languages.| |[**get_providers_edges_certificateauthorities**](TelephonyProvidersEdgeApi.html#get_providers_edges_certificateauthorities) | **GET** /api/v2/telephony/providers/edges/certificateauthorities | Get the list of certificate authorities.| |[**get_providers_edges_certificateauthorities_certificate_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_certificateauthorities_certificate_id) | **GET** /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} | Get a certificate authority.| @@ -66,10 +67,12 @@ |[**get_providers_edges_sites**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites) | **GET** /api/v2/telephony/providers/edges/sites | Get the list of Sites.| |[**get_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id) | **GET** /api/v2/telephony/providers/edges/sites/{siteId} | Get a Site by ID.| |[**get_providers_edges_sites_site_id_numberplans**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans | Get the list of Number Plans for this Site.| |[**get_providers_edges_sites_site_id_numberplans_classifications**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans_classifications) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications | Get a list of Classifications for this Site| |[**get_providers_edges_sites_site_id_numberplans_numberplan_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans_numberplan_id) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId} | Get a Number Plan by ID.| +|[**get_providers_edges_sites_site_id_outboundroutes**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_outboundroutes) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes | Get outbound routes| +|[**get_providers_edges_sites_site_id_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_outboundroutes_outboundroute_id) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} | Get an outbound route| |[**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| @@ -99,10 +102,11 @@ |[**post_providers_edges_phonebasesettings**](TelephonyProvidersEdgeApi.html#post_providers_edges_phonebasesettings) | **POST** /api/v2/telephony/providers/edges/phonebasesettings | Create a new Phone Base Settings object| |[**post_providers_edges_phones**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones) | **POST** /api/v2/telephony/providers/edges/phones | Create a new Phone| |[**post_providers_edges_phones_phone_id_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones_phone_id_reboot) | **POST** /api/v2/telephony/providers/edges/phones/{phoneId}/reboot | Reboot a Phone| |[**post_providers_edges_phones_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones_reboot) | **POST** /api/v2/telephony/providers/edges/phones/reboot | Reboot Multiple Phones| |[**post_providers_edges_sites**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites) | **POST** /api/v2/telephony/providers/edges/sites | Create a Site.| +|[**post_providers_edges_sites_site_id_outboundroutes**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites_site_id_outboundroutes) | **POST** /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes | Create outbound route| |[**post_providers_edges_sites_site_id_rebalance**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites_site_id_rebalance) | **POST** /api/v2/telephony/providers/edges/sites/{siteId}/rebalance | Triggers the rebalance operation.| |[**post_providers_edges_trunkbasesettings**](TelephonyProvidersEdgeApi.html#post_providers_edges_trunkbasesettings) | **POST** /api/v2/telephony/providers/edges/trunkbasesettings | Create a Trunk Base Settings object| |[**put_providers_edges_certificateauthorities_certificate_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_certificateauthorities_certificate_id) | **PUT** /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} | Update a certificate authority.| |[**put_providers_edges_didpools_didpool_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_didpools_didpool_id) | **PUT** /api/v2/telephony/providers/edges/didpools/{didPoolId} | Update a DID Pool by ID.| |[**put_providers_edges_dids_did_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_dids_did_id) | **PUT** /api/v2/telephony/providers/edges/dids/{didId} | Update a DID by ID.| @@ -116,10 +120,11 @@ |[**put_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_outboundroutes_outboundroute_id) | **PUT** /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} | Update outbound route| |[**put_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_phonebasesettings_phonebase_id) | **PUT** /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} | Update a Phone Base Settings by ID| |[**put_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_phones_phone_id) | **PUT** /api/v2/telephony/providers/edges/phones/{phoneId} | Update a Phone by ID| |[**put_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id) | **PUT** /api/v2/telephony/providers/edges/sites/{siteId} | Update a Site by ID.| |[**put_providers_edges_sites_site_id_numberplans**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id_numberplans) | **PUT** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans | Update the list of Number Plans.| +|[**put_providers_edges_sites_site_id_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id_outboundroutes_outboundroute_id) | **PUT** /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} | Update outbound route| |[**put_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_trunkbasesettings_trunkbasesettings_id) | **PUT** /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} | Update a Trunk Base Settings object by ID| {: class="table table-striped"} <a name="delete_providers_edges_certificateauthorities_certificate_id"></a> @@ -793,10 +798,66 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id"></a> + +## -String** delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id) + +Delete Outbound Route + + + +### 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 + +outbound_route_id = "outbound_route_id_example" # String | Outbound route ID + + +begin + #Delete Outbound Route + result = api_instance.delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **outbound_route_id** | **String**| Outbound route ID | +{: class="table table-striped"} + + +### Return type + +**String** + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="delete_providers_edges_trunkbasesettings_trunkbasesettings_id"></a> ## -String** delete_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id) Delete a Trunk Base Settings object by ID @@ -3638,10 +3699,142 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_providers_edges_sites_site_id_outboundroutes"></a> + +## -[**OutboundRouteBaseEntityListing**](OutboundRouteBaseEntityListing.html) get_providers_edges_sites_site_id_outboundroutes(site_id, opts) + +Get outbound routes + + + +### 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 + +site_id = "site_id_example" # String | Site ID + +opts = { + page_size: 25, # Integer | Page size + page_number: 1, # Integer | Page number + name: "name_example", # String | Name + sort_by: "name" # String | Sort by +} + +begin + #Get outbound routes + result = api_instance.get_providers_edges_sites_site_id_outboundroutes(site_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_sites_site_id_outboundroutes: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **site_id** | **String**| Site ID | + **page_size** | **Integer**| Page size | [optional] [default to 25] + **page_number** | **Integer**| Page number | [optional] [default to 1] + **name** | **String**| Name | [optional] + **sort_by** | **String**| Sort by | [optional] [default to name] +{: class="table table-striped"} + + +### Return type + +[**OutboundRouteBaseEntityListing**](OutboundRouteBaseEntityListing.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_providers_edges_sites_site_id_outboundroutes_outboundroute_id"></a> + +## -[**OutboundRouteBase**](OutboundRouteBase.html) get_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id, opts) + +Get an outbound route + + + +### 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 + +outbound_route_id = "outbound_route_id_example" # String | Outbound route ID + +opts = { + page_size: 25, # Integer | Page size + page_number: 1, # Integer | Page number + name: "name_example", # String | Name + sort_by: "name" # String | Sort by +} + +begin + #Get an outbound route + result = api_instance.get_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_sites_site_id_outboundroutes_outboundroute_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **outbound_route_id** | **String**| Outbound route ID | + **page_size** | **Integer**| Page size | [optional] [default to 25] + **page_number** | **Integer**| Page number | [optional] [default to 1] + **name** | **String**| Name | [optional] + **sort_by** | **String**| Sort by | [optional] [default to name] +{: class="table table-striped"} + + +### Return type + +[**OutboundRouteBase**](OutboundRouteBase.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_providers_edges_timezones"></a> ## -[**TimeZoneEntityListing**](TimeZoneEntityListing.html) get_providers_edges_timezones(opts) Get a list of Edge-compatible time zones @@ -5579,10 +5772,69 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="post_providers_edges_sites_site_id_outboundroutes"></a> + +## -[**OutboundRoute**](OutboundRoute.html) post_providers_edges_sites_site_id_outboundroutes(site_id, body) + +Create outbound route + + + +### 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 + +site_id = "site_id_example" # String | Site ID + +body = PureCloud::OutboundRoute.new # OutboundRoute | OutboundRoute + + +begin + #Create outbound route + result = api_instance.post_providers_edges_sites_site_id_outboundroutes(site_id, body) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_sites_site_id_outboundroutes: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **site_id** | **String**| Site ID | + **body** | [**OutboundRoute**](OutboundRoute.html)| OutboundRoute | +{: class="table table-striped"} + + +### Return type + +[**OutboundRoute**](OutboundRoute.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="post_providers_edges_sites_site_id_rebalance"></a> ## - post_providers_edges_sites_site_id_rebalance(site_id) Triggers the rebalance operation. @@ -6573,9 +6825,68 @@ ### Return type [**Array&lt;NumberPlan&gt;**](NumberPlan.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="put_providers_edges_sites_site_id_outboundroutes_outboundroute_id"></a> + +## -[**OutboundRouteBase**](OutboundRouteBase.html) put_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id, body) + +Update outbound route + + + +### 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 + +outbound_route_id = "outbound_route_id_example" # String | Outbound route ID + +body = PureCloud::OutboundRouteBase.new # OutboundRouteBase | OutboundRoute + + +begin + #Update outbound route + result = api_instance.put_providers_edges_sites_site_id_outboundroutes_outboundroute_id(outbound_route_id, body) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_sites_site_id_outboundroutes_outboundroute_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **outbound_route_id** | **String**| Outbound route ID | + **body** | [**OutboundRouteBase**](OutboundRouteBase.html)| OutboundRoute | +{: class="table table-striped"} + + +### Return type + +[**OutboundRouteBase**](OutboundRouteBase.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json