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: RoutingStatusAlertContainer
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: RoutingStatusRuleContainer
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: RuleSetEntityListing
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: SchemaCategoryEntityListing
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: SchemaReferenceEntityListing
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: ScreenRecordingSessionListing
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: ScriptEntityListing
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] |
@@ -12,11 +12,13 @@ Method | HTTP request | Description
12
12
  |[**get_search_0**](SearchApi.html#get_search_0) | **GET** /api/v2/locations/search | Search locations using the q64 value returned from a previous search|
13
13
  |[**get_search_1**](SearchApi.html#get_search_1) | **GET** /api/v2/search | Search using the q64 value returned from a previous search.|
14
14
  |[**get_search_2**](SearchApi.html#get_search_2) | **GET** /api/v2/users/search | Search users using the q64 value returned from a previous search|
15
+ |[**get_search_3**](SearchApi.html#get_search_3) | **GET** /api/v2/voicemail/search | Search voicemails using the q64 value returned from a previous search|
15
16
  |[**get_suggest**](SearchApi.html#get_suggest) | **GET** /api/v2/search/suggest | Suggest resources using the q64 value returned from a previous suggest query.|
16
17
  |[**post_search**](SearchApi.html#post_search) | **POST** /api/v2/groups/search | Search groups|
17
18
  |[**post_search_0**](SearchApi.html#post_search_0) | **POST** /api/v2/locations/search | Search locations|
18
19
  |[**post_search_1**](SearchApi.html#post_search_1) | **POST** /api/v2/search | Search resources.|
19
20
  |[**post_search_2**](SearchApi.html#post_search_2) | **POST** /api/v2/users/search | Search users|
21
+ |[**post_search_3**](SearchApi.html#post_search_3) | **POST** /api/v2/voicemail/search | Search voicemails|
20
22
  |[**post_suggest**](SearchApi.html#post_suggest) | **POST** /api/v2/search/suggest | Suggest resources.|
21
23
  {: class="table table-striped"}
22
24
 
@@ -168,7 +170,7 @@ api_instance = PureCloud::SearchApi.new
168
170
  q64 = "q64_example" # String | q64
169
171
 
170
172
  opts = {
171
- expand: ["expand_example"], # Array<String> | expand
173
+ expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
172
174
  profile: true # BOOLEAN | profile
173
175
  }
174
176
 
@@ -186,7 +188,7 @@ end
186
188
  Name | Type | Description | Notes
187
189
  ------------- | ------------- | ------------- | -------------
188
190
  **q64** | **String**| q64 |
189
- **expand** | [**Array&lt;String&gt;**](String.html)| expand | [optional]
191
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional]
190
192
  **profile** | **BOOLEAN**| profile | [optional] [default to true]
191
193
  {: class="table table-striped"}
192
194
 
@@ -262,6 +264,66 @@ Name | Type | Description | Notes
262
264
 
263
265
 
264
266
 
267
+ <a name="get_search_3"></a>
268
+
269
+ ## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_search_3(q64, opts)
270
+
271
+ Search voicemails using the q64 value returned from a previous search
272
+
273
+
274
+
275
+ ### Example
276
+ ~~~ruby
277
+ # load the gem
278
+ require 'purecloud'
279
+ # setup authorization
280
+ @secret = ENV['PURECLOUD_SECRET']
281
+ @id = ENV['PURECLOUD_CLIENT_ID']
282
+ environment = "mypurecloud.com"
283
+
284
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
285
+
286
+ PureCloud.configure do |config|
287
+ config.access_token = @authToken
288
+ end
289
+
290
+ api_instance = PureCloud::SearchApi.new
291
+
292
+ q64 = "q64_example" # String | q64
293
+
294
+ opts = {
295
+ expand: ["expand_example"] # Array<String> | expand
296
+ }
297
+
298
+ begin
299
+ #Search voicemails using the q64 value returned from a previous search
300
+ result = api_instance.get_search_3(q64, opts)
301
+ p result
302
+ rescue PureCloud::ApiError => e
303
+ puts "Exception when calling SearchApi->get_search_3: #{e}"
304
+ end
305
+ ~~~
306
+
307
+ ### Parameters
308
+
309
+ Name | Type | Description | Notes
310
+ ------------- | ------------- | ------------- | -------------
311
+ **q64** | **String**| q64 |
312
+ **expand** | [**Array&lt;String&gt;**](String.html)| expand | [optional]
313
+ {: class="table table-striped"}
314
+
315
+
316
+ ### Return type
317
+
318
+ [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html)
319
+
320
+ ### HTTP request headers
321
+
322
+ - **Content-Type**: application/json
323
+ - **Accept**: application/json
324
+
325
+
326
+
265
327
  <a name="get_suggest"></a>
266
328
 
267
329
  ## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_suggest(q64, opts)
@@ -290,6 +352,7 @@ api_instance = PureCloud::SearchApi.new
290
352
  q64 = "q64_example" # String | q64
291
353
 
292
354
  opts = {
355
+ expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
293
356
  profile: true # BOOLEAN | profile
294
357
  }
295
358
 
@@ -307,6 +370,7 @@ end
307
370
  Name | Type | Description | Notes
308
371
  ------------- | ------------- | ------------- | -------------
309
372
  **q64** | **String**| q64 |
373
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional]
310
374
  **profile** | **BOOLEAN**| profile | [optional] [default to true]
311
375
  {: class="table table-striped"}
312
376
 
@@ -550,6 +614,62 @@ Name | Type | Description | Notes
550
614
 
551
615
 
552
616
 
617
+ <a name="post_search_3"></a>
618
+
619
+ ## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) post_search_3(body)
620
+
621
+ Search voicemails
622
+
623
+
624
+
625
+ ### Example
626
+ ~~~ruby
627
+ # load the gem
628
+ require 'purecloud'
629
+ # setup authorization
630
+ @secret = ENV['PURECLOUD_SECRET']
631
+ @id = ENV['PURECLOUD_CLIENT_ID']
632
+ environment = "mypurecloud.com"
633
+
634
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
635
+
636
+ PureCloud.configure do |config|
637
+ config.access_token = @authToken
638
+ end
639
+
640
+ api_instance = PureCloud::SearchApi.new
641
+
642
+ body = PureCloud::VoicemailSearchRequest.new # VoicemailSearchRequest | Search request options
643
+
644
+
645
+ begin
646
+ #Search voicemails
647
+ result = api_instance.post_search_3(body)
648
+ p result
649
+ rescue PureCloud::ApiError => e
650
+ puts "Exception when calling SearchApi->post_search_3: #{e}"
651
+ end
652
+ ~~~
653
+
654
+ ### Parameters
655
+
656
+ Name | Type | Description | Notes
657
+ ------------- | ------------- | ------------- | -------------
658
+ **body** | [**VoicemailSearchRequest**](VoicemailSearchRequest.html)| Search request options |
659
+ {: class="table table-striped"}
660
+
661
+
662
+ ### Return type
663
+
664
+ [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html)
665
+
666
+ ### HTTP request headers
667
+
668
+ - **Content-Type**: application/json
669
+ - **Accept**: application/json
670
+
671
+
672
+
553
673
  <a name="post_suggest"></a>
554
674
 
555
675
  ## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_suggest(body, opts)
@@ -11,8 +11,8 @@ title: SecurityProfileEntityListing
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: ShareEntityListing
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: SiteEntityListing
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: SkillEntityListing
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: StationEntityListing
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] |
@@ -42,7 +42,7 @@ api_instance = PureCloud::SuggestApi.new
42
42
  q64 = "q64_example" # String | q64
43
43
 
44
44
  opts = {
45
- expand: ["expand_example"], # Array<String> | expand
45
+ expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
46
46
  profile: true # BOOLEAN | profile
47
47
  }
48
48
 
@@ -60,7 +60,7 @@ end
60
60
  Name | Type | Description | Notes
61
61
  ------------- | ------------- | ------------- | -------------
62
62
  **q64** | **String**| q64 |
63
- **expand** | [**Array&lt;String&gt;**](String.html)| expand | [optional]
63
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional]
64
64
  **profile** | **BOOLEAN**| profile | [optional] [default to true]
65
65
  {: class="table table-striped"}
66
66
 
@@ -104,6 +104,7 @@ api_instance = PureCloud::SuggestApi.new
104
104
  q64 = "q64_example" # String | q64
105
105
 
106
106
  opts = {
107
+ expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
107
108
  profile: true # BOOLEAN | profile
108
109
  }
109
110
 
@@ -121,6 +122,7 @@ end
121
122
  Name | Type | Description | Notes
122
123
  ------------- | ------------- | ------------- | -------------
123
124
  **q64** | **String**| q64 |
125
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional]
124
126
  **profile** | **BOOLEAN**| profile | [optional] [default to true]
125
127
  {: class="table table-striped"}
126
128
 
@@ -7,6 +7,7 @@ title: SuggestSearchRequest
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
+ | **expand** | **Array&lt;String&gt;** | Provides more details about a specified resource | [optional] |
10
11
  | **types** | **Array&lt;String&gt;** | Resource domain type to search | |
11
12
  | **query** | [**Array&lt;SuggestSearchCriteria&gt;**](SuggestSearchCriteria.html) | Suggest query | |
12
13
  {: class="table table-striped"}
@@ -11,8 +11,8 @@ title: TagValueEntityListing
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] |
@@ -882,7 +882,8 @@ opts = {
882
882
  name: "name_example", # String | Name
883
883
  site_id: "site_id_example", # String | Filter by site.id
884
884
  edge_group_id: "edge_group_id_example", # String | Filter by edgeGroup.id
885
- sort_by: "name" # String | Sort by
885
+ sort_by: "name", # String | Sort by
886
+ managed: true # BOOLEAN | Filter by managed
886
887
  }
887
888
 
888
889
  begin
@@ -904,6 +905,7 @@ Name | Type | Description | Notes
904
905
  **site_id** | **String**| Filter by site.id | [optional]
905
906
  **edge_group_id** | **String**| Filter by edgeGroup.id | [optional]
906
907
  **sort_by** | **String**| Sort by | [optional] [default to name]
908
+ **managed** | **BOOLEAN**| Filter by managed | [optional]
907
909
  {: class="table table-striped"}
908
910
 
909
911
 
@@ -1987,7 +1989,8 @@ opts = {
1987
1989
  page_size: 25, # Integer | Page size
1988
1990
  page_number: 1, # Integer | Page number
1989
1991
  name: "name_example", # String | Name
1990
- sort_by: "name" # String | Sort by
1992
+ sort_by: "name", # String | Sort by
1993
+ managed: true # BOOLEAN | Filter by managed
1991
1994
  }
1992
1995
 
1993
1996
  begin
@@ -2007,6 +2010,7 @@ Name | Type | Description | Notes
2007
2010
  **page_number** | **Integer**| Page number | [optional] [default to 1]
2008
2011
  **name** | **String**| Name | [optional]
2009
2012
  **sort_by** | **String**| Sort by | [optional] [default to name]
2013
+ **managed** | **BOOLEAN**| Filter by managed | [optional]
2010
2014
  {: class="table table-striped"}
2011
2015
 
2012
2016
 
@@ -3367,7 +3371,8 @@ opts = {
3367
3371
  sort_by: "name", # String | Sort by
3368
3372
  sort_order: "ASC", # String | Sort order
3369
3373
  name: "name_example", # String | Name
3370
- location_id: "location_id_example" # String | Location Id
3374
+ location_id: "location_id_example", # String | Location Id
3375
+ managed: true # BOOLEAN | Filter by managed
3371
3376
  }
3372
3377
 
3373
3378
  begin
@@ -3389,6 +3394,7 @@ Name | Type | Description | Notes
3389
3394
  **sort_order** | **String**| Sort order | [optional] [default to ASC]
3390
3395
  **name** | **String**| Name | [optional]
3391
3396
  **location_id** | **String**| Location Id | [optional]
3397
+ **managed** | **BOOLEAN**| Filter by managed | [optional]
3392
3398
  {: class="table table-striped"}
3393
3399
 
3394
3400
 
@@ -3724,6 +3730,8 @@ opts = {
3724
3730
  sort_by: "name", # String | Value by which to sort
3725
3731
  sort_order: "ASC", # String | Sort order
3726
3732
  recording_enabled: true, # BOOLEAN | Filter trunks by recording enabled
3733
+ ignore_hidden: true, # BOOLEAN | Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.
3734
+ managed: true, # BOOLEAN | Filter by managed
3727
3735
  expand: ["expand_example"] # Array<String> | Fields to expand in the response, comma-separated
3728
3736
  }
3729
3737
 
@@ -3745,6 +3753,8 @@ Name | Type | Description | Notes
3745
3753
  **sort_by** | **String**| Value by which to sort | [optional] [default to name]
3746
3754
  **sort_order** | **String**| Sort order | [optional] [default to ASC]
3747
3755
  **recording_enabled** | **BOOLEAN**| Filter trunks by recording enabled | [optional]
3756
+ **ignore_hidden** | **BOOLEAN**| Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only. | [optional]
3757
+ **managed** | **BOOLEAN**| Filter by managed | [optional]
3748
3758
  **expand** | [**Array&lt;String&gt;**](String.html)| Fields to expand in the response, comma-separated | [optional]
3749
3759
  {: class="table table-striped"}
3750
3760
 
@@ -3879,7 +3889,7 @@ Name | Type | Description | Notes
3879
3889
 
3880
3890
  <a name="get_providers_edges_trunkbasesettings_trunkbasesettings_id"></a>
3881
3891
 
3882
- ## -[**TrunkBase**](TrunkBase.html) get_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id)
3892
+ ## -[**TrunkBase**](TrunkBase.html) get_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id, opts)
3883
3893
 
3884
3894
  Get a Trunk Base Settings object by ID
3885
3895
 
@@ -3904,10 +3914,13 @@ api_instance = PureCloud::TelephonyProvidersEdgeApi.new
3904
3914
 
3905
3915
  trunk_base_settings_id = "trunk_base_settings_id_example" # String | Trunk Base ID
3906
3916
 
3917
+ opts = {
3918
+ ignore_hidden: true # BOOLEAN | Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.
3919
+ }
3907
3920
 
3908
3921
  begin
3909
3922
  #Get a Trunk Base Settings object by ID
3910
- result = api_instance.get_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id)
3923
+ result = api_instance.get_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id, opts)
3911
3924
  p result
3912
3925
  rescue PureCloud::ApiError => e
3913
3926
  puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunkbasesettings_trunkbasesettings_id: #{e}"
@@ -3919,6 +3932,7 @@ end
3919
3932
  Name | Type | Description | Notes
3920
3933
  ------------- | ------------- | ------------- | -------------
3921
3934
  **trunk_base_settings_id** | **String**| Trunk Base ID |
3935
+ **ignore_hidden** | **BOOLEAN**| Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only. | [optional]
3922
3936
  {: class="table table-striped"}
3923
3937
 
3924
3938