Class: PureCloud::VoicemailApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/voicemail_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VoicemailApi

Returns a new instance of VoicemailApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/voicemail_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/voicemail_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_voicemail_message(message_id, opts = {}) ⇒ String

Delete a message.

Parameters:

  • message_id —

    Message ID

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

    the optional parameters

Returns:

  • (String) 


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

def delete_voicemail_message(message_id, opts = {})
  data, _status_code, _headers = delete_voicemail_message_with_http_info(message_id, opts)
  return data
end

#delete_voicemail_message_with_http_info(message_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a message.

Parameters:

  • message_id —

    Message ID

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

    the optional parameters

Returns:

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

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

def delete_voicemail_message_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.delete_voicemail_message ..."
  end
  # verify the required parameter 'message_id' is set
  fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.delete_voicemail_message" if message_id.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#delete_voicemail_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_voicemail_messages(opts = {}) ⇒ String

Delete all voicemail messages

Parameters:

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

    the optional parameters

Returns:

  • (String) 


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

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

#delete_voicemail_messages_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete all voicemail messages

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def delete_voicemail_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.delete_voicemail_messages ..."
  end
  # resource path
  local_var_path = "/api/v2/voicemail/messages".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 = 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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#delete_voicemail_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_group_mailbox(group_id, opts = {}) ⇒ VoicemailMailboxInfo

Get the group’s mailbox information

Parameters:

  • group_id —

    groupId

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

    the optional parameters

Returns:



142
143
144
145
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 142

def get_voicemail_group_mailbox(group_id, opts = {})
  data, _status_code, _headers = get_voicemail_group_mailbox_with_http_info(group_id, opts)
  return data
end

#get_voicemail_group_mailbox_with_http_info(group_id, opts = {}) ⇒ Array<(VoicemailMailboxInfo, Fixnum, Hash)>

Get the group&#39;s mailbox information

Parameters:

  • group_id —

    groupId

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

    the optional parameters

Returns:

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

    VoicemailMailboxInfo data, response status code and response headers



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

def get_voicemail_group_mailbox_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_group_mailbox ..."
  end
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.get_voicemail_group_mailbox" if group_id.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/groups/{groupId}/mailbox".sub('{format}','json').sub('{' + 'groupId' + '}', group_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 => 'VoicemailMailboxInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_group_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_group_messages(group_id, opts = {}) ⇒ VoicemailMessageEntityListing

List voicemail messages

Parameters:

  • group_id —

    Group ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



201
202
203
204
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 201

def get_voicemail_group_messages(group_id, opts = {})
  data, _status_code, _headers = get_voicemail_group_messages_with_http_info(group_id, opts)
  return data
end

#get_voicemail_group_messages_with_http_info(group_id, opts = {}) ⇒ Array<(VoicemailMessageEntityListing, Fixnum, Hash)>

List voicemail messages

Parameters:

  • group_id —

    Group ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



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
254
255
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 213

def get_voicemail_group_messages_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_group_messages ..."
  end
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.get_voicemail_group_messages" if group_id.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/groups/{groupId}/messages".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

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

  # 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 => 'VoicemailMessageEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_group_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_group_policy(group_id, opts = {}) ⇒ VoicemailGroupPolicy

Get a group’s voicemail policy

Parameters:

  • group_id —

    Group ID

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

    the optional parameters

Returns:



262
263
264
265
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 262

def get_voicemail_group_policy(group_id, opts = {})
  data, _status_code, _headers = get_voicemail_group_policy_with_http_info(group_id, opts)
  return data
end

#get_voicemail_group_policy_with_http_info(group_id, opts = {}) ⇒ Array<(VoicemailGroupPolicy, Fixnum, Hash)>

Get a group&#39;s voicemail policy

Parameters:

  • group_id —

    Group ID

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

    the optional parameters

Returns:

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

    VoicemailGroupPolicy 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
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 272

def get_voicemail_group_policy_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_group_policy ..."
  end
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.get_voicemail_group_policy" if group_id.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/groups/{groupId}/policy".sub('{format}','json').sub('{' + 'groupId' + '}', group_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 => 'VoicemailGroupPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_group_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_mailbox(opts = {}) ⇒ VoicemailMailboxInfo

Get the current user’s mailbox information

Parameters:

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

    the optional parameters

Returns:



318
319
320
321
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 318

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

#get_voicemail_mailbox_with_http_info(opts = {}) ⇒ Array<(VoicemailMailboxInfo, Fixnum, Hash)>

Get the current user&#39;s mailbox information

Parameters:

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

    the optional parameters

Returns:

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

    VoicemailMailboxInfo data, response status code and response headers



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 327

def get_voicemail_mailbox_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_mailbox ..."
  end
  # resource path
  local_var_path = "/api/v2/voicemail/mailbox".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 = 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 => 'VoicemailMailboxInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_me_mailbox(opts = {}) ⇒ VoicemailMailboxInfo

Get the current user’s mailbox information

Parameters:

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

    the optional parameters

Returns:



371
372
373
374
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 371

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

#get_voicemail_me_mailbox_with_http_info(opts = {}) ⇒ Array<(VoicemailMailboxInfo, Fixnum, Hash)>

Get the current user&#39;s mailbox information

Parameters:

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

    the optional parameters

Returns:

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

    VoicemailMailboxInfo data, response status code and response headers



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
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 380

def get_voicemail_me_mailbox_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_me_mailbox ..."
  end
  # resource path
  local_var_path = "/api/v2/voicemail/me/mailbox".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 = 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 => 'VoicemailMailboxInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_me_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_me_messages(opts = {}) ⇒ VoicemailMessageEntityListing

List voicemail messages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



426
427
428
429
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 426

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

#get_voicemail_me_messages_with_http_info(opts = {}) ⇒ Array<(VoicemailMessageEntityListing, Fixnum, Hash)>

List voicemail messages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 437

def get_voicemail_me_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_me_messages ..."
  end
  # resource path
  local_var_path = "/api/v2/voicemail/me/messages".sub('{format}','json')

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

  # 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 => 'VoicemailMessageEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_me_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_me_policy(opts = {}) ⇒ VoicemailUserPolicy

Get the current user’s voicemail policy

Parameters:

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

    the optional parameters

Returns:



483
484
485
486
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 483

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

#get_voicemail_me_policy_with_http_info(opts = {}) ⇒ Array<(VoicemailUserPolicy, Fixnum, Hash)>

Get the current user&#39;s voicemail policy

Parameters:

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

    the optional parameters

Returns:

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

    VoicemailUserPolicy data, response status code and response headers



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 492

def get_voicemail_me_policy_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_me_policy ..."
  end
  # resource path
  local_var_path = "/api/v2/voicemail/me/policy".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 = 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 => 'VoicemailUserPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_me_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_message(message_id, opts = {}) ⇒ VoicemailMessage

Get message.

Parameters:

  • message_id —

    Message ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    If the caller is a known user, which fields, if any, to expand

Returns:



538
539
540
541
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 538

def get_voicemail_message(message_id, opts = {})
  data, _status_code, _headers = get_voicemail_message_with_http_info(message_id, opts)
  return data
end

#get_voicemail_message_media(message_id, opts = {}) ⇒ VoicemailMediaInfo

Get media playback URI for this message

Parameters:

  • message_id —

    Message ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format. (default to WEBM)

Returns:



598
599
600
601
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 598

def get_voicemail_message_media(message_id, opts = {})
  data, _status_code, _headers = get_voicemail_message_media_with_http_info(message_id, opts)
  return data
end

#get_voicemail_message_media_with_http_info(message_id, opts = {}) ⇒ Array<(VoicemailMediaInfo, Fixnum, Hash)>

Get media playback URI for this message

Parameters:

  • message_id —

    Message ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format.

Returns:

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

    VoicemailMediaInfo data, response status code and response headers



609
610
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
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 609

def get_voicemail_message_media_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_message_media ..."
  end
  # verify the required parameter 'message_id' is set
  fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.get_voicemail_message_media" if message_id.nil?
  if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
    fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE'
  end
  # resource path
  local_var_path = "/api/v2/voicemail/messages/{messageId}/media".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)

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

  # 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 => 'VoicemailMediaInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_message_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_message_with_http_info(message_id, opts = {}) ⇒ Array<(VoicemailMessage, Fixnum, Hash)>

Get message.

Parameters:

  • message_id —

    Message ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    If the caller is a known user, which fields, if any, to expand

Returns:

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

    VoicemailMessage data, response status code and response headers



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

def get_voicemail_message_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_message ..."
  end
  # verify the required parameter 'message_id' is set
  fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.get_voicemail_message" if message_id.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) 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 => 'VoicemailMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_messages(opts = {}) ⇒ VoicemailMessageEntityListing

List voicemail messages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    An optional comma separated list of VoicemailMessage ids

  • :expand (Array<String>) —

    If the caller is a known user, which fields, if any, to expand

Returns:



661
662
663
664
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 661

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

#get_voicemail_messages_with_http_info(opts = {}) ⇒ Array<(VoicemailMessageEntityListing, Fixnum, Hash)>

List voicemail messages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    An optional comma separated list of VoicemailMessage ids

  • :expand (Array<String>) —

    If the caller is a known user, which fields, if any, to expand

Returns:



672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 672

def get_voicemail_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_messages ..."
  end
  # resource path
  local_var_path = "/api/v2/voicemail/messages".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'ids'] = opts[:'ids'] if opts[:'ids']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) 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 => 'VoicemailMessageEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_policy(opts = {}) ⇒ VoicemailOrganizationPolicy

Get a policy

Parameters:

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

    the optional parameters

Returns:



718
719
720
721
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 718

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

#get_voicemail_policy_with_http_info(opts = {}) ⇒ Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>

Get a policy

Parameters:

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

    the optional parameters

Returns:



727
728
729
730
731
732
733
734
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
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 727

def get_voicemail_policy_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_policy ..."
  end
  # resource path
  local_var_path = "/api/v2/voicemail/policy".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 = 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 => 'VoicemailOrganizationPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_search(q64, opts = {}) ⇒ VoicemailsSearchResponse

Search voicemails using the q64 value returned from a previous search

Parameters:

  • q64 —

    q64

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    expand

Returns:



773
774
775
776
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 773

def get_voicemail_search(q64, opts = {})
  data, _status_code, _headers = get_voicemail_search_with_http_info(q64, opts)
  return data
end

#get_voicemail_search_with_http_info(q64, opts = {}) ⇒ Array<(VoicemailsSearchResponse, Fixnum, Hash)>

Search voicemails using the q64 value returned from a previous search

Parameters:

  • q64 —

    q64

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    expand

Returns:

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

    VoicemailsSearchResponse data, response status code and response headers



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
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
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 784

def get_voicemail_search_with_http_info(q64, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_search ..."
  end
  # verify the required parameter 'q64' is set
  fail ArgumentError, "Missing the required parameter 'q64' when calling VoicemailApi.get_voicemail_search" if q64.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'q64'] = q64
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) 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 => 'VoicemailsSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_userpolicy(user_id, opts = {}) ⇒ VoicemailUserPolicy

Get a user’s voicemail policy

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



833
834
835
836
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 833

def get_voicemail_userpolicy(user_id, opts = {})
  data, _status_code, _headers = get_voicemail_userpolicy_with_http_info(user_id, opts)
  return data
end

#get_voicemail_userpolicy_with_http_info(user_id, opts = {}) ⇒ Array<(VoicemailUserPolicy, Fixnum, Hash)>

Get a user&#39;s voicemail policy

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    VoicemailUserPolicy data, response status code and response headers



843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 843

def get_voicemail_userpolicy_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_userpolicy ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling VoicemailApi.get_voicemail_userpolicy" if user_id.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/userpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_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 => 'VoicemailUserPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_userpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_voicemail_group_policy(group_id, body, opts = {}) ⇒ VoicemailGroupPolicy

Update a group’s voicemail policy

Parameters:

  • group_id —

    Group ID

  • body —

    The group&#39;s voicemail policy

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

    the optional parameters

Returns:



891
892
893
894
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 891

def patch_voicemail_group_policy(group_id, body, opts = {})
  data, _status_code, _headers = patch_voicemail_group_policy_with_http_info(group_id, body, opts)
  return data
end

#patch_voicemail_group_policy_with_http_info(group_id, body, opts = {}) ⇒ Array<(VoicemailGroupPolicy, Fixnum, Hash)>

Update a group&#39;s voicemail policy

Parameters:

  • group_id —

    Group ID

  • body —

    The group&#39;s voicemail policy

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

    the optional parameters

Returns:

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

    VoicemailGroupPolicy data, response status code and response headers



902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 902

def patch_voicemail_group_policy_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.patch_voicemail_group_policy ..."
  end
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.patch_voicemail_group_policy" if group_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.patch_voicemail_group_policy" if body.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/groups/{groupId}/policy".sub('{format}','json').sub('{' + 'groupId' + '}', group_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(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailGroupPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#patch_voicemail_group_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_voicemail_me_policy(body, opts = {}) ⇒ VoicemailUserPolicy

Update the current user’s voicemail policy

Parameters:

  • body —

    The user&#39;s voicemail policy

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

    the optional parameters

Returns:



951
952
953
954
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 951

def patch_voicemail_me_policy(body, opts = {})
  data, _status_code, _headers = patch_voicemail_me_policy_with_http_info(body, opts)
  return data
end

#patch_voicemail_me_policy_with_http_info(body, opts = {}) ⇒ Array<(VoicemailUserPolicy, Fixnum, Hash)>

Update the current user&#39;s voicemail policy

Parameters:

  • body —

    The user&#39;s voicemail policy

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

    the optional parameters

Returns:

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

    VoicemailUserPolicy data, response status code and response headers



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 961

def patch_voicemail_me_policy_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.patch_voicemail_me_policy ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.patch_voicemail_me_policy" if body.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/me/policy".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(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailUserPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#patch_voicemail_me_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_voicemail_userpolicy(user_id, body, opts = {}) ⇒ VoicemailUserPolicy

Update a user’s voicemail policy

Parameters:

  • user_id —

    User ID

  • body —

    The user&#39;s voicemail policy

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

    the optional parameters

Returns:



1009
1010
1011
1012
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 1009

def patch_voicemail_userpolicy(user_id, body, opts = {})
  data, _status_code, _headers = patch_voicemail_userpolicy_with_http_info(user_id, body, opts)
  return data
end

#patch_voicemail_userpolicy_with_http_info(user_id, body, opts = {}) ⇒ Array<(VoicemailUserPolicy, Fixnum, Hash)>

Update a user&#39;s voicemail policy

Parameters:

  • user_id —

    User ID

  • body —

    The user&#39;s voicemail policy

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

    the optional parameters

Returns:

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

    VoicemailUserPolicy data, response status code and response headers



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
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 1020

def patch_voicemail_userpolicy_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.patch_voicemail_userpolicy ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling VoicemailApi.patch_voicemail_userpolicy" if user_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.patch_voicemail_userpolicy" if body.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/userpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_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(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailUserPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#patch_voicemail_userpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_voicemail_messages(opts = {}) ⇒ VoicemailMessage

Copy a voicemail message to a user or group

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1069
1070
1071
1072
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 1069

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

#post_voicemail_messages_with_http_info(opts = {}) ⇒ Array<(VoicemailMessage, Fixnum, Hash)>

Copy a voicemail message to a user or group

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    VoicemailMessage data, response status code and response headers



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
1112
1113
1114
1115
1116
1117
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 1079

def post_voicemail_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.post_voicemail_messages ..."
  end
  # resource path
  local_var_path = "/api/v2/voicemail/messages".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(opts[:'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 => 'VoicemailMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#post_voicemail_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_voicemail_search(body, opts = {}) ⇒ VoicemailsSearchResponse

Search voicemails

Parameters:

  • body —

    Search request options

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

    the optional parameters

Returns:



1124
1125
1126
1127
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 1124

def post_voicemail_search(body, opts = {})
  data, _status_code, _headers = post_voicemail_search_with_http_info(body, opts)
  return data
end

#post_voicemail_search_with_http_info(body, opts = {}) ⇒ Array<(VoicemailsSearchResponse, Fixnum, Hash)>

Search voicemails

Parameters:

  • body —

    Search request options

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

    the optional parameters

Returns:

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

    VoicemailsSearchResponse data, response status code and response headers



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
1174
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 1134

def post_voicemail_search_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.post_voicemail_search ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.post_voicemail_search" if body.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/search".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 => 'VoicemailsSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#post_voicemail_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_voicemail_message(message_id, body, opts = {}) ⇒ VoicemailMessage

Update a message.

Parameters:

  • message_id —

    Message ID

  • body —

    VoicemailMessage

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

    the optional parameters

Returns:



1182
1183
1184
1185
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 1182

def put_voicemail_message(message_id, body, opts = {})
  data, _status_code, _headers = put_voicemail_message_with_http_info(message_id, body, opts)
  return data
end

#put_voicemail_message_with_http_info(message_id, body, opts = {}) ⇒ Array<(VoicemailMessage, Fixnum, Hash)>

Update a message.

Parameters:

  • message_id —

    Message ID

  • body —

    VoicemailMessage

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

    the optional parameters

Returns:

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

    VoicemailMessage data, response status code and response headers



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
1229
1230
1231
1232
1233
1234
1235
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 1193

def put_voicemail_message_with_http_info(message_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.put_voicemail_message ..."
  end
  # verify the required parameter 'message_id' is set
  fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.put_voicemail_message" if message_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.put_voicemail_message" if body.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_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 => 'VoicemailMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#put_voicemail_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_voicemail_policy(body, opts = {}) ⇒ VoicemailOrganizationPolicy

Update a policy

Parameters:

  • body —

    Policy

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

    the optional parameters

Returns:



1242
1243
1244
1245
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 1242

def put_voicemail_policy(body, opts = {})
  data, _status_code, _headers = put_voicemail_policy_with_http_info(body, opts)
  return data
end

#put_voicemail_policy_with_http_info(body, opts = {}) ⇒ Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>

Update a policy

Parameters:

  • body —

    Policy

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

    the optional parameters

Returns:



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
1291
1292
 
# File 'lib/purecloudplatformclientv2/api/voicemail_api.rb', line 1252

def put_voicemail_policy_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.put_voicemail_policy ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.put_voicemail_policy" if body.nil?
  # resource path
  local_var_path = "/api/v2/voicemail/policy".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(: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 => 'VoicemailOrganizationPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#put_voicemail_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end