purecloudplatformclientv2 91.0.0 → 96.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (448) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AfterCallWork.md +15 -0
  4. data/docs/AmazonLexRequest.md +14 -0
  5. data/docs/AnalyticsApi.md +67 -1
  6. data/docs/AnalyticsProposedAgent.md +14 -0
  7. data/docs/AnalyticsSession.md +6 -0
  8. data/docs/ArchitectApi.md +51 -49
  9. data/docs/ArrayNode.md +4 -4
  10. data/docs/AuditApi.md +130 -0
  11. data/docs/AuditRealtimeQueryRequest.md +18 -0
  12. data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
  13. data/docs/AvailableTopic.md +1 -0
  14. data/docs/Biography.md +1 -0
  15. data/docs/BuAgentSchedulesQueryResponse.md +1 -0
  16. data/docs/ButtonComponent.md +16 -0
  17. data/docs/Call.md +1 -0
  18. data/docs/CallBasic.md +1 -0
  19. data/docs/Callback.md +1 -0
  20. data/docs/CallbackBasic.md +1 -0
  21. data/docs/CoachingApi.md +115 -30
  22. data/docs/CoachingAppointmentAggregateRequest.md +16 -0
  23. data/docs/CoachingAppointmentAggregateResponse.md +13 -0
  24. data/docs/CoachingAppointmentResponse.md +1 -0
  25. data/docs/CoachingNotification.md +1 -1
  26. data/docs/Cobrowsesession.md +1 -0
  27. data/docs/CommonCampaign.md +17 -0
  28. data/docs/CommonCampaignDivisionView.md +17 -0
  29. data/docs/CommonCampaignDivisionViewEntityListing.md +22 -0
  30. data/docs/CommonCampaignEntityListing.md +22 -0
  31. data/docs/Contact.md +1 -0
  32. data/docs/ContentActions.md +17 -0
  33. data/docs/ContentAttachment.md +19 -0
  34. data/docs/ContentGeneric.md +19 -0
  35. data/docs/ContentList.md +19 -0
  36. data/docs/ContentLocation.md +17 -0
  37. data/docs/ContentNotificationTemplate.md +17 -0
  38. data/docs/ContentQuickReply.md +16 -0
  39. data/docs/ConversationAssociation.md +1 -1
  40. data/docs/ConversationChat.md +1 -0
  41. data/docs/ConversationEventTopicAfterCallWork.md +15 -0
  42. data/docs/ConversationEventTopicCall.md +1 -0
  43. data/docs/ConversationEventTopicCallback.md +1 -0
  44. data/docs/ConversationEventTopicChat.md +1 -0
  45. data/docs/ConversationEventTopicCobrowse.md +1 -0
  46. data/docs/ConversationEventTopicEmail.md +1 -0
  47. data/docs/ConversationEventTopicMessage.md +2 -0
  48. data/docs/ConversationEventTopicScreenshare.md +1 -0
  49. data/docs/ConversationEventTopicSocialExpression.md +1 -0
  50. data/docs/ConversationEventTopicVideo.md +1 -0
  51. data/docs/ConversationMetrics.md +15 -0
  52. data/docs/ConversationsApi.md +73 -4
  53. data/docs/CreateCoachingAppointmentRequest.md +1 -1
  54. data/docs/CursorContactListing.md +16 -0
  55. data/docs/CursorNoteListing.md +16 -0
  56. data/docs/CursorOrganizationListing.md +16 -0
  57. data/docs/CursorRelationshipListing.md +16 -0
  58. data/docs/EdgeGroup.md +1 -0
  59. data/docs/Education.md +17 -0
  60. data/docs/Email.md +1 -0
  61. data/docs/EntityListing.md +1 -5
  62. data/docs/ExternalContactsApi.md +285 -9
  63. data/docs/ExternalOrganizationTrustorLink.md +1 -2
  64. data/docs/FacebookIntegrationUpdateRequest.md +14 -0
  65. data/docs/GoogleDialogflowCustomSettings.md +13 -0
  66. data/docs/HistoricalAdherenceActuals.md +15 -0
  67. data/docs/HistoricalAdherenceDayMetrics.md +23 -0
  68. data/docs/HistoricalAdherenceExceptionInfo.md +21 -0
  69. data/docs/HistoricalAdherenceQueryResult.md +21 -0
  70. data/docs/JourneyAggregateDataContainer.md +14 -0
  71. data/docs/JourneyAggregateQueryClause.md +14 -0
  72. data/docs/JourneyAggregateQueryFilter.md +15 -0
  73. data/docs/JourneyAggregateQueryPredicate.md +17 -0
  74. data/docs/JourneyAggregateQueryResponse.md +13 -0
  75. data/docs/JourneyAggregationQuery.md +21 -0
  76. data/docs/JourneyAggregationView.md +16 -0
  77. data/docs/JourneyApi.md +78 -0
  78. data/docs/JsonNode.md +4 -4
  79. data/docs/KnowledgeSearchRequest.md +3 -3
  80. data/docs/LanguageUnderstandingApi.md +165 -31
  81. data/docs/ListItemComponent.md +19 -0
  82. data/docs/Message.md +1 -0
  83. data/docs/MessageContent.md +19 -0
  84. data/docs/MessagingCampaign.md +28 -0
  85. data/docs/MessagingCampaignDivisionView.md +16 -0
  86. data/docs/MessagingCampaignDivisionViewEntityListing.md +22 -0
  87. data/docs/MessagingCampaignEntityListing.md +22 -0
  88. data/docs/NluDomainVersion.md +2 -1
  89. data/docs/NotificationTemplateBody.md +14 -0
  90. data/docs/NotificationTemplateFooter.md +13 -0
  91. data/docs/NotificationTemplateHeader.md +16 -0
  92. data/docs/NotificationTemplateParameter.md +14 -0
  93. data/docs/NotificationsApi.md +1 -1
  94. data/docs/OAuthClient.md +2 -0
  95. data/docs/OAuthClientListing.md +2 -0
  96. data/docs/OAuthClientRequest.md +2 -0
  97. data/docs/ObservationValue.md +3 -1
  98. data/docs/OrgOAuthClient.md +2 -0
  99. data/docs/OutboundApi.md +881 -76
  100. data/docs/Permissions.md +0 -2
  101. data/docs/PhoneCapabilities.md +1 -0
  102. data/docs/PostTextMessage.md +15 -0
  103. data/docs/PostTextRequest.md +23 -0
  104. data/docs/PostTextResponse.md +20 -0
  105. data/docs/PresenceApi.md +206 -6
  106. data/docs/PresenceExpand.md +17 -0
  107. data/docs/QueryRequestClause.md +14 -0
  108. data/docs/QueryRequestFilter.md +14 -0
  109. data/docs/QueryRequestPredicate.md +14 -0
  110. data/docs/QueryResponseData.md +14 -0
  111. data/docs/QueryResponseGroupedData.md +14 -0
  112. data/docs/QueryResponseMetric.md +14 -0
  113. data/docs/QueryResponseStats.md +13 -0
  114. data/docs/QueueConversationEventTopicAfterCallWork.md +15 -0
  115. data/docs/QueueConversationEventTopicCall.md +1 -0
  116. data/docs/QueueConversationEventTopicCallback.md +1 -0
  117. data/docs/QueueConversationEventTopicChat.md +1 -0
  118. data/docs/QueueConversationEventTopicCobrowse.md +1 -0
  119. data/docs/QueueConversationEventTopicEmail.md +1 -0
  120. data/docs/QueueConversationEventTopicMessage.md +2 -0
  121. data/docs/QueueConversationEventTopicScreenshare.md +1 -0
  122. data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
  123. data/docs/QueueConversationEventTopicVideo.md +1 -0
  124. data/docs/QueueConversationSocialExpressionEventTopicAfterCallWork.md +15 -0
  125. data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
  126. data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
  127. data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
  128. data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
  129. data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
  130. data/docs/QueueConversationSocialExpressionEventTopicMessage.md +2 -0
  131. data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
  132. data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
  133. data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
  134. data/docs/QueueConversationVideoEventTopicAfterCallWork.md +15 -0
  135. data/docs/QueueConversationVideoEventTopicCall.md +1 -0
  136. data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
  137. data/docs/QueueConversationVideoEventTopicChat.md +1 -0
  138. data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
  139. data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
  140. data/docs/QueueConversationVideoEventTopicMessage.md +2 -0
  141. data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
  142. data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
  143. data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
  144. data/docs/Recording.md +1 -0
  145. data/docs/RecordingApi.md +2 -2
  146. data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
  147. data/docs/ReportingExportJobRequest.md +2 -0
  148. data/docs/ReportingExportJobResponse.md +4 -0
  149. data/docs/RoutingApi.md +14 -14
  150. data/docs/SCIMApi.md +92 -104
  151. data/docs/ScimConfigResourceType.md +2 -2
  152. data/docs/ScimGenesysUserExternalId.md +14 -0
  153. data/docs/ScimMetadata.md +2 -2
  154. data/docs/ScimUserExtensions.md +3 -2
  155. data/docs/ScimUserRole.md +1 -1
  156. data/docs/ScimUserRoutingLanguage.md +2 -2
  157. data/docs/ScimUserRoutingSkill.md +2 -2
  158. data/docs/ScimV2CreateUser.md +3 -3
  159. data/docs/ScimV2Group.md +1 -1
  160. data/docs/ScimV2SchemaAttribute.md +11 -11
  161. data/docs/ScimV2SchemaDefinition.md +5 -5
  162. data/docs/ScimV2SchemaListResponse.md +1 -1
  163. data/docs/ScimV2User.md +4 -4
  164. data/docs/Screenshare.md +1 -0
  165. data/docs/SearchApi.md +5 -2
  166. data/docs/SmsConfig.md +15 -0
  167. data/docs/SmsPhoneNumberRef.md +14 -0
  168. data/docs/SocialExpression.md +1 -0
  169. data/docs/SpeechTextAnalyticsApi.md +147 -0
  170. data/docs/StatEventFlowOutcomeTopicDatum.md +14 -0
  171. data/docs/StatEventFlowOutcomeTopicMetric.md +15 -0
  172. data/docs/StatEventFlowOutcomeTopicStatsNotification.md +14 -0
  173. data/docs/StatEventFlowTopicDatum.md +14 -0
  174. data/docs/StatEventFlowTopicMetric.md +15 -0
  175. data/docs/StatEventFlowTopicStatsNotification.md +14 -0
  176. data/docs/StatEventWrapUpCodeTopicDatum.md +14 -0
  177. data/docs/StatEventWrapUpCodeTopicMetric.md +15 -0
  178. data/docs/StatEventWrapUpCodeTopicStatsNotification.md +14 -0
  179. data/docs/SurveyForm.md +0 -2
  180. data/docs/TelephonyProvidersEdgeApi.md +6 -2
  181. data/docs/TextbotsApi.md +78 -0
  182. data/docs/TranscriptUrl.md +13 -0
  183. data/docs/UpdateCoachingAppointmentRequest.md +2 -1
  184. data/docs/UserRoutingLanguage.md +3 -3
  185. data/docs/UserRoutingLanguagePost.md +1 -1
  186. data/docs/UserRoutingSkill.md +1 -1
  187. data/docs/UserScheduleAdherence.md +1 -0
  188. data/docs/UserSearchRequest.md +2 -0
  189. data/docs/UsersApi.md +19 -6
  190. data/docs/Video.md +1 -0
  191. data/docs/ViewFilter.md +2 -0
  192. data/docs/VoicemailUserPolicy.md +1 -0
  193. data/docs/WemCoachingAppointmentTopicCoachingAppointmentNotification.md +1 -0
  194. data/docs/WfmBusinessUnitReference.md +14 -0
  195. data/docs/WfmHistoricalAdherenceResponse.md +1 -0
  196. data/docs/WfmHistoricalAdherenceResultWrapper.md +15 -0
  197. data/docs/WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.md +13 -0
  198. data/docs/WfmHistoricalDataUploadRequestStatusTopicDateTime.md +16 -0
  199. data/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md +20 -0
  200. data/docs/WfmScheduleReference.md +16 -0
  201. data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUriReference.md +14 -0
  202. data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.md +1 -0
  203. data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference.md +13 -0
  204. data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUriReference.md +14 -0
  205. data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserReference.md +13 -0
  206. data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate.md +28 -0
  207. data/docs/WfmUserScheduleAdherenceUpdatedTopicUriReference.md +14 -0
  208. data/docs/WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.md +1 -0
  209. data/lib/purecloudplatformclientv2.rb +91 -0
  210. data/lib/purecloudplatformclientv2/api/analytics_api.rb +67 -2
  211. data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -6
  212. data/lib/purecloudplatformclientv2/api/audit_api.rb +129 -0
  213. data/lib/purecloudplatformclientv2/api/coaching_api.rb +155 -9
  214. data/lib/purecloudplatformclientv2/api/conversations_api.rb +79 -4
  215. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +305 -13
  216. data/lib/purecloudplatformclientv2/api/journey_api.rb +92 -0
  217. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +191 -32
  218. data/lib/purecloudplatformclientv2/api/outbound_api.rb +1215 -155
  219. data/lib/purecloudplatformclientv2/api/presence_api.rb +213 -8
  220. data/lib/purecloudplatformclientv2/api/recording_api.rb +3 -3
  221. data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
  222. data/lib/purecloudplatformclientv2/api/scim_api.rb +74 -74
  223. data/lib/purecloudplatformclientv2/api/search_api.rb +13 -0
  224. data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +167 -0
  225. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +18 -0
  226. data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
  227. data/lib/purecloudplatformclientv2/api/users_api.rb +78 -0
  228. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  229. data/lib/purecloudplatformclientv2/models/acw_settings.rb +2 -2
  230. data/lib/purecloudplatformclientv2/models/after_call_work.rb +267 -0
  231. data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
  232. data/lib/purecloudplatformclientv2/models/analytics_proposed_agent.rb +228 -0
  233. data/lib/purecloudplatformclientv2/models/analytics_session.rb +178 -4
  234. data/lib/purecloudplatformclientv2/models/array_node.rb +54 -54
  235. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
  236. data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +2 -2
  237. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +2 -2
  238. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +2 -2
  239. data/lib/purecloudplatformclientv2/models/audit_query_service.rb +2 -2
  240. data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
  241. data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
  242. data/lib/purecloudplatformclientv2/models/available_topic.rb +32 -4
  243. data/lib/purecloudplatformclientv2/models/biography.rb +32 -4
  244. data/lib/purecloudplatformclientv2/models/bu_agent_schedules_query_response.rb +30 -4
  245. data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
  246. data/lib/purecloudplatformclientv2/models/call.rb +30 -4
  247. data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
  248. data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
  249. data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
  250. data/lib/purecloudplatformclientv2/models/coaching_appointment_aggregate_request.rb +294 -0
  251. data/lib/purecloudplatformclientv2/models/coaching_appointment_aggregate_response.rb +204 -0
  252. data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +27 -1
  253. data/lib/purecloudplatformclientv2/models/coaching_notification.rb +1 -1
  254. data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
  255. data/lib/purecloudplatformclientv2/models/common_campaign.rb +320 -0
  256. data/lib/purecloudplatformclientv2/models/common_campaign_division_view.rb +320 -0
  257. data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +428 -0
  258. data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +428 -0
  259. data/lib/purecloudplatformclientv2/models/contact.rb +29 -4
  260. data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
  261. data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
  262. data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
  263. data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
  264. data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
  265. data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
  266. data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
  267. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  268. data/lib/purecloudplatformclientv2/models/conversation_association.rb +1 -1
  269. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
  270. data/lib/purecloudplatformclientv2/models/conversation_event_topic_after_call_work.rb +265 -0
  271. data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
  272. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
  273. data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
  274. data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
  275. data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
  276. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +53 -3
  277. data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
  278. data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
  279. data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
  280. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_media_participant.rb +2 -2
  281. data/lib/purecloudplatformclientv2/models/conversation_metrics.rb +254 -0
  282. data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb +1 -1
  283. data/lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb +2 -2
  284. data/lib/purecloudplatformclientv2/models/cursor_contact_listing.rb +278 -0
  285. data/lib/purecloudplatformclientv2/models/cursor_note_listing.rb +278 -0
  286. data/lib/purecloudplatformclientv2/models/cursor_organization_listing.rb +278 -0
  287. data/lib/purecloudplatformclientv2/models/cursor_relationship_listing.rb +278 -0
  288. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  289. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  290. data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
  291. data/lib/purecloudplatformclientv2/models/education.rb +304 -0
  292. data/lib/purecloudplatformclientv2/models/email.rb +30 -4
  293. data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
  294. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  295. data/lib/purecloudplatformclientv2/models/external_organization_trustor_link.rb +8 -34
  296. data/lib/purecloudplatformclientv2/models/facebook_integration_update_request.rb +228 -0
  297. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  298. data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
  299. data/lib/purecloudplatformclientv2/models/historical_adherence_actuals.rb +268 -0
  300. data/lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb +462 -0
  301. data/lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb +466 -0
  302. data/lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb +430 -0
  303. data/lib/purecloudplatformclientv2/models/intent_feedback.rb +2 -2
  304. data/lib/purecloudplatformclientv2/models/ip_address_range.rb +2 -2
  305. data/lib/purecloudplatformclientv2/models/journey_aggregate_data_container.rb +231 -0
  306. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_clause.rb +254 -0
  307. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_filter.rb +277 -0
  308. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_predicate.rb +348 -0
  309. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_response.rb +203 -0
  310. data/lib/purecloudplatformclientv2/models/journey_aggregation_query.rb +435 -0
  311. data/lib/purecloudplatformclientv2/models/journey_aggregation_view.rb +323 -0
  312. data/lib/purecloudplatformclientv2/models/json_node.rb +54 -54
  313. data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +0 -15
  314. data/lib/purecloudplatformclientv2/models/library.rb +2 -2
  315. data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
  316. data/lib/purecloudplatformclientv2/models/message.rb +32 -6
  317. data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
  318. data/lib/purecloudplatformclientv2/models/message_data.rb +2 -2
  319. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +2 -2
  320. data/lib/purecloudplatformclientv2/models/messaging_campaign.rb +621 -0
  321. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view.rb +279 -0
  322. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +428 -0
  323. data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +428 -0
  324. data/lib/purecloudplatformclientv2/models/messaging_integration.rb +2 -2
  325. data/lib/purecloudplatformclientv2/models/messaging_sticker.rb +2 -2
  326. data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +32 -1
  327. data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
  328. data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
  329. data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
  330. data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
  331. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +67 -1
  332. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +67 -1
  333. data/lib/purecloudplatformclientv2/models/o_auth_client_request.rb +70 -4
  334. data/lib/purecloudplatformclientv2/models/observation_value.rb +70 -2
  335. data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +67 -1
  336. data/lib/purecloudplatformclientv2/models/participant.rb +2 -2
  337. data/lib/purecloudplatformclientv2/models/participant_basic.rb +2 -2
  338. data/lib/purecloudplatformclientv2/models/permissions.rb +1 -52
  339. data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +29 -4
  340. data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
  341. data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
  342. data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
  343. data/lib/purecloudplatformclientv2/models/presence_expand.rb +309 -0
  344. data/lib/purecloudplatformclientv2/models/query_request_clause.rb +254 -0
  345. data/lib/purecloudplatformclientv2/models/query_request_filter.rb +254 -0
  346. data/lib/purecloudplatformclientv2/models/query_request_predicate.rb +252 -0
  347. data/lib/purecloudplatformclientv2/models/query_response_data.rb +230 -0
  348. data/lib/purecloudplatformclientv2/models/query_response_grouped_data.rb +232 -0
  349. data/lib/purecloudplatformclientv2/models/query_response_metric.rb +242 -0
  350. data/lib/purecloudplatformclientv2/models/query_response_stats.rb +202 -0
  351. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_after_call_work.rb +265 -0
  352. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
  353. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
  354. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
  355. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
  356. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
  357. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +53 -3
  358. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
  359. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
  360. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
  361. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media_participant.rb +2 -2
  362. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_after_call_work.rb +265 -0
  363. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
  364. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
  365. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
  366. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
  367. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
  368. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +53 -3
  369. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
  370. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
  371. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
  372. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_after_call_work.rb +265 -0
  373. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
  374. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
  375. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
  376. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
  377. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
  378. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +53 -3
  379. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
  380. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
  381. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
  382. data/lib/purecloudplatformclientv2/models/recipient.rb +2 -2
  383. data/lib/purecloudplatformclientv2/models/recording.rb +41 -1
  384. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +26 -1
  385. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +53 -1
  386. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +109 -1
  387. data/lib/purecloudplatformclientv2/models/response.rb +2 -2
  388. data/lib/purecloudplatformclientv2/models/schedule_generation_message.rb +2 -2
  389. data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +2 -2
  390. data/lib/purecloudplatformclientv2/models/scim_genesys_user_external_id.rb +229 -0
  391. data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
  392. data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
  393. data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +35 -7
  394. data/lib/purecloudplatformclientv2/models/scim_user_role.rb +1 -1
  395. data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +3 -3
  396. data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +3 -3
  397. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -2
  398. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
  399. data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +1 -1
  400. data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +12 -12
  401. data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +6 -6
  402. data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +2 -2
  403. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +4 -3
  404. data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
  405. data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
  406. data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_request.rb +2 -2
  407. data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_response.rb +2 -2
  408. data/lib/purecloudplatformclientv2/models/sms_config.rb +269 -0
  409. data/lib/purecloudplatformclientv2/models/sms_phone_number_ref.rb +232 -0
  410. data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
  411. data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_datum.rb +228 -0
  412. data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_metric.rb +253 -0
  413. data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_stats_notification.rb +230 -0
  414. data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_datum.rb +228 -0
  415. data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_metric.rb +253 -0
  416. data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_stats_notification.rb +230 -0
  417. data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_datum.rb +228 -0
  418. data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_metric.rb +253 -0
  419. data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_stats_notification.rb +230 -0
  420. data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
  421. data/lib/purecloudplatformclientv2/models/transcript_url.rb +202 -0
  422. data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +45 -5
  423. data/lib/purecloudplatformclientv2/models/user_routing_language.rb +4 -4
  424. data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +1 -1
  425. data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +1 -1
  426. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +27 -1
  427. data/lib/purecloudplatformclientv2/models/user_search_request.rb +70 -4
  428. data/lib/purecloudplatformclientv2/models/video.rb +30 -4
  429. data/lib/purecloudplatformclientv2/models/view_filter.rb +60 -4
  430. data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +30 -4
  431. data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +33 -8
  432. data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +233 -0
  433. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +27 -1
  434. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper.rb +258 -0
  435. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_purge_request_status_topic_historical_data_upload_purge_request_update.rb +215 -0
  436. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time.rb +276 -0
  437. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update.rb +390 -0
  438. data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +295 -0
  439. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_uri_reference.rb +226 -0
  440. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_user_schedule_adherence_update.rb +26 -1
  441. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_queue_reference.rb +201 -0
  442. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_uri_reference.rb +226 -0
  443. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_reference.rb +201 -0
  444. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_schedule_adherence_update.rb +606 -0
  445. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_uri_reference.rb +226 -0
  446. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb +26 -1
  447. data/lib/purecloudplatformclientv2/version.rb +1 -1
  448. metadata +185 -3
@@ -309,9 +309,9 @@ module PureCloud
309
309
  end
310
310
 
311
311
  # Get a user's Presence
312
- #
312
+ # Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources.
313
313
  # @param user_id user Id
314
- # @param source_id Source
314
+ # @param source_id Presence source ID
315
315
  # @param [Hash] opts the optional parameters
316
316
  # @return [UserPresence]
317
317
  def get_user_presence(user_id, source_id, opts = {})
@@ -320,9 +320,9 @@ module PureCloud
320
320
  end
321
321
 
322
322
  # Get a user's Presence
323
- #
323
+ # Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources.
324
324
  # @param user_id user Id
325
- # @param source_id Source
325
+ # @param source_id Presence source ID
326
326
  # @param [Hash] opts the optional parameters
327
327
  # @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
328
328
  def get_user_presence_with_http_info(user_id, source_id, opts = {})
@@ -383,10 +383,140 @@ module PureCloud
383
383
  return data, status_code, headers
384
384
  end
385
385
 
386
+ # Get a user's Microsoft Teams presence.
387
+ # Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
388
+ # @param user_id user Id
389
+ # @param [Hash] opts the optional parameters
390
+ # @return [PresenceExpand]
391
+ def get_user_presences_microsoftteams(user_id, opts = {})
392
+ data, _status_code, _headers = get_user_presences_microsoftteams_with_http_info(user_id, opts)
393
+ return data
394
+ end
395
+
396
+ # Get a user&#39;s Microsoft Teams presence.
397
+ # Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
398
+ # @param user_id user Id
399
+ # @param [Hash] opts the optional parameters
400
+ # @return [Array<(PresenceExpand, Fixnum, Hash)>] PresenceExpand data, response status code and response headers
401
+ def get_user_presences_microsoftteams_with_http_info(user_id, opts = {})
402
+ if @api_client.config.debugging
403
+ @api_client.config.logger.debug "Calling API: PresenceApi.get_user_presences_microsoftteams ..."
404
+ end
405
+
406
+
407
+ # verify the required parameter 'user_id' is set
408
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling PresenceApi.get_user_presences_microsoftteams" if user_id.nil?
409
+
410
+
411
+
412
+
413
+
414
+ # resource path
415
+ local_var_path = "/api/v2/users/{userId}/presences/microsoftteams".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
416
+
417
+ # query parameters
418
+ query_params = {}
419
+
420
+ # header parameters
421
+ header_params = {}
422
+
423
+ # HTTP header 'Accept' (if needed)
424
+ local_header_accept = ['application/json']
425
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
426
+
427
+ # HTTP header 'Content-Type'
428
+ local_header_content_type = ['application/json']
429
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
430
+
431
+ # form parameters
432
+ form_params = {}
433
+
434
+ # http body (model)
435
+ post_body = nil
436
+
437
+ auth_names = ['PureCloud OAuth']
438
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
439
+ :header_params => header_params,
440
+ :query_params => query_params,
441
+ :form_params => form_params,
442
+ :body => post_body,
443
+ :auth_names => auth_names,
444
+ :return_type => 'PresenceExpand')
445
+ if @api_client.config.debugging
446
+ @api_client.config.logger.debug "API called: PresenceApi#get_user_presences_microsoftteams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
447
+ end
448
+ return data, status_code, headers
449
+ end
450
+
451
+ # Get a user's Genesys Cloud presence.
452
+ # Get the default Genesys Cloud user presence source PURECLOUD
453
+ # @param user_id user Id
454
+ # @param [Hash] opts the optional parameters
455
+ # @return [UserPresence]
456
+ def get_user_presences_purecloud(user_id, opts = {})
457
+ data, _status_code, _headers = get_user_presences_purecloud_with_http_info(user_id, opts)
458
+ return data
459
+ end
460
+
461
+ # Get a user&#39;s Genesys Cloud presence.
462
+ # Get the default Genesys Cloud user presence source PURECLOUD
463
+ # @param user_id user Id
464
+ # @param [Hash] opts the optional parameters
465
+ # @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
466
+ def get_user_presences_purecloud_with_http_info(user_id, opts = {})
467
+ if @api_client.config.debugging
468
+ @api_client.config.logger.debug "Calling API: PresenceApi.get_user_presences_purecloud ..."
469
+ end
470
+
471
+
472
+ # verify the required parameter 'user_id' is set
473
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling PresenceApi.get_user_presences_purecloud" if user_id.nil?
474
+
475
+
476
+
477
+
478
+
479
+ # resource path
480
+ local_var_path = "/api/v2/users/{userId}/presences/purecloud".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
481
+
482
+ # query parameters
483
+ query_params = {}
484
+
485
+ # header parameters
486
+ header_params = {}
487
+
488
+ # HTTP header 'Accept' (if needed)
489
+ local_header_accept = ['application/json']
490
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
491
+
492
+ # HTTP header 'Content-Type'
493
+ local_header_content_type = ['application/json']
494
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
495
+
496
+ # form parameters
497
+ form_params = {}
498
+
499
+ # http body (model)
500
+ post_body = nil
501
+
502
+ auth_names = ['PureCloud OAuth']
503
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
504
+ :header_params => header_params,
505
+ :query_params => query_params,
506
+ :form_params => form_params,
507
+ :body => post_body,
508
+ :auth_names => auth_names,
509
+ :return_type => 'UserPresence')
510
+ if @api_client.config.debugging
511
+ @api_client.config.logger.debug "API called: PresenceApi#get_user_presences_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
512
+ end
513
+ return data, status_code, headers
514
+ end
515
+
386
516
  # Patch a user's Presence
387
- # The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
517
+ # Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
388
518
  # @param user_id user Id
389
- # @param source_id Source
519
+ # @param source_id Presence source ID
390
520
  # @param body User presence
391
521
  # @param [Hash] opts the optional parameters
392
522
  # @return [UserPresence]
@@ -396,9 +526,9 @@ module PureCloud
396
526
  end
397
527
 
398
528
  # Patch a user&#39;s Presence
399
- # The presence object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the &#39;source&#39; defined in the path as the user&#39;s primary presence source. Option 2: Provide the presenceDefinition value. The &#39;id&#39; is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
529
+ # Patch a user&#39;s presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the &#39;source&#39; defined in the path as the user&#39;s primary presence source. Option 2: Provide the presenceDefinition value. The &#39;id&#39; is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
400
530
  # @param user_id user Id
401
- # @param source_id Source
531
+ # @param source_id Presence source ID
402
532
  # @param body User presence
403
533
  # @param [Hash] opts the optional parameters
404
534
  # @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
@@ -468,6 +598,81 @@ module PureCloud
468
598
  return data, status_code, headers
469
599
  end
470
600
 
601
+ # Patch a Genesys Cloud user's presence
602
+ # The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
603
+ # @param user_id user Id
604
+ # @param body User presence
605
+ # @param [Hash] opts the optional parameters
606
+ # @return [UserPresence]
607
+ def patch_user_presences_purecloud(user_id, body, opts = {})
608
+ data, _status_code, _headers = patch_user_presences_purecloud_with_http_info(user_id, body, opts)
609
+ return data
610
+ end
611
+
612
+ # Patch a Genesys Cloud user&#39;s presence
613
+ # The presence object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the PURECLOUD source as the user&#39;s primary presence source. Option 2: Provide the presenceDefinition value. The &#39;id&#39; is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
614
+ # @param user_id user Id
615
+ # @param body User presence
616
+ # @param [Hash] opts the optional parameters
617
+ # @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
618
+ def patch_user_presences_purecloud_with_http_info(user_id, body, opts = {})
619
+ if @api_client.config.debugging
620
+ @api_client.config.logger.debug "Calling API: PresenceApi.patch_user_presences_purecloud ..."
621
+ end
622
+
623
+
624
+ # verify the required parameter 'user_id' is set
625
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling PresenceApi.patch_user_presences_purecloud" if user_id.nil?
626
+
627
+
628
+
629
+
630
+
631
+
632
+ # verify the required parameter 'body' is set
633
+ fail ArgumentError, "Missing the required parameter 'body' when calling PresenceApi.patch_user_presences_purecloud" if body.nil?
634
+
635
+
636
+
637
+
638
+
639
+ # resource path
640
+ local_var_path = "/api/v2/users/{userId}/presences/purecloud".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
641
+
642
+ # query parameters
643
+ query_params = {}
644
+
645
+ # header parameters
646
+ header_params = {}
647
+
648
+ # HTTP header 'Accept' (if needed)
649
+ local_header_accept = ['application/json']
650
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
651
+
652
+ # HTTP header 'Content-Type'
653
+ local_header_content_type = ['application/json']
654
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
655
+
656
+ # form parameters
657
+ form_params = {}
658
+
659
+ # http body (model)
660
+ post_body = @api_client.object_to_http_body(body)
661
+
662
+ auth_names = ['PureCloud OAuth']
663
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
664
+ :header_params => header_params,
665
+ :query_params => query_params,
666
+ :form_params => form_params,
667
+ :body => post_body,
668
+ :auth_names => auth_names,
669
+ :return_type => 'UserPresence')
670
+ if @api_client.config.debugging
671
+ @api_client.config.logger.debug "API called: PresenceApi#patch_user_presences_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
672
+ end
673
+ return data, status_code, headers
674
+ end
675
+
471
676
  # Create a Presence Definition
472
677
  #
473
678
  # @param body The Presence Definition to create
@@ -684,7 +684,7 @@ module PureCloud
684
684
  #
685
685
  # @param conversation_id Conversation ID
686
686
  # @param [Hash] opts the optional parameters
687
- # @return [Array<Recording>]
687
+ # @return [Array<RecordingMetadata>]
688
688
  def get_conversation_recordingmetadata(conversation_id, opts = {})
689
689
  data, _status_code, _headers = get_conversation_recordingmetadata_with_http_info(conversation_id, opts)
690
690
  return data
@@ -694,7 +694,7 @@ module PureCloud
694
694
  #
695
695
  # @param conversation_id Conversation ID
696
696
  # @param [Hash] opts the optional parameters
697
- # @return [Array<(Array<Recording>, Fixnum, Hash)>] Array<Recording> data, response status code and response headers
697
+ # @return [Array<(Array<RecordingMetadata>, Fixnum, Hash)>] Array<RecordingMetadata> data, response status code and response headers
698
698
  def get_conversation_recordingmetadata_with_http_info(conversation_id, opts = {})
699
699
  if @api_client.config.debugging
700
700
  @api_client.config.logger.debug "Calling API: RecordingApi.get_conversation_recordingmetadata ..."
@@ -738,7 +738,7 @@ module PureCloud
738
738
  :form_params => form_params,
739
739
  :body => post_body,
740
740
  :auth_names => auth_names,
741
- :return_type => 'Array<Recording>')
741
+ :return_type => 'Array<RecordingMetadata>')
742
742
  if @api_client.config.debugging
743
743
  @api_client.config.logger.debug "API called: RecordingApi#get_conversation_recordingmetadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
744
744
  end
@@ -1497,8 +1497,8 @@ module PureCloud
1497
1497
 
1498
1498
 
1499
1499
 
1500
- if opts[:'messenger_type'] && !['sms', 'facebook', 'twitter', 'line', 'whatsapp'].include?(opts[:'messenger_type'])
1501
- fail ArgumentError, 'invalid value for "messenger_type", must be one of sms, facebook, twitter, line, whatsapp'
1500
+ if opts[:'messenger_type'] && !['sms', 'facebook', 'twitter', 'line', 'whatsapp', 'webmessaging'].include?(opts[:'messenger_type'])
1501
+ fail ArgumentError, 'invalid value for "messenger_type", must be one of sms, facebook, twitter, line, whatsapp, webmessaging'
1502
1502
  end
1503
1503
 
1504
1504
 
@@ -24,22 +24,22 @@ module PureCloud
24
24
  @api_client = api_client
25
25
  end
26
26
 
27
- # Delete a group.
27
+ # Delete a group
28
28
  #
29
- # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
29
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
30
30
  # @param [Hash] opts the optional parameters
31
- # @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
31
+ # @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
32
32
  # @return [nil]
33
33
  def delete_scim_group(group_id, opts = {})
34
34
  delete_scim_group_with_http_info(group_id, opts)
35
35
  return nil
36
36
  end
37
37
 
38
- # Delete a group.
38
+ # Delete a group
39
39
  #
40
- # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
40
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
41
41
  # @param [Hash] opts the optional parameters
42
- # @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
42
+ # @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
43
43
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
44
44
  def delete_scim_group_with_http_info(group_id, opts = {})
45
45
  if @api_client.config.debugging
@@ -171,22 +171,22 @@ module PureCloud
171
171
  return data, status_code, headers
172
172
  end
173
173
 
174
- # Delete a group.
174
+ # Delete a group
175
175
  #
176
- # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
176
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
177
177
  # @param [Hash] opts the optional parameters
178
- # @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
178
+ # @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
179
179
  # @return [nil]
180
180
  def delete_scim_v2_group(group_id, opts = {})
181
181
  delete_scim_v2_group_with_http_info(group_id, opts)
182
182
  return nil
183
183
  end
184
184
 
185
- # Delete a group.
185
+ # Delete a group
186
186
  #
187
- # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
187
+ # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
188
188
  # @param [Hash] opts the optional parameters
189
- # @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
189
+ # @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;.
190
190
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
191
191
  def delete_scim_v2_group_with_http_info(group_id, opts = {})
192
192
  if @api_client.config.debugging
@@ -323,7 +323,7 @@ module PureCloud
323
323
  # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
324
324
  # @param [Hash] opts the optional parameters
325
325
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
326
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
326
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
327
327
  # @option opts [String] :if_none_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
328
328
  # @return [ScimV2Group]
329
329
  def get_scim_group(group_id, opts = {})
@@ -336,7 +336,7 @@ module PureCloud
336
336
  # @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
337
337
  # @param [Hash] opts the optional parameters
338
338
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
339
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
339
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
340
340
  # @option opts [String] :if_none_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
341
341
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
342
342
  def get_scim_group_with_http_info(group_id, opts = {})
@@ -414,10 +414,10 @@ module PureCloud
414
414
  #
415
415
  # @param [Hash] opts the optional parameters
416
416
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
417
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
417
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
418
418
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
419
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
420
- # @option opts [String] :filter Filters results.
419
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
420
+ # @option opts [String] :filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \&quot;id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\&quot;, \&quot;displayname eq Sales\&quot;.
421
421
  # @return [ScimGroupListResponse]
422
422
  def get_scim_groups(opts = {})
423
423
  data, _status_code, _headers = get_scim_groups_with_http_info(opts)
@@ -428,10 +428,10 @@ module PureCloud
428
428
  #
429
429
  # @param [Hash] opts the optional parameters
430
430
  # @option opts [Integer] :start_index The 1-based index of the first query result.
431
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
431
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
432
432
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
433
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
434
- # @option opts [String] :filter Filters results.
433
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
434
+ # @option opts [String] :filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \&quot;id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\&quot;, \&quot;displayname eq Sales\&quot;.
435
435
  # @return [Array<(ScimGroupListResponse, Fixnum, Hash)>] ScimGroupListResponse data, response status code and response headers
436
436
  def get_scim_groups_with_http_info(opts = {})
437
437
  if @api_client.config.debugging
@@ -635,21 +635,21 @@ module PureCloud
635
635
  return data, status_code, headers
636
636
  end
637
637
 
638
- # Get the SCIM schema by id
638
+ # Get a SCIM schema
639
639
  #
640
- # @param schema_id The ID of a schema.
640
+ # @param schema_id The ID of a schema. Returned with GET /api/v2/scim/schemas.
641
641
  # @param [Hash] opts the optional parameters
642
- # @return [ScimConfigResourceType]
642
+ # @return [ScimV2SchemaDefinition]
643
643
  def get_scim_schema(schema_id, opts = {})
644
644
  data, _status_code, _headers = get_scim_schema_with_http_info(schema_id, opts)
645
645
  return data
646
646
  end
647
647
 
648
- # Get the SCIM schema by id
648
+ # Get a SCIM schema
649
649
  #
650
- # @param schema_id The ID of a schema.
650
+ # @param schema_id The ID of a schema. Returned with GET /api/v2/scim/schemas.
651
651
  # @param [Hash] opts the optional parameters
652
- # @return [Array<(ScimConfigResourceType, Fixnum, Hash)>] ScimConfigResourceType data, response status code and response headers
652
+ # @return [Array<(ScimV2SchemaDefinition, Fixnum, Hash)>] ScimV2SchemaDefinition data, response status code and response headers
653
653
  def get_scim_schema_with_http_info(schema_id, opts = {})
654
654
  if @api_client.config.debugging
655
655
  @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_schema ..."
@@ -698,28 +698,28 @@ module PureCloud
698
698
  :form_params => form_params,
699
699
  :body => post_body,
700
700
  :auth_names => auth_names,
701
- :return_type => 'ScimConfigResourceType')
701
+ :return_type => 'ScimV2SchemaDefinition')
702
702
  if @api_client.config.debugging
703
703
  @api_client.config.logger.debug "API called: SCIMApi#get_scim_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
704
704
  end
705
705
  return data, status_code, headers
706
706
  end
707
707
 
708
- # Get the SCIM schemas
708
+ # Get a list of SCIM schemas
709
709
  #
710
710
  # @param [Hash] opts the optional parameters
711
- # @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
712
- # @return [ScimConfigResourceTypesListResponse]
711
+ # @option opts [String] :filter Filtered results are invalid and return 403 Unauthorized.
712
+ # @return [ScimV2SchemaListResponse]
713
713
  def get_scim_schemas(opts = {})
714
714
  data, _status_code, _headers = get_scim_schemas_with_http_info(opts)
715
715
  return data
716
716
  end
717
717
 
718
- # Get the SCIM schemas
718
+ # Get a list of SCIM schemas
719
719
  #
720
720
  # @param [Hash] opts the optional parameters
721
- # @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
722
- # @return [Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>] ScimConfigResourceTypesListResponse data, response status code and response headers
721
+ # @option opts [String] :filter Filtered results are invalid and return 403 Unauthorized.
722
+ # @return [Array<(ScimV2SchemaListResponse, Fixnum, Hash)>] ScimV2SchemaListResponse data, response status code and response headers
723
723
  def get_scim_schemas_with_http_info(opts = {})
724
724
  if @api_client.config.debugging
725
725
  @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_schemas ..."
@@ -762,7 +762,7 @@ module PureCloud
762
762
  :form_params => form_params,
763
763
  :body => post_body,
764
764
  :auth_names => auth_names,
765
- :return_type => 'ScimConfigResourceTypesListResponse')
765
+ :return_type => 'ScimV2SchemaListResponse')
766
766
  if @api_client.config.debugging
767
767
  @api_client.config.logger.debug "API called: SCIMApi#get_scim_schemas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
768
768
  end
@@ -926,13 +926,13 @@ module PureCloud
926
926
  end
927
927
 
928
928
  # Get a list of users
929
- # To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
929
+ # To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
930
930
  # @param [Hash] opts the optional parameters
931
931
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
932
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
932
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
933
933
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
934
934
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
935
- # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
935
+ # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;, \&quot;employeeNumber eq 9876543210\&quot;.
936
936
  # @return [ScimUserListResponse]
937
937
  def get_scim_users(opts = {})
938
938
  data, _status_code, _headers = get_scim_users_with_http_info(opts)
@@ -940,13 +940,13 @@ module PureCloud
940
940
  end
941
941
 
942
942
  # Get a list of users
943
- # To return all active users, do not use a filter parameter. To return inactive users, set \&quot;filter\&quot; to \&quot;active eq false\&quot;. By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \&quot;attributes\&quot; to \&quot;id,active\&quot; or \&quot;excludeAttributes\&quot; to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.
943
+ # To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \&quot;active eq false\&quot;. By default, returns SCIM attributes \&quot;externalId\&quot;, \&quot;enterprise-user:manager\&quot;, and \&quot;roles\&quot;. To exclude these attributes, set the attributes parameter to \&quot;id,active\&quot; or the excludeAttributes parameter to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.
944
944
  # @param [Hash] opts the optional parameters
945
945
  # @option opts [Integer] :start_index The 1-based index of the first query result.
946
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
946
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
947
947
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
948
948
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
949
- # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
949
+ # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;, \&quot;employeeNumber eq 9876543210\&quot;.
950
950
  # @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers
951
951
  def get_scim_users_with_http_info(opts = {})
952
952
  if @api_client.config.debugging
@@ -1030,8 +1030,8 @@ module PureCloud
1030
1030
  # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
1031
1031
  # @param [Hash] opts the optional parameters
1032
1032
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1033
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
1034
- # @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
1033
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
1034
+ # @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
1035
1035
  # @return [ScimV2Group]
1036
1036
  def get_scim_v2_group(group_id, opts = {})
1037
1037
  data, _status_code, _headers = get_scim_v2_group_with_http_info(group_id, opts)
@@ -1043,8 +1043,8 @@ module PureCloud
1043
1043
  # @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
1044
1044
  # @param [Hash] opts the optional parameters
1045
1045
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1046
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
1047
- # @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
1046
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
1047
+ # @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
1048
1048
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
1049
1049
  def get_scim_v2_group_with_http_info(group_id, opts = {})
1050
1050
  if @api_client.config.debugging
@@ -1119,12 +1119,12 @@ module PureCloud
1119
1119
 
1120
1120
  # Get a list of groups
1121
1121
  #
1122
- # @param filter Filters results.
1122
+ # @param filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \&quot;id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\&quot;, \&quot;displayname eq Sales\&quot;.
1123
1123
  # @param [Hash] opts the optional parameters
1124
1124
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
1125
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
1125
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
1126
1126
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1127
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
1127
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
1128
1128
  # @return [ScimGroupListResponse]
1129
1129
  def get_scim_v2_groups(filter, opts = {})
1130
1130
  data, _status_code, _headers = get_scim_v2_groups_with_http_info(filter, opts)
@@ -1133,12 +1133,12 @@ module PureCloud
1133
1133
 
1134
1134
  # Get a list of groups
1135
1135
  #
1136
- # @param filter Filters results.
1136
+ # @param filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \&quot;id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\&quot;, \&quot;displayname eq Sales\&quot;.
1137
1137
  # @param [Hash] opts the optional parameters
1138
1138
  # @option opts [Integer] :start_index The 1-based index of the first query result.
1139
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
1139
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
1140
1140
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1141
- # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
1141
+ # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
1142
1142
  # @return [Array<(ScimGroupListResponse, Fixnum, Hash)>] ScimGroupListResponse data, response status code and response headers
1143
1143
  def get_scim_v2_groups_with_http_info(filter, opts = {})
1144
1144
  if @api_client.config.debugging
@@ -1344,9 +1344,9 @@ module PureCloud
1344
1344
  return data, status_code, headers
1345
1345
  end
1346
1346
 
1347
- # Get the SCIM schema by id
1347
+ # Get a SCIM schema
1348
1348
  #
1349
- # @param schema_id The ID of a schema.
1349
+ # @param schema_id The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.
1350
1350
  # @param [Hash] opts the optional parameters
1351
1351
  # @return [ScimV2SchemaDefinition]
1352
1352
  def get_scim_v2_schema(schema_id, opts = {})
@@ -1354,9 +1354,9 @@ module PureCloud
1354
1354
  return data
1355
1355
  end
1356
1356
 
1357
- # Get the SCIM schema by id
1357
+ # Get a SCIM schema
1358
1358
  #
1359
- # @param schema_id The ID of a schema.
1359
+ # @param schema_id The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.
1360
1360
  # @param [Hash] opts the optional parameters
1361
1361
  # @return [Array<(ScimV2SchemaDefinition, Fixnum, Hash)>] ScimV2SchemaDefinition data, response status code and response headers
1362
1362
  def get_scim_v2_schema_with_http_info(schema_id, opts = {})
@@ -1414,20 +1414,20 @@ module PureCloud
1414
1414
  return data, status_code, headers
1415
1415
  end
1416
1416
 
1417
- # Get the SCIM schemas
1417
+ # Get a list of SCIM schemas
1418
1418
  #
1419
1419
  # @param [Hash] opts the optional parameters
1420
- # @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
1420
+ # @option opts [String] :filter Filtered results are invalid and return 403 Unauthorized.
1421
1421
  # @return [ScimV2SchemaListResponse]
1422
1422
  def get_scim_v2_schemas(opts = {})
1423
1423
  data, _status_code, _headers = get_scim_v2_schemas_with_http_info(opts)
1424
1424
  return data
1425
1425
  end
1426
1426
 
1427
- # Get the SCIM schemas
1427
+ # Get a list of SCIM schemas
1428
1428
  #
1429
1429
  # @param [Hash] opts the optional parameters
1430
- # @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
1430
+ # @option opts [String] :filter Filtered results are invalid and return 403 Unauthorized.
1431
1431
  # @return [Array<(ScimV2SchemaListResponse, Fixnum, Hash)>] ScimV2SchemaListResponse data, response status code and response headers
1432
1432
  def get_scim_v2_schemas_with_http_info(opts = {})
1433
1433
  if @api_client.config.debugging
@@ -1635,13 +1635,13 @@ module PureCloud
1635
1635
  end
1636
1636
 
1637
1637
  # Get a list of users
1638
- # To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
1638
+ # To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
1639
1639
  # @param [Hash] opts the optional parameters
1640
1640
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
1641
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
1641
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
1642
1642
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1643
1643
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
1644
- # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
1644
+ # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;, \&quot;employeeNumber eq 9876543210\&quot;.
1645
1645
  # @return [ScimUserListResponse]
1646
1646
  def get_scim_v2_users(opts = {})
1647
1647
  data, _status_code, _headers = get_scim_v2_users_with_http_info(opts)
@@ -1649,13 +1649,13 @@ module PureCloud
1649
1649
  end
1650
1650
 
1651
1651
  # Get a list of users
1652
- # To return all active users, do not use a filter parameter. To return inactive users, set \&quot;filter\&quot; to \&quot;active eq false\&quot;. By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \&quot;attributes\&quot; to \&quot;id,active\&quot; or \&quot;excludeAttributes\&quot; to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.
1652
+ # To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \&quot;active eq false\&quot;. By default, returns SCIM attributes \&quot;externalId\&quot;, \&quot;enterprise-user:manager\&quot;, and \&quot;roles\&quot;. To exclude these attributes, set the attributes parameter to \&quot;id,active\&quot; or the excludeAttributes parameter to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.
1653
1653
  # @param [Hash] opts the optional parameters
1654
1654
  # @option opts [Integer] :start_index The 1-based index of the first query result.
1655
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
1655
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
1656
1656
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1657
1657
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
1658
- # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
1658
+ # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;, \&quot;employeeNumber eq 9876543210\&quot;.
1659
1659
  # @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers
1660
1660
  def get_scim_v2_users_with_http_info(opts = {})
1661
1661
  if @api_client.config.debugging
@@ -2070,8 +2070,8 @@ module PureCloud
2070
2070
  return data, status_code, headers
2071
2071
  end
2072
2072
 
2073
- # The information used to create a group.
2074
- # PureCloud group will be created as \"Official\" group with visibility set \"Public\", and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
2073
+ # Creates a group
2074
+ # Creates a Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
2075
2075
  # @param body The information used to create a group.
2076
2076
  # @param [Hash] opts the optional parameters
2077
2077
  # @return [ScimV2Group]
@@ -2080,8 +2080,8 @@ module PureCloud
2080
2080
  return data
2081
2081
  end
2082
2082
 
2083
- # The information used to create a group.
2084
- # PureCloud group will be created as \&quot;Official\&quot; group with visibility set \&quot;Public\&quot;, and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
2083
+ # Creates a group
2084
+ # Creates a Genesys Cloud group with group visibility set to \&quot;public\&quot; and rules visibility set to \&quot;true\&quot;. Auto-creates an \&quot;externalId\&quot;. \&quot;externalId\&quot; is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
2085
2085
  # @param body The information used to create a group.
2086
2086
  # @param [Hash] opts the optional parameters
2087
2087
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
@@ -2200,9 +2200,9 @@ module PureCloud
2200
2200
  return data, status_code, headers
2201
2201
  end
2202
2202
 
2203
- # The information used to create a group.
2204
- # PureCloud group will be created as \"Official\" group with visibility set \"Public\", and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
2205
- # @param body The information used to create a group.
2203
+ # Create a group
2204
+ # Creates an \"official\" Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
2205
+ # @param body Creates a group.
2206
2206
  # @param [Hash] opts the optional parameters
2207
2207
  # @return [ScimV2Group]
2208
2208
  def post_scim_v2_groups(body, opts = {})
@@ -2210,9 +2210,9 @@ module PureCloud
2210
2210
  return data
2211
2211
  end
2212
2212
 
2213
- # The information used to create a group.
2214
- # PureCloud group will be created as \&quot;Official\&quot; group with visibility set \&quot;Public\&quot;, and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
2215
- # @param body The information used to create a group.
2213
+ # Create a group
2214
+ # Creates an \&quot;official\&quot; Genesys Cloud group with group visibility set to \&quot;public\&quot; and rules visibility set to \&quot;true\&quot;. Auto-creates an \&quot;externalId\&quot;. \&quot;externalId\&quot; is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
2215
+ # @param body Creates a group.
2216
2216
  # @param [Hash] opts the optional parameters
2217
2217
  # @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
2218
2218
  def post_scim_v2_groups_with_http_info(body, opts = {})