purecloud 0.60.1 → 0.61.1

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -28,7 +28,7 @@ module PureCloud
28
28
  #
29
29
  # @param q64 q64
30
30
  # @param [Hash] opts the optional parameters
31
- # @option opts [Array<String>] :expand expand
31
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
32
32
  # @option opts [BOOLEAN] :profile profile (default to true)
33
33
  # @return [JsonNodeSearchResponse]
34
34
  def get_search(q64, opts = {})
@@ -40,7 +40,7 @@ module PureCloud
40
40
  #
41
41
  # @param q64 q64
42
42
  # @param [Hash] opts the optional parameters
43
- # @option opts [Array<String>] :expand expand
43
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
44
44
  # @option opts [BOOLEAN] :profile profile
45
45
  # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
46
46
  def get_search_with_http_info(q64, opts = {})
@@ -95,6 +95,7 @@ module PureCloud
95
95
  #
96
96
  # @param q64 q64
97
97
  # @param [Hash] opts the optional parameters
98
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
98
99
  # @option opts [BOOLEAN] :profile profile (default to true)
99
100
  # @return [JsonNodeSearchResponse]
100
101
  def get_suggest(q64, opts = {})
@@ -106,6 +107,7 @@ module PureCloud
106
107
  #
107
108
  # @param q64 q64
108
109
  # @param [Hash] opts the optional parameters
110
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
109
111
  # @option opts [BOOLEAN] :profile profile
110
112
  # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
111
113
  def get_suggest_with_http_info(q64, opts = {})
@@ -122,6 +124,7 @@ module PureCloud
122
124
  # query parameters
123
125
  query_params = {}
124
126
  query_params[:'q64'] = q64
127
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
125
128
  query_params[:'profile'] = opts[:'profile'] if opts[:'profile']
126
129
 
127
130
  # header parameters
@@ -817,6 +817,7 @@ module PureCloud
817
817
  # @option opts [String] :site_id Filter by site.id
818
818
  # @option opts [String] :edge_group_id Filter by edgeGroup.id
819
819
  # @option opts [String] :sort_by Sort by (default to name)
820
+ # @option opts [BOOLEAN] :managed Filter by managed
820
821
  # @return [EdgeEntityListing]
821
822
  def get_providers_edges(opts = {})
822
823
  data, status_code, headers = get_providers_edges_with_http_info(opts)
@@ -832,6 +833,7 @@ module PureCloud
832
833
  # @option opts [String] :site_id Filter by site.id
833
834
  # @option opts [String] :edge_group_id Filter by edgeGroup.id
834
835
  # @option opts [String] :sort_by Sort by
836
+ # @option opts [BOOLEAN] :managed Filter by managed
835
837
  # @return [Array<(EdgeEntityListing, Fixnum, Hash)>] EdgeEntityListing data, response status code and response headers
836
838
  def get_providers_edges_with_http_info(opts = {})
837
839
  if @api_client.config.debugging
@@ -849,6 +851,7 @@ module PureCloud
849
851
  query_params[:'site.id'] = opts[:'site_id'] if opts[:'site_id']
850
852
  query_params[:'edgeGroup.id'] = opts[:'edge_group_id'] if opts[:'edge_group_id']
851
853
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
854
+ query_params[:'managed'] = opts[:'managed'] if opts[:'managed']
852
855
 
853
856
  # header parameters
854
857
  header_params = {}
@@ -2007,6 +2010,7 @@ module PureCloud
2007
2010
  # @option opts [Integer] :page_number Page number (default to 1)
2008
2011
  # @option opts [String] :name Name
2009
2012
  # @option opts [String] :sort_by Sort by (default to name)
2013
+ # @option opts [BOOLEAN] :managed Filter by managed
2010
2014
  # @return [EdgeGroupEntityListing]
2011
2015
  def get_providers_edges_edgegroups(opts = {})
2012
2016
  data, status_code, headers = get_providers_edges_edgegroups_with_http_info(opts)
@@ -2020,6 +2024,7 @@ module PureCloud
2020
2024
  # @option opts [Integer] :page_number Page number
2021
2025
  # @option opts [String] :name Name
2022
2026
  # @option opts [String] :sort_by Sort by
2027
+ # @option opts [BOOLEAN] :managed Filter by managed
2023
2028
  # @return [Array<(EdgeGroupEntityListing, Fixnum, Hash)>] EdgeGroupEntityListing data, response status code and response headers
2024
2029
  def get_providers_edges_edgegroups_with_http_info(opts = {})
2025
2030
  if @api_client.config.debugging
@@ -2035,6 +2040,7 @@ module PureCloud
2035
2040
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2036
2041
  query_params[:'name'] = opts[:'name'] if opts[:'name']
2037
2042
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
2043
+ query_params[:'managed'] = opts[:'managed'] if opts[:'managed']
2038
2044
 
2039
2045
  # header parameters
2040
2046
  header_params = {}
@@ -3493,6 +3499,7 @@ module PureCloud
3493
3499
  # @option opts [String] :sort_order Sort order (default to ASC)
3494
3500
  # @option opts [String] :name Name
3495
3501
  # @option opts [String] :location_id Location Id
3502
+ # @option opts [BOOLEAN] :managed Filter by managed
3496
3503
  # @return [SiteEntityListing]
3497
3504
  def get_providers_edges_sites(opts = {})
3498
3505
  data, status_code, headers = get_providers_edges_sites_with_http_info(opts)
@@ -3508,6 +3515,7 @@ module PureCloud
3508
3515
  # @option opts [String] :sort_order Sort order
3509
3516
  # @option opts [String] :name Name
3510
3517
  # @option opts [String] :location_id Location Id
3518
+ # @option opts [BOOLEAN] :managed Filter by managed
3511
3519
  # @return [Array<(SiteEntityListing, Fixnum, Hash)>] SiteEntityListing data, response status code and response headers
3512
3520
  def get_providers_edges_sites_with_http_info(opts = {})
3513
3521
  if @api_client.config.debugging
@@ -3525,6 +3533,7 @@ module PureCloud
3525
3533
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
3526
3534
  query_params[:'name'] = opts[:'name'] if opts[:'name']
3527
3535
  query_params[:'location.id'] = opts[:'location_id'] if opts[:'location_id']
3536
+ query_params[:'managed'] = opts[:'managed'] if opts[:'managed']
3528
3537
 
3529
3538
  # header parameters
3530
3539
  header_params = {}
@@ -3874,6 +3883,8 @@ module PureCloud
3874
3883
  # @option opts [String] :sort_by Value by which to sort (default to name)
3875
3884
  # @option opts [String] :sort_order Sort order (default to ASC)
3876
3885
  # @option opts [BOOLEAN] :recording_enabled Filter trunks by recording enabled
3886
+ # @option opts [BOOLEAN] :ignore_hidden Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.
3887
+ # @option opts [BOOLEAN] :managed Filter by managed
3877
3888
  # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
3878
3889
  # @return [TrunkBaseEntityListing]
3879
3890
  def get_providers_edges_trunkbasesettings(opts = {})
@@ -3889,6 +3900,8 @@ module PureCloud
3889
3900
  # @option opts [String] :sort_by Value by which to sort
3890
3901
  # @option opts [String] :sort_order Sort order
3891
3902
  # @option opts [BOOLEAN] :recording_enabled Filter trunks by recording enabled
3903
+ # @option opts [BOOLEAN] :ignore_hidden Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.
3904
+ # @option opts [BOOLEAN] :managed Filter by managed
3892
3905
  # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
3893
3906
  # @return [Array<(TrunkBaseEntityListing, Fixnum, Hash)>] TrunkBaseEntityListing data, response status code and response headers
3894
3907
  def get_providers_edges_trunkbasesettings_with_http_info(opts = {})
@@ -3906,6 +3919,8 @@ module PureCloud
3906
3919
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
3907
3920
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
3908
3921
  query_params[:'recordingEnabled'] = opts[:'recording_enabled'] if opts[:'recording_enabled']
3922
+ query_params[:'ignoreHidden'] = opts[:'ignore_hidden'] if opts[:'ignore_hidden']
3923
+ query_params[:'managed'] = opts[:'managed'] if opts[:'managed']
3909
3924
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
3910
3925
 
3911
3926
  # header parameters
@@ -4072,6 +4087,7 @@ module PureCloud
4072
4087
  # Managed properties will not be returned unless the user is assigned the managed:all:all permission.
4073
4088
  # @param trunk_base_settings_id Trunk Base ID
4074
4089
  # @param [Hash] opts the optional parameters
4090
+ # @option opts [BOOLEAN] :ignore_hidden Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.
4075
4091
  # @return [TrunkBase]
4076
4092
  def get_providers_edges_trunkbasesettings_trunkbasesettings_id(trunk_base_settings_id, opts = {})
4077
4093
  data, status_code, headers = get_providers_edges_trunkbasesettings_trunkbasesettings_id_with_http_info(trunk_base_settings_id, opts)
@@ -4082,6 +4098,7 @@ module PureCloud
4082
4098
  # Managed properties will not be returned unless the user is assigned the managed:all:all permission.
4083
4099
  # @param trunk_base_settings_id Trunk Base ID
4084
4100
  # @param [Hash] opts the optional parameters
4101
+ # @option opts [BOOLEAN] :ignore_hidden Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.
4085
4102
  # @return [Array<(TrunkBase, Fixnum, Hash)>] TrunkBase data, response status code and response headers
4086
4103
  def get_providers_edges_trunkbasesettings_trunkbasesettings_id_with_http_info(trunk_base_settings_id, opts = {})
4087
4104
  if @api_client.config.debugging
@@ -4096,6 +4113,7 @@ module PureCloud
4096
4113
 
4097
4114
  # query parameters
4098
4115
  query_params = {}
4116
+ query_params[:'ignoreHidden'] = opts[:'ignore_hidden'] if opts[:'ignore_hidden']
4099
4117
 
4100
4118
  # header parameters
4101
4119
  header_params = {}
@@ -139,7 +139,193 @@ module PureCloud
139
139
  return data, status_code, headers
140
140
  end
141
141
 
142
- # Get mailbox information
142
+ # Get the group's mailbox information
143
+ #
144
+ # @param group_id groupId
145
+ # @param [Hash] opts the optional parameters
146
+ # @return [VoicemailMailboxInfo]
147
+ def get_groups_group_id_mailbox(group_id, opts = {})
148
+ data, status_code, headers = get_groups_group_id_mailbox_with_http_info(group_id, opts)
149
+ return data
150
+ end
151
+
152
+ # Get the group&#39;s mailbox information
153
+ #
154
+ # @param group_id groupId
155
+ # @param [Hash] opts the optional parameters
156
+ # @return [Array<(VoicemailMailboxInfo, Fixnum, Hash)>] VoicemailMailboxInfo data, response status code and response headers
157
+ def get_groups_group_id_mailbox_with_http_info(group_id, opts = {})
158
+ if @api_client.config.debugging
159
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_groups_group_id_mailbox ..."
160
+ end
161
+
162
+ # verify the required parameter 'group_id' is set
163
+ fail "Missing the required parameter 'group_id' when calling get_groups_group_id_mailbox" if group_id.nil?
164
+
165
+ # resource path
166
+ local_var_path = "/api/v2/voicemail/groups/{groupId}/mailbox".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
167
+
168
+ # query parameters
169
+ query_params = {}
170
+
171
+ # header parameters
172
+ header_params = {}
173
+
174
+ # HTTP header 'Accept' (if needed)
175
+ _header_accept = ['application/json']
176
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
177
+
178
+ # HTTP header 'Content-Type'
179
+ _header_content_type = ['application/json']
180
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
181
+
182
+ # form parameters
183
+ form_params = {}
184
+
185
+ # http body (model)
186
+ post_body = nil
187
+
188
+ auth_names = ['PureCloud Auth']
189
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
190
+ :header_params => header_params,
191
+ :query_params => query_params,
192
+ :form_params => form_params,
193
+ :body => post_body,
194
+ :auth_names => auth_names,
195
+ :return_type => 'VoicemailMailboxInfo')
196
+ if @api_client.config.debugging
197
+ @api_client.config.logger.debug "API called: VoicemailApi#get_groups_group_id_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
198
+ end
199
+ return data, status_code, headers
200
+ end
201
+
202
+ # List voicemail messages
203
+ #
204
+ # @param group_id Group ID
205
+ # @param [Hash] opts the optional parameters
206
+ # @option opts [Integer] :page_size Page size (default to 25)
207
+ # @option opts [Integer] :page_number Page number (default to 1)
208
+ # @return [VoicemailMessageEntityListing]
209
+ def get_groups_group_id_messages(group_id, opts = {})
210
+ data, status_code, headers = get_groups_group_id_messages_with_http_info(group_id, opts)
211
+ return data
212
+ end
213
+
214
+ # List voicemail messages
215
+ #
216
+ # @param group_id Group ID
217
+ # @param [Hash] opts the optional parameters
218
+ # @option opts [Integer] :page_size Page size
219
+ # @option opts [Integer] :page_number Page number
220
+ # @return [Array<(VoicemailMessageEntityListing, Fixnum, Hash)>] VoicemailMessageEntityListing data, response status code and response headers
221
+ def get_groups_group_id_messages_with_http_info(group_id, opts = {})
222
+ if @api_client.config.debugging
223
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_groups_group_id_messages ..."
224
+ end
225
+
226
+ # verify the required parameter 'group_id' is set
227
+ fail "Missing the required parameter 'group_id' when calling get_groups_group_id_messages" if group_id.nil?
228
+
229
+ # resource path
230
+ local_var_path = "/api/v2/voicemail/groups/{groupId}/messages".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
231
+
232
+ # query parameters
233
+ query_params = {}
234
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
235
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
236
+
237
+ # header parameters
238
+ header_params = {}
239
+
240
+ # HTTP header 'Accept' (if needed)
241
+ _header_accept = ['application/json']
242
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
243
+
244
+ # HTTP header 'Content-Type'
245
+ _header_content_type = ['application/json']
246
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
247
+
248
+ # form parameters
249
+ form_params = {}
250
+
251
+ # http body (model)
252
+ post_body = nil
253
+
254
+ auth_names = ['PureCloud Auth']
255
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
256
+ :header_params => header_params,
257
+ :query_params => query_params,
258
+ :form_params => form_params,
259
+ :body => post_body,
260
+ :auth_names => auth_names,
261
+ :return_type => 'VoicemailMessageEntityListing')
262
+ if @api_client.config.debugging
263
+ @api_client.config.logger.debug "API called: VoicemailApi#get_groups_group_id_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
264
+ end
265
+ return data, status_code, headers
266
+ end
267
+
268
+ # Get a group's voicemail policy
269
+ #
270
+ # @param group_id Group ID
271
+ # @param [Hash] opts the optional parameters
272
+ # @return [VoicemailGroupPolicy]
273
+ def get_groups_group_id_policy(group_id, opts = {})
274
+ data, status_code, headers = get_groups_group_id_policy_with_http_info(group_id, opts)
275
+ return data
276
+ end
277
+
278
+ # Get a group&#39;s voicemail policy
279
+ #
280
+ # @param group_id Group ID
281
+ # @param [Hash] opts the optional parameters
282
+ # @return [Array<(VoicemailGroupPolicy, Fixnum, Hash)>] VoicemailGroupPolicy data, response status code and response headers
283
+ def get_groups_group_id_policy_with_http_info(group_id, opts = {})
284
+ if @api_client.config.debugging
285
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_groups_group_id_policy ..."
286
+ end
287
+
288
+ # verify the required parameter 'group_id' is set
289
+ fail "Missing the required parameter 'group_id' when calling get_groups_group_id_policy" if group_id.nil?
290
+
291
+ # resource path
292
+ local_var_path = "/api/v2/voicemail/groups/{groupId}/policy".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
293
+
294
+ # query parameters
295
+ query_params = {}
296
+
297
+ # header parameters
298
+ header_params = {}
299
+
300
+ # HTTP header 'Accept' (if needed)
301
+ _header_accept = ['application/json']
302
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
303
+
304
+ # HTTP header 'Content-Type'
305
+ _header_content_type = ['application/json']
306
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
307
+
308
+ # form parameters
309
+ form_params = {}
310
+
311
+ # http body (model)
312
+ post_body = nil
313
+
314
+ auth_names = ['PureCloud Auth']
315
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
316
+ :header_params => header_params,
317
+ :query_params => query_params,
318
+ :form_params => form_params,
319
+ :body => post_body,
320
+ :auth_names => auth_names,
321
+ :return_type => 'VoicemailGroupPolicy')
322
+ if @api_client.config.debugging
323
+ @api_client.config.logger.debug "API called: VoicemailApi#get_groups_group_id_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
324
+ end
325
+ return data, status_code, headers
326
+ end
327
+
328
+ # Get the current user's mailbox information
143
329
  #
144
330
  # @param [Hash] opts the optional parameters
145
331
  # @return [VoicemailMailboxInfo]
@@ -148,17 +334,188 @@ module PureCloud
148
334
  return data
149
335
  end
150
336
 
151
- # Get mailbox information
337
+ # Get the current user&#39;s mailbox information
338
+ #
339
+ # @param [Hash] opts the optional parameters
340
+ # @return [Array<(VoicemailMailboxInfo, Fixnum, Hash)>] VoicemailMailboxInfo data, response status code and response headers
341
+ def get_mailbox_with_http_info(opts = {})
342
+ if @api_client.config.debugging
343
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_mailbox ..."
344
+ end
345
+
346
+ # resource path
347
+ local_var_path = "/api/v2/voicemail/mailbox".sub('{format}','json')
348
+
349
+ # query parameters
350
+ query_params = {}
351
+
352
+ # header parameters
353
+ header_params = {}
354
+
355
+ # HTTP header 'Accept' (if needed)
356
+ _header_accept = ['application/json']
357
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
358
+
359
+ # HTTP header 'Content-Type'
360
+ _header_content_type = ['application/json']
361
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
362
+
363
+ # form parameters
364
+ form_params = {}
365
+
366
+ # http body (model)
367
+ post_body = nil
368
+
369
+ auth_names = ['PureCloud Auth']
370
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
371
+ :header_params => header_params,
372
+ :query_params => query_params,
373
+ :form_params => form_params,
374
+ :body => post_body,
375
+ :auth_names => auth_names,
376
+ :return_type => 'VoicemailMailboxInfo')
377
+ if @api_client.config.debugging
378
+ @api_client.config.logger.debug "API called: VoicemailApi#get_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
379
+ end
380
+ return data, status_code, headers
381
+ end
382
+
383
+ # Get the current user's mailbox information
384
+ #
385
+ # @param [Hash] opts the optional parameters
386
+ # @return [VoicemailMailboxInfo]
387
+ def get_me_mailbox(opts = {})
388
+ data, status_code, headers = get_me_mailbox_with_http_info(opts)
389
+ return data
390
+ end
391
+
392
+ # Get the current user&#39;s mailbox information
393
+ #
394
+ # @param [Hash] opts the optional parameters
395
+ # @return [Array<(VoicemailMailboxInfo, Fixnum, Hash)>] VoicemailMailboxInfo data, response status code and response headers
396
+ def get_me_mailbox_with_http_info(opts = {})
397
+ if @api_client.config.debugging
398
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_me_mailbox ..."
399
+ end
400
+
401
+ # resource path
402
+ local_var_path = "/api/v2/voicemail/me/mailbox".sub('{format}','json')
403
+
404
+ # query parameters
405
+ query_params = {}
406
+
407
+ # header parameters
408
+ header_params = {}
409
+
410
+ # HTTP header 'Accept' (if needed)
411
+ _header_accept = ['application/json']
412
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
413
+
414
+ # HTTP header 'Content-Type'
415
+ _header_content_type = ['application/json']
416
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
417
+
418
+ # form parameters
419
+ form_params = {}
420
+
421
+ # http body (model)
422
+ post_body = nil
423
+
424
+ auth_names = ['PureCloud Auth']
425
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
426
+ :header_params => header_params,
427
+ :query_params => query_params,
428
+ :form_params => form_params,
429
+ :body => post_body,
430
+ :auth_names => auth_names,
431
+ :return_type => 'VoicemailMailboxInfo')
432
+ if @api_client.config.debugging
433
+ @api_client.config.logger.debug "API called: VoicemailApi#get_me_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
434
+ end
435
+ return data, status_code, headers
436
+ end
437
+
438
+ # List voicemail messages
439
+ #
440
+ # @param [Hash] opts the optional parameters
441
+ # @option opts [Integer] :page_size Page size (default to 25)
442
+ # @option opts [Integer] :page_number Page number (default to 1)
443
+ # @return [VoicemailMessageEntityListing]
444
+ def get_me_messages(opts = {})
445
+ data, status_code, headers = get_me_messages_with_http_info(opts)
446
+ return data
447
+ end
448
+
449
+ # List voicemail messages
450
+ #
451
+ # @param [Hash] opts the optional parameters
452
+ # @option opts [Integer] :page_size Page size
453
+ # @option opts [Integer] :page_number Page number
454
+ # @return [Array<(VoicemailMessageEntityListing, Fixnum, Hash)>] VoicemailMessageEntityListing data, response status code and response headers
455
+ def get_me_messages_with_http_info(opts = {})
456
+ if @api_client.config.debugging
457
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_me_messages ..."
458
+ end
459
+
460
+ # resource path
461
+ local_var_path = "/api/v2/voicemail/me/messages".sub('{format}','json')
462
+
463
+ # query parameters
464
+ query_params = {}
465
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
466
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
467
+
468
+ # header parameters
469
+ header_params = {}
470
+
471
+ # HTTP header 'Accept' (if needed)
472
+ _header_accept = ['application/json']
473
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
474
+
475
+ # HTTP header 'Content-Type'
476
+ _header_content_type = ['application/json']
477
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
478
+
479
+ # form parameters
480
+ form_params = {}
481
+
482
+ # http body (model)
483
+ post_body = nil
484
+
485
+ auth_names = ['PureCloud Auth']
486
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
487
+ :header_params => header_params,
488
+ :query_params => query_params,
489
+ :form_params => form_params,
490
+ :body => post_body,
491
+ :auth_names => auth_names,
492
+ :return_type => 'VoicemailMessageEntityListing')
493
+ if @api_client.config.debugging
494
+ @api_client.config.logger.debug "API called: VoicemailApi#get_me_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
495
+ end
496
+ return data, status_code, headers
497
+ end
498
+
499
+ # Get the current user's voicemail policy
500
+ #
501
+ # @param [Hash] opts the optional parameters
502
+ # @return [VoicemailUserPolicy]
503
+ def get_me_policy(opts = {})
504
+ data, status_code, headers = get_me_policy_with_http_info(opts)
505
+ return data
506
+ end
507
+
508
+ # Get the current user&#39;s voicemail policy
152
509
  #
153
510
  # @param [Hash] opts the optional parameters
154
- # @return [Array<(VoicemailMailboxInfo, Fixnum, Hash)>] VoicemailMailboxInfo data, response status code and response headers
155
- def get_mailbox_with_http_info(opts = {})
511
+ # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers
512
+ def get_me_policy_with_http_info(opts = {})
156
513
  if @api_client.config.debugging
157
- @api_client.config.logger.debug "Calling API: VoicemailApi#get_mailbox ..."
514
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_me_policy ..."
158
515
  end
159
516
 
160
517
  # resource path
161
- local_var_path = "/api/v2/voicemail/mailbox".sub('{format}','json')
518
+ local_var_path = "/api/v2/voicemail/me/policy".sub('{format}','json')
162
519
 
163
520
  # query parameters
164
521
  query_params = {}
@@ -187,9 +544,9 @@ module PureCloud
187
544
  :form_params => form_params,
188
545
  :body => post_body,
189
546
  :auth_names => auth_names,
190
- :return_type => 'VoicemailMailboxInfo')
547
+ :return_type => 'VoicemailUserPolicy')
191
548
  if @api_client.config.debugging
192
- @api_client.config.logger.debug "API called: VoicemailApi#get_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
549
+ @api_client.config.logger.debug "API called: VoicemailApi#get_me_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
193
550
  end
194
551
  return data, status_code, headers
195
552
  end
@@ -197,6 +554,7 @@ module PureCloud
197
554
  # List voicemail messages
198
555
  #
199
556
  # @param [Hash] opts the optional parameters
557
+ # @option opts [String] :ids An optional comma separated list of VoicemailMessage ids
200
558
  # @return [VoicemailMessageEntityListing]
201
559
  def get_messages(opts = {})
202
560
  data, status_code, headers = get_messages_with_http_info(opts)
@@ -206,6 +564,7 @@ module PureCloud
206
564
  # List voicemail messages
207
565
  #
208
566
  # @param [Hash] opts the optional parameters
567
+ # @option opts [String] :ids An optional comma separated list of VoicemailMessage ids
209
568
  # @return [Array<(VoicemailMessageEntityListing, Fixnum, Hash)>] VoicemailMessageEntityListing data, response status code and response headers
210
569
  def get_messages_with_http_info(opts = {})
211
570
  if @api_client.config.debugging
@@ -217,6 +576,7 @@ module PureCloud
217
576
 
218
577
  # query parameters
219
578
  query_params = {}
579
+ query_params[:'ids'] = opts[:'ids'] if opts[:'ids']
220
580
 
221
581
  # header parameters
222
582
  header_params = {}
@@ -431,6 +791,70 @@ module PureCloud
431
791
  return data, status_code, headers
432
792
  end
433
793
 
794
+ # Search voicemails using the q64 value returned from a previous search
795
+ #
796
+ # @param q64 q64
797
+ # @param [Hash] opts the optional parameters
798
+ # @option opts [Array<String>] :expand expand
799
+ # @return [VoicemailsSearchResponse]
800
+ def get_search(q64, opts = {})
801
+ data, status_code, headers = get_search_with_http_info(q64, opts)
802
+ return data
803
+ end
804
+
805
+ # Search voicemails using the q64 value returned from a previous search
806
+ #
807
+ # @param q64 q64
808
+ # @param [Hash] opts the optional parameters
809
+ # @option opts [Array<String>] :expand expand
810
+ # @return [Array<(VoicemailsSearchResponse, Fixnum, Hash)>] VoicemailsSearchResponse data, response status code and response headers
811
+ def get_search_with_http_info(q64, opts = {})
812
+ if @api_client.config.debugging
813
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_search ..."
814
+ end
815
+
816
+ # verify the required parameter 'q64' is set
817
+ fail "Missing the required parameter 'q64' when calling get_search" if q64.nil?
818
+
819
+ # resource path
820
+ local_var_path = "/api/v2/voicemail/search".sub('{format}','json')
821
+
822
+ # query parameters
823
+ query_params = {}
824
+ query_params[:'q64'] = q64
825
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
826
+
827
+ # header parameters
828
+ header_params = {}
829
+
830
+ # HTTP header 'Accept' (if needed)
831
+ _header_accept = ['application/json']
832
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
833
+
834
+ # HTTP header 'Content-Type'
835
+ _header_content_type = ['application/json']
836
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
837
+
838
+ # form parameters
839
+ form_params = {}
840
+
841
+ # http body (model)
842
+ post_body = nil
843
+
844
+ auth_names = ['PureCloud Auth']
845
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
846
+ :header_params => header_params,
847
+ :query_params => query_params,
848
+ :form_params => form_params,
849
+ :body => post_body,
850
+ :auth_names => auth_names,
851
+ :return_type => 'VoicemailsSearchResponse')
852
+ if @api_client.config.debugging
853
+ @api_client.config.logger.debug "API called: VoicemailApi#get_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
854
+ end
855
+ return data, status_code, headers
856
+ end
857
+
434
858
  # Get a user's voicemail policy
435
859
  #
436
860
  # @param user_id User ID
@@ -491,6 +915,131 @@ module PureCloud
491
915
  return data, status_code, headers
492
916
  end
493
917
 
918
+ # Update a group's voicemail policy
919
+ #
920
+ # @param group_id Group ID
921
+ # @param body The group&#39;s voicemail policy
922
+ # @param [Hash] opts the optional parameters
923
+ # @return [VoicemailGroupPolicy]
924
+ def patch_groups_group_id_policy(group_id, body, opts = {})
925
+ data, status_code, headers = patch_groups_group_id_policy_with_http_info(group_id, body, opts)
926
+ return data
927
+ end
928
+
929
+ # Update a group&#39;s voicemail policy
930
+ #
931
+ # @param group_id Group ID
932
+ # @param body The group&#39;s voicemail policy
933
+ # @param [Hash] opts the optional parameters
934
+ # @return [Array<(VoicemailGroupPolicy, Fixnum, Hash)>] VoicemailGroupPolicy data, response status code and response headers
935
+ def patch_groups_group_id_policy_with_http_info(group_id, body, opts = {})
936
+ if @api_client.config.debugging
937
+ @api_client.config.logger.debug "Calling API: VoicemailApi#patch_groups_group_id_policy ..."
938
+ end
939
+
940
+ # verify the required parameter 'group_id' is set
941
+ fail "Missing the required parameter 'group_id' when calling patch_groups_group_id_policy" if group_id.nil?
942
+
943
+ # verify the required parameter 'body' is set
944
+ fail "Missing the required parameter 'body' when calling patch_groups_group_id_policy" if body.nil?
945
+
946
+ # resource path
947
+ local_var_path = "/api/v2/voicemail/groups/{groupId}/policy".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
948
+
949
+ # query parameters
950
+ query_params = {}
951
+
952
+ # header parameters
953
+ header_params = {}
954
+
955
+ # HTTP header 'Accept' (if needed)
956
+ _header_accept = ['application/json']
957
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
958
+
959
+ # HTTP header 'Content-Type'
960
+ _header_content_type = ['application/json']
961
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
962
+
963
+ # form parameters
964
+ form_params = {}
965
+
966
+ # http body (model)
967
+ post_body = @api_client.object_to_http_body(body)
968
+
969
+ auth_names = ['PureCloud Auth']
970
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
971
+ :header_params => header_params,
972
+ :query_params => query_params,
973
+ :form_params => form_params,
974
+ :body => post_body,
975
+ :auth_names => auth_names,
976
+ :return_type => 'VoicemailGroupPolicy')
977
+ if @api_client.config.debugging
978
+ @api_client.config.logger.debug "API called: VoicemailApi#patch_groups_group_id_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
979
+ end
980
+ return data, status_code, headers
981
+ end
982
+
983
+ # Update the current user's voicemail policy
984
+ #
985
+ # @param body The user&#39;s voicemail policy
986
+ # @param [Hash] opts the optional parameters
987
+ # @return [VoicemailUserPolicy]
988
+ def patch_me_policy(body, opts = {})
989
+ data, status_code, headers = patch_me_policy_with_http_info(body, opts)
990
+ return data
991
+ end
992
+
993
+ # Update the current user&#39;s voicemail policy
994
+ #
995
+ # @param body The user&#39;s voicemail policy
996
+ # @param [Hash] opts the optional parameters
997
+ # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers
998
+ def patch_me_policy_with_http_info(body, opts = {})
999
+ if @api_client.config.debugging
1000
+ @api_client.config.logger.debug "Calling API: VoicemailApi#patch_me_policy ..."
1001
+ end
1002
+
1003
+ # verify the required parameter 'body' is set
1004
+ fail "Missing the required parameter 'body' when calling patch_me_policy" if body.nil?
1005
+
1006
+ # resource path
1007
+ local_var_path = "/api/v2/voicemail/me/policy".sub('{format}','json')
1008
+
1009
+ # query parameters
1010
+ query_params = {}
1011
+
1012
+ # header parameters
1013
+ header_params = {}
1014
+
1015
+ # HTTP header 'Accept' (if needed)
1016
+ _header_accept = ['application/json']
1017
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1018
+
1019
+ # HTTP header 'Content-Type'
1020
+ _header_content_type = ['application/json']
1021
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1022
+
1023
+ # form parameters
1024
+ form_params = {}
1025
+
1026
+ # http body (model)
1027
+ post_body = @api_client.object_to_http_body(body)
1028
+
1029
+ auth_names = ['PureCloud Auth']
1030
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
1031
+ :header_params => header_params,
1032
+ :query_params => query_params,
1033
+ :form_params => form_params,
1034
+ :body => post_body,
1035
+ :auth_names => auth_names,
1036
+ :return_type => 'VoicemailUserPolicy')
1037
+ if @api_client.config.debugging
1038
+ @api_client.config.logger.debug "API called: VoicemailApi#patch_me_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1039
+ end
1040
+ return data, status_code, headers
1041
+ end
1042
+
494
1043
  # Update a user's voicemail policy
495
1044
  #
496
1045
  # @param user_id User ID
@@ -556,6 +1105,123 @@ module PureCloud
556
1105
  return data, status_code, headers
557
1106
  end
558
1107
 
1108
+ # Copy a voicemail message to a user or group
1109
+ #
1110
+ # @param [Hash] opts the optional parameters
1111
+ # @option opts [CopyVoicemailMessage] :body
1112
+ # @return [VoicemailMessage]
1113
+ def post_messages(opts = {})
1114
+ data, status_code, headers = post_messages_with_http_info(opts)
1115
+ return data
1116
+ end
1117
+
1118
+ # Copy a voicemail message to a user or group
1119
+ #
1120
+ # @param [Hash] opts the optional parameters
1121
+ # @option opts [CopyVoicemailMessage] :body
1122
+ # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers
1123
+ def post_messages_with_http_info(opts = {})
1124
+ if @api_client.config.debugging
1125
+ @api_client.config.logger.debug "Calling API: VoicemailApi#post_messages ..."
1126
+ end
1127
+
1128
+ # resource path
1129
+ local_var_path = "/api/v2/voicemail/messages".sub('{format}','json')
1130
+
1131
+ # query parameters
1132
+ query_params = {}
1133
+
1134
+ # header parameters
1135
+ header_params = {}
1136
+
1137
+ # HTTP header 'Accept' (if needed)
1138
+ _header_accept = ['application/json']
1139
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1140
+
1141
+ # HTTP header 'Content-Type'
1142
+ _header_content_type = ['application/json']
1143
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1144
+
1145
+ # form parameters
1146
+ form_params = {}
1147
+
1148
+ # http body (model)
1149
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1150
+
1151
+ auth_names = ['PureCloud Auth']
1152
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1153
+ :header_params => header_params,
1154
+ :query_params => query_params,
1155
+ :form_params => form_params,
1156
+ :body => post_body,
1157
+ :auth_names => auth_names,
1158
+ :return_type => 'VoicemailMessage')
1159
+ if @api_client.config.debugging
1160
+ @api_client.config.logger.debug "API called: VoicemailApi#post_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1161
+ end
1162
+ return data, status_code, headers
1163
+ end
1164
+
1165
+ # Search voicemails
1166
+ #
1167
+ # @param body Search request options
1168
+ # @param [Hash] opts the optional parameters
1169
+ # @return [VoicemailsSearchResponse]
1170
+ def post_search(body, opts = {})
1171
+ data, status_code, headers = post_search_with_http_info(body, opts)
1172
+ return data
1173
+ end
1174
+
1175
+ # Search voicemails
1176
+ #
1177
+ # @param body Search request options
1178
+ # @param [Hash] opts the optional parameters
1179
+ # @return [Array<(VoicemailsSearchResponse, Fixnum, Hash)>] VoicemailsSearchResponse data, response status code and response headers
1180
+ def post_search_with_http_info(body, opts = {})
1181
+ if @api_client.config.debugging
1182
+ @api_client.config.logger.debug "Calling API: VoicemailApi#post_search ..."
1183
+ end
1184
+
1185
+ # verify the required parameter 'body' is set
1186
+ fail "Missing the required parameter 'body' when calling post_search" if body.nil?
1187
+
1188
+ # resource path
1189
+ local_var_path = "/api/v2/voicemail/search".sub('{format}','json')
1190
+
1191
+ # query parameters
1192
+ query_params = {}
1193
+
1194
+ # header parameters
1195
+ header_params = {}
1196
+
1197
+ # HTTP header 'Accept' (if needed)
1198
+ _header_accept = ['application/json']
1199
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1200
+
1201
+ # HTTP header 'Content-Type'
1202
+ _header_content_type = ['application/json']
1203
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1204
+
1205
+ # form parameters
1206
+ form_params = {}
1207
+
1208
+ # http body (model)
1209
+ post_body = @api_client.object_to_http_body(body)
1210
+
1211
+ auth_names = ['PureCloud Auth']
1212
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1213
+ :header_params => header_params,
1214
+ :query_params => query_params,
1215
+ :form_params => form_params,
1216
+ :body => post_body,
1217
+ :auth_names => auth_names,
1218
+ :return_type => 'VoicemailsSearchResponse')
1219
+ if @api_client.config.debugging
1220
+ @api_client.config.logger.debug "API called: VoicemailApi#post_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1221
+ end
1222
+ return data, status_code, headers
1223
+ end
1224
+
559
1225
  # Update a message.
560
1226
  #
561
1227
  # @param message_id Message ID