--- title: TelephonyProvidersEdgeApi --- ## PureCloud::TelephonyProvidersEdgeApi All URIs are relative to *https://api.mypurecloud.com* Method | HTTP request | Description ------------- | ------------- | ------------- |[**delete_providers_edges_certificateauthorities_certificate_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_certificateauthorities_certificate_id) | **DELETE** /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} | Delete a certificate authority.| |[**delete_providers_edges_didpools_didpool_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_didpools_didpool_id) | **DELETE** /api/v2/telephony/providers/edges/didpools/{didPoolId} | Delete a DID Pool by ID.| |[**delete_providers_edges_edge_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edge_id) | **DELETE** /api/v2/telephony/providers/edges/{edgeId} | Delete a edge.| |[**delete_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edge_id_logicalinterfaces_interface_id) | **DELETE** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} | Delete an edge logical interface| |[**delete_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edge_id_softwareupdate) | **DELETE** /api/v2/telephony/providers/edges/{edgeId}/softwareupdate | Cancels any in-progress update for this edge.| |[**delete_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edgegroups_edgegroup_id) | **DELETE** /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} | Delete an edge group.| |[**delete_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_endpoints_endpoint_id) | **DELETE** /api/v2/telephony/providers/edges/endpoints/{endpointId} | Delete endpoint| |[**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_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.| |[**get_providers_edges_didpools**](TelephonyProvidersEdgeApi.html#get_providers_edges_didpools) | **GET** /api/v2/telephony/providers/edges/didpools | Get a listing of DID Pools| |[**get_providers_edges_didpools_didpool_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_didpools_didpool_id) | **GET** /api/v2/telephony/providers/edges/didpools/{didPoolId} | Get a DID Pool by ID.| |[**get_providers_edges_dids**](TelephonyProvidersEdgeApi.html#get_providers_edges_dids) | **GET** /api/v2/telephony/providers/edges/dids | Get a listing of DIDs| |[**get_providers_edges_dids_did_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_dids_did_id) | **GET** /api/v2/telephony/providers/edges/dids/{didId} | Get a DID by ID.| |[**get_providers_edges_edge_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id) | **GET** /api/v2/telephony/providers/edges/{edgeId} | Get edge.| |[**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_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_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.| |[**get_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#get_providers_edges_endpoints) | **GET** /api/v2/telephony/providers/edges/endpoints | Get endpoints| |[**get_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_endpoints_endpoint_id) | **GET** /api/v2/telephony/providers/edges/endpoints/{endpointId} | Get endpoint| |[**get_providers_edges_extensionpools**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensionpools) | **GET** /api/v2/telephony/providers/edges/extensionpools | Get a listing of extension pools| |[**get_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensionpools_extensionpool_id) | **GET** /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} | Get an extension pool by ID| |[**get_providers_edges_extensions**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensions) | **GET** /api/v2/telephony/providers/edges/extensions | Get a listing of extensions| |[**get_providers_edges_extensions_extension_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensions_extension_id) | **GET** /api/v2/telephony/providers/edges/extensions/{extensionId} | Get an extension by ID.| |[**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_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| |[**get_providers_edges_phonebasesettings_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings_template) | **GET** /api/v2/telephony/providers/edges/phonebasesettings/template | Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance| |[**get_providers_edges_phones**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones) | **GET** /api/v2/telephony/providers/edges/phones | Get a list of Phone Instances| |[**get_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones_phone_id) | **GET** /api/v2/telephony/providers/edges/phones/{phoneId} | Get a Phone by ID| |[**get_providers_edges_phones_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones_template) | **GET** /api/v2/telephony/providers/edges/phones/template | Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance| |[**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_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_providers_edges_trunkswithrecording**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkswithrecording) | **GET** /api/v2/telephony/providers/edges/trunkswithrecording | Get Counts of trunks that have recording disabled or enabled| |[**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_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.| |[**post_providers_edges_edge_id_logs_jobs_job_id_upload**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logs_jobs_job_id_upload) | **POST** /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/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) | **POST** /api/v2/telephony/providers/edges/{edgeId}/reboot | Reboot an Edge| |[**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_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| |[**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_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.| |[**put_providers_edges_edge_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id) | **PUT** /api/v2/telephony/providers/edges/{edgeId} | Update a edge.| |[**put_providers_edges_edge_id_lines_line_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id_lines_line_id) | **PUT** /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId} | Update a line.| |[**put_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id_logicalinterfaces_interface_id) | **PUT** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} | Update an edge logical interface.| |[**put_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edgegroups_edgegroup_id) | **PUT** /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} | Update an edge group.| |[**put_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_endpoints_endpoint_id) | **PUT** /api/v2/telephony/providers/edges/endpoints/{endpointId} | Update endpoint| |[**put_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_extensionpools_extensionpool_id) | **PUT** /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} | Update an extension pool by ID| |[**put_providers_edges_extensions_extension_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_extensions_extension_id) | **PUT** /api/v2/telephony/providers/edges/extensions/{extensionId} | Update an extension by ID.| |[**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_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"} ## -String** delete_providers_edges_certificateauthorities_certificate_id(certificate_id) Delete a certificate authority. ### 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 certificate_id = "certificate_id_example" # String | Certificate ID begin #Delete a certificate authority. result = api_instance.delete_providers_edges_certificateauthorities_certificate_id(certificate_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_certificateauthorities_certificate_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **certificate_id** | **String**| Certificate ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_providers_edges_didpools_didpool_id(did_pool_id) Delete a DID Pool 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 did_pool_id = "did_pool_id_example" # String | DID pool ID begin #Delete a DID Pool by ID. result = api_instance.delete_providers_edges_didpools_didpool_id(did_pool_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_didpools_didpool_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **did_pool_id** | **String**| DID pool ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_providers_edges_edge_id(edge_id) Delete a 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 #Delete a edge. result = api_instance.delete_providers_edges_edge_id(edge_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_edge_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - delete_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id) Delete an edge logical interface ### 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 interface_id = "interface_id_example" # String | Interface ID begin #Delete an edge logical interface api_instance.delete_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id) rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_edge_id_logicalinterfaces_interface_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **interface_id** | **String**| Interface ID | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_providers_edges_edge_id_softwareupdate(edge_id) Cancels any in-progress update for this 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 #Cancels any in-progress update for this edge. result = api_instance.delete_providers_edges_edge_id_softwareupdate(edge_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_edge_id_softwareupdate: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_providers_edges_edgegroups_edgegroup_id(edge_group_id) Delete an 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 edge_group_id = "edge_group_id_example" # String | Edge group ID begin #Delete an edge group. result = api_instance.delete_providers_edges_edgegroups_edgegroup_id(edge_group_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_edgegroups_edgegroup_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_group_id** | **String**| Edge group ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_providers_edges_endpoints_endpoint_id(endpoint_id) Delete endpoint ### 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 endpoint_id = "endpoint_id_example" # String | Endpoint ID begin #Delete endpoint result = api_instance.delete_providers_edges_endpoints_endpoint_id(endpoint_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_endpoints_endpoint_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **endpoint_id** | **String**| Endpoint ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_providers_edges_extensionpools_extensionpool_id(extension_pool_id) Delete an extension pool 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 extension_pool_id = "extension_pool_id_example" # String | Extension pool ID begin #Delete an extension pool by ID result = api_instance.delete_providers_edges_extensionpools_extensionpool_id(extension_pool_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_extensionpools_extensionpool_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **extension_pool_id** | **String**| Extension pool ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_providers_edges_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_outboundroutes_outboundroute_id(outbound_route_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_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 ## -String** delete_providers_edges_phonebasesettings_phonebase_id(phone_base_id) Delete a Phone Base Settings 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 phone_base_id = "phone_base_id_example" # String | Phone base ID begin #Delete a Phone Base Settings by ID result = api_instance.delete_providers_edges_phonebasesettings_phonebase_id(phone_base_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_phonebasesettings_phonebase_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **phone_base_id** | **String**| Phone base ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_providers_edges_phones_phone_id(phone_id) Delete a Phone 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 phone_id = "phone_id_example" # String | Phone ID begin #Delete a Phone by ID result = api_instance.delete_providers_edges_phones_phone_id(phone_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_phones_phone_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **phone_id** | **String**| Phone ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_providers_edges_sites_site_id(site_id) Delete a Site 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 site_id = "site_id_example" # String | Site ID begin #Delete a Site by ID result = api_instance.delete_providers_edges_sites_site_id(site_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_sites_site_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **site_id** | **String**| Site ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id) Delete a Trunk Base Settings object 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_base_settings_id = "trunk_base_settings_id_example" # String | Trunk Base ID begin #Delete a Trunk Base Settings object by ID result = api_instance.delete_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->delete_providers_edges_trunkbasesettings_trunkbasesettings_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **trunk_base_settings_id** | **String**| Trunk Base ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EdgeEntityListing**](EdgeEntityListing.html) get_providers_edges(opts) Get the 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 opts = { page_size: 25, # Integer | Page size page_number: 1, # Integer | Page number name: "name_example", # String | Name site_id: "site_id_example", # String | Filter by site.id edge_group_id: "edge_group_id_example", # String | Filter by edgeGroup.id sort_by: "name" # String | Sort by } begin #Get the list of edges. result = api_instance.get_providers_edges(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **name** | **String**| Name | [optional] **site_id** | **String**| Filter by site.id | [optional] **edge_group_id** | **String**| Filter by edgeGroup.id | [optional] **sort_by** | **String**| Sort by | [optional] [default to name] {: class="table table-striped"} ### Return type [**EdgeEntityListing**](EdgeEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**AvailableLanguageList**](AvailableLanguageList.html) get_providers_edges_availablelanguages Get the list of available languages. ### 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 begin #Get the list of available languages. result = api_instance.get_providers_edges_availablelanguages p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_availablelanguages: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**AvailableLanguageList**](AvailableLanguageList.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CertificateAuthorityEntityListing**](CertificateAuthorityEntityListing.html) get_providers_edges_certificateauthorities Get the list of certificate authorities. ### 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 begin #Get the list of certificate authorities. result = api_instance.get_providers_edges_certificateauthorities p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_certificateauthorities: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**CertificateAuthorityEntityListing**](CertificateAuthorityEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DomainCertificateAuthority**](DomainCertificateAuthority.html) get_providers_edges_certificateauthorities_certificate_id(certificate_id) Get a certificate authority. ### 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 certificate_id = "certificate_id_example" # String | Certificate ID begin #Get a certificate authority. result = api_instance.get_providers_edges_certificateauthorities_certificate_id(certificate_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_certificateauthorities_certificate_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **certificate_id** | **String**| Certificate ID | {: class="table table-striped"} ### Return type [**DomainCertificateAuthority**](DomainCertificateAuthority.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DIDPoolEntityListing**](DIDPoolEntityListing.html) get_providers_edges_didpools(opts) Get a listing of DID Pools ### 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_size: 25, # Integer | Page size page_number: 1, # Integer | Page number sort_by: "number" # String | Sort by } begin #Get a listing of DID Pools result = api_instance.get_providers_edges_didpools(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_didpools: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **sort_by** | **String**| Sort by | [optional] [default to number] {: class="table table-striped"} ### Return type [**DIDPoolEntityListing**](DIDPoolEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DIDPool**](DIDPool.html) get_providers_edges_didpools_didpool_id(did_pool_id) Get a DID Pool 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 did_pool_id = "did_pool_id_example" # String | DID pool ID begin #Get a DID Pool by ID. result = api_instance.get_providers_edges_didpools_didpool_id(did_pool_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_didpools_didpool_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **did_pool_id** | **String**| DID pool ID | {: class="table table-striped"} ### Return type [**DIDPool**](DIDPool.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DIDEntityListing**](DIDEntityListing.html) get_providers_edges_dids(opts) Get a listing of DIDs ### 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_size: 25, # Integer | Page size page_number: 1, # Integer | Page number sort_by: "number", # String | Sort by sort_order: "ASC", # String | Sort order phone_number: "phone_number_example" # String | Filter by phoneNumber } begin #Get a listing of DIDs result = api_instance.get_providers_edges_dids(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_dids: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **sort_by** | **String**| Sort by | [optional] [default to number] **sort_order** | **String**| Sort order | [optional] [default to ASC] **phone_number** | **String**| Filter by phoneNumber | [optional] {: class="table table-striped"} ### Return type [**DIDEntityListing**](DIDEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DID**](DID.html) get_providers_edges_dids_did_id(did_id) Get a DID 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 did_id = "did_id_example" # String | DID ID begin #Get a DID by ID. result = api_instance.get_providers_edges_dids_did_id(did_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_dids_did_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **did_id** | **String**| DID ID | {: class="table table-striped"} ### Return type [**DID**](DID.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Edge**](Edge.html) get_providers_edges_edge_id(edge_id) Get 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 edge. result = api_instance.get_providers_edges_edge_id(edge_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | {: class="table table-striped"} ### Return type [**Edge**](Edge.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EdgeLineEntityListing**](EdgeLineEntityListing.html) get_providers_edges_edge_id_lines(edge_id, opts) Get the list of lines. ### 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 = { page_size: 25, # Integer | Page size page_number: 1 # Integer | Page number } begin #Get the list of lines. result = api_instance.get_providers_edges_edge_id_lines(edge_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_lines: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] {: class="table table-striped"} ### Return type [**EdgeLineEntityListing**](EdgeLineEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EdgeLine**](EdgeLine.html) get_providers_edges_edge_id_lines_line_id(edge_id, line_id) Get line ### 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 line_id = "line_id_example" # String | Line ID begin #Get line result = api_instance.get_providers_edges_edge_id_lines_line_id(edge_id, line_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_lines_line_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **line_id** | **String**| Line ID | {: class="table table-striped"} ### Return type [**EdgeLine**](EdgeLine.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**LogicalInterfaceEntityListing**](LogicalInterfaceEntityListing.html) get_providers_edges_edge_id_logicalinterfaces(edge_id) Get edge logical interfaces. Retrieve a list of all configured logical interfaces from a specific 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 edge logical interfaces. result = api_instance.get_providers_edges_edge_id_logicalinterfaces(edge_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_logicalinterfaces: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | {: class="table table-striped"} ### Return type [**LogicalInterfaceEntityListing**](LogicalInterfaceEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DomainLogicalInterface**](DomainLogicalInterface.html) get_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id) Get an edge logical interface ### 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 interface_id = "interface_id_example" # String | Interface ID begin #Get an edge logical interface result = api_instance.get_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_logicalinterfaces_interface_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **interface_id** | **String**| Interface ID | {: class="table table-striped"} ### Return type [**DomainLogicalInterface**](DomainLogicalInterface.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EdgeLogsJob**](EdgeLogsJob.html) get_providers_edges_edge_id_logs_jobs_job_id(edge_id, job_id) Get an Edge logs job. ### 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 job_id = "job_id_example" # String | Job ID begin #Get an Edge logs job. result = api_instance.get_providers_edges_edge_id_logs_jobs_job_id(edge_id, job_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_logs_jobs_job_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **job_id** | **String**| Job ID | {: class="table table-striped"} ### Return type [**EdgeLogsJob**](EdgeLogsJob.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**PhysicalInterfaceEntityListing**](PhysicalInterfaceEntityListing.html) get_providers_edges_edge_id_physicalinterfaces(edge_id) Retrieve a list of all configured physical interfaces from a specific 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 #Retrieve a list of all configured physical interfaces from a specific edge. result = api_instance.get_providers_edges_edge_id_physicalinterfaces(edge_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_physicalinterfaces: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | {: class="table table-striped"} ### Return type [**PhysicalInterfaceEntityListing**](PhysicalInterfaceEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DomainPhysicalInterface**](DomainPhysicalInterface.html) get_providers_edges_edge_id_physicalinterfaces_interface_id(edge_id, interface_id) Get edge physical interface. Retrieve a physical interface from a specific 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 interface_id = "interface_id_example" # String | Interface ID begin #Get edge physical interface. result = api_instance.get_providers_edges_edge_id_physicalinterfaces_interface_id(edge_id, interface_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_physicalinterfaces_interface_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **interface_id** | **String**| Interface ID | {: class="table table-striped"} ### Return type [**DomainPhysicalInterface**](DomainPhysicalInterface.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html) get_providers_edges_edge_id_softwareupdate(edge_id) Gets software update status information about any 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 #Gets software update status information about any edge. result = api_instance.get_providers_edges_edge_id_softwareupdate(edge_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_softwareupdate: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | {: class="table table-striped"} ### Return type [**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DomainEdgeSoftwareVersionDto**](DomainEdgeSoftwareVersionDto.html) get_providers_edges_edge_id_softwareversions(edge_id) Gets all the available software versions for this 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 #Gets all the available software versions for this edge. result = api_instance.get_providers_edges_edge_id_softwareversions(edge_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_softwareversions: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | {: class="table table-striped"} ### Return type [**DomainEdgeSoftwareVersionDto**](DomainEdgeSoftwareVersionDto.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EdgeGroupEntityListing**](EdgeGroupEntityListing.html) get_providers_edges_edgegroups(opts) Get the list of edge groups. ### 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_size: 25, # Integer | Page size page_number: 1, # Integer | Page number name: "name_example", # String | Name sort_by: "name" # String | Sort by } begin #Get the list of edge groups. result = api_instance.get_providers_edges_edgegroups(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edgegroups: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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 [**EdgeGroupEntityListing**](EdgeGroupEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EdgeGroup**](EdgeGroup.html) get_providers_edges_edgegroups_edgegroup_id(edge_group_id) Get 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 edge_group_id = "edge_group_id_example" # String | Edge group ID begin #Get edge group. result = api_instance.get_providers_edges_edgegroups_edgegroup_id(edge_group_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edgegroups_edgegroup_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_group_id** | **String**| Edge group ID | {: class="table table-striped"} ### Return type [**EdgeGroup**](EdgeGroup.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EdgeVersionReport**](EdgeVersionReport.html) get_providers_edges_edgeversionreport Get the edge version report. The report will not have consistent data about the edge version(s) until all edges have been reset. ### 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 begin #Get the edge version report. result = api_instance.get_providers_edges_edgeversionreport p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edgeversionreport: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**EdgeVersionReport**](EdgeVersionReport.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EndpointEntityListing**](EndpointEntityListing.html) get_providers_edges_endpoints(opts) Get endpoints ### 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_size: 25, # Integer | Page size page_number: 1, # Integer | Page number name: "name_example", # String | Name sort_by: "name" # String | Sort by } begin #Get endpoints result = api_instance.get_providers_edges_endpoints(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_endpoints: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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 [**EndpointEntityListing**](EndpointEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Endpoint**](Endpoint.html) get_providers_edges_endpoints_endpoint_id(endpoint_id) Get endpoint ### 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 endpoint_id = "endpoint_id_example" # String | Endpoint ID begin #Get endpoint result = api_instance.get_providers_edges_endpoints_endpoint_id(endpoint_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_endpoints_endpoint_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **endpoint_id** | **String**| Endpoint ID | {: class="table table-striped"} ### Return type [**Endpoint**](Endpoint.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ExtensionPoolEntityListing**](ExtensionPoolEntityListing.html) get_providers_edges_extensionpools(opts) Get a listing of extension pools ### 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_size: 25, # Integer | Page size page_number: 1, # Integer | Page number sort_by: "startNumber", # String | Sort by number: "number_example" # String | Number } begin #Get a listing of extension pools result = api_instance.get_providers_edges_extensionpools(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_extensionpools: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **sort_by** | **String**| Sort by | [optional] [default to startNumber] **number** | **String**| Number | [optional] {: class="table table-striped"} ### Return type [**ExtensionPoolEntityListing**](ExtensionPoolEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ExtensionPool**](ExtensionPool.html) get_providers_edges_extensionpools_extensionpool_id(extension_pool_id) Get an extension pool 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 extension_pool_id = "extension_pool_id_example" # String | Extension pool ID begin #Get an extension pool by ID result = api_instance.get_providers_edges_extensionpools_extensionpool_id(extension_pool_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_extensionpools_extensionpool_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **extension_pool_id** | **String**| Extension pool ID | {: class="table table-striped"} ### Return type [**ExtensionPool**](ExtensionPool.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ExtensionEntityListing**](ExtensionEntityListing.html) get_providers_edges_extensions(opts) Get a listing of extensions ### 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_size: 25, # Integer | Page size page_number: 1, # Integer | Page number sort_by: "number", # String | Sort by sort_order: "ASC", # String | Sort order number: "number_example" # String | Filter by number } begin #Get a listing of extensions result = api_instance.get_providers_edges_extensions(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_extensions: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **sort_by** | **String**| Sort by | [optional] [default to number] **sort_order** | **String**| Sort order | [optional] [default to ASC] **number** | **String**| Filter by number | [optional] {: class="table table-striped"} ### Return type [**ExtensionEntityListing**](ExtensionEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Extension**](Extension.html) get_providers_edges_extensions_extension_id(extension_id) Get an extension 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 extension_id = "extension_id_example" # String | Extension ID begin #Get an extension by ID. result = api_instance.get_providers_edges_extensions_extension_id(extension_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_extensions_extension_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **extension_id** | **String**| Extension ID | {: class="table table-striped"} ### Return type [**Extension**](Extension.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**LineBaseEntityListing**](LineBaseEntityListing.html) get_providers_edges_linebasesettings(opts) Get a listing of line base settings objects ### 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 } begin #Get a listing of line base settings objects result = api_instance.get_providers_edges_linebasesettings(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_linebasesettings: #{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] {: class="table table-striped"} ### Return type [**LineBaseEntityListing**](LineBaseEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**LineBase**](LineBase.html) get_providers_edges_linebasesettings_linebase_id(line_base_id) Get a line base settings object 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 line_base_id = "line_base_id_example" # String | Line base ID begin #Get a line base settings object by ID result = api_instance.get_providers_edges_linebasesettings_linebase_id(line_base_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_linebasesettings_linebase_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **line_base_id** | **String**| Line base ID | {: class="table table-striped"} ### Return type [**LineBase**](LineBase.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**LineEntityListing**](LineEntityListing.html) get_providers_edges_lines(opts) Get a list of Lines ### 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_size: 25, # Integer | Page size page_number: 1, # Integer | Page number name: "name_example", # String | Name sort_by: "name", # String | Value by which to sort expand: ["expand_example"] # Array | Fields to expand in the response, comma-separated } begin #Get a list of Lines result = api_instance.get_providers_edges_lines(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_lines: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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**| Value by which to sort | [optional] [default to name] **expand** | [**Array<String>**](String.html)| Fields to expand in the response, comma-separated | [optional] {: class="table table-striped"} ### Return type [**LineEntityListing**](LineEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Line**](Line.html) get_providers_edges_lines_line_id(line_id) Get a Line 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 line_id = "line_id_example" # String | Line ID begin #Get a Line by ID result = api_instance.get_providers_edges_lines_line_id(line_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_lines_line_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **line_id** | **String**| Line ID | {: class="table table-striped"} ### Return type [**Line**](Line.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Line**](Line.html) get_providers_edges_lines_template(line_base_settings_id) 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 ### 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 line_base_settings_id = "line_base_settings_id_example" # String | The id of a Line Base Settings object upon which to base this Line begin #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 result = api_instance.get_providers_edges_lines_template(line_base_settings_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_lines_template: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **line_base_settings_id** | **String**| The id of a Line Base Settings object upon which to base this Line | {: class="table table-striped"} ### Return type [**Line**](Line.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**OutboundRouteEntityListing**](OutboundRouteEntityListing.html) get_providers_edges_outboundroutes(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 opts = { page_size: 25, # Integer | Page size page_number: 1, # Integer | Page number name: "name_example", # String | Name site_id: "site_id_example", # String | Filter by site.id sort_by: "name" # String | Sort by } begin #Get outbound routes result = api_instance.get_providers_edges_outboundroutes(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_outboundroutes: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **name** | **String**| Name | [optional] **site_id** | **String**| Filter by site.id | [optional] **sort_by** | **String**| Sort by | [optional] [default to name] {: class="table table-striped"} ### Return type [**OutboundRouteEntityListing**](OutboundRouteEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**OutboundRoute**](OutboundRoute.html) get_providers_edges_outboundroutes_outboundroute_id(outbound_route_id) Get 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 #Get outbound route result = api_instance.get_providers_edges_outboundroutes_outboundroute_id(outbound_route_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_outboundroutes_outboundroute_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **outbound_route_id** | **String**| Outbound route ID | {: class="table table-striped"} ### Return type [**OutboundRoute**](OutboundRoute.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**PhoneBaseEntityListing**](PhoneBaseEntityListing.html) get_providers_edges_phonebasesettings(opts) Get a list of Phone Base Settings objects ### 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 } begin #Get a list of Phone Base Settings objects result = api_instance.get_providers_edges_phonebasesettings(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_phonebasesettings: #{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] {: class="table table-striped"} ### Return type [**PhoneBaseEntityListing**](PhoneBaseEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**PhoneMetaBaseEntityListing**](PhoneMetaBaseEntityListing.html) get_providers_edges_phonebasesettings_availablemetabases(opts) Get a list of available makes and models to create a new Phone Base 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 opts = { page_size: 25, # Integer | Page size page_number: 1 # Integer | Page number } begin #Get a list of available makes and models to create a new Phone Base Settings result = api_instance.get_providers_edges_phonebasesettings_availablemetabases(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_phonebasesettings_availablemetabases: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] {: class="table table-striped"} ### Return type [**PhoneMetaBaseEntityListing**](PhoneMetaBaseEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**PhoneBase**](PhoneBase.html) get_providers_edges_phonebasesettings_phonebase_id(phone_base_id) Get a Phone Base Settings object 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 phone_base_id = "phone_base_id_example" # String | Phone base ID begin #Get a Phone Base Settings object by ID result = api_instance.get_providers_edges_phonebasesettings_phonebase_id(phone_base_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_phonebasesettings_phonebase_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **phone_base_id** | **String**| Phone base ID | {: class="table table-striped"} ### Return type [**PhoneBase**](PhoneBase.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**PhoneBase**](PhoneBase.html) get_providers_edges_phonebasesettings_template(phone_metabase_id) Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance ### 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 phone_metabase_id = "phone_metabase_id_example" # String | The id of a metabase object upon which to base this Phone Base Settings begin #Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance result = api_instance.get_providers_edges_phonebasesettings_template(phone_metabase_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_phonebasesettings_template: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **phone_metabase_id** | **String**| The id of a metabase object upon which to base this Phone Base Settings | {: class="table table-striped"} ### Return type [**PhoneBase**](PhoneBase.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**PhoneEntityListing**](PhoneEntityListing.html) get_providers_edges_phones(opts) Get a list of Phone Instances ### 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 site_id: "site_id_example", # String | Filter by site.id web_rtc_user_id: "web_rtc_user_id_example", # String | Filter by webRtcUser.id phone_base_settings_id: "phone_base_settings_id_example", # String | Filter by phoneBaseSettings.id lines_logged_in_user_id: "lines_logged_in_user_id_example", # String | Filter by lines.loggedInUser.id phone_hardware_id: "phone_hardware_id_example", # String | Filter by phone_hardwareId lines_id: "lines_id_example", # String | Filter by lines.id lines_name: "lines_name_example", # String | Filter by lines.name expand: ["expand_example"], # Array | Fields to expand in the response, comma-separated fields: ["fields_example"] # Array | Fields and properties to get, comma-separated } begin #Get a list of Phone Instances result = api_instance.get_providers_edges_phones(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_phones: #{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] **site_id** | **String**| Filter by site.id | [optional] **web_rtc_user_id** | **String**| Filter by webRtcUser.id | [optional] **phone_base_settings_id** | **String**| Filter by phoneBaseSettings.id | [optional] **lines_logged_in_user_id** | **String**| Filter by lines.loggedInUser.id | [optional] **phone_hardware_id** | **String**| Filter by phone_hardwareId | [optional] **lines_id** | **String**| Filter by lines.id | [optional] **lines_name** | **String**| Filter by lines.name | [optional] **expand** | [**Array<String>**](String.html)| Fields to expand in the response, comma-separated | [optional] **fields** | [**Array<String>**](String.html)| Fields and properties to get, comma-separated | [optional] {: class="table table-striped"} ### Return type [**PhoneEntityListing**](PhoneEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Phone**](Phone.html) get_providers_edges_phones_phone_id(phone_id) Get a Phone 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 phone_id = "phone_id_example" # String | Phone ID begin #Get a Phone by ID result = api_instance.get_providers_edges_phones_phone_id(phone_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_phones_phone_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **phone_id** | **String**| Phone ID | {: class="table table-striped"} ### Return type [**Phone**](Phone.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Phone**](Phone.html) get_providers_edges_phones_template(phone_base_settings_id) Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance ### 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 phone_base_settings_id = "phone_base_settings_id_example" # String | The id of a Phone Base Settings object upon which to base this Phone begin #Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance result = api_instance.get_providers_edges_phones_template(phone_base_settings_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_phones_template: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **phone_base_settings_id** | **String**| The id of a Phone Base Settings object upon which to base this Phone | {: class="table table-striped"} ### Return type [**Phone**](Phone.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**SiteEntityListing**](SiteEntityListing.html) get_providers_edges_sites(opts) Get the list of Sites. ### 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_size: 25, # Integer | Page size page_number: 1, # Integer | Page number sort_by: "name", # String | Sort by sort_order: "ASC", # String | Sort order name: "name_example", # String | Name location_id: "location_id_example" # String | Location Id } begin #Get the list of Sites. result = api_instance.get_providers_edges_sites(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_sites: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **sort_by** | **String**| Sort by | [optional] [default to name] **sort_order** | **String**| Sort order | [optional] [default to ASC] **name** | **String**| Name | [optional] **location_id** | **String**| Location Id | [optional] {: class="table table-striped"} ### Return type [**SiteEntityListing**](SiteEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Site**](Site.html) get_providers_edges_sites_site_id(site_id) Get a Site 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 site_id = "site_id_example" # String | Site ID begin #Get a Site by ID. result = api_instance.get_providers_edges_sites_site_id(site_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_sites_site_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **site_id** | **String**| Site ID | {: class="table table-striped"} ### Return type [**Site**](Site.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Array<NumberPlan>**](NumberPlan.html) get_providers_edges_sites_site_id_numberplans(site_id) Get the list of Number Plans for this Site. ### 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 begin #Get the list of Number Plans for this Site. result = api_instance.get_providers_edges_sites_site_id_numberplans(site_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_sites_site_id_numberplans: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **site_id** | **String**| Site ID | {: class="table table-striped"} ### Return type [**Array<NumberPlan>**](NumberPlan.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -Array<String>** get_providers_edges_sites_site_id_numberplans_classifications(site_id, opts) Get a list of Classifications for this Site ### 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 = { classification: "classification_example" # String | Classification } begin #Get a list of Classifications for this Site result = api_instance.get_providers_edges_sites_site_id_numberplans_classifications(site_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_sites_site_id_numberplans_classifications: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **site_id** | **String**| Site ID | **classification** | **String**| Classification | [optional] {: class="table table-striped"} ### Return type **Array<String>** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**NumberPlan**](NumberPlan.html) get_providers_edges_sites_site_id_numberplans_numberplan_id(site_id, number_plan_id) Get a Number Plan 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 site_id = "site_id_example" # String | Site ID number_plan_id = "number_plan_id_example" # String | Number Plan ID begin #Get a Number Plan by ID. result = api_instance.get_providers_edges_sites_site_id_numberplans_numberplan_id(site_id, number_plan_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_sites_site_id_numberplans_numberplan_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **site_id** | **String**| Site ID | **number_plan_id** | **String**| Number Plan ID | {: class="table table-striped"} ### Return type [**NumberPlan**](NumberPlan.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**TimeZoneEntityListing**](TimeZoneEntityListing.html) get_providers_edges_timezones(opts) Get a list of Edge-compatible time zones ### 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_size: 1000, # Integer | Page size page_number: 1 # Integer | Page number } begin #Get a list of Edge-compatible time zones result = api_instance.get_providers_edges_timezones(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_timezones: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 1000] **page_number** | **Integer**| Page number | [optional] [default to 1] {: class="table table-striped"} ### Return type [**TimeZoneEntityListing**](TimeZoneEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**TrunkBase**](TrunkBase.html) get_providers_edges_trunkbasesettings(opts) Get Trunk Base Settings listing ### 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 recording_enabled: true # BOOLEAN | Filter trunks by recording enabled } begin #Get Trunk Base Settings listing result = api_instance.get_providers_edges_trunkbasesettings(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunkbasesettings: #{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] **recording_enabled** | **BOOLEAN**| Filter trunks by recording enabled | [optional] {: class="table table-striped"} ### Return type [**TrunkBase**](TrunkBase.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**TrunkMetabaseEntityListing**](TrunkMetabaseEntityListing.html) get_providers_edges_trunkbasesettings_availablemetabases(opts) Get a list of available makes and models to create a new Trunk Base 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 opts = { type: "type_example", # String | page_size: 25, # Integer | page_number: 1 # Integer | } begin #Get a list of available makes and models to create a new Trunk Base Settings result = api_instance.get_providers_edges_trunkbasesettings_availablemetabases(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunkbasesettings_availablemetabases: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **type** | **String**| | [optional] **page_size** | **Integer**| | [optional] [default to 25] **page_number** | **Integer**| | [optional] [default to 1] {: class="table table-striped"} ### Return type [**TrunkMetabaseEntityListing**](TrunkMetabaseEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**TrunkBase**](TrunkBase.html) get_providers_edges_trunkbasesettings_template(trunk_metabase_id) 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 ### 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_metabase_id = "trunk_metabase_id_example" # String | The id of a metabase object upon which to base this Trunk Base Settings begin #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 result = api_instance.get_providers_edges_trunkbasesettings_template(trunk_metabase_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunkbasesettings_template: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **trunk_metabase_id** | **String**| The id of a metabase object upon which to base this Trunk Base Settings | {: class="table table-striped"} ### Return type [**TrunkBase**](TrunkBase.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**TrunkBase**](TrunkBase.html) get_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id) Get a Trunk Base Settings object 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_base_settings_id = "trunk_base_settings_id_example" # String | Trunk Base ID begin #Get a Trunk Base Settings object by ID result = api_instance.get_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunkbasesettings_trunkbasesettings_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **trunk_base_settings_id** | **String**| Trunk Base ID | {: class="table table-striped"} ### Return type [**TrunkBase**](TrunkBase.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**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 ## -[**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 ## -[**TrunkRecordingEnabledCount**](TrunkRecordingEnabledCount.html) get_providers_edges_trunkswithrecording(opts) Get Counts of trunks that have recording disabled or enabled ### 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 = { trunk_type: "trunk_type_example" # String | The type of this trunk base. } begin #Get Counts of trunks that have recording disabled or enabled result = api_instance.get_providers_edges_trunkswithrecording(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunkswithrecording: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **trunk_type** | **String**| The type of this trunk base. | [optional] {: class="table table-striped"} ### Return type [**TrunkRecordingEnabledCount**](TrunkRecordingEnabledCount.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**SchemaCategoryEntityListing**](SchemaCategoryEntityListing.html) get_schemas_edges_vnext(opts) Lists available schema categories ### 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_size: 25, # Integer | Page size page_number: 1 # Integer | Page number } begin #Lists available schema categories result = api_instance.get_schemas_edges_vnext(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_schemas_edges_vnext: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] {: class="table table-striped"} ### Return type [**SchemaCategoryEntityListing**](SchemaCategoryEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**SchemaReferenceEntityListing**](SchemaReferenceEntityListing.html) get_schemas_edges_vnext_schemacategory(schema_category, opts) List schemas of a specific category ### 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 schema_category = "schema_category_example" # String | Schema category opts = { page_size: 25, # Integer | Page size page_number: 1 # Integer | Page number } begin #List schemas of a specific category result = api_instance.get_schemas_edges_vnext_schemacategory(schema_category, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_schemas_edges_vnext_schemacategory: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **schema_category** | **String**| Schema category | **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] {: class="table table-striped"} ### Return type [**SchemaReferenceEntityListing**](SchemaReferenceEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**SchemaReferenceEntityListing**](SchemaReferenceEntityListing.html) get_schemas_edges_vnext_schemacategory_schematype(schema_category, schema_type, opts) List schemas of a specific category ### 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 schema_category = "schema_category_example" # String | Schema category schema_type = "schema_type_example" # String | Schema type opts = { page_size: 25, # Integer | Page size page_number: 1 # Integer | Page number } begin #List schemas of a specific category result = api_instance.get_schemas_edges_vnext_schemacategory_schematype(schema_category, schema_type, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_schemas_edges_vnext_schemacategory_schematype: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **schema_category** | **String**| Schema category | **schema_type** | **String**| Schema type | **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] {: class="table table-striped"} ### Return type [**SchemaReferenceEntityListing**](SchemaReferenceEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Organization**](Organization.html) get_schemas_edges_vnext_schemacategory_schematype_schema_id(schema_category, schema_type, schema_id) Get a json schema ### 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 schema_category = "schema_category_example" # String | Schema category schema_type = "schema_type_example" # String | Schema type schema_id = "schema_id_example" # String | Schema ID begin #Get a json schema result = api_instance.get_schemas_edges_vnext_schemacategory_schematype_schema_id(schema_category, schema_type, schema_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->get_schemas_edges_vnext_schemacategory_schematype_schema_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **schema_category** | **String**| Schema category | **schema_type** | **String**| Schema type | **schema_id** | **String**| Schema ID | {: class="table table-striped"} ### Return type [**Organization**](Organization.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**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 ### 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 schema_category = "schema_category_example" # String | Schema category schema_type = "schema_type_example" # String | Schema type schema_id = "schema_id_example" # String | Schema ID 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_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_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_type** | **String**| extension | **metadata_id** | **String**| Metadata ID | **type** | **String**| Type | [optional] {: class="table table-striped"} ### Return type [**Organization**](Organization.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Edge**](Edge.html) post_providers_edges(body) Create a 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 body = PureCloud::Edge.new # Edge | Edge begin #Create a edge. result = api_instance.post_providers_edges(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Edge**](Edge.html)| Edge | {: class="table table-striped"} ### Return type [**Edge**](Edge.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ValidateAddressResponse**](ValidateAddressResponse.html) post_providers_edges_addressvalidation(body) Validates a street address ### 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::ValidateAddressRequest.new # ValidateAddressRequest | Address begin #Validates a street address result = api_instance.post_providers_edges_addressvalidation(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_addressvalidation: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**ValidateAddressRequest**](ValidateAddressRequest.html)| Address | {: class="table table-striped"} ### Return type [**ValidateAddressResponse**](ValidateAddressResponse.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DomainCertificateAuthority**](DomainCertificateAuthority.html) post_providers_edges_certificateauthorities(body) Create a certificate authority. ### 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::DomainCertificateAuthority.new # DomainCertificateAuthority | CertificateAuthority begin #Create a certificate authority. result = api_instance.post_providers_edges_certificateauthorities(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_certificateauthorities: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**DomainCertificateAuthority**](DomainCertificateAuthority.html)| CertificateAuthority | {: class="table table-striped"} ### Return type [**DomainCertificateAuthority**](DomainCertificateAuthority.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DIDPool**](DIDPool.html) post_providers_edges_didpools(body) Create a new DID pool ### 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::DIDPool.new # DIDPool | DID pool begin #Create a new DID pool result = api_instance.post_providers_edges_didpools(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_didpools: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**DIDPool**](DIDPool.html)| DID pool | {: class="table table-striped"} ### Return type [**DIDPool**](DIDPool.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DomainLogicalInterface**](DomainLogicalInterface.html) post_providers_edges_edge_id_logicalinterfaces(edge_id, body) Create an edge logical interface. Create ### 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 body = PureCloud::DomainLogicalInterface.new # DomainLogicalInterface | Logical interface begin #Create an edge logical interface. result = api_instance.post_providers_edges_edge_id_logicalinterfaces(edge_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_edge_id_logicalinterfaces: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **body** | [**DomainLogicalInterface**](DomainLogicalInterface.html)| Logical interface | {: class="table table-striped"} ### Return type [**DomainLogicalInterface**](DomainLogicalInterface.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EdgeLogsJobResponse**](EdgeLogsJobResponse.html) post_providers_edges_edge_id_logs_jobs(edge_id, body) Create a job to upload a list of Edge logs. ### 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 body = PureCloud::EdgeLogsJobRequest.new # EdgeLogsJobRequest | EdgeLogsJobRequest begin #Create a job to upload a list of Edge logs. result = api_instance.post_providers_edges_edge_id_logs_jobs(edge_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_edge_id_logs_jobs: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **body** | [**EdgeLogsJobRequest**](EdgeLogsJobRequest.html)| EdgeLogsJobRequest | {: class="table table-striped"} ### Return type [**EdgeLogsJobResponse**](EdgeLogsJobResponse.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - post_providers_edges_edge_id_logs_jobs_job_id_upload(edge_id, job_id, body) Request that the specified fileIds be uploaded from the 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 job_id = "job_id_example" # String | Job ID body = PureCloud::EdgeLogsJobUploadRequest.new # EdgeLogsJobUploadRequest | Log upload request begin #Request that the specified fileIds be uploaded from the Edge. api_instance.post_providers_edges_edge_id_logs_jobs_job_id_upload(edge_id, job_id, body) rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_edge_id_logs_jobs_job_id_upload: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **job_id** | **String**| Job ID | **body** | [**EdgeLogsJobUploadRequest**](EdgeLogsJobUploadRequest.html)| Log upload request | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** post_providers_edges_edge_id_reboot(edge_id) Reboot an 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 #Reboot an Edge result = api_instance.post_providers_edges_edge_id_reboot(edge_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_edge_id_reboot: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html) post_providers_edges_edge_id_softwareupdate(edge_id, body) Starts a software update for this 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 body = PureCloud::DomainEdgeSoftwareUpdateDto.new # DomainEdgeSoftwareUpdateDto | Software update request begin #Starts a software update for this edge. result = api_instance.post_providers_edges_edge_id_softwareupdate(edge_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_edge_id_softwareupdate: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **body** | [**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html)| Software update request | {: class="table table-striped"} ### Return type [**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** post_providers_edges_edge_id_unpair(edge_id) Unpair an 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 #Unpair an Edge result = api_instance.post_providers_edges_edge_id_unpair(edge_id) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_edge_id_unpair: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge Id | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EdgeGroup**](EdgeGroup.html) post_providers_edges_edgegroups(body) Create an 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 body = PureCloud::EdgeGroup.new # EdgeGroup | EdgeGroup begin #Create an edge group. result = api_instance.post_providers_edges_edgegroups(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_edgegroups: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**EdgeGroup**](EdgeGroup.html)| EdgeGroup | {: class="table table-striped"} ### Return type [**EdgeGroup**](EdgeGroup.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Endpoint**](Endpoint.html) post_providers_edges_endpoints(body) Create endpoint ### 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::Endpoint.new # Endpoint | EndpointTemplate begin #Create endpoint result = api_instance.post_providers_edges_endpoints(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_endpoints: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Endpoint**](Endpoint.html)| EndpointTemplate | {: class="table table-striped"} ### Return type [**Endpoint**](Endpoint.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Extension**](Extension.html) post_providers_edges_extensionpools(body) Create a new extension pool ### 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::ExtensionPool.new # ExtensionPool | ExtensionPool begin #Create a new extension pool result = api_instance.post_providers_edges_extensionpools(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_extensionpools: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**ExtensionPool**](ExtensionPool.html)| ExtensionPool | {: class="table table-striped"} ### Return type [**Extension**](Extension.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**OutboundRoute**](OutboundRoute.html) post_providers_edges_outboundroutes(body) Create outbound rule ### 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::OutboundRoute.new # OutboundRoute | OutboundRoute begin #Create outbound rule result = api_instance.post_providers_edges_outboundroutes(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_outboundroutes: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OutboundRoute**](OutboundRoute.html)| OutboundRoute | {: class="table table-striped"} ### Return type [**OutboundRoute**](OutboundRoute.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**PhoneBase**](PhoneBase.html) post_providers_edges_phonebasesettings(body) Create a new Phone Base Settings object ### 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::PhoneBase.new # PhoneBase | Phone base settings begin #Create a new Phone Base Settings object result = api_instance.post_providers_edges_phonebasesettings(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_phonebasesettings: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**PhoneBase**](PhoneBase.html)| Phone base settings | {: class="table table-striped"} ### Return type [**PhoneBase**](PhoneBase.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Phone**](Phone.html) post_providers_edges_phones(body) Create a new Phone ### 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::Phone.new # Phone | Phone begin #Create a new Phone result = api_instance.post_providers_edges_phones(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_phones: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Phone**](Phone.html)| Phone | {: class="table table-striped"} ### Return type [**Phone**](Phone.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - post_providers_edges_phones_phone_id_reboot(phone_id) Reboot a Phone ### 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 phone_id = "phone_id_example" # String | Phone Id begin #Reboot a Phone api_instance.post_providers_edges_phones_phone_id_reboot(phone_id) rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_phones_phone_id_reboot: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **phone_id** | **String**| Phone Id | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - post_providers_edges_phones_reboot(body) Reboot Multiple Phones ### 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::PhonesReboot.new # PhonesReboot | Phones begin #Reboot Multiple Phones api_instance.post_providers_edges_phones_reboot(body) rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_phones_reboot: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**PhonesReboot**](PhonesReboot.html)| Phones | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Site**](Site.html) post_providers_edges_sites(body) Create a Site. ### 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::Site.new # Site | Site begin #Create a Site. result = api_instance.post_providers_edges_sites(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_sites: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Site**](Site.html)| Site | {: class="table table-striped"} ### Return type [**Site**](Site.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - post_providers_edges_sites_site_id_rebalance(site_id) Triggers the rebalance operation. ### 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 begin #Triggers the rebalance operation. api_instance.post_providers_edges_sites_site_id_rebalance(site_id) rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_sites_site_id_rebalance: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **site_id** | **String**| Site ID | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**TrunkBase**](TrunkBase.html) post_providers_edges_trunkbasesettings(body) Create a Trunk Base Settings object ### 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::TrunkBase.new # TrunkBase | Trunk base settings begin #Create a Trunk Base Settings object result = api_instance.post_providers_edges_trunkbasesettings(body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_trunkbasesettings: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**TrunkBase**](TrunkBase.html)| Trunk base settings | {: class="table table-striped"} ### Return type [**TrunkBase**](TrunkBase.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DomainCertificateAuthority**](DomainCertificateAuthority.html) put_providers_edges_certificateauthorities_certificate_id(certificate_id, body) Update a certificate authority. ### 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 certificate_id = "certificate_id_example" # String | Certificate ID body = PureCloud::DomainCertificateAuthority.new # DomainCertificateAuthority | Certificate authority begin #Update a certificate authority. result = api_instance.put_providers_edges_certificateauthorities_certificate_id(certificate_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_certificateauthorities_certificate_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **certificate_id** | **String**| Certificate ID | **body** | [**DomainCertificateAuthority**](DomainCertificateAuthority.html)| Certificate authority | {: class="table table-striped"} ### Return type [**DomainCertificateAuthority**](DomainCertificateAuthority.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DIDPool**](DIDPool.html) put_providers_edges_didpools_didpool_id(did_pool_id, body) Update a DID Pool 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 did_pool_id = "did_pool_id_example" # String | DID pool ID body = PureCloud::DIDPool.new # DIDPool | DID pool begin #Update a DID Pool by ID. result = api_instance.put_providers_edges_didpools_didpool_id(did_pool_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_didpools_didpool_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **did_pool_id** | **String**| DID pool ID | **body** | [**DIDPool**](DIDPool.html)| DID pool | {: class="table table-striped"} ### Return type [**DIDPool**](DIDPool.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DID**](DID.html) put_providers_edges_dids_did_id(did_id, body) Update a DID 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 did_id = "did_id_example" # String | DID ID body = PureCloud::DID.new # DID | DID begin #Update a DID by ID. result = api_instance.put_providers_edges_dids_did_id(did_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_dids_did_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **did_id** | **String**| DID ID | **body** | [**DID**](DID.html)| DID | {: class="table table-striped"} ### Return type [**DID**](DID.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Edge**](Edge.html) put_providers_edges_edge_id(edge_id, body) Update a 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 body = PureCloud::Edge.new # Edge | Edge begin #Update a edge. result = api_instance.put_providers_edges_edge_id(edge_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_edge_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **body** | [**Edge**](Edge.html)| Edge | {: class="table table-striped"} ### Return type [**Edge**](Edge.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EdgeLine**](EdgeLine.html) put_providers_edges_edge_id_lines_line_id(edge_id, line_id, body) Update a line. ### 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 line_id = "line_id_example" # String | Line ID body = PureCloud::EdgeLine.new # EdgeLine | Line begin #Update a line. result = api_instance.put_providers_edges_edge_id_lines_line_id(edge_id, line_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_edge_id_lines_line_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **line_id** | **String**| Line ID | **body** | [**EdgeLine**](EdgeLine.html)| Line | {: class="table table-striped"} ### Return type [**EdgeLine**](EdgeLine.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DomainLogicalInterface**](DomainLogicalInterface.html) put_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id, body) Update an edge logical interface. ### 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 interface_id = "interface_id_example" # String | Interface ID body = PureCloud::DomainLogicalInterface.new # DomainLogicalInterface | Logical interface begin #Update an edge logical interface. result = api_instance.put_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_edge_id_logicalinterfaces_interface_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_id** | **String**| Edge ID | **interface_id** | **String**| Interface ID | **body** | [**DomainLogicalInterface**](DomainLogicalInterface.html)| Logical interface | {: class="table table-striped"} ### Return type [**DomainLogicalInterface**](DomainLogicalInterface.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EdgeGroup**](EdgeGroup.html) put_providers_edges_edgegroups_edgegroup_id(edge_group_id, body) Update an 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 edge_group_id = "edge_group_id_example" # String | Edge group ID body = PureCloud::EdgeGroup.new # EdgeGroup | EdgeGroup begin #Update an edge group. result = api_instance.put_providers_edges_edgegroups_edgegroup_id(edge_group_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_edgegroups_edgegroup_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **edge_group_id** | **String**| Edge group ID | **body** | [**EdgeGroup**](EdgeGroup.html)| EdgeGroup | {: class="table table-striped"} ### Return type [**EdgeGroup**](EdgeGroup.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Endpoint**](Endpoint.html) put_providers_edges_endpoints_endpoint_id(endpoint_id, body) Update endpoint ### 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 endpoint_id = "endpoint_id_example" # String | Endpoint ID body = PureCloud::Endpoint.new # Endpoint | EndpointTemplate begin #Update endpoint result = api_instance.put_providers_edges_endpoints_endpoint_id(endpoint_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_endpoints_endpoint_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **endpoint_id** | **String**| Endpoint ID | **body** | [**Endpoint**](Endpoint.html)| EndpointTemplate | {: class="table table-striped"} ### Return type [**Endpoint**](Endpoint.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ExtensionPool**](ExtensionPool.html) put_providers_edges_extensionpools_extensionpool_id(extension_pool_id, body) Update an extension pool 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 extension_pool_id = "extension_pool_id_example" # String | Extension pool ID body = PureCloud::ExtensionPool.new # ExtensionPool | ExtensionPool begin #Update an extension pool by ID result = api_instance.put_providers_edges_extensionpools_extensionpool_id(extension_pool_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_extensionpools_extensionpool_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **extension_pool_id** | **String**| Extension pool ID | **body** | [**ExtensionPool**](ExtensionPool.html)| ExtensionPool | {: class="table table-striped"} ### Return type [**ExtensionPool**](ExtensionPool.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Extension**](Extension.html) put_providers_edges_extensions_extension_id(extension_id, body) Update an extension 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 extension_id = "extension_id_example" # String | Extension ID body = PureCloud::Extension.new # Extension | Extension begin #Update an extension by ID. result = api_instance.put_providers_edges_extensions_extension_id(extension_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_extensions_extension_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **extension_id** | **String**| Extension ID | **body** | [**Extension**](Extension.html)| Extension | {: class="table table-striped"} ### Return type [**Extension**](Extension.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**OutboundRoute**](OutboundRoute.html) put_providers_edges_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::OutboundRoute.new # OutboundRoute | OutboundRoute begin #Update outbound route result = api_instance.put_providers_edges_outboundroutes_outboundroute_id(outbound_route_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_outboundroutes_outboundroute_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **outbound_route_id** | **String**| Outbound route 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 ## -[**PhoneBase**](PhoneBase.html) put_providers_edges_phonebasesettings_phonebase_id(phone_base_id, body) Update a Phone Base Settings 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 phone_base_id = "phone_base_id_example" # String | Phone base ID body = PureCloud::PhoneBase.new # PhoneBase | Phone base settings begin #Update a Phone Base Settings by ID result = api_instance.put_providers_edges_phonebasesettings_phonebase_id(phone_base_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_phonebasesettings_phonebase_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **phone_base_id** | **String**| Phone base ID | **body** | [**PhoneBase**](PhoneBase.html)| Phone base settings | {: class="table table-striped"} ### Return type [**PhoneBase**](PhoneBase.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Phone**](Phone.html) put_providers_edges_phones_phone_id(phone_id, body) Update a Phone 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 phone_id = "phone_id_example" # String | Phone ID body = PureCloud::Phone.new # Phone | Phone begin #Update a Phone by ID result = api_instance.put_providers_edges_phones_phone_id(phone_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_phones_phone_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **phone_id** | **String**| Phone ID | **body** | [**Phone**](Phone.html)| Phone | {: class="table table-striped"} ### Return type [**Phone**](Phone.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Site**](Site.html) put_providers_edges_sites_site_id(site_id, body) Update a Site 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 site_id = "site_id_example" # String | Site ID body = PureCloud::Site.new # Site | Site begin #Update a Site by ID. result = api_instance.put_providers_edges_sites_site_id(site_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_sites_site_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **site_id** | **String**| Site ID | **body** | [**Site**](Site.html)| Site | {: class="table table-striped"} ### Return type [**Site**](Site.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Array<NumberPlan>**](NumberPlan.html) put_providers_edges_sites_site_id_numberplans(site_id, body) Update the list of Number Plans. ### 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::NumberPlan.new] # Array | List of number plans begin #Update the list of Number Plans. result = api_instance.put_providers_edges_sites_site_id_numberplans(site_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_sites_site_id_numberplans: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **site_id** | **String**| Site ID | **body** | [**Array<NumberPlan>**](NumberPlan.html)| List of number plans | {: class="table table-striped"} ### Return type [**Array<NumberPlan>**](NumberPlan.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**TrunkBase**](TrunkBase.html) put_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id, body) Update a Trunk Base Settings object 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_base_settings_id = "trunk_base_settings_id_example" # String | Trunk Base ID body = PureCloud::TrunkBase.new # TrunkBase | Trunk base settings begin #Update a Trunk Base Settings object by ID result = api_instance.put_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling TelephonyProvidersEdgeApi->put_providers_edges_trunkbasesettings_trunkbasesettings_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **trunk_base_settings_id** | **String**| Trunk Base ID | **body** | [**TrunkBase**](TrunkBase.html)| Trunk base settings | {: class="table table-striped"} ### Return type [**TrunkBase**](TrunkBase.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json