purecloud 0.60.1 → 0.61.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (268) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/AgentActivityEntityListing.html.md +1 -1
  5. data/doc_out/AttemptLimitsEntityListing.html.md +1 -1
  6. data/doc_out/AttributeEntityListing.html.md +1 -1
  7. data/doc_out/CalibrationEntityListing.html.md +1 -1
  8. data/doc_out/CallConversationEntityListing.html.md +1 -1
  9. data/doc_out/CallableTimeSetEntityListing.html.md +1 -1
  10. data/doc_out/CallbackConversationEntityListing.html.md +1 -1
  11. data/doc_out/CampaignEntityListing.html.md +1 -1
  12. data/doc_out/CampaignSequenceEntityListing.html.md +1 -1
  13. data/doc_out/CertificateAuthorityEntityListing.html.md +1 -1
  14. data/doc_out/ChannelEntityListing.html.md +1 -1
  15. data/doc_out/ChatConversationEntityListing.html.md +1 -1
  16. data/doc_out/CobrowseConversationEntityListing.html.md +1 -1
  17. data/doc_out/CommandStatusEntityListing.html.md +1 -1
  18. data/doc_out/ContactListEntityListing.html.md +1 -1
  19. data/doc_out/ConversationEntityListing.html.md +1 -1
  20. data/doc_out/CopyVoicemailMessage.html.md +15 -0
  21. data/doc_out/DIDEntityListing.html.md +1 -1
  22. data/doc_out/DIDPoolEntityListing.html.md +1 -1
  23. data/doc_out/DecisionsDownloadLink.html.md +14 -0
  24. data/doc_out/DecisionsDownloadMetadata.html.md +20 -0
  25. data/doc_out/DecisionsFileMetadataEntityListing.html.md +22 -0
  26. data/doc_out/DncListEntityListing.html.md +1 -1
  27. data/doc_out/DocumentAuditEntityListing.html.md +1 -1
  28. data/doc_out/DocumentEntityListing.html.md +1 -1
  29. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +1 -1
  30. data/doc_out/DomainEntityListing.html.md +1 -1
  31. data/doc_out/DomainEntityListingEvaluationForm.html.md +1 -1
  32. data/doc_out/DomainEntityListingQueryResult.html.md +1 -1
  33. data/doc_out/Edge.html.md +2 -0
  34. data/doc_out/EdgeEntityListing.html.md +1 -1
  35. data/doc_out/EdgeGroupEntityListing.html.md +1 -1
  36. data/doc_out/EdgeLineEntityListing.html.md +1 -1
  37. data/doc_out/EmailConversationEntityListing.html.md +1 -1
  38. data/doc_out/EmailMessageListing.html.md +1 -1
  39. data/doc_out/EncryptionKeyEntityListing.html.md +1 -1
  40. data/doc_out/EndpointEntityListing.html.md +1 -1
  41. data/doc_out/EvaluationEntityListing.html.md +1 -1
  42. data/doc_out/EvaluationFormEntityListing.html.md +1 -1
  43. data/doc_out/EvaluatorActivityEntityListing.html.md +1 -1
  44. data/doc_out/ExtensionEntityListing.html.md +1 -1
  45. data/doc_out/ExtensionPoolEntityListing.html.md +1 -1
  46. data/doc_out/FaxDocumentEntityListing.html.md +1 -1
  47. data/doc_out/ForecastSearchCriteria.html.md +20 -0
  48. data/doc_out/ForecastSearchRequest.html.md +20 -0
  49. data/doc_out/GreetingListing.html.md +22 -0
  50. data/doc_out/GreetingsApi.html.md +240 -0
  51. data/doc_out/GroupEntityListing.html.md +1 -1
  52. data/doc_out/HeartBeatAlertContainer.html.md +1 -1
  53. data/doc_out/HeartBeatRuleContainer.html.md +1 -1
  54. data/doc_out/InboundDomainEntityListing.html.md +1 -1
  55. data/doc_out/InboundRouteEntityListing.html.md +1 -1
  56. data/doc_out/InteractionStatsAlertContainer.html.md +1 -1
  57. data/doc_out/InteractionStatsRuleContainer.html.md +1 -1
  58. data/doc_out/KeywordSetEntityListing.html.md +1 -1
  59. data/doc_out/LanguageEntityListing.html.md +1 -1
  60. data/doc_out/LanguagesApi.html.md +123 -70
  61. data/doc_out/LibraryEntityListing.html.md +1 -1
  62. data/doc_out/Line.html.md +2 -2
  63. data/doc_out/LineBaseEntityListing.html.md +1 -1
  64. data/doc_out/LineEntityListing.html.md +1 -1
  65. data/doc_out/LocalEncryptionConfigurationListing.html.md +1 -1
  66. data/doc_out/LogicalInterfaceEntityListing.html.md +1 -1
  67. data/doc_out/OAuthClientEntityListing.html.md +1 -1
  68. data/doc_out/OAuthProviderEntityListing.html.md +1 -1
  69. data/doc_out/OrganizationPresenceEntityListing.html.md +1 -1
  70. data/doc_out/OrganizationRoleEntityListing.html.md +1 -1
  71. data/doc_out/OrphanRecordingListing.html.md +1 -1
  72. data/doc_out/OutboundApi.html.md +3 -1
  73. data/doc_out/OutboundRouteEntityListing.html.md +1 -1
  74. data/doc_out/Participant.html.md +1 -0
  75. data/doc_out/PermissionCollectionEntityListing.html.md +1 -1
  76. data/doc_out/Phone.html.md +2 -0
  77. data/doc_out/PhoneBaseEntityListing.html.md +1 -1
  78. data/doc_out/PhoneEntityListing.html.md +1 -1
  79. data/doc_out/PhoneMetaBaseEntityListing.html.md +1 -1
  80. data/doc_out/PhysicalInterfaceEntityListing.html.md +1 -1
  81. data/doc_out/PolicyEntityListing.html.md +1 -1
  82. data/doc_out/QualityAuditPage.html.md +1 -1
  83. data/doc_out/QueueEntityListing.html.md +1 -1
  84. data/doc_out/QueueMemberEntityListing.html.md +1 -1
  85. data/doc_out/ReportMetaDataEntityListing.html.md +1 -1
  86. data/doc_out/ReportRunEntryEntityDomainListing.html.md +1 -1
  87. data/doc_out/ReportScheduleEntityListing.html.md +1 -1
  88. data/doc_out/ResponseEntityList.html.md +1 -1
  89. data/doc_out/ResponseEntityListing.html.md +1 -1
  90. data/doc_out/ResponseSetEntityListing.html.md +1 -1
  91. data/doc_out/RoutingApi.html.md +121 -0
  92. data/doc_out/RoutingStatusAlertContainer.html.md +1 -1
  93. data/doc_out/RoutingStatusRuleContainer.html.md +1 -1
  94. data/doc_out/RuleSetEntityListing.html.md +1 -1
  95. data/doc_out/SchemaCategoryEntityListing.html.md +1 -1
  96. data/doc_out/SchemaReferenceEntityListing.html.md +1 -1
  97. data/doc_out/ScreenRecordingSessionListing.html.md +1 -1
  98. data/doc_out/ScriptEntityListing.html.md +1 -1
  99. data/doc_out/SearchApi.html.md +122 -2
  100. data/doc_out/SecurityProfileEntityListing.html.md +1 -1
  101. data/doc_out/ShareEntityListing.html.md +1 -1
  102. data/doc_out/SiteEntityListing.html.md +1 -1
  103. data/doc_out/SkillEntityListing.html.md +1 -1
  104. data/doc_out/StationEntityListing.html.md +1 -1
  105. data/doc_out/SuggestApi.html.md +4 -2
  106. data/doc_out/SuggestSearchRequest.html.md +1 -0
  107. data/doc_out/TagValueEntityListing.html.md +1 -1
  108. data/doc_out/TelephonyProvidersEdgeApi.html.md +19 -5
  109. data/doc_out/TimeZoneEntityListing.html.md +1 -1
  110. data/doc_out/TrunkBaseEntityListing.html.md +1 -1
  111. data/doc_out/TrunkEntityListing.html.md +1 -1
  112. data/doc_out/TrunkMetabaseEntityListing.html.md +1 -1
  113. data/doc_out/UserEntityListing.html.md +1 -1
  114. data/doc_out/UserPresenceAlertContainer.html.md +1 -1
  115. data/doc_out/UserPresenceRuleContainer.html.md +1 -1
  116. data/doc_out/UserQueueEntityListing.html.md +1 -1
  117. data/doc_out/UserRecordingEntityListing.html.md +1 -1
  118. data/doc_out/UserSkillEntityListing.html.md +1 -1
  119. data/doc_out/VoicemailApi.html.md +649 -10
  120. data/doc_out/VoicemailGroupPolicy.html.md +16 -0
  121. data/doc_out/VoicemailMailboxInfo.html.md +6 -6
  122. data/doc_out/VoicemailMessage.html.md +13 -9
  123. data/doc_out/VoicemailMessageEntityListing.html.md +8 -1
  124. data/doc_out/VoicemailOrganizationPolicy.html.md +1 -0
  125. data/doc_out/VoicemailSearchCriteria.html.md +20 -0
  126. data/doc_out/VoicemailSearchRequest.html.md +19 -0
  127. data/doc_out/VoicemailsSearchResponse.html.md +21 -0
  128. data/doc_out/WorkforceManagementApi.html.md +118 -0
  129. data/doc_out/WorkspaceEntityListing.html.md +1 -1
  130. data/doc_out/WorkspaceMemberEntityListing.html.md +1 -1
  131. data/doc_out/WrapupCodeEntityListing.html.md +1 -1
  132. data/doc_out/index.html.md +3 -3
  133. data/lib/purecloud.rb +11 -0
  134. data/lib/purecloud/api/greetings_api.rb +256 -0
  135. data/lib/purecloud/api/languages_api.rb +134 -80
  136. data/lib/purecloud/api/outbound_api.rb +3 -0
  137. data/lib/purecloud/api/routing_api.rb +131 -0
  138. data/lib/purecloud/api/search_api.rb +129 -2
  139. data/lib/purecloud/api/suggest_api.rb +5 -2
  140. data/lib/purecloud/api/telephony_providers_edge_api.rb +18 -0
  141. data/lib/purecloud/api/voicemail_api.rb +674 -8
  142. data/lib/purecloud/api/workforce_management_api.rb +123 -0
  143. data/lib/purecloud/api_client.rb +1 -1
  144. data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
  145. data/lib/purecloud/models/analytics_conversation_segment.rb +1 -1
  146. data/lib/purecloud/models/attempt_limits_entity_listing.rb +11 -11
  147. data/lib/purecloud/models/attribute_entity_listing.rb +11 -11
  148. data/lib/purecloud/models/calibration_entity_listing.rb +11 -11
  149. data/lib/purecloud/models/call_conversation_entity_listing.rb +11 -11
  150. data/lib/purecloud/models/callable_time_set_entity_listing.rb +11 -11
  151. data/lib/purecloud/models/callback_conversation_entity_listing.rb +11 -11
  152. data/lib/purecloud/models/campaign_entity_listing.rb +11 -11
  153. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +11 -11
  154. data/lib/purecloud/models/certificate_authority_entity_listing.rb +11 -11
  155. data/lib/purecloud/models/channel_entity_listing.rb +11 -11
  156. data/lib/purecloud/models/chat_conversation_entity_listing.rb +11 -11
  157. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +11 -11
  158. data/lib/purecloud/models/command_status_entity_listing.rb +11 -11
  159. data/lib/purecloud/models/contact_list_entity_listing.rb +11 -11
  160. data/lib/purecloud/models/conversation_entity_listing.rb +11 -11
  161. data/lib/purecloud/models/copy_voicemail_message.rb +189 -0
  162. data/lib/purecloud/models/decisions_download_link.rb +177 -0
  163. data/lib/purecloud/models/decisions_download_metadata.rb +242 -0
  164. data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +257 -0
  165. data/lib/purecloud/models/did_entity_listing.rb +11 -11
  166. data/lib/purecloud/models/did_pool_entity_listing.rb +11 -11
  167. data/lib/purecloud/models/dnc_list_entity_listing.rb +11 -11
  168. data/lib/purecloud/models/document_audit_entity_listing.rb +11 -11
  169. data/lib/purecloud/models/document_entity_listing.rb +11 -11
  170. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +11 -11
  171. data/lib/purecloud/models/domain_entity_listing.rb +11 -11
  172. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +11 -11
  173. data/lib/purecloud/models/domain_entity_listing_query_result.rb +11 -11
  174. data/lib/purecloud/models/edge.rb +30 -1
  175. data/lib/purecloud/models/edge_entity_listing.rb +11 -11
  176. data/lib/purecloud/models/edge_group_entity_listing.rb +11 -11
  177. data/lib/purecloud/models/edge_line_entity_listing.rb +11 -11
  178. data/lib/purecloud/models/email_conversation_entity_listing.rb +11 -11
  179. data/lib/purecloud/models/email_message_listing.rb +11 -11
  180. data/lib/purecloud/models/encryption_key_entity_listing.rb +11 -11
  181. data/lib/purecloud/models/endpoint_entity_listing.rb +11 -11
  182. data/lib/purecloud/models/evaluation_entity_listing.rb +11 -11
  183. data/lib/purecloud/models/evaluation_form_entity_listing.rb +11 -11
  184. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +11 -11
  185. data/lib/purecloud/models/extension_entity_listing.rb +11 -11
  186. data/lib/purecloud/models/extension_pool_entity_listing.rb +11 -11
  187. data/lib/purecloud/models/fax_document_entity_listing.rb +11 -11
  188. data/lib/purecloud/models/forecast_search_criteria.rb +267 -0
  189. data/lib/purecloud/models/forecast_search_request.rb +259 -0
  190. data/lib/purecloud/models/greeting_listing.rb +257 -0
  191. data/lib/purecloud/models/group_entity_listing.rb +11 -11
  192. data/lib/purecloud/models/heart_beat_alert_container.rb +11 -11
  193. data/lib/purecloud/models/heart_beat_rule_container.rb +11 -11
  194. data/lib/purecloud/models/inbound_domain_entity_listing.rb +11 -11
  195. data/lib/purecloud/models/inbound_route_entity_listing.rb +11 -11
  196. data/lib/purecloud/models/interaction_stats_alert_container.rb +11 -11
  197. data/lib/purecloud/models/interaction_stats_rule_container.rb +11 -11
  198. data/lib/purecloud/models/keyword_set_entity_listing.rb +11 -11
  199. data/lib/purecloud/models/language_entity_listing.rb +11 -11
  200. data/lib/purecloud/models/library_entity_listing.rb +11 -11
  201. data/lib/purecloud/models/line.rb +2 -0
  202. data/lib/purecloud/models/line_base_entity_listing.rb +11 -11
  203. data/lib/purecloud/models/line_entity_listing.rb +11 -11
  204. data/lib/purecloud/models/local_encryption_configuration_listing.rb +11 -11
  205. data/lib/purecloud/models/logical_interface_entity_listing.rb +11 -11
  206. data/lib/purecloud/models/o_auth_client_entity_listing.rb +11 -11
  207. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +11 -11
  208. data/lib/purecloud/models/organization_presence_entity_listing.rb +11 -11
  209. data/lib/purecloud/models/organization_role_entity_listing.rb +11 -11
  210. data/lib/purecloud/models/orphan_recording_listing.rb +11 -11
  211. data/lib/purecloud/models/outbound_route_entity_listing.rb +11 -11
  212. data/lib/purecloud/models/participant.rb +12 -1
  213. data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
  214. data/lib/purecloud/models/phone.rb +21 -1
  215. data/lib/purecloud/models/phone_base_entity_listing.rb +11 -11
  216. data/lib/purecloud/models/phone_entity_listing.rb +11 -11
  217. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +11 -11
  218. data/lib/purecloud/models/physical_interface_entity_listing.rb +11 -11
  219. data/lib/purecloud/models/policy_entity_listing.rb +11 -11
  220. data/lib/purecloud/models/quality_audit_page.rb +11 -11
  221. data/lib/purecloud/models/queue_entity_listing.rb +11 -11
  222. data/lib/purecloud/models/queue_member_entity_listing.rb +11 -11
  223. data/lib/purecloud/models/report_meta_data_entity_listing.rb +11 -11
  224. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +11 -11
  225. data/lib/purecloud/models/report_schedule_entity_listing.rb +11 -11
  226. data/lib/purecloud/models/response_entity_list.rb +11 -11
  227. data/lib/purecloud/models/response_entity_listing.rb +11 -11
  228. data/lib/purecloud/models/response_set_entity_listing.rb +11 -11
  229. data/lib/purecloud/models/routing_status_alert_container.rb +11 -11
  230. data/lib/purecloud/models/routing_status_rule_container.rb +11 -11
  231. data/lib/purecloud/models/rule_set_entity_listing.rb +11 -11
  232. data/lib/purecloud/models/schema_category_entity_listing.rb +11 -11
  233. data/lib/purecloud/models/schema_reference_entity_listing.rb +11 -11
  234. data/lib/purecloud/models/screen_recording_session_listing.rb +11 -11
  235. data/lib/purecloud/models/script_entity_listing.rb +11 -11
  236. data/lib/purecloud/models/security_profile_entity_listing.rb +11 -11
  237. data/lib/purecloud/models/share_entity_listing.rb +11 -11
  238. data/lib/purecloud/models/site_entity_listing.rb +11 -11
  239. data/lib/purecloud/models/skill_entity_listing.rb +11 -11
  240. data/lib/purecloud/models/station_entity_listing.rb +11 -11
  241. data/lib/purecloud/models/suggest_search_request.rb +14 -1
  242. data/lib/purecloud/models/tag_value_entity_listing.rb +11 -11
  243. data/lib/purecloud/models/time_zone_entity_listing.rb +11 -11
  244. data/lib/purecloud/models/trunk_base_entity_listing.rb +11 -11
  245. data/lib/purecloud/models/trunk_entity_listing.rb +11 -11
  246. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +11 -11
  247. data/lib/purecloud/models/user_entity_listing.rb +11 -11
  248. data/lib/purecloud/models/user_presence_alert_container.rb +11 -11
  249. data/lib/purecloud/models/user_presence_rule_container.rb +11 -11
  250. data/lib/purecloud/models/user_queue_entity_listing.rb +11 -11
  251. data/lib/purecloud/models/user_recording_entity_listing.rb +11 -11
  252. data/lib/purecloud/models/user_skill_entity_listing.rb +11 -11
  253. data/lib/purecloud/models/voicemail_group_policy.rb +202 -0
  254. data/lib/purecloud/models/voicemail_mailbox_info.rb +13 -9
  255. data/lib/purecloud/models/voicemail_message.rb +56 -3
  256. data/lib/purecloud/models/voicemail_message_entity_listing.rb +83 -13
  257. data/lib/purecloud/models/voicemail_organization_policy.rb +17 -4
  258. data/lib/purecloud/models/voicemail_search_criteria.rb +267 -0
  259. data/lib/purecloud/models/voicemail_search_request.rb +246 -0
  260. data/lib/purecloud/models/voicemails_search_response.rb +258 -0
  261. data/lib/purecloud/models/workspace_entity_listing.rb +11 -11
  262. data/lib/purecloud/models/workspace_member_entity_listing.rb +11 -11
  263. data/lib/purecloud/models/wrapup_code_entity_listing.rb +11 -11
  264. data/lib/purecloud/version.rb +1 -1
  265. data/newVersion.md +1 -1
  266. data/swagger.json +1 -1
  267. data/version.json +1 -1
  268. metadata +24 -2
@@ -11,8 +11,8 @@ title: TimeZoneEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: TrunkBaseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: TrunkEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: TrunkMetabaseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: UserEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: UserPresenceAlertContainer
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: UserPresenceRuleContainer
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: UserQueueEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: UserRecordingEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: UserSkillEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -10,13 +10,24 @@ Method | HTTP request | Description
10
10
  ------------- | ------------- | -------------
11
11
  |[**delete_messages**](VoicemailApi.html#delete_messages) | **DELETE** /api/v2/voicemail/messages | Delete all voicemail messages|
12
12
  |[**delete_messages_message_id**](VoicemailApi.html#delete_messages_message_id) | **DELETE** /api/v2/voicemail/messages/{messageId} | Delete a message.|
13
- |[**get_mailbox**](VoicemailApi.html#get_mailbox) | **GET** /api/v2/voicemail/mailbox | Get mailbox information|
13
+ |[**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|
14
+ |[**get_groups_group_id_messages**](VoicemailApi.html#get_groups_group_id_messages) | **GET** /api/v2/voicemail/groups/{groupId}/messages | List voicemail messages|
15
+ |[**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|
16
+ |[**get_mailbox**](VoicemailApi.html#get_mailbox) | **GET** /api/v2/voicemail/mailbox | Get the current user's mailbox information|
17
+ |[**get_me_mailbox**](VoicemailApi.html#get_me_mailbox) | **GET** /api/v2/voicemail/me/mailbox | Get the current user's mailbox information|
18
+ |[**get_me_messages**](VoicemailApi.html#get_me_messages) | **GET** /api/v2/voicemail/me/messages | List voicemail messages|
19
+ |[**get_me_policy**](VoicemailApi.html#get_me_policy) | **GET** /api/v2/voicemail/me/policy | Get the current user's voicemail policy|
14
20
  |[**get_messages**](VoicemailApi.html#get_messages) | **GET** /api/v2/voicemail/messages | List voicemail messages|
15
21
  |[**get_messages_message_id**](VoicemailApi.html#get_messages_message_id) | **GET** /api/v2/voicemail/messages/{messageId} | Get message.|
16
22
  |[**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|
17
23
  |[**get_policy**](VoicemailApi.html#get_policy) | **GET** /api/v2/voicemail/policy | Get a policy|
24
+ |[**get_search**](VoicemailApi.html#get_search) | **GET** /api/v2/voicemail/search | Search voicemails using the q64 value returned from a previous search|
18
25
  |[**get_userpolicies_user_id**](VoicemailApi.html#get_userpolicies_user_id) | **GET** /api/v2/voicemail/userpolicies/{userId} | Get a user's voicemail policy|
26
+ |[**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|
27
+ |[**patch_me_policy**](VoicemailApi.html#patch_me_policy) | **PATCH** /api/v2/voicemail/me/policy | Update the current user's voicemail policy|
19
28
  |[**patch_userpolicies_user_id**](VoicemailApi.html#patch_userpolicies_user_id) | **PATCH** /api/v2/voicemail/userpolicies/{userId} | Update a user's voicemail policy|
29
+ |[**post_messages**](VoicemailApi.html#post_messages) | **POST** /api/v2/voicemail/messages | Copy a voicemail message to a user or group|
30
+ |[**post_search**](VoicemailApi.html#post_search) | **POST** /api/v2/voicemail/search | Search voicemails|
20
31
  |[**put_messages_message_id**](VoicemailApi.html#put_messages_message_id) | **PUT** /api/v2/voicemail/messages/{messageId} | Update a message.|
21
32
  |[**put_policy**](VoicemailApi.html#put_policy) | **PUT** /api/v2/voicemail/policy | Update a policy|
22
33
  {: class="table table-striped"}
@@ -127,11 +138,344 @@ Name | Type | Description | Notes
127
138
 
128
139
 
129
140
 
141
+ <a name="get_groups_group_id_mailbox"></a>
142
+
143
+ ## -[**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_groups_group_id_mailbox(group_id)
144
+
145
+ Get the group's mailbox information
146
+
147
+
148
+
149
+ ### Example
150
+ ~~~ruby
151
+ # load the gem
152
+ require 'purecloud'
153
+ # setup authorization
154
+ @secret = ENV['PURECLOUD_SECRET']
155
+ @id = ENV['PURECLOUD_CLIENT_ID']
156
+ environment = "mypurecloud.com"
157
+
158
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
159
+
160
+ PureCloud.configure do |config|
161
+ config.access_token = @authToken
162
+ end
163
+
164
+ api_instance = PureCloud::VoicemailApi.new
165
+
166
+ group_id = "group_id_example" # String | groupId
167
+
168
+
169
+ begin
170
+ #Get the group's mailbox information
171
+ result = api_instance.get_groups_group_id_mailbox(group_id)
172
+ p result
173
+ rescue PureCloud::ApiError => e
174
+ puts "Exception when calling VoicemailApi->get_groups_group_id_mailbox: #{e}"
175
+ end
176
+ ~~~
177
+
178
+ ### Parameters
179
+
180
+ Name | Type | Description | Notes
181
+ ------------- | ------------- | ------------- | -------------
182
+ **group_id** | **String**| groupId |
183
+ {: class="table table-striped"}
184
+
185
+
186
+ ### Return type
187
+
188
+ [**VoicemailMailboxInfo**](VoicemailMailboxInfo.html)
189
+
190
+ ### HTTP request headers
191
+
192
+ - **Content-Type**: application/json
193
+ - **Accept**: application/json
194
+
195
+
196
+
197
+ <a name="get_groups_group_id_messages"></a>
198
+
199
+ ## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_groups_group_id_messages(group_id, opts)
200
+
201
+ List voicemail messages
202
+
203
+
204
+
205
+ ### Example
206
+ ~~~ruby
207
+ # load the gem
208
+ require 'purecloud'
209
+ # setup authorization
210
+ @secret = ENV['PURECLOUD_SECRET']
211
+ @id = ENV['PURECLOUD_CLIENT_ID']
212
+ environment = "mypurecloud.com"
213
+
214
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
215
+
216
+ PureCloud.configure do |config|
217
+ config.access_token = @authToken
218
+ end
219
+
220
+ api_instance = PureCloud::VoicemailApi.new
221
+
222
+ group_id = "group_id_example" # String | Group ID
223
+
224
+ opts = {
225
+ page_size: 25, # Integer | Page size
226
+ page_number: 1 # Integer | Page number
227
+ }
228
+
229
+ begin
230
+ #List voicemail messages
231
+ result = api_instance.get_groups_group_id_messages(group_id, opts)
232
+ p result
233
+ rescue PureCloud::ApiError => e
234
+ puts "Exception when calling VoicemailApi->get_groups_group_id_messages: #{e}"
235
+ end
236
+ ~~~
237
+
238
+ ### Parameters
239
+
240
+ Name | Type | Description | Notes
241
+ ------------- | ------------- | ------------- | -------------
242
+ **group_id** | **String**| Group ID |
243
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
244
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
245
+ {: class="table table-striped"}
246
+
247
+
248
+ ### Return type
249
+
250
+ [**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html)
251
+
252
+ ### HTTP request headers
253
+
254
+ - **Content-Type**: application/json
255
+ - **Accept**: application/json
256
+
257
+
258
+
259
+ <a name="get_groups_group_id_policy"></a>
260
+
261
+ ## -[**VoicemailGroupPolicy**](VoicemailGroupPolicy.html) get_groups_group_id_policy(group_id)
262
+
263
+ Get a group's voicemail policy
264
+
265
+
266
+
267
+ ### Example
268
+ ~~~ruby
269
+ # load the gem
270
+ require 'purecloud'
271
+ # setup authorization
272
+ @secret = ENV['PURECLOUD_SECRET']
273
+ @id = ENV['PURECLOUD_CLIENT_ID']
274
+ environment = "mypurecloud.com"
275
+
276
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
277
+
278
+ PureCloud.configure do |config|
279
+ config.access_token = @authToken
280
+ end
281
+
282
+ api_instance = PureCloud::VoicemailApi.new
283
+
284
+ group_id = "group_id_example" # String | Group ID
285
+
286
+
287
+ begin
288
+ #Get a group's voicemail policy
289
+ result = api_instance.get_groups_group_id_policy(group_id)
290
+ p result
291
+ rescue PureCloud::ApiError => e
292
+ puts "Exception when calling VoicemailApi->get_groups_group_id_policy: #{e}"
293
+ end
294
+ ~~~
295
+
296
+ ### Parameters
297
+
298
+ Name | Type | Description | Notes
299
+ ------------- | ------------- | ------------- | -------------
300
+ **group_id** | **String**| Group ID |
301
+ {: class="table table-striped"}
302
+
303
+
304
+ ### Return type
305
+
306
+ [**VoicemailGroupPolicy**](VoicemailGroupPolicy.html)
307
+
308
+ ### HTTP request headers
309
+
310
+ - **Content-Type**: application/json
311
+ - **Accept**: application/json
312
+
313
+
314
+
130
315
  <a name="get_mailbox"></a>
131
316
 
132
- ## -[**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_mailbox
317
+ ## -[**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_mailbox
318
+
319
+ Get the current user's mailbox information
320
+
321
+
322
+
323
+ ### Example
324
+ ~~~ruby
325
+ # load the gem
326
+ require 'purecloud'
327
+ # setup authorization
328
+ @secret = ENV['PURECLOUD_SECRET']
329
+ @id = ENV['PURECLOUD_CLIENT_ID']
330
+ environment = "mypurecloud.com"
331
+
332
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
333
+
334
+ PureCloud.configure do |config|
335
+ config.access_token = @authToken
336
+ end
337
+
338
+ api_instance = PureCloud::VoicemailApi.new
339
+
340
+ begin
341
+ #Get the current user's mailbox information
342
+ result = api_instance.get_mailbox
343
+ p result
344
+ rescue PureCloud::ApiError => e
345
+ puts "Exception when calling VoicemailApi->get_mailbox: #{e}"
346
+ end
347
+ ~~~
348
+
349
+ ### Parameters
350
+ This endpoint does not need any parameter.
351
+ {: class="table table-striped"}
352
+
353
+
354
+ ### Return type
355
+
356
+ [**VoicemailMailboxInfo**](VoicemailMailboxInfo.html)
357
+
358
+ ### HTTP request headers
359
+
360
+ - **Content-Type**: application/json
361
+ - **Accept**: application/json
362
+
363
+
364
+
365
+ <a name="get_me_mailbox"></a>
366
+
367
+ ## -[**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_me_mailbox
368
+
369
+ Get the current user's mailbox information
370
+
371
+
372
+
373
+ ### Example
374
+ ~~~ruby
375
+ # load the gem
376
+ require 'purecloud'
377
+ # setup authorization
378
+ @secret = ENV['PURECLOUD_SECRET']
379
+ @id = ENV['PURECLOUD_CLIENT_ID']
380
+ environment = "mypurecloud.com"
381
+
382
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
383
+
384
+ PureCloud.configure do |config|
385
+ config.access_token = @authToken
386
+ end
387
+
388
+ api_instance = PureCloud::VoicemailApi.new
389
+
390
+ begin
391
+ #Get the current user's mailbox information
392
+ result = api_instance.get_me_mailbox
393
+ p result
394
+ rescue PureCloud::ApiError => e
395
+ puts "Exception when calling VoicemailApi->get_me_mailbox: #{e}"
396
+ end
397
+ ~~~
398
+
399
+ ### Parameters
400
+ This endpoint does not need any parameter.
401
+ {: class="table table-striped"}
402
+
403
+
404
+ ### Return type
405
+
406
+ [**VoicemailMailboxInfo**](VoicemailMailboxInfo.html)
407
+
408
+ ### HTTP request headers
409
+
410
+ - **Content-Type**: application/json
411
+ - **Accept**: application/json
412
+
413
+
414
+
415
+ <a name="get_me_messages"></a>
416
+
417
+ ## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_me_messages(opts)
418
+
419
+ List voicemail messages
420
+
421
+
422
+
423
+ ### Example
424
+ ~~~ruby
425
+ # load the gem
426
+ require 'purecloud'
427
+ # setup authorization
428
+ @secret = ENV['PURECLOUD_SECRET']
429
+ @id = ENV['PURECLOUD_CLIENT_ID']
430
+ environment = "mypurecloud.com"
431
+
432
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
433
+
434
+ PureCloud.configure do |config|
435
+ config.access_token = @authToken
436
+ end
437
+
438
+ api_instance = PureCloud::VoicemailApi.new
439
+
440
+ opts = {
441
+ page_size: 25, # Integer | Page size
442
+ page_number: 1 # Integer | Page number
443
+ }
444
+
445
+ begin
446
+ #List voicemail messages
447
+ result = api_instance.get_me_messages(opts)
448
+ p result
449
+ rescue PureCloud::ApiError => e
450
+ puts "Exception when calling VoicemailApi->get_me_messages: #{e}"
451
+ end
452
+ ~~~
453
+
454
+ ### Parameters
455
+
456
+ Name | Type | Description | Notes
457
+ ------------- | ------------- | ------------- | -------------
458
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
459
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
460
+ {: class="table table-striped"}
461
+
462
+
463
+ ### Return type
464
+
465
+ [**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html)
466
+
467
+ ### HTTP request headers
468
+
469
+ - **Content-Type**: application/json
470
+ - **Accept**: application/json
471
+
472
+
473
+
474
+ <a name="get_me_policy"></a>
475
+
476
+ ## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) get_me_policy
133
477
 
134
- Get mailbox information
478
+ Get the current user's voicemail policy
135
479
 
136
480
 
137
481
 
@@ -153,11 +497,11 @@ end
153
497
  api_instance = PureCloud::VoicemailApi.new
154
498
 
155
499
  begin
156
- #Get mailbox information
157
- result = api_instance.get_mailbox
500
+ #Get the current user's voicemail policy
501
+ result = api_instance.get_me_policy
158
502
  p result
159
503
  rescue PureCloud::ApiError => e
160
- puts "Exception when calling VoicemailApi->get_mailbox: #{e}"
504
+ puts "Exception when calling VoicemailApi->get_me_policy: #{e}"
161
505
  end
162
506
  ~~~
163
507
 
@@ -168,7 +512,7 @@ This endpoint does not need any parameter.
168
512
 
169
513
  ### Return type
170
514
 
171
- [**VoicemailMailboxInfo**](VoicemailMailboxInfo.html)
515
+ [**VoicemailUserPolicy**](VoicemailUserPolicy.html)
172
516
 
173
517
  ### HTTP request headers
174
518
 
@@ -179,7 +523,7 @@ This endpoint does not need any parameter.
179
523
 
180
524
  <a name="get_messages"></a>
181
525
 
182
- ## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_messages
526
+ ## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_messages(opts)
183
527
 
184
528
  List voicemail messages
185
529
 
@@ -202,9 +546,13 @@ end
202
546
 
203
547
  api_instance = PureCloud::VoicemailApi.new
204
548
 
549
+ opts = {
550
+ ids: "ids_example" # String | An optional comma separated list of VoicemailMessage ids
551
+ }
552
+
205
553
  begin
206
554
  #List voicemail messages
207
- result = api_instance.get_messages
555
+ result = api_instance.get_messages(opts)
208
556
  p result
209
557
  rescue PureCloud::ApiError => e
210
558
  puts "Exception when calling VoicemailApi->get_messages: #{e}"
@@ -212,7 +560,10 @@ end
212
560
  ~~~
213
561
 
214
562
  ### Parameters
215
- This endpoint does not need any parameter.
563
+
564
+ Name | Type | Description | Notes
565
+ ------------- | ------------- | ------------- | -------------
566
+ **ids** | **String**| An optional comma separated list of VoicemailMessage ids | [optional]
216
567
  {: class="table table-striped"}
217
568
 
218
569
 
@@ -393,6 +744,66 @@ This endpoint does not need any parameter.
393
744
 
394
745
 
395
746
 
747
+ <a name="get_search"></a>
748
+
749
+ ## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_search(q64, opts)
750
+
751
+ Search voicemails using the q64 value returned from a previous search
752
+
753
+
754
+
755
+ ### Example
756
+ ~~~ruby
757
+ # load the gem
758
+ require 'purecloud'
759
+ # setup authorization
760
+ @secret = ENV['PURECLOUD_SECRET']
761
+ @id = ENV['PURECLOUD_CLIENT_ID']
762
+ environment = "mypurecloud.com"
763
+
764
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
765
+
766
+ PureCloud.configure do |config|
767
+ config.access_token = @authToken
768
+ end
769
+
770
+ api_instance = PureCloud::VoicemailApi.new
771
+
772
+ q64 = "q64_example" # String | q64
773
+
774
+ opts = {
775
+ expand: ["expand_example"] # Array<String> | expand
776
+ }
777
+
778
+ begin
779
+ #Search voicemails using the q64 value returned from a previous search
780
+ result = api_instance.get_search(q64, opts)
781
+ p result
782
+ rescue PureCloud::ApiError => e
783
+ puts "Exception when calling VoicemailApi->get_search: #{e}"
784
+ end
785
+ ~~~
786
+
787
+ ### Parameters
788
+
789
+ Name | Type | Description | Notes
790
+ ------------- | ------------- | ------------- | -------------
791
+ **q64** | **String**| q64 |
792
+ **expand** | [**Array&lt;String&gt;**](String.html)| expand | [optional]
793
+ {: class="table table-striped"}
794
+
795
+
796
+ ### Return type
797
+
798
+ [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html)
799
+
800
+ ### HTTP request headers
801
+
802
+ - **Content-Type**: application/json
803
+ - **Accept**: application/json
804
+
805
+
806
+
396
807
  <a name="get_userpolicies_user_id"></a>
397
808
 
398
809
  ## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) get_userpolicies_user_id(user_id)
@@ -449,6 +860,121 @@ Name | Type | Description | Notes
449
860
 
450
861
 
451
862
 
863
+ <a name="patch_groups_group_id_policy"></a>
864
+
865
+ ## -[**VoicemailGroupPolicy**](VoicemailGroupPolicy.html) patch_groups_group_id_policy(group_id, body)
866
+
867
+ Update a group's voicemail policy
868
+
869
+
870
+
871
+ ### Example
872
+ ~~~ruby
873
+ # load the gem
874
+ require 'purecloud'
875
+ # setup authorization
876
+ @secret = ENV['PURECLOUD_SECRET']
877
+ @id = ENV['PURECLOUD_CLIENT_ID']
878
+ environment = "mypurecloud.com"
879
+
880
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
881
+
882
+ PureCloud.configure do |config|
883
+ config.access_token = @authToken
884
+ end
885
+
886
+ api_instance = PureCloud::VoicemailApi.new
887
+
888
+ group_id = "group_id_example" # String | Group ID
889
+
890
+ body = PureCloud::VoicemailGroupPolicy.new # VoicemailGroupPolicy | The group's voicemail policy
891
+
892
+
893
+ begin
894
+ #Update a group's voicemail policy
895
+ result = api_instance.patch_groups_group_id_policy(group_id, body)
896
+ p result
897
+ rescue PureCloud::ApiError => e
898
+ puts "Exception when calling VoicemailApi->patch_groups_group_id_policy: #{e}"
899
+ end
900
+ ~~~
901
+
902
+ ### Parameters
903
+
904
+ Name | Type | Description | Notes
905
+ ------------- | ------------- | ------------- | -------------
906
+ **group_id** | **String**| Group ID |
907
+ **body** | [**VoicemailGroupPolicy**](VoicemailGroupPolicy.html)| The group&#39;s voicemail policy |
908
+ {: class="table table-striped"}
909
+
910
+
911
+ ### Return type
912
+
913
+ [**VoicemailGroupPolicy**](VoicemailGroupPolicy.html)
914
+
915
+ ### HTTP request headers
916
+
917
+ - **Content-Type**: application/json
918
+ - **Accept**: application/json
919
+
920
+
921
+
922
+ <a name="patch_me_policy"></a>
923
+
924
+ ## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) patch_me_policy(body)
925
+
926
+ Update the current user's voicemail policy
927
+
928
+
929
+
930
+ ### Example
931
+ ~~~ruby
932
+ # load the gem
933
+ require 'purecloud'
934
+ # setup authorization
935
+ @secret = ENV['PURECLOUD_SECRET']
936
+ @id = ENV['PURECLOUD_CLIENT_ID']
937
+ environment = "mypurecloud.com"
938
+
939
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
940
+
941
+ PureCloud.configure do |config|
942
+ config.access_token = @authToken
943
+ end
944
+
945
+ api_instance = PureCloud::VoicemailApi.new
946
+
947
+ body = PureCloud::VoicemailUserPolicy.new # VoicemailUserPolicy | The user's voicemail policy
948
+
949
+
950
+ begin
951
+ #Update the current user's voicemail policy
952
+ result = api_instance.patch_me_policy(body)
953
+ p result
954
+ rescue PureCloud::ApiError => e
955
+ puts "Exception when calling VoicemailApi->patch_me_policy: #{e}"
956
+ end
957
+ ~~~
958
+
959
+ ### Parameters
960
+
961
+ Name | Type | Description | Notes
962
+ ------------- | ------------- | ------------- | -------------
963
+ **body** | [**VoicemailUserPolicy**](VoicemailUserPolicy.html)| The user&#39;s voicemail policy |
964
+ {: class="table table-striped"}
965
+
966
+
967
+ ### Return type
968
+
969
+ [**VoicemailUserPolicy**](VoicemailUserPolicy.html)
970
+
971
+ ### HTTP request headers
972
+
973
+ - **Content-Type**: application/json
974
+ - **Accept**: application/json
975
+
976
+
977
+
452
978
  <a name="patch_userpolicies_user_id"></a>
453
979
 
454
980
  ## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) patch_userpolicies_user_id(user_id, body)
@@ -508,6 +1034,119 @@ Name | Type | Description | Notes
508
1034
 
509
1035
 
510
1036
 
1037
+ <a name="post_messages"></a>
1038
+
1039
+ ## -[**VoicemailMessage**](VoicemailMessage.html) post_messages(opts)
1040
+
1041
+ Copy a voicemail message to a user or group
1042
+
1043
+
1044
+
1045
+ ### Example
1046
+ ~~~ruby
1047
+ # load the gem
1048
+ require 'purecloud'
1049
+ # setup authorization
1050
+ @secret = ENV['PURECLOUD_SECRET']
1051
+ @id = ENV['PURECLOUD_CLIENT_ID']
1052
+ environment = "mypurecloud.com"
1053
+
1054
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1055
+
1056
+ PureCloud.configure do |config|
1057
+ config.access_token = @authToken
1058
+ end
1059
+
1060
+ api_instance = PureCloud::VoicemailApi.new
1061
+
1062
+ opts = {
1063
+ body: PureCloud::CopyVoicemailMessage.new # CopyVoicemailMessage |
1064
+ }
1065
+
1066
+ begin
1067
+ #Copy a voicemail message to a user or group
1068
+ result = api_instance.post_messages(opts)
1069
+ p result
1070
+ rescue PureCloud::ApiError => e
1071
+ puts "Exception when calling VoicemailApi->post_messages: #{e}"
1072
+ end
1073
+ ~~~
1074
+
1075
+ ### Parameters
1076
+
1077
+ Name | Type | Description | Notes
1078
+ ------------- | ------------- | ------------- | -------------
1079
+ **body** | [**CopyVoicemailMessage**](CopyVoicemailMessage.html)| | [optional]
1080
+ {: class="table table-striped"}
1081
+
1082
+
1083
+ ### Return type
1084
+
1085
+ [**VoicemailMessage**](VoicemailMessage.html)
1086
+
1087
+ ### HTTP request headers
1088
+
1089
+ - **Content-Type**: application/json
1090
+ - **Accept**: application/json
1091
+
1092
+
1093
+
1094
+ <a name="post_search"></a>
1095
+
1096
+ ## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) post_search(body)
1097
+
1098
+ Search voicemails
1099
+
1100
+
1101
+
1102
+ ### Example
1103
+ ~~~ruby
1104
+ # load the gem
1105
+ require 'purecloud'
1106
+ # setup authorization
1107
+ @secret = ENV['PURECLOUD_SECRET']
1108
+ @id = ENV['PURECLOUD_CLIENT_ID']
1109
+ environment = "mypurecloud.com"
1110
+
1111
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1112
+
1113
+ PureCloud.configure do |config|
1114
+ config.access_token = @authToken
1115
+ end
1116
+
1117
+ api_instance = PureCloud::VoicemailApi.new
1118
+
1119
+ body = PureCloud::VoicemailSearchRequest.new # VoicemailSearchRequest | Search request options
1120
+
1121
+
1122
+ begin
1123
+ #Search voicemails
1124
+ result = api_instance.post_search(body)
1125
+ p result
1126
+ rescue PureCloud::ApiError => e
1127
+ puts "Exception when calling VoicemailApi->post_search: #{e}"
1128
+ end
1129
+ ~~~
1130
+
1131
+ ### Parameters
1132
+
1133
+ Name | Type | Description | Notes
1134
+ ------------- | ------------- | ------------- | -------------
1135
+ **body** | [**VoicemailSearchRequest**](VoicemailSearchRequest.html)| Search request options |
1136
+ {: class="table table-striped"}
1137
+
1138
+
1139
+ ### Return type
1140
+
1141
+ [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html)
1142
+
1143
+ ### HTTP request headers
1144
+
1145
+ - **Content-Type**: application/json
1146
+ - **Accept**: application/json
1147
+
1148
+
1149
+
511
1150
  <a name="put_messages_message_id"></a>
512
1151
 
513
1152
  ## -[**VoicemailMessage**](VoicemailMessage.html) put_messages_message_id(message_id, body)