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.



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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



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

def 
  @account_id
end

#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(buy_incoming_number_request, opts = {}) ⇒ IncomingNumberResult

Buy a Phone Number

Parameters:

  • buy_incoming_number_request (BuyIncomingNumberRequest) —

    Incoming Number transaction details

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

    the optional parameters

Returns:



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

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

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

Buy a Phone Number

Parameters:

  • buy_incoming_number_request (BuyIncomingNumberRequest) —

    Incoming Number transaction details

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

    the optional parameters

Returns:

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

    IncomingNumberResult data, response status code and response headers



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
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/freeclimb/api/default_api.rb', line 40

def buy_a_phone_number_with_http_info(buy_incoming_number_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.buy_a_phone_number ...'
  end

  # verify the required parameter 'buy_incoming_number_request' is set
  if @api_client.config.client_side_validation && buy_incoming_number_request.nil?
    fail ArgumentError, "Missing the required parameter 'buy_incoming_number_request' when calling DefaultApi.buy_a_phone_number"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/IncomingPhoneNumbers'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.buy_a_phone_number",
    :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:



98
99
100
101
 
# File 'lib/freeclimb/api/default_api.rb', line 98

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/freeclimb/api/default_api.rb', line 107

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(.to_s))

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

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

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

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

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

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

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

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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:



160
161
162
163
 
# File 'lib/freeclimb/api/default_api.rb', line 160

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/freeclimb/api/default_api.rb', line 169

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(.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.create_a_queue",
    :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:



222
223
224
225
 
# File 'lib/freeclimb/api/default_api.rb', line 222

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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/freeclimb/api/default_api.rb', line 231

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(.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.create_an_application",
    :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

#create_knowledge_base_completion(knowledge_base_id, opts = {}) ⇒ CompletionResult

Query the knowledge base

Parameters:

  • knowledge_base_id (String) —

    A string that uniquely identifies the KnowledgeBase resource.

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

    the optional parameters

Options Hash (opts):

Returns:



285
286
287
288
 
# File 'lib/freeclimb/api/default_api.rb', line 285

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

#create_knowledge_base_completion_with_http_info(knowledge_base_id, opts = {}) ⇒ Array<(CompletionResult, Integer, Hash)>

Query the knowledge base

Parameters:

  • knowledge_base_id (String) —

    A string that uniquely identifies the KnowledgeBase resource.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CompletionResult data, response status code and response headers



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/freeclimb/api/default_api.rb', line 295

def create_knowledge_base_completion_with_http_info(knowledge_base_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_knowledge_base_completion ...'
  end

  # verify the required parameter 'knowledge_base_id' is set
  if @api_client.config.client_side_validation && knowledge_base_id.nil?
    fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling DefaultApi.create_knowledge_base_completion"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'knowledgeBaseId' + '}', CGI.escape(knowledge_base_id.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.create_knowledge_base_completion",
    :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_knowledge_base_completion\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) 


353
354
355
356
 
# File 'lib/freeclimb/api/default_api.rb', line 353

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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/freeclimb/api/default_api.rb', line 362

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(.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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

  data, status_code, headers = @api_client.call_api(: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) 


413
414
415
416
 
# File 'lib/freeclimb/api/default_api.rb', line 413

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



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/freeclimb/api/default_api.rb', line 422

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(.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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"DefaultApi.delete_an_application",
    :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) 


473
474
475
476
 
# File 'lib/freeclimb/api/default_api.rb', line 473

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



482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/freeclimb/api/default_api.rb', line 482

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(.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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"DefaultApi.delete_an_incoming_number",
    :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:



534
535
536
537
 
# File 'lib/freeclimb/api/default_api.rb', line 534

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



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
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
 
# File 'lib/freeclimb/api/default_api.rb', line 544

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(.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[:debug_body]

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

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

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

  data, status_code, headers = @api_client.call_api(: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:



602
603
604
605
 
# File 'lib/freeclimb/api/default_api.rb', line 602

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



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
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
 
# File 'lib/freeclimb/api/default_api.rb', line 611

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(.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[:debug_body]

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

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

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

  data, status_code, headers = @api_client.call_api(: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) 


664
665
666
667
 
# File 'lib/freeclimb/api/default_api.rb', line 664

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



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
 
# File 'lib/freeclimb/api/default_api.rb', line 673

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.download_a_recording_file",
    :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(filter_logs_request, opts = {}) ⇒ LogList

Filter Logs

Parameters:

  • filter_logs_request (FilterLogsRequest) —

    Filter logs request paramters

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

    the optional parameters

Returns:



726
727
728
729
 
# File 'lib/freeclimb/api/default_api.rb', line 726

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

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

Filter Logs

Parameters:

  • filter_logs_request (FilterLogsRequest) —

    Filter logs request paramters

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

    the optional parameters

Returns:

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

    LogList data, response status code and response headers



735
736
737
738
739
740
741
742
743
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
 
# File 'lib/freeclimb/api/default_api.rb', line 735

def filter_logs_with_http_info(filter_logs_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.filter_logs ...'
  end

  # verify the required parameter 'filter_logs_request' is set
  if @api_client.config.client_side_validation && filter_logs_request.nil?
    fail ArgumentError, "Missing the required parameter 'filter_logs_request' when calling DefaultApi.filter_logs"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Logs'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.filter_logs",
    :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:



793
794
795
796
 
# File 'lib/freeclimb/api/default_api.rb', line 793

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



802
803
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 802

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.get_a_call",
    :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:



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

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



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

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(.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s))

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

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

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

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

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

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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:



918
919
920
921
 
# File 'lib/freeclimb/api/default_api.rb', line 918

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



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

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(.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[:debug_body]

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

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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:



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

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



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
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/freeclimb/api/default_api.rb', line 997

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.get_a_participant",
    :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:



1055
1056
1057
1058
 
# File 'lib/freeclimb/api/default_api.rb', line 1055

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



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
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'lib/freeclimb/api/default_api.rb', line 1064

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.get_a_queue",
    :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:



1117
1118
1119
1120
 
# File 'lib/freeclimb/api/default_api.rb', line 1117

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



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/freeclimb/api/default_api.rb', line 1126

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(.to_s)).sub('{' + 'recordingId' + '}', CGI.escape(recording_id.to_s))

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

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

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

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

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

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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:



1178
1179
1180
1181
 
# File 'lib/freeclimb/api/default_api.rb', line 1178

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



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
1222
1223
1224
1225
1226
1227
1228
 
# File 'lib/freeclimb/api/default_api.rb', line 1186

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(.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.get_an_account",
    :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:



1234
1235
1236
1237
 
# File 'lib/freeclimb/api/default_api.rb', line 1234

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



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
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File 'lib/freeclimb/api/default_api.rb', line 1243

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.get_an_application",
    :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:



1296
1297
1298
1299
 
# File 'lib/freeclimb/api/default_api.rb', line 1296

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



1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/freeclimb/api/default_api.rb', line 1305

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.get_an_incoming_number",
    :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:



1358
1359
1360
1361
 
# File 'lib/freeclimb/api/default_api.rb', line 1358

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



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
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
 
# File 'lib/freeclimb/api/default_api.rb', line 1367

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.get_an_sms_message",
    :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:



1420
1421
1422
1423
 
# File 'lib/freeclimb/api/default_api.rb', line 1420

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



1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
 
# File 'lib/freeclimb/api/default_api.rb', line 1429

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(.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[:debug_body]

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

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

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

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

#get_next_page(response, opts = {}) ⇒ Object 



3789
3790
3791
3792
 
# File 'lib/freeclimb/api/default_api.rb', line 3789

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

#get_next_page_with_http_info(response, opts = {}) ⇒ Object 



3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
 
# File 'lib/freeclimb/api/default_api.rb', line 3735

def get_next_page_with_http_info(response, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_next_page ...'
  end       
  
  # verify the required parameter 'phone_number_id' is set
  if @api_client.config.client_side_validation && response.nil?
    fail ArgumentError, "Missing the required parameter 'response' when calling DefaultApi.get_next_page"
  end
  # resource path
  local_var_path = response.next_page_uri

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || response.class.name

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

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

#get_ten_dlc_sms_brand(brand_id, opts = {}) ⇒ SMSTenDLCBrand

Get a 10DLC SMS Brand

Parameters:

  • brand_id (String) —

    String that uniquely identifies this brand resource.

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

    the optional parameters

Returns:



1482
1483
1484
1485
 
# File 'lib/freeclimb/api/default_api.rb', line 1482

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

#get_ten_dlc_sms_brand_with_http_info(brand_id, opts = {}) ⇒ Array<(SMSTenDLCBrand, Integer, Hash)>

Get a 10DLC SMS Brand

Parameters:

  • brand_id (String) —

    String that uniquely identifies this brand resource.

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

    the optional parameters

Returns:

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

    SMSTenDLCBrand data, response status code and response headers



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

def get_ten_dlc_sms_brand_with_http_info(brand_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_ten_dlc_sms_brand ...'
  end

  # verify the required parameter 'brand_id' is set
  if @api_client.config.client_side_validation && brand_id.nil?
    fail ArgumentError, "Missing the required parameter 'brand_id' when calling DefaultApi.get_ten_dlc_sms_brand"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Messages/10DLC/Brands/{brandId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'brandId' + '}', CGI.escape(brand_id.to_s))

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

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

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

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

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

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

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

#get_ten_dlc_sms_brands(opts = {}) ⇒ SMSTenDLCBrandsListResult

Get list of SMS 10DLC Brands

Parameters:

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

    the optional parameters

Returns:



1543
1544
1545
1546
 
# File 'lib/freeclimb/api/default_api.rb', line 1543

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

#get_ten_dlc_sms_brands_with_http_info(opts = {}) ⇒ Array<(SMSTenDLCBrandsListResult, Integer, Hash)>

Get list of SMS 10DLC Brands

Parameters:

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

    the optional parameters

Returns:

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

    SMSTenDLCBrandsListResult data, response status code and response headers



1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
 
# File 'lib/freeclimb/api/default_api.rb', line 1551

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

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

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

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

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

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

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

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

#get_ten_dlc_sms_campaign(campaign_id, opts = {}) ⇒ SMSTenDLCCampaign

Get a 10DLC SMS Campaign

Parameters:

  • campaign_id (String) —

    String that uniquely identifies this campaign resource.

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

    the optional parameters

Returns:



1599
1600
1601
1602
 
# File 'lib/freeclimb/api/default_api.rb', line 1599

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

#get_ten_dlc_sms_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(SMSTenDLCCampaign, Integer, Hash)>

Get a 10DLC SMS Campaign

Parameters:

  • campaign_id (String) —

    String that uniquely identifies this campaign resource.

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

    the optional parameters

Returns:

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

    SMSTenDLCCampaign data, response status code and response headers



1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
 
# File 'lib/freeclimb/api/default_api.rb', line 1608

def get_ten_dlc_sms_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_ten_dlc_sms_campaign ...'
  end

  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling DefaultApi.get_ten_dlc_sms_campaign"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

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

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

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

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

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

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

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

#get_ten_dlc_sms_campaigns(opts = {}) ⇒ SMSTenDLCCampaignsListResult

Get list of SMS 10DLC Campaigns

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :brand_id (String) —

    The unique identifier for a brand

Returns:



1661
1662
1663
1664
 
# File 'lib/freeclimb/api/default_api.rb', line 1661

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

#get_ten_dlc_sms_campaigns_with_http_info(opts = {}) ⇒ Array<(SMSTenDLCCampaignsListResult, Integer, Hash)>

Get list of SMS 10DLC Campaigns

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :brand_id (String) —

    The unique identifier for a brand

Returns:



1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
 
# File 'lib/freeclimb/api/default_api.rb', line 1670

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'brandId'] = opts[:'brand_id'] if !opts[:'brand_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[:debug_body]

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

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

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

#get_ten_dlc_sms_partner_campaign(campaign_id, opts = {}) ⇒ SMSTenDLCPartnerCampaign

Get a 10DLC SMS Partner Campaign

Parameters:

  • campaign_id (String) —

    String that uniquely identifies this campaign resource.

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

    the optional parameters

Returns:



1719
1720
1721
1722
 
# File 'lib/freeclimb/api/default_api.rb', line 1719

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

#get_ten_dlc_sms_partner_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(SMSTenDLCPartnerCampaign, Integer, Hash)>

Get a 10DLC SMS Partner Campaign

Parameters:

  • campaign_id (String) —

    String that uniquely identifies this campaign resource.

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

    the optional parameters

Returns:

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

    SMSTenDLCPartnerCampaign data, response status code and response headers



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/freeclimb/api/default_api.rb', line 1728

def get_ten_dlc_sms_partner_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_ten_dlc_sms_partner_campaign ...'
  end

  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling DefaultApi.get_ten_dlc_sms_partner_campaign"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

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

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

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

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

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

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

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

#get_ten_dlc_sms_partner_campaigns(opts = {}) ⇒ SMSTenDLCPartnerCampaignsListResult

Get list of SMS 10DLC Partner Campaigns

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :brand_id (String) —

    The unique identifier for a brand

Returns:



1781
1782
1783
1784
 
# File 'lib/freeclimb/api/default_api.rb', line 1781

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

#get_ten_dlc_sms_partner_campaigns_with_http_info(opts = {}) ⇒ Array<(SMSTenDLCPartnerCampaignsListResult, Integer, Hash)>

Get list of SMS 10DLC Partner Campaigns

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :brand_id (String) —

    The unique identifier for a brand

Returns:



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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'brandId'] = opts[:'brand_id'] if !opts[:'brand_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[:debug_body]

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

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

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

#get_toll_free_sms_campaign(campaign_id, opts = {}) ⇒ SMSTollFreeCampaign

Get a TollFree SMS Campaign

Parameters:

  • campaign_id (String) —

    String that uniquely identifies this TollFree Campaign resource.

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

    the optional parameters

Returns:



1839
1840
1841
1842
 
# File 'lib/freeclimb/api/default_api.rb', line 1839

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

#get_toll_free_sms_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(SMSTollFreeCampaign, Integer, Hash)>

Get a TollFree SMS Campaign

Parameters:

  • campaign_id (String) —

    String that uniquely identifies this TollFree Campaign resource.

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

    the optional parameters

Returns:

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

    SMSTollFreeCampaign data, response status code and response headers



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
1891
1892
1893
1894
1895
 
# File 'lib/freeclimb/api/default_api.rb', line 1848

def get_toll_free_sms_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_toll_free_sms_campaign ...'
  end

  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling DefaultApi.get_toll_free_sms_campaign"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Messages/TollFree/Campaigns/{campaignId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))

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

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

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

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

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

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

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

#get_toll_free_sms_campaigns(opts = {}) ⇒ SMSTollFreeCampaignsListResult

Get list of TollFree Campaigns

Parameters:

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

    the optional parameters

Returns:



1900
1901
1902
1903
 
# File 'lib/freeclimb/api/default_api.rb', line 1900

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

#get_toll_free_sms_campaigns_with_http_info(opts = {}) ⇒ Array<(SMSTollFreeCampaignsListResult, Integer, Hash)>

Get list of TollFree Campaigns

Parameters:

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

    the optional parameters

Returns:



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 1908

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

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.get_toll_free_sms_campaigns",
    :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_toll_free_sms_campaigns\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:



1956
1957
1958
1959
 
# File 'lib/freeclimb/api/default_api.rb', line 1956

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



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

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.list_active_queues",
    :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:



2013
2014
2015
2016
 
# File 'lib/freeclimb/api/default_api.rb', line 2013

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



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

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(.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.list_all_account_logs",
    :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_applications(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:



2069
2070
2071
2072
 
# File 'lib/freeclimb/api/default_api.rb', line 2069

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

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



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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.list_applications",
    :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_applications\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):

  • :phone_number (String) —

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

  • :region (String) —

    State or province of this phone number.

  • :country (String) —

    Country of this phone number.

  • :voice_enabled (Boolean) —

    Indicates whether the phone number can handle Calls. Typically set to true for all numbers. (default to true)

  • :sms_enabled (Boolean) —

    Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. (default to true)

  • :capabilities_voice (Boolean)
  • :capabilities_sms (Boolean)
  • :capabilities_toll_free (Boolean)
  • :capabilities_ten_dlc (Boolean)
  • :capabilities_short_code (Boolean)

Returns:



2136
2137
2138
2139
 
# File 'lib/freeclimb/api/default_api.rb', line 2136

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

  • :phone_number (String) —

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

  • :region (String) —

    State or province of this phone number.

  • :country (String) —

    Country of this phone number.

  • :voice_enabled (Boolean) —

    Indicates whether the phone number can handle Calls. Typically set to true for all numbers.

  • :sms_enabled (Boolean) —

    Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.

  • :capabilities_voice (Boolean)
  • :capabilities_sms (Boolean)
  • :capabilities_toll_free (Boolean)
  • :capabilities_ten_dlc (Boolean)
  • :capabilities_short_code (Boolean)

Returns:

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

    AvailableNumberList data, response status code and response headers



2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
 
# File 'lib/freeclimb/api/default_api.rb', line 2154

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[:'phoneNumber'] = opts[:'phone_number'] if !opts[:'phone_number'].nil?
  query_params[:'region'] = opts[:'region'] if !opts[:'region'].nil?
  query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
  query_params[:'voiceEnabled'] = opts[:'voice_enabled'] if !opts[:'voice_enabled'].nil?
  query_params[:'smsEnabled'] = opts[:'sms_enabled'] if !opts[:'sms_enabled'].nil?
  query_params[:'capabilities.voice'] = opts[:'capabilities_voice'] if !opts[:'capabilities_voice'].nil?
  query_params[:'capabilities.sms'] = opts[:'capabilities_sms'] if !opts[:'capabilities_sms'].nil?
  query_params[:'capabilities.tollFree'] = opts[:'capabilities_toll_free'] if !opts[:'capabilities_toll_free'].nil?
  query_params[:'capabilities.tenDLC'] = opts[:'capabilities_ten_dlc'] if !opts[:'capabilities_ten_dlc'].nil?
  query_params[:'capabilities.shortCode'] = opts[:'capabilities_short_code'] if !opts[:'capabilities_short_code'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.list_available_numbers",
    :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:



2212
2213
2214
2215
 
# File 'lib/freeclimb/api/default_api.rb', line 2212

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



2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
 
# File 'lib/freeclimb/api/default_api.rb', line 2221

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.list_call_logs",
    :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:



2275
2276
2277
2278
 
# File 'lib/freeclimb/api/default_api.rb', line 2275

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



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

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(.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[:debug_body]

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

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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):

  • :active (Boolean) —

    If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. (default to false)

  • :to (String) —

    Only show Calls to this phone number.

  • :from (String) —

    Only show Calls from this phone number.

  • :status (CallStatus) —

    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.

  • :application_id (Array<String>) —

    Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.

Returns:



2346
2347
2348
2349
 
# File 'lib/freeclimb/api/default_api.rb', line 2346

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

  • :active (Boolean) —

    If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query.

  • :to (String) —

    Only show Calls to this phone number.

  • :from (String) —

    Only show Calls from this phone number.

  • :status (CallStatus) —

    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.

  • :application_id (Array<String>) —

    Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.

Returns:

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

    CallList data, response status code and response headers



2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
 
# File 'lib/freeclimb/api/default_api.rb', line 2362

def list_calls_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_calls ...'
  end
  if @api_client.config.client_side_validation && !opts[:'application_id'].nil? && opts[:'application_id'].length > 16
    fail ArgumentError, 'invalid value for "opts[:"application_id"]" when calling DefaultApi.list_calls, number of items must be less than or equal to 16.'
  end

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'active'] = opts[:'active'] if !opts[:'active'].nil?
  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?
  query_params[:'applicationId'] = @api_client.build_collection_param(opts[:'application_id'], :multi) if !opts[:'application_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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.list_calls",
    :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_conference_recordings(conference_id, opts = {}) ⇒ RecordingList

List Conference Recordings

Parameters:

  • conference_id (String) —

    Show only Recordings made during the conference with this ID.

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

    the optional parameters

Options Hash (opts):

  • :call_id (String) —

    Show only Recordings made during the Call with this ID.

  • :date_created (String) —

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

Returns:



2424
2425
2426
2427
 
# File 'lib/freeclimb/api/default_api.rb', line 2424

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

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

List Conference Recordings

Parameters:

  • conference_id (String) —

    Show only Recordings made during the conference with this ID.

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

    the optional parameters

Options Hash (opts):

  • :call_id (String) —

    Show only Recordings made during the Call 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



2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
 
# File 'lib/freeclimb/api/default_api.rb', line 2435

def list_conference_recordings_with_http_info(conference_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.list_conference_recordings ...'
  end

  # verify the required parameter 'conference_id' is set
  if @api_client.config.client_side_validation && conference_id.nil?
    fail ArgumentError, "Missing the required parameter 'conference_id' when calling DefaultApi.list_conference_recordings"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Conferences/{conferenceId}/Recordings'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'conferenceId' + '}', CGI.escape(conference_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'callId'] = opts[:'call_id'] if !opts[:'call_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[:debug_body]

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

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#list_conference_recordings\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:



2493
2494
2495
2496
 
# File 'lib/freeclimb/api/default_api.rb', line 2493

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



2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
 
# File 'lib/freeclimb/api/default_api.rb', line 2505

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(.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[:debug_body]

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

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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.

  • :region (String) —

    State or province of this phone number.

  • :country (String) —

    Country of this phone number.

  • :application_id (String) —

    ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.

  • :has_application (Boolean) —

    Indication of whether the phone number has an application linked to it. (default to false)

  • :voice_enabled (Boolean) —

    Indicates whether the phone number can handle Calls. Typically set to true for all numbers. (default to true)

  • :sms_enabled (Boolean) —

    Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. (default to true)

  • :has_campaign (Boolean) —

    Indication of whether the phone number has a campaign associated with it

  • :capabilities_voice (Boolean)
  • :capabilities_sms (Boolean)
  • :capabilities_toll_free (Boolean)
  • :capabilities_ten_dlc (Boolean)
  • :capabilities_short_code (Boolean)
  • :tfn_campaign_id (String) —

    Only show incoming phone number resources that have been assigned to the provided TFNCampaign ID.

  • :offnet (Boolean) —

    Indication of whether the phone number was registered as an offnet number. This field will be rendered only for requests to the IncomingPhone number resource.

Returns:



2572
2573
2574
2575
 
# File 'lib/freeclimb/api/default_api.rb', line 2572

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.

  • :region (String) —

    State or province of this phone number.

  • :country (String) —

    Country of this phone number.

  • :application_id (String) —

    ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.

  • :has_application (Boolean) —

    Indication of whether the phone number has an application linked to it.

  • :voice_enabled (Boolean) —

    Indicates whether the phone number can handle Calls. Typically set to true for all numbers.

  • :sms_enabled (Boolean) —

    Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.

  • :has_campaign (Boolean) —

    Indication of whether the phone number has a campaign associated with it

  • :capabilities_voice (Boolean)
  • :capabilities_sms (Boolean)
  • :capabilities_toll_free (Boolean)
  • :capabilities_ten_dlc (Boolean)
  • :capabilities_short_code (Boolean)
  • :tfn_campaign_id (String) —

    Only show incoming phone number resources that have been assigned to the provided TFNCampaign ID.

  • :offnet (Boolean) —

    Indication of whether the phone number was registered as an offnet number. This field will be rendered only for requests to the IncomingPhone number resource.

Returns:

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

    IncomingNumberList data, response status code and response headers



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

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(.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?
  query_params[:'region'] = opts[:'region'] if !opts[:'region'].nil?
  query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
  query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
  query_params[:'hasApplication'] = opts[:'has_application'] if !opts[:'has_application'].nil?
  query_params[:'voiceEnabled'] = opts[:'voice_enabled'] if !opts[:'voice_enabled'].nil?
  query_params[:'smsEnabled'] = opts[:'sms_enabled'] if !opts[:'sms_enabled'].nil?
  query_params[:'hasCampaign'] = opts[:'has_campaign'] if !opts[:'has_campaign'].nil?
  query_params[:'capabilities.voice'] = opts[:'capabilities_voice'] if !opts[:'capabilities_voice'].nil?
  query_params[:'capabilities.sms'] = opts[:'capabilities_sms'] if !opts[:'capabilities_sms'].nil?
  query_params[:'capabilities.tollFree'] = opts[:'capabilities_toll_free'] if !opts[:'capabilities_toll_free'].nil?
  query_params[:'capabilities.tenDLC'] = opts[:'capabilities_ten_dlc'] if !opts[:'capabilities_ten_dlc'].nil?
  query_params[:'capabilities.shortCode'] = opts[:'capabilities_short_code'] if !opts[:'capabilities_short_code'].nil?
  query_params[:'tfn.campaignId'] = opts[:'tfn_campaign_id'] if !opts[:'tfn_campaign_id'].nil?
  query_params[:'offnet'] = opts[:'offnet'] if !opts[:'offnet'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.list_incoming_numbers",
    :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:



2660
2661
2662
2663
 
# File 'lib/freeclimb/api/default_api.rb', line 2660

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



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
2708
2709
2710
2711
2712
2713
2714
2715
2716
 
# File 'lib/freeclimb/api/default_api.rb', line 2669

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.list_members",
    :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:



2724
2725
2726
2727
 
# File 'lib/freeclimb/api/default_api.rb', line 2724

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



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
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
 
# File 'lib/freeclimb/api/default_api.rb', line 2735

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.list_participants",
    :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:



2792
2793
2794
2795
 
# File 'lib/freeclimb/api/default_api.rb', line 2792

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



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
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
 
# File 'lib/freeclimb/api/default_api.rb', line 2803

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(.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[:debug_body]

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

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 (MessageDirection) —

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

  • :campaign_id (String) —

    Only show messages associated with this campaign ID.

  • :brand_id (String) —

    Only show messages associated with this brand ID

  • :is10_dlc (Boolean) —

    Only show messages that were sent as part of a 10DLC campaign.

Returns:



2861
2862
2863
2864
 
# File 'lib/freeclimb/api/default_api.rb', line 2861

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 (MessageDirection) —

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

  • :campaign_id (String) —

    Only show messages associated with this campaign ID.

  • :brand_id (String) —

    Only show messages associated with this brand ID

  • :is10_dlc (Boolean) —

    Only show messages that were sent as part of a 10DLC campaign.

Returns:

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

    MessagesList data, response status code and response headers



2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
 
# File 'lib/freeclimb/api/default_api.rb', line 2877

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(.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[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
  query_params[:'brandId'] = opts[:'brand_id'] if !opts[:'brand_id'].nil?
  query_params[:'is10DLC'] = opts[:'is10_dlc'] if !opts[:'is10_dlc'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.list_sms_messages",
    :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:



2933
2934
2935
2936
 
# File 'lib/freeclimb/api/default_api.rb', line 2933

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



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

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(.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.make_a_call",
    :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

#make_a_webrtc_jwt(create_web_rtc_token, opts = {}) ⇒ String

Make a JWT for WebRTC calling

Parameters:

  • create_web_rtc_token (CreateWebRTCToken) —

    Information needed to craft a JWT compatible with the platforms WebRTC APIs

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

    the optional parameters

Returns:

  • (String) 


2995
2996
2997
2998
 
# File 'lib/freeclimb/api/default_api.rb', line 2995

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

#make_a_webrtc_jwt_with_http_info(create_web_rtc_token, opts = {}) ⇒ Array<(String, Integer, Hash)>

Make a JWT for WebRTC calling

Parameters:

  • create_web_rtc_token (CreateWebRTCToken) —

    Information needed to craft a JWT compatible with the platforms WebRTC APIs

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
 
# File 'lib/freeclimb/api/default_api.rb', line 3004

def make_a_webrtc_jwt_with_http_info(create_web_rtc_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.make_a_webrtc_jwt ...'
  end

  # verify the required parameter 'create_web_rtc_token' is set
  if @api_client.config.client_side_validation && create_web_rtc_token.nil?
    fail ArgumentError, "Missing the required parameter 'create_web_rtc_token' when calling DefaultApi.make_a_webrtc_jwt"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Calls/WebRTC/Token'.sub('{' + 'accountId' + '}', CGI.escape(.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(['text/plain'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.make_a_webrtc_jwt",
    :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_webrtc_jwt\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) 


3063
3064
3065
3066
 
# File 'lib/freeclimb/api/default_api.rb', line 3063

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



3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
 
# File 'lib/freeclimb/api/default_api.rb', line 3073

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(.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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"DefaultApi.remove_a_participant",
    :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(message_request, opts = {}) ⇒ MessageResult

Send an SMS Message

Parameters:

  • message_request (MessageRequest) —

    Details to create a message

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

    the optional parameters

Returns:



3129
3130
3131
3132
 
# File 'lib/freeclimb/api/default_api.rb', line 3129

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

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

Send an SMS Message

Parameters:

  • message_request (MessageRequest) —

    Details to create a message

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

    the optional parameters

Returns:

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

    MessageResult data, response status code and response headers



3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
 
# File 'lib/freeclimb/api/default_api.rb', line 3138

def send_an_sms_message_with_http_info(message_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_an_sms_message ...'
  end

  # verify the required parameter 'message_request' is set
  if @api_client.config.client_side_validation && message_request.nil?
    fail ArgumentError, "Missing the required parameter 'message_request' when calling DefaultApi.send_an_sms_message"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Messages'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.send_an_sms_message",
    :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) 


3196
3197
3198
3199
 
# File 'lib/freeclimb/api/default_api.rb', line 3196

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



3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
 
# File 'lib/freeclimb/api/default_api.rb', line 3205

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(.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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.stream_a_recording_file",
    :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 = {}) ⇒ nil

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:

  • (nil) 


3259
3260
3261
3262
 
# File 'lib/freeclimb/api/default_api.rb', line 3259

def update_a_conference(conference_id, opts = {})
  update_a_conference_with_http_info(conference_id, opts)
  nil
end

#update_a_conference_with_http_info(conference_id, opts = {}) ⇒ Array<(nil, 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<(nil, Integer, Hash)>) —

    nil, response status code and response headers



3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
 
# File 'lib/freeclimb/api/default_api.rb', line 3269

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(.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 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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, update_call_request, opts = {}) ⇒ nil

Update a Live Call

Parameters:

  • call_id (String) —

    String that uniquely identifies this call resource.

  • update_call_request (UpdateCallRequest) —

    Call details to update

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

    the optional parameters

Returns:

  • (nil) 


3326
3327
3328
3329
 
# File 'lib/freeclimb/api/default_api.rb', line 3326

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

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

Update a Live Call

Parameters:

  • call_id (String) —

    String that uniquely identifies this call resource.

  • update_call_request (UpdateCallRequest) —

    Call details to update

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
 
# File 'lib/freeclimb/api/default_api.rb', line 3336

def update_a_live_call_with_http_info(call_id, update_call_request, 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

  # verify the required parameter 'update_call_request' is set
  if @api_client.config.client_side_validation && update_call_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_call_request' when calling DefaultApi.update_a_live_call"
  end
  # resource path
  local_var_path = '/Accounts/{accountId}/Calls/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"DefaultApi.update_a_live_call",
    :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:



3399
3400
3401
3402
 
# File 'lib/freeclimb/api/default_api.rb', line 3399

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



3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
 
# File 'lib/freeclimb/api/default_api.rb', line 3410

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(.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.update_a_participant",
    :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:



3474
3475
3476
3477
 
# File 'lib/freeclimb/api/default_api.rb', line 3474

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



3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
 
# File 'lib/freeclimb/api/default_api.rb', line 3484

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(.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.update_a_queue",
    :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) 


3542
3543
3544
3545
 
# File 'lib/freeclimb/api/default_api.rb', line 3542

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



3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
 
# File 'lib/freeclimb/api/default_api.rb', line 3551

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(.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"DefaultApi.update_an_account",
    :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:



3603
3604
3605
3606
 
# File 'lib/freeclimb/api/default_api.rb', line 3603

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



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

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(.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.update_an_application",
    :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:



3672
3673
3674
3675
 
# File 'lib/freeclimb/api/default_api.rb', line 3672

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



3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
 
# File 'lib/freeclimb/api/default_api.rb', line 3682

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(.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

  new_options = opts.merge(
    :operation => :"DefaultApi.update_an_incoming_number",
    :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