Class: PureCloud::VoicemailApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/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/purecloud/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/purecloud/api/voicemail_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_messages(opts = {}) ⇒ String

Delete all voicemail messages

Parameters:

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

    the optional parameters

Returns:

  • (String) 


31
32
33
34
 
# File 'lib/purecloud/api/voicemail_api.rb', line 31

def delete_messages(opts = {})
  data, status_code, headers = delete_messages_with_http_info(opts)
  return data
end

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

Delete a message.

Parameters:

  • message_id —

    Message ID

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

    the optional parameters

Returns:

  • (String) 


87
88
89
90
 
# File 'lib/purecloud/api/voicemail_api.rb', line 87

def delete_messages_message_id(message_id, opts = {})
  data, status_code, headers = delete_messages_message_id_with_http_info(message_id, opts)
  return data
end

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



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

def delete_messages_message_id_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi#delete_messages_message_id ..."
  end
  
  # verify the required parameter 'message_id' is set
  fail "Missing the required parameter 'message_id' when calling delete_messages_message_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/purecloud/api/voicemail_api.rb', line 40

def delete_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi#delete_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

#get_mailbox(opts = {}) ⇒ VoicemailMailboxInfo

Get mailbox information

Parameters:

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

    the optional parameters

Returns:



146
147
148
149
 
# File 'lib/purecloud/api/voicemail_api.rb', line 146

def get_mailbox(opts = {})
  data, status_code, headers = get_mailbox_with_http_info(opts)
  return data
end

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

Get mailbox information

Parameters:

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

    the optional parameters

Returns:

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

    VoicemailMailboxInfo data, response status code and response headers



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

def get_mailbox_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi#get_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

#get_messages(opts = {}) ⇒ VoicemailMessageEntityListing

List voicemail messages

Parameters:

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

    the optional parameters

Returns:



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

def get_messages(opts = {})
  data, status_code, headers = get_messages_with_http_info(opts)
  return data
end

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

Get message.

Parameters:

  • message_id —

    Message ID

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

    the optional parameters

Returns:



257
258
259
260
 
# File 'lib/purecloud/api/voicemail_api.rb', line 257

def get_messages_message_id(message_id, opts = {})
  data, status_code, headers = get_messages_message_id_with_http_info(message_id, opts)
  return data
end

#get_messages_message_id_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:



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

def get_messages_message_id_media(message_id, opts = {})
  data, status_code, headers = get_messages_message_id_media_with_http_info(message_id, opts)
  return data
end

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



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

def get_messages_message_id_media_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages_message_id_media ..."
  end
  
  # verify the required parameter 'message_id' is set
  fail "Missing the required parameter 'message_id' when calling get_messages_message_id_media" if message_id.nil?
  
  if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
    fail '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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Get message.

Parameters:

  • message_id —

    Message ID

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

    the optional parameters

Returns:

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

    VoicemailMessage data, response status code and response headers



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

def get_messages_message_id_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages_message_id ..."
  end
  
  # verify the required parameter 'message_id' is set
  fail "Missing the required parameter 'message_id' when calling get_messages_message_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

List voicemail messages

Parameters:

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

    the optional parameters

Returns:



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

def get_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi#get_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

#get_policy(opts = {}) ⇒ VoicemailOrganizationPolicy

Get a policy

Parameters:

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

    the optional parameters

Returns:



383
384
385
386
 
# File 'lib/purecloud/api/voicemail_api.rb', line 383

def get_policy(opts = {})
  data, status_code, headers = get_policy_with_http_info(opts)
  return data
end

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

Get a policy

Parameters:

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

    the optional parameters

Returns:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/purecloud/api/voicemail_api.rb', line 392

def get_policy_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi#get_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Get a user’s voicemail policy

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



439
440
441
442
 
# File 'lib/purecloud/api/voicemail_api.rb', line 439

def get_userpolicies_user_id(user_id, opts = {})
  data, status_code, headers = get_userpolicies_user_id_with_http_info(user_id, opts)
  return data
end

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



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/purecloud/api/voicemail_api.rb', line 449

def get_userpolicies_user_id_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi#get_userpolicies_user_id ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling get_userpolicies_user_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_userpolicies_user_id(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:



500
501
502
503
 
# File 'lib/purecloud/api/voicemail_api.rb', line 500

def patch_userpolicies_user_id(user_id, body, opts = {})
  data, status_code, headers = patch_userpolicies_user_id_with_http_info(user_id, body, opts)
  return data
end

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



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

def patch_userpolicies_user_id_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi#patch_userpolicies_user_id ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling patch_userpolicies_user_id" if user_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling patch_userpolicies_user_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_userpolicies_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a message.

Parameters:

  • message_id —

    Message ID

  • body —

    VoicemailMessage

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

    the optional parameters

Returns:



565
566
567
568
 
# File 'lib/purecloud/api/voicemail_api.rb', line 565

def put_messages_message_id(message_id, body, opts = {})
  data, status_code, headers = put_messages_message_id_with_http_info(message_id, body, opts)
  return data
end

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



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

def put_messages_message_id_with_http_info(message_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi#put_messages_message_id ..."
  end
  
  # verify the required parameter 'message_id' is set
  fail "Missing the required parameter 'message_id' when calling put_messages_message_id" if message_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_messages_message_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a policy

Parameters:

  • body —

    Policy

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

    the optional parameters

Returns:



629
630
631
632
 
# File 'lib/purecloud/api/voicemail_api.rb', line 629

def put_policy(body, opts = {})
  data, status_code, headers = put_policy_with_http_info(body, opts)
  return data
end

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

Update a policy

Parameters:

  • body —

    Policy

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

    the optional parameters

Returns:



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

def put_policy_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi#put_policy ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end