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
@@ -11,8 +11,8 @@ title: HeartBeatAlertContainer
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: HeartBeatRuleContainer
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: InboundDomainEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: InboundRouteEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: InteractionStatsAlertContainer
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: InteractionStatsRuleContainer
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: KeywordSetEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -11,8 +11,8 @@ title: LanguageEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
17
  | **next_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
@@ -8,21 +8,77 @@ All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
9
  Method | HTTP request | Description
10
10
  ------------- | ------------- | -------------
11
- |[**delete_language_id**](LanguagesApi.html#delete_language_id) | **DELETE** /api/v2/languages/{languageId} | Delete Language|
12
- |[**get_language_id**](LanguagesApi.html#get_language_id) | **GET** /api/v2/languages/{languageId} | Get language|
13
- |[**get_languages**](LanguagesApi.html#get_languages) | **GET** /api/v2/languages | Get the list of supported languages.|
11
+ |[**delete_language_id**](LanguagesApi.html#delete_language_id) | **DELETE** /api/v2/languages/{languageId} | Delete Language (Deprecated)|
12
+ |[**delete_languages_language_id**](LanguagesApi.html#delete_languages_language_id) | **DELETE** /api/v2/routing/languages/{languageId} | Delete Language|
13
+ |[**get_language_id**](LanguagesApi.html#get_language_id) | **GET** /api/v2/languages/{languageId} | Get language (Deprecated)|
14
+ |[**get_languages**](LanguagesApi.html#get_languages) | **GET** /api/v2/languages | Get the list of supported languages. (Deprecated)|
15
+ |[**get_languages_language_id**](LanguagesApi.html#get_languages_language_id) | **GET** /api/v2/routing/languages/{languageId} | Get language|
14
16
  |[**get_translations**](LanguagesApi.html#get_translations) | **GET** /api/v2/languages/translations | Get all available languages for translation|
15
17
  |[**get_translations_builtin**](LanguagesApi.html#get_translations_builtin) | **GET** /api/v2/languages/translations/builtin | Get the builtin translation for a language|
16
18
  |[**get_translations_organization**](LanguagesApi.html#get_translations_organization) | **GET** /api/v2/languages/translations/organization | Get effective translation for an organization by language|
17
19
  |[**get_translations_users_user_id**](LanguagesApi.html#get_translations_users_user_id) | **GET** /api/v2/languages/translations/users/{userId} | Get effective language translation for a user|
18
- |[**post_languages**](LanguagesApi.html#post_languages) | **POST** /api/v2/languages | Create Language|
19
- |[**put_language_id**](LanguagesApi.html#put_language_id) | **PUT** /api/v2/languages/{languageId} | Update Language|
20
+ |[**post_languages**](LanguagesApi.html#post_languages) | **POST** /api/v2/languages | Create Language (Deprecated)|
20
21
  {: class="table table-striped"}
21
22
 
22
23
  <a name="delete_language_id"></a>
23
24
 
24
25
  ## - delete_language_id(language_id)
25
26
 
27
+ Delete Language (Deprecated)
28
+
29
+ This endpoint is deprecated. It has been moved to /routing/languages/{languageId}
30
+
31
+ ### Example
32
+ ~~~ruby
33
+ # load the gem
34
+ require 'purecloud'
35
+ # setup authorization
36
+ @secret = ENV['PURECLOUD_SECRET']
37
+ @id = ENV['PURECLOUD_CLIENT_ID']
38
+ environment = "mypurecloud.com"
39
+
40
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
41
+
42
+ PureCloud.configure do |config|
43
+ config.access_token = @authToken
44
+ end
45
+
46
+ api_instance = PureCloud::LanguagesApi.new
47
+
48
+ language_id = "language_id_example" # String | Language ID
49
+
50
+
51
+ begin
52
+ #Delete Language (Deprecated)
53
+ api_instance.delete_language_id(language_id)
54
+ rescue PureCloud::ApiError => e
55
+ puts "Exception when calling LanguagesApi->delete_language_id: #{e}"
56
+ end
57
+ ~~~
58
+
59
+ ### Parameters
60
+
61
+ Name | Type | Description | Notes
62
+ ------------- | ------------- | ------------- | -------------
63
+ **language_id** | **String**| Language ID |
64
+ {: class="table table-striped"}
65
+
66
+
67
+ ### Return type
68
+
69
+ nil (empty response body)
70
+
71
+ ### HTTP request headers
72
+
73
+ - **Content-Type**: application/json
74
+ - **Accept**: application/json
75
+
76
+
77
+
78
+ <a name="delete_languages_language_id"></a>
79
+
80
+ ## - delete_languages_language_id(language_id)
81
+
26
82
  Delete Language
27
83
 
28
84
 
@@ -49,9 +105,9 @@ language_id = "language_id_example" # String | Language ID
49
105
 
50
106
  begin
51
107
  #Delete Language
52
- api_instance.delete_language_id(language_id)
108
+ api_instance.delete_languages_language_id(language_id)
53
109
  rescue PureCloud::ApiError => e
54
- puts "Exception when calling LanguagesApi->delete_language_id: #{e}"
110
+ puts "Exception when calling LanguagesApi->delete_languages_language_id: #{e}"
55
111
  end
56
112
  ~~~
57
113
 
@@ -78,9 +134,9 @@ nil (empty response body)
78
134
 
79
135
  ## -[**Language**](Language.html) get_language_id(language_id)
80
136
 
81
- Get language
82
-
137
+ Get language (Deprecated)
83
138
 
139
+ This endpoint is deprecated. It has been moved to /routing/languages/{languageId}
84
140
 
85
141
  ### Example
86
142
  ~~~ruby
@@ -103,7 +159,7 @@ language_id = "language_id_example" # String | Language ID
103
159
 
104
160
 
105
161
  begin
106
- #Get language
162
+ #Get language (Deprecated)
107
163
  result = api_instance.get_language_id(language_id)
108
164
  p result
109
165
  rescue PureCloud::ApiError => e
@@ -134,9 +190,9 @@ Name | Type | Description | Notes
134
190
 
135
191
  ## -[**LanguageEntityListing**](LanguageEntityListing.html) get_languages(opts)
136
192
 
137
- Get the list of supported languages.
138
-
193
+ Get the list of supported languages. (Deprecated)
139
194
 
195
+ This endpoint is deprecated. It has been moved to /routing/languages
140
196
 
141
197
  ### Example
142
198
  ~~~ruby
@@ -163,7 +219,7 @@ opts = {
163
219
  }
164
220
 
165
221
  begin
166
- #Get the list of supported languages.
222
+ #Get the list of supported languages. (Deprecated)
167
223
  result = api_instance.get_languages(opts)
168
224
  p result
169
225
  rescue PureCloud::ApiError => e
@@ -193,11 +249,11 @@ Name | Type | Description | Notes
193
249
 
194
250
 
195
251
 
196
- <a name="get_translations"></a>
252
+ <a name="get_languages_language_id"></a>
197
253
 
198
- ## -[**AvailableTranslations**](AvailableTranslations.html) get_translations
254
+ ## -[**Language**](Language.html) get_languages_language_id(language_id)
199
255
 
200
- Get all available languages for translation
256
+ Get language
201
257
 
202
258
 
203
259
 
@@ -218,23 +274,29 @@ end
218
274
 
219
275
  api_instance = PureCloud::LanguagesApi.new
220
276
 
277
+ language_id = "language_id_example" # String | Language ID
278
+
279
+
221
280
  begin
222
- #Get all available languages for translation
223
- result = api_instance.get_translations
281
+ #Get language
282
+ result = api_instance.get_languages_language_id(language_id)
224
283
  p result
225
284
  rescue PureCloud::ApiError => e
226
- puts "Exception when calling LanguagesApi->get_translations: #{e}"
285
+ puts "Exception when calling LanguagesApi->get_languages_language_id: #{e}"
227
286
  end
228
287
  ~~~
229
288
 
230
289
  ### Parameters
231
- This endpoint does not need any parameter.
290
+
291
+ Name | Type | Description | Notes
292
+ ------------- | ------------- | ------------- | -------------
293
+ **language_id** | **String**| Language ID |
232
294
  {: class="table table-striped"}
233
295
 
234
296
 
235
297
  ### Return type
236
298
 
237
- [**AvailableTranslations**](AvailableTranslations.html)
299
+ [**Language**](Language.html)
238
300
 
239
301
  ### HTTP request headers
240
302
 
@@ -243,11 +305,11 @@ This endpoint does not need any parameter.
243
305
 
244
306
 
245
307
 
246
- <a name="get_translations_builtin"></a>
308
+ <a name="get_translations"></a>
247
309
 
248
- ## -Hash&lt;String, Object&gt;** get_translations_builtin(language)
310
+ ## -[**AvailableTranslations**](AvailableTranslations.html) get_translations
249
311
 
250
- Get the builtin translation for a language
312
+ Get all available languages for translation
251
313
 
252
314
 
253
315
 
@@ -268,29 +330,23 @@ end
268
330
 
269
331
  api_instance = PureCloud::LanguagesApi.new
270
332
 
271
- language = "language_example" # String | The language of the builtin translation to retrieve
272
-
273
-
274
333
  begin
275
- #Get the builtin translation for a language
276
- result = api_instance.get_translations_builtin(language)
334
+ #Get all available languages for translation
335
+ result = api_instance.get_translations
277
336
  p result
278
337
  rescue PureCloud::ApiError => e
279
- puts "Exception when calling LanguagesApi->get_translations_builtin: #{e}"
338
+ puts "Exception when calling LanguagesApi->get_translations: #{e}"
280
339
  end
281
340
  ~~~
282
341
 
283
342
  ### Parameters
284
-
285
- Name | Type | Description | Notes
286
- ------------- | ------------- | ------------- | -------------
287
- **language** | **String**| The language of the builtin translation to retrieve |
343
+ This endpoint does not need any parameter.
288
344
  {: class="table table-striped"}
289
345
 
290
346
 
291
347
  ### Return type
292
348
 
293
- **Hash&lt;String, Object&gt;**
349
+ [**AvailableTranslations**](AvailableTranslations.html)
294
350
 
295
351
  ### HTTP request headers
296
352
 
@@ -299,11 +355,11 @@ Name | Type | Description | Notes
299
355
 
300
356
 
301
357
 
302
- <a name="get_translations_organization"></a>
358
+ <a name="get_translations_builtin"></a>
303
359
 
304
- ## -Hash&lt;String, Object&gt;** get_translations_organization(language)
360
+ ## -Hash&lt;String, Object&gt;** get_translations_builtin(language)
305
361
 
306
- Get effective translation for an organization by language
362
+ Get the builtin translation for a language
307
363
 
308
364
 
309
365
 
@@ -324,15 +380,15 @@ end
324
380
 
325
381
  api_instance = PureCloud::LanguagesApi.new
326
382
 
327
- language = "language_example" # String | The language of the translation to retrieve for the organization
383
+ language = "language_example" # String | The language of the builtin translation to retrieve
328
384
 
329
385
 
330
386
  begin
331
- #Get effective translation for an organization by language
332
- result = api_instance.get_translations_organization(language)
387
+ #Get the builtin translation for a language
388
+ result = api_instance.get_translations_builtin(language)
333
389
  p result
334
390
  rescue PureCloud::ApiError => e
335
- puts "Exception when calling LanguagesApi->get_translations_organization: #{e}"
391
+ puts "Exception when calling LanguagesApi->get_translations_builtin: #{e}"
336
392
  end
337
393
  ~~~
338
394
 
@@ -340,7 +396,7 @@ end
340
396
 
341
397
  Name | Type | Description | Notes
342
398
  ------------- | ------------- | ------------- | -------------
343
- **language** | **String**| The language of the translation to retrieve for the organization |
399
+ **language** | **String**| The language of the builtin translation to retrieve |
344
400
  {: class="table table-striped"}
345
401
 
346
402
 
@@ -355,11 +411,11 @@ Name | Type | Description | Notes
355
411
 
356
412
 
357
413
 
358
- <a name="get_translations_users_user_id"></a>
414
+ <a name="get_translations_organization"></a>
359
415
 
360
- ## -Hash&lt;String, Object&gt;** get_translations_users_user_id(user_id)
416
+ ## -Hash&lt;String, Object&gt;** get_translations_organization(language)
361
417
 
362
- Get effective language translation for a user
418
+ Get effective translation for an organization by language
363
419
 
364
420
 
365
421
 
@@ -380,15 +436,15 @@ end
380
436
 
381
437
  api_instance = PureCloud::LanguagesApi.new
382
438
 
383
- user_id = "user_id_example" # String | The user id
439
+ language = "language_example" # String | The language of the translation to retrieve for the organization
384
440
 
385
441
 
386
442
  begin
387
- #Get effective language translation for a user
388
- result = api_instance.get_translations_users_user_id(user_id)
443
+ #Get effective translation for an organization by language
444
+ result = api_instance.get_translations_organization(language)
389
445
  p result
390
446
  rescue PureCloud::ApiError => e
391
- puts "Exception when calling LanguagesApi->get_translations_users_user_id: #{e}"
447
+ puts "Exception when calling LanguagesApi->get_translations_organization: #{e}"
392
448
  end
393
449
  ~~~
394
450
 
@@ -396,7 +452,7 @@ end
396
452
 
397
453
  Name | Type | Description | Notes
398
454
  ------------- | ------------- | ------------- | -------------
399
- **user_id** | **String**| The user id |
455
+ **language** | **String**| The language of the translation to retrieve for the organization |
400
456
  {: class="table table-striped"}
401
457
 
402
458
 
@@ -411,11 +467,11 @@ Name | Type | Description | Notes
411
467
 
412
468
 
413
469
 
414
- <a name="post_languages"></a>
470
+ <a name="get_translations_users_user_id"></a>
415
471
 
416
- ## -[**Language**](Language.html) post_languages(body)
472
+ ## -Hash&lt;String, Object&gt;** get_translations_users_user_id(user_id)
417
473
 
418
- Create Language
474
+ Get effective language translation for a user
419
475
 
420
476
 
421
477
 
@@ -436,15 +492,15 @@ end
436
492
 
437
493
  api_instance = PureCloud::LanguagesApi.new
438
494
 
439
- body = PureCloud::Language.new # Language | Language
495
+ user_id = "user_id_example" # String | The user id
440
496
 
441
497
 
442
498
  begin
443
- #Create Language
444
- result = api_instance.post_languages(body)
499
+ #Get effective language translation for a user
500
+ result = api_instance.get_translations_users_user_id(user_id)
445
501
  p result
446
502
  rescue PureCloud::ApiError => e
447
- puts "Exception when calling LanguagesApi->post_languages: #{e}"
503
+ puts "Exception when calling LanguagesApi->get_translations_users_user_id: #{e}"
448
504
  end
449
505
  ~~~
450
506
 
@@ -452,13 +508,13 @@ end
452
508
 
453
509
  Name | Type | Description | Notes
454
510
  ------------- | ------------- | ------------- | -------------
455
- **body** | [**Language**](Language.html)| Language |
511
+ **user_id** | **String**| The user id |
456
512
  {: class="table table-striped"}
457
513
 
458
514
 
459
515
  ### Return type
460
516
 
461
- [**Language**](Language.html)
517
+ **Hash&lt;String, Object&gt;**
462
518
 
463
519
  ### HTTP request headers
464
520
 
@@ -467,13 +523,13 @@ Name | Type | Description | Notes
467
523
 
468
524
 
469
525
 
470
- <a name="put_language_id"></a>
471
-
472
- ## -[**Language**](Language.html) put_language_id(language_id, body)
526
+ <a name="post_languages"></a>
473
527
 
474
- Update Language
528
+ ## -[**Language**](Language.html) post_languages(body)
475
529
 
530
+ Create Language (Deprecated)
476
531
 
532
+ This endpoint is deprecated. It has been moved to /routing/languages
477
533
 
478
534
  ### Example
479
535
  ~~~ruby
@@ -492,17 +548,15 @@ end
492
548
 
493
549
  api_instance = PureCloud::LanguagesApi.new
494
550
 
495
- language_id = "language_id_example" # String | Language ID
496
-
497
551
  body = PureCloud::Language.new # Language | Language
498
552
 
499
553
 
500
554
  begin
501
- #Update Language
502
- result = api_instance.put_language_id(language_id, body)
555
+ #Create Language (Deprecated)
556
+ result = api_instance.post_languages(body)
503
557
  p result
504
558
  rescue PureCloud::ApiError => e
505
- puts "Exception when calling LanguagesApi->put_language_id: #{e}"
559
+ puts "Exception when calling LanguagesApi->post_languages: #{e}"
506
560
  end
507
561
  ~~~
508
562
 
@@ -510,7 +564,6 @@ end
510
564
 
511
565
  Name | Type | Description | Notes
512
566
  ------------- | ------------- | ------------- | -------------
513
- **language_id** | **String**| Language ID |
514
567
  **body** | [**Language**](Language.html)| Language |
515
568
  {: class="table table-striped"}
516
569