Class: PureCloud::TelephonyProvidersEdgeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_telephony_providers_edge(edge_id, opts = {}) ⇒ nil

Delete a edge.

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_telephony_providers_edge(edge_id, opts = {})
  delete_telephony_providers_edge_with_http_info(edge_id, opts)
  return nil
end

#delete_telephony_providers_edge_logicalinterface(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) 


97
98
99
100
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 97

def delete_telephony_providers_edge_logicalinterface(edge_id, interface_id, opts = {})
  delete_telephony_providers_edge_logicalinterface_with_http_info(edge_id, interface_id, opts)
  return nil
end

#delete_telephony_providers_edge_logicalinterface_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



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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 108

def delete_telephony_providers_edge_logicalinterface_with_http_info(edge_id, interface_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edge_logicalinterface ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edge_logicalinterface" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'interface_id' is set
  fail ArgumentError, "Missing the required parameter 'interface_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edge_logicalinterface" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_logicalinterface\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edge_softwareupdate(edge_id, opts = {}) ⇒ nil

Cancels any in-progress update for this edge.

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Returns:

  • (nil) 


170
171
172
173
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 170

def delete_telephony_providers_edge_softwareupdate(edge_id, opts = {})
  delete_telephony_providers_edge_softwareupdate_with_http_info(edge_id, opts)
  return nil
end

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

Cancels any in-progress update for this edge.

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 180

def delete_telephony_providers_edge_softwareupdate_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edge_softwareupdate ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edge_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_softwareupdate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a edge.

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Returns:

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

    nil, 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
86
87
88
89
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 42

def delete_telephony_providers_edge_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edge ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edge" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edges_certificateauthority(certificate_id, opts = {}) ⇒ nil

Delete a certificate authority.

Parameters:

  • certificate_id —

    Certificate ID

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

    the optional parameters

Returns:

  • (nil) 


234
235
236
237
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 234

def delete_telephony_providers_edges_certificateauthority(certificate_id, opts = {})
  delete_telephony_providers_edges_certificateauthority_with_http_info(certificate_id, opts)
  return nil
end

#delete_telephony_providers_edges_certificateauthority_with_http_info(certificate_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a certificate authority.

Parameters:

  • certificate_id —

    Certificate ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 244

def delete_telephony_providers_edges_certificateauthority_with_http_info(certificate_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edges_certificateauthority ..."
  end
  
  
  # verify the required parameter 'certificate_id' is set
  fail ArgumentError, "Missing the required parameter 'certificate_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edges_certificateauthority" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_certificateauthority\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edges_didpool(did_pool_id, opts = {}) ⇒ nil

Delete a DID Pool by ID.

Parameters:

  • did_pool_id —

    DID pool ID

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

    the optional parameters

Returns:

  • (nil) 


298
299
300
301
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 298

def delete_telephony_providers_edges_didpool(did_pool_id, opts = {})
  delete_telephony_providers_edges_didpool_with_http_info(did_pool_id, opts)
  return nil
end

#delete_telephony_providers_edges_didpool_with_http_info(did_pool_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a DID Pool by ID.

Parameters:

  • did_pool_id —

    DID pool ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 308

def delete_telephony_providers_edges_didpool_with_http_info(did_pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edges_didpool ..."
  end
  
  
  # verify the required parameter 'did_pool_id' is set
  fail ArgumentError, "Missing the required parameter 'did_pool_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edges_didpool" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_didpool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edges_edgegroup(edge_group_id, opts = {}) ⇒ nil

Delete an edge group.

Parameters:

  • edge_group_id —

    Edge group ID

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

    the optional parameters

Returns:

  • (nil) 


362
363
364
365
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 362

def delete_telephony_providers_edges_edgegroup(edge_group_id, opts = {})
  delete_telephony_providers_edges_edgegroup_with_http_info(edge_group_id, opts)
  return nil
end

#delete_telephony_providers_edges_edgegroup_with_http_info(edge_group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an edge group.

Parameters:

  • edge_group_id —

    Edge group ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 372

def delete_telephony_providers_edges_edgegroup_with_http_info(edge_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edges_edgegroup ..."
  end
  
  
  # verify the required parameter 'edge_group_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_group_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edges_edgegroup" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_edgegroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edges_endpoint(endpoint_id, opts = {}) ⇒ nil

Delete endpoint

Parameters:

  • endpoint_id —

    Endpoint ID

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

    the optional parameters

Returns:

  • (nil) 


426
427
428
429
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 426

def delete_telephony_providers_edges_endpoint(endpoint_id, opts = {})
  delete_telephony_providers_edges_endpoint_with_http_info(endpoint_id, opts)
  return nil
end

#delete_telephony_providers_edges_endpoint_with_http_info(endpoint_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete endpoint

Parameters:

  • endpoint_id —

    Endpoint ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 436

def delete_telephony_providers_edges_endpoint_with_http_info(endpoint_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edges_endpoint ..."
  end
  
  
  # verify the required parameter 'endpoint_id' is set
  fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edges_endpoint" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_endpoint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edges_extensionpool(extension_pool_id, opts = {}) ⇒ nil

Delete an extension pool by ID

Parameters:

  • extension_pool_id —

    Extension pool ID

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

    the optional parameters

Returns:

  • (nil) 


490
491
492
493
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 490

def delete_telephony_providers_edges_extensionpool(extension_pool_id, opts = {})
  delete_telephony_providers_edges_extensionpool_with_http_info(extension_pool_id, opts)
  return nil
end

#delete_telephony_providers_edges_extensionpool_with_http_info(extension_pool_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an extension pool by ID

Parameters:

  • extension_pool_id —

    Extension pool ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 500

def delete_telephony_providers_edges_extensionpool_with_http_info(extension_pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edges_extensionpool ..."
  end
  
  
  # verify the required parameter 'extension_pool_id' is set
  fail ArgumentError, "Missing the required parameter 'extension_pool_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edges_extensionpool" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_extensionpool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edges_outboundroute(outbound_route_id, opts = {}) ⇒ nil

Delete Outbound Route

Parameters:

  • outbound_route_id —

    Outbound route ID

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

    the optional parameters

Returns:

  • (nil) 


554
555
556
557
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 554

def delete_telephony_providers_edges_outboundroute(outbound_route_id, opts = {})
  delete_telephony_providers_edges_outboundroute_with_http_info(outbound_route_id, opts)
  return nil
end

#delete_telephony_providers_edges_outboundroute_with_http_info(outbound_route_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Outbound Route

Parameters:

  • outbound_route_id —

    Outbound route ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_telephony_providers_edges_outboundroute_with_http_info(outbound_route_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edges_outboundroute ..."
  end
  
  
  # verify the required parameter 'outbound_route_id' is set
  fail ArgumentError, "Missing the required parameter 'outbound_route_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edges_outboundroute" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_outboundroute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edges_phone(phone_id, opts = {}) ⇒ nil

Delete a Phone by ID

Parameters:

  • phone_id —

    Phone ID

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

    the optional parameters

Returns:

  • (nil) 


618
619
620
621
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 618

def delete_telephony_providers_edges_phone(phone_id, opts = {})
  delete_telephony_providers_edges_phone_with_http_info(phone_id, opts)
  return nil
end

#delete_telephony_providers_edges_phone_with_http_info(phone_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Phone by ID

Parameters:

  • phone_id —

    Phone ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 628

def delete_telephony_providers_edges_phone_with_http_info(phone_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edges_phone ..."
  end
  
  
  # verify the required parameter 'phone_id' is set
  fail ArgumentError, "Missing the required parameter 'phone_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edges_phone" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_phone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edges_phonebasesetting(phone_base_id, opts = {}) ⇒ nil

Delete a Phone Base Settings by ID

Parameters:

  • phone_base_id —

    Phone base ID

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

    the optional parameters

Returns:

  • (nil) 


682
683
684
685
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 682

def delete_telephony_providers_edges_phonebasesetting(phone_base_id, opts = {})
  delete_telephony_providers_edges_phonebasesetting_with_http_info(phone_base_id, opts)
  return nil
end

#delete_telephony_providers_edges_phonebasesetting_with_http_info(phone_base_id, opts = {}) ⇒ Array<(nil, 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<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 692

def delete_telephony_providers_edges_phonebasesetting_with_http_info(phone_base_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edges_phonebasesetting ..."
  end
  
  
  # verify the required parameter 'phone_base_id' is set
  fail ArgumentError, "Missing the required parameter 'phone_base_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edges_phonebasesetting" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_phonebasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edges_site(site_id, opts = {}) ⇒ nil

Delete a Site by ID

Parameters:

  • site_id —

    Site ID

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

    the optional parameters

Returns:

  • (nil) 


746
747
748
749
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 746

def delete_telephony_providers_edges_site(site_id, opts = {})
  delete_telephony_providers_edges_site_with_http_info(site_id, opts)
  return nil
end

#delete_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id, opts = {}) ⇒ nil

Delete Outbound Route

Parameters:

  • site_id —

    Site ID

  • outbound_route_id —

    Outbound route ID

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

    the optional parameters

Returns:

  • (nil) 


811
812
813
814
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 811

def delete_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id, opts = {})
  delete_telephony_providers_edges_site_outboundroute_with_http_info(site_id, outbound_route_id, opts)
  return nil
end

#delete_telephony_providers_edges_site_outboundroute_with_http_info(site_id, outbound_route_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Outbound Route

Parameters:

  • site_id —

    Site ID

  • outbound_route_id —

    Outbound route ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 822

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_site_outboundroute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edges_site_with_http_info(site_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Site by ID

Parameters:

  • site_id —

    Site ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 756

def delete_telephony_providers_edges_site_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edges_site ..."
  end
  
  
  # verify the required parameter 'site_id' is set
  fail ArgumentError, "Missing the required parameter 'site_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edges_site" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_site\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_telephony_providers_edges_trunkbasesetting(trunk_base_settings_id, opts = {}) ⇒ nil

Delete a Trunk Base Settings object by ID

Parameters:

  • trunk_base_settings_id —

    Trunk Base ID

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

    the optional parameters

Returns:

  • (nil) 


884
885
886
887
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 884

def delete_telephony_providers_edges_trunkbasesetting(trunk_base_settings_id, opts = {})
  delete_telephony_providers_edges_trunkbasesetting_with_http_info(trunk_base_settings_id, opts)
  return nil
end

#delete_telephony_providers_edges_trunkbasesetting_with_http_info(trunk_base_settings_id, opts = {}) ⇒ Array<(nil, 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<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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

def delete_telephony_providers_edges_trunkbasesetting_with_http_info(trunk_base_settings_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.delete_telephony_providers_edges_trunkbasesetting ..."
  end
  
  
  # verify the required parameter 'trunk_base_settings_id' is set
  fail ArgumentError, "Missing the required parameter 'trunk_base_settings_id' when calling TelephonyProvidersEdgeApi.delete_telephony_providers_edges_trunkbasesetting" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_trunkbasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_configuration_schemas_edges_vnext(opts = {}) ⇒ SchemaCategoryEntityListing

Lists available schema categories (Deprecated)

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:



949
950
951
952
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 949

def get_configuration_schemas_edges_vnext(opts = {})
  data, _status_code, _headers = get_configuration_schemas_edges_vnext_with_http_info(opts)
  return data
end

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

List schemas of a specific category (Deprecated)

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:



1023
1024
1025
1026
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1023

def get_configuration_schemas_edges_vnext_schema_category(schema_category, opts = {})
  data, _status_code, _headers = get_configuration_schemas_edges_vnext_schema_category_with_http_info(schema_category, opts)
  return data
end

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

List schemas of a specific category (Deprecated)

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:



1107
1108
1109
1110
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1107

def get_configuration_schemas_edges_vnext_schema_category_schema_type(schema_category, schema_type, opts = {})
  data, _status_code, _headers = get_configuration_schemas_edges_vnext_schema_category_schema_type_with_http_info(schema_category, schema_type, opts)
  return data
end

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

Get a json schema (Deprecated)

Parameters:

  • schema_category —

    Schema category

  • schema_type —

    Schema type

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:



1199
1200
1201
1202
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1199

def get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id(schema_category, schema_type, schema_id, opts = {})
  data, _status_code, _headers = get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_with_http_info(schema_category, schema_type, schema_id, opts)
  return data
end

#get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_metadata_id(schema_category, schema_type, schema_id, extension_type, metadata_id, opts = {}) ⇒ Organization

Get metadata for a schema (Deprecated)

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:



1287
1288
1289
1290
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1287

def get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_metadata_id(schema_category, schema_type, schema_id, extension_type, metadata_id, opts = {})
  data, _status_code, _headers = get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_metadata_id_with_http_info(schema_category, schema_type, schema_id, extension_type, metadata_id, opts)
  return data
end

#get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_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 (Deprecated)

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



1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1302

def get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_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_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_metadata_id ..."
  end
  
  
  # verify the required parameter 'schema_category' is set
  fail ArgumentError, "Missing the required parameter 'schema_category' when calling TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_metadata_id" if schema_category.nil?
  
  
  
  
  
  
  # verify the required parameter 'schema_type' is set
  fail ArgumentError, "Missing the required parameter 'schema_type' when calling TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_metadata_id" if schema_type.nil?
  
  
  
  
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_metadata_id" if schema_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'extension_type' is set
  fail ArgumentError, "Missing the required parameter 'extension_type' when calling TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_metadata_id" if extension_type.nil?
  
  
  
  
  
  
  # verify the required parameter 'metadata_id' is set
  fail ArgumentError, "Missing the required parameter 'metadata_id' when calling TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_extension_type_metadata_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id_with_http_info(schema_category, schema_type, schema_id, opts = {}) ⇒ Array<(Organization, Fixnum, Hash)>

Get a json schema (Deprecated)

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



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
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1211

def get_configuration_schemas_edges_vnext_schema_category_schema_type_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_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id ..."
  end
  
  
  # verify the required parameter 'schema_category' is set
  fail ArgumentError, "Missing the required parameter 'schema_category' when calling TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id" if schema_category.nil?
  
  
  
  
  
  
  # verify the required parameter 'schema_type' is set
  fail ArgumentError, "Missing the required parameter 'schema_type' when calling TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id" if schema_type.nil?
  
  
  
  
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category_schema_type_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_configuration_schemas_edges_vnext_schema_category_schema_type_schema_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_configuration_schemas_edges_vnext_schema_category_schema_type_with_http_info(schema_category, schema_type, opts = {}) ⇒ Array<(SchemaReferenceEntityListing, Fixnum, Hash)>

List schemas of a specific category (Deprecated)

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:



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

def get_configuration_schemas_edges_vnext_schema_category_schema_type_with_http_info(schema_category, schema_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category_schema_type ..."
  end
  
  
  # verify the required parameter 'schema_category' is set
  fail ArgumentError, "Missing the required parameter 'schema_category' when calling TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category_schema_type" if schema_category.nil?
  
  
  
  
  
  
  # verify the required parameter 'schema_type' is set
  fail ArgumentError, "Missing the required parameter 'schema_type' when calling TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category_schema_type" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_configuration_schemas_edges_vnext_schema_category_schema_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_configuration_schemas_edges_vnext_schema_category_with_http_info(schema_category, opts = {}) ⇒ Array<(SchemaReferenceEntityListing, Fixnum, Hash)>

List schemas of a specific category (Deprecated)

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:



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
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1035

def get_configuration_schemas_edges_vnext_schema_category_with_http_info(schema_category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category ..."
  end
  
  
  # verify the required parameter 'schema_category' is set
  fail ArgumentError, "Missing the required parameter 'schema_category' when calling TelephonyProvidersEdgeApi.get_configuration_schemas_edges_vnext_schema_category" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_configuration_schemas_edges_vnext_schema_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_configuration_schemas_edges_vnext_with_http_info(opts = {}) ⇒ Array<(SchemaCategoryEntityListing, Fixnum, Hash)>

Lists available schema categories (Deprecated)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



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
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 960

def get_configuration_schemas_edges_vnext_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_configuration_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_configuration_schemas_edges_vnext\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get edge.

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

Returns:



1397
1398
1399
1400
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1397

def get_telephony_providers_edge(edge_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_with_http_info(edge_id, opts)
  return data
end

#get_telephony_providers_edge_line(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:



1471
1472
1473
1474
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1471

def get_telephony_providers_edge_line(edge_id, line_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_line_with_http_info(edge_id, line_id, opts)
  return data
end

#get_telephony_providers_edge_line_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



1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1482

def get_telephony_providers_edge_line_with_http_info(edge_id, line_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge_line ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_line" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'line_id' is set
  fail ArgumentError, "Missing the required parameter 'line_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_line" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edge_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:



1547
1548
1549
1550
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1547

def get_telephony_providers_edge_lines(edge_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_lines_with_http_info(edge_id, opts)
  return data
end

#get_telephony_providers_edge_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



1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1559

def get_telephony_providers_edge_lines_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge_lines ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_lines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edge_logicalinterface(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

Options Hash (opts):

  • :expand (Array<String>) —

    Field to expand in the response

Returns:



1630
1631
1632
1633
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1630

def get_telephony_providers_edge_logicalinterface(edge_id, interface_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_logicalinterface_with_http_info(edge_id, interface_id, opts)
  return data
end

#get_telephony_providers_edge_logicalinterface_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

Options Hash (opts):

  • :expand (Array<String>) —

    Field to expand in the response

Returns:

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

    DomainLogicalInterface data, response status code and response headers



1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1642

def get_telephony_providers_edge_logicalinterface_with_http_info(edge_id, interface_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge_logicalinterface ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_logicalinterface" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'interface_id' is set
  fail ArgumentError, "Missing the required parameter 'interface_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_logicalinterface" 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 = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_logicalinterface\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edge_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

Options Hash (opts):

  • :expand (Array<String>) —

    Field to expand in the response

Returns:



1713
1714
1715
1716
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1713

def get_telephony_providers_edge_logicalinterfaces(edge_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_logicalinterfaces_with_http_info(edge_id, opts)
  return data
end

#get_telephony_providers_edge_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

Options Hash (opts):

  • :expand (Array<String>) —

    Field to expand in the response

Returns:



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
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1724

def get_telephony_providers_edge_logicalinterfaces_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge_logicalinterfaces ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_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 = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_logicalinterfaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edge_logs_job(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:



1787
1788
1789
1790
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1787

def get_telephony_providers_edge_logs_job(edge_id, job_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_logs_job_with_http_info(edge_id, job_id, opts)
  return data
end

#get_telephony_providers_edge_logs_job_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



1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1798

def get_telephony_providers_edge_logs_job_with_http_info(edge_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge_logs_job ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_logs_job" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_logs_job" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_logs_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edge_physicalinterface(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:



1862
1863
1864
1865
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1862

def get_telephony_providers_edge_physicalinterface(edge_id, interface_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_physicalinterface_with_http_info(edge_id, interface_id, opts)
  return data
end

#get_telephony_providers_edge_physicalinterface_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



1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1873

def get_telephony_providers_edge_physicalinterface_with_http_info(edge_id, interface_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge_physicalinterface ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_physicalinterface" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'interface_id' is set
  fail ArgumentError, "Missing the required parameter 'interface_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_physicalinterface" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_physicalinterface\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edge_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:



1936
1937
1938
1939
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1936

def get_telephony_providers_edge_physicalinterfaces(edge_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_physicalinterfaces_with_http_info(edge_id, opts)
  return data
end

#get_telephony_providers_edge_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:



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1946

def get_telephony_providers_edge_physicalinterfaces_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge_physicalinterfaces ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_physicalinterfaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edge_setuppackage(edge_id, opts = {}) ⇒ VmPairingInfo

Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Returns:



2001
2002
2003
2004
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2001

def get_telephony_providers_edge_setuppackage(edge_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_setuppackage_with_http_info(edge_id, opts)
  return data
end

#get_telephony_providers_edge_setuppackage_with_http_info(edge_id, opts = {}) ⇒ Array<(VmPairingInfo, Fixnum, Hash)>

Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Returns:

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

    VmPairingInfo data, response status code and response headers



2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
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/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2011

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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 => 'VmPairingInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_setuppackage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edge_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:



2066
2067
2068
2069
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2066

def get_telephony_providers_edge_softwareupdate(edge_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_softwareupdate_with_http_info(edge_id, opts)
  return data
end

#get_telephony_providers_edge_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:



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

def get_telephony_providers_edge_softwareupdate_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge_softwareupdate ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_softwareupdate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edge_softwareversions(edge_id, opts = {}) ⇒ DomainEdgeSoftwareVersionDtoEntityListing

Gets all the available software versions for this edge.

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Returns:



2131
2132
2133
2134
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2131

def get_telephony_providers_edge_softwareversions(edge_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_softwareversions_with_http_info(edge_id, opts)
  return data
end

#get_telephony_providers_edge_softwareversions_with_http_info(edge_id, opts = {}) ⇒ Array<(DomainEdgeSoftwareVersionDtoEntityListing, Fixnum, Hash)>

Gets all the available software versions for this edge.

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Returns:



2141
2142
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
2187
2188
2189
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2141

def get_telephony_providers_edge_softwareversions_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge_softwareversions ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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 => 'DomainEdgeSoftwareVersionDtoEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_softwareversions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edge_trunks(edge_id, opts = {}) ⇒ TrunkEntityListing

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

Parameters:

  • edge_id —

    Edge ID

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

  • :trunk_base_id (String) —

    Filter by Trunk Base Ids

  • :trunk_type (String) —

    Filter by a Trunk type

Returns:



2202
2203
2204
2205
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2202

def get_telephony_providers_edge_trunks(edge_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edge_trunks_with_http_info(edge_id, opts)
  return data
end

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

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

Parameters:

  • edge_id —

    Edge ID

  • 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

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



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
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
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
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2218

def get_telephony_providers_edge_trunks_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge_trunks ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_trunks" if edge_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'trunk_type'] && !['EXTERNAL', 'PHONE', 'EDGE'].include?(opts[:'trunk_type'])
    fail ArgumentError, 'invalid value for "trunk_type", must be one of EXTERNAL, PHONE, EDGE'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/telephony/providers/edges/{edgeId}/trunks".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)

  # 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[:'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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_trunks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get edge.

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

Returns:

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

    Edge data, response status code and response headers



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
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 1408

def get_telephony_providers_edge_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge" 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 = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

  • :managed (BOOLEAN) —

    Filter by managed

Returns:



2325
2326
2327
2328
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2325

def get_telephony_providers_edges(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_with_http_info(opts)
  return data
end

#get_telephony_providers_edges_availablelanguages(opts = {}) ⇒ AvailableLanguageList

Get the list of available languages.

Parameters:

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

    the optional parameters

Returns:



2436
2437
2438
2439
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2436

def get_telephony_providers_edges_availablelanguages(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_availablelanguages_with_http_info(opts)
  return data
end

#get_telephony_providers_edges_availablelanguages_with_http_info(opts = {}) ⇒ Array<(AvailableLanguageList, Fixnum, Hash)>

Get the list of available languages.

Parameters:

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

    the optional parameters

Returns:

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

    AvailableLanguageList data, response status code and response headers



2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2445

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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 => 'AvailableLanguageList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edges_availablelanguages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_certificateauthorities(opts = {}) ⇒ CertificateAuthorityEntityListing

Get the list of certificate authorities.

Parameters:

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

    the optional parameters

Returns:



2491
2492
2493
2494
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2491

def get_telephony_providers_edges_certificateauthorities(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_certificateauthorities_with_http_info(opts)
  return data
end

#get_telephony_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:



2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2500

def get_telephony_providers_edges_certificateauthorities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_certificateauthorities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a certificate authority.

Parameters:

  • certificate_id —

    Certificate ID

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

    the optional parameters

Returns:



2547
2548
2549
2550
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2547

def get_telephony_providers_edges_certificateauthority(certificate_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_certificateauthority_with_http_info(certificate_id, opts)
  return data
end

#get_telephony_providers_edges_certificateauthority_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



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

def get_telephony_providers_edges_certificateauthority_with_http_info(certificate_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_certificateauthority ..."
  end
  
  
  # verify the required parameter 'certificate_id' is set
  fail ArgumentError, "Missing the required parameter 'certificate_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_certificateauthority" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_certificateauthority\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a DID by ID.

Parameters:

  • did_id —

    DID ID

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

    the optional parameters

Returns:



2612
2613
2614
2615
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2612

def get_telephony_providers_edges_did(did_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_did_with_http_info(did_id, opts)
  return data
end

#get_telephony_providers_edges_did_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



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

def get_telephony_providers_edges_did_with_http_info(did_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_did ..."
  end
  
  
  # verify the required parameter 'did_id' is set
  fail ArgumentError, "Missing the required parameter 'did_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_did" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_did\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_didpool(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:



2677
2678
2679
2680
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2677

def get_telephony_providers_edges_didpool(did_pool_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_didpool_with_http_info(did_pool_id, opts)
  return data
end

#get_telephony_providers_edges_didpool_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



2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2687

def get_telephony_providers_edges_didpool_with_http_info(did_pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_didpool ..."
  end
  
  
  # verify the required parameter 'did_pool_id' is set
  fail ArgumentError, "Missing the required parameter 'did_pool_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_didpool" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_didpool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



2744
2745
2746
2747
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2744

def get_telephony_providers_edges_didpools(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_didpools_with_http_info(opts)
  return data
end

#get_telephony_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



2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2756

def get_telephony_providers_edges_didpools_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_didpools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



2828
2829
2830
2831
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2828

def get_telephony_providers_edges_dids(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_dids_with_http_info(opts)
  return data
end

#get_telephony_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



2842
2843
2844
2845
2846
2847
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
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2842

def get_telephony_providers_edges_dids_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_dids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get edge group.

Parameters:

  • edge_group_id —

    Edge group ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Fields to expand in the response

Returns:



2925
2926
2927
2928
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2925

def get_telephony_providers_edges_edgegroup(edge_group_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_edgegroup_with_http_info(edge_group_id, opts)
  return data
end

#get_telephony_providers_edges_edgegroup_edgetrunkbasis(edgegroup_id, edgetrunkbase_id, opts = {}) ⇒ EdgeTrunkBase

Gets the edge trunk base associated with the edge group

Parameters:

  • edgegroup_id —

    Edge Group ID

  • edgetrunkbase_id —

    Edge Trunk Base ID

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

    the optional parameters

Returns:



2999
3000
3001
3002
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2999

def get_telephony_providers_edges_edgegroup_edgetrunkbasis(edgegroup_id, edgetrunkbase_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_edgegroup_edgetrunkbasis_with_http_info(edgegroup_id, edgetrunkbase_id, opts)
  return data
end

#get_telephony_providers_edges_edgegroup_edgetrunkbasis_with_http_info(edgegroup_id, edgetrunkbase_id, opts = {}) ⇒ Array<(EdgeTrunkBase, Fixnum, Hash)>

Gets the edge trunk base associated with the edge group

Parameters:

  • edgegroup_id —

    Edge Group ID

  • edgetrunkbase_id —

    Edge Trunk Base ID

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

    the optional parameters

Returns:

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

    EdgeTrunkBase data, response status code and response headers



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

def get_telephony_providers_edges_edgegroup_edgetrunkbasis_with_http_info(edgegroup_id, edgetrunkbase_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_edgegroup_edgetrunkbasis ..."
  end
  
  
  # verify the required parameter 'edgegroup_id' is set
  fail ArgumentError, "Missing the required parameter 'edgegroup_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_edgegroup_edgetrunkbasis" if edgegroup_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'edgetrunkbase_id' is set
  fail ArgumentError, "Missing the required parameter 'edgetrunkbase_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_edgegroup_edgetrunkbasis" if edgetrunkbase_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}".sub('{format}','json').sub('{' + 'edgegroupId' + '}', edgegroup_id.to_s).sub('{' + 'edgetrunkbaseId' + '}', edgetrunkbase_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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 => 'EdgeTrunkBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edges_edgegroup_edgetrunkbasis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_edgegroup_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

Options Hash (opts):

  • :expand (Array<String>) —

    Fields to expand in the response

Returns:

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

    EdgeGroup data, response status code and response headers



2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2936

def get_telephony_providers_edges_edgegroup_with_http_info(edge_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_edgegroup ..."
  end
  
  
  # verify the required parameter 'edge_group_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_group_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_edgegroup" 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 = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_edgegroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

  • :managed (BOOLEAN) —

    Filter by managed

Returns:



3077
3078
3079
3080
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3077

def get_telephony_providers_edges_edgegroups(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_edgegroups_with_http_info(opts)
  return data
end

#get_telephony_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

  • :managed (BOOLEAN) —

    Filter by managed

Returns:

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

    EdgeGroupEntityListing data, response status code and response headers



3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3091

def get_telephony_providers_edges_edgegroups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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']
  query_params[:'managed'] = opts[:'managed'] if opts[:'managed']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_edgegroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



3172
3173
3174
3175
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3172

def get_telephony_providers_edges_edgeversionreport(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_edgeversionreport_with_http_info(opts)
  return data
end

#get_telephony_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



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

def get_telephony_providers_edges_edgeversionreport_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_edgeversionreport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get endpoint

Parameters:

  • endpoint_id —

    Endpoint ID

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

    the optional parameters

Returns:



3228
3229
3230
3231
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3228

def get_telephony_providers_edges_endpoint(endpoint_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_endpoint_with_http_info(endpoint_id, opts)
  return data
end

#get_telephony_providers_edges_endpoint_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



3238
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
3283
3284
3285
3286
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3238

def get_telephony_providers_edges_endpoint_with_http_info(endpoint_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_endpoint ..."
  end
  
  
  # verify the required parameter 'endpoint_id' is set
  fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_endpoint" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_endpoint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



3296
3297
3298
3299
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3296

def get_telephony_providers_edges_endpoints(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_endpoints_with_http_info(opts)
  return data
end

#get_telephony_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



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
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3309

def get_telephony_providers_edges_endpoints_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_endpoints\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get an extension by ID.

Parameters:

  • extension_id —

    Extension ID

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

    the optional parameters

Returns:



3384
3385
3386
3387
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3384

def get_telephony_providers_edges_extension(extension_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_extension_with_http_info(extension_id, opts)
  return data
end

#get_telephony_providers_edges_extension_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



3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3394

def get_telephony_providers_edges_extension_with_http_info(extension_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_extension ..."
  end
  
  
  # verify the required parameter 'extension_id' is set
  fail ArgumentError, "Missing the required parameter 'extension_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_extension" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_extension\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_extensionpool(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:



3449
3450
3451
3452
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3449

def get_telephony_providers_edges_extensionpool(extension_pool_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_extensionpool_with_http_info(extension_pool_id, opts)
  return data
end

#get_telephony_providers_edges_extensionpool_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



3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3459

def get_telephony_providers_edges_extensionpool_with_http_info(extension_pool_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_extensionpool ..."
  end
  
  
  # verify the required parameter 'extension_pool_id' is set
  fail ArgumentError, "Missing the required parameter 'extension_pool_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_extensionpool" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_extensionpool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



3517
3518
3519
3520
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3517

def get_telephony_providers_edges_extensionpools(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_extensionpools_with_http_info(opts)
  return data
end

#get_telephony_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



3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
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
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3530

def get_telephony_providers_edges_extensionpools_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_extensionpools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



3609
3610
3611
3612
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3609

def get_telephony_providers_edges_extensions(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_extensions_with_http_info(opts)
  return data
end

#get_telephony_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



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
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3623

def get_telephony_providers_edges_extensions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_extensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a Line by ID

Parameters:

  • line_id —

    Line ID

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

    the optional parameters

Returns:



3705
3706
3707
3708
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3705

def get_telephony_providers_edges_line(line_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_line_with_http_info(line_id, opts)
  return data
end

#get_telephony_providers_edges_line_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



3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3715

def get_telephony_providers_edges_line_with_http_info(line_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_line ..."
  end
  
  
  # verify the required parameter 'line_id' is set
  fail ArgumentError, "Missing the required parameter 'line_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_line" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_linebasesetting(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:



3770
3771
3772
3773
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3770

def get_telephony_providers_edges_linebasesetting(line_base_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_linebasesetting_with_http_info(line_base_id, opts)
  return data
end

#get_telephony_providers_edges_linebasesetting_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



3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3780

def get_telephony_providers_edges_linebasesetting_with_http_info(line_base_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_linebasesetting ..."
  end
  
  
  # verify the required parameter 'line_base_id' is set
  fail ArgumentError, "Missing the required parameter 'line_base_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_linebasesetting" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_linebasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



3838
3839
3840
3841
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3838

def get_telephony_providers_edges_linebasesettings(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_linebasesettings_with_http_info(opts)
  return data
end

#get_telephony_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



3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
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
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3851

def get_telephony_providers_edges_linebasesettings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_linebasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



3930
3931
3932
3933
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3930

def get_telephony_providers_edges_lines(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_lines_with_http_info(opts)
  return data
end

#get_telephony_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:



4026
4027
4028
4029
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4026

def get_telephony_providers_edges_lines_template(line_base_settings_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_lines_template_with_http_info(line_base_settings_id, opts)
  return data
end

#get_telephony_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



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
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4036

def get_telephony_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_telephony_providers_edges_lines_template ..."
  end
  
  
  # verify the required parameter 'line_base_settings_id' is set
  fail ArgumentError, "Missing the required parameter 'line_base_settings_id' when calling TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_lines_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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



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
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 3944

def get_telephony_providers_edges_lines_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_lines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_logicalinterfaces(edge_ids, opts = {}) ⇒ LogicalInterfaceEntityListing

Get edge logical interfaces. Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time.

Parameters:

  • edge_ids —

    Comma separated list of Edge Id&#39;s

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Field to expand in the response

Returns:



4093
4094
4095
4096
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4093

def get_telephony_providers_edges_logicalinterfaces(edge_ids, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_logicalinterfaces_with_http_info(edge_ids, opts)
  return data
end

#get_telephony_providers_edges_logicalinterfaces_with_http_info(edge_ids, opts = {}) ⇒ Array<(LogicalInterfaceEntityListing, Fixnum, Hash)>

Get edge logical interfaces. Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time.

Parameters:

  • edge_ids —

    Comma separated list of Edge Id&#39;s

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Field to expand in the response

Returns:



4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4104

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

  # query parameters
  query_params = {}
  query_params[:'edgeIds'] = edge_ids
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_logicalinterfaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get outbound route

Parameters:

  • outbound_route_id —

    Outbound route ID

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

    the optional parameters

Returns:



4167
4168
4169
4170
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4167

def get_telephony_providers_edges_outboundroute(outbound_route_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_outboundroute_with_http_info(outbound_route_id, opts)
  return data
end

#get_telephony_providers_edges_outboundroute_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



4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4177

def get_telephony_providers_edges_outboundroute_with_http_info(outbound_route_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_outboundroute ..."
  end
  
  
  # verify the required parameter 'outbound_route_id' is set
  fail ArgumentError, "Missing the required parameter 'outbound_route_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_outboundroute" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_outboundroute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



4236
4237
4238
4239
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4236

def get_telephony_providers_edges_outboundroutes(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_outboundroutes_with_http_info(opts)
  return data
end

#get_telephony_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



4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4250

def get_telephony_providers_edges_outboundroutes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_outboundroutes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a Phone by ID

Parameters:

  • phone_id —

    Phone ID

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

    the optional parameters

Returns:



4332
4333
4334
4335
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4332

def get_telephony_providers_edges_phone(phone_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_phone_with_http_info(phone_id, opts)
  return data
end

#get_telephony_providers_edges_phone_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



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
4390
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4342

def get_telephony_providers_edges_phone_with_http_info(phone_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_phone ..."
  end
  
  
  # verify the required parameter 'phone_id' is set
  fail ArgumentError, "Missing the required parameter 'phone_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_phone" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_phone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_phonebasesetting(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:



4397
4398
4399
4400
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4397

def get_telephony_providers_edges_phonebasesetting(phone_base_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_phonebasesetting_with_http_info(phone_base_id, opts)
  return data
end

#get_telephony_providers_edges_phonebasesetting_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



4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4407

def get_telephony_providers_edges_phonebasesetting_with_http_info(phone_base_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_phonebasesetting ..."
  end
  
  
  # verify the required parameter 'phone_base_id' is set
  fail ArgumentError, "Missing the required parameter 'phone_base_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_phonebasesetting" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_phonebasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Value by which to sort (default to name)

  • :sort_order (String) —

    Sort order (default to ASC)

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

  • :name (String) —

    Name

Returns:



4467
4468
4469
4470
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4467

def get_telephony_providers_edges_phonebasesettings(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_phonebasesettings_with_http_info(opts)
  return data
end

#get_telephony_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:



4572
4573
4574
4575
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4572

def get_telephony_providers_edges_phonebasesettings_availablemetabases(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_phonebasesettings_availablemetabases_with_http_info(opts)
  return data
end

#get_telephony_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



4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4583

def get_telephony_providers_edges_phonebasesettings_availablemetabases_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_phonebasesettings_availablemetabases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



4644
4645
4646
4647
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4644

def get_telephony_providers_edges_phonebasesettings_template(phone_metabase_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_phonebasesettings_template_with_http_info(phone_metabase_id, opts)
  return data
end

#get_telephony_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



4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4654

def get_telephony_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_telephony_providers_edges_phonebasesettings_template ..."
  end
  
  
  # verify the required parameter 'phone_metabase_id' is set
  fail ArgumentError, "Missing the required parameter 'phone_metabase_id' when calling TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_phonebasesettings_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Value by which to sort

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

  • :name (String) —

    Name

Returns:

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

    PhoneBaseEntityListing data, response status code and response headers



4482
4483
4484
4485
4486
4487
4488
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
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4482

def get_telephony_providers_edges_phonebasesettings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_phonebasesettings ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/telephony/providers/edges/phonebasesettings".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[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'name'] = opts[:'name'] if opts[:'name']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_phonebasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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

  • :web_rtc_user_id (String) —

    Filter by webRtcUser.id

  • :phone_base_settings_id (String) —

    Filter by phoneBaseSettings.id

  • :lines_logged_in_user_id (String) —

    Filter by lines.loggedInUser.id

  • :lines_default_for_user_id (String) —

    Filter by lines.defaultForUser.id

  • :phone_hardware_id (String) —

    Filter by phone_hardwareId

  • :lines_id (String) —

    Filter by lines.id

  • :lines_name (String) —

    Filter by lines.name

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

  • :fields (Array<String>) —

    Fields and properties to get, comma-separated

Returns:



4723
4724
4725
4726
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4723

def get_telephony_providers_edges_phones(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_phones_with_http_info(opts)
  return data
end

#get_telephony_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:



4891
4892
4893
4894
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4891

def get_telephony_providers_edges_phones_template(phone_base_settings_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_phones_template_with_http_info(phone_base_settings_id, opts)
  return data
end

#get_telephony_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



4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4901

def get_telephony_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_telephony_providers_edges_phones_template ..."
  end
  
  
  # verify the required parameter 'phone_base_settings_id' is set
  fail ArgumentError, "Missing the required parameter 'phone_base_settings_id' when calling TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_phones_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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

  • :web_rtc_user_id (String) —

    Filter by webRtcUser.id

  • :phone_base_settings_id (String) —

    Filter by phoneBaseSettings.id

  • :lines_logged_in_user_id (String) —

    Filter by lines.loggedInUser.id

  • :lines_default_for_user_id (String) —

    Filter by lines.defaultForUser.id

  • :phone_hardware_id (String) —

    Filter by phone_hardwareId

  • :lines_id (String) —

    Filter by lines.id

  • :lines_name (String) —

    Filter by lines.name

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

  • :fields (Array<String>) —

    Fields and properties to get, comma-separated

Returns:

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

    PhoneEntityListing data, response status code and response headers



4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4746

def get_telephony_providers_edges_phones_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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[:'webRtcUser.id'] = opts[:'web_rtc_user_id'] if opts[:'web_rtc_user_id']
  query_params[:'phoneBaseSettings.id'] = opts[:'phone_base_settings_id'] if opts[:'phone_base_settings_id']
  query_params[:'lines.loggedInUser.id'] = opts[:'lines_logged_in_user_id'] if opts[:'lines_logged_in_user_id']
  query_params[:'lines.defaultForUser.id'] = opts[:'lines_default_for_user_id'] if opts[:'lines_default_for_user_id']
  query_params[:'phone_hardwareId'] = opts[:'phone_hardware_id'] if opts[:'phone_hardware_id']
  query_params[:'lines.id'] = opts[:'lines_id'] if opts[:'lines_id']
  query_params[:'lines.name'] = opts[:'lines_name'] if opts[:'lines_name']
  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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_phones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_physicalinterfaces(edge_ids, opts = {}) ⇒ PhysicalInterfaceEntityListing

Get physical interfaces for edges. Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time.

Parameters:

  • edge_ids —

    Comma separated list of Edge Id&#39;s

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

    the optional parameters

Returns:



4957
4958
4959
4960
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4957

def get_telephony_providers_edges_physicalinterfaces(edge_ids, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_physicalinterfaces_with_http_info(edge_ids, opts)
  return data
end

#get_telephony_providers_edges_physicalinterfaces_with_http_info(edge_ids, opts = {}) ⇒ Array<(PhysicalInterfaceEntityListing, Fixnum, Hash)>

Get physical interfaces for edges. Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time.

Parameters:

  • edge_ids —

    Comma separated list of Edge Id&#39;s

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

    the optional parameters

Returns:



4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 4967

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

  # query parameters
  query_params = {}
  query_params[:'edgeIds'] = edge_ids

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_physicalinterfaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a Site by ID.

Parameters:

  • site_id —

    Site ID

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

    the optional parameters

Returns:



5023
5024
5025
5026
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5023

def get_telephony_providers_edges_site(site_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_site_with_http_info(site_id, opts)
  return data
end

#get_telephony_providers_edges_site_numberplan(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:



5089
5090
5091
5092
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5089

def get_telephony_providers_edges_site_numberplan(site_id, number_plan_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_site_numberplan_with_http_info(site_id, number_plan_id, opts)
  return data
end

#get_telephony_providers_edges_site_numberplan_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



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
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5100

def get_telephony_providers_edges_site_numberplan_with_http_info(site_id, number_plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_site_numberplan ..."
  end
  
  
  # verify the required parameter 'site_id' is set
  fail ArgumentError, "Missing the required parameter 'site_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_site_numberplan" if site_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'number_plan_id' is set
  fail ArgumentError, "Missing the required parameter 'number_plan_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_site_numberplan" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_site_numberplan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_site_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:



5163
5164
5165
5166
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5163

def get_telephony_providers_edges_site_numberplans(site_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_site_numberplans_with_http_info(site_id, opts)
  return data
end

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


5229
5230
5231
5232
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5229

def get_telephony_providers_edges_site_numberplans_classifications(site_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_site_numberplans_classifications_with_http_info(site_id, opts)
  return data
end

#get_telephony_providers_edges_site_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



5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
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
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5240

def get_telephony_providers_edges_site_numberplans_classifications_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_site_numberplans_classifications ..."
  end
  
  
  # verify the required parameter 'site_id' is set
  fail ArgumentError, "Missing the required parameter 'site_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_site_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_site_numberplans_classifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_site_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



5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5173

def get_telephony_providers_edges_site_numberplans_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_site_numberplans ..."
  end
  
  
  # verify the required parameter 'site_id' is set
  fail ArgumentError, "Missing the required parameter 'site_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_site_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_site_numberplans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id, opts = {}) ⇒ OutboundRouteBase

Get an outbound route

Parameters:

  • site_id —

    Site ID

  • outbound_route_id —

    Outbound route ID

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

    the optional parameters

Returns:



5303
5304
5305
5306
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5303

def get_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_site_outboundroute_with_http_info(site_id, outbound_route_id, opts)
  return data
end

#get_telephony_providers_edges_site_outboundroute_with_http_info(site_id, outbound_route_id, opts = {}) ⇒ Array<(OutboundRouteBase, Fixnum, Hash)>

Get an outbound route

Parameters:

  • site_id —

    Site ID

  • outbound_route_id —

    Outbound route ID

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

    the optional parameters

Returns:

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

    OutboundRouteBase data, response status code and response headers



5314
5315
5316
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
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5314

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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 => 'OutboundRouteBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edges_site_outboundroute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_site_outboundroutes(site_id, opts = {}) ⇒ OutboundRouteBaseEntityListing

Get outbound routes

Parameters:

  • site_id —

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

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by (default to name)

Returns:



5381
5382
5383
5384
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5381

def get_telephony_providers_edges_site_outboundroutes(site_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_site_outboundroutes_with_http_info(site_id, opts)
  return data
end

#get_telephony_providers_edges_site_outboundroutes_with_http_info(site_id, opts = {}) ⇒ Array<(OutboundRouteBaseEntityListing, Fixnum, Hash)>

Get outbound routes

Parameters:

  • site_id —

    Site ID

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



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

def get_telephony_providers_edges_site_outboundroutes_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_site_outboundroutes ..."
  end
  
  
  # verify the required parameter 'site_id' is set
  fail ArgumentError, "Missing the required parameter 'site_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_site_outboundroutes" if site_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes".sub('{format}','json').sub('{' + 'siteId' + '}', site_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']
  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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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 => 'OutboundRouteBaseEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edges_site_outboundroutes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a Site by ID.

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



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
5073
5074
5075
5076
5077
5078
5079
5080
5081
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5033

def get_telephony_providers_edges_site_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_site ..."
  end
  
  
  # verify the required parameter 'site_id' is set
  fail ArgumentError, "Missing the required parameter 'site_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_site" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_site\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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

  • :managed (BOOLEAN) —

    Filter by managed

Returns:



5484
5485
5486
5487
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5484

def get_telephony_providers_edges_sites(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_sites_with_http_info(opts)
  return data
end

#get_telephony_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

  • :managed (BOOLEAN) —

    Filter by managed

Returns:

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

    SiteEntityListing data, response status code and response headers



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
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5500

def get_telephony_providers_edges_sites_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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']
  query_params[:'managed'] = opts[:'managed'] if opts[:'managed']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_sites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



5597
5598
5599
5600
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5597

def get_telephony_providers_edges_timezones(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_timezones_with_http_info(opts)
  return data
end

#get_telephony_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



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
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5608

def get_telephony_providers_edges_timezones_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_timezones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a Trunk by ID

Parameters:

  • trunk_id —

    Trunk ID

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

    the optional parameters

Returns:



5669
5670
5671
5672
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5669

def get_telephony_providers_edges_trunk(trunk_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_trunk_with_http_info(trunk_id, opts)
  return data
end

#get_telephony_providers_edges_trunk_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



5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5679

def get_telephony_providers_edges_trunk_with_http_info(trunk_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_trunk ..."
  end
  
  
  # verify the required parameter 'trunk_id' is set
  fail ArgumentError, "Missing the required parameter 'trunk_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_trunk" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_trunk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a Trunk Base Settings object by ID Managed properties will not be returned unless the user is assigned the managed:all:all permission.

Parameters:

  • trunk_base_settings_id —

    Trunk Base ID

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

    the optional parameters

Options Hash (opts):

  • :ignore_hidden (BOOLEAN) —

    Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.

Returns:



5735
5736
5737
5738
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5735

def get_telephony_providers_edges_trunkbasesetting(trunk_base_settings_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_trunkbasesetting_with_http_info(trunk_base_settings_id, opts)
  return data
end

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

Get a Trunk Base Settings object by ID Managed properties will not be returned unless the user is assigned the managed:all:all permission.

Parameters:

  • trunk_base_settings_id —

    Trunk Base ID

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

    the optional parameters

Options Hash (opts):

  • :ignore_hidden (BOOLEAN) —

    Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.

Returns:

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

    TrunkBase data, response status code and response headers



5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5746

def get_telephony_providers_edges_trunkbasesetting_with_http_info(trunk_base_settings_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_trunkbasesetting ..."
  end
  
  
  # verify the required parameter 'trunk_base_settings_id' is set
  fail ArgumentError, "Missing the required parameter 'trunk_base_settings_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edges_trunkbasesetting" 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 = {}
  query_params[:'ignoreHidden'] = opts[:'ignore_hidden'] if opts[:'ignore_hidden']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_trunkbasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_trunkbasesettings(opts = {}) ⇒ TrunkBaseEntityListing

Get Trunk Base Settings listing Managed properties will not be returned unless the user is assigned the managed:all:all permission.

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)

  • :recording_enabled (BOOLEAN) —

    Filter trunks by recording enabled

  • :ignore_hidden (BOOLEAN) —

    Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.

  • :managed (BOOLEAN) —

    Filter by managed

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

  • :name (String) —

    Name of the TrunkBase to filter by

Returns:



5816
5817
5818
5819
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5816

def get_telephony_providers_edges_trunkbasesettings(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_trunkbasesettings_with_http_info(opts)
  return data
end

#get_telephony_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:



5946
5947
5948
5949
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5946

def get_telephony_providers_edges_trunkbasesettings_availablemetabases(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_trunkbasesettings_availablemetabases_with_http_info(opts)
  return data
end

#get_telephony_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



5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
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
6018
6019
6020
6021
6022
6023
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5958

def get_telephony_providers_edges_trunkbasesettings_availablemetabases_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_trunkbasesettings_availablemetabases ..."
  end
  
  
  
  
  if opts[:'type'] && !['EXTERNAL', 'PHONE', 'EDGE'].include?(opts[:'type'])
    fail ArgumentError, '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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_trunkbasesettings_availablemetabases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



6030
6031
6032
6033
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6030

def get_telephony_providers_edges_trunkbasesettings_template(trunk_metabase_id, opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_trunkbasesettings_template_with_http_info(trunk_metabase_id, opts)
  return data
end

#get_telephony_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



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
6085
6086
6087
6088
6089
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6040

def get_telephony_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_telephony_providers_edges_trunkbasesettings_template ..."
  end
  
  
  # verify the required parameter 'trunk_metabase_id' is set
  fail ArgumentError, "Missing the required parameter 'trunk_metabase_id' when calling TelephonyProvidersEdgeApi.get_telephony_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_trunkbasesettings_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_trunkbasesettings_with_http_info(opts = {}) ⇒ Array<(TrunkBaseEntityListing, Fixnum, Hash)>

Get Trunk Base Settings listing Managed properties will not be returned unless the user is assigned the managed:all:all permission.

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

  • :recording_enabled (BOOLEAN) —

    Filter trunks by recording enabled

  • :ignore_hidden (BOOLEAN) —

    Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.

  • :managed (BOOLEAN) —

    Filter by managed

  • :expand (Array<String>) —

    Fields to expand in the response, comma-separated

  • :name (String) —

    Name of the TrunkBase to filter by

Returns:

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

    TrunkBaseEntityListing data, response status code and response headers



5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
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
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
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
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 5834

def get_telephony_providers_edges_trunkbasesettings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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']
  query_params[:'recordingEnabled'] = opts[:'recording_enabled'] if opts[:'recording_enabled']
  query_params[:'ignoreHidden'] = opts[:'ignore_hidden'] if opts[:'ignore_hidden']
  query_params[:'managed'] = opts[:'managed'] if opts[:'managed']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'name'] = opts[:'name'] if opts[:'name']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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 => 'TrunkBaseEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edges_trunkbasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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:



6102
6103
6104
6105
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6102

def get_telephony_providers_edges_trunks(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_trunks_with_http_info(opts)
  return data
end

#get_telephony_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



6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
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
6209
6210
6211
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6118

def get_telephony_providers_edges_trunks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edges_trunks ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'trunk_type'] && !['EXTERNAL', 'PHONE', 'EDGE'].include?(opts[:'trunk_type'])
    fail ArgumentError, '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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_trunks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_providers_edges_trunkswithrecording(opts = {}) ⇒ TrunkRecordingEnabledCount

Get Counts of trunks that have recording disabled or enabled

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :trunk_type (String) —

    The type of this trunk base.

Returns:



6218
6219
6220
6221
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6218

def get_telephony_providers_edges_trunkswithrecording(opts = {})
  data, _status_code, _headers = get_telephony_providers_edges_trunkswithrecording_with_http_info(opts)
  return data
end

#get_telephony_providers_edges_trunkswithrecording_with_http_info(opts = {}) ⇒ Array<(TrunkRecordingEnabledCount, Fixnum, Hash)>

Get Counts of trunks that have recording disabled or enabled

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :trunk_type (String) —

    The type of this trunk base.

Returns:

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

    TrunkRecordingEnabledCount data, response status code and response headers



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
6271
6272
6273
6274
6275
6276
6277
6278
6279
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6228

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

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

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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 => 'TrunkRecordingEnabledCount')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edges_trunkswithrecording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_telephony_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

  • :managed (BOOLEAN) —

    Filter by managed

Returns:

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

    EdgeEntityListing data, response status code and response headers



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
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 2341

def get_telephony_providers_edges_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_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']
  query_params[:'managed'] = opts[:'managed'] if opts[:'managed']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edge_logicalinterfaces(edge_id, body, opts = {}) ⇒ DomainLogicalInterface

Create an edge logical interface. Create

Parameters:

  • edge_id —

    Edge ID

  • body —

    Logical interface

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

    the optional parameters

Returns:



6287
6288
6289
6290
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6287

def post_telephony_providers_edge_logicalinterfaces(edge_id, body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edge_logicalinterfaces_with_http_info(edge_id, body, opts)
  return data
end

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

Create an edge logical interface. Create

Parameters:

  • edge_id —

    Edge ID

  • body —

    Logical interface

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

    the optional parameters

Returns:

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

    DomainLogicalInterface data, response status code and response headers



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
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6298

def post_telephony_providers_edge_logicalinterfaces_with_http_info(edge_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edge_logicalinterfaces ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edge_logicalinterfaces" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edge_logicalinterfaces" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edge_logicalinterfaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edge_logs_job_upload(edge_id, job_id, body, opts = {}) ⇒ nil

Request that the specified fileIds be uploaded from the Edge.

Parameters:

  • edge_id —

    Edge ID

  • job_id —

    Job ID

  • body —

    Log upload request

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

    the optional parameters

Returns:

  • (nil) 


6363
6364
6365
6366
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6363

def post_telephony_providers_edge_logs_job_upload(edge_id, job_id, body, opts = {})
  post_telephony_providers_edge_logs_job_upload_with_http_info(edge_id, job_id, body, opts)
  return nil
end

#post_telephony_providers_edge_logs_job_upload_with_http_info(edge_id, job_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Request that the specified fileIds be uploaded from the Edge.

Parameters:

  • edge_id —

    Edge ID

  • job_id —

    Job ID

  • body —

    Log upload request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
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
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6375

def post_telephony_providers_edge_logs_job_upload_with_http_info(edge_id, job_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edge_logs_job_upload ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edge_logs_job_upload" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edge_logs_job_upload" if job_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edge_logs_job_upload" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edge_logs_job_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edge_logs_jobs(edge_id, body, opts = {}) ⇒ EdgeLogsJobResponse

Create a job to upload a list of Edge logs.

Parameters:

  • edge_id —

    Edge ID

  • body —

    EdgeLogsJobRequest

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

    the optional parameters

Returns:



6446
6447
6448
6449
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6446

def post_telephony_providers_edge_logs_jobs(edge_id, body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edge_logs_jobs_with_http_info(edge_id, body, opts)
  return data
end

#post_telephony_providers_edge_logs_jobs_with_http_info(edge_id, body, opts = {}) ⇒ Array<(EdgeLogsJobResponse, Fixnum, Hash)>

Create a job to upload a list of Edge logs.

Parameters:

  • edge_id —

    Edge ID

  • body —

    EdgeLogsJobRequest

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

    the optional parameters

Returns:

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

    EdgeLogsJobResponse data, response status code and response headers



6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
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
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6457

def post_telephony_providers_edge_logs_jobs_with_http_info(edge_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edge_logs_jobs ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edge_logs_jobs" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edge_logs_jobs" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edge_logs_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Reboot an Edge

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String) 


6521
6522
6523
6524
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6521

def post_telephony_providers_edge_reboot(edge_id, opts = {})
  data, _status_code, _headers = post_telephony_providers_edge_reboot_with_http_info(edge_id, opts)
  return data
end

#post_telephony_providers_edge_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

Options Hash (opts):

Returns:

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

    String data, response status code and response headers



6532
6533
6534
6535
6536
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
6581
6582
6583
6584
6585
6586
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6532

def post_telephony_providers_edge_reboot_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edge_reboot ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edge_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edge_reboot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edge_softwareupdate(edge_id, body, opts = {}) ⇒ DomainEdgeSoftwareUpdateDto

Starts a software update for this edge.

Parameters:

  • edge_id —

    Edge ID

  • body —

    Software update request

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

    the optional parameters

Returns:



6594
6595
6596
6597
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6594

def post_telephony_providers_edge_softwareupdate(edge_id, body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edge_softwareupdate_with_http_info(edge_id, body, opts)
  return data
end

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

Starts a software update for this edge.

Parameters:

  • edge_id —

    Edge ID

  • body —

    Software update request

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

    the optional parameters

Returns:



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
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6605

def post_telephony_providers_edge_softwareupdate_with_http_info(edge_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edge_softwareupdate ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edge_softwareupdate" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edge_softwareupdate" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edge_softwareupdate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Take an Edge in or out of service

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String) 


6669
6670
6671
6672
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6669

def post_telephony_providers_edge_statuscode(edge_id, opts = {})
  data, _status_code, _headers = post_telephony_providers_edge_statuscode_with_http_info(edge_id, opts)
  return data
end

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

Take an Edge in or out of service

Parameters:

  • edge_id —

    Edge ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    String data, response status code and response headers



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
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6680

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edge_statuscode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Unpair an Edge

Parameters:

  • edge_id —

    Edge Id

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

    the optional parameters

Returns:

  • (String) 


6741
6742
6743
6744
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6741

def post_telephony_providers_edge_unpair(edge_id, opts = {})
  data, _status_code, _headers = post_telephony_providers_edge_unpair_with_http_info(edge_id, opts)
  return data
end

#post_telephony_providers_edge_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



6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6751

def post_telephony_providers_edge_unpair_with_http_info(edge_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edge_unpair ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edge_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edge_unpair\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges(body, opts = {}) ⇒ Edge

Create an edge.

Parameters:

  • body —

    Edge

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

    the optional parameters

Returns:



6806
6807
6808
6809
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6806

def post_telephony_providers_edges(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_with_http_info(body, opts)
  return data
end

#post_telephony_providers_edges_addressvalidation(body, opts = {}) ⇒ ValidateAddressResponse

Validates a street address

Parameters:

  • body —

    Address

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

    the optional parameters

Returns:



6871
6872
6873
6874
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6871

def post_telephony_providers_edges_addressvalidation(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_addressvalidation_with_http_info(body, opts)
  return data
end

#post_telephony_providers_edges_addressvalidation_with_http_info(body, opts = {}) ⇒ Array<(ValidateAddressResponse, Fixnum, Hash)>

Validates a street address

Parameters:

  • body —

    Address

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

    the optional parameters

Returns:

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

    ValidateAddressResponse data, response status code and response headers



6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6881

def post_telephony_providers_edges_addressvalidation_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_addressvalidation ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_addressvalidation" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_addressvalidation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_certificateauthorities(body, opts = {}) ⇒ DomainCertificateAuthority

Create a certificate authority.

Parameters:

  • body —

    CertificateAuthority

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

    the optional parameters

Returns:



6936
6937
6938
6939
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6936

def post_telephony_providers_edges_certificateauthorities(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_certificateauthorities_with_http_info(body, opts)
  return data
end

#post_telephony_providers_edges_certificateauthorities_with_http_info(body, opts = {}) ⇒ Array<(DomainCertificateAuthority, Fixnum, Hash)>

Create a certificate authority.

Parameters:

  • body —

    CertificateAuthority

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

    the optional parameters

Returns:

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

    DomainCertificateAuthority data, response status code and response headers



6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6946

def post_telephony_providers_edges_certificateauthorities_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_certificateauthorities ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_certificateauthorities" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_certificateauthorities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_didpools(body, opts = {}) ⇒ DIDPool

Create a new DID pool

Parameters:

  • body —

    DID pool

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

    the optional parameters

Returns:



7001
7002
7003
7004
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7001

def post_telephony_providers_edges_didpools(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_didpools_with_http_info(body, opts)
  return data
end

#post_telephony_providers_edges_didpools_with_http_info(body, opts = {}) ⇒ Array<(DIDPool, Fixnum, Hash)>

Create a new DID pool

Parameters:

  • body —

    DID pool

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

    the optional parameters

Returns:

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

    DIDPool data, response status code and response headers



7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7011

def post_telephony_providers_edges_didpools_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_didpools ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_didpools" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_didpools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_edgegroups(body, opts = {}) ⇒ EdgeGroup

Create an edge group.

Parameters:

  • body —

    EdgeGroup

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

    the optional parameters

Returns:



7066
7067
7068
7069
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7066

def post_telephony_providers_edges_edgegroups(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_edgegroups_with_http_info(body, opts)
  return data
end

#post_telephony_providers_edges_edgegroups_with_http_info(body, opts = {}) ⇒ Array<(EdgeGroup, Fixnum, Hash)>

Create an edge group.

Parameters:

  • body —

    EdgeGroup

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

    the optional parameters

Returns:

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

    EdgeGroup data, response status code and response headers



7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7076

def post_telephony_providers_edges_edgegroups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_edgegroups ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_edgegroups" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_edgegroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_endpoints(body, opts = {}) ⇒ Endpoint

Create endpoint

Parameters:

  • body —

    EndpointTemplate

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

    the optional parameters

Returns:



7131
7132
7133
7134
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7131

def post_telephony_providers_edges_endpoints(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_endpoints_with_http_info(body, opts)
  return data
end

#post_telephony_providers_edges_endpoints_with_http_info(body, opts = {}) ⇒ Array<(Endpoint, Fixnum, Hash)>

Create endpoint

Parameters:

  • body —

    EndpointTemplate

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

    the optional parameters

Returns:

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

    Endpoint data, response status code and response headers



7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7141

def post_telephony_providers_edges_endpoints_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_endpoints ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_endpoints" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_endpoints\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_extensionpools(body, opts = {}) ⇒ ExtensionPool

Create a new extension pool

Parameters:

  • body —

    ExtensionPool

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

    the optional parameters

Returns:



7196
7197
7198
7199
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7196

def post_telephony_providers_edges_extensionpools(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_extensionpools_with_http_info(body, opts)
  return data
end

#post_telephony_providers_edges_extensionpools_with_http_info(body, opts = {}) ⇒ Array<(ExtensionPool, Fixnum, Hash)>

Create a new extension pool

Parameters:

  • body —

    ExtensionPool

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

    the optional parameters

Returns:

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

    ExtensionPool data, response status code and response headers



7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7206

def post_telephony_providers_edges_extensionpools_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_extensionpools ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_extensionpools" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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 => 'ExtensionPool')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edges_extensionpools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_outboundroutes(body, opts = {}) ⇒ OutboundRoute

Create outbound rule

Parameters:

  • body —

    OutboundRoute

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

    the optional parameters

Returns:



7261
7262
7263
7264
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7261

def post_telephony_providers_edges_outboundroutes(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_outboundroutes_with_http_info(body, opts)
  return data
end

#post_telephony_providers_edges_outboundroutes_with_http_info(body, opts = {}) ⇒ Array<(OutboundRoute, Fixnum, Hash)>

Create outbound rule

Parameters:

  • body —

    OutboundRoute

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

    the optional parameters

Returns:

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

    OutboundRoute data, response status code and response headers



7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7271

def post_telephony_providers_edges_outboundroutes_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_outboundroutes ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_outboundroutes" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_outboundroutes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_phone_reboot(phone_id, opts = {}) ⇒ nil

Reboot a Phone

Parameters:

  • phone_id —

    Phone Id

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

    the optional parameters

Returns:

  • (nil) 


7326
7327
7328
7329
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7326

def post_telephony_providers_edges_phone_reboot(phone_id, opts = {})
  post_telephony_providers_edges_phone_reboot_with_http_info(phone_id, opts)
  return nil
end

#post_telephony_providers_edges_phone_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



7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7336

def post_telephony_providers_edges_phone_reboot_with_http_info(phone_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_phone_reboot ..."
  end
  
  
  # verify the required parameter 'phone_id' is set
  fail ArgumentError, "Missing the required parameter 'phone_id' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_phone_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_phone_reboot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_phonebasesettings(body, opts = {}) ⇒ PhoneBase

Create a new Phone Base Settings object

Parameters:

  • body —

    Phone base settings

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

    the optional parameters

Returns:



7390
7391
7392
7393
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7390

def post_telephony_providers_edges_phonebasesettings(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_phonebasesettings_with_http_info(body, opts)
  return data
end

#post_telephony_providers_edges_phonebasesettings_with_http_info(body, opts = {}) ⇒ Array<(PhoneBase, Fixnum, Hash)>

Create a new Phone Base Settings object

Parameters:

  • body —

    Phone base settings

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

    the optional parameters

Returns:

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

    PhoneBase data, response status code and response headers



7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7400

def post_telephony_providers_edges_phonebasesettings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_phonebasesettings ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_phonebasesettings" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_phonebasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_phones(body, opts = {}) ⇒ Phone

Create a new Phone

Parameters:

  • body —

    Phone

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

    the optional parameters

Returns:



7455
7456
7457
7458
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7455

def post_telephony_providers_edges_phones(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_phones_with_http_info(body, opts)
  return data
end

#post_telephony_providers_edges_phones_reboot(body, opts = {}) ⇒ nil

Reboot Multiple Phones

Parameters:

  • body —

    Phones

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

    the optional parameters

Returns:

  • (nil) 


7520
7521
7522
7523
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7520

def post_telephony_providers_edges_phones_reboot(body, opts = {})
  post_telephony_providers_edges_phones_reboot_with_http_info(body, opts)
  return nil
end

#post_telephony_providers_edges_phones_reboot_with_http_info(body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Reboot Multiple Phones

Parameters:

  • body —

    Phones

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7530

def post_telephony_providers_edges_phones_reboot_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_phones_reboot ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_phones_reboot" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_phones_reboot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_phones_with_http_info(body, opts = {}) ⇒ Array<(Phone, Fixnum, Hash)>

Create a new Phone

Parameters:

  • body —

    Phone

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

    the optional parameters

Returns:

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

    Phone data, response status code and response headers



7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7465

def post_telephony_providers_edges_phones_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_phones ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_phones" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_phones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_site_outboundroutes(site_id, body, opts = {}) ⇒ OutboundRouteBase

Create outbound route

Parameters:

  • site_id —

    Site ID

  • body —

    OutboundRoute

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

    the optional parameters

Returns:



7585
7586
7587
7588
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7585

def post_telephony_providers_edges_site_outboundroutes(site_id, body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_site_outboundroutes_with_http_info(site_id, body, opts)
  return data
end

#post_telephony_providers_edges_site_outboundroutes_with_http_info(site_id, body, opts = {}) ⇒ Array<(OutboundRouteBase, Fixnum, Hash)>

Create outbound route

Parameters:

  • site_id —

    Site ID

  • body —

    OutboundRoute

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

    the optional parameters

Returns:

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

    OutboundRouteBase data, response status code and response headers



7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7596

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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 => 'OutboundRouteBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edges_site_outboundroutes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_site_rebalance(site_id, opts = {}) ⇒ nil

Triggers the rebalance operation.

Parameters:

  • site_id —

    Site ID

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

    the optional parameters

Returns:

  • (nil) 


7659
7660
7661
7662
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7659

def post_telephony_providers_edges_site_rebalance(site_id, opts = {})
  post_telephony_providers_edges_site_rebalance_with_http_info(site_id, opts)
  return nil
end

#post_telephony_providers_edges_site_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



7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7669

def post_telephony_providers_edges_site_rebalance_with_http_info(site_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_site_rebalance ..."
  end
  
  
  # verify the required parameter 'site_id' is set
  fail ArgumentError, "Missing the required parameter 'site_id' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_site_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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_telephony_providers_edges_site_rebalance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_sites(body, opts = {}) ⇒ Site

Create a Site.

Parameters:

  • body —

    Site

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

    the optional parameters

Returns:



7723
7724
7725
7726
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7723

def post_telephony_providers_edges_sites(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_sites_with_http_info(body, opts)
  return data
end

#post_telephony_providers_edges_sites_with_http_info(body, opts = {}) ⇒ Array<(Site, Fixnum, Hash)>

Create a Site.

Parameters:

  • body —

    Site

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

    the optional parameters

Returns:

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

    Site data, response status code and response headers



7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7733

def post_telephony_providers_edges_sites_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_sites ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_sites" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_sites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_trunkbasesettings(body, opts = {}) ⇒ TrunkBase

Create a Trunk Base Settings object

Parameters:

  • body —

    Trunk base settings

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

    the optional parameters

Returns:



7788
7789
7790
7791
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7788

def post_telephony_providers_edges_trunkbasesettings(body, opts = {})
  data, _status_code, _headers = post_telephony_providers_edges_trunkbasesettings_with_http_info(body, opts)
  return data
end

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

Create a Trunk Base Settings object

Parameters:

  • body —

    Trunk base settings

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

    the optional parameters

Returns:

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

    TrunkBase data, response status code and response headers



7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7798

def post_telephony_providers_edges_trunkbasesettings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges_trunkbasesettings ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges_trunkbasesettings" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_trunkbasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_telephony_providers_edges_with_http_info(body, opts = {}) ⇒ Array<(Edge, Fixnum, Hash)>

Create an edge.

Parameters:

  • body —

    Edge

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

    the optional parameters

Returns:

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

    Edge data, response status code and response headers



6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 6816

def post_telephony_providers_edges_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.post_telephony_providers_edges ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.post_telephony_providers_edges" if body.nil?
  
  
  
  
  
  # 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edge(edge_id, body, opts = {}) ⇒ Edge

Update a edge.

Parameters:

  • edge_id —

    Edge ID

  • body —

    Edge

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

    the optional parameters

Returns:



7854
7855
7856
7857
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7854

def put_telephony_providers_edge(edge_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edge_with_http_info(edge_id, body, opts)
  return data
end

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

Update a line.

Parameters:

  • edge_id —

    Edge ID

  • line_id —

    Line ID

  • body —

    Line

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

    the optional parameters

Returns:



7930
7931
7932
7933
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7930

def put_telephony_providers_edge_line(edge_id, line_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edge_line_with_http_info(edge_id, line_id, body, opts)
  return data
end

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

Update a line.

Parameters:

  • edge_id —

    Edge ID

  • line_id —

    Line ID

  • body —

    Line

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

    the optional parameters

Returns:

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

    EdgeLine data, response status code and response headers



7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7942

def put_telephony_providers_edge_line_with_http_info(edge_id, line_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edge_line ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edge_line" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'line_id' is set
  fail ArgumentError, "Missing the required parameter 'line_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edge_line" if line_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edge_line" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edge_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update an edge logical interface.

Parameters:

  • edge_id —

    Edge ID

  • interface_id —

    Interface ID

  • body —

    Logical interface

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

    the optional parameters

Returns:



8015
8016
8017
8018
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8015

def put_telephony_providers_edge_logicalinterface(edge_id, interface_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edge_logicalinterface_with_http_info(edge_id, interface_id, body, opts)
  return data
end

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

Update an edge logical interface.

Parameters:

  • edge_id —

    Edge ID

  • interface_id —

    Interface ID

  • body —

    Logical interface

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

    the optional parameters

Returns:

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

    DomainLogicalInterface data, response status code and response headers



8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8027

def put_telephony_providers_edge_logicalinterface_with_http_info(edge_id, interface_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edge_logicalinterface ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edge_logicalinterface" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'interface_id' is set
  fail ArgumentError, "Missing the required parameter 'interface_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edge_logicalinterface" if interface_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edge_logicalinterface" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edge_logicalinterface\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a edge.

Parameters:

  • edge_id —

    Edge ID

  • body —

    Edge

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

    the optional parameters

Returns:

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

    Edge data, response status code and response headers



7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 7865

def put_telephony_providers_edge_with_http_info(edge_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edge ..."
  end
  
  
  # verify the required parameter 'edge_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edge" if edge_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edge" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_certificateauthority(certificate_id, body, opts = {}) ⇒ DomainCertificateAuthority

Update a certificate authority.

Parameters:

  • certificate_id —

    Certificate ID

  • body —

    Certificate authority

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

    the optional parameters

Returns:



8099
8100
8101
8102
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8099

def put_telephony_providers_edges_certificateauthority(certificate_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_certificateauthority_with_http_info(certificate_id, body, opts)
  return data
end

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

Update a certificate authority.

Parameters:

  • certificate_id —

    Certificate ID

  • body —

    Certificate authority

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

    the optional parameters

Returns:

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

    DomainCertificateAuthority data, response status code and response headers



8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8110

def put_telephony_providers_edges_certificateauthority_with_http_info(certificate_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_certificateauthority ..."
  end
  
  
  # verify the required parameter 'certificate_id' is set
  fail ArgumentError, "Missing the required parameter 'certificate_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_certificateauthority" if certificate_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_certificateauthority" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_certificateauthority\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_did(did_id, body, opts = {}) ⇒ DID

Update a DID by ID.

Parameters:

  • did_id —

    DID ID

  • body —

    DID

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

    the optional parameters

Returns:



8174
8175
8176
8177
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8174

def put_telephony_providers_edges_did(did_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_did_with_http_info(did_id, body, opts)
  return data
end

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

Update a DID by ID.

Parameters:

  • did_id —

    DID ID

  • body —

    DID

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

    the optional parameters

Returns:

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

    DID data, response status code and response headers



8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8185

def put_telephony_providers_edges_did_with_http_info(did_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_did ..."
  end
  
  
  # verify the required parameter 'did_id' is set
  fail ArgumentError, "Missing the required parameter 'did_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_did" if did_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_did" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_did\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_didpool(did_pool_id, body, opts = {}) ⇒ DIDPool

Update a DID Pool by ID.

Parameters:

  • did_pool_id —

    DID pool ID

  • body —

    DID pool

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

    the optional parameters

Returns:



8249
8250
8251
8252
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8249

def put_telephony_providers_edges_didpool(did_pool_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_didpool_with_http_info(did_pool_id, body, opts)
  return data
end

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

Update a DID Pool by ID.

Parameters:

  • did_pool_id —

    DID pool ID

  • body —

    DID pool

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

    the optional parameters

Returns:

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

    DIDPool data, response status code and response headers



8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8260

def put_telephony_providers_edges_didpool_with_http_info(did_pool_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_didpool ..."
  end
  
  
  # verify the required parameter 'did_pool_id' is set
  fail ArgumentError, "Missing the required parameter 'did_pool_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_didpool" if did_pool_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_didpool" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_didpool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_edgegroup(edge_group_id, body, opts = {}) ⇒ EdgeGroup

Update an edge group.

Parameters:

  • edge_group_id —

    Edge group ID

  • body —

    EdgeGroup

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

    the optional parameters

Returns:



8324
8325
8326
8327
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8324

def put_telephony_providers_edges_edgegroup(edge_group_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_edgegroup_with_http_info(edge_group_id, body, opts)
  return data
end

#put_telephony_providers_edges_edgegroup_edgetrunkbasis(edgegroup_id, edgetrunkbase_id, body, opts = {}) ⇒ EdgeTrunkBase

Update the edge trunk base associated with the edge group

Parameters:

  • edgegroup_id —

    Edge Group ID

  • edgetrunkbase_id —

    Edge Trunk Base ID

  • body —

    EdgeTrunkBase

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

    the optional parameters

Returns:



8400
8401
8402
8403
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8400

def put_telephony_providers_edges_edgegroup_edgetrunkbasis(edgegroup_id, edgetrunkbase_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_edgegroup_edgetrunkbasis_with_http_info(edgegroup_id, edgetrunkbase_id, body, opts)
  return data
end

#put_telephony_providers_edges_edgegroup_edgetrunkbasis_with_http_info(edgegroup_id, edgetrunkbase_id, body, opts = {}) ⇒ Array<(EdgeTrunkBase, Fixnum, Hash)>

Update the edge trunk base associated with the edge group

Parameters:

  • edgegroup_id —

    Edge Group ID

  • edgetrunkbase_id —

    Edge Trunk Base ID

  • body —

    EdgeTrunkBase

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

    the optional parameters

Returns:

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

    EdgeTrunkBase data, response status code and response headers



8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8412

def put_telephony_providers_edges_edgegroup_edgetrunkbasis_with_http_info(edgegroup_id, edgetrunkbase_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_edgegroup_edgetrunkbasis ..."
  end
  
  
  # verify the required parameter 'edgegroup_id' is set
  fail ArgumentError, "Missing the required parameter 'edgegroup_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_edgegroup_edgetrunkbasis" if edgegroup_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'edgetrunkbase_id' is set
  fail ArgumentError, "Missing the required parameter 'edgetrunkbase_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_edgegroup_edgetrunkbasis" if edgetrunkbase_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_edgegroup_edgetrunkbasis" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}".sub('{format}','json').sub('{' + 'edgegroupId' + '}', edgegroup_id.to_s).sub('{' + 'edgetrunkbaseId' + '}', edgetrunkbase_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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 => 'EdgeTrunkBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_telephony_providers_edges_edgegroup_edgetrunkbasis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update an edge group.

Parameters:

  • edge_group_id —

    Edge group ID

  • body —

    EdgeGroup

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

    the optional parameters

Returns:

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

    EdgeGroup data, response status code and response headers



8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8335

def put_telephony_providers_edges_edgegroup_with_http_info(edge_group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_edgegroup ..."
  end
  
  
  # verify the required parameter 'edge_group_id' is set
  fail ArgumentError, "Missing the required parameter 'edge_group_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_edgegroup" if edge_group_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_edgegroup" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_edgegroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_endpoint(endpoint_id, body, opts = {}) ⇒ Endpoint

Update endpoint

Parameters:

  • endpoint_id —

    Endpoint ID

  • body —

    EndpointTemplate

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

    the optional parameters

Returns:



8484
8485
8486
8487
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8484

def put_telephony_providers_edges_endpoint(endpoint_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_endpoint_with_http_info(endpoint_id, body, opts)
  return data
end

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

Update endpoint

Parameters:

  • endpoint_id —

    Endpoint ID

  • body —

    EndpointTemplate

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

    the optional parameters

Returns:

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

    Endpoint data, response status code and response headers



8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8495

def put_telephony_providers_edges_endpoint_with_http_info(endpoint_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_endpoint ..."
  end
  
  
  # verify the required parameter 'endpoint_id' is set
  fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_endpoint" if endpoint_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_endpoint" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_endpoint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_extension(extension_id, body, opts = {}) ⇒ Extension

Update an extension by ID.

Parameters:

  • extension_id —

    Extension ID

  • body —

    Extension

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

    the optional parameters

Returns:



8559
8560
8561
8562
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8559

def put_telephony_providers_edges_extension(extension_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_extension_with_http_info(extension_id, body, opts)
  return data
end

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

Update an extension by ID.

Parameters:

  • extension_id —

    Extension ID

  • body —

    Extension

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

    the optional parameters

Returns:

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

    Extension data, response status code and response headers



8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8570

def put_telephony_providers_edges_extension_with_http_info(extension_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_extension ..."
  end
  
  
  # verify the required parameter 'extension_id' is set
  fail ArgumentError, "Missing the required parameter 'extension_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_extension" if extension_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_extension" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_extension\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_extensionpool(extension_pool_id, body, opts = {}) ⇒ ExtensionPool

Update an extension pool by ID

Parameters:

  • extension_pool_id —

    Extension pool ID

  • body —

    ExtensionPool

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

    the optional parameters

Returns:



8634
8635
8636
8637
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8634

def put_telephony_providers_edges_extensionpool(extension_pool_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_extensionpool_with_http_info(extension_pool_id, body, opts)
  return data
end

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

Update an extension pool by ID

Parameters:

  • extension_pool_id —

    Extension pool ID

  • body —

    ExtensionPool

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

    the optional parameters

Returns:

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

    ExtensionPool data, response status code and response headers



8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8645

def put_telephony_providers_edges_extensionpool_with_http_info(extension_pool_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_extensionpool ..."
  end
  
  
  # verify the required parameter 'extension_pool_id' is set
  fail ArgumentError, "Missing the required parameter 'extension_pool_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_extensionpool" if extension_pool_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_extensionpool" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_extensionpool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_outboundroute(outbound_route_id, body, opts = {}) ⇒ OutboundRoute

Update outbound route

Parameters:

  • outbound_route_id —

    Outbound route ID

  • body —

    OutboundRoute

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

    the optional parameters

Returns:



8709
8710
8711
8712
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8709

def put_telephony_providers_edges_outboundroute(outbound_route_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_outboundroute_with_http_info(outbound_route_id, body, opts)
  return data
end

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

Update outbound route

Parameters:

  • outbound_route_id —

    Outbound route ID

  • body —

    OutboundRoute

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

    the optional parameters

Returns:

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

    OutboundRoute data, response status code and response headers



8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8720

def put_telephony_providers_edges_outboundroute_with_http_info(outbound_route_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_outboundroute ..."
  end
  
  
  # verify the required parameter 'outbound_route_id' is set
  fail ArgumentError, "Missing the required parameter 'outbound_route_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_outboundroute" if outbound_route_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_outboundroute" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_outboundroute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_phone(phone_id, body, opts = {}) ⇒ Phone

Update a Phone by ID

Parameters:

  • phone_id —

    Phone ID

  • body —

    Phone

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

    the optional parameters

Returns:



8784
8785
8786
8787
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8784

def put_telephony_providers_edges_phone(phone_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_phone_with_http_info(phone_id, body, opts)
  return data
end

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

Update a Phone by ID

Parameters:

  • phone_id —

    Phone ID

  • body —

    Phone

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

    the optional parameters

Returns:

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

    Phone data, response status code and response headers



8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8795

def put_telephony_providers_edges_phone_with_http_info(phone_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_phone ..."
  end
  
  
  # verify the required parameter 'phone_id' is set
  fail ArgumentError, "Missing the required parameter 'phone_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_phone" if phone_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_phone" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_phone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_phonebasesetting(phone_base_id, body, opts = {}) ⇒ PhoneBase

Update a Phone Base Settings by ID

Parameters:

  • phone_base_id —

    Phone base ID

  • body —

    Phone base settings

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

    the optional parameters

Returns:



8859
8860
8861
8862
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8859

def put_telephony_providers_edges_phonebasesetting(phone_base_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_phonebasesetting_with_http_info(phone_base_id, body, opts)
  return data
end

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

Update a Phone Base Settings by ID

Parameters:

  • phone_base_id —

    Phone base ID

  • body —

    Phone base settings

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

    the optional parameters

Returns:

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

    PhoneBase data, response status code and response headers



8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8870

def put_telephony_providers_edges_phonebasesetting_with_http_info(phone_base_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_phonebasesetting ..."
  end
  
  
  # verify the required parameter 'phone_base_id' is set
  fail ArgumentError, "Missing the required parameter 'phone_base_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_phonebasesetting" if phone_base_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_phonebasesetting" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_phonebasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_site(site_id, body, opts = {}) ⇒ Site

Update a Site by ID.

Parameters:

  • site_id —

    Site ID

  • body —

    Site

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

    the optional parameters

Returns:



8934
8935
8936
8937
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8934

def put_telephony_providers_edges_site(site_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_site_with_http_info(site_id, body, opts)
  return data
end

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

Update the list of Number Plans.

Parameters:

  • site_id —

    Site ID

  • body —

    List of number plans

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

    the optional parameters

Returns:



9009
9010
9011
9012
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 9009

def put_telephony_providers_edges_site_numberplans(site_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_site_numberplans_with_http_info(site_id, body, opts)
  return data
end

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

Update the list of Number Plans.

Parameters:

  • site_id —

    Site ID

  • body —

    List of number plans

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

    the optional parameters

Returns:

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

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



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 9020

def put_telephony_providers_edges_site_numberplans_with_http_info(site_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_site_numberplans ..."
  end
  
  
  # verify the required parameter 'site_id' is set
  fail ArgumentError, "Missing the required parameter 'site_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_site_numberplans" if site_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_site_numberplans" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_site_numberplans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id, body, opts = {}) ⇒ OutboundRouteBase

Update outbound route

Parameters:

  • site_id —

    Site ID

  • outbound_route_id —

    Outbound route ID

  • body —

    OutboundRoute

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

    the optional parameters

Returns:



9085
9086
9087
9088
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 9085

def put_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_site_outboundroute_with_http_info(site_id, outbound_route_id, body, opts)
  return data
end

#put_telephony_providers_edges_site_outboundroute_with_http_info(site_id, outbound_route_id, body, opts = {}) ⇒ Array<(OutboundRouteBase, Fixnum, Hash)>

Update outbound route

Parameters:

  • site_id —

    Site ID

  • outbound_route_id —

    Outbound route ID

  • body —

    OutboundRoute

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

    the optional parameters

Returns:

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

    OutboundRouteBase data, response status code and response headers



9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 9097

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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 => 'OutboundRouteBase')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_telephony_providers_edges_site_outboundroute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a Site by ID.

Parameters:

  • site_id —

    Site ID

  • body —

    Site

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

    the optional parameters

Returns:

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

    Site data, response status code and response headers



8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 8945

def put_telephony_providers_edges_site_with_http_info(site_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_site ..."
  end
  
  
  # verify the required parameter 'site_id' is set
  fail ArgumentError, "Missing the required parameter 'site_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_site" if site_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_site" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_site\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_telephony_providers_edges_trunkbasesetting(trunk_base_settings_id, body, opts = {}) ⇒ TrunkBase

Update a Trunk Base Settings object by ID

Parameters:

  • trunk_base_settings_id —

    Trunk Base ID

  • body —

    Trunk base settings

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

    the optional parameters

Returns:



9169
9170
9171
9172
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 9169

def put_telephony_providers_edges_trunkbasesetting(trunk_base_settings_id, body, opts = {})
  data, _status_code, _headers = put_telephony_providers_edges_trunkbasesetting_with_http_info(trunk_base_settings_id, body, opts)
  return data
end

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

Update a Trunk Base Settings object by ID

Parameters:

  • trunk_base_settings_id —

    Trunk Base ID

  • body —

    Trunk base settings

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

    the optional parameters

Returns:

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

    TrunkBase data, response status code and response headers



9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
 
# File 'lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb', line 9180

def put_telephony_providers_edges_trunkbasesetting_with_http_info(trunk_base_settings_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.put_telephony_providers_edges_trunkbasesetting ..."
  end
  
  
  # verify the required parameter 'trunk_base_settings_id' is set
  fail ArgumentError, "Missing the required parameter 'trunk_base_settings_id' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_trunkbasesetting" if trunk_base_settings_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TelephonyProvidersEdgeApi.put_telephony_providers_edges_trunkbasesetting" if body.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_telephony_providers_edges_trunkbasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end