doc_out/VoicemailApi.html.md in purecloud-0.67.1 vs doc_out/VoicemailApi.html.md in purecloud-0.68.1
- old
+ new
@@ -4,44 +4,47 @@
## PureCloud::VoicemailApi
All URIs are relative to *https://api.mypurecloud.com*
-Method | HTTP request | Description
+Method | Description
------------- | ------------- | -------------
-|[**delete_messages**](VoicemailApi.html#delete_messages) | **DELETE** /api/v2/voicemail/messages | Delete all voicemail messages|
-|[**delete_messages_message_id**](VoicemailApi.html#delete_messages_message_id) | **DELETE** /api/v2/voicemail/messages/{messageId} | Delete a message.|
-|[**get_groups_group_id_mailbox**](VoicemailApi.html#get_groups_group_id_mailbox) | **GET** /api/v2/voicemail/groups/{groupId}/mailbox | Get the group's mailbox information|
-|[**get_groups_group_id_messages**](VoicemailApi.html#get_groups_group_id_messages) | **GET** /api/v2/voicemail/groups/{groupId}/messages | List voicemail messages|
-|[**get_groups_group_id_policy**](VoicemailApi.html#get_groups_group_id_policy) | **GET** /api/v2/voicemail/groups/{groupId}/policy | Get a group's voicemail policy|
-|[**get_mailbox**](VoicemailApi.html#get_mailbox) | **GET** /api/v2/voicemail/mailbox | Get the current user's mailbox information|
-|[**get_me_mailbox**](VoicemailApi.html#get_me_mailbox) | **GET** /api/v2/voicemail/me/mailbox | Get the current user's mailbox information|
-|[**get_me_messages**](VoicemailApi.html#get_me_messages) | **GET** /api/v2/voicemail/me/messages | List voicemail messages|
-|[**get_me_policy**](VoicemailApi.html#get_me_policy) | **GET** /api/v2/voicemail/me/policy | Get the current user's voicemail policy|
-|[**get_messages**](VoicemailApi.html#get_messages) | **GET** /api/v2/voicemail/messages | List voicemail messages|
-|[**get_messages_message_id**](VoicemailApi.html#get_messages_message_id) | **GET** /api/v2/voicemail/messages/{messageId} | Get message.|
-|[**get_messages_message_id_media**](VoicemailApi.html#get_messages_message_id_media) | **GET** /api/v2/voicemail/messages/{messageId}/media | Get media playback URI for this message|
-|[**get_policy**](VoicemailApi.html#get_policy) | **GET** /api/v2/voicemail/policy | Get a policy|
-|[**get_search**](VoicemailApi.html#get_search) | **GET** /api/v2/voicemail/search | Search voicemails using the q64 value returned from a previous search|
-|[**get_userpolicies_user_id**](VoicemailApi.html#get_userpolicies_user_id) | **GET** /api/v2/voicemail/userpolicies/{userId} | Get a user's voicemail policy|
-|[**patch_groups_group_id_policy**](VoicemailApi.html#patch_groups_group_id_policy) | **PATCH** /api/v2/voicemail/groups/{groupId}/policy | Update a group's voicemail policy|
-|[**patch_me_policy**](VoicemailApi.html#patch_me_policy) | **PATCH** /api/v2/voicemail/me/policy | Update the current user's voicemail policy|
-|[**patch_userpolicies_user_id**](VoicemailApi.html#patch_userpolicies_user_id) | **PATCH** /api/v2/voicemail/userpolicies/{userId} | Update a user's voicemail policy|
-|[**post_messages**](VoicemailApi.html#post_messages) | **POST** /api/v2/voicemail/messages | Copy a voicemail message to a user or group|
-|[**post_search**](VoicemailApi.html#post_search) | **POST** /api/v2/voicemail/search | Search voicemails|
-|[**put_messages_message_id**](VoicemailApi.html#put_messages_message_id) | **PUT** /api/v2/voicemail/messages/{messageId} | Update a message.|
-|[**put_policy**](VoicemailApi.html#put_policy) | **PUT** /api/v2/voicemail/policy | Update a policy|
+[**delete_messages**](VoicemailApi.html#delete_messages) | Delete all voicemail messages
+[**delete_messages_message_id**](VoicemailApi.html#delete_messages_message_id) | Delete a message.
+[**get_groups_group_id_mailbox**](VoicemailApi.html#get_groups_group_id_mailbox) | Get the group's mailbox information
+[**get_groups_group_id_messages**](VoicemailApi.html#get_groups_group_id_messages) | List voicemail messages
+[**get_groups_group_id_policy**](VoicemailApi.html#get_groups_group_id_policy) | Get a group's voicemail policy
+[**get_mailbox**](VoicemailApi.html#get_mailbox) | Get the current user's mailbox information
+[**get_me_mailbox**](VoicemailApi.html#get_me_mailbox) | Get the current user's mailbox information
+[**get_me_messages**](VoicemailApi.html#get_me_messages) | List voicemail messages
+[**get_me_policy**](VoicemailApi.html#get_me_policy) | Get the current user's voicemail policy
+[**get_messages**](VoicemailApi.html#get_messages) | List voicemail messages
+[**get_messages_message_id**](VoicemailApi.html#get_messages_message_id) | Get message.
+[**get_messages_message_id_media**](VoicemailApi.html#get_messages_message_id_media) | Get media playback URI for this message
+[**get_policy**](VoicemailApi.html#get_policy) | Get a policy
+[**get_search**](VoicemailApi.html#get_search) | Search voicemails using the q64 value returned from a previous search
+[**get_userpolicies_user_id**](VoicemailApi.html#get_userpolicies_user_id) | Get a user's voicemail policy
+[**patch_groups_group_id_policy**](VoicemailApi.html#patch_groups_group_id_policy) | Update a group's voicemail policy
+[**patch_me_policy**](VoicemailApi.html#patch_me_policy) | Update the current user's voicemail policy
+[**patch_userpolicies_user_id**](VoicemailApi.html#patch_userpolicies_user_id) | Update a user's voicemail policy
+[**post_messages**](VoicemailApi.html#post_messages) | Copy a voicemail message to a user or group
+[**post_search**](VoicemailApi.html#post_search) | Search voicemails
+[**put_messages_message_id**](VoicemailApi.html#put_messages_message_id) | Update a message.
+[**put_policy**](VoicemailApi.html#put_policy) | Update a policy
{: class="table table-striped"}
<a name="delete_messages"></a>
## -String** delete_messages
Delete all voicemail messages
+Wraps DELETE /api/v2/voicemail/messages
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -88,10 +91,13 @@
Delete a message.
+Wraps DELETE /api/v2/voicemail/messages/{messageId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -144,10 +150,13 @@
Get the group's mailbox information
+Wraps GET /api/v2/voicemail/groups/{groupId}/mailbox
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -200,10 +209,13 @@
List voicemail messages
+Wraps GET /api/v2/voicemail/groups/{groupId}/messages
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -262,10 +274,13 @@
Get a group's voicemail policy
+Wraps GET /api/v2/voicemail/groups/{groupId}/policy
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -318,10 +333,13 @@
Get the current user's mailbox information
+Wraps GET /api/v2/voicemail/mailbox
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -368,10 +386,13 @@
Get the current user's mailbox information
+Wraps GET /api/v2/voicemail/me/mailbox
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -418,10 +439,13 @@
List voicemail messages
+Wraps GET /api/v2/voicemail/me/messages
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -477,10 +501,13 @@
Get the current user's voicemail policy
+Wraps GET /api/v2/voicemail/me/policy
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -527,10 +554,13 @@
List voicemail messages
+Wraps GET /api/v2/voicemail/messages
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -586,10 +616,13 @@
Get message.
+Wraps GET /api/v2/voicemail/messages/{messageId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -646,10 +679,13 @@
Get media playback URI for this message
+Wraps GET /api/v2/voicemail/messages/{messageId}/media
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -706,10 +742,13 @@
Get a policy
+Wraps GET /api/v2/voicemail/policy
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -756,10 +795,13 @@
Search voicemails using the q64 value returned from a previous search
+Wraps GET /api/v2/voicemail/search
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -816,10 +858,13 @@
Get a user's voicemail policy
+Wraps GET /api/v2/voicemail/userpolicies/{userId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -872,10 +917,13 @@
Update a group's voicemail policy
+Wraps PATCH /api/v2/voicemail/groups/{groupId}/policy
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -931,10 +979,13 @@
Update the current user's voicemail policy
+Wraps PATCH /api/v2/voicemail/me/policy
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -987,10 +1038,13 @@
Update a user's voicemail policy
+Wraps PATCH /api/v2/voicemail/userpolicies/{userId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1046,10 +1100,13 @@
Copy a voicemail message to a user or group
+Wraps POST /api/v2/voicemail/messages
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1103,10 +1160,13 @@
Search voicemails
+Wraps POST /api/v2/voicemail/search
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1159,10 +1219,13 @@
Update a message.
+Wraps PUT /api/v2/voicemail/messages/{messageId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -1216,9 +1279,12 @@
## -[**VoicemailOrganizationPolicy**](VoicemailOrganizationPolicy.html) put_policy(body)
Update a policy
+
+
+Wraps PUT /api/v2/voicemail/policy
### Example
~~~ruby
# load the gem