Class: PureCloud::ResponseManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_responsemanagement_library(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) 


32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 32

def delete_responsemanagement_library(library_id, opts = {})
  delete_responsemanagement_library_with_http_info(library_id, opts)
  return nil
end

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



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
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 42

def delete_responsemanagement_library_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi.delete_responsemanagement_library ..."
  end
  # verify the required parameter 'library_id' is set
  fail ArgumentError, "Missing the required parameter 'library_id' when calling ResponseManagementApi.delete_responsemanagement_library" if library_id.nil?
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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, local_var_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_responsemanagement_library\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_responsemanagement_response(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) 


88
89
90
91
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 88

def delete_responsemanagement_response(response_id, opts = {})
  delete_responsemanagement_response_with_http_info(response_id, opts)
  return nil
end

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 98

def delete_responsemanagement_response_with_http_info(response_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi.delete_responsemanagement_response ..."
  end
  # verify the required parameter 'response_id' is set
  fail ArgumentError, "Missing the required parameter 'response_id' when calling ResponseManagementApi.delete_responsemanagement_response" if response_id.nil?
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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, local_var_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_responsemanagement_response\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_responsemanagement_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 (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

Returns:



145
146
147
148
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 145

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

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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 156

def get_responsemanagement_libraries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi.get_responsemanagement_libraries ..."
  end
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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, local_var_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_responsemanagement_libraries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get details about an existing response library.

Parameters:

  • library_id —

    Library ID

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

    the optional parameters

Returns:



203
204
205
206
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 203

def get_responsemanagement_library(library_id, opts = {})
  data, _status_code, _headers = get_responsemanagement_library_with_http_info(library_id, opts)
  return data
end

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



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/purecloudplatformclientv2/api/response_management_api.rb', line 213

def get_responsemanagement_library_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi.get_responsemanagement_library ..."
  end
  # verify the required parameter 'library_id' is set
  fail ArgumentError, "Missing the required parameter 'library_id' when calling ResponseManagementApi.get_responsemanagement_library" if library_id.nil?
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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, local_var_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_responsemanagement_library\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get details about an existing response.

Parameters:

  • response_id —

    Response ID

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the return value.

Returns:



261
262
263
264
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 261

def get_responsemanagement_response(response_id, opts = {})
  data, _status_code, _headers = get_responsemanagement_response_with_http_info(response_id, opts)
  return data
end

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

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the return value.

Returns:

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

    Response data, response status code and response headers



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

def get_responsemanagement_response_with_http_info(response_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi.get_responsemanagement_response ..."
  end
  # verify the required parameter 'response_id' is set
  fail ArgumentError, "Missing the required parameter 'response_id' when calling ResponseManagementApi.get_responsemanagement_response" if response_id.nil?
  if opts[:'expand'] && !['substitutionsSchema'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of substitutionsSchema'
  end
  # resource path
  local_var_path = "/api/v2/responsemanagement/responses/{responseId}".sub('{format}','json').sub('{' + 'responseId' + '}', response_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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, local_var_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_responsemanagement_response\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_responsemanagement_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 (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :expand (String) —

    Expand instructions for the return value.

Returns:



326
327
328
329
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 326

def get_responsemanagement_responses(library_id, opts = {})
  data, _status_code, _headers = get_responsemanagement_responses_with_http_info(library_id, opts)
  return data
end

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

  • :expand (String) —

    Expand instructions for the return value.

Returns:

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

    ResponseEntityListing data, response status code and response headers



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

def get_responsemanagement_responses_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi.get_responsemanagement_responses ..."
  end
  # verify the required parameter 'library_id' is set
  fail ArgumentError, "Missing the required parameter 'library_id' when calling ResponseManagementApi.get_responsemanagement_responses" if library_id.nil?
  if opts[:'expand'] && !['substitutionsSchema'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of substitutionsSchema'
  end
  # resource path
  local_var_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']
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_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, local_var_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_responsemanagement_responses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_responsemanagement_libraries(body, opts = {}) ⇒ Library

Create a response library.

Parameters:

  • body —

    Library

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

    the optional parameters

Returns:



393
394
395
396
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 393

def post_responsemanagement_libraries(body, opts = {})
  data, _status_code, _headers = post_responsemanagement_libraries_with_http_info(body, opts)
  return data
end

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

Create a response library.

Parameters:

  • body —

    Library

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

    the optional parameters

Returns:

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

    Library data, response status code and response headers



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
440
441
442
443
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 403

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_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_responsemanagement_libraries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_responsemanagement_responses(body, opts = {}) ⇒ Response

Create a response.

Parameters:

  • body —

    Response

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the return value.

Returns:



451
452
453
454
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 451

def post_responsemanagement_responses(body, opts = {})
  data, _status_code, _headers = post_responsemanagement_responses_with_http_info(body, opts)
  return data
end

#post_responsemanagement_responses_query(body, opts = {}) ⇒ ResponseQueryResults

Query responses

Parameters:

  • body —

    Response

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

    the optional parameters

Returns:



513
514
515
516
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 513

def post_responsemanagement_responses_query(body, opts = {})
  data, _status_code, _headers = post_responsemanagement_responses_query_with_http_info(body, opts)
  return data
end

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

Query responses

Parameters:

  • body —

    Response

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

    the optional parameters

Returns:

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

    ResponseQueryResults data, response status code and response headers



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 523

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_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_responsemanagement_responses_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create a response.

Parameters:

  • body —

    Response

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the return value.

Returns:

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

    Response data, response status code and response headers



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 462

def post_responsemanagement_responses_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi.post_responsemanagement_responses ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ResponseManagementApi.post_responsemanagement_responses" if body.nil?
  if opts[:'expand'] && !['substitutionsSchema'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of substitutionsSchema'
  end
  # resource path
  local_var_path = "/api/v2/responsemanagement/responses".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_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_responsemanagement_responses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_responsemanagement_library(library_id, body, 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

  • body —

    Library

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

    the optional parameters

Returns:



571
572
573
574
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 571

def put_responsemanagement_library(library_id, body, opts = {})
  data, _status_code, _headers = put_responsemanagement_library_with_http_info(library_id, body, opts)
  return data
end

#put_responsemanagement_library_with_http_info(library_id, body, 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

  • body —

    Library

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

    the optional parameters

Returns:

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

    Library data, response status code and response headers



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

def put_responsemanagement_library_with_http_info(library_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi.put_responsemanagement_library ..."
  end
  # verify the required parameter 'library_id' is set
  fail ArgumentError, "Missing the required parameter 'library_id' when calling ResponseManagementApi.put_responsemanagement_library" if library_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ResponseManagementApi.put_responsemanagement_library" if body.nil?
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_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_responsemanagement_library\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_responsemanagement_response(response_id, body, 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

  • body —

    Response

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the return value.

Returns:



633
634
635
636
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 633

def put_responsemanagement_response(response_id, body, opts = {})
  data, _status_code, _headers = put_responsemanagement_response_with_http_info(response_id, body, opts)
  return data
end

#put_responsemanagement_response_with_http_info(response_id, body, 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

  • body —

    Response

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the return value.

Returns:

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

    Response data, response status code and response headers



645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/purecloudplatformclientv2/api/response_management_api.rb', line 645

def put_responsemanagement_response_with_http_info(response_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ResponseManagementApi.put_responsemanagement_response ..."
  end
  # verify the required parameter 'response_id' is set
  fail ArgumentError, "Missing the required parameter 'response_id' when calling ResponseManagementApi.put_responsemanagement_response" if response_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ResponseManagementApi.put_responsemanagement_response" if body.nil?
  if opts[:'expand'] && !['substitutionsSchema'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of substitutionsSchema'
  end
  # resource path
  local_var_path = "/api/v2/responsemanagement/responses/{responseId}".sub('{format}','json').sub('{' + 'responseId' + '}', response_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_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_responsemanagement_response\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end