Class: Bandwidth::ConferencesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/api/conferences_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConferencesApi

Returns a new instance of ConferencesApi.



19
20
21
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#download_conference_recording(account_id, conference_id, recording_id, opts = {}) ⇒ File

Download Conference Recording Downloads the specified recording file.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

  • recording_id (String) —

    Programmable Voice API Recording ID.

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

    the optional parameters

Returns:

  • (File) 


29
30
31
32
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 29

def download_conference_recording(, conference_id, recording_id, opts = {})
  data, _status_code, _headers = download_conference_recording_with_http_info(, conference_id, recording_id, opts)
  data
end

#download_conference_recording_with_http_info(account_id, conference_id, recording_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Download Conference Recording Downloads the specified recording file.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

  • recording_id (String) —

    Programmable Voice API Recording ID.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 41

def download_conference_recording_with_http_info(, conference_id, recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConferencesApi.download_conference_recording ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ConferencesApi.download_conference_recording"
  end
  # verify the required parameter 'conference_id' is set
  if @api_client.config.client_side_validation && conference_id.nil?
    fail ArgumentError, "Missing the required parameter 'conference_id' when calling ConferencesApi.download_conference_recording"
  end
  # verify the required parameter 'recording_id' is set
  if @api_client.config.client_side_validation && recording_id.nil?
    fail ArgumentError, "Missing the required parameter 'recording_id' when calling ConferencesApi.download_conference_recording"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}/media'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s)).sub('{' + 'recordingId' + '}', CGI.escape(recording_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['audio/vnd.wave', 'audio/mpeg', 'application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"ConferencesApi.download_conference_recording",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConferencesApi#download_conference_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conference(account_id, conference_id, opts = {}) ⇒ Conference

Get Conference Information Returns information about the specified conference.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

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

    the optional parameters

Returns:



103
104
105
106
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 103

def get_conference(, conference_id, opts = {})
  data, _status_code, _headers = get_conference_with_http_info(, conference_id, opts)
  data
end

#get_conference_member(account_id, conference_id, member_id, opts = {}) ⇒ ConferenceMember

Get Conference Member Returns information about the specified conference member.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

  • member_id (String) —

    Programmable Voice API Conference Member ID.

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

    the optional parameters

Returns:



173
174
175
176
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 173

def get_conference_member(, conference_id, member_id, opts = {})
  data, _status_code, _headers = get_conference_member_with_http_info(, conference_id, member_id, opts)
  data
end

#get_conference_member_with_http_info(account_id, conference_id, member_id, opts = {}) ⇒ Array<(ConferenceMember, Integer, Hash)>

Get Conference Member Returns information about the specified conference member.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

  • member_id (String) —

    Programmable Voice API Conference Member ID.

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

    the optional parameters

Returns:

  • (Array<(ConferenceMember, Integer, Hash)>) —

    ConferenceMember data, response status code and response headers



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
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 185

def get_conference_member_with_http_info(, conference_id, member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConferencesApi.get_conference_member ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ConferencesApi.get_conference_member"
  end
  # verify the required parameter 'conference_id' is set
  if @api_client.config.client_side_validation && conference_id.nil?
    fail ArgumentError, "Missing the required parameter 'conference_id' when calling ConferencesApi.get_conference_member"
  end
  # verify the required parameter 'member_id' is set
  if @api_client.config.client_side_validation && member_id.nil?
    fail ArgumentError, "Missing the required parameter 'member_id' when calling ConferencesApi.get_conference_member"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/conferences/{conferenceId}/members/{memberId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s)).sub('{' + 'memberId' + '}', CGI.escape(member_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ConferenceMember'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"ConferencesApi.get_conference_member",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConferencesApi#get_conference_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conference_recording(account_id, conference_id, recording_id, opts = {}) ⇒ ConferenceRecordingMetadata

Get Conference Recording Information Returns metadata for the specified recording.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

  • recording_id (String) —

    Programmable Voice API Recording ID.

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

    the optional parameters

Returns:



248
249
250
251
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 248

def get_conference_recording(, conference_id, recording_id, opts = {})
  data, _status_code, _headers = get_conference_recording_with_http_info(, conference_id, recording_id, opts)
  data
end

#get_conference_recording_with_http_info(account_id, conference_id, recording_id, opts = {}) ⇒ Array<(ConferenceRecordingMetadata, Integer, Hash)>

Get Conference Recording Information Returns metadata for the specified recording.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

  • recording_id (String) —

    Programmable Voice API Recording ID.

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

    the optional parameters

Returns:

  • (Array<(ConferenceRecordingMetadata, Integer, Hash)>) —

    ConferenceRecordingMetadata data, response status code and response headers



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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 260

def get_conference_recording_with_http_info(, conference_id, recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConferencesApi.get_conference_recording ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ConferencesApi.get_conference_recording"
  end
  # verify the required parameter 'conference_id' is set
  if @api_client.config.client_side_validation && conference_id.nil?
    fail ArgumentError, "Missing the required parameter 'conference_id' when calling ConferencesApi.get_conference_recording"
  end
  # verify the required parameter 'recording_id' is set
  if @api_client.config.client_side_validation && recording_id.nil?
    fail ArgumentError, "Missing the required parameter 'recording_id' when calling ConferencesApi.get_conference_recording"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s)).sub('{' + 'recordingId' + '}', CGI.escape(recording_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ConferenceRecordingMetadata'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"ConferencesApi.get_conference_recording",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConferencesApi#get_conference_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conference_with_http_info(account_id, conference_id, opts = {}) ⇒ Array<(Conference, Integer, Hash)>

Get Conference Information Returns information about the specified conference.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

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

    the optional parameters

Returns:

  • (Array<(Conference, Integer, Hash)>) —

    Conference data, response status code and response headers



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
164
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 114

def get_conference_with_http_info(, conference_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConferencesApi.get_conference ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ConferencesApi.get_conference"
  end
  # verify the required parameter 'conference_id' is set
  if @api_client.config.client_side_validation && conference_id.nil?
    fail ArgumentError, "Missing the required parameter 'conference_id' when calling ConferencesApi.get_conference"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/conferences/{conferenceId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Conference'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"ConferencesApi.get_conference",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConferencesApi#get_conference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_conference_recordings(account_id, conference_id, opts = {}) ⇒ Array<ConferenceRecordingMetadata>

Get Conference Recordings Returns a (potentially empty) list of metadata for the recordings that took place during the specified conference.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

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

    the optional parameters

Returns:



322
323
324
325
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 322

def list_conference_recordings(, conference_id, opts = {})
  data, _status_code, _headers = list_conference_recordings_with_http_info(, conference_id, opts)
  data
end

#list_conference_recordings_with_http_info(account_id, conference_id, opts = {}) ⇒ Array<(Array<ConferenceRecordingMetadata>, Integer, Hash)>

Get Conference Recordings Returns a (potentially empty) list of metadata for the recordings that took place during the specified conference.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

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

    the optional parameters

Returns:

  • (Array<(Array<ConferenceRecordingMetadata>, Integer, Hash)>) —

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



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
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 333

def list_conference_recordings_with_http_info(, conference_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConferencesApi.list_conference_recordings ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ConferencesApi.list_conference_recordings"
  end
  # verify the required parameter 'conference_id' is set
  if @api_client.config.client_side_validation && conference_id.nil?
    fail ArgumentError, "Missing the required parameter 'conference_id' when calling ConferencesApi.list_conference_recordings"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/conferences/{conferenceId}/recordings'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ConferenceRecordingMetadata>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"ConferencesApi.list_conference_recordings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConferencesApi#list_conference_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_conferences(account_id, opts = {}) ⇒ Array<Conference>

Get Conferences Returns a max of 1000 conferences, sorted by ‘createdTime` from oldest to newest. NOTE: If the number of conferences in the account is bigger than `pageSize`, a `Link` header (with format `<url>; rel="next"`) will be returned in the response. The url can be used to retrieve the next page of conference records.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filter results by the &#x60;name&#x60; field.

  • :min_created_time (String) —

    Filter results to conferences which have a &#x60;createdTime&#x60; after or at &#x60;minCreatedTime&#x60; (in ISO8601 format).

  • :max_created_time (String) —

    Filter results to conferences which have a &#x60;createdTime&#x60; before or at &#x60;maxCreatedTime&#x60; (in ISO8601 format).

  • :page_size (Integer) —

    Specifies the max number of conferences that will be returned. (default to 1000)

  • :page_token (String) —

    Not intended for explicit use. To use pagination, follow the links in the &#x60;Link&#x60; header of the response, as indicated in the endpoint description.

Returns:



395
396
397
398
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 395

def list_conferences(, opts = {})
  data, _status_code, _headers = list_conferences_with_http_info(, opts)
  data
end

#list_conferences_with_http_info(account_id, opts = {}) ⇒ Array<(Array<Conference>, Integer, Hash)>

Get Conferences Returns a max of 1000 conferences, sorted by &#x60;createdTime&#x60; from oldest to newest. NOTE: If the number of conferences in the account is bigger than &#x60;pageSize&#x60;, a &#x60;Link&#x60; header (with format &#x60;&lt;url&gt;; rel&#x3D;&quot;next&quot;&#x60;) will be returned in the response. The url can be used to retrieve the next page of conference records.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filter results by the &#x60;name&#x60; field.

  • :min_created_time (String) —

    Filter results to conferences which have a &#x60;createdTime&#x60; after or at &#x60;minCreatedTime&#x60; (in ISO8601 format).

  • :max_created_time (String) —

    Filter results to conferences which have a &#x60;createdTime&#x60; before or at &#x60;maxCreatedTime&#x60; (in ISO8601 format).

  • :page_size (Integer) —

    Specifies the max number of conferences that will be returned. (default to 1000)

  • :page_token (String) —

    Not intended for explicit use. To use pagination, follow the links in the &#x60;Link&#x60; header of the response, as indicated in the endpoint description.

Returns:

  • (Array<(Array<Conference>, Integer, Hash)>) —

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



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 410

def list_conferences_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConferencesApi.list_conferences ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ConferencesApi.list_conferences"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ConferencesApi.list_conferences, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ConferencesApi.list_conferences, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/accounts/{accountId}/conferences'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'minCreatedTime'] = opts[:'min_created_time'] if !opts[:'min_created_time'].nil?
  query_params[:'maxCreatedTime'] = opts[:'max_created_time'] if !opts[:'max_created_time'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Conference>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"ConferencesApi.list_conferences",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConferencesApi#list_conferences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_conference(account_id, conference_id, update_conference, opts = {}) ⇒ nil

Update Conference Update the conference state.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

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

    the optional parameters

Returns:

  • (nil) 


478
479
480
481
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 478

def update_conference(, conference_id, update_conference, opts = {})
  update_conference_with_http_info(, conference_id, update_conference, opts)
  nil
end

#update_conference_bxml(account_id, conference_id, body, opts = {}) ⇒ nil

Update Conference BXML Update the conference BXML document.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

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

    the optional parameters

Returns:

  • (nil) 


558
559
560
561
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 558

def update_conference_bxml(, conference_id, body, opts = {})
  update_conference_bxml_with_http_info(, conference_id, body, opts)
  nil
end

#update_conference_bxml_with_http_info(account_id, conference_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update Conference BXML Update the conference BXML document.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
627
628
629
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 570

def update_conference_bxml_with_http_info(, conference_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConferencesApi.update_conference_bxml ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ConferencesApi.update_conference_bxml"
  end
  # verify the required parameter 'conference_id' is set
  if @api_client.config.client_side_validation && conference_id.nil?
    fail ArgumentError, "Missing the required parameter 'conference_id' when calling ConferencesApi.update_conference_bxml"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConferencesApi.update_conference_bxml"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/conferences/{conferenceId}/bxml'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/xml'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"ConferencesApi.update_conference_bxml",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConferencesApi#update_conference_bxml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_conference_member(account_id, conference_id, member_id, update_conference_member, opts = {}) ⇒ nil

Update Conference Member Updates settings for a particular conference member.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

  • member_id (String) —

    Programmable Voice API Conference Member ID.

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

    the optional parameters

Returns:

  • (nil) 


639
640
641
642
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 639

def update_conference_member(, conference_id, member_id, update_conference_member, opts = {})
  update_conference_member_with_http_info(, conference_id, member_id, update_conference_member, opts)
  nil
end

#update_conference_member_with_http_info(account_id, conference_id, member_id, update_conference_member, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update Conference Member Updates settings for a particular conference member.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

  • member_id (String) —

    Programmable Voice API Conference Member ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 652

def update_conference_member_with_http_info(, conference_id, member_id, update_conference_member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConferencesApi.update_conference_member ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ConferencesApi.update_conference_member"
  end
  # verify the required parameter 'conference_id' is set
  if @api_client.config.client_side_validation && conference_id.nil?
    fail ArgumentError, "Missing the required parameter 'conference_id' when calling ConferencesApi.update_conference_member"
  end
  # verify the required parameter 'member_id' is set
  if @api_client.config.client_side_validation && member_id.nil?
    fail ArgumentError, "Missing the required parameter 'member_id' when calling ConferencesApi.update_conference_member"
  end
  # verify the required parameter 'update_conference_member' is set
  if @api_client.config.client_side_validation && update_conference_member.nil?
    fail ArgumentError, "Missing the required parameter 'update_conference_member' when calling ConferencesApi.update_conference_member"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/conferences/{conferenceId}/members/{memberId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s)).sub('{' + 'memberId' + '}', CGI.escape(member_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_conference_member)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"ConferencesApi.update_conference_member",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConferencesApi#update_conference_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_conference_with_http_info(account_id, conference_id, update_conference, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update Conference Update the conference state.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • conference_id (String) —

    Programmable Voice API Conference ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



490
491
492
493
494
495
496
497
498
499
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
548
549
 
# File 'lib/bandwidth-sdk/api/conferences_api.rb', line 490

def update_conference_with_http_info(, conference_id, update_conference, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConferencesApi.update_conference ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ConferencesApi.update_conference"
  end
  # verify the required parameter 'conference_id' is set
  if @api_client.config.client_side_validation && conference_id.nil?
    fail ArgumentError, "Missing the required parameter 'conference_id' when calling ConferencesApi.update_conference"
  end
  # verify the required parameter 'update_conference' is set
  if @api_client.config.client_side_validation && update_conference.nil?
    fail ArgumentError, "Missing the required parameter 'update_conference' when calling ConferencesApi.update_conference"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/conferences/{conferenceId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_conference)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"ConferencesApi.update_conference",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConferencesApi#update_conference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end