Class: PureCloud::TelephonyProvidersEdgeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/telephony_providers_edge_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TelephonyProvidersEdgeApi

Returns a new instance of TelephonyProvidersEdgeApi.



7
8
9
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 7

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#delete_providers_edges_certificateauthorities_certificate_id(certificate_id, opts = {}) ⇒ String

Delete a certificate authority.

Parameters:

  • certificate_id —

    Certificate ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


800
801
802
803
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 800

def delete_providers_edges_certificateauthorities_certificate_id(certificate_id, opts = {})
  data, status_code, headers = delete_providers_edges_certificateauthorities_certificate_id_with_http_info(certificate_id, opts)
  return data
end

#delete_providers_edges_certificateauthorities_certificate_id_with_http_info(certificate_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a certificate authority.

Parameters:

  • certificate_id —

    Certificate ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 810

def delete_providers_edges_certificateauthorities_certificate_id_with_http_info(certificate_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_certificateauthorities_certificate_id ..."
  end
  
  # verify the required parameter 'certificate_id' is set
  fail "Missing the required parameter 'certificate_id' when calling delete_providers_edges_certificateauthorities_certificate_id" if certificate_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}".sub('{format}','json').sub('{' + 'certificateId' + '}', certificate_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_certificateauthorities_certificate_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_didpools_didpool_id(did_pool_id, opts = {}) ⇒ String

Delete a DID Pool by ID.

Parameters:

  • did_pool_id —

    DID pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


1108
1109
1110
1111
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1108

def delete_providers_edges_didpools_didpool_id(did_pool_id, opts = {})
  data, status_code, headers = delete_providers_edges_didpools_didpool_id_with_http_info(did_pool_id, opts)
  return data
end

#delete_providers_edges_didpools_didpool_id_with_http_info(did_pool_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a DID Pool by ID.

Parameters:

  • did_pool_id —

    DID pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1118

def delete_providers_edges_didpools_didpool_id_with_http_info(did_pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_didpools_didpool_id ..."
  end
  
  # verify the required parameter 'did_pool_id' is set
  fail "Missing the required parameter 'did_pool_id' when calling delete_providers_edges_didpools_didpool_id" if did_pool_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/didpools/{didPoolId}".sub('{format}','json').sub('{' + 'didPoolId' + '}', did_pool_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_didpools_didpool_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_edge_id(edge_id, opts = {}) ⇒ String

Delete a edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


5384
5385
5386
5387
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5384

def delete_providers_edges_edge_id(edge_id, opts = {})
  data, status_code, headers = delete_providers_edges_edge_id_with_http_info(edge_id, opts)
  return data
end

#delete_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id, opts = {}) ⇒ nil

Delete an edge logical interface

Parameters:

  • edge_id —

    Edge ID

  • interface_id —

    Interface ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


5905
5906
5907
5908
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5905

def delete_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id, opts = {})
  delete_providers_edges_edge_id_logicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts)
  return nil
end

#delete_providers_edges_edge_id_logicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an edge logical interface

Parameters:

  • edge_id —

    Edge ID

  • interface_id —

    Interface ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5916

def delete_providers_edges_edge_id_logicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_edge_id_logicalinterfaces_interface_id ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling delete_providers_edges_edge_id_logicalinterfaces_interface_id" if edge_id.nil?
  
  # verify the required parameter 'interface_id' is set
  fail "Missing the required parameter 'interface_id' when calling delete_providers_edges_edge_id_logicalinterfaces_interface_id" if interface_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s).sub('{' + 'interfaceId' + '}', interface_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_edge_id_logicalinterfaces_interface_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_edge_id_softwareupdate(edge_id, opts = {}) ⇒ String

Cancels any in-progress update for this edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


6477
6478
6479
6480
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6477

def delete_providers_edges_edge_id_softwareupdate(edge_id, opts = {})
  data, status_code, headers = delete_providers_edges_edge_id_softwareupdate_with_http_info(edge_id, opts)
  return data
end

#delete_providers_edges_edge_id_softwareupdate_with_http_info(edge_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Cancels any in-progress update for this edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6487

def delete_providers_edges_edge_id_softwareupdate_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_edge_id_softwareupdate ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling delete_providers_edges_edge_id_softwareupdate" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/softwareupdate".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_edge_id_softwareupdate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_edge_id_with_http_info(edge_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5394

def delete_providers_edges_edge_id_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_edge_id ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling delete_providers_edges_edge_id" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_edge_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_edgegroups_edgegroup_id(edge_group_id, opts = {}) ⇒ String

Delete an edge group.

Parameters:

  • edge_group_id —

    Edge group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


1614
1615
1616
1617
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1614

def delete_providers_edges_edgegroups_edgegroup_id(edge_group_id, opts = {})
  data, status_code, headers = delete_providers_edges_edgegroups_edgegroup_id_with_http_info(edge_group_id, opts)
  return data
end

#delete_providers_edges_edgegroups_edgegroup_id_with_http_info(edge_group_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete an edge group.

Parameters:

  • edge_group_id —

    Edge group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1624

def delete_providers_edges_edgegroups_edgegroup_id_with_http_info(edge_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_edgegroups_edgegroup_id ..."
  end
  
  # verify the required parameter 'edge_group_id' is set
  fail "Missing the required parameter 'edge_group_id' when calling delete_providers_edges_edgegroups_edgegroup_id" if edge_group_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}".sub('{format}','json').sub('{' + 'edgeGroupId' + '}', edge_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_edgegroups_edgegroup_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_endpoints_endpoint_id(endpoint_id, opts = {}) ⇒ String

Delete endpoint

Parameters:

  • endpoint_id —

    Endpoint ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


1981
1982
1983
1984
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1981

def delete_providers_edges_endpoints_endpoint_id(endpoint_id, opts = {})
  data, status_code, headers = delete_providers_edges_endpoints_endpoint_id_with_http_info(endpoint_id, opts)
  return data
end

#delete_providers_edges_endpoints_endpoint_id_with_http_info(endpoint_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete endpoint

Parameters:

  • endpoint_id —

    Endpoint ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1991

def delete_providers_edges_endpoints_endpoint_id_with_http_info(endpoint_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_endpoints_endpoint_id ..."
  end
  
  # verify the required parameter 'endpoint_id' is set
  fail "Missing the required parameter 'endpoint_id' when calling delete_providers_edges_endpoints_endpoint_id" if endpoint_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/endpoints/{endpointId}".sub('{format}','json').sub('{' + 'endpointId' + '}', endpoint_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_endpoints_endpoint_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_extensionpools_extensionpool_id(extension_pool_id, opts = {}) ⇒ String

Delete an extension pool by ID

Parameters:

  • extension_pool_id —

    Extension pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


2292
2293
2294
2295
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2292

def delete_providers_edges_extensionpools_extensionpool_id(extension_pool_id, opts = {})
  data, status_code, headers = delete_providers_edges_extensionpools_extensionpool_id_with_http_info(extension_pool_id, opts)
  return data
end

#delete_providers_edges_extensionpools_extensionpool_id_with_http_info(extension_pool_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete an extension pool by ID

Parameters:

  • extension_pool_id —

    Extension pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2302

def delete_providers_edges_extensionpools_extensionpool_id_with_http_info(extension_pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_extensionpools_extensionpool_id ..."
  end
  
  # verify the required parameter 'extension_pool_id' is set
  fail "Missing the required parameter 'extension_pool_id' when calling delete_providers_edges_extensionpools_extensionpool_id" if extension_pool_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}".sub('{format}','json').sub('{' + 'extensionPoolId' + '}', extension_pool_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_extensionpools_extensionpool_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_outboundroutes_outboundroute_id(outbound_route_id, opts = {}) ⇒ String

Delete Outbound Route

Parameters:

  • outbound_route_id —

    Outbound route ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


3124
3125
3126
3127
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3124

def delete_providers_edges_outboundroutes_outboundroute_id(outbound_route_id, opts = {})
  data, status_code, headers = delete_providers_edges_outboundroutes_outboundroute_id_with_http_info(outbound_route_id, opts)
  return data
end

#delete_providers_edges_outboundroutes_outboundroute_id_with_http_info(outbound_route_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete Outbound Route

Parameters:

  • outbound_route_id —

    Outbound route ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3134

def delete_providers_edges_outboundroutes_outboundroute_id_with_http_info(outbound_route_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_outboundroutes_outboundroute_id ..."
  end
  
  # verify the required parameter 'outbound_route_id' is set
  fail "Missing the required parameter 'outbound_route_id' when calling delete_providers_edges_outboundroutes_outboundroute_id" if outbound_route_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}".sub('{format}','json').sub('{' + 'outboundRouteId' + '}', outbound_route_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_outboundroutes_outboundroute_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_phonebasesettings_phonebase_id(phone_base_id, opts = {}) ⇒ String

Delete a Phone Base Settings by ID

Parameters:

  • phone_base_id —

    Phone base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


3559
3560
3561
3562
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3559

def delete_providers_edges_phonebasesettings_phonebase_id(phone_base_id, opts = {})
  data, status_code, headers = delete_providers_edges_phonebasesettings_phonebase_id_with_http_info(phone_base_id, opts)
  return data
end

#delete_providers_edges_phonebasesettings_phonebase_id_with_http_info(phone_base_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a Phone Base Settings by ID

Parameters:

  • phone_base_id —

    Phone base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3569

def delete_providers_edges_phonebasesettings_phonebase_id_with_http_info(phone_base_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_phonebasesettings_phonebase_id ..."
  end
  
  # verify the required parameter 'phone_base_id' is set
  fail "Missing the required parameter 'phone_base_id' when calling delete_providers_edges_phonebasesettings_phonebase_id" if phone_base_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}".sub('{format}','json').sub('{' + 'phoneBaseId' + '}', phone_base_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_phonebasesettings_phonebase_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_phones_phone_id(phone_id, opts = {}) ⇒ String

Delete a Phone by ID

Parameters:

  • phone_id —

    Phone ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


4004
4005
4006
4007
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4004

def delete_providers_edges_phones_phone_id(phone_id, opts = {})
  data, status_code, headers = delete_providers_edges_phones_phone_id_with_http_info(phone_id, opts)
  return data
end

#delete_providers_edges_phones_phone_id_with_http_info(phone_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a Phone by ID

Parameters:

  • phone_id —

    Phone ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4014

def delete_providers_edges_phones_phone_id_with_http_info(phone_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_phones_phone_id ..."
  end
  
  # verify the required parameter 'phone_id' is set
  fail "Missing the required parameter 'phone_id' when calling delete_providers_edges_phones_phone_id" if phone_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phones/{phoneId}".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_phones_phone_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_sites_site_id(site_id, opts = {}) ⇒ String

Delete an ednpoint

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


4381
4382
4383
4384
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4381

def delete_providers_edges_sites_site_id(site_id, opts = {})
  data, status_code, headers = delete_providers_edges_sites_site_id_with_http_info(site_id, opts)
  return data
end

#delete_providers_edges_sites_site_id_with_http_info(site_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete an ednpoint

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4391

def delete_providers_edges_sites_site_id_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_sites_site_id ..."
  end
  
  # verify the required parameter 'site_id' is set
  fail "Missing the required parameter 'site_id' when calling delete_providers_edges_sites_site_id" if site_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/sites/{siteId}".sub('{format}','json').sub('{' + 'siteId' + '}', site_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_sites_site_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id, opts = {}) ⇒ String

Delete a Trunk Base Settings object by ID

Parameters:

  • trunk_base_settings_id —

    Trunk Base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


5199
5200
5201
5202
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5199

def delete_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id, opts = {})
  data, status_code, headers = delete_providers_edges_trunkbasesettings_trunkbasesettings_id_with_http_info(trunk_base_settings_id, opts)
  return data
end

#delete_providers_edges_trunkbasesettings_trunkbasesettings_id_with_http_info(trunk_base_settings_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a Trunk Base Settings object by ID

Parameters:

  • trunk_base_settings_id —

    Trunk Base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5209

def delete_providers_edges_trunkbasesettings_trunkbasesettings_id_with_http_info(trunk_base_settings_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_providers_edges_trunkbasesettings_trunkbasesettings_id ..."
  end
  
  # verify the required parameter 'trunk_base_settings_id' is set
  fail "Missing the required parameter 'trunk_base_settings_id' when calling delete_providers_edges_trunkbasesettings_trunkbasesettings_id" if trunk_base_settings_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}".sub('{format}','json').sub('{' + 'trunkBaseSettingsId' + '}', trunk_base_settings_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_providers_edges_trunkbasesettings_trunkbasesettings_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges(opts = {}) ⇒ EdgeEntityListing

Get the list of edges.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

  • :site_id (String) —

    Filter by site.id

  • :edge_group_id (String) —

    Filter by edgeGroup.id

  • :sort_by (String) —

    Sort by

Returns:



377
378
379
380
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 377

def get_providers_edges(opts = {})
  data, status_code, headers = get_providers_edges_with_http_info(opts)
  return data
end

#get_providers_edges_certificateauthorities(opts = {}) ⇒ CertificateAuthorityEntityListing

Get the list of certificate authorities.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



561
562
563
564
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 561

def get_providers_edges_certificateauthorities(opts = {})
  data, status_code, headers = get_providers_edges_certificateauthorities_with_http_info(opts)
  return data
end

#get_providers_edges_certificateauthorities_certificate_id(certificate_id, opts = {}) ⇒ DomainCertificateAuthority

Get a certificate authority.

Parameters:

  • certificate_id —

    Certificate ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



676
677
678
679
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 676

def get_providers_edges_certificateauthorities_certificate_id(certificate_id, opts = {})
  data, status_code, headers = get_providers_edges_certificateauthorities_certificate_id_with_http_info(certificate_id, opts)
  return data
end

#get_providers_edges_certificateauthorities_certificate_id_with_http_info(certificate_id, opts = {}) ⇒ Array<(DomainCertificateAuthority, Fixnum, Hash)>

Get a certificate authority.

Parameters:

  • certificate_id —

    Certificate ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DomainCertificateAuthority, Fixnum, Hash)>) —

    DomainCertificateAuthority data, response status code and response headers



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 686

def get_providers_edges_certificateauthorities_certificate_id_with_http_info(certificate_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_certificateauthorities_certificate_id ..."
  end
  
  # verify the required parameter 'certificate_id' is set
  fail "Missing the required parameter 'certificate_id' when calling get_providers_edges_certificateauthorities_certificate_id" if certificate_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}".sub('{format}','json').sub('{' + 'certificateId' + '}', certificate_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainCertificateAuthority')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_certificateauthorities_certificate_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_certificateauthorities_with_http_info(opts = {}) ⇒ Array<(CertificateAuthorityEntityListing, Fixnum, Hash)>

Get the list of certificate authorities.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 570

def get_providers_edges_certificateauthorities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_certificateauthorities ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/certificateauthorities".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CertificateAuthorityEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_certificateauthorities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_didpools(opts = {}) ⇒ DIDPoolEntityListing

Get a listing of DID Pools

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

Returns:



863
864
865
866
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 863

def get_providers_edges_didpools(opts = {})
  data, status_code, headers = get_providers_edges_didpools_with_http_info(opts)
  return data
end

#get_providers_edges_didpools_didpool_id(did_pool_id, opts = {}) ⇒ DIDPool

Get a DID Pool by ID.

Parameters:

  • did_pool_id —

    DID pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



984
985
986
987
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 984

def get_providers_edges_didpools_didpool_id(did_pool_id, opts = {})
  data, status_code, headers = get_providers_edges_didpools_didpool_id_with_http_info(did_pool_id, opts)
  return data
end

#get_providers_edges_didpools_didpool_id_with_http_info(did_pool_id, opts = {}) ⇒ Array<(DIDPool, Fixnum, Hash)>

Get a DID Pool by ID.

Parameters:

  • did_pool_id —

    DID pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DIDPool, Fixnum, Hash)>) —

    DIDPool data, response status code and response headers



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 994

def get_providers_edges_didpools_didpool_id_with_http_info(did_pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_didpools_didpool_id ..."
  end
  
  # verify the required parameter 'did_pool_id' is set
  fail "Missing the required parameter 'did_pool_id' when calling get_providers_edges_didpools_didpool_id" if did_pool_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/didpools/{didPoolId}".sub('{format}','json').sub('{' + 'didPoolId' + '}', did_pool_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DIDPool')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_didpools_didpool_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_didpools_with_http_info(opts = {}) ⇒ Array<(DIDPoolEntityListing, Fixnum, Hash)>

Get a listing of DID Pools

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

Returns:

  • (Array<(DIDPoolEntityListing, Fixnum, Hash)>) —

    DIDPoolEntityListing data, response status code and response headers



875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 875

def get_providers_edges_didpools_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_didpools ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/didpools".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DIDPoolEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_didpools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_dids(opts = {}) ⇒ DIDEntityListing

Get a listing of DIDs

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :phone_number (String) —

    Filter by phoneNumber

Returns:



1173
1174
1175
1176
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1173

def get_providers_edges_dids(opts = {})
  data, status_code, headers = get_providers_edges_dids_with_http_info(opts)
  return data
end

#get_providers_edges_dids_did_id(did_id, opts = {}) ⇒ DID

Get a DID by ID.

Parameters:

  • did_id —

    DID ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1240
1241
1242
1243
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1240

def get_providers_edges_dids_did_id(did_id, opts = {})
  data, status_code, headers = get_providers_edges_dids_did_id_with_http_info(did_id, opts)
  return data
end

#get_providers_edges_dids_did_id_with_http_info(did_id, opts = {}) ⇒ Array<(DID, Fixnum, Hash)>

Get a DID by ID.

Parameters:

  • did_id —

    DID ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DID, Fixnum, Hash)>) —

    DID data, response status code and response headers



1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1250

def get_providers_edges_dids_did_id_with_http_info(did_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_dids_did_id ..."
  end
  
  # verify the required parameter 'did_id' is set
  fail "Missing the required parameter 'did_id' when calling get_providers_edges_dids_did_id" if did_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/dids/{didId}".sub('{format}','json').sub('{' + 'didId' + '}', did_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DID')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_dids_did_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_dids_with_http_info(opts = {}) ⇒ Array<(DIDEntityListing, Fixnum, Hash)>

Get a listing of DIDs

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :phone_number (String) —

    Filter by phoneNumber

Returns:

  • (Array<(DIDEntityListing, Fixnum, Hash)>) —

    DIDEntityListing data, response status code and response headers



1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1187

def get_providers_edges_dids_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_dids ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/dids".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'phoneNumber'] = opts[:'phone_number'] if opts[:'phone_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DIDEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_dids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edge_id(edge_id, opts = {}) ⇒ Edge

Get edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5260
5261
5262
5263
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5260

def get_providers_edges_edge_id(edge_id, opts = {})
  data, status_code, headers = get_providers_edges_edge_id_with_http_info(edge_id, opts)
  return data
end

#get_providers_edges_edge_id_lines(edge_id, opts = {}) ⇒ EdgeLineEntityListing

Get the list of lines.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



5447
5448
5449
5450
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5447

def get_providers_edges_edge_id_lines(edge_id, opts = {})
  data, status_code, headers = get_providers_edges_edge_id_lines_with_http_info(edge_id, opts)
  return data
end

#get_providers_edges_edge_id_lines_line_id(edge_id, line_id, opts = {}) ⇒ EdgeLine

Get line

Parameters:

  • edge_id —

    Edge ID

  • line_id —

    Line ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5513
5514
5515
5516
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5513

def get_providers_edges_edge_id_lines_line_id(edge_id, line_id, opts = {})
  data, status_code, headers = get_providers_edges_edge_id_lines_line_id_with_http_info(edge_id, line_id, opts)
  return data
end

#get_providers_edges_edge_id_lines_line_id_with_http_info(edge_id, line_id, opts = {}) ⇒ Array<(EdgeLine, Fixnum, Hash)>

Get line

Parameters:

  • edge_id —

    Edge ID

  • line_id —

    Line ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EdgeLine, Fixnum, Hash)>) —

    EdgeLine data, response status code and response headers



5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5524

def get_providers_edges_edge_id_lines_line_id_with_http_info(edge_id, line_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_lines_line_id ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling get_providers_edges_edge_id_lines_line_id" if edge_id.nil?
  
  # verify the required parameter 'line_id' is set
  fail "Missing the required parameter 'line_id' when calling get_providers_edges_edge_id_lines_line_id" if line_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s).sub('{' + 'lineId' + '}', line_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EdgeLine')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_lines_line_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edge_id_lines_with_http_info(edge_id, opts = {}) ⇒ Array<(EdgeLineEntityListing, Fixnum, Hash)>

Get the list of lines.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

  • (Array<(EdgeLineEntityListing, Fixnum, Hash)>) —

    EdgeLineEntityListing data, response status code and response headers



5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5459

def get_providers_edges_edge_id_lines_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_lines ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling get_providers_edges_edge_id_lines" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/lines".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EdgeLineEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_lines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edge_id_logicalinterfaces(edge_id, opts = {}) ⇒ LogicalInterfaceEntityListing

Get edge logical interfaces. Retrieve a list of all configured logical interfaces from a specific edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5646
5647
5648
5649
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5646

def get_providers_edges_edge_id_logicalinterfaces(edge_id, opts = {})
  data, status_code, headers = get_providers_edges_edge_id_logicalinterfaces_with_http_info(edge_id, opts)
  return data
end

#get_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id, opts = {}) ⇒ DomainLogicalInterface

Get an edge logical interface

Parameters:

  • edge_id —

    Edge ID

  • interface_id —

    Interface ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5771
5772
5773
5774
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5771

def get_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id, opts = {})
  data, status_code, headers = get_providers_edges_edge_id_logicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts)
  return data
end

#get_providers_edges_edge_id_logicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts = {}) ⇒ Array<(DomainLogicalInterface, Fixnum, Hash)>

Get an edge logical interface

Parameters:

  • edge_id —

    Edge ID

  • interface_id —

    Interface ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DomainLogicalInterface, Fixnum, Hash)>) —

    DomainLogicalInterface data, response status code and response headers



5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5782

def get_providers_edges_edge_id_logicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_logicalinterfaces_interface_id ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling get_providers_edges_edge_id_logicalinterfaces_interface_id" if edge_id.nil?
  
  # verify the required parameter 'interface_id' is set
  fail "Missing the required parameter 'interface_id' when calling get_providers_edges_edge_id_logicalinterfaces_interface_id" if interface_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s).sub('{' + 'interfaceId' + '}', interface_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainLogicalInterface')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_logicalinterfaces_interface_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edge_id_logicalinterfaces_with_http_info(edge_id, opts = {}) ⇒ Array<(LogicalInterfaceEntityListing, Fixnum, Hash)>

Get edge logical interfaces. Retrieve a list of all configured logical interfaces from a specific edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5656

def get_providers_edges_edge_id_logicalinterfaces_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_logicalinterfaces ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling get_providers_edges_edge_id_logicalinterfaces" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LogicalInterfaceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_logicalinterfaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edge_id_logs_jobs_job_id(edge_id, job_id, opts = {}) ⇒ EdgeLogsJob

Get an Edge logs job.

Parameters:

  • edge_id —

    Edge ID

  • job_id —

    Job ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6033
6034
6035
6036
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6033

def get_providers_edges_edge_id_logs_jobs_job_id(edge_id, job_id, opts = {})
  data, status_code, headers = get_providers_edges_edge_id_logs_jobs_job_id_with_http_info(edge_id, job_id, opts)
  return data
end

#get_providers_edges_edge_id_logs_jobs_job_id_with_http_info(edge_id, job_id, opts = {}) ⇒ Array<(EdgeLogsJob, Fixnum, Hash)>

Get an Edge logs job.

Parameters:

  • edge_id —

    Edge ID

  • job_id —

    Job ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EdgeLogsJob, Fixnum, Hash)>) —

    EdgeLogsJob data, response status code and response headers



6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6044

def get_providers_edges_edge_id_logs_jobs_job_id_with_http_info(edge_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_logs_jobs_job_id ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling get_providers_edges_edge_id_logs_jobs_job_id" if edge_id.nil?
  
  # verify the required parameter 'job_id' is set
  fail "Missing the required parameter 'job_id' when calling get_providers_edges_edge_id_logs_jobs_job_id" if job_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s).sub('{' + 'jobId' + '}', job_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EdgeLogsJob')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_logs_jobs_job_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edge_id_physicalinterfaces(edge_id, opts = {}) ⇒ PhysicalInterfaceEntityListing

Retrieve a list of all configured physical interfaces from a specific edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6165
6166
6167
6168
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6165

def get_providers_edges_edge_id_physicalinterfaces(edge_id, opts = {})
  data, status_code, headers = get_providers_edges_edge_id_physicalinterfaces_with_http_info(edge_id, opts)
  return data
end

#get_providers_edges_edge_id_physicalinterfaces_interface_id(edge_id, interface_id, opts = {}) ⇒ DomainPhysicalInterface

Get edge physical interface. Retrieve a physical interface from a specific edge.

Parameters:

  • edge_id —

    Edge ID

  • interface_id —

    Interface ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6227
6228
6229
6230
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6227

def get_providers_edges_edge_id_physicalinterfaces_interface_id(edge_id, interface_id, opts = {})
  data, status_code, headers = get_providers_edges_edge_id_physicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts)
  return data
end

#get_providers_edges_edge_id_physicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts = {}) ⇒ Array<(DomainPhysicalInterface, Fixnum, Hash)>

Get edge physical interface. Retrieve a physical interface from a specific edge.

Parameters:

  • edge_id —

    Edge ID

  • interface_id —

    Interface ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DomainPhysicalInterface, Fixnum, Hash)>) —

    DomainPhysicalInterface data, response status code and response headers



6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6238

def get_providers_edges_edge_id_physicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_physicalinterfaces_interface_id ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling get_providers_edges_edge_id_physicalinterfaces_interface_id" if edge_id.nil?
  
  # verify the required parameter 'interface_id' is set
  fail "Missing the required parameter 'interface_id' when calling get_providers_edges_edge_id_physicalinterfaces_interface_id" if interface_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s).sub('{' + 'interfaceId' + '}', interface_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainPhysicalInterface')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_physicalinterfaces_interface_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edge_id_physicalinterfaces_with_http_info(edge_id, opts = {}) ⇒ Array<(PhysicalInterfaceEntityListing, Fixnum, Hash)>

Retrieve a list of all configured physical interfaces from a specific edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6175

def get_providers_edges_edge_id_physicalinterfaces_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_physicalinterfaces ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling get_providers_edges_edge_id_physicalinterfaces" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PhysicalInterfaceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_physicalinterfaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edge_id_softwareupdate(edge_id, opts = {}) ⇒ DomainEdgeSoftwareUpdateDto

Gets software update status information about any edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6353
6354
6355
6356
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6353

def get_providers_edges_edge_id_softwareupdate(edge_id, opts = {})
  data, status_code, headers = get_providers_edges_edge_id_softwareupdate_with_http_info(edge_id, opts)
  return data
end

#get_providers_edges_edge_id_softwareupdate_with_http_info(edge_id, opts = {}) ⇒ Array<(DomainEdgeSoftwareUpdateDto, Fixnum, Hash)>

Gets software update status information about any edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6363

def get_providers_edges_edge_id_softwareupdate_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_softwareupdate ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling get_providers_edges_edge_id_softwareupdate" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/softwareupdate".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainEdgeSoftwareUpdateDto')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_softwareupdate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edge_id_softwareversions(edge_id, opts = {}) ⇒ DomainEdgeSoftwareVersionDto

Gets all the available software versions for this edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6538
6539
6540
6541
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6538

def get_providers_edges_edge_id_softwareversions(edge_id, opts = {})
  data, status_code, headers = get_providers_edges_edge_id_softwareversions_with_http_info(edge_id, opts)
  return data
end

#get_providers_edges_edge_id_softwareversions_with_http_info(edge_id, opts = {}) ⇒ Array<(DomainEdgeSoftwareVersionDto, Fixnum, Hash)>

Gets all the available software versions for this edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6548

def get_providers_edges_edge_id_softwareversions_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_softwareversions ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling get_providers_edges_edge_id_softwareversions" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/softwareversions".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainEdgeSoftwareVersionDto')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edge_id_softwareversions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edge_id_with_http_info(edge_id, opts = {}) ⇒ Array<(Edge, Fixnum, Hash)>

Get edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Edge, Fixnum, Hash)>) —

    Edge data, response status code and response headers



5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5270

def get_providers_edges_edge_id_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edge_id ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling get_providers_edges_edge_id" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Edge')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edge_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edgegroups(opts = {}) ⇒ EdgeGroupEntityListing

Get the list of edge groups.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

Returns:



1367
1368
1369
1370
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1367

def get_providers_edges_edgegroups(opts = {})
  data, status_code, headers = get_providers_edges_edgegroups_with_http_info(opts)
  return data
end

#get_providers_edges_edgegroups_edgegroup_id(edge_group_id, opts = {}) ⇒ EdgeGroup

Get edge group.

Parameters:

  • edge_group_id —

    Edge group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1490
1491
1492
1493
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1490

def get_providers_edges_edgegroups_edgegroup_id(edge_group_id, opts = {})
  data, status_code, headers = get_providers_edges_edgegroups_edgegroup_id_with_http_info(edge_group_id, opts)
  return data
end

#get_providers_edges_edgegroups_edgegroup_id_with_http_info(edge_group_id, opts = {}) ⇒ Array<(EdgeGroup, Fixnum, Hash)>

Get edge group.

Parameters:

  • edge_group_id —

    Edge group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EdgeGroup, Fixnum, Hash)>) —

    EdgeGroup data, response status code and response headers



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1500

def get_providers_edges_edgegroups_edgegroup_id_with_http_info(edge_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edgegroups_edgegroup_id ..."
  end
  
  # verify the required parameter 'edge_group_id' is set
  fail "Missing the required parameter 'edge_group_id' when calling get_providers_edges_edgegroups_edgegroup_id" if edge_group_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}".sub('{format}','json').sub('{' + 'edgeGroupId' + '}', edge_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EdgeGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edgegroups_edgegroup_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edgegroups_with_http_info(opts = {}) ⇒ Array<(EdgeGroupEntityListing, Fixnum, Hash)>

Get the list of edge groups.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

Returns:

  • (Array<(EdgeGroupEntityListing, Fixnum, Hash)>) —

    EdgeGroupEntityListing data, response status code and response headers



1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1380

def get_providers_edges_edgegroups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edgegroups ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/edgegroups".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EdgeGroupEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edgegroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_edgeversionreport(opts = {}) ⇒ EdgeVersionReport

Get the edge version report. The report will not have consistent data about the edge version(s) until all edges have been reset.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1674
1675
1676
1677
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1674

def get_providers_edges_edgeversionreport(opts = {})
  data, status_code, headers = get_providers_edges_edgeversionreport_with_http_info(opts)
  return data
end

#get_providers_edges_edgeversionreport_with_http_info(opts = {}) ⇒ Array<(EdgeVersionReport, Fixnum, Hash)>

Get the edge version report. The report will not have consistent data about the edge version(s) until all edges have been reset.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EdgeVersionReport, Fixnum, Hash)>) —

    EdgeVersionReport data, response status code and response headers



1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1683

def get_providers_edges_edgeversionreport_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_edgeversionreport ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/edgeversionreport".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EdgeVersionReport')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_edgeversionreport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_endpoints(opts = {}) ⇒ EndpointEntityListing

Get endpoints

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

Returns:



1734
1735
1736
1737
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1734

def get_providers_edges_endpoints(opts = {})
  data, status_code, headers = get_providers_edges_endpoints_with_http_info(opts)
  return data
end

#get_providers_edges_endpoints_endpoint_id(endpoint_id, opts = {}) ⇒ Endpoint

Get endpoint

Parameters:

  • endpoint_id —

    Endpoint ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1857
1858
1859
1860
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1857

def get_providers_edges_endpoints_endpoint_id(endpoint_id, opts = {})
  data, status_code, headers = get_providers_edges_endpoints_endpoint_id_with_http_info(endpoint_id, opts)
  return data
end

#get_providers_edges_endpoints_endpoint_id_with_http_info(endpoint_id, opts = {}) ⇒ Array<(Endpoint, Fixnum, Hash)>

Get endpoint

Parameters:

  • endpoint_id —

    Endpoint ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Endpoint, Fixnum, Hash)>) —

    Endpoint data, response status code and response headers



1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1867

def get_providers_edges_endpoints_endpoint_id_with_http_info(endpoint_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_endpoints_endpoint_id ..."
  end
  
  # verify the required parameter 'endpoint_id' is set
  fail "Missing the required parameter 'endpoint_id' when calling get_providers_edges_endpoints_endpoint_id" if endpoint_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/endpoints/{endpointId}".sub('{format}','json').sub('{' + 'endpointId' + '}', endpoint_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Endpoint')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_endpoints_endpoint_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_endpoints_with_http_info(opts = {}) ⇒ Array<(EndpointEntityListing, Fixnum, Hash)>

Get endpoints

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

Returns:

  • (Array<(EndpointEntityListing, Fixnum, Hash)>) —

    EndpointEntityListing data, response status code and response headers



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1747

def get_providers_edges_endpoints_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_endpoints ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/endpoints".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EndpointEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_endpoints\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_extensionpools(opts = {}) ⇒ ExtensionPoolEntityListing

Get a listing of extension pools

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :number (String) —

    Number

Returns:



2045
2046
2047
2048
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2045

def get_providers_edges_extensionpools(opts = {})
  data, status_code, headers = get_providers_edges_extensionpools_with_http_info(opts)
  return data
end

#get_providers_edges_extensionpools_extensionpool_id(extension_pool_id, opts = {}) ⇒ ExtensionPool

Get an extension pool by ID

Parameters:

  • extension_pool_id —

    Extension pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2168
2169
2170
2171
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2168

def get_providers_edges_extensionpools_extensionpool_id(extension_pool_id, opts = {})
  data, status_code, headers = get_providers_edges_extensionpools_extensionpool_id_with_http_info(extension_pool_id, opts)
  return data
end

#get_providers_edges_extensionpools_extensionpool_id_with_http_info(extension_pool_id, opts = {}) ⇒ Array<(ExtensionPool, Fixnum, Hash)>

Get an extension pool by ID

Parameters:

  • extension_pool_id —

    Extension pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ExtensionPool, Fixnum, Hash)>) —

    ExtensionPool data, response status code and response headers



2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2178

def get_providers_edges_extensionpools_extensionpool_id_with_http_info(extension_pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_extensionpools_extensionpool_id ..."
  end
  
  # verify the required parameter 'extension_pool_id' is set
  fail "Missing the required parameter 'extension_pool_id' when calling get_providers_edges_extensionpools_extensionpool_id" if extension_pool_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}".sub('{format}','json').sub('{' + 'extensionPoolId' + '}', extension_pool_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExtensionPool')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_extensionpools_extensionpool_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_extensionpools_with_http_info(opts = {}) ⇒ Array<(ExtensionPoolEntityListing, Fixnum, Hash)>

Get a listing of extension pools

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :number (String) —

    Number

Returns:

  • (Array<(ExtensionPoolEntityListing, Fixnum, Hash)>) —

    ExtensionPoolEntityListing data, response status code and response headers



2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2058

def get_providers_edges_extensionpools_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_extensionpools ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/extensionpools".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'number'] = opts[:'number'] if opts[:'number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExtensionPoolEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_extensionpools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_extensions(opts = {}) ⇒ ExtensionEntityListing

Get a listing of extensions

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :number (String) —

    Filter by number

Returns:



2357
2358
2359
2360
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2357

def get_providers_edges_extensions(opts = {})
  data, status_code, headers = get_providers_edges_extensions_with_http_info(opts)
  return data
end

#get_providers_edges_extensions_extension_id(extension_id, opts = {}) ⇒ Extension

Get an extension by ID.

Parameters:

  • extension_id —

    Extension ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2424
2425
2426
2427
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2424

def get_providers_edges_extensions_extension_id(extension_id, opts = {})
  data, status_code, headers = get_providers_edges_extensions_extension_id_with_http_info(extension_id, opts)
  return data
end

#get_providers_edges_extensions_extension_id_with_http_info(extension_id, opts = {}) ⇒ Array<(Extension, Fixnum, Hash)>

Get an extension by ID.

Parameters:

  • extension_id —

    Extension ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Extension, Fixnum, Hash)>) —

    Extension data, response status code and response headers



2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2434

def get_providers_edges_extensions_extension_id_with_http_info(extension_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_extensions_extension_id ..."
  end
  
  # verify the required parameter 'extension_id' is set
  fail "Missing the required parameter 'extension_id' when calling get_providers_edges_extensions_extension_id" if extension_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/extensions/{extensionId}".sub('{format}','json').sub('{' + 'extensionId' + '}', extension_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Extension')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_extensions_extension_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_extensions_with_http_info(opts = {}) ⇒ Array<(ExtensionEntityListing, Fixnum, Hash)>

Get a listing of extensions

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :number (String) —

    Filter by number

Returns:

  • (Array<(ExtensionEntityListing, Fixnum, Hash)>) —

    ExtensionEntityListing data, response status code and response headers



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2371

def get_providers_edges_extensions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_extensions ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/extensions".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'number'] = opts[:'number'] if opts[:'number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExtensionEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_extensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_linebasesettings(opts = {}) ⇒ LineBaseEntityListing

Get a listing of line base settings objects

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Value by which to sort

  • :sort_order (String) —

    Sort order

Returns:



2551
2552
2553
2554
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2551

def get_providers_edges_linebasesettings(opts = {})
  data, status_code, headers = get_providers_edges_linebasesettings_with_http_info(opts)
  return data
end

#get_providers_edges_linebasesettings_linebase_id(line_base_id, opts = {}) ⇒ LineBase

Get a line base settings object by ID

Parameters:

  • line_base_id —

    Line base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2616
2617
2618
2619
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2616

def get_providers_edges_linebasesettings_linebase_id(line_base_id, opts = {})
  data, status_code, headers = get_providers_edges_linebasesettings_linebase_id_with_http_info(line_base_id, opts)
  return data
end

#get_providers_edges_linebasesettings_linebase_id_with_http_info(line_base_id, opts = {}) ⇒ Array<(LineBase, Fixnum, Hash)>

Get a line base settings object by ID

Parameters:

  • line_base_id —

    Line base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LineBase, Fixnum, Hash)>) —

    LineBase data, response status code and response headers



2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2626

def get_providers_edges_linebasesettings_linebase_id_with_http_info(line_base_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_linebasesettings_linebase_id ..."
  end
  
  # verify the required parameter 'line_base_id' is set
  fail "Missing the required parameter 'line_base_id' when calling get_providers_edges_linebasesettings_linebase_id" if line_base_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}".sub('{format}','json').sub('{' + 'lineBaseId' + '}', line_base_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LineBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_linebasesettings_linebase_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_linebasesettings_with_http_info(opts = {}) ⇒ Array<(LineBaseEntityListing, Fixnum, Hash)>

Get a listing of line base settings objects

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Value by which to sort

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(LineBaseEntityListing, Fixnum, Hash)>) —

    LineBaseEntityListing data, response status code and response headers



2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2564

def get_providers_edges_linebasesettings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_linebasesettings ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/linebasesettings".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LineBaseEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_linebasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_lines(opts = {}) ⇒ LineEntityListing

Get a list of Lines

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

  • :sort_by (String) —

    Value by which to sort

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

Returns:



2681
2682
2683
2684
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2681

def get_providers_edges_lines(opts = {})
  data, status_code, headers = get_providers_edges_lines_with_http_info(opts)
  return data
end

#get_providers_edges_lines_line_id(line_id, opts = {}) ⇒ Line

Get a Line by ID

Parameters:

  • line_id —

    Line ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2810
2811
2812
2813
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2810

def get_providers_edges_lines_line_id(line_id, opts = {})
  data, status_code, headers = get_providers_edges_lines_line_id_with_http_info(line_id, opts)
  return data
end

#get_providers_edges_lines_line_id_with_http_info(line_id, opts = {}) ⇒ Array<(Line, Fixnum, Hash)>

Get a Line by ID

Parameters:

  • line_id —

    Line ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Line, Fixnum, Hash)>) —

    Line data, response status code and response headers



2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2820

def get_providers_edges_lines_line_id_with_http_info(line_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_lines_line_id ..."
  end
  
  # verify the required parameter 'line_id' is set
  fail "Missing the required parameter 'line_id' when calling get_providers_edges_lines_line_id" if line_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/lines/{lineId}".sub('{format}','json').sub('{' + 'lineId' + '}', line_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Line')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_lines_line_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_lines_template(line_base_settings_id, opts = {}) ⇒ Line

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

Parameters:

  • line_base_settings_id —

    The id of a Line Base Settings object upon which to base this Line

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2748
2749
2750
2751
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2748

def get_providers_edges_lines_template(line_base_settings_id, opts = {})
  data, status_code, headers = get_providers_edges_lines_template_with_http_info(line_base_settings_id, opts)
  return data
end

#get_providers_edges_lines_template_with_http_info(line_base_settings_id, opts = {}) ⇒ Array<(Line, Fixnum, Hash)>

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

Parameters:

  • line_base_settings_id —

    The id of a Line Base Settings object upon which to base this Line

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Line, Fixnum, Hash)>) —

    Line data, response status code and response headers



2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2758

def get_providers_edges_lines_template_with_http_info(line_base_settings_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_lines_template ..."
  end
  
  # verify the required parameter 'line_base_settings_id' is set
  fail "Missing the required parameter 'line_base_settings_id' when calling get_providers_edges_lines_template" if line_base_settings_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/lines/template".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'lineBaseSettingsId'] = line_base_settings_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Line')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_lines_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_lines_with_http_info(opts = {}) ⇒ Array<(LineEntityListing, Fixnum, Hash)>

Get a list of Lines

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

  • :sort_by (String) —

    Value by which to sort

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

Returns:

  • (Array<(LineEntityListing, Fixnum, Hash)>) —

    LineEntityListing data, response status code and response headers



2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2695

def get_providers_edges_lines_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_lines ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/lines".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LineEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_lines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_outboundroutes(opts = {}) ⇒ OutboundRouteEntityListing

Get outbound routes

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

  • :site_id (String) —

    Filter by site.id

  • :sort_by (String) —

    Sort by

Returns:



2875
2876
2877
2878
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2875

def get_providers_edges_outboundroutes(opts = {})
  data, status_code, headers = get_providers_edges_outboundroutes_with_http_info(opts)
  return data
end

#get_providers_edges_outboundroutes_outboundroute_id(outbound_route_id, opts = {}) ⇒ OutboundRoute

Get outbound route

Parameters:

  • outbound_route_id —

    Outbound route ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3000
3001
3002
3003
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3000

def get_providers_edges_outboundroutes_outboundroute_id(outbound_route_id, opts = {})
  data, status_code, headers = get_providers_edges_outboundroutes_outboundroute_id_with_http_info(outbound_route_id, opts)
  return data
end

#get_providers_edges_outboundroutes_outboundroute_id_with_http_info(outbound_route_id, opts = {}) ⇒ Array<(OutboundRoute, Fixnum, Hash)>

Get outbound route

Parameters:

  • outbound_route_id —

    Outbound route ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(OutboundRoute, Fixnum, Hash)>) —

    OutboundRoute data, response status code and response headers



3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3010

def get_providers_edges_outboundroutes_outboundroute_id_with_http_info(outbound_route_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_outboundroutes_outboundroute_id ..."
  end
  
  # verify the required parameter 'outbound_route_id' is set
  fail "Missing the required parameter 'outbound_route_id' when calling get_providers_edges_outboundroutes_outboundroute_id" if outbound_route_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}".sub('{format}','json').sub('{' + 'outboundRouteId' + '}', outbound_route_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OutboundRoute')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_outboundroutes_outboundroute_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_outboundroutes_with_http_info(opts = {}) ⇒ Array<(OutboundRouteEntityListing, Fixnum, Hash)>

Get outbound routes

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

  • :site_id (String) —

    Filter by site.id

  • :sort_by (String) —

    Sort by

Returns:

  • (Array<(OutboundRouteEntityListing, Fixnum, Hash)>) —

    OutboundRouteEntityListing data, response status code and response headers



2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2889

def get_providers_edges_outboundroutes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_outboundroutes ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/outboundroutes".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'site.id'] = opts[:'site_id'] if opts[:'site_id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OutboundRouteEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_outboundroutes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_phonebasesettings(opts = {}) ⇒ PhoneBaseEntityListing

Get a list of Phone Base Settings objects

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Value by which to sort

  • :sort_order (String) —

    Sort order

Returns:



3188
3189
3190
3191
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3188

def get_providers_edges_phonebasesettings(opts = {})
  data, status_code, headers = get_providers_edges_phonebasesettings_with_http_info(opts)
  return data
end

#get_providers_edges_phonebasesettings_availablemetabases(opts = {}) ⇒ PhoneMetaBaseEntityListing

Get a list of available makes and models to create a new Phone Base Settings

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



3312
3313
3314
3315
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3312

def get_providers_edges_phonebasesettings_availablemetabases(opts = {})
  data, status_code, headers = get_providers_edges_phonebasesettings_availablemetabases_with_http_info(opts)
  return data
end

#get_providers_edges_phonebasesettings_availablemetabases_with_http_info(opts = {}) ⇒ Array<(PhoneMetaBaseEntityListing, Fixnum, Hash)>

Get a list of available makes and models to create a new Phone Base Settings

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

  • (Array<(PhoneMetaBaseEntityListing, Fixnum, Hash)>) —

    PhoneMetaBaseEntityListing data, response status code and response headers



3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3323

def get_providers_edges_phonebasesettings_availablemetabases_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_phonebasesettings_availablemetabases ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PhoneMetaBaseEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_phonebasesettings_availablemetabases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_phonebasesettings_phonebase_id(phone_base_id, opts = {}) ⇒ PhoneBase

Get a Phone Base Settings object by ID

Parameters:

  • phone_base_id —

    Phone base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3435
3436
3437
3438
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3435

def get_providers_edges_phonebasesettings_phonebase_id(phone_base_id, opts = {})
  data, status_code, headers = get_providers_edges_phonebasesettings_phonebase_id_with_http_info(phone_base_id, opts)
  return data
end

#get_providers_edges_phonebasesettings_phonebase_id_with_http_info(phone_base_id, opts = {}) ⇒ Array<(PhoneBase, Fixnum, Hash)>

Get a Phone Base Settings object by ID

Parameters:

  • phone_base_id —

    Phone base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PhoneBase, Fixnum, Hash)>) —

    PhoneBase data, response status code and response headers



3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3445

def get_providers_edges_phonebasesettings_phonebase_id_with_http_info(phone_base_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_phonebasesettings_phonebase_id ..."
  end
  
  # verify the required parameter 'phone_base_id' is set
  fail "Missing the required parameter 'phone_base_id' when calling get_providers_edges_phonebasesettings_phonebase_id" if phone_base_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}".sub('{format}','json').sub('{' + 'phoneBaseId' + '}', phone_base_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PhoneBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_phonebasesettings_phonebase_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_phonebasesettings_template(phone_metabase_id, opts = {}) ⇒ PhoneBase

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

Parameters:

  • phone_metabase_id —

    The id of a metabase object upon which to base this Phone Base Settings

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3373
3374
3375
3376
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3373

def get_providers_edges_phonebasesettings_template(phone_metabase_id, opts = {})
  data, status_code, headers = get_providers_edges_phonebasesettings_template_with_http_info(phone_metabase_id, opts)
  return data
end

#get_providers_edges_phonebasesettings_template_with_http_info(phone_metabase_id, opts = {}) ⇒ Array<(PhoneBase, Fixnum, Hash)>

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

Parameters:

  • phone_metabase_id —

    The id of a metabase object upon which to base this Phone Base Settings

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PhoneBase, Fixnum, Hash)>) —

    PhoneBase data, response status code and response headers



3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3383

def get_providers_edges_phonebasesettings_template_with_http_info(phone_metabase_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_phonebasesettings_template ..."
  end
  
  # verify the required parameter 'phone_metabase_id' is set
  fail "Missing the required parameter 'phone_metabase_id' when calling get_providers_edges_phonebasesettings_template" if phone_metabase_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phonebasesettings/template".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'phoneMetabaseId'] = phone_metabase_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PhoneBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_phonebasesettings_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_phonebasesettings_with_http_info(opts = {}) ⇒ Array<(PhoneBaseEntityListing, Fixnum, Hash)>

Get a list of Phone Base Settings objects

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Value by which to sort

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(PhoneBaseEntityListing, Fixnum, Hash)>) —

    PhoneBaseEntityListing data, response status code and response headers



3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3201

def get_providers_edges_phonebasesettings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_phonebasesettings ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phonebasesettings".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PhoneBaseEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_phonebasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_phones(opts = {}) ⇒ PhoneEntityListing

Get a list of Phone Instances

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Value by which to sort

  • :sort_order (String) —

    Sort order

  • :site_id (String) —

    Filter by site.id

  • :phone_base_settings_id (String) —

    Filter by phoneBaseSettings.id

  • :phone_hardware_id (String) —

    Filter by phone_hardwareId

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

  • :fields (Array<String>) —

    Fields under properties to get, comma-separated

Returns:



3628
3629
3630
3631
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3628

def get_providers_edges_phones(opts = {})
  data, status_code, headers = get_providers_edges_phones_with_http_info(opts)
  return data
end

#get_providers_edges_phones_phone_id(phone_id, opts = {}) ⇒ Phone

Get a Phone by ID

Parameters:

  • phone_id —

    Phone ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3880
3881
3882
3883
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3880

def get_providers_edges_phones_phone_id(phone_id, opts = {})
  data, status_code, headers = get_providers_edges_phones_phone_id_with_http_info(phone_id, opts)
  return data
end

#get_providers_edges_phones_phone_id_with_http_info(phone_id, opts = {}) ⇒ Array<(Phone, Fixnum, Hash)>

Get a Phone by ID

Parameters:

  • phone_id —

    Phone ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Phone, Fixnum, Hash)>) —

    Phone data, response status code and response headers



3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3890

def get_providers_edges_phones_phone_id_with_http_info(phone_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_phones_phone_id ..."
  end
  
  # verify the required parameter 'phone_id' is set
  fail "Missing the required parameter 'phone_id' when calling get_providers_edges_phones_phone_id" if phone_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phones/{phoneId}".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Phone')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_phones_phone_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_phones_template(phone_base_settings_id, opts = {}) ⇒ Phone

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

Parameters:

  • phone_base_settings_id —

    The id of a Phone Base Settings object upon which to base this Phone

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3818
3819
3820
3821
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3818

def get_providers_edges_phones_template(phone_base_settings_id, opts = {})
  data, status_code, headers = get_providers_edges_phones_template_with_http_info(phone_base_settings_id, opts)
  return data
end

#get_providers_edges_phones_template_with_http_info(phone_base_settings_id, opts = {}) ⇒ Array<(Phone, Fixnum, Hash)>

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

Parameters:

  • phone_base_settings_id —

    The id of a Phone Base Settings object upon which to base this Phone

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Phone, Fixnum, Hash)>) —

    Phone data, response status code and response headers



3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3828

def get_providers_edges_phones_template_with_http_info(phone_base_settings_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_phones_template ..."
  end
  
  # verify the required parameter 'phone_base_settings_id' is set
  fail "Missing the required parameter 'phone_base_settings_id' when calling get_providers_edges_phones_template" if phone_base_settings_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phones/template".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'phoneBaseSettingsId'] = phone_base_settings_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Phone')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_phones_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_phones_with_http_info(opts = {}) ⇒ Array<(PhoneEntityListing, Fixnum, Hash)>

Get a list of Phone Instances

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Value by which to sort

  • :sort_order (String) —

    Sort order

  • :site_id (String) —

    Filter by site.id

  • :phone_base_settings_id (String) —

    Filter by phoneBaseSettings.id

  • :phone_hardware_id (String) —

    Filter by phone_hardwareId

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

  • :fields (Array<String>) —

    Fields under properties to get, comma-separated

Returns:

  • (Array<(PhoneEntityListing, Fixnum, Hash)>) —

    PhoneEntityListing data, response status code and response headers



3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3646

def get_providers_edges_phones_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_phones ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phones".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'site.id'] = opts[:'site_id'] if opts[:'site_id']
  query_params[:'phoneBaseSettings.id'] = opts[:'phone_base_settings_id'] if opts[:'phone_base_settings_id']
  query_params[:'phone_hardwareId'] = opts[:'phone_hardware_id'] if opts[:'phone_hardware_id']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if opts[:'fields']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PhoneEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_phones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_sites(opts = {}) ⇒ SiteEntityListing

Get the list of sites.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :name (String) —

    Name

  • :location_id (String) —

    Location Id

Returns:



4130
4131
4132
4133
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4130

def get_providers_edges_sites(opts = {})
  data, status_code, headers = get_providers_edges_sites_with_http_info(opts)
  return data
end

#get_providers_edges_sites_site_id(site_id, opts = {}) ⇒ Site

Get endpoint.

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4257
4258
4259
4260
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4257

def get_providers_edges_sites_site_id(site_id, opts = {})
  data, status_code, headers = get_providers_edges_sites_site_id_with_http_info(site_id, opts)
  return data
end

#get_providers_edges_sites_site_id_numberplans(site_id, opts = {}) ⇒ Array<NumberPlan>

Get the list of Number Plans for this Site.

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4442
4443
4444
4445
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4442

def get_providers_edges_sites_site_id_numberplans(site_id, opts = {})
  data, status_code, headers = get_providers_edges_sites_site_id_numberplans_with_http_info(site_id, opts)
  return data
end

#get_providers_edges_sites_site_id_numberplans_classifications(site_id, opts = {}) ⇒ Array<String>

Get a list of Classifications for this Site

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :classification (String) —

    Classification

Returns:

  • (Array<String>) 


4567
4568
4569
4570
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4567

def get_providers_edges_sites_site_id_numberplans_classifications(site_id, opts = {})
  data, status_code, headers = get_providers_edges_sites_site_id_numberplans_classifications_with_http_info(site_id, opts)
  return data
end

#get_providers_edges_sites_site_id_numberplans_classifications_with_http_info(site_id, opts = {}) ⇒ Array<(Array<String>, Fixnum, Hash)>

Get a list of Classifications for this Site

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :classification (String) —

    Classification

Returns:

  • (Array<(Array<String>, Fixnum, Hash)>) —

    Array<String> data, response status code and response headers



4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4578

def get_providers_edges_sites_site_id_numberplans_classifications_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_sites_site_id_numberplans_classifications ..."
  end
  
  # verify the required parameter 'site_id' is set
  fail "Missing the required parameter 'site_id' when calling get_providers_edges_sites_site_id_numberplans_classifications" if site_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications".sub('{format}','json').sub('{' + 'siteId' + '}', site_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'classification'] = opts[:'classification'] if opts[:'classification']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<String>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_sites_site_id_numberplans_classifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_sites_site_id_numberplans_numberplan_id(site_id, number_plan_id, opts = {}) ⇒ NumberPlan

Get a Number Plan by ID.

Parameters:

  • site_id —

    Site ID

  • number_plan_id —

    Number Plan ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4631
4632
4633
4634
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4631

def get_providers_edges_sites_site_id_numberplans_numberplan_id(site_id, number_plan_id, opts = {})
  data, status_code, headers = get_providers_edges_sites_site_id_numberplans_numberplan_id_with_http_info(site_id, number_plan_id, opts)
  return data
end

#get_providers_edges_sites_site_id_numberplans_numberplan_id_with_http_info(site_id, number_plan_id, opts = {}) ⇒ Array<(NumberPlan, Fixnum, Hash)>

Get a Number Plan by ID.

Parameters:

  • site_id —

    Site ID

  • number_plan_id —

    Number Plan ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(NumberPlan, Fixnum, Hash)>) —

    NumberPlan data, response status code and response headers



4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4642

def get_providers_edges_sites_site_id_numberplans_numberplan_id_with_http_info(site_id, number_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_sites_site_id_numberplans_numberplan_id ..."
  end
  
  # verify the required parameter 'site_id' is set
  fail "Missing the required parameter 'site_id' when calling get_providers_edges_sites_site_id_numberplans_numberplan_id" if site_id.nil?
  
  # verify the required parameter 'number_plan_id' is set
  fail "Missing the required parameter 'number_plan_id' when calling get_providers_edges_sites_site_id_numberplans_numberplan_id" if number_plan_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}".sub('{format}','json').sub('{' + 'siteId' + '}', site_id.to_s).sub('{' + 'numberPlanId' + '}', number_plan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NumberPlan')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_sites_site_id_numberplans_numberplan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_sites_site_id_numberplans_with_http_info(site_id, opts = {}) ⇒ Array<(Array<NumberPlan>, Fixnum, Hash)>

Get the list of Number Plans for this Site.

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<NumberPlan>, Fixnum, Hash)>) —

    Array<NumberPlan> data, response status code and response headers



4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4452

def get_providers_edges_sites_site_id_numberplans_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_sites_site_id_numberplans ..."
  end
  
  # verify the required parameter 'site_id' is set
  fail "Missing the required parameter 'site_id' when calling get_providers_edges_sites_site_id_numberplans" if site_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/sites/{siteId}/numberplans".sub('{format}','json').sub('{' + 'siteId' + '}', site_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<NumberPlan>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_sites_site_id_numberplans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_sites_site_id_with_http_info(site_id, opts = {}) ⇒ Array<(Site, Fixnum, Hash)>

Get endpoint.

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Site, Fixnum, Hash)>) —

    Site data, response status code and response headers



4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4267

def get_providers_edges_sites_site_id_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_sites_site_id ..."
  end
  
  # verify the required parameter 'site_id' is set
  fail "Missing the required parameter 'site_id' when calling get_providers_edges_sites_site_id" if site_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/sites/{siteId}".sub('{format}','json').sub('{' + 'siteId' + '}', site_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Site')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_sites_site_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_sites_with_http_info(opts = {}) ⇒ Array<(SiteEntityListing, Fixnum, Hash)>

Get the list of sites.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :name (String) —

    Name

  • :location_id (String) —

    Location Id

Returns:

  • (Array<(SiteEntityListing, Fixnum, Hash)>) —

    SiteEntityListing data, response status code and response headers



4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4145

def get_providers_edges_sites_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_sites ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/sites".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'location.id'] = opts[:'location_id'] if opts[:'location_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SiteEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_sites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_timezones(opts = {}) ⇒ TimeZoneEntityListing

Get a list of Edge-compatible time zones

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



4757
4758
4759
4760
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4757

def get_providers_edges_timezones(opts = {})
  data, status_code, headers = get_providers_edges_timezones_with_http_info(opts)
  return data
end

#get_providers_edges_timezones_with_http_info(opts = {}) ⇒ Array<(TimeZoneEntityListing, Fixnum, Hash)>

Get a list of Edge-compatible time zones

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

  • (Array<(TimeZoneEntityListing, Fixnum, Hash)>) —

    TimeZoneEntityListing data, response status code and response headers



4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4768

def get_providers_edges_timezones_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_timezones ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/timezones".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeZoneEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_timezones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_trunkbasesettings(opts = {}) ⇒ TrunkBase

Get Trunk Base Settings listing

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Value by which to sort

  • :sort_order (String) —

    Sort order

Returns:



4821
4822
4823
4824
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4821

def get_providers_edges_trunkbasesettings(opts = {})
  data, status_code, headers = get_providers_edges_trunkbasesettings_with_http_info(opts)
  return data
end

#get_providers_edges_trunkbasesettings_availablemetabases(opts = {}) ⇒ TrunkMetabaseEntityListing

Get a list of available makes and models to create a new Trunk Base Settings

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String)
  • :page_size (Integer)
  • :page_number (Integer)

Returns:



4946
4947
4948
4949
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4946

def get_providers_edges_trunkbasesettings_availablemetabases(opts = {})
  data, status_code, headers = get_providers_edges_trunkbasesettings_availablemetabases_with_http_info(opts)
  return data
end

#get_providers_edges_trunkbasesettings_availablemetabases_with_http_info(opts = {}) ⇒ Array<(TrunkMetabaseEntityListing, Fixnum, Hash)>

Get a list of available makes and models to create a new Trunk Base Settings

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String)
  • :page_size (Integer)
  • :page_number (Integer)

Returns:

  • (Array<(TrunkMetabaseEntityListing, Fixnum, Hash)>) —

    TrunkMetabaseEntityListing data, response status code and response headers



4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4958

def get_providers_edges_trunkbasesettings_availablemetabases_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_trunkbasesettings_availablemetabases ..."
  end
  
  if opts[:'type'] && !['EXTERNAL', 'PHONE', 'EDGE'].include?(opts[:'type'])
    fail 'invalid value for "type", must be one of EXTERNAL, PHONE, EDGE'
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'type'] = opts[:'type'] if opts[:'type']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TrunkMetabaseEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_trunkbasesettings_availablemetabases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_trunkbasesettings_template(trunk_metabase_id, opts = {}) ⇒ TrunkBase

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

Parameters:

  • trunk_metabase_id —

    The id of a metabase object upon which to base this Trunk Base Settings

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5013
5014
5015
5016
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5013

def get_providers_edges_trunkbasesettings_template(trunk_metabase_id, opts = {})
  data, status_code, headers = get_providers_edges_trunkbasesettings_template_with_http_info(trunk_metabase_id, opts)
  return data
end

#get_providers_edges_trunkbasesettings_template_with_http_info(trunk_metabase_id, opts = {}) ⇒ Array<(TrunkBase, Fixnum, Hash)>

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

Parameters:

  • trunk_metabase_id —

    The id of a metabase object upon which to base this Trunk Base Settings

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TrunkBase, Fixnum, Hash)>) —

    TrunkBase data, response status code and response headers



5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5023

def get_providers_edges_trunkbasesettings_template_with_http_info(trunk_metabase_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_trunkbasesettings_template ..."
  end
  
  # verify the required parameter 'trunk_metabase_id' is set
  fail "Missing the required parameter 'trunk_metabase_id' when calling get_providers_edges_trunkbasesettings_template" if trunk_metabase_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/trunkbasesettings/template".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'trunkMetabaseId'] = trunk_metabase_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TrunkBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_trunkbasesettings_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id, opts = {}) ⇒ TrunkBase

Get a Trunk Base Settings object by ID

Parameters:

  • trunk_base_settings_id —

    Trunk Base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5075
5076
5077
5078
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5075

def get_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id, opts = {})
  data, status_code, headers = get_providers_edges_trunkbasesettings_trunkbasesettings_id_with_http_info(trunk_base_settings_id, opts)
  return data
end

#get_providers_edges_trunkbasesettings_trunkbasesettings_id_with_http_info(trunk_base_settings_id, opts = {}) ⇒ Array<(TrunkBase, Fixnum, Hash)>

Get a Trunk Base Settings object by ID

Parameters:

  • trunk_base_settings_id —

    Trunk Base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TrunkBase, Fixnum, Hash)>) —

    TrunkBase data, response status code and response headers



5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5085

def get_providers_edges_trunkbasesettings_trunkbasesettings_id_with_http_info(trunk_base_settings_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_trunkbasesettings_trunkbasesettings_id ..."
  end
  
  # verify the required parameter 'trunk_base_settings_id' is set
  fail "Missing the required parameter 'trunk_base_settings_id' when calling get_providers_edges_trunkbasesettings_trunkbasesettings_id" if trunk_base_settings_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}".sub('{format}','json').sub('{' + 'trunkBaseSettingsId' + '}', trunk_base_settings_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TrunkBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_trunkbasesettings_trunkbasesettings_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_trunkbasesettings_with_http_info(opts = {}) ⇒ Array<(TrunkBase, Fixnum, Hash)>

Get Trunk Base Settings listing

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Value by which to sort

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(TrunkBase, Fixnum, Hash)>) —

    TrunkBase data, response status code and response headers



4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4834

def get_providers_edges_trunkbasesettings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_trunkbasesettings ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/trunkbasesettings".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TrunkBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_trunkbasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_with_http_info(opts = {}) ⇒ Array<(EdgeEntityListing, Fixnum, Hash)>

Get the list of edges.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

  • :site_id (String) —

    Filter by site.id

  • :edge_group_id (String) —

    Filter by edgeGroup.id

  • :sort_by (String) —

    Sort by

Returns:

  • (Array<(EdgeEntityListing, Fixnum, Hash)>) —

    EdgeEntityListing data, response status code and response headers



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 392

def get_providers_edges_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'site.id'] = opts[:'site_id'] if opts[:'site_id']
  query_params[:'edgeGroup.id'] = opts[:'edge_group_id'] if opts[:'edge_group_id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EdgeEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schemas_edges_vnext(opts = {}) ⇒ SchemaCategoryEntityListing

Lists available schema categories

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



17
18
19
20
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 17

def get_schemas_edges_vnext(opts = {})
  data, status_code, headers = get_schemas_edges_vnext_with_http_info(opts)
  return data
end

#get_schemas_edges_vnext_schemacategory(schema_category, opts = {}) ⇒ SchemaReferenceEntityListing

List schemas of a specific category

Parameters:

  • schema_category —

    Schema category

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



80
81
82
83
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 80

def get_schemas_edges_vnext_schemacategory(schema_category, opts = {})
  data, status_code, headers = get_schemas_edges_vnext_schemacategory_with_http_info(schema_category, opts)
  return data
end

#get_schemas_edges_vnext_schemacategory_schematype(schema_category, schema_type, opts = {}) ⇒ SchemaReferenceEntityListing

List schemas of a specific category

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



148
149
150
151
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 148

def get_schemas_edges_vnext_schemacategory_schematype(schema_category, schema_type, opts = {})
  data, status_code, headers = get_schemas_edges_vnext_schemacategory_schematype_with_http_info(schema_category, schema_type, opts)
  return data
end

#get_schemas_edges_vnext_schemacategory_schematype_schema_id(schema_category, schema_type, schema_id, opts = {}) ⇒ Organization

Get a json schema

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • schema_id —

    Schema ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



219
220
221
222
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 219

def get_schemas_edges_vnext_schemacategory_schematype_schema_id(schema_category, schema_type, schema_id, opts = {})
  data, status_code, headers = get_schemas_edges_vnext_schemacategory_schematype_schema_id_with_http_info(schema_category, schema_type, schema_id, opts)
  return data
end

#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id(schema_category, schema_type, schema_id, extension, metadata_id, opts = {}) ⇒ Organization

Get metadata for a schema

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • schema_id —

    Schema ID

  • extension —

    extension

  • metadata_id —

    Metadata ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Type

Returns:



293
294
295
296
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 293

def get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id(schema_category, schema_type, schema_id, extension, metadata_id, opts = {})
  data, status_code, headers = get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id_with_http_info(schema_category, schema_type, schema_id, extension, metadata_id, opts)
  return data
end

#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id_with_http_info(schema_category, schema_type, schema_id, extension, metadata_id, opts = {}) ⇒ Array<(Organization, Fixnum, Hash)>

Get metadata for a schema

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • schema_id —

    Schema ID

  • extension —

    extension

  • metadata_id —

    Metadata ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Type

Returns:

  • (Array<(Organization, Fixnum, Hash)>) —

    Organization data, response status code and response headers



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 308

def get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id_with_http_info(schema_category, schema_type, schema_id, extension, metadata_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id ..."
  end
  
  # verify the required parameter 'schema_category' is set
  fail "Missing the required parameter 'schema_category' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id" if schema_category.nil?
  
  # verify the required parameter 'schema_type' is set
  fail "Missing the required parameter 'schema_type' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id" if schema_type.nil?
  
  # verify the required parameter 'schema_id' is set
  fail "Missing the required parameter 'schema_id' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id" if schema_id.nil?
  
  # verify the required parameter 'extension' is set
  fail "Missing the required parameter 'extension' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id" if extension.nil?
  
  # verify the required parameter 'metadata_id' is set
  fail "Missing the required parameter 'metadata_id' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id" if metadata_id.nil?
  
  # resource path
  path = "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extension}/{metadataId}".sub('{format}','json').sub('{' + 'schemaCategory' + '}', schema_category.to_s).sub('{' + 'schemaType' + '}', schema_type.to_s).sub('{' + 'schemaId' + '}', schema_id.to_s).sub('{' + 'extension' + '}', extension.to_s).sub('{' + 'metadataId' + '}', metadata_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'type'] = opts[:'type'] if opts[:'type']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Organization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extension_metadata_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schemas_edges_vnext_schemacategory_schematype_schema_id_with_http_info(schema_category, schema_type, schema_id, opts = {}) ⇒ Array<(Organization, Fixnum, Hash)>

Get a json schema

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • schema_id —

    Schema ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Organization, Fixnum, Hash)>) —

    Organization data, response status code and response headers



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 231

def get_schemas_edges_vnext_schemacategory_schematype_schema_id_with_http_info(schema_category, schema_type, schema_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_schemas_edges_vnext_schemacategory_schematype_schema_id ..."
  end
  
  # verify the required parameter 'schema_category' is set
  fail "Missing the required parameter 'schema_category' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id" if schema_category.nil?
  
  # verify the required parameter 'schema_type' is set
  fail "Missing the required parameter 'schema_type' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id" if schema_type.nil?
  
  # verify the required parameter 'schema_id' is set
  fail "Missing the required parameter 'schema_id' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id" if schema_id.nil?
  
  # resource path
  path = "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}".sub('{format}','json').sub('{' + 'schemaCategory' + '}', schema_category.to_s).sub('{' + 'schemaType' + '}', schema_type.to_s).sub('{' + 'schemaId' + '}', schema_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Organization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_schemas_edges_vnext_schemacategory_schematype_schema_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schemas_edges_vnext_schemacategory_schematype_with_http_info(schema_category, schema_type, opts = {}) ⇒ Array<(SchemaReferenceEntityListing, Fixnum, Hash)>

List schemas of a specific category

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 161

def get_schemas_edges_vnext_schemacategory_schematype_with_http_info(schema_category, schema_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_schemas_edges_vnext_schemacategory_schematype ..."
  end
  
  # verify the required parameter 'schema_category' is set
  fail "Missing the required parameter 'schema_category' when calling get_schemas_edges_vnext_schemacategory_schematype" if schema_category.nil?
  
  # verify the required parameter 'schema_type' is set
  fail "Missing the required parameter 'schema_type' when calling get_schemas_edges_vnext_schemacategory_schematype" if schema_type.nil?
  
  # resource path
  path = "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}".sub('{format}','json').sub('{' + 'schemaCategory' + '}', schema_category.to_s).sub('{' + 'schemaType' + '}', schema_type.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SchemaReferenceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_schemas_edges_vnext_schemacategory_schematype\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schemas_edges_vnext_schemacategory_with_http_info(schema_category, opts = {}) ⇒ Array<(SchemaReferenceEntityListing, Fixnum, Hash)>

List schemas of a specific category

Parameters:

  • schema_category —

    Schema category

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 92

def get_schemas_edges_vnext_schemacategory_with_http_info(schema_category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_schemas_edges_vnext_schemacategory ..."
  end
  
  # verify the required parameter 'schema_category' is set
  fail "Missing the required parameter 'schema_category' when calling get_schemas_edges_vnext_schemacategory" if schema_category.nil?
  
  # resource path
  path = "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}".sub('{format}','json').sub('{' + 'schemaCategory' + '}', schema_category.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SchemaReferenceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_schemas_edges_vnext_schemacategory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schemas_edges_vnext_with_http_info(opts = {}) ⇒ Array<(SchemaCategoryEntityListing, Fixnum, Hash)>

Lists available schema categories

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 28

def get_schemas_edges_vnext_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_schemas_edges_vnext ..."
  end
  
  # resource path
  path = "/api/v2/configuration/schemas/edges/vnext".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SchemaCategoryEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_schemas_edges_vnext\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges(opts = {}) ⇒ Edge

Create a edge.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Edge) —

    Edge

Returns:



446
447
448
449
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 446

def post_providers_edges(opts = {})
  data, status_code, headers = post_providers_edges_with_http_info(opts)
  return data
end

#post_providers_edges_addressvalidation(opts = {}) ⇒ ValidateAddressResponse

Validates a street address

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



504
505
506
507
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 504

def post_providers_edges_addressvalidation(opts = {})
  data, status_code, headers = post_providers_edges_addressvalidation_with_http_info(opts)
  return data
end

#post_providers_edges_addressvalidation_with_http_info(opts = {}) ⇒ Array<(ValidateAddressResponse, Fixnum, Hash)>

Validates a street address

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ValidateAddressResponse, Fixnum, Hash)>) —

    ValidateAddressResponse data, response status code and response headers



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 514

def post_providers_edges_addressvalidation_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_addressvalidation ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/addressvalidation".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ValidateAddressResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_addressvalidation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_certificateauthorities(opts = {}) ⇒ DomainCertificateAuthority

Create a certificate authority.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



618
619
620
621
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 618

def post_providers_edges_certificateauthorities(opts = {})
  data, status_code, headers = post_providers_edges_certificateauthorities_with_http_info(opts)
  return data
end

#post_providers_edges_certificateauthorities_with_http_info(opts = {}) ⇒ Array<(DomainCertificateAuthority, Fixnum, Hash)>

Create a certificate authority.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DomainCertificateAuthority, Fixnum, Hash)>) —

    DomainCertificateAuthority data, response status code and response headers



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 628

def post_providers_edges_certificateauthorities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_certificateauthorities ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/certificateauthorities".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainCertificateAuthority')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_certificateauthorities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_didpools(opts = {}) ⇒ DIDPool

Create a new DID pool

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



926
927
928
929
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 926

def post_providers_edges_didpools(opts = {})
  data, status_code, headers = post_providers_edges_didpools_with_http_info(opts)
  return data
end

#post_providers_edges_didpools_with_http_info(opts = {}) ⇒ Array<(DIDPool, Fixnum, Hash)>

Create a new DID pool

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DIDPool, Fixnum, Hash)>) —

    DIDPool data, response status code and response headers



936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 936

def post_providers_edges_didpools_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_didpools ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/didpools".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DIDPool')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_didpools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_edge_id_logicalinterfaces(edge_id, opts = {}) ⇒ DomainLogicalInterface

Create an edge logical interface. Create

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



5708
5709
5710
5711
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5708

def post_providers_edges_edge_id_logicalinterfaces(edge_id, opts = {})
  data, status_code, headers = post_providers_edges_edge_id_logicalinterfaces_with_http_info(edge_id, opts)
  return data
end

#post_providers_edges_edge_id_logicalinterfaces_with_http_info(edge_id, opts = {}) ⇒ Array<(DomainLogicalInterface, Fixnum, Hash)>

Create an edge logical interface. Create

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DomainLogicalInterface, Fixnum, Hash)>) —

    DomainLogicalInterface data, response status code and response headers



5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5719

def post_providers_edges_edge_id_logicalinterfaces_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_logicalinterfaces ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling post_providers_edges_edge_id_logicalinterfaces" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainLogicalInterface')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_logicalinterfaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_edge_id_logs_jobs(edge_id, opts = {}) ⇒ EdgeLogsJobResponse

Create a job to upload a list of Edge logs.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



5970
5971
5972
5973
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5970

def post_providers_edges_edge_id_logs_jobs(edge_id, opts = {})
  data, status_code, headers = post_providers_edges_edge_id_logs_jobs_with_http_info(edge_id, opts)
  return data
end

#post_providers_edges_edge_id_logs_jobs_job_id_upload(edge_id, job_id, opts = {}) ⇒ nil

Request that the specified fileIds be uploaded from the Edge.

Parameters:

  • edge_id —

    Edge ID

  • job_id —

    Job ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


6100
6101
6102
6103
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6100

def post_providers_edges_edge_id_logs_jobs_job_id_upload(edge_id, job_id, opts = {})
  post_providers_edges_edge_id_logs_jobs_job_id_upload_with_http_info(edge_id, job_id, opts)
  return nil
end

#post_providers_edges_edge_id_logs_jobs_job_id_upload_with_http_info(edge_id, job_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Request that the specified fileIds be uploaded from the Edge.

Parameters:

  • edge_id —

    Edge ID

  • job_id —

    Job ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6112

def post_providers_edges_edge_id_logs_jobs_job_id_upload_with_http_info(edge_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_logs_jobs_job_id_upload ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling post_providers_edges_edge_id_logs_jobs_job_id_upload" if edge_id.nil?
  
  # verify the required parameter 'job_id' is set
  fail "Missing the required parameter 'job_id' when calling post_providers_edges_edge_id_logs_jobs_job_id_upload" if job_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s).sub('{' + 'jobId' + '}', job_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_logs_jobs_job_id_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_edge_id_logs_jobs_with_http_info(edge_id, opts = {}) ⇒ Array<(EdgeLogsJobResponse, Fixnum, Hash)>

Create a job to upload a list of Edge logs.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(EdgeLogsJobResponse, Fixnum, Hash)>) —

    EdgeLogsJobResponse data, response status code and response headers



5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5981

def post_providers_edges_edge_id_logs_jobs_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_logs_jobs ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling post_providers_edges_edge_id_logs_jobs" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/logs/jobs".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EdgeLogsJobResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_logs_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_edge_id_reboot(edge_id, opts = {}) ⇒ String

Reboot an Edge

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


6292
6293
6294
6295
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6292

def post_providers_edges_edge_id_reboot(edge_id, opts = {})
  data, status_code, headers = post_providers_edges_edge_id_reboot_with_http_info(edge_id, opts)
  return data
end

#post_providers_edges_edge_id_reboot_with_http_info(edge_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Reboot an Edge

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6302

def post_providers_edges_edge_id_reboot_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_reboot ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling post_providers_edges_edge_id_reboot" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/reboot".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_reboot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_edge_id_softwareupdate(edge_id, opts = {}) ⇒ DomainEdgeSoftwareUpdateDto

Starts a software update for this edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



6415
6416
6417
6418
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6415

def post_providers_edges_edge_id_softwareupdate(edge_id, opts = {})
  data, status_code, headers = post_providers_edges_edge_id_softwareupdate_with_http_info(edge_id, opts)
  return data
end

#post_providers_edges_edge_id_softwareupdate_with_http_info(edge_id, opts = {}) ⇒ Array<(DomainEdgeSoftwareUpdateDto, Fixnum, Hash)>

Starts a software update for this edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6426

def post_providers_edges_edge_id_softwareupdate_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_softwareupdate ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling post_providers_edges_edge_id_softwareupdate" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/softwareupdate".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainEdgeSoftwareUpdateDto')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_softwareupdate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_edge_id_unpair(edge_id, opts = {}) ⇒ String

Unpair an Edge

Parameters:

  • edge_id —

    Edge Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


6599
6600
6601
6602
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6599

def post_providers_edges_edge_id_unpair(edge_id, opts = {})
  data, status_code, headers = post_providers_edges_edge_id_unpair_with_http_info(edge_id, opts)
  return data
end

#post_providers_edges_edge_id_unpair_with_http_info(edge_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Unpair an Edge

Parameters:

  • edge_id —

    Edge Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6609

def post_providers_edges_edge_id_unpair_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_unpair ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling post_providers_edges_edge_id_unpair" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/unpair".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_edge_id_unpair\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_edgegroups(opts = {}) ⇒ EdgeGroup

Create an edge group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1432
1433
1434
1435
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1432

def post_providers_edges_edgegroups(opts = {})
  data, status_code, headers = post_providers_edges_edgegroups_with_http_info(opts)
  return data
end

#post_providers_edges_edgegroups_with_http_info(opts = {}) ⇒ Array<(EdgeGroup, Fixnum, Hash)>

Create an edge group.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(EdgeGroup, Fixnum, Hash)>) —

    EdgeGroup data, response status code and response headers



1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1442

def post_providers_edges_edgegroups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_edgegroups ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/edgegroups".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EdgeGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_edgegroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_endpoints(opts = {}) ⇒ Endpoint

Create endpoint

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1799
1800
1801
1802
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1799

def post_providers_edges_endpoints(opts = {})
  data, status_code, headers = post_providers_edges_endpoints_with_http_info(opts)
  return data
end

#post_providers_edges_endpoints_with_http_info(opts = {}) ⇒ Array<(Endpoint, Fixnum, Hash)>

Create endpoint

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Endpoint, Fixnum, Hash)>) —

    Endpoint data, response status code and response headers



1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1809

def post_providers_edges_endpoints_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_endpoints ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/endpoints".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Endpoint')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_endpoints\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_extensionpools(opts = {}) ⇒ Extension

Create a new extension pool

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2110
2111
2112
2113
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2110

def post_providers_edges_extensionpools(opts = {})
  data, status_code, headers = post_providers_edges_extensionpools_with_http_info(opts)
  return data
end

#post_providers_edges_extensionpools_with_http_info(opts = {}) ⇒ Array<(Extension, Fixnum, Hash)>

Create a new extension pool

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Extension, Fixnum, Hash)>) —

    Extension data, response status code and response headers



2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2120

def post_providers_edges_extensionpools_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_extensionpools ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/extensionpools".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Extension')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_extensionpools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_outboundroutes(opts = {}) ⇒ OutboundRoute

Create outbound rule

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2942
2943
2944
2945
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2942

def post_providers_edges_outboundroutes(opts = {})
  data, status_code, headers = post_providers_edges_outboundroutes_with_http_info(opts)
  return data
end

#post_providers_edges_outboundroutes_with_http_info(opts = {}) ⇒ Array<(OutboundRoute, Fixnum, Hash)>

Create outbound rule

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OutboundRoute, Fixnum, Hash)>) —

    OutboundRoute data, response status code and response headers



2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2952

def post_providers_edges_outboundroutes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_outboundroutes ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/outboundroutes".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OutboundRoute')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_outboundroutes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_phonebasesettings(opts = {}) ⇒ PhoneBase

Create a new Phone Base Settings object

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3253
3254
3255
3256
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3253

def post_providers_edges_phonebasesettings(opts = {})
  data, status_code, headers = post_providers_edges_phonebasesettings_with_http_info(opts)
  return data
end

#post_providers_edges_phonebasesettings_with_http_info(opts = {}) ⇒ Array<(PhoneBase, Fixnum, Hash)>

Create a new Phone Base Settings object

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(PhoneBase, Fixnum, Hash)>) —

    PhoneBase data, response status code and response headers



3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3263

def post_providers_edges_phonebasesettings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_phonebasesettings ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phonebasesettings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PhoneBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_phonebasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_phones(opts = {}) ⇒ Phone

Create a new Phone

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3703
3704
3705
3706
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3703

def post_providers_edges_phones(opts = {})
  data, status_code, headers = post_providers_edges_phones_with_http_info(opts)
  return data
end

#post_providers_edges_phones_phone_id_reboot(phone_id, opts = {}) ⇒ nil

Reboot a Phone

Parameters:

  • phone_id —

    Phone Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


4065
4066
4067
4068
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4065

def post_providers_edges_phones_phone_id_reboot(phone_id, opts = {})
  post_providers_edges_phones_phone_id_reboot_with_http_info(phone_id, opts)
  return nil
end

#post_providers_edges_phones_phone_id_reboot_with_http_info(phone_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Reboot a Phone

Parameters:

  • phone_id —

    Phone Id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4075

def post_providers_edges_phones_phone_id_reboot_with_http_info(phone_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_phones_phone_id_reboot ..."
  end
  
  # verify the required parameter 'phone_id' is set
  fail "Missing the required parameter 'phone_id' when calling post_providers_edges_phones_phone_id_reboot" if phone_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phones/{phoneId}/reboot".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_phones_phone_id_reboot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_phones_reboot(opts = {}) ⇒ nil

Reboot Multiple Phones

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3761
3762
3763
3764
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3761

def post_providers_edges_phones_reboot(opts = {})
  post_providers_edges_phones_reboot_with_http_info(opts)
  return nil
end

#post_providers_edges_phones_reboot_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Reboot Multiple Phones

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3771

def post_providers_edges_phones_reboot_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_phones_reboot ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phones/reboot".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_phones_reboot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_phones_with_http_info(opts = {}) ⇒ Array<(Phone, Fixnum, Hash)>

Create a new Phone

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Phone, Fixnum, Hash)>) —

    Phone data, response status code and response headers



3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3713

def post_providers_edges_phones_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_phones ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phones".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Phone')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_phones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_sites(opts = {}) ⇒ Site

Create a endpoint.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Site) —

    Site

Returns:



4199
4200
4201
4202
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4199

def post_providers_edges_sites(opts = {})
  data, status_code, headers = post_providers_edges_sites_with_http_info(opts)
  return data
end

#post_providers_edges_sites_site_id_rebalance(site_id, opts = {}) ⇒ nil

Triggers the rebalance operation.

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


4696
4697
4698
4699
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4696

def post_providers_edges_sites_site_id_rebalance(site_id, opts = {})
  post_providers_edges_sites_site_id_rebalance_with_http_info(site_id, opts)
  return nil
end

#post_providers_edges_sites_site_id_rebalance_with_http_info(site_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Triggers the rebalance operation.

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4706

def post_providers_edges_sites_site_id_rebalance_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_sites_site_id_rebalance ..."
  end
  
  # verify the required parameter 'site_id' is set
  fail "Missing the required parameter 'site_id' when calling post_providers_edges_sites_site_id_rebalance" if site_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/sites/{siteId}/rebalance".sub('{format}','json').sub('{' + 'siteId' + '}', site_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_sites_site_id_rebalance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_sites_with_http_info(opts = {}) ⇒ Array<(Site, Fixnum, Hash)>

Create a endpoint.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Site) —

    Site

Returns:

  • (Array<(Site, Fixnum, Hash)>) —

    Site data, response status code and response headers



4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4209

def post_providers_edges_sites_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_sites ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/sites".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Site')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_sites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_trunkbasesettings(opts = {}) ⇒ TrunkBase

Create a Trunk Base Settings object

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



4886
4887
4888
4889
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4886

def post_providers_edges_trunkbasesettings(opts = {})
  data, status_code, headers = post_providers_edges_trunkbasesettings_with_http_info(opts)
  return data
end

#post_providers_edges_trunkbasesettings_with_http_info(opts = {}) ⇒ Array<(TrunkBase, Fixnum, Hash)>

Create a Trunk Base Settings object

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TrunkBase, Fixnum, Hash)>) —

    TrunkBase data, response status code and response headers



4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4896

def post_providers_edges_trunkbasesettings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges_trunkbasesettings ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges/trunkbasesettings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TrunkBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges_trunkbasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_providers_edges_with_http_info(opts = {}) ⇒ Array<(Edge, Fixnum, Hash)>

Create a edge.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Edge) —

    Edge

Returns:

  • (Array<(Edge, Fixnum, Hash)>) —

    Edge data, response status code and response headers



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 456

def post_providers_edges_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_providers_edges ..."
  end
  
  # resource path
  path = "/api/v2/telephony/providers/edges".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Edge')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_providers_edges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_certificateauthorities_certificate_id(certificate_id, opts = {}) ⇒ DomainCertificateAuthority

Update a certificate authority.

Parameters:

  • certificate_id —

    Certificate ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



738
739
740
741
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 738

def put_providers_edges_certificateauthorities_certificate_id(certificate_id, opts = {})
  data, status_code, headers = put_providers_edges_certificateauthorities_certificate_id_with_http_info(certificate_id, opts)
  return data
end

#put_providers_edges_certificateauthorities_certificate_id_with_http_info(certificate_id, opts = {}) ⇒ Array<(DomainCertificateAuthority, Fixnum, Hash)>

Update a certificate authority.

Parameters:

  • certificate_id —

    Certificate ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DomainCertificateAuthority, Fixnum, Hash)>) —

    DomainCertificateAuthority data, response status code and response headers



749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 749

def put_providers_edges_certificateauthorities_certificate_id_with_http_info(certificate_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_certificateauthorities_certificate_id ..."
  end
  
  # verify the required parameter 'certificate_id' is set
  fail "Missing the required parameter 'certificate_id' when calling put_providers_edges_certificateauthorities_certificate_id" if certificate_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}".sub('{format}','json').sub('{' + 'certificateId' + '}', certificate_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainCertificateAuthority')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_certificateauthorities_certificate_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_didpools_didpool_id(did_pool_id, opts = {}) ⇒ DIDPool

Update a DID Pool by ID.

Parameters:

  • did_pool_id —

    DID pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1046
1047
1048
1049
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1046

def put_providers_edges_didpools_didpool_id(did_pool_id, opts = {})
  data, status_code, headers = put_providers_edges_didpools_didpool_id_with_http_info(did_pool_id, opts)
  return data
end

#put_providers_edges_didpools_didpool_id_with_http_info(did_pool_id, opts = {}) ⇒ Array<(DIDPool, Fixnum, Hash)>

Update a DID Pool by ID.

Parameters:

  • did_pool_id —

    DID pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DIDPool, Fixnum, Hash)>) —

    DIDPool data, response status code and response headers



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1057

def put_providers_edges_didpools_didpool_id_with_http_info(did_pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_didpools_didpool_id ..."
  end
  
  # verify the required parameter 'did_pool_id' is set
  fail "Missing the required parameter 'did_pool_id' when calling put_providers_edges_didpools_didpool_id" if did_pool_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/didpools/{didPoolId}".sub('{format}','json').sub('{' + 'didPoolId' + '}', did_pool_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DIDPool')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_didpools_didpool_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_dids_did_id(did_id, opts = {}) ⇒ DID

Update a DID by ID.

Parameters:

  • did_id —

    DID ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1302
1303
1304
1305
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1302

def put_providers_edges_dids_did_id(did_id, opts = {})
  data, status_code, headers = put_providers_edges_dids_did_id_with_http_info(did_id, opts)
  return data
end

#put_providers_edges_dids_did_id_with_http_info(did_id, opts = {}) ⇒ Array<(DID, Fixnum, Hash)>

Update a DID by ID.

Parameters:

  • did_id —

    DID ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DID, Fixnum, Hash)>) —

    DID data, response status code and response headers



1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1313

def put_providers_edges_dids_did_id_with_http_info(did_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_dids_did_id ..."
  end
  
  # verify the required parameter 'did_id' is set
  fail "Missing the required parameter 'did_id' when calling put_providers_edges_dids_did_id" if did_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/dids/{didId}".sub('{format}','json').sub('{' + 'didId' + '}', did_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DID')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_dids_did_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_edge_id(edge_id, opts = {}) ⇒ Edge

Update a edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Edge) —

    Edge

Returns:



5322
5323
5324
5325
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5322

def put_providers_edges_edge_id(edge_id, opts = {})
  data, status_code, headers = put_providers_edges_edge_id_with_http_info(edge_id, opts)
  return data
end

#put_providers_edges_edge_id_lines_line_id(edge_id, line_id, opts = {}) ⇒ EdgeLine

Update a line.

Parameters:

  • edge_id —

    Edge ID

  • line_id —

    Line ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



5580
5581
5582
5583
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5580

def put_providers_edges_edge_id_lines_line_id(edge_id, line_id, opts = {})
  data, status_code, headers = put_providers_edges_edge_id_lines_line_id_with_http_info(edge_id, line_id, opts)
  return data
end

#put_providers_edges_edge_id_lines_line_id_with_http_info(edge_id, line_id, opts = {}) ⇒ Array<(EdgeLine, Fixnum, Hash)>

Update a line.

Parameters:

  • edge_id —

    Edge ID

  • line_id —

    Line ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(EdgeLine, Fixnum, Hash)>) —

    EdgeLine data, response status code and response headers



5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5592

def put_providers_edges_edge_id_lines_line_id_with_http_info(edge_id, line_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_edge_id_lines_line_id ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling put_providers_edges_edge_id_lines_line_id" if edge_id.nil?
  
  # verify the required parameter 'line_id' is set
  fail "Missing the required parameter 'line_id' when calling put_providers_edges_edge_id_lines_line_id" if line_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s).sub('{' + 'lineId' + '}', line_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EdgeLine')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_edge_id_lines_line_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id, opts = {}) ⇒ DomainLogicalInterface

Update an edge logical interface.

Parameters:

  • edge_id —

    Edge ID

  • interface_id —

    Interface ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



5838
5839
5840
5841
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5838

def put_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id, opts = {})
  data, status_code, headers = put_providers_edges_edge_id_logicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts)
  return data
end

#put_providers_edges_edge_id_logicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts = {}) ⇒ Array<(DomainLogicalInterface, Fixnum, Hash)>

Update an edge logical interface.

Parameters:

  • edge_id —

    Edge ID

  • interface_id —

    Interface ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DomainLogicalInterface, Fixnum, Hash)>) —

    DomainLogicalInterface data, response status code and response headers



5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5850

def put_providers_edges_edge_id_logicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_edge_id_logicalinterfaces_interface_id ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling put_providers_edges_edge_id_logicalinterfaces_interface_id" if edge_id.nil?
  
  # verify the required parameter 'interface_id' is set
  fail "Missing the required parameter 'interface_id' when calling put_providers_edges_edge_id_logicalinterfaces_interface_id" if interface_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s).sub('{' + 'interfaceId' + '}', interface_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainLogicalInterface')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_edge_id_logicalinterfaces_interface_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_edge_id_with_http_info(edge_id, opts = {}) ⇒ Array<(Edge, Fixnum, Hash)>

Update a edge.

Parameters:

  • edge_id —

    Edge ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Edge) —

    Edge

Returns:

  • (Array<(Edge, Fixnum, Hash)>) —

    Edge data, response status code and response headers



5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5333

def put_providers_edges_edge_id_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_edge_id ..."
  end
  
  # verify the required parameter 'edge_id' is set
  fail "Missing the required parameter 'edge_id' when calling put_providers_edges_edge_id" if edge_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/{edgeId}".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Edge')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_edge_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_edgegroups_edgegroup_id(edge_group_id, opts = {}) ⇒ EdgeGroup

Update an edge group.

Parameters:

  • edge_group_id —

    Edge group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1552
1553
1554
1555
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1552

def put_providers_edges_edgegroups_edgegroup_id(edge_group_id, opts = {})
  data, status_code, headers = put_providers_edges_edgegroups_edgegroup_id_with_http_info(edge_group_id, opts)
  return data
end

#put_providers_edges_edgegroups_edgegroup_id_with_http_info(edge_group_id, opts = {}) ⇒ Array<(EdgeGroup, Fixnum, Hash)>

Update an edge group.

Parameters:

  • edge_group_id —

    Edge group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(EdgeGroup, Fixnum, Hash)>) —

    EdgeGroup data, response status code and response headers



1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1563

def put_providers_edges_edgegroups_edgegroup_id_with_http_info(edge_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_edgegroups_edgegroup_id ..."
  end
  
  # verify the required parameter 'edge_group_id' is set
  fail "Missing the required parameter 'edge_group_id' when calling put_providers_edges_edgegroups_edgegroup_id" if edge_group_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}".sub('{format}','json').sub('{' + 'edgeGroupId' + '}', edge_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EdgeGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_edgegroups_edgegroup_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_endpoints_endpoint_id(endpoint_id, opts = {}) ⇒ Endpoint

Update endpoint

Parameters:

  • endpoint_id —

    Endpoint ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1919
1920
1921
1922
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1919

def put_providers_edges_endpoints_endpoint_id(endpoint_id, opts = {})
  data, status_code, headers = put_providers_edges_endpoints_endpoint_id_with_http_info(endpoint_id, opts)
  return data
end

#put_providers_edges_endpoints_endpoint_id_with_http_info(endpoint_id, opts = {}) ⇒ Array<(Endpoint, Fixnum, Hash)>

Update endpoint

Parameters:

  • endpoint_id —

    Endpoint ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Endpoint, Fixnum, Hash)>) —

    Endpoint data, response status code and response headers



1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1930

def put_providers_edges_endpoints_endpoint_id_with_http_info(endpoint_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_endpoints_endpoint_id ..."
  end
  
  # verify the required parameter 'endpoint_id' is set
  fail "Missing the required parameter 'endpoint_id' when calling put_providers_edges_endpoints_endpoint_id" if endpoint_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/endpoints/{endpointId}".sub('{format}','json').sub('{' + 'endpointId' + '}', endpoint_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Endpoint')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_endpoints_endpoint_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_extensionpools_extensionpool_id(extension_pool_id, opts = {}) ⇒ ExtensionPool

Update an extension pool by ID

Parameters:

  • extension_pool_id —

    Extension pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2230
2231
2232
2233
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2230

def put_providers_edges_extensionpools_extensionpool_id(extension_pool_id, opts = {})
  data, status_code, headers = put_providers_edges_extensionpools_extensionpool_id_with_http_info(extension_pool_id, opts)
  return data
end

#put_providers_edges_extensionpools_extensionpool_id_with_http_info(extension_pool_id, opts = {}) ⇒ Array<(ExtensionPool, Fixnum, Hash)>

Update an extension pool by ID

Parameters:

  • extension_pool_id —

    Extension pool ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ExtensionPool, Fixnum, Hash)>) —

    ExtensionPool data, response status code and response headers



2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2241

def put_providers_edges_extensionpools_extensionpool_id_with_http_info(extension_pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_extensionpools_extensionpool_id ..."
  end
  
  # verify the required parameter 'extension_pool_id' is set
  fail "Missing the required parameter 'extension_pool_id' when calling put_providers_edges_extensionpools_extensionpool_id" if extension_pool_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}".sub('{format}','json').sub('{' + 'extensionPoolId' + '}', extension_pool_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExtensionPool')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_extensionpools_extensionpool_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_extensions_extension_id(extension_id, opts = {}) ⇒ Extension

Update an extension by ID.

Parameters:

  • extension_id —

    Extension ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2486
2487
2488
2489
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2486

def put_providers_edges_extensions_extension_id(extension_id, opts = {})
  data, status_code, headers = put_providers_edges_extensions_extension_id_with_http_info(extension_id, opts)
  return data
end

#put_providers_edges_extensions_extension_id_with_http_info(extension_id, opts = {}) ⇒ Array<(Extension, Fixnum, Hash)>

Update an extension by ID.

Parameters:

  • extension_id —

    Extension ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Extension, Fixnum, Hash)>) —

    Extension data, response status code and response headers



2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2497

def put_providers_edges_extensions_extension_id_with_http_info(extension_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_extensions_extension_id ..."
  end
  
  # verify the required parameter 'extension_id' is set
  fail "Missing the required parameter 'extension_id' when calling put_providers_edges_extensions_extension_id" if extension_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/extensions/{extensionId}".sub('{format}','json').sub('{' + 'extensionId' + '}', extension_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Extension')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_extensions_extension_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_outboundroutes_outboundroute_id(outbound_route_id, opts = {}) ⇒ OutboundRoute

Update outbound route

Parameters:

  • outbound_route_id —

    Outbound route ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3062
3063
3064
3065
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3062

def put_providers_edges_outboundroutes_outboundroute_id(outbound_route_id, opts = {})
  data, status_code, headers = put_providers_edges_outboundroutes_outboundroute_id_with_http_info(outbound_route_id, opts)
  return data
end

#put_providers_edges_outboundroutes_outboundroute_id_with_http_info(outbound_route_id, opts = {}) ⇒ Array<(OutboundRoute, Fixnum, Hash)>

Update outbound route

Parameters:

  • outbound_route_id —

    Outbound route ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OutboundRoute, Fixnum, Hash)>) —

    OutboundRoute data, response status code and response headers



3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3073

def put_providers_edges_outboundroutes_outboundroute_id_with_http_info(outbound_route_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_outboundroutes_outboundroute_id ..."
  end
  
  # verify the required parameter 'outbound_route_id' is set
  fail "Missing the required parameter 'outbound_route_id' when calling put_providers_edges_outboundroutes_outboundroute_id" if outbound_route_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}".sub('{format}','json').sub('{' + 'outboundRouteId' + '}', outbound_route_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OutboundRoute')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_outboundroutes_outboundroute_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_phonebasesettings_phonebase_id(phone_base_id, opts = {}) ⇒ PhoneBase

Update a Phone Base Settings by ID

Parameters:

  • phone_base_id —

    Phone base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3497
3498
3499
3500
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3497

def put_providers_edges_phonebasesettings_phonebase_id(phone_base_id, opts = {})
  data, status_code, headers = put_providers_edges_phonebasesettings_phonebase_id_with_http_info(phone_base_id, opts)
  return data
end

#put_providers_edges_phonebasesettings_phonebase_id_with_http_info(phone_base_id, opts = {}) ⇒ Array<(PhoneBase, Fixnum, Hash)>

Update a Phone Base Settings by ID

Parameters:

  • phone_base_id —

    Phone base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(PhoneBase, Fixnum, Hash)>) —

    PhoneBase data, response status code and response headers



3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3508

def put_providers_edges_phonebasesettings_phonebase_id_with_http_info(phone_base_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_phonebasesettings_phonebase_id ..."
  end
  
  # verify the required parameter 'phone_base_id' is set
  fail "Missing the required parameter 'phone_base_id' when calling put_providers_edges_phonebasesettings_phonebase_id" if phone_base_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}".sub('{format}','json').sub('{' + 'phoneBaseId' + '}', phone_base_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PhoneBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_phonebasesettings_phonebase_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_phones_phone_id(phone_id, opts = {}) ⇒ Phone

Update a Phone by ID

Parameters:

  • phone_id —

    Phone ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



3942
3943
3944
3945
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3942

def put_providers_edges_phones_phone_id(phone_id, opts = {})
  data, status_code, headers = put_providers_edges_phones_phone_id_with_http_info(phone_id, opts)
  return data
end

#put_providers_edges_phones_phone_id_with_http_info(phone_id, opts = {}) ⇒ Array<(Phone, Fixnum, Hash)>

Update a Phone by ID

Parameters:

  • phone_id —

    Phone ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Phone, Fixnum, Hash)>) —

    Phone data, response status code and response headers



3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3953

def put_providers_edges_phones_phone_id_with_http_info(phone_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_phones_phone_id ..."
  end
  
  # verify the required parameter 'phone_id' is set
  fail "Missing the required parameter 'phone_id' when calling put_providers_edges_phones_phone_id" if phone_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/phones/{phoneId}".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Phone')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_phones_phone_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_sites_site_id(site_id, opts = {}) ⇒ Site

Update a endpoint.

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Site) —

    Site

Returns:



4319
4320
4321
4322
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4319

def put_providers_edges_sites_site_id(site_id, opts = {})
  data, status_code, headers = put_providers_edges_sites_site_id_with_http_info(site_id, opts)
  return data
end

#put_providers_edges_sites_site_id_numberplans(site_id, opts = {}) ⇒ Array<NumberPlan>

Update the list of Number Plans.

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



4504
4505
4506
4507
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4504

def put_providers_edges_sites_site_id_numberplans(site_id, opts = {})
  data, status_code, headers = put_providers_edges_sites_site_id_numberplans_with_http_info(site_id, opts)
  return data
end

#put_providers_edges_sites_site_id_numberplans_with_http_info(site_id, opts = {}) ⇒ Array<(Array<NumberPlan>, Fixnum, Hash)>

Update the list of Number Plans.

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<NumberPlan>, Fixnum, Hash)>) —

    Array<NumberPlan> data, response status code and response headers



4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4515

def put_providers_edges_sites_site_id_numberplans_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_sites_site_id_numberplans ..."
  end
  
  # verify the required parameter 'site_id' is set
  fail "Missing the required parameter 'site_id' when calling put_providers_edges_sites_site_id_numberplans" if site_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/sites/{siteId}/numberplans".sub('{format}','json').sub('{' + 'siteId' + '}', site_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<NumberPlan>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_sites_site_id_numberplans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_sites_site_id_with_http_info(site_id, opts = {}) ⇒ Array<(Site, Fixnum, Hash)>

Update a endpoint.

Parameters:

  • site_id —

    Site ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Site) —

    Site

Returns:

  • (Array<(Site, Fixnum, Hash)>) —

    Site data, response status code and response headers



4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4330

def put_providers_edges_sites_site_id_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_sites_site_id ..."
  end
  
  # verify the required parameter 'site_id' is set
  fail "Missing the required parameter 'site_id' when calling put_providers_edges_sites_site_id" if site_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/sites/{siteId}".sub('{format}','json').sub('{' + 'siteId' + '}', site_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Site')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_sites_site_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id, opts = {}) ⇒ TrunkBase

Update a Trunk Base Settings object by ID

Parameters:

  • trunk_base_settings_id —

    Trunk Base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



5137
5138
5139
5140
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5137

def put_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id, opts = {})
  data, status_code, headers = put_providers_edges_trunkbasesettings_trunkbasesettings_id_with_http_info(trunk_base_settings_id, opts)
  return data
end

#put_providers_edges_trunkbasesettings_trunkbasesettings_id_with_http_info(trunk_base_settings_id, opts = {}) ⇒ Array<(TrunkBase, Fixnum, Hash)>

Update a Trunk Base Settings object by ID

Parameters:

  • trunk_base_settings_id —

    Trunk Base ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TrunkBase, Fixnum, Hash)>) —

    TrunkBase data, response status code and response headers



5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5148

def put_providers_edges_trunkbasesettings_trunkbasesettings_id_with_http_info(trunk_base_settings_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_providers_edges_trunkbasesettings_trunkbasesettings_id ..."
  end
  
  # verify the required parameter 'trunk_base_settings_id' is set
  fail "Missing the required parameter 'trunk_base_settings_id' when calling put_providers_edges_trunkbasesettings_trunkbasesettings_id" if trunk_base_settings_id.nil?
  
  # resource path
  path = "/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}".sub('{format}','json').sub('{' + 'trunkBaseSettingsId' + '}', trunk_base_settings_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TrunkBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_providers_edges_trunkbasesettings_trunkbasesettings_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end