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.



23
24
25
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 21

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) 


32
33
34
35
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 32

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



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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 42

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
  local_var_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, local_var_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) 


92
93
94
95
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 92

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



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
139
140
141
142
143
144
145
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 102

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
  local_var_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, local_var_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) 


152
153
154
155
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 152

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) 


213
214
215
216
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 213

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



224
225
226
227
228
229
230
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 224

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
  local_var_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, local_var_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) 


276
277
278
279
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 276

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 286

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
  local_var_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, local_var_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



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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 162

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
  local_var_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, local_var_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) 


336
337
338
339
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 336

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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 346

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
  local_var_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, local_var_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) 


396
397
398
399
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 396

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



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
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 406

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
  local_var_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, local_var_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) 


456
457
458
459
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 456

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



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
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 466

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
  local_var_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, local_var_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) 


516
517
518
519
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 516

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



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
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 526

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
  local_var_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, local_var_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) 


576
577
578
579
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 576

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



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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 586

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
  local_var_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, local_var_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) 


636
637
638
639
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 636

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



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 646

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
  local_var_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, local_var_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) 


696
697
698
699
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 696

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



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
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 706

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
  local_var_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, local_var_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) 


756
757
758
759
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 756

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



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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 766

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
  local_var_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, local_var_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :name (String) —

    Name

  • :site_id (String) —

    Filter by site.id

  • :edge_group_id (String) —

    Filter by edgeGroup.id

  • :sort_by (String) —

    Sort by (default to name)

Returns:



821
822
823
824
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 821

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:



888
889
890
891
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 888

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:



944
945
946
947
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 944

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



954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 954

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
  local_var_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, local_var_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:



897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 897

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
  local_var_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, local_var_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Sort by (default to number)

Returns:



1006
1007
1008
1009
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1006

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:



1068
1069
1070
1071
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1068

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



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1078

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
  local_var_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, local_var_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



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1018

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
  local_var_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, local_var_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Sort by (default to number)

  • :sort_order (String) —

    Sort order (default to ASC)

  • :phone_number (String) —

    Filter by phoneNumber

Returns:



1132
1133
1134
1135
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1132

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:



1198
1199
1200
1201
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1198

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



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
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1208

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
  local_var_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, local_var_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



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1146

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
  local_var_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, local_var_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:



1258
1259
1260
1261
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1258

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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



1320
1321
1322
1323
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1320

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:



1385
1386
1387
1388
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1385

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



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
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1396

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
  local_var_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, local_var_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



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
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1332

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
  local_var_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, local_var_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:



1449
1450
1451
1452
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1449

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:



1510
1511
1512
1513
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1510

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



1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1521

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
  local_var_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, local_var_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:



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
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1459

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
  local_var_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, local_var_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:



1575
1576
1577
1578
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1575

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



1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1586

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
  local_var_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, local_var_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:



1639
1640
1641
1642
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1639

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:



1700
1701
1702
1703
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1700

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



1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1711

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
  local_var_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, local_var_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:



1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1649

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
  local_var_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, local_var_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:



1764
1765
1766
1767
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1764

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:



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1774

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
  local_var_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, local_var_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:



1824
1825
1826
1827
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1824

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:



1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1834

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
  local_var_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, local_var_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



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
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1268

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
  local_var_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, local_var_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by (default to name)

Returns:



1887
1888
1889
1890
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1887

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:



1951
1952
1953
1954
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1951

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



1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1961

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
  local_var_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, local_var_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



1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 1900

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
  local_var_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, local_var_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:



2010
2011
2012
2013
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2010

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



2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2019

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
  local_var_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, local_var_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by (default to name)

Returns:



2069
2070
2071
2072
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2069

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:



2133
2134
2135
2136
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2133

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



2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2143

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
  local_var_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, local_var_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



2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2082

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
  local_var_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, local_var_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Sort by (default to startNumber)

  • :number (String) —

    Number

Returns:



2196
2197
2198
2199
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2196

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:



2260
2261
2262
2263
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2260

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



2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2270

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
  local_var_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, local_var_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



2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2209

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
  local_var_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, local_var_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Sort by (default to number)

  • :sort_order (String) —

    Sort order (default to ASC)

  • :number (String) —

    Filter by number

Returns:



2324
2325
2326
2327
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2324

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:



2390
2391
2392
2393
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2390

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



2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2400

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
  local_var_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, local_var_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



2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2338

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
  local_var_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, local_var_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 (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :sort_by (String) —

    Value by which to sort (default to name)

  • :sort_order (String) —

    Sort order (default to ASC)

Returns:



2453
2454
2455
2456
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2453

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:



2517
2518
2519
2520
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2517

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



2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2527

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
  local_var_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, local_var_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



2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2466

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
  local_var_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, local_var_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :name (String) —

    Name

  • :sort_by (String) —

    Value by which to sort (default to name)

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

Returns:



2581
2582
2583
2584
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2581

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:



2647
2648
2649
2650
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2647

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



2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2657

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
  local_var_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, local_var_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:



2707
2708
2709
2710
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2707

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



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
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2717

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
  local_var_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, local_var_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



2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2595

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
  local_var_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, local_var_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :name (String) —

    Name

  • :site_id (String) —

    Filter by site.id

  • :sort_by (String) —

    Sort by (default to name)

Returns:



2772
2773
2774
2775
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2772

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:



2838
2839
2840
2841
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2838

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



2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2848

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
  local_var_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, local_var_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



2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2786

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
  local_var_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, local_var_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 (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :sort_by (String) —

    Value by which to sort (default to name)

  • :sort_order (String) —

    Sort order (default to ASC)

Returns:



2901
2902
2903
2904
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2901

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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



2966
2967
2968
2969
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2966

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



2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2977

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
  local_var_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, local_var_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:



3026
3027
3028
3029
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3026

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



3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3036

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
  local_var_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, local_var_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:



3086
3087
3088
3089
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3086

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



3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3096

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
  local_var_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, local_var_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



2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 2914

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
  local_var_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, local_var_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 (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :sort_by (String) —

    Value by which to sort (default to name)

  • :sort_order (String) —

    Sort order (default to ASC)

  • :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:



3155
3156
3157
3158
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3155

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:



3229
3230
3231
3232
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3229

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



3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3239

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
  local_var_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, local_var_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:



3289
3290
3291
3292
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3289

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



3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3299

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
  local_var_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, local_var_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



3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3173

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
  local_var_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, local_var_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Sort by (default to name)

  • :sort_order (String) —

    Sort order (default to ASC)

  • :name (String) —

    Name

  • :location_id (String) —

    Location Id

Returns:



3355
3356
3357
3358
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3355

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:



3423
3424
3425
3426
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3423

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:



3483
3484
3485
3486
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3483

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>) 


3544
3545
3546
3547
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3544

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



3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3555

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
  local_var_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, local_var_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:



3607
3608
3609
3610
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3607

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



3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3618

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
  local_var_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, local_var_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



3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3493

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
  local_var_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, local_var_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



3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3433

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
  local_var_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, local_var_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



3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3370

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
  local_var_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, local_var_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 (default to 1000)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



3672
3673
3674
3675
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3672

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



3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3683

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
  local_var_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, local_var_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 (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :sort_by (String) —

    Value by which to sort (default to name)

  • :sort_order (String) —

    Sort order (default to ASC)

Returns:



3735
3736
3737
3738
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3735

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) — default: default to 25
  • :page_number (Integer) — default: default to 1

Returns:



3801
3802
3803
3804
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3801

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



3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3813

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
  local_var_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, local_var_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:



3867
3868
3869
3870
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3867

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



3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3877

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
  local_var_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, local_var_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:



3928
3929
3930
3931
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3928

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



3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3938

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
  local_var_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, local_var_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



3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3748

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
  local_var_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, local_var_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_trunks(opts = {}) ⇒ TrunkEntityListing

Get the list of available trunks. Trunks are created by assigning trunk base settings to an Edge or Edge Group.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :sort_by (String) —

    Value by which to sort (default to name)

  • :sort_order (String) —

    Sort order (default to ASC)

  • :edge_id (String) —

    Filter by Edge Ids

  • :trunk_base_id (String) —

    Filter by Trunk Base Ids

  • :trunk_type (String) —

    Filter by a Trunk type

Returns:



3994
3995
3996
3997
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 3994

def get_providers_edges_trunks(opts = {})
  data, status_code, headers = get_providers_edges_trunks_with_http_info(opts)
  return data
end

#get_providers_edges_trunks_trunk_id(trunk_id, opts = {}) ⇒ Trunk

Get a Trunk by ID

Parameters:

  • trunk_id —

    Trunk ID

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

    the optional parameters

Returns:



4068
4069
4070
4071
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4068

def get_providers_edges_trunks_trunk_id(trunk_id, opts = {})
  data, status_code, headers = get_providers_edges_trunks_trunk_id_with_http_info(trunk_id, opts)
  return data
end

#get_providers_edges_trunks_trunk_id_with_http_info(trunk_id, opts = {}) ⇒ Array<(Trunk, Fixnum, Hash)>

Get a Trunk by ID

Parameters:

  • trunk_id —

    Trunk ID

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

    the optional parameters

Returns:

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

    Trunk data, response status code and response headers



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
4119
4120
4121
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4078

def get_providers_edges_trunks_trunk_id_with_http_info(trunk_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_trunks_trunk_id ..."
  end
  
  # verify the required parameter 'trunk_id' is set
  fail "Missing the required parameter 'trunk_id' when calling get_providers_edges_trunks_trunk_id" if trunk_id.nil?
  
  # resource path
  local_var_path = "/api/v2/telephony/providers/edges/trunks/{trunkId}".sub('{format}','json').sub('{' + 'trunkId' + '}', trunk_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, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Trunk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_trunks_trunk_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_providers_edges_trunks_with_http_info(opts = {}) ⇒ Array<(TrunkEntityListing, Fixnum, Hash)>

Get the list of available trunks. Trunks are created by assigning trunk base settings to an Edge or Edge Group.

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

  • :edge_id (String) —

    Filter by Edge Ids

  • :trunk_base_id (String) —

    Filter by Trunk Base Ids

  • :trunk_type (String) —

    Filter by a Trunk type

Returns:

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

    TrunkEntityListing data, response status code and response headers



4010
4011
4012
4013
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
4059
4060
4061
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4010

def get_providers_edges_trunks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_trunks ..."
  end
  
  if opts[:'trunk_type'] && !['EXTERNAL', 'PHONE', 'EDGE'].include?(opts[:'trunk_type'])
    fail 'invalid value for "trunk_type", must be one of EXTERNAL, PHONE, EDGE'
  end
  
  # resource path
  local_var_path = "/api/v2/telephony/providers/edges/trunks".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[:'edge.id'] = opts[:'edge_id'] if opts[:'edge_id']
  query_params[:'trunkBase.id'] = opts[:'trunk_base_id'] if opts[:'trunk_base_id']
  query_params[:'trunkType'] = opts[:'trunk_type'] if opts[:'trunk_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, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TrunkEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_trunks\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



836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 836

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
  local_var_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, local_var_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



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

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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



4191
4192
4193
4194
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4191

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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



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

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:



4328
4329
4330
4331
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4328

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_extensiontype_metadata_id(schema_category, schema_type, schema_id, extension_type, metadata_id, opts = {}) ⇒ Organization

Get metadata for a schema

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • schema_id —

    Schema ID

  • extension_type —

    extension

  • metadata_id —

    Metadata ID

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Type

Returns:



4401
4402
4403
4404
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4401

def get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id(schema_category, schema_type, schema_id, extension_type, metadata_id, opts = {})
  data, status_code, headers = get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id_with_http_info(schema_category, schema_type, schema_id, extension_type, metadata_id, opts)
  return data
end

#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id_with_http_info(schema_category, schema_type, schema_id, extension_type, 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_type —

    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



4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4416

def get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id_with_http_info(schema_category, schema_type, schema_id, extension_type, metadata_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_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_extensiontype_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_extensiontype_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_extensiontype_metadata_id" if schema_id.nil?
  
  # verify the required parameter 'extension_type' is set
  fail "Missing the required parameter 'extension_type' when calling get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id" if extension_type.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_extensiontype_metadata_id" if metadata_id.nil?
  
  # resource path
  local_var_path = "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId}".sub('{format}','json').sub('{' + 'schemaCategory' + '}', schema_category.to_s).sub('{' + 'schemaType' + '}', schema_type.to_s).sub('{' + 'schemaId' + '}', schema_id.to_s).sub('{' + 'extensionType' + '}', extension_type.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, local_var_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_extensiontype_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



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
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4340

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
  local_var_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, local_var_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:



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
4312
4313
4314
4315
4316
4317
4318
4319
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4271

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
  local_var_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, local_var_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:



4203
4204
4205
4206
4207
4208
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4203

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
  local_var_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, local_var_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:



4140
4141
4142
4143
4144
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4140

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
  local_var_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, local_var_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:



4479
4480
4481
4482
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4479

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:



4536
4537
4538
4539
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4536

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



4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4546

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
  local_var_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, local_var_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:



4593
4594
4595
4596
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4593

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



4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4603

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
  local_var_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, local_var_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:



4650
4651
4652
4653
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4650

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



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
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4660

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
  local_var_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, local_var_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:



4708
4709
4710
4711
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4708

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



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
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4719

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
  local_var_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, local_var_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:



4770
4771
4772
4773
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4770

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) 


4833
4834
4835
4836
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4833

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



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
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4845

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
  local_var_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, local_var_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



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
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4781

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
  local_var_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, local_var_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) 


4897
4898
4899
4900
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4897

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



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
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4907

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
  local_var_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, local_var_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:



4958
4959
4960
4961
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4958

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:



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
5007
5008
5009
5010
5011
5012
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4969

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
  local_var_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, local_var_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) 


5019
5020
5021
5022
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5019

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



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
5069
5070
5071
5072
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5029

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
  local_var_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, local_var_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:



5079
5080
5081
5082
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5079

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



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 5089

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
  local_var_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, local_var_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:



5136
5137
5138
5139
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5136

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



5146
5147
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5146

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
  local_var_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, local_var_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:



5193
5194
5195
5196
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5193

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



5203
5204
5205
5206
5207
5208
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5203

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
  local_var_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, local_var_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:



5250
5251
5252
5253
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5250

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



5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5260

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
  local_var_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, local_var_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:



5307
5308
5309
5310
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5307

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



5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5317

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
  local_var_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, local_var_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:



5364
5365
5366
5367
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5364

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) 


5421
5422
5423
5424
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5421

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



5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5431

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
  local_var_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, local_var_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) 


5480
5481
5482
5483
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5480

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



5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5490

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
  local_var_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, local_var_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



5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5374

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
  local_var_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, local_var_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:



5536
5537
5538
5539
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5536

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) 


5593
5594
5595
5596
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5593

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



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
5640
5641
5642
5643
5644
5645
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5603

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
  local_var_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, local_var_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



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
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5546

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
  local_var_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, local_var_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:



5652
5653
5654
5655
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5652

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



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
5701
5702
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5662

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
  local_var_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, local_var_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



4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 4489

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
  local_var_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, local_var_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:



5710
5711
5712
5713
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5710

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



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
5764
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5721

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
  local_var_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, local_var_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:



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

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



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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5783

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
  local_var_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, local_var_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:



5834
5835
5836
5837
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5834

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



5845
5846
5847
5848
5849
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5845

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
  local_var_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, local_var_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:



5896
5897
5898
5899
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5896

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:



5959
5960
5961
5962
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5959

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



5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5971

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
  local_var_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, local_var_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:



6026
6027
6028
6029
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6026

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



6038
6039
6040
6041
6042
6043
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6038

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
  local_var_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, local_var_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



5907
5908
5909
5910
5911
5912
5913
5914
5915
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 5907

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
  local_var_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, local_var_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:



6092
6093
6094
6095
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6092

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



6103
6104
6105
6106
6107
6108
6109
6110
6111
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6103

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
  local_var_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, local_var_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:



6154
6155
6156
6157
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6154

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



6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6165

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
  local_var_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, local_var_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:



6216
6217
6218
6219
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6216

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



6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6227

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
  local_var_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, local_var_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:



6278
6279
6280
6281
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6278

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



6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6289

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
  local_var_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, local_var_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:



6340
6341
6342
6343
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6340

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



6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6351

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
  local_var_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, local_var_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:



6402
6403
6404
6405
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6402

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



6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6413

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
  local_var_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, local_var_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:



6464
6465
6466
6467
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6464

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



6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6475

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
  local_var_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, local_var_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:



6526
6527
6528
6529
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6526

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:



6588
6589
6590
6591
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6588

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



6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6599

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
  local_var_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, local_var_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



6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
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
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6537

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
  local_var_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, local_var_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:



6650
6651
6652
6653
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6650

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



6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
 
# File 'lib/purecloud/api/telephony_providers_edge_api.rb', line 6661

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
  local_var_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, local_var_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