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
@@ -24,8 +24,8 @@ module PureCloud
24
24
  @api_client = api_client
25
25
  end
26
26
 
27
- # Delete Language
28
- #
27
+ # Delete Language (Deprecated)
28
+ # This endpoint is deprecated. It has been moved to /routing/languages/{languageId}
29
29
  # @param language_id Language ID
30
30
  # @param [Hash] opts the optional parameters
31
31
  # @return [nil]
@@ -34,8 +34,8 @@ module PureCloud
34
34
  return nil
35
35
  end
36
36
 
37
- # Delete Language
38
- #
37
+ # Delete Language (Deprecated)
38
+ # This endpoint is deprecated. It has been moved to /routing/languages/{languageId}
39
39
  # @param language_id Language ID
40
40
  # @param [Hash] opts the optional parameters
41
41
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -83,18 +83,77 @@ module PureCloud
83
83
  return data, status_code, headers
84
84
  end
85
85
 
86
- # Get language
86
+ # Delete Language
87
+ #
88
+ # @param language_id Language ID
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [nil]
91
+ def delete_languages_language_id(language_id, opts = {})
92
+ delete_languages_language_id_with_http_info(language_id, opts)
93
+ return nil
94
+ end
95
+
96
+ # Delete Language
87
97
  #
88
98
  # @param language_id Language ID
89
99
  # @param [Hash] opts the optional parameters
100
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
101
+ def delete_languages_language_id_with_http_info(language_id, opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug "Calling API: LanguagesApi#delete_languages_language_id ..."
104
+ end
105
+
106
+ # verify the required parameter 'language_id' is set
107
+ fail "Missing the required parameter 'language_id' when calling delete_languages_language_id" if language_id.nil?
108
+
109
+ # resource path
110
+ local_var_path = "/api/v2/routing/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)
111
+
112
+ # query parameters
113
+ query_params = {}
114
+
115
+ # header parameters
116
+ header_params = {}
117
+
118
+ # HTTP header 'Accept' (if needed)
119
+ _header_accept = ['application/json']
120
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
121
+
122
+ # HTTP header 'Content-Type'
123
+ _header_content_type = ['application/json']
124
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
125
+
126
+ # form parameters
127
+ form_params = {}
128
+
129
+ # http body (model)
130
+ post_body = nil
131
+
132
+ auth_names = ['PureCloud Auth']
133
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
134
+ :header_params => header_params,
135
+ :query_params => query_params,
136
+ :form_params => form_params,
137
+ :body => post_body,
138
+ :auth_names => auth_names)
139
+ if @api_client.config.debugging
140
+ @api_client.config.logger.debug "API called: LanguagesApi#delete_languages_language_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
141
+ end
142
+ return data, status_code, headers
143
+ end
144
+
145
+ # Get language (Deprecated)
146
+ # This endpoint is deprecated. It has been moved to /routing/languages/{languageId}
147
+ # @param language_id Language ID
148
+ # @param [Hash] opts the optional parameters
90
149
  # @return [Language]
91
150
  def get_language_id(language_id, opts = {})
92
151
  data, status_code, headers = get_language_id_with_http_info(language_id, opts)
93
152
  return data
94
153
  end
95
154
 
96
- # Get language
97
- #
155
+ # Get language (Deprecated)
156
+ # This endpoint is deprecated. It has been moved to /routing/languages/{languageId}
98
157
  # @param language_id Language ID
99
158
  # @param [Hash] opts the optional parameters
100
159
  # @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers
@@ -143,8 +202,8 @@ module PureCloud
143
202
  return data, status_code, headers
144
203
  end
145
204
 
146
- # Get the list of supported languages.
147
- #
205
+ # Get the list of supported languages. (Deprecated)
206
+ # This endpoint is deprecated. It has been moved to /routing/languages
148
207
  # @param [Hash] opts the optional parameters
149
208
  # @option opts [Integer] :page_size Page size (default to 25)
150
209
  # @option opts [Integer] :page_number Page number (default to 1)
@@ -156,8 +215,8 @@ module PureCloud
156
215
  return data
157
216
  end
158
217
 
159
- # Get the list of supported languages.
160
- #
218
+ # Get the list of supported languages. (Deprecated)
219
+ # This endpoint is deprecated. It has been moved to /routing/languages
161
220
  # @param [Hash] opts the optional parameters
162
221
  # @option opts [Integer] :page_size Page size
163
222
  # @option opts [Integer] :page_number Page number
@@ -214,6 +273,66 @@ module PureCloud
214
273
  return data, status_code, headers
215
274
  end
216
275
 
276
+ # Get language
277
+ #
278
+ # @param language_id Language ID
279
+ # @param [Hash] opts the optional parameters
280
+ # @return [Language]
281
+ def get_languages_language_id(language_id, opts = {})
282
+ data, status_code, headers = get_languages_language_id_with_http_info(language_id, opts)
283
+ return data
284
+ end
285
+
286
+ # Get language
287
+ #
288
+ # @param language_id Language ID
289
+ # @param [Hash] opts the optional parameters
290
+ # @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers
291
+ def get_languages_language_id_with_http_info(language_id, opts = {})
292
+ if @api_client.config.debugging
293
+ @api_client.config.logger.debug "Calling API: LanguagesApi#get_languages_language_id ..."
294
+ end
295
+
296
+ # verify the required parameter 'language_id' is set
297
+ fail "Missing the required parameter 'language_id' when calling get_languages_language_id" if language_id.nil?
298
+
299
+ # resource path
300
+ local_var_path = "/api/v2/routing/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)
301
+
302
+ # query parameters
303
+ query_params = {}
304
+
305
+ # header parameters
306
+ header_params = {}
307
+
308
+ # HTTP header 'Accept' (if needed)
309
+ _header_accept = ['application/json']
310
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
311
+
312
+ # HTTP header 'Content-Type'
313
+ _header_content_type = ['application/json']
314
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
315
+
316
+ # form parameters
317
+ form_params = {}
318
+
319
+ # http body (model)
320
+ post_body = nil
321
+
322
+ auth_names = ['PureCloud Auth']
323
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
324
+ :header_params => header_params,
325
+ :query_params => query_params,
326
+ :form_params => form_params,
327
+ :body => post_body,
328
+ :auth_names => auth_names,
329
+ :return_type => 'Language')
330
+ if @api_client.config.debugging
331
+ @api_client.config.logger.debug "API called: LanguagesApi#get_languages_language_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
332
+ end
333
+ return data, status_code, headers
334
+ end
335
+
217
336
  # Get all available languages for translation
218
337
  #
219
338
  # @param [Hash] opts the optional parameters
@@ -451,8 +570,8 @@ module PureCloud
451
570
  return data, status_code, headers
452
571
  end
453
572
 
454
- # Create Language
455
- #
573
+ # Create Language (Deprecated)
574
+ # This endpoint is deprecated. It has been moved to /routing/languages
456
575
  # @param body Language
457
576
  # @param [Hash] opts the optional parameters
458
577
  # @return [Language]
@@ -461,8 +580,8 @@ module PureCloud
461
580
  return data
462
581
  end
463
582
 
464
- # Create Language
465
- #
583
+ # Create Language (Deprecated)
584
+ # This endpoint is deprecated. It has been moved to /routing/languages
466
585
  # @param body Language
467
586
  # @param [Hash] opts the optional parameters
468
587
  # @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers
@@ -510,70 +629,5 @@ module PureCloud
510
629
  end
511
630
  return data, status_code, headers
512
631
  end
513
-
514
- # Update Language
515
- #
516
- # @param language_id Language ID
517
- # @param body Language
518
- # @param [Hash] opts the optional parameters
519
- # @return [Language]
520
- def put_language_id(language_id, body, opts = {})
521
- data, status_code, headers = put_language_id_with_http_info(language_id, body, opts)
522
- return data
523
- end
524
-
525
- # Update Language
526
- #
527
- # @param language_id Language ID
528
- # @param body Language
529
- # @param [Hash] opts the optional parameters
530
- # @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers
531
- def put_language_id_with_http_info(language_id, body, opts = {})
532
- if @api_client.config.debugging
533
- @api_client.config.logger.debug "Calling API: LanguagesApi#put_language_id ..."
534
- end
535
-
536
- # verify the required parameter 'language_id' is set
537
- fail "Missing the required parameter 'language_id' when calling put_language_id" if language_id.nil?
538
-
539
- # verify the required parameter 'body' is set
540
- fail "Missing the required parameter 'body' when calling put_language_id" if body.nil?
541
-
542
- # resource path
543
- local_var_path = "/api/v2/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)
544
-
545
- # query parameters
546
- query_params = {}
547
-
548
- # header parameters
549
- header_params = {}
550
-
551
- # HTTP header 'Accept' (if needed)
552
- _header_accept = ['application/json']
553
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
554
-
555
- # HTTP header 'Content-Type'
556
- _header_content_type = ['application/json']
557
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
558
-
559
- # form parameters
560
- form_params = {}
561
-
562
- # http body (model)
563
- post_body = @api_client.object_to_http_body(body)
564
-
565
- auth_names = ['PureCloud Auth']
566
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
567
- :header_params => header_params,
568
- :query_params => query_params,
569
- :form_params => form_params,
570
- :body => post_body,
571
- :auth_names => auth_names,
572
- :return_type => 'Language')
573
- if @api_client.config.debugging
574
- @api_client.config.logger.debug "API called: LanguagesApi#put_language_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
575
- end
576
- return data, status_code, headers
577
- end
578
632
  end
579
633
  end
@@ -3258,6 +3258,7 @@ module PureCloud
3258
3258
  # @param body Contact
3259
3259
  # @param [Hash] opts the optional parameters
3260
3260
  # @option opts [BOOLEAN] :priority Contact priority. True means the contact(s) will go to the beginning of the list, false means at the end.
3261
+ # @option opts [BOOLEAN] :clear_system_data Clear system data. True means the system data stored on the contact will be cleared if the contact already exists (attempts, callable status, etc), false means it won&#39;t.
3261
3262
  # @return [Array<DialerContact>]
3262
3263
  def post_contactlists_contactlist_id_contacts(contact_list_id, body, opts = {})
3263
3264
  data, status_code, headers = post_contactlists_contactlist_id_contacts_with_http_info(contact_list_id, body, opts)
@@ -3270,6 +3271,7 @@ module PureCloud
3270
3271
  # @param body Contact
3271
3272
  # @param [Hash] opts the optional parameters
3272
3273
  # @option opts [BOOLEAN] :priority Contact priority. True means the contact(s) will go to the beginning of the list, false means at the end.
3274
+ # @option opts [BOOLEAN] :clear_system_data Clear system data. True means the system data stored on the contact will be cleared if the contact already exists (attempts, callable status, etc), false means it won&#39;t.
3273
3275
  # @return [Array<(Array<DialerContact>, Fixnum, Hash)>] Array<DialerContact> data, response status code and response headers
3274
3276
  def post_contactlists_contactlist_id_contacts_with_http_info(contact_list_id, body, opts = {})
3275
3277
  if @api_client.config.debugging
@@ -3288,6 +3290,7 @@ module PureCloud
3288
3290
  # query parameters
3289
3291
  query_params = {}
3290
3292
  query_params[:'priority'] = opts[:'priority'] if opts[:'priority']
3293
+ query_params[:'clearSystemData'] = opts[:'clear_system_data'] if opts[:'clear_system_data']
3291
3294
 
3292
3295
  # header parameters
3293
3296
  header_params = {}
@@ -886,6 +886,77 @@ module PureCloud
886
886
  return data, status_code, headers
887
887
  end
888
888
 
889
+ # Get the list of supported languages.
890
+ #
891
+ # @param [Hash] opts the optional parameters
892
+ # @option opts [Integer] :page_size Page size (default to 25)
893
+ # @option opts [Integer] :page_number Page number (default to 1)
894
+ # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
895
+ # @option opts [String] :name Name
896
+ # @return [LanguageEntityListing]
897
+ def get_languages(opts = {})
898
+ data, status_code, headers = get_languages_with_http_info(opts)
899
+ return data
900
+ end
901
+
902
+ # Get the list of supported languages.
903
+ #
904
+ # @param [Hash] opts the optional parameters
905
+ # @option opts [Integer] :page_size Page size
906
+ # @option opts [Integer] :page_number Page number
907
+ # @option opts [String] :sort_order Ascending or descending sort order
908
+ # @option opts [String] :name Name
909
+ # @return [Array<(LanguageEntityListing, Fixnum, Hash)>] LanguageEntityListing data, response status code and response headers
910
+ def get_languages_with_http_info(opts = {})
911
+ if @api_client.config.debugging
912
+ @api_client.config.logger.debug "Calling API: RoutingApi#get_languages ..."
913
+ end
914
+
915
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
916
+ fail 'invalid value for "sort_order", must be one of ascending, descending'
917
+ end
918
+
919
+ # resource path
920
+ local_var_path = "/api/v2/routing/languages".sub('{format}','json')
921
+
922
+ # query parameters
923
+ query_params = {}
924
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
925
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
926
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
927
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
928
+
929
+ # header parameters
930
+ header_params = {}
931
+
932
+ # HTTP header 'Accept' (if needed)
933
+ _header_accept = ['application/json']
934
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
935
+
936
+ # HTTP header 'Content-Type'
937
+ _header_content_type = ['application/json']
938
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
939
+
940
+ # form parameters
941
+ form_params = {}
942
+
943
+ # http body (model)
944
+ post_body = nil
945
+
946
+ auth_names = ['PureCloud Auth']
947
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
948
+ :header_params => header_params,
949
+ :query_params => query_params,
950
+ :form_params => form_params,
951
+ :body => post_body,
952
+ :auth_names => auth_names,
953
+ :return_type => 'LanguageEntityListing')
954
+ if @api_client.config.debugging
955
+ @api_client.config.logger.debug "API called: RoutingApi#get_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
956
+ end
957
+ return data, status_code, headers
958
+ end
959
+
889
960
  # Get list of queues.
890
961
  #
891
962
  # @param [Hash] opts the optional parameters
@@ -2198,6 +2269,66 @@ module PureCloud
2198
2269
  return data, status_code, headers
2199
2270
  end
2200
2271
 
2272
+ # Create Language
2273
+ #
2274
+ # @param body Language
2275
+ # @param [Hash] opts the optional parameters
2276
+ # @return [Language]
2277
+ def post_languages(body, opts = {})
2278
+ data, status_code, headers = post_languages_with_http_info(body, opts)
2279
+ return data
2280
+ end
2281
+
2282
+ # Create Language
2283
+ #
2284
+ # @param body Language
2285
+ # @param [Hash] opts the optional parameters
2286
+ # @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers
2287
+ def post_languages_with_http_info(body, opts = {})
2288
+ if @api_client.config.debugging
2289
+ @api_client.config.logger.debug "Calling API: RoutingApi#post_languages ..."
2290
+ end
2291
+
2292
+ # verify the required parameter 'body' is set
2293
+ fail "Missing the required parameter 'body' when calling post_languages" if body.nil?
2294
+
2295
+ # resource path
2296
+ local_var_path = "/api/v2/routing/languages".sub('{format}','json')
2297
+
2298
+ # query parameters
2299
+ query_params = {}
2300
+
2301
+ # header parameters
2302
+ header_params = {}
2303
+
2304
+ # HTTP header 'Accept' (if needed)
2305
+ _header_accept = ['application/json']
2306
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2307
+
2308
+ # HTTP header 'Content-Type'
2309
+ _header_content_type = ['application/json']
2310
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2311
+
2312
+ # form parameters
2313
+ form_params = {}
2314
+
2315
+ # http body (model)
2316
+ post_body = @api_client.object_to_http_body(body)
2317
+
2318
+ auth_names = ['PureCloud Auth']
2319
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2320
+ :header_params => header_params,
2321
+ :query_params => query_params,
2322
+ :form_params => form_params,
2323
+ :body => post_body,
2324
+ :auth_names => auth_names,
2325
+ :return_type => 'Language')
2326
+ if @api_client.config.debugging
2327
+ @api_client.config.logger.debug "API called: RoutingApi#post_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2328
+ end
2329
+ return data, status_code, headers
2330
+ end
2331
+
2201
2332
  # Create queue
2202
2333
  #
2203
2334
  # @param body Queue
@@ -156,7 +156,7 @@ module PureCloud
156
156
  #
157
157
  # @param q64 q64
158
158
  # @param [Hash] opts the optional parameters
159
- # @option opts [Array<String>] :expand expand
159
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
160
160
  # @option opts [BOOLEAN] :profile profile (default to true)
161
161
  # @return [JsonNodeSearchResponse]
162
162
  def get_search_1(q64, opts = {})
@@ -168,7 +168,7 @@ module PureCloud
168
168
  #
169
169
  # @param q64 q64
170
170
  # @param [Hash] opts the optional parameters
171
- # @option opts [Array<String>] :expand expand
171
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
172
172
  # @option opts [BOOLEAN] :profile profile
173
173
  # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
174
174
  def get_search_1_with_http_info(q64, opts = {})
@@ -283,10 +283,75 @@ module PureCloud
283
283
  return data, status_code, headers
284
284
  end
285
285
 
286
+ # Search voicemails using the q64 value returned from a previous search
287
+ #
288
+ # @param q64 q64
289
+ # @param [Hash] opts the optional parameters
290
+ # @option opts [Array<String>] :expand expand
291
+ # @return [VoicemailsSearchResponse]
292
+ def get_search_3(q64, opts = {})
293
+ data, status_code, headers = get_search_3_with_http_info(q64, opts)
294
+ return data
295
+ end
296
+
297
+ # Search voicemails using the q64 value returned from a previous search
298
+ #
299
+ # @param q64 q64
300
+ # @param [Hash] opts the optional parameters
301
+ # @option opts [Array<String>] :expand expand
302
+ # @return [Array<(VoicemailsSearchResponse, Fixnum, Hash)>] VoicemailsSearchResponse data, response status code and response headers
303
+ def get_search_3_with_http_info(q64, opts = {})
304
+ if @api_client.config.debugging
305
+ @api_client.config.logger.debug "Calling API: SearchApi#get_search_3 ..."
306
+ end
307
+
308
+ # verify the required parameter 'q64' is set
309
+ fail "Missing the required parameter 'q64' when calling get_search_3" if q64.nil?
310
+
311
+ # resource path
312
+ local_var_path = "/api/v2/voicemail/search".sub('{format}','json')
313
+
314
+ # query parameters
315
+ query_params = {}
316
+ query_params[:'q64'] = q64
317
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
318
+
319
+ # header parameters
320
+ header_params = {}
321
+
322
+ # HTTP header 'Accept' (if needed)
323
+ _header_accept = ['application/json']
324
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
325
+
326
+ # HTTP header 'Content-Type'
327
+ _header_content_type = ['application/json']
328
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
329
+
330
+ # form parameters
331
+ form_params = {}
332
+
333
+ # http body (model)
334
+ post_body = nil
335
+
336
+ auth_names = ['PureCloud Auth']
337
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
338
+ :header_params => header_params,
339
+ :query_params => query_params,
340
+ :form_params => form_params,
341
+ :body => post_body,
342
+ :auth_names => auth_names,
343
+ :return_type => 'VoicemailsSearchResponse')
344
+ if @api_client.config.debugging
345
+ @api_client.config.logger.debug "API called: SearchApi#get_search_3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
346
+ end
347
+ return data, status_code, headers
348
+ end
349
+
286
350
  # Suggest resources using the q64 value returned from a previous suggest query.
287
351
  #
288
352
  # @param q64 q64
289
353
  # @param [Hash] opts the optional parameters
354
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
290
355
  # @option opts [BOOLEAN] :profile profile (default to true)
291
356
  # @return [JsonNodeSearchResponse]
292
357
  def get_suggest(q64, opts = {})
@@ -298,6 +363,7 @@ module PureCloud
298
363
  #
299
364
  # @param q64 q64
300
365
  # @param [Hash] opts the optional parameters
366
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
301
367
  # @option opts [BOOLEAN] :profile profile
302
368
  # @return [Array<(JsonNodeSearchResponse, Fixnum, Hash)>] JsonNodeSearchResponse data, response status code and response headers
303
369
  def get_suggest_with_http_info(q64, opts = {})
@@ -314,6 +380,7 @@ module PureCloud
314
380
  # query parameters
315
381
  query_params = {}
316
382
  query_params[:'q64'] = q64
383
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
317
384
  query_params[:'profile'] = opts[:'profile'] if opts[:'profile']
318
385
 
319
386
  # header parameters
@@ -590,6 +657,66 @@ module PureCloud
590
657
  return data, status_code, headers
591
658
  end
592
659
 
660
+ # Search voicemails
661
+ #
662
+ # @param body Search request options
663
+ # @param [Hash] opts the optional parameters
664
+ # @return [VoicemailsSearchResponse]
665
+ def post_search_3(body, opts = {})
666
+ data, status_code, headers = post_search_3_with_http_info(body, opts)
667
+ return data
668
+ end
669
+
670
+ # Search voicemails
671
+ #
672
+ # @param body Search request options
673
+ # @param [Hash] opts the optional parameters
674
+ # @return [Array<(VoicemailsSearchResponse, Fixnum, Hash)>] VoicemailsSearchResponse data, response status code and response headers
675
+ def post_search_3_with_http_info(body, opts = {})
676
+ if @api_client.config.debugging
677
+ @api_client.config.logger.debug "Calling API: SearchApi#post_search_3 ..."
678
+ end
679
+
680
+ # verify the required parameter 'body' is set
681
+ fail "Missing the required parameter 'body' when calling post_search_3" if body.nil?
682
+
683
+ # resource path
684
+ local_var_path = "/api/v2/voicemail/search".sub('{format}','json')
685
+
686
+ # query parameters
687
+ query_params = {}
688
+
689
+ # header parameters
690
+ header_params = {}
691
+
692
+ # HTTP header 'Accept' (if needed)
693
+ _header_accept = ['application/json']
694
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
695
+
696
+ # HTTP header 'Content-Type'
697
+ _header_content_type = ['application/json']
698
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
699
+
700
+ # form parameters
701
+ form_params = {}
702
+
703
+ # http body (model)
704
+ post_body = @api_client.object_to_http_body(body)
705
+
706
+ auth_names = ['PureCloud Auth']
707
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
708
+ :header_params => header_params,
709
+ :query_params => query_params,
710
+ :form_params => form_params,
711
+ :body => post_body,
712
+ :auth_names => auth_names,
713
+ :return_type => 'VoicemailsSearchResponse')
714
+ if @api_client.config.debugging
715
+ @api_client.config.logger.debug "API called: SearchApi#post_search_3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
716
+ end
717
+ return data, status_code, headers
718
+ end
719
+
593
720
  # Suggest resources.
594
721
  #
595
722
  # @param body Search request options