Class: Bandwidth::WebRtc::APIController

Inherits:
BaseController show all
Defined in:
lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb

Overview

APIController

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #validate_parameters, #validate_response

Constructor Details

#initialize(config, http_call_back: nil) ⇒ APIController

Returns a new instance of APIController.



10
11
12
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 10

def initialize(config, http_call_back: nil)
  super(config, http_call_back: http_call_back)
end

Instance Method Details

#add_participant_to_session(account_id, session_id, participant_id, body: nil) ⇒ void

This method returns an undefined value.

Add a participant to a session. Subscriptions can optionally be provided as part of this call. participant should be created with

Parameters:

  • account_id (String) —

    Required parameter: Account ID

  • session_id (String) —

    Required parameter: Session ID

  • participant_id (String) —

    Required parameter: Participant ID

  • body (Subscriptions) (defaults to: nil) —

    Optional parameter: Subscriptions the



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
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 446

def add_participant_to_session(,
                               session_id,
                               participant_id,
                               body: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
  _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'sessionId' => { 'value' => session_id, 'encode' => false },
    'participantId' => { 'value' => participant_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'content-type' => 'application/json; charset=utf-8'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.put(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  WebRtcBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 401
    raise APIException.new(
      'Unauthorized',
      _response
    )
  when 403
    raise APIException.new(
      'Access Denied',
      _response
    )
  when 404
    raise APIException.new(
      'Not Found',
      _response
    )
  end
  unless _response.status_code.between?(200, 208)
    raise ErrorException.new(
      'Unexpected Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  ApiResponse.new(_response)
end

#create_participant(account_id, body: nil) ⇒ AccountsParticipantsResponse

Create a new participant under this account. Participants are idempotent, so relevant parameters must be set in this function if desired.

Parameters:

  • account_id (String) —

    Required parameter: Account ID

  • body (Participant) (defaults to: nil) —

    Optional parameter: Participant parameters

Returns:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 20

def create_participant(,
                       body: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
  _query_builder << '/accounts/{accountId}/participants'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  WebRtcBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 400
    raise APIException.new(
      'Bad Request',
      _response
    )
  when 401
    raise APIException.new(
      'Unauthorized',
      _response
    )
  when 403
    raise APIException.new(
      'Access Denied',
      _response
    )
  end
  unless _response.status_code.between?(200, 208)
    raise ErrorException.new(
      'Unexpected Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response,
    data: AccountsParticipantsResponse.from_hash(decoded)
  )
end

#create_session(account_id, body: nil) ⇒ Session

Create a new session. Sessions are idempotent, so relevant parameters must be set in this function if desired.

Parameters:

  • account_id (String) —

    Required parameter: Account ID

  • body (Session) (defaults to: nil) —

    Optional parameter: Session parameters

Returns:

  • (Session) —

    response from the API call



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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 201

def create_session(,
                   body: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
  _query_builder << '/accounts/{accountId}/sessions'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  WebRtcBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 400
    raise APIException.new(
      'Bad Request',
      _response
    )
  when 401
    raise APIException.new(
      'Unauthorized',
      _response
    )
  when 403
    raise APIException.new(
      'Access Denied',
      _response
    )
  end
  unless _response.status_code.between?(200, 208)
    raise ErrorException.new(
      'Unexpected Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response, data: Session.from_hash(decoded)
  )
end

#delete_participant(account_id, participant_id) ⇒ void

This method returns an undefined value.

Delete participant by ID.

Parameters:

  • account_id (String) —

    Required parameter: Account ID

  • participant_id (String) —

    Required parameter: Example:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 146

def delete_participant(,
                       participant_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
  _query_builder << '/accounts/{accountId}/participants/{participantId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'participantId' => { 'value' => participant_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare and execute HttpRequest.
  _request = config.http_client.delete(
    _query_url
  )
  WebRtcBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 401
    raise APIException.new(
      'Unauthorized',
      _response
    )
  when 403
    raise APIException.new(
      'Access Denied',
      _response
    )
  when 404
    raise APIException.new(
      'Not Found',
      _response
    )
  end
  unless _response.status_code.between?(200, 208)
    raise ErrorException.new(
      'Unexpected Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  ApiResponse.new(_response)
end

#delete_session(account_id, session_id) ⇒ void

This method returns an undefined value.

Delete session by ID.

Parameters:

  • account_id (String) —

    Required parameter: Account ID

  • session_id (String) —

    Required parameter: Session ID



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 326

def delete_session(,
                   session_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
  _query_builder << '/accounts/{accountId}/sessions/{sessionId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'sessionId' => { 'value' => session_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare and execute HttpRequest.
  _request = config.http_client.delete(
    _query_url
  )
  WebRtcBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 401
    raise APIException.new(
      'Unauthorized',
      _response
    )
  when 403
    raise APIException.new(
      'Access Denied',
      _response
    )
  when 404
    raise APIException.new(
      'Not Found',
      _response
    )
  end
  unless _response.status_code.between?(200, 208)
    raise ErrorException.new(
      'Unexpected Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  ApiResponse.new(_response)
end

#get_participant(account_id, participant_id) ⇒ Participant

Get participant by ID.

Parameters:

  • account_id (String) —

    Required parameter: Account ID

  • participant_id (String) —

    Required parameter: Participant ID

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 84

def get_participant(,
                    participant_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
  _query_builder << '/accounts/{accountId}/participants/{participantId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'participantId' => { 'value' => participant_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  WebRtcBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 401
    raise APIException.new(
      'Unauthorized',
      _response
    )
  when 403
    raise APIException.new(
      'Access Denied',
      _response
    )
  when 404
    raise APIException.new(
      'Not Found',
      _response
    )
  end
  unless _response.status_code.between?(200, 208)
    raise ErrorException.new(
      'Unexpected Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response, data: Participant.from_hash(decoded)
  )
end

#get_participant_subscriptions(account_id, session_id, participant_id) ⇒ Subscriptions

Get a participant’s subscriptions.

Parameters:

  • account_id (String) —

    Required parameter: Account ID

  • session_id (String) —

    Required parameter: Session ID

  • participant_id (String) —

    Required parameter: Participant ID

Returns:



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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 568

def get_participant_subscriptions(,
                                  session_id,
                                  participant_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
  _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}/subscriptions'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'sessionId' => { 'value' => session_id, 'encode' => false },
    'participantId' => { 'value' => participant_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  WebRtcBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 401
    raise APIException.new(
      'Unauthorized',
      _response
    )
  when 403
    raise APIException.new(
      'Access Denied',
      _response
    )
  when 404
    raise APIException.new(
      'Not Found',
      _response
    )
  end
  unless _response.status_code.between?(200, 208)
    raise ErrorException.new(
      'Unexpected Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response, data: Subscriptions.from_hash(decoded)
  )
end

#get_session(account_id, session_id) ⇒ Session

Get session by ID.

Parameters:

  • account_id (String) —

    Required parameter: Account ID

  • session_id (String) —

    Required parameter: Session ID

Returns:

  • (Session) —

    response from the API call



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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 264

def get_session(,
                session_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
  _query_builder << '/accounts/{accountId}/sessions/{sessionId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'sessionId' => { 'value' => session_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  WebRtcBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 401
    raise APIException.new(
      'Unauthorized',
      _response
    )
  when 403
    raise APIException.new(
      'Access Denied',
      _response
    )
  when 404
    raise APIException.new(
      'Not Found',
      _response
    )
  end
  unless _response.status_code.between?(200, 208)
    raise ErrorException.new(
      'Unexpected Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response, data: Session.from_hash(decoded)
  )
end

#list_session_participants(account_id, session_id) ⇒ List of Participant

List participants in a session.

Parameters:

  • account_id (String) —

    Required parameter: Account ID

  • session_id (String) —

    Required parameter: Session ID

Returns:



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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 379

def list_session_participants(,
                              session_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
  _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'sessionId' => { 'value' => session_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  WebRtcBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 401
    raise APIException.new(
      'Unauthorized',
      _response
    )
  when 403
    raise APIException.new(
      'Access Denied',
      _response
    )
  when 404
    raise APIException.new(
      'Not Found',
      _response
    )
  end
  unless _response.status_code.between?(200, 208)
    raise ErrorException.new(
      'Unexpected Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response,
    data: decoded.map { |element| Participant.from_hash(element) }
  )
end

#remove_participant_from_session(account_id, session_id, participant_id) ⇒ void

This method returns an undefined value.

Remove a participant from a session. This will automatically remove any subscriptions the participant has associated with this session.

Parameters:

  • account_id (String) —

    Required parameter: Account ID

  • session_id (String) —

    Required parameter: Session ID

  • participant_id (String) —

    Required parameter: Participant ID



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
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 512

def remove_participant_from_session(,
                                    session_id,
                                    participant_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
  _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'sessionId' => { 'value' => session_id, 'encode' => false },
    'participantId' => { 'value' => participant_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare and execute HttpRequest.
  _request = config.http_client.delete(
    _query_url
  )
  WebRtcBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 401
    raise APIException.new(
      'Unauthorized',
      _response
    )
  when 403
    raise APIException.new(
      'Access Denied',
      _response
    )
  when 404
    raise APIException.new(
      'Not Found',
      _response
    )
  end
  unless _response.status_code.between?(200, 208)
    raise ErrorException.new(
      'Unexpected Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  ApiResponse.new(_response)
end

#update_participant_subscriptions(account_id, session_id, participant_id, body: nil) ⇒ void

This method returns an undefined value.

Update a participant’s subscriptions. This is a full update that will replace the participant’s subscriptions. First call ‘getParticipantSubscriptions` if you need the current subscriptions. Call this function with no `Subscriptions` object to remove all subscriptions.

Parameters:

  • account_id (String) —

    Required parameter: Account ID

  • session_id (String) —

    Required parameter: Session ID

  • participant_id (String) —

    Required parameter: Participant ID

  • body (Subscriptions) (defaults to: nil) —

    Optional parameter: Initial state



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
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb', line 638

def update_participant_subscriptions(,
                                     session_id,
                                     participant_id,
                                     body: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
  _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}/subscriptions'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'sessionId' => { 'value' => session_id, 'encode' => false },
    'participantId' => { 'value' => participant_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'content-type' => 'application/json; charset=utf-8'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.put(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  WebRtcBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 400
    raise APIException.new(
      'Bad Request',
      _response
    )
  when 401
    raise APIException.new(
      'Unauthorized',
      _response
    )
  when 403
    raise APIException.new(
      'Access Denied',
      _response
    )
  when 404
    raise APIException.new(
      'Not Found',
      _response
    )
  end
  unless _response.status_code.between?(200, 208)
    raise ErrorException.new(
      'Unexpected Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  ApiResponse.new(_response)
end