doc_out/TelephonyProvidersEdgeApi.html.md in purecloud-0.68.1 vs doc_out/TelephonyProvidersEdgeApi.html.md in purecloud-0.69.1

- old
+ new

@@ -34,18 +34,18 @@ [**get_providers_edges_edge_id_lines**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_lines) | Get the list of lines. [**get_providers_edges_edge_id_lines_line_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_lines_line_id) | Get line [**get_providers_edges_edge_id_logicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces) | Get edge logical interfaces. [**get_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces_interface_id) | Get an edge logical interface [**get_providers_edges_edge_id_logs_jobs_job_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logs_jobs_job_id) | Get an Edge logs job. -[**get_providers_edges_edge_id_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_metrics) | Get the edge metrics. [**get_providers_edges_edge_id_physicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces) | Retrieve a list of all configured physical interfaces from a specific edge. [**get_providers_edges_edge_id_physicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces_interface_id) | Get edge physical interface. [**get_providers_edges_edge_id_setuppackage**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_setuppackage) | Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge. [**get_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_softwareupdate) | Gets software update status information about any edge. [**get_providers_edges_edge_id_softwareversions**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_softwareversions) | Gets all the available software versions for this edge. [**get_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups) | Get the list of edge groups. [**get_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups_edgegroup_id) | Get edge group. +[**get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id) | Gets the edge trunk base associated with the edge group [**get_providers_edges_edgeversionreport**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgeversionreport) | Get the edge version report. [**get_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#get_providers_edges_endpoints) | Get endpoints [**get_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_endpoints_endpoint_id) | Get endpoint [**get_providers_edges_extensionpools**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensionpools) | Get a listing of extension pools [**get_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensionpools_extensionpool_id) | Get an extension pool by ID @@ -54,11 +54,11 @@ [**get_providers_edges_linebasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_linebasesettings) | Get a listing of line base settings objects [**get_providers_edges_linebasesettings_linebase_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_linebasesettings_linebase_id) | Get a line base settings object by ID [**get_providers_edges_lines**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines) | Get a list of Lines [**get_providers_edges_lines_line_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_line_id) | Get a Line by ID [**get_providers_edges_lines_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_template) | Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance -[**get_providers_edges_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_metrics) | Get the metrics for a list of edges. +[**get_providers_edges_logicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_logicalinterfaces) | Get edge logical interfaces. [**get_providers_edges_outboundroutes**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes) | Get outbound routes [**get_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes_outboundroute_id) | Get outbound route [**get_providers_edges_phonebasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings) | Get a list of Phone Base Settings objects [**get_providers_edges_phonebasesettings_availablemetabases**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings_availablemetabases) | Get a list of available makes and models to create a new Phone Base Settings [**get_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings_phonebase_id) | Get a Phone Base Settings object by ID @@ -77,11 +77,13 @@ [**get_providers_edges_trunkbasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings) | Get Trunk Base Settings listing [**get_providers_edges_trunkbasesettings_availablemetabases**](TelephonyProvidersEdgeApi.html#get_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 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 a Trunk Base Settings object by ID [**get_providers_edges_trunks**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks) | Get the list of available trunks. +[**get_providers_edges_trunks_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks_metrics) | Get the metrics for a list of trunks. [**get_providers_edges_trunks_trunk_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks_trunk_id) | Get a Trunk by ID +[**get_providers_edges_trunks_trunk_id_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks_trunk_id_metrics) | Get the trunk metrics. [**get_providers_edges_trunkswithrecording**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkswithrecording) | Get Counts of trunks that have recording disabled or enabled [**get_schemas_edges_vnext**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext) | Lists available schema categories (Deprecated) [**get_schemas_edges_vnext_schemacategory**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory) | List schemas of a specific category (Deprecated) [**get_schemas_edges_vnext_schemacategory_schematype**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype) | List schemas of a specific category (Deprecated) [**get_schemas_edges_vnext_schemacategory_schematype_schema_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id) | Get a json schema (Deprecated) @@ -93,10 +95,11 @@ [**post_providers_edges_edge_id_logicalinterfaces**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logicalinterfaces) | Create an edge logical interface. [**post_providers_edges_edge_id_logs_jobs**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logs_jobs) | Create a job to upload a list of Edge logs. [**post_providers_edges_edge_id_logs_jobs_job_id_upload**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logs_jobs_job_id_upload) | Request that the specified fileIds be uploaded from the Edge. [**post_providers_edges_edge_id_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_reboot) | Reboot an Edge [**post_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_softwareupdate) | Starts a software update for this edge. +[**post_providers_edges_edge_id_statuscode**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_statuscode) | Take an Edge in or out of service [**post_providers_edges_edge_id_unpair**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_unpair) | Unpair an Edge [**post_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#post_providers_edges_edgegroups) | Create an edge group. [**post_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#post_providers_edges_endpoints) | Create endpoint [**post_providers_edges_extensionpools**](TelephonyProvidersEdgeApi.html#post_providers_edges_extensionpools) | Create a new extension pool [**post_providers_edges_offlineconfiguration**](TelephonyProvidersEdgeApi.html#post_providers_edges_offlineconfiguration) | Create a file that can be used to configure a hardware Edge&#39;s settings. @@ -114,10 +117,11 @@ [**put_providers_edges_dids_did_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_dids_did_id) | Update a DID by ID. [**put_providers_edges_edge_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id) | Update a edge. [**put_providers_edges_edge_id_lines_line_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id_lines_line_id) | Update a line. [**put_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id_logicalinterfaces_interface_id) | Update an edge logical interface. [**put_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edgegroups_edgegroup_id) | Update an edge group. +[**put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id) | Update the edge trunk base associated with the edge group [**put_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_endpoints_endpoint_id) | Update endpoint [**put_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_extensionpools_extensionpool_id) | Update an extension pool by ID [**put_providers_edges_extensions_extension_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_extensions_extension_id) | Update an extension by ID. [**put_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_outboundroutes_outboundroute_id) | Update outbound route [**put_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_phonebasesettings_phonebase_id) | Update a Phone Base Settings by ID @@ -838,11 +842,11 @@ <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) +## -String** delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_id, outbound_route_id) Delete Outbound Route @@ -864,26 +868,29 @@ config.access_token = @authToken end api_instance = PureCloud::TelephonyProvidersEdgeApi.new +site_id = "site_id_example" # String | Site ID + 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) + result = api_instance.delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_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 ------------- | ------------- | ------------- | ------------- + **site_id** | **String**| Site ID | **outbound_route_id** | **String**| Outbound route ID | {: class="table table-striped"} ### Return type @@ -1822,69 +1829,10 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="get_providers_edges_edge_id_metrics"></a> - -## -[**EdgeMetrics**](EdgeMetrics.html) get_providers_edges_edge_id_metrics(edge_id) - -Get the edge metrics. - - - -Wraps GET /api/v2/telephony/providers/edges/{edgeId}/metrics - - -### 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 - -edge_id = "edge_id_example" # String | Edge Id - - -begin - #Get the edge metrics. - result = api_instance.get_providers_edges_edge_id_metrics(edge_id) - p result -rescue PureCloud::ApiError => e - puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_metrics: #{e}" -end -~~~ - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **edge_id** | **String**| Edge Id | -{: class="table table-striped"} - - -### Return type - -[**EdgeMetrics**](EdgeMetrics.html) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - <a name="get_providers_edges_edge_id_physicalinterfaces"></a> ## -[**PhysicalInterfaceEntityListing**](PhysicalInterfaceEntityListing.html) get_providers_edges_edge_id_physicalinterfaces(edge_id) Retrieve a list of all configured physical interfaces from a specific edge. @@ -2310,10 +2258,72 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id"></a> + +## -[**EdgeTrunkBase**](EdgeTrunkBase.html) get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id(edgegroup_id, edgetrunkbase_id) + +Gets the edge trunk base associated with the edge group + + + +Wraps GET /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId} + + +### 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 + +edgegroup_id = "edgegroup_id_example" # String | Edge Group ID + +edgetrunkbase_id = "edgetrunkbase_id_example" # String | Edge Trunk Base ID + + +begin + #Gets the edge trunk base associated with the edge group + result = api_instance.get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id(edgegroup_id, edgetrunkbase_id) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edgegroup_id** | **String**| Edge Group ID | + **edgetrunkbase_id** | **String**| Edge Trunk Base ID | +{: class="table table-striped"} + + +### Return type + +[**EdgeTrunkBase**](EdgeTrunkBase.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_providers_edges_edgeversionreport"></a> ## -[**EdgeVersionReport**](EdgeVersionReport.html) get_providers_edges_edgeversionreport Get the edge version report. @@ -3051,21 +3061,21 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="get_providers_edges_metrics"></a> +<a name="get_providers_edges_logicalinterfaces"></a> -## -[**Array&lt;EdgeMetrics&gt;**](EdgeMetrics.html) get_providers_edges_metrics(edge_ids) +## -[**LogicalInterfaceEntityListing**](LogicalInterfaceEntityListing.html) get_providers_edges_logicalinterfaces(edge_ids, opts) -Get the metrics for a list of edges. +Get edge logical interfaces. +Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time. +Wraps GET /api/v2/telephony/providers/edges/logicalinterfaces -Wraps GET /api/v2/telephony/providers/edges/metrics - ### Example ~~~ruby # load the gem require 'purecloud' # setup authorization @@ -3081,31 +3091,35 @@ api_instance = PureCloud::TelephonyProvidersEdgeApi.new edge_ids = "edge_ids_example" # String | Comma separated list of Edge Id's +opts = { + expand: ["expand_example"] # Array<String> | Field to expand in the response +} begin - #Get the metrics for a list of edges. - result = api_instance.get_providers_edges_metrics(edge_ids) + #Get edge logical interfaces. + result = api_instance.get_providers_edges_logicalinterfaces(edge_ids, opts) p result rescue PureCloud::ApiError => e - puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_metrics: #{e}" + puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_logicalinterfaces: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_ids** | **String**| Comma separated list of Edge Id&#39;s | + **expand** | [**Array&lt;String&gt;**](String.html)| Field to expand in the response | [optional] {: class="table table-striped"} ### Return type -[**Array&lt;EdgeMetrics&gt;**](EdgeMetrics.html) +[**LogicalInterfaceEntityListing**](LogicalInterfaceEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json @@ -3266,12 +3280,12 @@ end api_instance = PureCloud::TelephonyProvidersEdgeApi.new opts = { - page_number: 1, # Integer | Page number page_size: 25, # Integer | Page size + page_number: 1, # Integer | Page number sort_by: "name", # String | Value by which to sort sort_order: "ASC", # String | Sort order name: "name_example" # String | Name } @@ -3286,12 +3300,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_number** | **Integer**| Page number | [optional] [default to 1] **page_size** | **Integer**| Page size | [optional] [default to 25] + **page_number** | **Integer**| Page number | [optional] [default to 1] **sort_by** | **String**| Value by which to sort | [optional] [default to name] **sort_order** | **String**| Sort order | [optional] [default to ASC] **name** | **String**| Name | [optional] {: class="table table-striped"} @@ -4075,11 +4089,11 @@ <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) +## -[**OutboundRouteBase**](OutboundRouteBase.html) get_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_id, outbound_route_id, opts) Get an outbound route @@ -4101,10 +4115,12 @@ config.access_token = @authToken end api_instance = PureCloud::TelephonyProvidersEdgeApi.new +site_id = "site_id_example" # String | Site ID + outbound_route_id = "outbound_route_id_example" # String | Outbound route ID opts = { page_size: 25, # Integer | Page size page_number: 1, # Integer | Page number @@ -4112,21 +4128,22 @@ 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) + result = api_instance.get_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_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 ------------- | ------------- | ------------- | ------------- + **site_id** | **String**| Site ID | **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] @@ -4240,11 +4257,12 @@ sort_by: "name", # String | Value by which to sort sort_order: "ASC", # String | Sort order recording_enabled: true, # BOOLEAN | Filter trunks by recording enabled ignore_hidden: true, # BOOLEAN | Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only. managed: true, # BOOLEAN | Filter by managed - expand: ["expand_example"] # Array<String> | Fields to expand in the response, comma-separated + expand: ["expand_example"], # Array<String> | Fields to expand in the response, comma-separated + name: "name_example" # String | Name of the TrunkBase to filter by } begin #Get Trunk Base Settings listing result = api_instance.get_providers_edges_trunkbasesettings(opts) @@ -4264,10 +4282,11 @@ **sort_order** | **String**| Sort order | [optional] [default to ASC] **recording_enabled** | **BOOLEAN**| Filter trunks by recording enabled | [optional] **ignore_hidden** | **BOOLEAN**| Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only. | [optional] **managed** | **BOOLEAN**| Filter by managed | [optional] **expand** | [**Array&lt;String&gt;**](String.html)| Fields to expand in the response, comma-separated | [optional] + **name** | **String**| Name of the TrunkBase to filter by | [optional] {: class="table table-striped"} ### Return type @@ -4536,10 +4555,69 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_providers_edges_trunks_metrics"></a> + +## -[**Array&lt;TrunkMetrics&gt;**](TrunkMetrics.html) get_providers_edges_trunks_metrics(trunk_ids) + +Get the metrics for a list of trunks. + + + +Wraps GET /api/v2/telephony/providers/edges/trunks/metrics + + +### 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_ids = "trunk_ids_example" # String | Comma separated list of Trunk Id's + + +begin + #Get the metrics for a list of trunks. + result = api_instance.get_providers_edges_trunks_metrics(trunk_ids) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunks_metrics: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trunk_ids** | **String**| Comma separated list of Trunk Id&#39;s | +{: class="table table-striped"} + + +### Return type + +[**Array&lt;TrunkMetrics&gt;**](TrunkMetrics.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 @@ -4595,10 +4673,69 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_providers_edges_trunks_trunk_id_metrics"></a> + +## -[**TrunkMetrics**](TrunkMetrics.html) get_providers_edges_trunks_trunk_id_metrics(trunk_id) + +Get the trunk metrics. + + + +Wraps GET /api/v2/telephony/providers/edges/trunks/{trunkId}/metrics + + +### 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 the trunk metrics. + result = api_instance.get_providers_edges_trunks_trunk_id_metrics(trunk_id) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunks_trunk_id_metrics: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **trunk_id** | **String**| Trunk Id | +{: class="table table-striped"} + + +### Return type + +[**TrunkMetrics**](TrunkMetrics.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_providers_edges_trunkswithrecording"></a> ## -[**TrunkRecordingEnabledCount**](TrunkRecordingEnabledCount.html) get_providers_edges_trunkswithrecording(opts) Get Counts of trunks that have recording disabled or enabled @@ -5539,10 +5676,73 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="post_providers_edges_edge_id_statuscode"></a> + +## -String** post_providers_edges_edge_id_statuscode(edge_id, opts) + +Take an Edge in or out of service + + + +Wraps POST /api/v2/telephony/providers/edges/{edgeId}/statuscode + + +### 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 + +edge_id = "edge_id_example" # String | Edge ID + +opts = { + body: PureCloud::EdgeServiceStateRequest.new # EdgeServiceStateRequest | Edge Service State +} + +begin + #Take an Edge in or out of service + result = api_instance.post_providers_edges_edge_id_statuscode(edge_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_edge_id_statuscode: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_id** | **String**| Edge ID | + **body** | [**EdgeServiceStateRequest**](EdgeServiceStateRequest.html)| Edge Service State | [optional] +{: class="table table-striped"} + + +### Return type + +**String** + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="post_providers_edges_edge_id_unpair"></a> ## -String** post_providers_edges_edge_id_unpair(edge_id) Unpair an Edge @@ -6805,10 +7005,75 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id"></a> + +## -[**EdgeTrunkBase**](EdgeTrunkBase.html) put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id(edgegroup_id, edgetrunkbase_id, body) + +Update the edge trunk base associated with the edge group + + + +Wraps PUT /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId} + + +### 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 + +edgegroup_id = "edgegroup_id_example" # String | Edge Group ID + +edgetrunkbase_id = "edgetrunkbase_id_example" # String | Edge Trunk Base ID + +body = PureCloud::EdgeTrunkBase.new # EdgeTrunkBase | EdgeTrunkBase + + +begin + #Update the edge trunk base associated with the edge group + result = api_instance.put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id(edgegroup_id, edgetrunkbase_id, body) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_edgegroups_edgegroup_id_edgetrunkbases_edgetrunkbase_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edgegroup_id** | **String**| Edge Group ID | + **edgetrunkbase_id** | **String**| Edge Trunk Base ID | + **body** | [**EdgeTrunkBase**](EdgeTrunkBase.html)| EdgeTrunkBase | +{: class="table table-striped"} + + +### Return type + +[**EdgeTrunkBase**](EdgeTrunkBase.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="put_providers_edges_endpoints_endpoint_id"></a> ## -[**Endpoint**](Endpoint.html) put_providers_edges_endpoints_endpoint_id(endpoint_id, body) Update endpoint @@ -7303,11 +7568,11 @@ <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) +## -[**OutboundRouteBase**](OutboundRouteBase.html) put_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_id, outbound_route_id, body) Update outbound route @@ -7329,27 +7594,30 @@ config.access_token = @authToken end api_instance = PureCloud::TelephonyProvidersEdgeApi.new +site_id = "site_id_example" # String | Site ID + 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) + result = api_instance.put_providers_edges_sites_site_id_outboundroutes_outboundroute_id(site_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 ------------- | ------------- | ------------- | ------------- + **site_id** | **String**| Site ID | **outbound_route_id** | **String**| Outbound route ID | **body** | [**OutboundRouteBase**](OutboundRouteBase.html)| OutboundRoute | {: class="table table-striped"}