doc_out/TelephonyProvidersEdgeApi.html.md in purecloud-0.50.1 vs doc_out/TelephonyProvidersEdgeApi.html.md in purecloud-0.51.1

- old
+ new

@@ -35,10 +35,11 @@ |[**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_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.| |[**get_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups) | **GET** /api/v2/telephony/providers/edges/edgegroups | Get the list of edge groups.| |[**get_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups_edgegroup_id) | **GET** /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} | Get edge group.| |[**get_providers_edges_edgeversionreport**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgeversionreport) | **GET** /api/v2/telephony/providers/edges/edgeversionreport | Get the edge version report.| @@ -78,11 +79,11 @@ |[**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_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**](TelephonyProvidersEdgeApi.html#post_providers_edges) | **POST** /api/v2/telephony/providers/edges | Create an 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.| |[**post_providers_edges_edge_id_logs_jobs**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logs_jobs) | **POST** /api/v2/telephony/providers/edges/{edgeId}/logs/jobs | Create a job to upload a list of Edge logs.| @@ -91,10 +92,11 @@ |[**post_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_softwareupdate) | **POST** /api/v2/telephony/providers/edges/{edgeId}/softwareupdate | Starts a software update for this edge.| |[**post_providers_edges_edge_id_unpair**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_unpair) | **POST** /api/v2/telephony/providers/edges/{edgeId}/unpair | Unpair an Edge| |[**post_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#post_providers_edges_edgegroups) | **POST** /api/v2/telephony/providers/edges/edgegroups | Create an edge group.| |[**post_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#post_providers_edges_endpoints) | **POST** /api/v2/telephony/providers/edges/endpoints | Create endpoint| |[**post_providers_edges_extensionpools**](TelephonyProvidersEdgeApi.html#post_providers_edges_extensionpools) | **POST** /api/v2/telephony/providers/edges/extensionpools | Create a new extension pool| +|[**post_providers_edges_offlineconfiguration**](TelephonyProvidersEdgeApi.html#post_providers_edges_offlineconfiguration) | **POST** /api/v2/telephony/providers/edges/offlineconfiguration | Create a file that can be used to configure a hardware Edge&#39;s settings.| |[**post_providers_edges_outboundroutes**](TelephonyProvidersEdgeApi.html#post_providers_edges_outboundroutes) | **POST** /api/v2/telephony/providers/edges/outboundroutes | Create outbound rule| |[**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| @@ -1782,10 +1784,66 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_providers_edges_edge_id_setuppackage"></a> + +## -[**VmPairingInfo**](VmPairingInfo.html) get_providers_edges_edge_id_setuppackage(edge_id) + +Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge. + + + +### 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 setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge. + result = api_instance.get_providers_edges_edge_id_setuppackage(edge_id) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_setuppackage: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edge_id** | **String**| Edge ID | +{: class="table table-striped"} + + +### Return type + +[**VmPairingInfo**](VmPairingInfo.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_providers_edges_edge_id_softwareupdate"></a> ## -[**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html) get_providers_edges_edge_id_softwareupdate(edge_id) Gets software update status information about any edge. @@ -1840,11 +1898,11 @@ <a name="get_providers_edges_edge_id_softwareversions"></a> -## -[**DomainEdgeSoftwareVersionDto**](DomainEdgeSoftwareVersionDto.html) get_providers_edges_edge_id_softwareversions(edge_id) +## -[**DomainEdgeSoftwareVersionDtoEntityListing**](DomainEdgeSoftwareVersionDtoEntityListing.html) get_providers_edges_edge_id_softwareversions(edge_id) Gets all the available software versions for this edge. @@ -1885,11 +1943,11 @@ {: class="table table-striped"} ### Return type -[**DomainEdgeSoftwareVersionDto**](DomainEdgeSoftwareVersionDto.html) +[**DomainEdgeSoftwareVersionDtoEntityListing**](DomainEdgeSoftwareVersionDtoEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json @@ -4373,11 +4431,11 @@ <a name="post_providers_edges"></a> ## -[**Edge**](Edge.html) post_providers_edges(body) -Create a edge. +Create an edge. ### Example ~~~ruby @@ -4398,11 +4456,11 @@ body = PureCloud::Edge.new # Edge | Edge begin - #Create a edge. + #Create an edge. result = api_instance.post_providers_edges(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges: #{e}" end @@ -5057,11 +5115,11 @@ <a name="post_providers_edges_extensionpools"></a> -## -[**Extension**](Extension.html) post_providers_edges_extensionpools(body) +## -[**ExtensionPool**](ExtensionPool.html) post_providers_edges_extensionpools(body) Create a new extension pool @@ -5102,10 +5160,66 @@ {: class="table table-striped"} ### Return type -[**Extension**](Extension.html) +[**ExtensionPool**](ExtensionPool.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="post_providers_edges_offlineconfiguration"></a> + +## -[**EdgeOfflineConfigurationResponse**](EdgeOfflineConfigurationResponse.html) post_providers_edges_offlineconfiguration(body) + +Create a file that can be used to configure a hardware Edge's settings. + + + +### 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 + +body = PureCloud::EdgeOfflineConfiguration.new # EdgeOfflineConfiguration | EdgeOfflineConfiguration + + +begin + #Create a file that can be used to configure a hardware Edge's settings. + result = api_instance.post_providers_edges_offlineconfiguration(body) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_offlineconfiguration: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**EdgeOfflineConfiguration**](EdgeOfflineConfiguration.html)| EdgeOfflineConfiguration | +{: class="table table-striped"} + + +### Return type + +[**EdgeOfflineConfigurationResponse**](EdgeOfflineConfigurationResponse.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json