doc_out/TelephonyProvidersEdgeApi.html.md in purecloud-0.66.1 vs doc_out/TelephonyProvidersEdgeApi.html.md in purecloud-0.67.1

- old
+ new

@@ -34,10 +34,11 @@ |[**get_providers_edges_edge_id_lines**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_lines) | **GET** /api/v2/telephony/providers/edges/{edgeId}/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** /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId} | Get line| |[**get_providers_edges_edge_id_logicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces) | **GET** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces | Get edge logical interfaces.| |[**get_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces_interface_id) | **GET** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} | 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** /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId} | Get an Edge logs job.| +|[**get_providers_edges_edge_id_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_metrics) | **GET** /api/v2/telephony/providers/edges/{edgeId}/metrics | Get the edge metrics.| |[**get_providers_edges_edge_id_physicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces) | **GET** /api/v2/telephony/providers/edges/{edgeId}/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** /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId} | Get edge physical interface.| |[**get_providers_edges_edge_id_setuppackage**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_setuppackage) | **GET** /api/v2/telephony/providers/edges/{edgeId}/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) | **GET** /api/v2/telephony/providers/edges/{edgeId}/softwareupdate | Gets software update status information about any edge.| |[**get_providers_edges_edge_id_softwareversions**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_softwareversions) | **GET** /api/v2/telephony/providers/edges/{edgeId}/softwareversions | Gets all the available software versions for this edge.| @@ -53,10 +54,11 @@ |[**get_providers_edges_linebasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_linebasesettings) | **GET** /api/v2/telephony/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** /api/v2/telephony/providers/edges/linebasesettings/{lineBaseId} | Get a line base settings object by ID| |[**get_providers_edges_lines**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines) | **GET** /api/v2/telephony/providers/edges/lines | Get a list of Lines| |[**get_providers_edges_lines_line_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_line_id) | **GET** /api/v2/telephony/providers/edges/lines/{lineId} | Get a Line by ID| |[**get_providers_edges_lines_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_template) | **GET** /api/v2/telephony/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** /api/v2/telephony/providers/edges/metrics | Get the metrics for a list of edges.| |[**get_providers_edges_outboundroutes**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes) | **GET** /api/v2/telephony/providers/edges/outboundroutes | Get outbound routes| |[**get_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes_outboundroute_id) | **GET** /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} | Get outbound route| |[**get_providers_edges_phonebasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings) | **GET** /api/v2/telephony/providers/edges/phonebasesettings | Get a list of Phone Base Settings objects| |[**get_providers_edges_phonebasesettings_availablemetabases**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings_availablemetabases) | **GET** /api/v2/telephony/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** /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} | Get a Phone Base Settings object by ID| @@ -1736,10 +1738,66 @@ - **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. + + + +### 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. @@ -2849,10 +2907,66 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_providers_edges_metrics"></a> + +## -[**Array&lt;EdgeMetrics&gt;**](EdgeMetrics.html) get_providers_edges_metrics(edge_ids) + +Get the metrics for a list of edges. + + + +### 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_ids = "edge_ids_example" # String | Comma separated list of Edge Id's + + +begin + #Get the metrics for a list of edges. + result = api_instance.get_providers_edges_metrics(edge_ids) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_metrics: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_ids** | **String**| Comma separated list of Edge Id&#39;s | +{: class="table table-striped"} + + +### Return type + +[**Array&lt;EdgeMetrics&gt;**](EdgeMetrics.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_providers_edges_outboundroutes"></a> ## -[**OutboundRouteEntityListing**](OutboundRouteEntityListing.html) get_providers_edges_outboundroutes(opts) Get outbound routes @@ -2999,11 +3113,12 @@ 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 + sort_order: "ASC", # String | Sort order + name: "name_example" # String | Name } begin #Get a list of Phone Base Settings objects result = api_instance.get_providers_edges_phonebasesettings(opts) @@ -3019,9 +3134,10 @@ ------------- | ------------- | ------------- | ------------- **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] + **name** | **String**| Name | [optional] {: class="table table-striped"} ### Return type