Class: Freeclimb::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/freeclimb/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, account_id = nil) ⇒ DefaultApi

Returns a new instance of DefaultApi.



19
20
21
22
23
24
25
26
 
# File 'lib/freeclimb/api/default_api.rb', line 19

def initialize(api_client = ApiClient.default,  = nil)
  @api_client = api_client
  if .nil?
    @account_id = api_client.config.username
  else
    @account_id = 
  end
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/freeclimb/api/default_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#buy_a_phone_number(opts = {}) ⇒ IncomingNumberResult

Buy a Phone Number

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



85
86
87
88
 
# File 'lib/freeclimb/api/default_api.rb', line 85

def buy_a_phone_number(opts = {})
  data, _status_code, _headers = buy_a_phone_number_with_http_info(opts)
  data
end

#buy_a_phone_number_with_http_info(opts = {}) ⇒ Array<(IncomingNumberResult, Integer, Hash)>

Buy a Phone Number

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IncomingNumberResult data, response status code and response headers



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
 
# File 'lib/freeclimb/api/default_api.rb', line 94

def buy_a_phone_number_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.buy_a_phone_number ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/IncomingPhoneNumbers'.sub('{' + 'accountId' + '}', CGI.escape(@account_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'IncomingNumberResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#buy_a_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_a_conference(opts = {}) ⇒ ConferenceResult

Create a Conference

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



143
144
145
146
 
# File 'lib/freeclimb/api/default_api.rb', line 143

def create_a_conference(opts = {})
  data, _status_code, _headers = create_a_conference_with_http_info(opts)
  data
end

#create_a_conference_with_http_info(opts = {}) ⇒ Array<(ConferenceResult, Integer, Hash)>

Create a Conference

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ConferenceResult data, response status code and response headers



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
194
195
 
# File 'lib/freeclimb/api/default_api.rb', line 152

def create_a_conference_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_a_conference ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Conferences'.sub('{' + 'accountId' + '}', CGI.escape(@account_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'ConferenceResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#create_a_conference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_a_queue(opts = {}) ⇒ QueueResult

Create a Queue

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :queue_request (QueueRequest) —

    Queue details used to create a queue

Returns:



201
202
203
204
 
# File 'lib/freeclimb/api/default_api.rb', line 201

def create_a_queue(opts = {})
  data, _status_code, _headers = create_a_queue_with_http_info(opts)
  data
end

#create_a_queue_with_http_info(opts = {}) ⇒ Array<(QueueResult, Integer, Hash)>

Create a Queue

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :queue_request (QueueRequest) —

    Queue details used to create a queue

Returns:

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

    QueueResult data, response status code and response headers



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
 
# File 'lib/freeclimb/api/default_api.rb', line 210

def create_a_queue_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_a_queue ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Queues'.sub('{' + 'accountId' + '}', CGI.escape(@account_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'QueueResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#create_a_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_an_application(opts = {}) ⇒ ApplicationResult

Create an application

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



259
260
261
262
 
# File 'lib/freeclimb/api/default_api.rb', line 259

def create_an_application(opts = {})
  data, _status_code, _headers = create_an_application_with_http_info(opts)
  data
end

#create_an_application_with_http_info(opts = {}) ⇒ Array<(ApplicationResult, Integer, Hash)>

Create an application

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ApplicationResult data, response status code and response headers



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
 
# File 'lib/freeclimb/api/default_api.rb', line 268

def create_an_application_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_an_application ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Applications'.sub('{' + 'accountId' + '}', CGI.escape(@account_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'ApplicationResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#create_an_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_a_recording(recording_id, opts = {}) ⇒ nil

Delete a Recording

Parameters:

  • recording_id (String) —

    String that uniquely identifies this recording resource.

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

    the optional parameters

Returns:

  • (nil) 


317
318
319
320
 
# File 'lib/freeclimb/api/default_api.rb', line 317

def delete_a_recording(recording_id, opts = {})
  delete_a_recording_with_http_info(recording_id, opts)
  nil
end

#delete_a_recording_with_http_info(recording_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a Recording

Parameters:

  • recording_id (String) —

    String that uniquely identifies this recording resource.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/freeclimb/api/default_api.rb', line 326

def delete_a_recording_with_http_info(recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_a_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 DefaultApi.delete_a_recording"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Recordings/{recordingId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_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] || {}

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_a_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_an_application(application_id, opts = {}) ⇒ nil

Delete an application

Parameters:

  • application_id (String) —

    String that uniquely identifies this application resource.

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

    the optional parameters

Returns:

  • (nil) 


375
376
377
378
 
# File 'lib/freeclimb/api/default_api.rb', line 375

def delete_an_application(application_id, opts = {})
  delete_an_application_with_http_info(application_id, opts)
  nil
end

#delete_an_application_with_http_info(application_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an application

Parameters:

  • application_id (String) —

    String that uniquely identifies this application resource.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/freeclimb/api/default_api.rb', line 384

def delete_an_application_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_an_application ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling DefaultApi.delete_an_application"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Applications/{applicationId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_an_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_an_incoming_number(phone_number_id, opts = {}) ⇒ nil

Delete an Incoming Number

Parameters:

  • phone_number_id (String) —

    String that uniquely identifies this phone number resource.

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

    the optional parameters

Returns:

  • (nil) 


433
434
435
436
 
# File 'lib/freeclimb/api/default_api.rb', line 433

def delete_an_incoming_number(phone_number_id, opts = {})
  delete_an_incoming_number_with_http_info(phone_number_id, opts)
  nil
end

#delete_an_incoming_number_with_http_info(phone_number_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an Incoming Number

Parameters:

  • phone_number_id (String) —

    String that uniquely identifies this phone number resource.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
484
485
 
# File 'lib/freeclimb/api/default_api.rb', line 442

def delete_an_incoming_number_with_http_info(phone_number_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_an_incoming_number ...'
  end
  # verify the required parameter 'phone_number_id' is set
  if @api_client.config.client_side_validation && phone_number_id.nil?
    fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling DefaultApi.delete_an_incoming_number"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_an_incoming_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dequeue_a_member(queue_id, call_id, opts = {}) ⇒ QueueMember

Dequeue a Member

Parameters:

  • queue_id (String) —

    String that uniquely identifies the Queue that the Member belongs to.

  • call_id (String) —

    ID if the Call that the Member belongs to

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

    the optional parameters

Returns:



492
493
494
495
 
# File 'lib/freeclimb/api/default_api.rb', line 492

def dequeue_a_member(queue_id, call_id, opts = {})
  data, _status_code, _headers = dequeue_a_member_with_http_info(queue_id, call_id, opts)
  data
end

#dequeue_a_member_with_http_info(queue_id, call_id, opts = {}) ⇒ Array<(QueueMember, Integer, Hash)>

Dequeue a Member

Parameters:

  • queue_id (String) —

    String that uniquely identifies the Queue that the Member belongs to.

  • call_id (String) —

    ID if the Call that the Member belongs to

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

    the optional parameters

Returns:

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

    QueueMember data, response status code and response headers



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
550
551
 
# File 'lib/freeclimb/api/default_api.rb', line 502

def dequeue_a_member_with_http_info(queue_id, call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.dequeue_a_member ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling DefaultApi.dequeue_a_member"
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling DefaultApi.dequeue_a_member"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Queues/{queueId}/Members/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'queueId' + '}', CGI.escape(queue_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'QueueMember' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#dequeue_a_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#dequeue_head_member(queue_id, opts = {}) ⇒ QueueMember

Dequeue Head Member

Parameters:

  • queue_id (String) —

    String that uniquely identifies this queue resource.

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

    the optional parameters

Returns:



557
558
559
560
 
# File 'lib/freeclimb/api/default_api.rb', line 557

def dequeue_head_member(queue_id, opts = {})
  data, _status_code, _headers = dequeue_head_member_with_http_info(queue_id, opts)
  data
end

#dequeue_head_member_with_http_info(queue_id, opts = {}) ⇒ Array<(QueueMember, Integer, Hash)>

Dequeue Head Member

Parameters:

  • queue_id (String) —

    String that uniquely identifies this queue resource.

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

    the optional parameters

Returns:

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

    QueueMember data, response status code and response headers



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/freeclimb/api/default_api.rb', line 566

def dequeue_head_member_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.dequeue_head_member ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling DefaultApi.dequeue_head_member"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Queues/{queueId}/Members/Front'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'queueId' + '}', CGI.escape(queue_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'QueueMember' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#dequeue_head_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#download_a_recording_file(recording_id, opts = {}) ⇒ File

Download a Recording File

Parameters:

  • recording_id (String) —

    String that uniquely identifies this recording resource.

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

    the optional parameters

Returns:

  • (File) 


617
618
619
620
 
# File 'lib/freeclimb/api/default_api.rb', line 617

def download_a_recording_file(recording_id, opts = {})
  data, _status_code, _headers = download_a_recording_file_with_http_info(recording_id, opts)
  data
end

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

Download a Recording File

Parameters:

  • recording_id (String) —

    String that uniquely identifies this recording resource.

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



626
627
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
 
# File 'lib/freeclimb/api/default_api.rb', line 626

def download_a_recording_file_with_http_info(recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.download_a_recording_file ...'
  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 DefaultApi.download_a_recording_file"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Recordings/{recordingId}/Download'.sub('{' + 'accountId' + '}', CGI.escape(@account_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/x-wav'])

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

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

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

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#download_a_recording_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#filter_logs(opts = {}) ⇒ LogList

Filter Logs

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



677
678
679
680
 
# File 'lib/freeclimb/api/default_api.rb', line 677

def filter_logs(opts = {})
  data, _status_code, _headers = filter_logs_with_http_info(opts)
  data
end

#filter_logs_with_http_info(opts = {}) ⇒ Array<(LogList, Integer, Hash)>

Filter Logs

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    LogList data, response status code and response headers



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

def filter_logs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.filter_logs ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Logs'.sub('{' + 'accountId' + '}', CGI.escape(@account_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'LogList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#filter_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_call(call_id, opts = {}) ⇒ CallResult

Get a Call

Parameters:

  • call_id (String) —

    String that uniquely identifies this call resource.

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

    the optional parameters

Returns:



735
736
737
738
 
# File 'lib/freeclimb/api/default_api.rb', line 735

def get_a_call(call_id, opts = {})
  data, _status_code, _headers = get_a_call_with_http_info(call_id, opts)
  data
end

#get_a_call_with_http_info(call_id, opts = {}) ⇒ Array<(CallResult, Integer, Hash)>

Get a Call

Parameters:

  • call_id (String) —

    String that uniquely identifies this call resource.

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

    the optional parameters

Returns:

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

    CallResult data, response status code and response headers



744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
 
# File 'lib/freeclimb/api/default_api.rb', line 744

def get_a_call_with_http_info(call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_a_call ...'
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling DefaultApi.get_a_call"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Calls/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'CallResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#get_a_call\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_conference(conference_id, opts = {}) ⇒ ConferenceResult

Get a Conference

Parameters:

  • conference_id (String) —

    A string that uniquely identifies this conference resource.

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

    the optional parameters

Returns:



795
796
797
798
 
# File 'lib/freeclimb/api/default_api.rb', line 795

def get_a_conference(conference_id, opts = {})
  data, _status_code, _headers = get_a_conference_with_http_info(conference_id, opts)
  data
end

#get_a_conference_with_http_info(conference_id, opts = {}) ⇒ Array<(ConferenceResult, Integer, Hash)>

Get a Conference

Parameters:

  • conference_id (String) —

    A string that uniquely identifies this conference resource.

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

    the optional parameters

Returns:

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

    ConferenceResult data, response status code and response headers



804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
 
# File 'lib/freeclimb/api/default_api.rb', line 804

def get_a_conference_with_http_info(conference_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_a_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 DefaultApi.get_a_conference"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Conferences/{conferenceId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.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[:body] 

  # return_type
  return_type = opts[:return_type] || 'ConferenceResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#get_a_conference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_member(queue_id, call_id, opts = {}) ⇒ QueueMember

Get a Member

Parameters:

  • queue_id (String) —

    String that uniquely identifies the Queue that the Member belongs to.

  • call_id (String) —

    ID of the Call that the Member belongs to

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

    the optional parameters

Returns:



856
857
858
859
 
# File 'lib/freeclimb/api/default_api.rb', line 856

def get_a_member(queue_id, call_id, opts = {})
  data, _status_code, _headers = get_a_member_with_http_info(queue_id, call_id, opts)
  data
end

#get_a_member_with_http_info(queue_id, call_id, opts = {}) ⇒ Array<(QueueMember, Integer, Hash)>

Get a Member

Parameters:

  • queue_id (String) —

    String that uniquely identifies the Queue that the Member belongs to.

  • call_id (String) —

    ID of the Call that the Member belongs to

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

    the optional parameters

Returns:

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

    QueueMember data, response status code and response headers



866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
 
# File 'lib/freeclimb/api/default_api.rb', line 866

def get_a_member_with_http_info(queue_id, call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_a_member ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling DefaultApi.get_a_member"
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling DefaultApi.get_a_member"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Queues/{queueId}/Members/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'queueId' + '}', CGI.escape(queue_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'QueueMember' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#get_a_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_participant(conference_id, call_id, opts = {}) ⇒ ConferenceParticipantResult

Get a Participant

Parameters:

  • conference_id (String) —

    ID of the conference this participant is in.

  • call_id (String) —

    ID of the Call associated with this participant.

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

    the optional parameters

Returns:



922
923
924
925
 
# File 'lib/freeclimb/api/default_api.rb', line 922

def get_a_participant(conference_id, call_id, opts = {})
  data, _status_code, _headers = get_a_participant_with_http_info(conference_id, call_id, opts)
  data
end

#get_a_participant_with_http_info(conference_id, call_id, opts = {}) ⇒ Array<(ConferenceParticipantResult, Integer, Hash)>

Get a Participant

Parameters:

  • conference_id (String) —

    ID of the conference this participant is in.

  • call_id (String) —

    ID of the Call associated with this participant.

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

    the optional parameters

Returns:

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

    ConferenceParticipantResult data, response status code and response headers



932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
 
# File 'lib/freeclimb/api/default_api.rb', line 932

def get_a_participant_with_http_info(conference_id, call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_a_participant ...'
  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 DefaultApi.get_a_participant"
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling DefaultApi.get_a_participant"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'ConferenceParticipantResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#get_a_participant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_queue(queue_id, opts = {}) ⇒ QueueResult

Get a Queue

Parameters:

  • queue_id (String) —

    A string that uniquely identifies this queue resource.

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

    the optional parameters

Returns:



987
988
989
990
 
# File 'lib/freeclimb/api/default_api.rb', line 987

def get_a_queue(queue_id, opts = {})
  data, _status_code, _headers = get_a_queue_with_http_info(queue_id, opts)
  data
end

#get_a_queue_with_http_info(queue_id, opts = {}) ⇒ Array<(QueueResult, Integer, Hash)>

Get a Queue

Parameters:

  • queue_id (String) —

    A string that uniquely identifies this queue resource.

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

    the optional parameters

Returns:

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

    QueueResult data, response status code and response headers



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

def get_a_queue_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_a_queue ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling DefaultApi.get_a_queue"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Queues/{queueId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'queueId' + '}', CGI.escape(queue_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'QueueResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#get_a_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_recording(recording_id, opts = {}) ⇒ RecordingResult

Get a Recording

Parameters:

  • recording_id (String) —

    String that uniquely identifies this recording resource.

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

    the optional parameters

Returns:



1047
1048
1049
1050
 
# File 'lib/freeclimb/api/default_api.rb', line 1047

def get_a_recording(recording_id, opts = {})
  data, _status_code, _headers = get_a_recording_with_http_info(recording_id, opts)
  data
end

#get_a_recording_with_http_info(recording_id, opts = {}) ⇒ Array<(RecordingResult, Integer, Hash)>

Get a Recording

Parameters:

  • recording_id (String) —

    String that uniquely identifies this recording resource.

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

    the optional parameters

Returns:

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

    RecordingResult data, response status code and response headers



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
1098
1099
1100
1101
 
# File 'lib/freeclimb/api/default_api.rb', line 1056

def get_a_recording_with_http_info(recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_a_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 DefaultApi.get_a_recording"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Recordings/{recordingId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'RecordingResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#get_a_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_an_account(opts = {}) ⇒ AccountResult

Get an Account

Parameters:

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

    the optional parameters

Returns:



30
31
32
33
 
# File 'lib/freeclimb/api/default_api.rb', line 30

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

#get_an_account_with_http_info(opts = {}) ⇒ Array<(AccountResult, Integer, Hash)>

Get an Account

Parameters:

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

    the optional parameters

Returns:

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

    AccountResult data, response status code and response headers



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
79
 
# File 'lib/freeclimb/api/default_api.rb', line 38

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_an_account ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'AccountResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#get_an_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_an_application(application_id, opts = {}) ⇒ ApplicationResult

Get an Application

Parameters:

  • application_id (String) —

    A string that uniquely identifies this application resource.

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

    the optional parameters

Returns:



1107
1108
1109
1110
 
# File 'lib/freeclimb/api/default_api.rb', line 1107

def get_an_application(application_id, opts = {})
  data, _status_code, _headers = get_an_application_with_http_info(application_id, opts)
  data
end

#get_an_application_with_http_info(application_id, opts = {}) ⇒ Array<(ApplicationResult, Integer, Hash)>

Get an Application

Parameters:

  • application_id (String) —

    A string that uniquely identifies this application resource.

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

    the optional parameters

Returns:

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

    ApplicationResult data, response status code and response headers



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

def get_an_application_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_an_application ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling DefaultApi.get_an_application"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Applications/{applicationId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'applicationId' + '}', CGI.escape(application_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'ApplicationResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#get_an_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_an_incoming_number(phone_number_id, opts = {}) ⇒ IncomingNumberResult

Get an Incoming Number

Parameters:

  • phone_number_id (String) —

    String that uniquely identifies this phone number resource.

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

    the optional parameters

Returns:



1167
1168
1169
1170
 
# File 'lib/freeclimb/api/default_api.rb', line 1167

def get_an_incoming_number(phone_number_id, opts = {})
  data, _status_code, _headers = get_an_incoming_number_with_http_info(phone_number_id, opts)
  data
end

#get_an_incoming_number_with_http_info(phone_number_id, opts = {}) ⇒ Array<(IncomingNumberResult, Integer, Hash)>

Get an Incoming Number

Parameters:

  • phone_number_id (String) —

    String that uniquely identifies this phone number resource.

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

    the optional parameters

Returns:

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

    IncomingNumberResult data, response status code and response headers



1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'lib/freeclimb/api/default_api.rb', line 1176

def get_an_incoming_number_with_http_info(phone_number_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_an_incoming_number ...'
  end
  # verify the required parameter 'phone_number_id' is set
  if @api_client.config.client_side_validation && phone_number_id.nil?
    fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling DefaultApi.get_an_incoming_number"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'IncomingNumberResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#get_an_incoming_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_an_sms_message(message_id, opts = {}) ⇒ MessageResult

Get an SMS Message

Parameters:

  • message_id (String) —

    String that uniquely identifies this Message resource.

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

    the optional parameters

Returns:



1227
1228
1229
1230
 
# File 'lib/freeclimb/api/default_api.rb', line 1227

def get_an_sms_message(message_id, opts = {})
  data, _status_code, _headers = get_an_sms_message_with_http_info(message_id, opts)
  data
end

#get_an_sms_message_with_http_info(message_id, opts = {}) ⇒ Array<(MessageResult, Integer, Hash)>

Get an SMS Message

Parameters:

  • message_id (String) —

    String that uniquely identifies this Message resource.

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

    the optional parameters

Returns:

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

    MessageResult data, response status code and response headers



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
1276
1277
1278
1279
1280
1281
 
# File 'lib/freeclimb/api/default_api.rb', line 1236

def get_an_sms_message_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_an_sms_message ...'
  end
  # verify the required parameter 'message_id' is set
  if @api_client.config.client_side_validation && message_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_id' when calling DefaultApi.get_an_sms_message"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Messages/{messageId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'messageId' + '}', CGI.escape(message_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'MessageResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#get_an_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_head_member(queue_id, opts = {}) ⇒ QueueMember

Get Head Member

Parameters:

  • queue_id (String) —

    String that uniquely identifies the Queue that the Member belongs to.

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

    the optional parameters

Returns:



1287
1288
1289
1290
 
# File 'lib/freeclimb/api/default_api.rb', line 1287

def get_head_member(queue_id, opts = {})
  data, _status_code, _headers = get_head_member_with_http_info(queue_id, opts)
  data
end

#get_head_member_with_http_info(queue_id, opts = {}) ⇒ Array<(QueueMember, Integer, Hash)>

Get Head Member

Parameters:

  • queue_id (String) —

    String that uniquely identifies the Queue that the Member belongs to.

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

    the optional parameters

Returns:

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

    QueueMember data, response status code and response headers



1296
1297
1298
1299
1300
1301
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
 
# File 'lib/freeclimb/api/default_api.rb', line 1296

def get_head_member_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_head_member ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling DefaultApi.get_head_member"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Queues/{queueId}/Members/Front'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'queueId' + '}', CGI.escape(queue_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'QueueMember' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#get_head_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_active_queues(opts = {}) ⇒ QueueList

List Active Queues

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_alias (String) —

    Return only the Queue resources with aliases that exactly match this name.

Returns:



1347
1348
1349
1350
 
# File 'lib/freeclimb/api/default_api.rb', line 1347

def list_active_queues(opts = {})
  data, _status_code, _headers = list_active_queues_with_http_info(opts)
  data
end

#list_active_queues_with_http_info(opts = {}) ⇒ Array<(QueueList, Integer, Hash)>

List Active Queues

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_alias (String) —

    Return only the Queue resources with aliases that exactly match this name.

Returns:

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

    QueueList data, response status code and response headers



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
1390
1391
1392
1393
1394
1395
1396
1397
1398
 
# File 'lib/freeclimb/api/default_api.rb', line 1356

def list_active_queues_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_active_queues ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Queues'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'alias'] = opts[:'_alias'] if !opts[:'_alias'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'QueueList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_active_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_all_account_logs(opts = {}) ⇒ LogList

List All Account Logs

Parameters:

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

    the optional parameters

Returns:



1403
1404
1405
1406
 
# File 'lib/freeclimb/api/default_api.rb', line 1403

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

#list_all_account_logs_with_http_info(opts = {}) ⇒ Array<(LogList, Integer, Hash)>

List All Account Logs

Parameters:

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

    the optional parameters

Returns:

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

    LogList data, response status code and response headers



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
 
# File 'lib/freeclimb/api/default_api.rb', line 1411

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_all_account_logs ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Logs'.sub('{' + 'accountId' + '}', CGI.escape(@account_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'LogList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_all_account_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_an_application(opts = {}) ⇒ ApplicationList

List applications

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_alias (String) —

    Return only applications with aliases that exactly match this value.

Returns:



1458
1459
1460
1461
 
# File 'lib/freeclimb/api/default_api.rb', line 1458

def list_an_application(opts = {})
  data, _status_code, _headers = list_an_application_with_http_info(opts)
  data
end

#list_an_application_with_http_info(opts = {}) ⇒ Array<(ApplicationList, Integer, Hash)>

List applications

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_alias (String) —

    Return only applications with aliases that exactly match this value.

Returns:

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

    ApplicationList data, response status code and response headers



1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
 
# File 'lib/freeclimb/api/default_api.rb', line 1467

def list_an_application_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_an_application ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Applications'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'alias'] = opts[:'_alias'] if !opts[:'_alias'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'ApplicationList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_an_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_available_numbers(opts = {}) ⇒ AvailableNumberList

List available numbers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_alias (String) —

    Filter on numbers based on the formatted string of the phone number.

  • :phone_number (String) —

    PCRE-compatible regular expression to filter against &#x60;phoneNumber&#x60; field, which is in E.164 format.

Returns:



1516
1517
1518
1519
 
# File 'lib/freeclimb/api/default_api.rb', line 1516

def list_available_numbers(opts = {})
  data, _status_code, _headers = list_available_numbers_with_http_info(opts)
  data
end

#list_available_numbers_with_http_info(opts = {}) ⇒ Array<(AvailableNumberList, Integer, Hash)>

List available numbers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_alias (String) —

    Filter on numbers based on the formatted string of the phone number.

  • :phone_number (String) —

    PCRE-compatible regular expression to filter against &#x60;phoneNumber&#x60; field, which is in E.164 format.

Returns:

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

    AvailableNumberList data, response status code and response headers



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

def list_available_numbers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_available_numbers ...'
  end
  # resource path
  local_var_path = '/AvailablePhoneNumbers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'alias'] = opts[:'_alias'] if !opts[:'_alias'].nil?
  query_params[:'phoneNumber'] = opts[:'phone_number'] if !opts[:'phone_number'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'AvailableNumberList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_available_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_call_logs(call_id, opts = {}) ⇒ LogList

List Call Logs

Parameters:

  • call_id (String) —

    String that uniquely identifies this call resource.

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

    the optional parameters

Returns:



1575
1576
1577
1578
 
# File 'lib/freeclimb/api/default_api.rb', line 1575

def list_call_logs(call_id, opts = {})
  data, _status_code, _headers = list_call_logs_with_http_info(call_id, opts)
  data
end

#list_call_logs_with_http_info(call_id, opts = {}) ⇒ Array<(LogList, Integer, Hash)>

List Call Logs

Parameters:

  • call_id (String) —

    String that uniquely identifies this call resource.

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

    the optional parameters

Returns:

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

    LogList data, response status code and response headers



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
1622
1623
1624
1625
1626
1627
1628
1629
 
# File 'lib/freeclimb/api/default_api.rb', line 1584

def list_call_logs_with_http_info(call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_call_logs ...'
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling DefaultApi.list_call_logs"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Calls/{callId}/Logs'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'LogList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_call_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_call_recordings(call_id, opts = {}) ⇒ RecordingList

List Call Recordings

Parameters:

  • call_id (String) —

    String that uniquely identifies this call resource.

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

    the optional parameters

Options Hash (opts):

  • :date_created (String) —

    Only show recordings created on the specified date, in the form YYYY-MM-DD.

Returns:



1636
1637
1638
1639
 
# File 'lib/freeclimb/api/default_api.rb', line 1636

def list_call_recordings(call_id, opts = {})
  data, _status_code, _headers = list_call_recordings_with_http_info(call_id, opts)
  data
end

#list_call_recordings_with_http_info(call_id, opts = {}) ⇒ Array<(RecordingList, Integer, Hash)>

List Call Recordings

Parameters:

  • call_id (String) —

    String that uniquely identifies this call resource.

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

    the optional parameters

Options Hash (opts):

  • :date_created (String) —

    Only show recordings created on the specified date, in the form YYYY-MM-DD.

Returns:

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

    RecordingList data, response status code and response headers



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
 
# File 'lib/freeclimb/api/default_api.rb', line 1646

def list_call_recordings_with_http_info(call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_call_recordings ...'
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling DefaultApi.list_call_recordings"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Calls/{callId}/Recordings'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dateCreated'] = opts[:'date_created'] if !opts[:'date_created'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'RecordingList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_call_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_calls(opts = {}) ⇒ CallList

List Calls

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :to (String) —

    Only show Calls to this phone number.

  • :from (String) —

    Only show Calls from this phone number.

  • :status (String) —

    Only show Calls currently in this status. May be &#x60;queued&#x60;, &#x60;ringing&#x60;, &#x60;inProgress&#x60;, &#x60;canceled&#x60;, &#x60;completed&#x60;, &#x60;failed&#x60;, &#x60;busy&#x60;, or &#x60;noAnswer&#x60;.

  • :start_time (String) —

    Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss.

  • :end_time (String) —

    Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss.

  • :parent_call_id (String) —

    Only show Calls spawned by the call with this ID.

Returns:



1703
1704
1705
1706
 
# File 'lib/freeclimb/api/default_api.rb', line 1703

def list_calls(opts = {})
  data, _status_code, _headers = list_calls_with_http_info(opts)
  data
end

#list_calls_with_http_info(opts = {}) ⇒ Array<(CallList, Integer, Hash)>

List Calls

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :to (String) —

    Only show Calls to this phone number.

  • :from (String) —

    Only show Calls from this phone number.

  • :status (String) —

    Only show Calls currently in this status. May be &#x60;queued&#x60;, &#x60;ringing&#x60;, &#x60;inProgress&#x60;, &#x60;canceled&#x60;, &#x60;completed&#x60;, &#x60;failed&#x60;, &#x60;busy&#x60;, or &#x60;noAnswer&#x60;.

  • :start_time (String) —

    Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss.

  • :end_time (String) —

    Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss.

  • :parent_call_id (String) —

    Only show Calls spawned by the call with this ID.

Returns:

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

    CallList data, response status code and response headers



1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
 
# File 'lib/freeclimb/api/default_api.rb', line 1717

def list_calls_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_calls ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Calls'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'startTime'] = opts[:'start_time'] if !opts[:'start_time'].nil?
  query_params[:'endTime'] = opts[:'end_time'] if !opts[:'end_time'].nil?
  query_params[:'parentCallId'] = opts[:'parent_call_id'] if !opts[:'parent_call_id'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'CallList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_calls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_conferences(opts = {}) ⇒ ConferenceList

List Conferences

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Only show conferences that currently have the specified status. Valid values: &#x60;empty&#x60;, &#x60;populated&#x60;, &#x60;inProgress&#x60;, or &#x60;terminated&#x60;.

  • :_alias (String) —

    List Conferences whose alias exactly matches this string.

  • :date_created (String) —

    Only show Conferences that were created on the specified date, in the form YYYY-MM-DD.

  • :date_updated (String) —

    Only show Conferences that were last updated on the specified date, in the form YYYY-MM-DD.

Returns:



1773
1774
1775
1776
 
# File 'lib/freeclimb/api/default_api.rb', line 1773

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

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

List Conferences

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Only show conferences that currently have the specified status. Valid values: &#x60;empty&#x60;, &#x60;populated&#x60;, &#x60;inProgress&#x60;, or &#x60;terminated&#x60;.

  • :_alias (String) —

    List Conferences whose alias exactly matches this string.

  • :date_created (String) —

    Only show Conferences that were created on the specified date, in the form YYYY-MM-DD.

  • :date_updated (String) —

    Only show Conferences that were last updated on the specified date, in the form YYYY-MM-DD.

Returns:

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

    ConferenceList data, response status code and response headers



1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
 
# File 'lib/freeclimb/api/default_api.rb', line 1785

def list_conferences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_conferences ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Conferences'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'alias'] = opts[:'_alias'] if !opts[:'_alias'].nil?
  query_params[:'dateCreated'] = opts[:'date_created'] if !opts[:'date_created'].nil?
  query_params[:'dateUpdated'] = opts[:'date_updated'] if !opts[:'date_updated'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'ConferenceList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_conferences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_incoming_numbers(opts = {}) ⇒ IncomingNumberList

List Incoming Numbers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :phone_number (String) —

    Only show incoming phone number resources that match this PCRE-compatible regular expression.

  • :_alias (String) —

    Only show incoming phone numbers with aliases that exactly match this value.

Returns:



1837
1838
1839
1840
 
# File 'lib/freeclimb/api/default_api.rb', line 1837

def list_incoming_numbers(opts = {})
  data, _status_code, _headers = list_incoming_numbers_with_http_info(opts)
  data
end

#list_incoming_numbers_with_http_info(opts = {}) ⇒ Array<(IncomingNumberList, Integer, Hash)>

List Incoming Numbers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :phone_number (String) —

    Only show incoming phone number resources that match this PCRE-compatible regular expression.

  • :_alias (String) —

    Only show incoming phone numbers with aliases that exactly match this value.

Returns:

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

    IncomingNumberList data, response status code and response headers



1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
 
# File 'lib/freeclimb/api/default_api.rb', line 1847

def list_incoming_numbers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_incoming_numbers ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/IncomingPhoneNumbers'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'phoneNumber'] = opts[:'phone_number'] if !opts[:'phone_number'].nil?
  query_params[:'alias'] = opts[:'_alias'] if !opts[:'_alias'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'IncomingNumberList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_incoming_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_members(queue_id, opts = {}) ⇒ QueueMemberList

List Members

Parameters:

  • queue_id (String) —

    String that uniquely identifies the Queue that the Member belongs to.

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

    the optional parameters

Returns:



1896
1897
1898
1899
 
# File 'lib/freeclimb/api/default_api.rb', line 1896

def list_members(queue_id, opts = {})
  data, _status_code, _headers = list_members_with_http_info(queue_id, opts)
  data
end

#list_members_with_http_info(queue_id, opts = {}) ⇒ Array<(QueueMemberList, Integer, Hash)>

List Members

Parameters:

  • queue_id (String) —

    String that uniquely identifies the Queue that the Member belongs to.

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

    the optional parameters

Returns:

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

    QueueMemberList data, response status code and response headers



1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
 
# File 'lib/freeclimb/api/default_api.rb', line 1905

def list_members_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_members ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling DefaultApi.list_members"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Queues/{queueId}/Members'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'queueId' + '}', CGI.escape(queue_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'QueueMemberList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_participants(conference_id, opts = {}) ⇒ ConferenceParticipantList

List Participants

Parameters:

  • conference_id (String) —

    ID of the conference this participant is in.

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

    the optional parameters

Options Hash (opts):

  • :talk (Boolean) —

    Only show Participants with the talk privilege.

  • :listen (Boolean) —

    Only show Participants with the listen privilege.

Returns:



1958
1959
1960
1961
 
# File 'lib/freeclimb/api/default_api.rb', line 1958

def list_participants(conference_id, opts = {})
  data, _status_code, _headers = list_participants_with_http_info(conference_id, opts)
  data
end

#list_participants_with_http_info(conference_id, opts = {}) ⇒ Array<(ConferenceParticipantList, Integer, Hash)>

List Participants

Parameters:

  • conference_id (String) —

    ID of the conference this participant is in.

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

    the optional parameters

Options Hash (opts):

  • :talk (Boolean) —

    Only show Participants with the talk privilege.

  • :listen (Boolean) —

    Only show Participants with the listen privilege.

Returns:

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

    ConferenceParticipantList data, response status code and response headers



1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
 
# File 'lib/freeclimb/api/default_api.rb', line 1969

def list_participants_with_http_info(conference_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_participants ...'
  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 DefaultApi.list_participants"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Conferences/{conferenceId}/Participants'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'talk'] = opts[:'talk'] if !opts[:'talk'].nil?
  query_params[:'listen'] = opts[:'listen'] if !opts[:'listen'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'ConferenceParticipantList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_participants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_recordings(opts = {}) ⇒ RecordingList

List Recordings

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :call_id (String) —

    Show only Recordings made during the Call with this ID.

  • :conference_id (String) —

    Show only Recordings made during the conference with this ID.

  • :date_created (String) —

    Only show Recordings created on this date, formatted as YYYY-MM-DD.

Returns:



2024
2025
2026
2027
 
# File 'lib/freeclimb/api/default_api.rb', line 2024

def list_recordings(opts = {})
  data, _status_code, _headers = list_recordings_with_http_info(opts)
  data
end

#list_recordings_with_http_info(opts = {}) ⇒ Array<(RecordingList, Integer, Hash)>

List Recordings

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :call_id (String) —

    Show only Recordings made during the Call with this ID.

  • :conference_id (String) —

    Show only Recordings made during the conference with this ID.

  • :date_created (String) —

    Only show Recordings created on this date, formatted as YYYY-MM-DD.

Returns:

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

    RecordingList data, response status code and response headers



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
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
 
# File 'lib/freeclimb/api/default_api.rb', line 2035

def list_recordings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_recordings ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Recordings'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'callId'] = opts[:'call_id'] if !opts[:'call_id'].nil?
  query_params[:'conferenceId'] = opts[:'conference_id'] if !opts[:'conference_id'].nil?
  query_params[:'dateCreated'] = opts[:'date_created'] if !opts[:'date_created'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'RecordingList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_sms_messages(opts = {}) ⇒ MessagesList

List SMS Messages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :to (String) —

    Only show Messages to this phone number.

  • :from (String) —

    Only show Messages from this phone number.

  • :begin_time (String) —

    Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*.

  • :end_time (String) —

    Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*..

  • :direction (String) —

    Either &#x60;inbound&#x60; or &#x60;outbound&#x60;. Only show Messages that were either *sent from* or *received by* FreeClimb.

  • :account_id (String) —

    String that uniquely identifies this account resource.

Returns:



2090
2091
2092
2093
 
# File 'lib/freeclimb/api/default_api.rb', line 2090

def list_sms_messages(opts = {})
  data, _status_code, _headers = list_sms_messages_with_http_info(opts)
  data
end

#list_sms_messages_with_http_info(opts = {}) ⇒ Array<(MessagesList, Integer, Hash)>

List SMS Messages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :to (String) —

    Only show Messages to this phone number.

  • :from (String) —

    Only show Messages from this phone number.

  • :begin_time (String) —

    Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*.

  • :end_time (String) —

    Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*..

  • :direction (String) —

    Either &#x60;inbound&#x60; or &#x60;outbound&#x60;. Only show Messages that were either *sent from* or *received by* FreeClimb.

  • :account_id (String) —

    String that uniquely identifies this account resource.

Returns:

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

    MessagesList data, response status code and response headers



2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
 
# File 'lib/freeclimb/api/default_api.rb', line 2104

def list_sms_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_sms_messages ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Messages'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'beginTime'] = opts[:'begin_time'] if !opts[:'begin_time'].nil?
  query_params[:'endTime'] = opts[:'end_time'] if !opts[:'end_time'].nil?
  query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
  query_params[:'accountID'] = opts[:'account_id'] if !opts[:'account_id'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'MessagesList' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#list_sms_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#make_a_call(opts = {}) ⇒ CallResult

Make a Call

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2157
2158
2159
2160
 
# File 'lib/freeclimb/api/default_api.rb', line 2157

def make_a_call(opts = {})
  data, _status_code, _headers = make_a_call_with_http_info(opts)
  data
end

#make_a_call_with_http_info(opts = {}) ⇒ Array<(CallResult, Integer, Hash)>

Make a Call

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CallResult data, response status code and response headers



2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
 
# File 'lib/freeclimb/api/default_api.rb', line 2166

def make_a_call_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.make_a_call ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Calls'.sub('{' + 'accountId' + '}', CGI.escape(@account_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'CallResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#make_a_call\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_a_participant(conference_id, call_id, opts = {}) ⇒ nil

Remove a Participant

Parameters:

  • conference_id (String) —

    ID of the conference this participant is in.

  • call_id (String) —

    ID of the Call associated with this participant.

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

    the optional parameters

Returns:

  • (nil) 


2216
2217
2218
2219
 
# File 'lib/freeclimb/api/default_api.rb', line 2216

def remove_a_participant(conference_id, call_id, opts = {})
  remove_a_participant_with_http_info(conference_id, call_id, opts)
  nil
end

#remove_a_participant_with_http_info(conference_id, call_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove a Participant

Parameters:

  • conference_id (String) —

    ID of the conference this participant is in.

  • call_id (String) —

    ID of the Call associated with this participant.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/freeclimb/api/default_api.rb', line 2226

def remove_a_participant_with_http_info(conference_id, call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.remove_a_participant ...'
  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 DefaultApi.remove_a_participant"
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling DefaultApi.remove_a_participant"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#remove_a_participant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_an_sms_message(opts = {}) ⇒ MessageResult

Send an SMS Message

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2279
2280
2281
2282
 
# File 'lib/freeclimb/api/default_api.rb', line 2279

def send_an_sms_message(opts = {})
  data, _status_code, _headers = send_an_sms_message_with_http_info(opts)
  data
end

#send_an_sms_message_with_http_info(opts = {}) ⇒ Array<(MessageResult, Integer, Hash)>

Send an SMS Message

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    MessageResult data, response status code and response headers



2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
 
# File 'lib/freeclimb/api/default_api.rb', line 2288

def send_an_sms_message_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_an_sms_message ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Messages'.sub('{' + 'accountId' + '}', CGI.escape(@account_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'MessageResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#send_an_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stream_a_recording_file(recording_id, opts = {}) ⇒ File

Stream a Recording File

Parameters:

  • recording_id (String) —

    String that uniquely identifies this recording resource.

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

    the optional parameters

Returns:

  • (File) 


2337
2338
2339
2340
 
# File 'lib/freeclimb/api/default_api.rb', line 2337

def stream_a_recording_file(recording_id, opts = {})
  data, _status_code, _headers = stream_a_recording_file_with_http_info(recording_id, opts)
  data
end

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

Stream a Recording File

Parameters:

  • recording_id (String) —

    String that uniquely identifies this recording resource.

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
 
# File 'lib/freeclimb/api/default_api.rb', line 2346

def stream_a_recording_file_with_http_info(recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.stream_a_recording_file ...'
  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 DefaultApi.stream_a_recording_file"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Recordings/{recordingId}/Stream'.sub('{' + 'accountId' + '}', CGI.escape(@account_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/x-wav'])

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

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

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

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#stream_a_recording_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_a_conference(conference_id, opts = {}) ⇒ ConferenceResult

Update a Conference

Parameters:

  • conference_id (String) —

    String that uniquely identifies this conference resource.

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

    the optional parameters

Options Hash (opts):

Returns:



2398
2399
2400
2401
 
# File 'lib/freeclimb/api/default_api.rb', line 2398

def update_a_conference(conference_id, opts = {})
  data, _status_code, _headers = update_a_conference_with_http_info(conference_id, opts)
  data
end

#update_a_conference_with_http_info(conference_id, opts = {}) ⇒ Array<(ConferenceResult, Integer, Hash)>

Update a Conference

Parameters:

  • conference_id (String) —

    String that uniquely identifies this conference resource.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ConferenceResult data, response status code and response headers



2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
 
# File 'lib/freeclimb/api/default_api.rb', line 2408

def update_a_conference_with_http_info(conference_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_a_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 DefaultApi.update_a_conference"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Conferences/{conferenceId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'ConferenceResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#update_a_conference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_a_live_call(call_id, opts = {}) ⇒ nil

Update a Live Call

Parameters:

  • call_id (String) —

    String that uniquely identifies this call resource.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


2462
2463
2464
2465
 
# File 'lib/freeclimb/api/default_api.rb', line 2462

def update_a_live_call(call_id, opts = {})
  update_a_live_call_with_http_info(call_id, opts)
  nil
end

#update_a_live_call_with_http_info(call_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update a Live Call

Parameters:

  • call_id (String) —

    String that uniquely identifies this call resource.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
 
# File 'lib/freeclimb/api/default_api.rb', line 2472

def update_a_live_call_with_http_info(call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_a_live_call ...'
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling DefaultApi.update_a_live_call"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Calls/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#update_a_live_call\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_a_participant(conference_id, call_id, opts = {}) ⇒ ConferenceParticipantResult

Update a Participant

Parameters:

  • conference_id (String) —

    ID of the conference this participant is in.

  • call_id (String) —

    ID of the Call associated with this participant.

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

    the optional parameters

Options Hash (opts):

Returns:



2525
2526
2527
2528
 
# File 'lib/freeclimb/api/default_api.rb', line 2525

def update_a_participant(conference_id, call_id, opts = {})
  data, _status_code, _headers = update_a_participant_with_http_info(conference_id, call_id, opts)
  data
end

#update_a_participant_with_http_info(conference_id, call_id, opts = {}) ⇒ Array<(ConferenceParticipantResult, Integer, Hash)>

Update a Participant

Parameters:

  • conference_id (String) —

    ID of the conference this participant is in.

  • call_id (String) —

    ID of the Call associated with this participant.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ConferenceParticipantResult data, response status code and response headers



2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
 
# File 'lib/freeclimb/api/default_api.rb', line 2536

def update_a_participant_with_http_info(conference_id, call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_a_participant ...'
  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 DefaultApi.update_a_participant"
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling DefaultApi.update_a_participant"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'ConferenceParticipantResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#update_a_participant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_a_queue(queue_id, opts = {}) ⇒ QueueResult

Update a Queue

Parameters:

  • queue_id (String) —

    A string that uniquely identifies this Queue resource.

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

    the optional parameters

Options Hash (opts):

Returns:



2594
2595
2596
2597
 
# File 'lib/freeclimb/api/default_api.rb', line 2594

def update_a_queue(queue_id, opts = {})
  data, _status_code, _headers = update_a_queue_with_http_info(queue_id, opts)
  data
end

#update_a_queue_with_http_info(queue_id, opts = {}) ⇒ Array<(QueueResult, Integer, Hash)>

Update a Queue

Parameters:

  • queue_id (String) —

    A string that uniquely identifies this Queue resource.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    QueueResult data, response status code and response headers



2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
 
# File 'lib/freeclimb/api/default_api.rb', line 2604

def update_a_queue_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_a_queue ...'
  end
  # verify the required parameter 'queue_id' is set
  if @api_client.config.client_side_validation && queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'queue_id' when calling DefaultApi.update_a_queue"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Queues/{queueId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'queueId' + '}', CGI.escape(queue_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'QueueResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#update_a_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_an_account(opts = {}) ⇒ nil

Manage an account

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


2657
2658
2659
2660
 
# File 'lib/freeclimb/api/default_api.rb', line 2657

def (opts = {})
  (opts)
  nil
end

#update_an_account_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Manage an account

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
 
# File 'lib/freeclimb/api/default_api.rb', line 2666

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_an_account ...'
  end
  # resource path
  local_var_path = '/Accounts/{accountId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#update_an_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_an_application(application_id, opts = {}) ⇒ ApplicationResult

Update an application

Parameters:

  • application_id (String) —

    A string that uniquely identifies this application resource.

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

    the optional parameters

Options Hash (opts):

Returns:



2714
2715
2716
2717
 
# File 'lib/freeclimb/api/default_api.rb', line 2714

def update_an_application(application_id, opts = {})
  data, _status_code, _headers = update_an_application_with_http_info(application_id, opts)
  data
end

#update_an_application_with_http_info(application_id, opts = {}) ⇒ Array<(ApplicationResult, Integer, Hash)>

Update an application

Parameters:

  • application_id (String) —

    A string that uniquely identifies this application resource.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ApplicationResult data, response status code and response headers



2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'lib/freeclimb/api/default_api.rb', line 2724

def update_an_application_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_an_application ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling DefaultApi.update_an_application"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Applications/{applicationId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'applicationId' + '}', CGI.escape(application_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'ApplicationResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#update_an_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_an_incoming_number(phone_number_id, opts = {}) ⇒ IncomingNumberResult

Update an Incoming Number

Parameters:

  • phone_number_id (String) —

    String that uniquely identifies this phone number resource.

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

    the optional parameters

Options Hash (opts):

Returns:



2778
2779
2780
2781
 
# File 'lib/freeclimb/api/default_api.rb', line 2778

def update_an_incoming_number(phone_number_id, opts = {})
  data, _status_code, _headers = update_an_incoming_number_with_http_info(phone_number_id, opts)
  data
end

#update_an_incoming_number_with_http_info(phone_number_id, opts = {}) ⇒ Array<(IncomingNumberResult, Integer, Hash)>

Update an Incoming Number

Parameters:

  • phone_number_id (String) —

    String that uniquely identifies this phone number resource.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IncomingNumberResult data, response status code and response headers



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

def update_an_incoming_number_with_http_info(phone_number_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_an_incoming_number ...'
  end
  # verify the required parameter 'phone_number_id' is set
  if @api_client.config.client_side_validation && phone_number_id.nil?
    fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling DefaultApi.update_an_incoming_number"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s)).sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'IncomingNumberResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['fc']

  new_options = opts.merge(
    :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: DefaultApi#update_an_incoming_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end