Class: PureCloud::ResponseManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/response_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResponseManagementApi

Returns a new instance of ResponseManagementApi.



7
8
9
 
# File 'lib/purecloud/api/response_management_api.rb', line 7

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/response_management_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#delete_libraries_library_id(library_id, opts = {}) ⇒ nil

Delete an existing response library. This will remove any responses associated with the library.

Parameters:

  • library_id —

    Library ID

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

    the optional parameters

Returns:

  • (nil) 


260
261
262
263
 
# File 'lib/purecloud/api/response_management_api.rb', line 260

def delete_libraries_library_id(library_id, opts = {})
  delete_libraries_library_id_with_http_info(library_id, opts)
  return nil
end

#delete_libraries_library_id_with_http_info(library_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an existing response library. This will remove any responses associated with the library.

Parameters:

  • library_id —

    Library ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/purecloud/api/response_management_api.rb', line 270

def delete_libraries_library_id_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi#delete_libraries_library_id ..."
  end
  
  # verify the required parameter 'library_id' is set
  fail "Missing the required parameter 'library_id' when calling delete_libraries_library_id" if library_id.nil?
  
  # resource path
  path = "/api/v2/responsemanagement/libraries/{libraryId}".sub('{format}','json').sub('{' + 'libraryId' + '}', library_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseManagementApi#delete_libraries_library_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_responses_response_id(response_id, opts = {}) ⇒ nil

Delete an existing response. This will remove the response from any libraries associated with it.

Parameters:

  • response_id —

    Response ID

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

    the optional parameters

Returns:

  • (nil) 


628
629
630
631
 
# File 'lib/purecloud/api/response_management_api.rb', line 628

def delete_responses_response_id(response_id, opts = {})
  delete_responses_response_id_with_http_info(response_id, opts)
  return nil
end

#delete_responses_response_id_with_http_info(response_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an existing response. This will remove the response from any libraries associated with it.

Parameters:

  • response_id —

    Response ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/purecloud/api/response_management_api.rb', line 638

def delete_responses_response_id_with_http_info(response_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi#delete_responses_response_id ..."
  end
  
  # verify the required parameter 'response_id' is set
  fail "Missing the required parameter 'response_id' when calling delete_responses_response_id" if response_id.nil?
  
  # resource path
  path = "/api/v2/responsemanagement/responses/{responseId}".sub('{format}','json').sub('{' + 'responseId' + '}', response_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseManagementApi#delete_responses_response_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_libraries(opts = {}) ⇒ LibraryEntityListing

Gets a list of existing response libraries.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:



17
18
19
20
 
# File 'lib/purecloud/api/response_management_api.rb', line 17

def get_libraries(opts = {})
  data, status_code, headers = get_libraries_with_http_info(opts)
  return data
end

#get_libraries_library_id(library_id, opts = {}) ⇒ Library

Get details about an existing response library.

Parameters:

  • library_id —

    Library ID

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

    the optional parameters

Returns:



136
137
138
139
 
# File 'lib/purecloud/api/response_management_api.rb', line 136

def get_libraries_library_id(library_id, opts = {})
  data, status_code, headers = get_libraries_library_id_with_http_info(library_id, opts)
  return data
end

#get_libraries_library_id_with_http_info(library_id, opts = {}) ⇒ Array<(Library, Fixnum, Hash)>

Get details about an existing response library.

Parameters:

  • library_id —

    Library ID

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

    the optional parameters

Returns:

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

    Library data, response status code and response headers



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

def get_libraries_library_id_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi#get_libraries_library_id ..."
  end
  
  # verify the required parameter 'library_id' is set
  fail "Missing the required parameter 'library_id' when calling get_libraries_library_id" if library_id.nil?
  
  # resource path
  path = "/api/v2/responsemanagement/libraries/{libraryId}".sub('{format}','json').sub('{' + 'libraryId' + '}', library_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Library')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseManagementApi#get_libraries_library_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_libraries_with_http_info(opts = {}) ⇒ Array<(LibraryEntityListing, Fixnum, Hash)>

Gets a list of existing response libraries.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:

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

    LibraryEntityListing data, response status code and response headers



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloud/api/response_management_api.rb', line 28

def get_libraries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi#get_libraries ..."
  end
  
  # resource path
  path = "/api/v2/responsemanagement/libraries".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseManagementApi#get_libraries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_responses(library_id, opts = {}) ⇒ ResponseEntityListing

Gets a list of existing responses.

Parameters:

  • library_id —

    Library ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:



322
323
324
325
 
# File 'lib/purecloud/api/response_management_api.rb', line 322

def get_responses(library_id, opts = {})
  data, status_code, headers = get_responses_with_http_info(library_id, opts)
  return data
end

#get_responses_response_id(response_id, opts = {}) ⇒ Response

Get details about an existing response.

Parameters:

  • response_id —

    Response ID

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

    the optional parameters

Returns:



504
505
506
507
 
# File 'lib/purecloud/api/response_management_api.rb', line 504

def get_responses_response_id(response_id, opts = {})
  data, status_code, headers = get_responses_response_id_with_http_info(response_id, opts)
  return data
end

#get_responses_response_id_with_http_info(response_id, opts = {}) ⇒ Array<(Response, Fixnum, Hash)>

Get details about an existing response.

Parameters:

  • response_id —

    Response ID

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

    the optional parameters

Returns:

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

    Response data, response status code and response headers



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/purecloud/api/response_management_api.rb', line 514

def get_responses_response_id_with_http_info(response_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi#get_responses_response_id ..."
  end
  
  # verify the required parameter 'response_id' is set
  fail "Missing the required parameter 'response_id' when calling get_responses_response_id" if response_id.nil?
  
  # resource path
  path = "/api/v2/responsemanagement/responses/{responseId}".sub('{format}','json').sub('{' + 'responseId' + '}', response_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Response')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseManagementApi#get_responses_response_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_responses_with_http_info(library_id, opts = {}) ⇒ Array<(ResponseEntityListing, Fixnum, Hash)>

Gets a list of existing responses.

Parameters:

  • library_id —

    Library ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:

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

    ResponseEntityListing data, response status code and response headers



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/purecloud/api/response_management_api.rb', line 334

def get_responses_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi#get_responses ..."
  end
  
  # verify the required parameter 'library_id' is set
  fail "Missing the required parameter 'library_id' when calling get_responses" if library_id.nil?
  
  # resource path
  path = "/api/v2/responsemanagement/responses".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'libraryId'] = library_id
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseManagementApi#get_responses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_libraries(opts = {}) ⇒ Library

Create a response library.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



78
79
80
81
 
# File 'lib/purecloud/api/response_management_api.rb', line 78

def post_libraries(opts = {})
  data, status_code, headers = post_libraries_with_http_info(opts)
  return data
end

#post_libraries_with_http_info(opts = {}) ⇒ Array<(Library, Fixnum, Hash)>

Create a response library.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Library data, response status code and response headers



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/purecloud/api/response_management_api.rb', line 88

def post_libraries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi#post_libraries ..."
  end
  
  # resource path
  path = "/api/v2/responsemanagement/libraries".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Library')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseManagementApi#post_libraries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_responses(opts = {}) ⇒ Response

Create a response.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



388
389
390
391
 
# File 'lib/purecloud/api/response_management_api.rb', line 388

def post_responses(opts = {})
  data, status_code, headers = post_responses_with_http_info(opts)
  return data
end

#post_responses_query(opts = {}) ⇒ ResponseQueryResults

Query responses

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



446
447
448
449
 
# File 'lib/purecloud/api/response_management_api.rb', line 446

def post_responses_query(opts = {})
  data, status_code, headers = post_responses_query_with_http_info(opts)
  return data
end

#post_responses_query_with_http_info(opts = {}) ⇒ Array<(ResponseQueryResults, Fixnum, Hash)>

Query responses

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ResponseQueryResults data, response status code and response headers



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/purecloud/api/response_management_api.rb', line 456

def post_responses_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi#post_responses_query ..."
  end
  
  # resource path
  path = "/api/v2/responsemanagement/responses/query".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseQueryResults')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseManagementApi#post_responses_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_responses_with_http_info(opts = {}) ⇒ Array<(Response, Fixnum, Hash)>

Create a response.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Response data, response status code and response headers



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/purecloud/api/response_management_api.rb', line 398

def post_responses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi#post_responses ..."
  end
  
  # resource path
  path = "/api/v2/responsemanagement/responses".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Response')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseManagementApi#post_responses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_libraries_library_id(library_id, opts = {}) ⇒ Library

Update an existing response library. Fields that can be updated: name. The most recent version is required for updates.

Parameters:

  • library_id —

    Library ID

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

    the optional parameters

Options Hash (opts):

Returns:



198
199
200
201
 
# File 'lib/purecloud/api/response_management_api.rb', line 198

def put_libraries_library_id(library_id, opts = {})
  data, status_code, headers = put_libraries_library_id_with_http_info(library_id, opts)
  return data
end

#put_libraries_library_id_with_http_info(library_id, opts = {}) ⇒ Array<(Library, Fixnum, Hash)>

Update an existing response library. Fields that can be updated: name. The most recent version is required for updates.

Parameters:

  • library_id —

    Library ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Library data, response status code and response headers



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/purecloud/api/response_management_api.rb', line 209

def put_libraries_library_id_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi#put_libraries_library_id ..."
  end
  
  # verify the required parameter 'library_id' is set
  fail "Missing the required parameter 'library_id' when calling put_libraries_library_id" if library_id.nil?
  
  # resource path
  path = "/api/v2/responsemanagement/libraries/{libraryId}".sub('{format}','json').sub('{' + 'libraryId' + '}', library_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Library')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseManagementApi#put_libraries_library_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_responses_response_id(response_id, opts = {}) ⇒ Response

Update an existing response. Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.

Parameters:

  • response_id —

    Response ID

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

    the optional parameters

Options Hash (opts):

Returns:



566
567
568
569
 
# File 'lib/purecloud/api/response_management_api.rb', line 566

def put_responses_response_id(response_id, opts = {})
  data, status_code, headers = put_responses_response_id_with_http_info(response_id, opts)
  return data
end

#put_responses_response_id_with_http_info(response_id, opts = {}) ⇒ Array<(Response, Fixnum, Hash)>

Update an existing response. Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.

Parameters:

  • response_id —

    Response ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Response data, response status code and response headers



577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/purecloud/api/response_management_api.rb', line 577

def put_responses_response_id_with_http_info(response_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi#put_responses_response_id ..."
  end
  
  # verify the required parameter 'response_id' is set
  fail "Missing the required parameter 'response_id' when calling put_responses_response_id" if response_id.nil?
  
  # resource path
  path = "/api/v2/responsemanagement/responses/{responseId}".sub('{format}','json').sub('{' + 'responseId' + '}', response_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Response')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseManagementApi#put_responses_response_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end