purecloudplatformclientv2 89.0.0 → 94.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (753) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/ActionEntityListing.md +1 -1
  4. data/docs/AfterCallWork.md +15 -0
  5. data/docs/AgentActivityEntityListing.md +1 -1
  6. data/docs/AmazonLexRequest.md +14 -0
  7. data/docs/AnalyticsApi.md +67 -1
  8. data/docs/AnalyticsEvaluation.md +1 -1
  9. data/docs/AnalyticsParticipant.md +1 -0
  10. data/docs/AnalyticsParticipantWithoutAttributes.md +1 -0
  11. data/docs/AnalyticsSession.md +4 -0
  12. data/docs/ArchitectApi.md +51 -49
  13. data/docs/AttemptLimitsEntityListing.md +1 -1
  14. data/docs/AuditApi.md +70 -0
  15. data/docs/AuditRealtimeQueryRequest.md +18 -0
  16. data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
  17. data/docs/AuthorizationApi.md +12 -12
  18. data/docs/AuthzDivisionEntityListing.md +1 -1
  19. data/docs/Biography.md +1 -0
  20. data/docs/BuAgentScheduleActivity.md +2 -0
  21. data/docs/BuRescheduleRequest.md +2 -2
  22. data/docs/ButtonComponent.md +16 -0
  23. data/docs/CalibrationEntityListing.md +1 -1
  24. data/docs/Call.md +1 -0
  25. data/docs/CallBasic.md +1 -0
  26. data/docs/CallConversationEntityListing.md +1 -1
  27. data/docs/CallHistoryConversationEntityListing.md +1 -1
  28. data/docs/CallableTimeSetEntityListing.md +1 -1
  29. data/docs/Callback.md +1 -0
  30. data/docs/CallbackBasic.md +1 -0
  31. data/docs/CallbackConversationEntityListing.md +1 -1
  32. data/docs/CampaignDivisionViewListing.md +1 -1
  33. data/docs/CampaignEntityListing.md +1 -1
  34. data/docs/CampaignRuleEntityListing.md +1 -1
  35. data/docs/CampaignSequenceEntityListing.md +1 -1
  36. data/docs/CertificateAuthorityEntityListing.md +1 -1
  37. data/docs/CertificateDetails.md +1 -1
  38. data/docs/ChatConversationEntityListing.md +1 -1
  39. data/docs/ClientAppEntityListing.md +1 -1
  40. data/docs/CoachingAnnotationList.md +1 -1
  41. data/docs/CoachingApi.md +27 -26
  42. data/docs/CoachingAppointmentResponseList.md +1 -1
  43. data/docs/CoachingNotificationList.md +1 -1
  44. data/docs/CobrowseConversationEntityListing.md +1 -1
  45. data/docs/Cobrowsesession.md +1 -0
  46. data/docs/CommandStatusEntityListing.md +1 -1
  47. data/docs/CommonCampaign.md +17 -0
  48. data/docs/CommonCampaignDivisionView.md +17 -0
  49. data/docs/CommonCampaignDivisionViewEntityListing.md +22 -0
  50. data/docs/CommonCampaignEntityListing.md +22 -0
  51. data/docs/ConsumedResourcesEntityListing.md +1 -1
  52. data/docs/ConsumingResourcesEntityListing.md +1 -1
  53. data/docs/Contact.md +1 -0
  54. data/docs/ContactListDivisionViewListing.md +1 -1
  55. data/docs/ContactListEntityListing.md +1 -1
  56. data/docs/ContactListFilterEntityListing.md +1 -1
  57. data/docs/ContactListing.md +1 -1
  58. data/docs/ContentActions.md +17 -0
  59. data/docs/ContentAttachment.md +19 -0
  60. data/docs/ContentGeneric.md +19 -0
  61. data/docs/ContentList.md +19 -0
  62. data/docs/ContentLocation.md +17 -0
  63. data/docs/ContentNotificationTemplate.md +17 -0
  64. data/docs/ContentQuickReply.md +16 -0
  65. data/docs/ConversationAggregationQuery.md +1 -1
  66. data/docs/ConversationAssociation.md +1 -1
  67. data/docs/ConversationChat.md +1 -0
  68. data/docs/ConversationEntityListing.md +1 -1
  69. data/docs/ConversationEventTopicAfterCallWork.md +15 -0
  70. data/docs/ConversationEventTopicCall.md +1 -0
  71. data/docs/ConversationEventTopicCallback.md +1 -0
  72. data/docs/ConversationEventTopicChat.md +1 -0
  73. data/docs/ConversationEventTopicCobrowse.md +1 -0
  74. data/docs/ConversationEventTopicEmail.md +1 -0
  75. data/docs/ConversationEventTopicMessage.md +2 -0
  76. data/docs/ConversationEventTopicScreenshare.md +1 -0
  77. data/docs/ConversationEventTopicSocialExpression.md +1 -0
  78. data/docs/ConversationEventTopicVideo.md +1 -0
  79. data/docs/ConversationsApi.md +73 -4
  80. data/docs/CredentialInfoListing.md +1 -1
  81. data/docs/CredentialTypeListing.md +1 -1
  82. data/docs/CursorContactListing.md +16 -0
  83. data/docs/CursorNoteListing.md +16 -0
  84. data/docs/CursorOrganizationListing.md +16 -0
  85. data/docs/CursorRelationshipListing.md +16 -0
  86. data/docs/DIDEntityListing.md +1 -1
  87. data/docs/DIDPoolEntityListing.md +1 -1
  88. data/docs/DataTableRowEntityListing.md +1 -1
  89. data/docs/DataTablesDomainEntityListing.md +1 -1
  90. data/docs/DependencyObjectEntityListing.md +1 -1
  91. data/docs/DependencyTypeEntityListing.md +1 -1
  92. data/docs/DialerEventEntityListing.md +1 -1
  93. data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
  94. data/docs/DirectoryUserDevicesListing.md +1 -1
  95. data/docs/DivsPermittedEntityListing.md +1 -1
  96. data/docs/DncListDivisionViewListing.md +1 -1
  97. data/docs/DncListEntityListing.md +1 -1
  98. data/docs/DocumentAuditEntityListing.md +1 -1
  99. data/docs/DocumentEntityListing.md +1 -1
  100. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  101. data/docs/DomainEntityListing.md +1 -1
  102. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  103. data/docs/DomainEntityListingQueryResult.md +1 -1
  104. data/docs/DomainEntityListingSurveyForm.md +1 -1
  105. data/docs/EdgeEntityListing.md +1 -1
  106. data/docs/EdgeGroup.md +1 -0
  107. data/docs/EdgeGroupEntityListing.md +1 -1
  108. data/docs/EdgeLineEntityListing.md +1 -1
  109. data/docs/Education.md +17 -0
  110. data/docs/Email.md +1 -0
  111. data/docs/EmailConversationEntityListing.md +1 -1
  112. data/docs/EmailMessageListing.md +1 -1
  113. data/docs/EmergencyGroupListing.md +1 -1
  114. data/docs/EncryptionKeyEntityListing.md +1 -1
  115. data/docs/EntityListing.md +1 -5
  116. data/docs/EvaluationAggregationQuery.md +1 -1
  117. data/docs/EvaluationEntityListing.md +1 -1
  118. data/docs/EvaluationFormEntityListing.md +1 -1
  119. data/docs/EvaluatorActivityEntityListing.md +1 -1
  120. data/docs/ExtensionEntityListing.md +1 -1
  121. data/docs/ExtensionPoolEntityListing.md +1 -1
  122. data/docs/ExternalContactsApi.md +285 -9
  123. data/docs/ExternalOrganizationListing.md +1 -1
  124. data/docs/FacebookIntegrationEntityListing.md +1 -1
  125. data/docs/FacebookIntegrationUpdateRequest.md +14 -0
  126. data/docs/FaxDocumentEntityListing.md +1 -1
  127. data/docs/FlowAggregationQuery.md +1 -1
  128. data/docs/FlowDivisionViewEntityListing.md +1 -1
  129. data/docs/FlowEntityListing.md +1 -1
  130. data/docs/FlowOutcomeListing.md +1 -1
  131. data/docs/FlowVersionEntityListing.md +1 -1
  132. data/docs/GDPRRequestEntityListing.md +1 -1
  133. data/docs/GDPRSubjectEntityListing.md +1 -1
  134. data/docs/GoogleDialogflowCustomSettings.md +13 -0
  135. data/docs/GreetingListing.md +1 -1
  136. data/docs/GroupEntityListing.md +1 -1
  137. data/docs/GroupProfileEntityListing.md +1 -1
  138. data/docs/GroupsApi.md +4 -4
  139. data/docs/HistoricalAdherenceActuals.md +15 -0
  140. data/docs/HistoricalAdherenceDayMetrics.md +23 -0
  141. data/docs/HistoricalAdherenceExceptionInfo.md +21 -0
  142. data/docs/HistoricalAdherenceQueryResult.md +21 -0
  143. data/docs/HistoryListing.md +1 -1
  144. data/docs/IVREntityListing.md +1 -1
  145. data/docs/InboundDomainEntityListing.md +1 -1
  146. data/docs/InboundRouteEntityListing.md +1 -1
  147. data/docs/IntegrationEntityListing.md +1 -1
  148. data/docs/IntegrationEventEntityListing.md +1 -1
  149. data/docs/IntegrationTypeEntityListing.md +1 -1
  150. data/docs/IntegrationsApi.md +14 -14
  151. data/docs/InteractionStatsAlertContainer.md +1 -1
  152. data/docs/InteractionStatsRuleContainer.md +1 -1
  153. data/docs/JourneyAggregateDataContainer.md +14 -0
  154. data/docs/JourneyAggregateQueryClause.md +14 -0
  155. data/docs/JourneyAggregateQueryFilter.md +15 -0
  156. data/docs/JourneyAggregateQueryPredicate.md +17 -0
  157. data/docs/JourneyAggregateQueryResponse.md +13 -0
  158. data/docs/JourneyAggregationQuery.md +21 -0
  159. data/docs/JourneyAggregationView.md +16 -0
  160. data/docs/JourneyApi.md +78 -0
  161. data/docs/KeywordSetEntityListing.md +1 -1
  162. data/docs/KnowledgeSearchRequest.md +3 -3
  163. data/docs/LanguageEntityListing.md +1 -1
  164. data/docs/LanguageUnderstandingApi.md +164 -30
  165. data/docs/LexBotAliasEntityListing.md +1 -1
  166. data/docs/LexBotEntityListing.md +1 -1
  167. data/docs/LibraryEntityListing.md +1 -1
  168. data/docs/LineBaseEntityListing.md +1 -1
  169. data/docs/LineEntityListing.md +1 -1
  170. data/docs/LineIntegrationEntityListing.md +1 -1
  171. data/docs/ListItemComponent.md +19 -0
  172. data/docs/LocationEntityListing.md +1 -1
  173. data/docs/LogicalInterfaceEntityListing.md +1 -1
  174. data/docs/ManagementUnitListing.md +1 -1
  175. data/docs/Message.md +1 -0
  176. data/docs/MessageContent.md +19 -0
  177. data/docs/MessageConversationEntityListing.md +1 -1
  178. data/docs/MessagingCampaign.md +28 -0
  179. data/docs/MessagingCampaignDivisionView.md +16 -0
  180. data/docs/MessagingCampaignDivisionViewEntityListing.md +22 -0
  181. data/docs/MessagingCampaignEntityListing.md +22 -0
  182. data/docs/MessagingIntegrationEntityListing.md +1 -1
  183. data/docs/MessagingStickerEntityListing.md +1 -1
  184. data/docs/NluDomainListing.md +1 -1
  185. data/docs/NluDomainVersion.md +2 -1
  186. data/docs/NluDomainVersionListing.md +1 -1
  187. data/docs/NluFeedbackListing.md +1 -1
  188. data/docs/NoteListing.md +1 -1
  189. data/docs/NotificationTemplateBody.md +14 -0
  190. data/docs/NotificationTemplateFooter.md +13 -0
  191. data/docs/NotificationTemplateHeader.md +16 -0
  192. data/docs/NotificationTemplateParameter.md +14 -0
  193. data/docs/OAuthClient.md +1 -0
  194. data/docs/OAuthClientEntityListing.md +1 -1
  195. data/docs/OAuthClientListing.md +1 -0
  196. data/docs/OAuthClientRequest.md +1 -0
  197. data/docs/OAuthProviderEntityListing.md +1 -1
  198. data/docs/ObjectsApi.md +4 -4
  199. data/docs/ObservationValue.md +3 -1
  200. data/docs/OrgOAuthClient.md +1 -0
  201. data/docs/OrganizationPresenceEntityListing.md +1 -1
  202. data/docs/OrganizationRoleEntityListing.md +1 -1
  203. data/docs/OrphanRecordingListing.md +1 -1
  204. data/docs/OutboundApi.md +881 -76
  205. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  206. data/docs/OutboundRouteEntityListing.md +1 -1
  207. data/docs/PermissionCollectionEntityListing.md +1 -1
  208. data/docs/PhoneBaseEntityListing.md +1 -1
  209. data/docs/PhoneCapabilities.md +1 -0
  210. data/docs/PhoneEntityListing.md +1 -1
  211. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  212. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  213. data/docs/PolicyEntityListing.md +1 -1
  214. data/docs/PostTextMessage.md +15 -0
  215. data/docs/PostTextRequest.md +23 -0
  216. data/docs/PostTextResponse.md +20 -0
  217. data/docs/PresenceApi.md +206 -6
  218. data/docs/PresenceExpand.md +17 -0
  219. data/docs/PromptAssetEntityListing.md +1 -1
  220. data/docs/PromptEntityListing.md +1 -1
  221. data/docs/QualityApi.md +18 -18
  222. data/docs/QualityAuditPage.md +1 -1
  223. data/docs/QueueConversationEventTopicAfterCallWork.md +15 -0
  224. data/docs/QueueConversationEventTopicCall.md +1 -0
  225. data/docs/QueueConversationEventTopicCallback.md +1 -0
  226. data/docs/QueueConversationEventTopicChat.md +1 -0
  227. data/docs/QueueConversationEventTopicCobrowse.md +1 -0
  228. data/docs/QueueConversationEventTopicEmail.md +1 -0
  229. data/docs/QueueConversationEventTopicMessage.md +2 -0
  230. data/docs/QueueConversationEventTopicScreenshare.md +1 -0
  231. data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
  232. data/docs/QueueConversationEventTopicVideo.md +1 -0
  233. data/docs/QueueConversationSocialExpressionEventTopicAfterCallWork.md +15 -0
  234. data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
  235. data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
  236. data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
  237. data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
  238. data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
  239. data/docs/QueueConversationSocialExpressionEventTopicMessage.md +2 -0
  240. data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
  241. data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
  242. data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
  243. data/docs/QueueConversationVideoEventTopicAfterCallWork.md +15 -0
  244. data/docs/QueueConversationVideoEventTopicCall.md +1 -0
  245. data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
  246. data/docs/QueueConversationVideoEventTopicChat.md +1 -0
  247. data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
  248. data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
  249. data/docs/QueueConversationVideoEventTopicMessage.md +2 -0
  250. data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
  251. data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
  252. data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
  253. data/docs/QueueEntityListing.md +1 -1
  254. data/docs/QueueMemberEntityListing.md +1 -1
  255. data/docs/RecipientListing.md +1 -1
  256. data/docs/RecordingApi.md +4 -4
  257. data/docs/RecordingJobEntityListing.md +1 -1
  258. data/docs/RelationshipListing.md +1 -1
  259. data/docs/ReportMetaDataEntityListing.md +1 -1
  260. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  261. data/docs/ReportScheduleEntityListing.md +1 -1
  262. data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
  263. data/docs/ReportingExportJobListing.md +1 -1
  264. data/docs/ReportingExportJobRequest.md +2 -0
  265. data/docs/ReportingExportJobResponse.md +3 -0
  266. data/docs/ReportingExportMetadataJobListing.md +1 -1
  267. data/docs/ResponseEntityList.md +1 -1
  268. data/docs/ResponseEntityListing.md +1 -1
  269. data/docs/ResponseSetEntityListing.md +1 -1
  270. data/docs/RuleSetEntityListing.md +1 -1
  271. data/docs/SCIMApi.md +156 -156
  272. data/docs/ScheduleEntityListing.md +1 -1
  273. data/docs/ScheduleGroupEntityListing.md +1 -1
  274. data/docs/SchemaCategoryEntityListing.md +1 -1
  275. data/docs/SchemaReferenceEntityListing.md +1 -1
  276. data/docs/ScimConfigResourceType.md +1 -2
  277. data/docs/ScimEmail.md +1 -1
  278. data/docs/ScimGenesysUserExternalId.md +14 -0
  279. data/docs/ScimServiceProviderConfig.md +0 -1
  280. data/docs/ScimUserExtensions.md +3 -2
  281. data/docs/ScimUserRole.md +1 -1
  282. data/docs/ScimUserRoutingLanguage.md +2 -2
  283. data/docs/ScimUserRoutingSkill.md +2 -2
  284. data/docs/ScimV2CreateUser.md +3 -3
  285. data/docs/ScimV2Group.md +1 -2
  286. data/docs/ScimV2SchemaAttribute.md +11 -11
  287. data/docs/ScimV2SchemaDefinition.md +4 -5
  288. data/docs/ScimV2SchemaListResponse.md +1 -1
  289. data/docs/ScimV2User.md +4 -5
  290. data/docs/ScreenRecordingSessionListing.md +1 -1
  291. data/docs/Screenshare.md +1 -0
  292. data/docs/ScriptEntityListing.md +1 -1
  293. data/docs/SearchApi.md +3 -1
  294. data/docs/SecurityProfileEntityListing.md +1 -1
  295. data/docs/ShareEntityListing.md +1 -1
  296. data/docs/SiteEntityListing.md +1 -1
  297. data/docs/SkillEntityListing.md +1 -1
  298. data/docs/SmsAddressEntityListing.md +1 -1
  299. data/docs/SmsConfig.md +15 -0
  300. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  301. data/docs/SmsPhoneNumberRef.md +14 -0
  302. data/docs/SocialExpression.md +1 -0
  303. data/docs/StationEntityListing.md +1 -1
  304. data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
  305. data/docs/SurveyAggregationQuery.md +1 -1
  306. data/docs/SurveyForm.md +0 -2
  307. data/docs/SurveyFormEntityListing.md +1 -1
  308. data/docs/SystemPromptAssetEntityListing.md +1 -1
  309. data/docs/SystemPromptEntityListing.md +1 -1
  310. data/docs/TagValueEntityListing.md +1 -1
  311. data/docs/TelephonyProvidersEdgeApi.md +6 -2
  312. data/docs/TextMessageListing.md +1 -1
  313. data/docs/TextbotsApi.md +78 -0
  314. data/docs/TimeZoneEntityListing.md +1 -1
  315. data/docs/TrunkBaseEntityListing.md +1 -1
  316. data/docs/TrunkEntityListing.md +1 -1
  317. data/docs/TrunkMetabaseEntityListing.md +1 -1
  318. data/docs/TrustEntityListing.md +1 -1
  319. data/docs/TrustUserEntityListing.md +1 -1
  320. data/docs/TrustorEntityListing.md +1 -1
  321. data/docs/TtsEngineEntityListing.md +1 -1
  322. data/docs/TtsVoiceEntityListing.md +1 -1
  323. data/docs/TwitterIntegrationEntityListing.md +1 -1
  324. data/docs/UpdateCoachingAppointmentRequest.md +1 -0
  325. data/docs/UserActionCategoryEntityListing.md +1 -1
  326. data/docs/UserAggregationQuery.md +1 -1
  327. data/docs/UserAppEntityListing.md +1 -1
  328. data/docs/UserEntityListing.md +1 -1
  329. data/docs/UserLanguageEntityListing.md +1 -1
  330. data/docs/UserProfileEntityListing.md +1 -1
  331. data/docs/UserQueueEntityListing.md +1 -1
  332. data/docs/UserRecordingEntityListing.md +1 -1
  333. data/docs/UserRoutingLanguage.md +3 -3
  334. data/docs/UserRoutingLanguagePost.md +1 -1
  335. data/docs/UserRoutingSkill.md +1 -1
  336. data/docs/UserSearchRequest.md +1 -0
  337. data/docs/UserSkillEntityListing.md +1 -1
  338. data/docs/UsersApi.md +21 -9
  339. data/docs/Video.md +1 -0
  340. data/docs/ViewFilter.md +2 -0
  341. data/docs/VoicemailMessageEntityListing.md +1 -1
  342. data/docs/VoicemailMessagesTopicOwner.md +13 -0
  343. data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +14 -0
  344. data/docs/VoicemailMessagesTopicVoicemailMessage.md +2 -0
  345. data/docs/VoicemailUserPolicy.md +1 -0
  346. data/docs/WebChatMemberInfoEntityList.md +1 -1
  347. data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +23 -0
  348. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +24 -0
  349. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +15 -0
  350. data/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +17 -0
  351. data/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +14 -0
  352. data/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +13 -0
  353. data/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +15 -0
  354. data/docs/WfmBusinessUnitReference.md +14 -0
  355. data/docs/WfmHistoricalAdherenceResponse.md +1 -0
  356. data/docs/WfmHistoricalAdherenceResultWrapper.md +15 -0
  357. data/docs/WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.md +13 -0
  358. data/docs/WfmHistoricalDataUploadRequestStatusTopicDateTime.md +16 -0
  359. data/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md +20 -0
  360. data/docs/WfmScheduleReference.md +16 -0
  361. data/docs/WhatsAppIntegrationEntityListing.md +1 -1
  362. data/docs/WorkforceManagementApi.md +3 -3
  363. data/docs/WorkspaceEntityListing.md +1 -1
  364. data/docs/WorkspaceMemberEntityListing.md +1 -1
  365. data/docs/WrapupCodeEntityListing.md +1 -1
  366. data/lib/purecloudplatformclientv2.rb +72 -1
  367. data/lib/purecloudplatformclientv2/api/analytics_api.rb +67 -2
  368. data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -6
  369. data/lib/purecloudplatformclientv2/api/audit_api.rb +74 -0
  370. data/lib/purecloudplatformclientv2/api/authorization_api.rb +12 -12
  371. data/lib/purecloudplatformclientv2/api/coaching_api.rb +10 -9
  372. data/lib/purecloudplatformclientv2/api/conversations_api.rb +79 -4
  373. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +305 -13
  374. data/lib/purecloudplatformclientv2/api/groups_api.rb +4 -4
  375. data/lib/purecloudplatformclientv2/api/integrations_api.rb +14 -14
  376. data/lib/purecloudplatformclientv2/api/journey_api.rb +92 -0
  377. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +189 -30
  378. data/lib/purecloudplatformclientv2/api/objects_api.rb +4 -4
  379. data/lib/purecloudplatformclientv2/api/outbound_api.rb +1215 -155
  380. data/lib/purecloudplatformclientv2/api/presence_api.rb +213 -8
  381. data/lib/purecloudplatformclientv2/api/quality_api.rb +18 -18
  382. data/lib/purecloudplatformclientv2/api/recording_api.rb +4 -4
  383. data/lib/purecloudplatformclientv2/api/scim_api.rb +142 -142
  384. data/lib/purecloudplatformclientv2/api/search_api.rb +13 -0
  385. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +18 -0
  386. data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
  387. data/lib/purecloudplatformclientv2/api/users_api.rb +82 -4
  388. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
  389. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  390. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
  391. data/lib/purecloudplatformclientv2/models/after_call_work.rb +267 -0
  392. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
  393. data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
  394. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  395. data/lib/purecloudplatformclientv2/models/analytics_participant.rb +29 -1
  396. data/lib/purecloudplatformclientv2/models/analytics_participant_without_attributes.rb +29 -1
  397. data/lib/purecloudplatformclientv2/models/analytics_session.rb +124 -4
  398. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
  399. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
  400. data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +2 -2
  401. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +2 -2
  402. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +2 -2
  403. data/lib/purecloudplatformclientv2/models/audit_query_service.rb +2 -2
  404. data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
  405. data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
  406. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +14 -14
  407. data/lib/purecloudplatformclientv2/models/biography.rb +32 -4
  408. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
  409. data/lib/purecloudplatformclientv2/models/bu_reschedule_request.rb +2 -12
  410. data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
  411. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
  412. data/lib/purecloudplatformclientv2/models/call.rb +30 -4
  413. data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
  414. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
  415. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
  416. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
  417. data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
  418. data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
  419. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
  420. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +14 -14
  421. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
  422. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
  423. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
  424. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
  425. data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
  426. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
  427. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
  428. data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +14 -14
  429. data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +2 -2
  430. data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +14 -14
  431. data/lib/purecloudplatformclientv2/models/coaching_notification.rb +2 -2
  432. data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +14 -14
  433. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
  434. data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
  435. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
  436. data/lib/purecloudplatformclientv2/models/{scim_metadata.rb → common_campaign.rb} +70 -45
  437. data/lib/purecloudplatformclientv2/models/common_campaign_division_view.rb +320 -0
  438. data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +428 -0
  439. data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +428 -0
  440. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
  441. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
  442. data/lib/purecloudplatformclientv2/models/contact.rb +29 -4
  443. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +14 -14
  444. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
  445. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
  446. data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
  447. data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
  448. data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
  449. data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
  450. data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
  451. data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
  452. data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
  453. data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
  454. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  455. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
  456. data/lib/purecloudplatformclientv2/models/conversation_association.rb +1 -1
  457. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
  458. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
  459. data/lib/purecloudplatformclientv2/models/conversation_event_topic_after_call_work.rb +265 -0
  460. data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
  461. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
  462. data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
  463. data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
  464. data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
  465. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +51 -1
  466. data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
  467. data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
  468. data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
  469. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
  470. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
  471. data/lib/purecloudplatformclientv2/models/cursor_contact_listing.rb +278 -0
  472. data/lib/purecloudplatformclientv2/models/cursor_note_listing.rb +278 -0
  473. data/lib/purecloudplatformclientv2/models/cursor_organization_listing.rb +278 -0
  474. data/lib/purecloudplatformclientv2/models/cursor_relationship_listing.rb +278 -0
  475. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
  476. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
  477. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  478. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  479. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
  480. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
  481. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
  482. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +14 -14
  483. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
  484. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
  485. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
  486. data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +14 -14
  487. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +14 -14
  488. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
  489. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
  490. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
  491. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
  492. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
  493. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
  494. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
  495. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
  496. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
  497. data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
  498. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
  499. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
  500. data/lib/purecloudplatformclientv2/models/education.rb +304 -0
  501. data/lib/purecloudplatformclientv2/models/email.rb +30 -4
  502. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
  503. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
  504. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
  505. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
  506. data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
  507. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
  508. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
  509. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
  510. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
  511. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  512. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
  513. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
  514. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
  515. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +14 -14
  516. data/lib/purecloudplatformclientv2/models/facebook_integration_update_request.rb +228 -0
  517. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
  518. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  519. data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
  520. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
  521. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
  522. data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +14 -14
  523. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
  524. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
  525. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
  526. data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
  527. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
  528. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
  529. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
  530. data/lib/purecloudplatformclientv2/models/historical_adherence_actuals.rb +268 -0
  531. data/lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb +462 -0
  532. data/lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb +466 -0
  533. data/lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb +430 -0
  534. data/lib/purecloudplatformclientv2/models/history_listing.rb +12 -12
  535. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
  536. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
  537. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
  538. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
  539. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
  540. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
  541. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
  542. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
  543. data/lib/purecloudplatformclientv2/models/journey_aggregate_data_container.rb +231 -0
  544. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_clause.rb +254 -0
  545. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_filter.rb +277 -0
  546. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_predicate.rb +348 -0
  547. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_response.rb +203 -0
  548. data/lib/purecloudplatformclientv2/models/journey_aggregation_query.rb +435 -0
  549. data/lib/purecloudplatformclientv2/models/journey_aggregation_view.rb +323 -0
  550. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
  551. data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +0 -15
  552. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
  553. data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +14 -14
  554. data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +14 -14
  555. data/lib/purecloudplatformclientv2/models/library.rb +2 -2
  556. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
  557. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
  558. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
  559. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +14 -14
  560. data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
  561. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
  562. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
  563. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
  564. data/lib/purecloudplatformclientv2/models/message.rb +30 -4
  565. data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
  566. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
  567. data/lib/purecloudplatformclientv2/models/messaging_campaign.rb +621 -0
  568. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view.rb +279 -0
  569. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +428 -0
  570. data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +428 -0
  571. data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +14 -14
  572. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +14 -14
  573. data/lib/purecloudplatformclientv2/models/nlu_domain_listing.rb +14 -14
  574. data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +32 -1
  575. data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +14 -14
  576. data/lib/purecloudplatformclientv2/models/nlu_feedback_listing.rb +14 -14
  577. data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
  578. data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
  579. data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
  580. data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
  581. data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
  582. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +41 -1
  583. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
  584. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +41 -1
  585. data/lib/purecloudplatformclientv2/models/o_auth_client_request.rb +44 -4
  586. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
  587. data/lib/purecloudplatformclientv2/models/observation_value.rb +70 -2
  588. data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +41 -1
  589. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
  590. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
  591. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
  592. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
  593. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
  594. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
  595. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
  596. data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +29 -4
  597. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
  598. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
  599. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
  600. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
  601. data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
  602. data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
  603. data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
  604. data/lib/purecloudplatformclientv2/models/presence_expand.rb +309 -0
  605. data/lib/purecloudplatformclientv2/models/prompt_asset.rb +15 -1
  606. data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +15 -1
  607. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
  608. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
  609. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
  610. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_after_call_work.rb +265 -0
  611. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
  612. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
  613. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
  614. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
  615. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
  616. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +51 -1
  617. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
  618. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
  619. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
  620. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_after_call_work.rb +265 -0
  621. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
  622. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
  623. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
  624. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
  625. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
  626. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +51 -1
  627. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
  628. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
  629. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
  630. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_after_call_work.rb +265 -0
  631. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
  632. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
  633. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
  634. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
  635. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
  636. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +51 -1
  637. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
  638. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
  639. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
  640. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
  641. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
  642. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
  643. data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +14 -14
  644. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
  645. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
  646. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
  647. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
  648. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
  649. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
  650. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +53 -1
  651. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +78 -1
  652. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +14 -14
  653. data/lib/purecloudplatformclientv2/models/response.rb +2 -2
  654. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
  655. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
  656. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
  657. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
  658. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
  659. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
  660. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
  661. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
  662. data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +5 -31
  663. data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
  664. data/lib/purecloudplatformclientv2/models/scim_genesys_user_external_id.rb +229 -0
  665. data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
  666. data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +4 -30
  667. data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +35 -7
  668. data/lib/purecloudplatformclientv2/models/scim_user_role.rb +1 -1
  669. data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +3 -3
  670. data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +3 -3
  671. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -2
  672. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
  673. data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +5 -31
  674. data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +12 -12
  675. data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +9 -35
  676. data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +2 -2
  677. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +8 -33
  678. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
  679. data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
  680. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
  681. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
  682. data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
  683. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
  684. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
  685. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
  686. data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +14 -14
  687. data/lib/purecloudplatformclientv2/models/sms_config.rb +269 -0
  688. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
  689. data/lib/purecloudplatformclientv2/models/sms_phone_number_ref.rb +232 -0
  690. data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
  691. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
  692. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +14 -14
  693. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
  694. data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
  695. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
  696. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
  697. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
  698. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
  699. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
  700. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
  701. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
  702. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
  703. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
  704. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
  705. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
  706. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
  707. data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +14 -14
  708. data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +14 -14
  709. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +14 -14
  710. data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +44 -4
  711. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
  712. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
  713. data/lib/purecloudplatformclientv2/models/user_app_entity_listing.rb +14 -14
  714. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
  715. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
  716. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
  717. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
  718. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
  719. data/lib/purecloudplatformclientv2/models/user_routing_language.rb +4 -4
  720. data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +1 -1
  721. data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +1 -1
  722. data/lib/purecloudplatformclientv2/models/user_search_request.rb +44 -4
  723. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
  724. data/lib/purecloudplatformclientv2/models/video.rb +30 -4
  725. data/lib/purecloudplatformclientv2/models/view_filter.rb +58 -4
  726. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
  727. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
  728. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
  729. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
  730. data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +30 -4
  731. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +14 -14
  732. data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +4 -4
  733. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
  734. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
  735. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
  736. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
  737. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
  738. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
  739. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
  740. data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +228 -0
  741. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +27 -1
  742. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper.rb +258 -0
  743. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_purge_request_status_topic_historical_data_upload_purge_request_update.rb +215 -0
  744. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time.rb +276 -0
  745. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update.rb +390 -0
  746. data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +280 -0
  747. data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +14 -14
  748. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
  749. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
  750. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
  751. data/lib/purecloudplatformclientv2/version.rb +1 -1
  752. metadata +147 -5
  753. data/docs/ScimMetadata.md +0 -16
@@ -19,6 +19,7 @@ title: QueueConversationVideoEventTopicScreenshare
19
19
  | **connected_time** | **DateTime** | | [optional] |
20
20
  | **disconnected_time** | **DateTime** | | [optional] |
21
21
  | **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
22
+ | **after_call_work** | [**QueueConversationVideoEventTopicAfterCallWork**](QueueConversationVideoEventTopicAfterCallWork.html) | | [optional] |
22
23
  | **additional_properties** | **Object** | | [optional] |
23
24
  {: class="table table-striped"}
24
25
 
@@ -23,6 +23,7 @@ title: QueueConversationVideoEventTopicSocialExpression
23
23
  | **connected_time** | **DateTime** | | [optional] |
24
24
  | **disconnected_time** | **DateTime** | | [optional] |
25
25
  | **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
26
+ | **after_call_work** | [**QueueConversationVideoEventTopicAfterCallWork**](QueueConversationVideoEventTopicAfterCallWork.html) | | [optional] |
26
27
  | **additional_properties** | **Object** | | [optional] |
27
28
  {: class="table table-striped"}
28
29
 
@@ -22,6 +22,7 @@ title: QueueConversationVideoEventTopicVideo
22
22
  | **disconnected_time** | **DateTime** | | [optional] |
23
23
  | **msids** | **Array<String>** | | [optional] |
24
24
  | **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
25
+ | **after_call_work** | [**QueueConversationVideoEventTopicAfterCallWork**](QueueConversationVideoEventTopicAfterCallWork.html) | | [optional] |
25
26
  | **additional_properties** | **Object** | | [optional] |
26
27
  {: class="table table-striped"}
27
28
 
@@ -12,9 +12,9 @@ title: QueueEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: QueueMemberEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: RecipientListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -991,7 +991,7 @@ opts = {
991
991
  page_size: 25, # Integer | The total page size requested
992
992
  page_number: 1, # Integer | The page number requested
993
993
  sort_by: "sort_by_example", # String | variable name requested to sort by
994
- expand: ["expand_example"], # Array<String> | variable name requested by expand list
994
+ expand: nil, # Array<Object> | variable name requested by expand list
995
995
  next_page: "next_page_example", # String | next page token
996
996
  previous_page: "previous_page_example", # String | Previous page token
997
997
  has_conversation: false, # BOOLEAN | Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.
@@ -1014,7 +1014,7 @@ Name | Type | Description | Notes
1014
1014
  **page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
1015
1015
  **page_number** | **Integer**| The page number requested | [optional] [default to 1] |
1016
1016
  **sort_by** | **String**| variable name requested to sort by | [optional] |
1017
- **expand** | [**Array&lt;String&gt;**](String.html)| variable name requested by expand list | [optional] |
1017
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional] |
1018
1018
  **next_page** | **String**| next page token | [optional] |
1019
1019
  **previous_page** | **String**| Previous page token | [optional] |
1020
1020
  **has_conversation** | **BOOLEAN**| Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. | [optional] [default to false] |
@@ -1400,7 +1400,7 @@ opts = {
1400
1400
  page_size: 25, # Integer | The total page size requested
1401
1401
  page_number: 1, # Integer | The page number requested
1402
1402
  sort_by: "sort_by_example", # String | variable name requested to sort by
1403
- expand: ["expand_example"], # Array<String> | variable name requested by expand list
1403
+ expand: nil, # Array<Object> | variable name requested by expand list
1404
1404
  next_page: "next_page_example", # String | next page token
1405
1405
  previous_page: "previous_page_example", # String | Previous page token
1406
1406
  name: "name_example", # String | the policy name - used for filtering results in searches.
@@ -1425,7 +1425,7 @@ Name | Type | Description | Notes
1425
1425
  **page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
1426
1426
  **page_number** | **Integer**| The page number requested | [optional] [default to 1] |
1427
1427
  **sort_by** | **String**| variable name requested to sort by | [optional] |
1428
- **expand** | [**Array&lt;String&gt;**](String.html)| variable name requested by expand list | [optional] |
1428
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional] |
1429
1429
  **next_page** | **String**| next page token | [optional] |
1430
1430
  **previous_page** | **String**| Previous page token | [optional] |
1431
1431
  **name** | **String**| the policy name - used for filtering results in searches. | [optional] |
@@ -12,9 +12,9 @@ title: RecordingJobEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: RelationshipListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: ReportMetaDataEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: ReportRunEntryEntityDomainListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: ReportScheduleEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -18,6 +18,7 @@ title: ReportingDataExportTopicDataExportNotification
18
18
  | **created_date_time** | **DateTime** | | [optional] |
19
19
  | **modified_date_time** | **DateTime** | | [optional] |
20
20
  | **percentage_complete** | **Float** | | [optional] |
21
+ | **email_statuses** | **Hash&lt;String, String&gt;** | | [optional] |
21
22
  {: class="table table-striped"}
22
23
 
23
24
 
@@ -12,9 +12,9 @@ title: ReportingExportJobListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -18,6 +18,8 @@ title: ReportingExportJobRequest
18
18
  | **locale** | **String** | The locale use for localization of the exported data, i.e. en-us, es-mx | |
19
19
  | **has_format_durations** | **BOOLEAN** | Indicates if durations are formatted in hh:mm:ss format instead of ms | [optional] |
20
20
  | **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
21
+ | **exclude_empty_rows** | **BOOLEAN** | Excludes empty rows from the exports | [optional] |
22
+ | **has_split_by_media** | **BOOLEAN** | Indicates if media type will be split in aggregate detail exports | [optional] |
21
23
  | **selected_columns** | [**Array&lt;SelectedColumns&gt;**](SelectedColumns.html) | The list of ordered selected columns from the export view by the user | [optional] |
22
24
  | **has_custom_participant_attributes** | **BOOLEAN** | Indicates if custom participant attributes will be exported | [optional] |
23
25
  | **recipient_emails** | **Array&lt;String&gt;** | The list of email recipients for the exports | [optional] |
@@ -25,10 +25,13 @@ title: ReportingExportJobResponse
25
25
  | **percentage_complete** | **Float** | The percentage of the job that has completed processing | |
26
26
  | **has_format_durations** | **BOOLEAN** | Indicates if durations are formatted in hh:mm:ss format instead of ms | [optional] |
27
27
  | **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
28
+ | **exclude_empty_rows** | **BOOLEAN** | Excludes empty rows from the exports | [optional] |
29
+ | **has_split_by_media** | **BOOLEAN** | Indicates if media type will be split in aggregate detail exports | [optional] |
28
30
  | **selected_columns** | [**Array&lt;SelectedColumns&gt;**](SelectedColumns.html) | The list of ordered selected columns from the export view by the user | [optional] |
29
31
  | **has_custom_participant_attributes** | **BOOLEAN** | Indicates if custom participant attributes will be exported | [optional] |
30
32
  | **recipient_emails** | **Array&lt;String&gt;** | The list of email recipients for the exports | [optional] |
31
33
  | **email_statuses** | **Hash&lt;String, String&gt;** | The status of individual email addresses as a map | [optional] |
34
+ | **enabled** | **BOOLEAN** | | [optional] |
32
35
  | **self_uri** | **String** | The URI for this object | [optional] |
33
36
  {: class="table table-striped"}
34
37
 
@@ -12,9 +12,9 @@ title: ReportingExportMetadataJobListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: ResponseEntityList
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: ResponseEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: ResponseSetEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: RuleSetEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **previous_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -8,16 +8,16 @@ All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
9
  Method | Description
10
10
  ------------- | ------------- | -------------
11
- [**delete_scim_group**](SCIMApi.html#delete_scim_group) | Delete a group.
11
+ [**delete_scim_group**](SCIMApi.html#delete_scim_group) | Delete a group
12
12
  [**delete_scim_user**](SCIMApi.html#delete_scim_user) | Delete a user
13
- [**delete_scim_v2_group**](SCIMApi.html#delete_scim_v2_group) | Delete a group.
13
+ [**delete_scim_v2_group**](SCIMApi.html#delete_scim_v2_group) | Delete a group
14
14
  [**delete_scim_v2_user**](SCIMApi.html#delete_scim_v2_user) | Delete a user
15
15
  [**get_scim_group**](SCIMApi.html#get_scim_group) | Get a group
16
16
  [**get_scim_groups**](SCIMApi.html#get_scim_groups) | Get a list of groups
17
17
  [**get_scim_resourcetype**](SCIMApi.html#get_scim_resourcetype) | Get a resource type
18
18
  [**get_scim_resourcetypes**](SCIMApi.html#get_scim_resourcetypes) | Get a list of resource types
19
- [**get_scim_schema**](SCIMApi.html#get_scim_schema) | Get the SCIM schema by id
20
- [**get_scim_schemas**](SCIMApi.html#get_scim_schemas) | Get the SCIM schemas
19
+ [**get_scim_schema**](SCIMApi.html#get_scim_schema) | Get a SCIM schema
20
+ [**get_scim_schemas**](SCIMApi.html#get_scim_schemas) | Get a list of SCIM schemas
21
21
  [**get_scim_serviceproviderconfig**](SCIMApi.html#get_scim_serviceproviderconfig) | Get a service provider&#39;s configuration
22
22
  [**get_scim_user**](SCIMApi.html#get_scim_user) | Get a user
23
23
  [**get_scim_users**](SCIMApi.html#get_scim_users) | Get a list of users
@@ -25,8 +25,8 @@ Method | Description
25
25
  [**get_scim_v2_groups**](SCIMApi.html#get_scim_v2_groups) | Get a list of groups
26
26
  [**get_scim_v2_resourcetype**](SCIMApi.html#get_scim_v2_resourcetype) | Get a resource type
27
27
  [**get_scim_v2_resourcetypes**](SCIMApi.html#get_scim_v2_resourcetypes) | Get a list of resource types
28
- [**get_scim_v2_schema**](SCIMApi.html#get_scim_v2_schema) | Get the SCIM schema by id
29
- [**get_scim_v2_schemas**](SCIMApi.html#get_scim_v2_schemas) | Get the SCIM schemas
28
+ [**get_scim_v2_schema**](SCIMApi.html#get_scim_v2_schema) | Get a SCIM schema
29
+ [**get_scim_v2_schemas**](SCIMApi.html#get_scim_v2_schemas) | Get a list of SCIM schemas
30
30
  [**get_scim_v2_serviceproviderconfig**](SCIMApi.html#get_scim_v2_serviceproviderconfig) | Get a service provider&#39;s configuration
31
31
  [**get_scim_v2_user**](SCIMApi.html#get_scim_v2_user) | Get a user
32
32
  [**get_scim_v2_users**](SCIMApi.html#get_scim_v2_users) | Get a list of users
@@ -34,9 +34,9 @@ Method | Description
34
34
  [**patch_scim_user**](SCIMApi.html#patch_scim_user) | Modify a user
35
35
  [**patch_scim_v2_group**](SCIMApi.html#patch_scim_v2_group) | Modify a group
36
36
  [**patch_scim_v2_user**](SCIMApi.html#patch_scim_v2_user) | Modify a user
37
- [**post_scim_groups**](SCIMApi.html#post_scim_groups) | The information used to create a group.
37
+ [**post_scim_groups**](SCIMApi.html#post_scim_groups) | Creates a group
38
38
  [**post_scim_users**](SCIMApi.html#post_scim_users) | Create a user
39
- [**post_scim_v2_groups**](SCIMApi.html#post_scim_v2_groups) | The information used to create a group.
39
+ [**post_scim_v2_groups**](SCIMApi.html#post_scim_v2_groups) | Create a group
40
40
  [**post_scim_v2_users**](SCIMApi.html#post_scim_v2_users) | Create a user
41
41
  [**put_scim_group**](SCIMApi.html#put_scim_group) | Replace a group
42
42
  [**put_scim_user**](SCIMApi.html#put_scim_user) | Replace a user
@@ -50,7 +50,7 @@ Method | Description
50
50
 
51
51
 
52
52
 
53
- Delete a group.
53
+ Delete a group
54
54
 
55
55
 
56
56
 
@@ -78,14 +78,14 @@ end
78
78
 
79
79
  api_instance = PureCloud::SCIMApi.new
80
80
 
81
- group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
81
+ group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
82
82
 
83
83
  opts = {
84
- if_match: "if_match_example" # String | 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: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
84
+ if_match: "if_match_example" # String | 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: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
85
85
  }
86
86
 
87
87
  begin
88
- #Delete a group.
88
+ #Delete a group
89
89
  api_instance.delete_scim_group(group_id, opts)
90
90
  rescue PureCloud::ApiError => e
91
91
  puts "Exception when calling SCIMApi->delete_scim_group: #{e}"
@@ -96,8 +96,8 @@ end
96
96
 
97
97
  Name | Type | Description | Notes
98
98
  ------------- | ------------- | ------------- | -------------
99
- **group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
100
- **if_match** | **String**| 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;. | [optional] |
99
+ **group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups. | |
100
+ **if_match** | **String**| 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;. | [optional] |
101
101
  {: class="table table-striped"}
102
102
 
103
103
 
@@ -107,8 +107,8 @@ nil (empty response body)
107
107
 
108
108
  ### HTTP request headers
109
109
 
110
- - **Content-Type**: application/json, application/scim+json
111
- - **Accept**: application/json, application/scim+json
110
+ - **Content-Type**: application/scim+json, application/json
111
+ - **Accept**: application/scim+json, application/json
112
112
 
113
113
 
114
114
 
@@ -176,8 +176,8 @@ Name | Type | Description | Notes
176
176
 
177
177
  ### HTTP request headers
178
178
 
179
- - **Content-Type**: application/json, application/scim+json
180
- - **Accept**: application/json, application/scim+json
179
+ - **Content-Type**: application/scim+json, application/json
180
+ - **Accept**: application/scim+json, application/json
181
181
 
182
182
 
183
183
 
@@ -187,7 +187,7 @@ Name | Type | Description | Notes
187
187
 
188
188
 
189
189
 
190
- Delete a group.
190
+ Delete a group
191
191
 
192
192
 
193
193
 
@@ -215,14 +215,14 @@ end
215
215
 
216
216
  api_instance = PureCloud::SCIMApi.new
217
217
 
218
- group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
218
+ group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
219
219
 
220
220
  opts = {
221
- if_match: "if_match_example" # String | 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: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
221
+ if_match: "if_match_example" # String | 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: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
222
222
  }
223
223
 
224
224
  begin
225
- #Delete a group.
225
+ #Delete a group
226
226
  api_instance.delete_scim_v2_group(group_id, opts)
227
227
  rescue PureCloud::ApiError => e
228
228
  puts "Exception when calling SCIMApi->delete_scim_v2_group: #{e}"
@@ -233,8 +233,8 @@ end
233
233
 
234
234
  Name | Type | Description | Notes
235
235
  ------------- | ------------- | ------------- | -------------
236
- **group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
237
- **if_match** | **String**| 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;. | [optional] |
236
+ **group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups. | |
237
+ **if_match** | **String**| 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;. | [optional] |
238
238
  {: class="table table-striped"}
239
239
 
240
240
 
@@ -244,8 +244,8 @@ nil (empty response body)
244
244
 
245
245
  ### HTTP request headers
246
246
 
247
- - **Content-Type**: application/json, application/scim+json
248
- - **Accept**: application/json, application/scim+json
247
+ - **Content-Type**: application/scim+json, application/json
248
+ - **Accept**: application/scim+json, application/json
249
249
 
250
250
 
251
251
 
@@ -313,8 +313,8 @@ Name | Type | Description | Notes
313
313
 
314
314
  ### HTTP request headers
315
315
 
316
- - **Content-Type**: application/json, application/scim+json
317
- - **Accept**: application/json, application/scim+json
316
+ - **Content-Type**: application/scim+json, application/json
317
+ - **Accept**: application/scim+json, application/json
318
318
 
319
319
 
320
320
 
@@ -356,7 +356,7 @@ group_id = "group_id_example" # String | The ID of a group. Returned with GET /a
356
356
 
357
357
  opts = {
358
358
  attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes.
359
- excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
359
+ excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
360
360
  if_none_match: "if_none_match_example" # String | 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: \"42\". 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.
361
361
  }
362
362
 
@@ -374,8 +374,8 @@ end
374
374
  Name | Type | Description | Notes
375
375
  ------------- | ------------- | ------------- | -------------
376
376
  **group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups. | |
377
- **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
378
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
377
+ **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:meta, urn:ietf:params:scim:schemas:core:2.0:Group:meta.version, urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
378
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:meta, urn:ietf:params:scim:schemas:core:2.0:Group:meta.version, urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
379
379
  **if_none_match** | **String**| 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. | [optional] |
380
380
  {: class="table table-striped"}
381
381
 
@@ -386,8 +386,8 @@ Name | Type | Description | Notes
386
386
 
387
387
  ### HTTP request headers
388
388
 
389
- - **Content-Type**: application/json, application/scim+json
390
- - **Accept**: application/json, application/scim+json
389
+ - **Content-Type**: application/scim+json, application/json
390
+ - **Accept**: application/scim+json, application/json
391
391
 
392
392
 
393
393
 
@@ -427,10 +427,10 @@ api_instance = PureCloud::SCIMApi.new
427
427
 
428
428
  opts = {
429
429
  start_index: 1, # Integer | The 1-based index of the first query result.
430
- count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users 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, and for Groups externalId, members).
430
+ count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". 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)
431
431
  attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes.
432
- excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
433
- filter: "displayName eq groupName" # String | Filters results.
432
+ excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
433
+ filter: "displayName eq groupName" # String | Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
434
434
  }
435
435
 
436
436
  begin
@@ -447,10 +447,10 @@ end
447
447
  Name | Type | Description | Notes
448
448
  ------------- | ------------- | ------------- | -------------
449
449
  **start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
450
- **count** | **Integer**| The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users 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, and for Groups externalId, members). | [optional] [default to 25] |
451
- **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
452
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
453
- **filter** | **String**| Filters results. | [optional] |
450
+ **count** | **Integer**| 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) | [optional] [default to 25] |
451
+ **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:meta, urn:ietf:params:scim:schemas:core:2.0:Group:meta.version, urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
452
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:meta, urn:ietf:params:scim:schemas:core:2.0:Group:meta.version, urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
453
+ **filter** | **String**| 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;. | [optional] |
454
454
  {: class="table table-striped"}
455
455
 
456
456
 
@@ -460,8 +460,8 @@ Name | Type | Description | Notes
460
460
 
461
461
  ### HTTP request headers
462
462
 
463
- - **Content-Type**: application/json, application/scim+json
464
- - **Accept**: application/json, application/scim+json
463
+ - **Content-Type**: application/scim+json, application/json
464
+ - **Accept**: application/scim+json, application/json
465
465
 
466
466
 
467
467
 
@@ -524,8 +524,8 @@ Name | Type | Description | Notes
524
524
 
525
525
  ### HTTP request headers
526
526
 
527
- - **Content-Type**: application/json, application/scim+json
528
- - **Accept**: application/json, application/scim+json
527
+ - **Content-Type**: application/scim+json, application/json
528
+ - **Accept**: application/scim+json, application/json
529
529
 
530
530
 
531
531
 
@@ -582,18 +582,18 @@ This endpoint does not need any parameter.
582
582
 
583
583
  ### HTTP request headers
584
584
 
585
- - **Content-Type**: application/json, application/scim+json
586
- - **Accept**: application/json, application/scim+json
585
+ - **Content-Type**: application/scim+json, application/json
586
+ - **Accept**: application/scim+json, application/json
587
587
 
588
588
 
589
589
 
590
590
  <a name="get_scim_schema"></a>
591
591
 
592
- ## [**ScimConfigResourceType**](ScimConfigResourceType.html) get_scim_schema(schema_id)
592
+ ## [**ScimV2SchemaDefinition**](ScimV2SchemaDefinition.html) get_scim_schema(schema_id)
593
593
 
594
594
 
595
595
 
596
- Get the SCIM schema by id
596
+ Get a SCIM schema
597
597
 
598
598
 
599
599
 
@@ -620,11 +620,11 @@ end
620
620
 
621
621
  api_instance = PureCloud::SCIMApi.new
622
622
 
623
- schema_id = "schema_id_example" # String | The ID of a schema.
623
+ schema_id = "schema_id_example" # String | The ID of a schema. Returned with GET /api/v2/scim/schemas.
624
624
 
625
625
 
626
626
  begin
627
- #Get the SCIM schema by id
627
+ #Get a SCIM schema
628
628
  result = api_instance.get_scim_schema(schema_id)
629
629
  p result
630
630
  rescue PureCloud::ApiError => e
@@ -636,28 +636,28 @@ end
636
636
 
637
637
  Name | Type | Description | Notes
638
638
  ------------- | ------------- | ------------- | -------------
639
- **schema_id** | **String**| The ID of a schema. | <br />**Values**: urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User |
639
+ **schema_id** | **String**| The ID of a schema. Returned with GET /api/v2/scim/schemas. | <br />**Values**: urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User |
640
640
  {: class="table table-striped"}
641
641
 
642
642
 
643
643
  ### Return type
644
644
 
645
- [**ScimConfigResourceType**](ScimConfigResourceType.html)
645
+ [**ScimV2SchemaDefinition**](ScimV2SchemaDefinition.html)
646
646
 
647
647
  ### HTTP request headers
648
648
 
649
- - **Content-Type**: application/json, application/scim+json
650
- - **Accept**: application/json, application/scim+json
649
+ - **Content-Type**: application/scim+json, application/json
650
+ - **Accept**: application/scim+json, application/json
651
651
 
652
652
 
653
653
 
654
654
  <a name="get_scim_schemas"></a>
655
655
 
656
- ## [**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html) get_scim_schemas(opts)
656
+ ## [**ScimV2SchemaListResponse**](ScimV2SchemaListResponse.html) get_scim_schemas(opts)
657
657
 
658
658
 
659
659
 
660
- Get the SCIM schemas
660
+ Get a list of SCIM schemas
661
661
 
662
662
 
663
663
 
@@ -685,11 +685,11 @@ end
685
685
  api_instance = PureCloud::SCIMApi.new
686
686
 
687
687
  opts = {
688
- filter: "displayName eq groupName" # String | Filtered results are invalid and will result in a 403 (Unauthorized) return.
688
+ filter: "displayName eq groupName" # String | Filtered results are invalid and return 403 Unauthorized.
689
689
  }
690
690
 
691
691
  begin
692
- #Get the SCIM schemas
692
+ #Get a list of SCIM schemas
693
693
  result = api_instance.get_scim_schemas(opts)
694
694
  p result
695
695
  rescue PureCloud::ApiError => e
@@ -701,18 +701,18 @@ end
701
701
 
702
702
  Name | Type | Description | Notes
703
703
  ------------- | ------------- | ------------- | -------------
704
- **filter** | **String**| Filtered results are invalid and will result in a 403 (Unauthorized) return. | [optional] |
704
+ **filter** | **String**| Filtered results are invalid and return 403 Unauthorized. | [optional] |
705
705
  {: class="table table-striped"}
706
706
 
707
707
 
708
708
  ### Return type
709
709
 
710
- [**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html)
710
+ [**ScimV2SchemaListResponse**](ScimV2SchemaListResponse.html)
711
711
 
712
712
  ### HTTP request headers
713
713
 
714
- - **Content-Type**: application/json, application/scim+json
715
- - **Accept**: application/json, application/scim+json
714
+ - **Content-Type**: application/scim+json, application/json
715
+ - **Accept**: application/scim+json, application/json
716
716
 
717
717
 
718
718
 
@@ -776,8 +776,8 @@ Name | Type | Description | Notes
776
776
 
777
777
  ### HTTP request headers
778
778
 
779
- - **Content-Type**: application/json, application/scim+json
780
- - **Accept**: application/json, application/scim+json
779
+ - **Content-Type**: application/scim+json, application/json
780
+ - **Accept**: application/scim+json, application/json
781
781
 
782
782
 
783
783
 
@@ -836,8 +836,8 @@ end
836
836
  Name | Type | Description | Notes
837
837
  ------------- | ------------- | ------------- | -------------
838
838
  **user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
839
- **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
840
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
839
+ **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:core:2.0:User:meta, urn:ietf:params:scim:schemas:core:2.0:User:meta.version, urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds |
840
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:core:2.0:User:meta, urn:ietf:params:scim:schemas:core:2.0:User:meta.version, urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds |
841
841
  **if_none_match** | **String**| TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. 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. | [optional] |
842
842
  {: class="table table-striped"}
843
843
 
@@ -848,8 +848,8 @@ Name | Type | Description | Notes
848
848
 
849
849
  ### HTTP request headers
850
850
 
851
- - **Content-Type**: application/json, application/scim+json
852
- - **Accept**: application/json, application/scim+json
851
+ - **Content-Type**: application/scim+json, application/json
852
+ - **Accept**: application/scim+json, application/json
853
853
 
854
854
 
855
855
 
@@ -861,7 +861,7 @@ Name | Type | Description | Notes
861
861
 
862
862
  Get a list of users
863
863
 
864
- 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\".
864
+ 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\".
865
865
 
866
866
  Wraps GET /api/v2/scim/users
867
867
 
@@ -888,10 +888,10 @@ api_instance = PureCloud::SCIMApi.new
888
888
 
889
889
  opts = {
890
890
  start_index: 1, # Integer | The 1-based index of the first query result.
891
- count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users 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, and for Groups externalId, members).
891
+ count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". 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)
892
892
  attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
893
893
  excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
894
- filter: "filter_example" # String | Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\".
894
+ filter: "filter_example" # String | Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".
895
895
  }
896
896
 
897
897
  begin
@@ -908,10 +908,10 @@ end
908
908
  Name | Type | Description | Notes
909
909
  ------------- | ------------- | ------------- | -------------
910
910
  **start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
911
- **count** | **Integer**| The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users 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, and for Groups externalId, members). | [optional] [default to 25] |
912
- **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
913
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
914
- **filter** | **String**| 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;. | [optional] |
911
+ **count** | **Integer**| 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) | [optional] [default to 25] |
912
+ **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:core:2.0:User:meta, urn:ietf:params:scim:schemas:core:2.0:User:meta.version, urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds |
913
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:core:2.0:User:meta, urn:ietf:params:scim:schemas:core:2.0:User:meta.version, urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds |
914
+ **filter** | **String**| 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;. | [optional] |
915
915
  {: class="table table-striped"}
916
916
 
917
917
 
@@ -921,8 +921,8 @@ Name | Type | Description | Notes
921
921
 
922
922
  ### HTTP request headers
923
923
 
924
- - **Content-Type**: application/json, application/scim+json
925
- - **Accept**: application/json, application/scim+json
924
+ - **Content-Type**: application/scim+json, application/json
925
+ - **Accept**: application/scim+json, application/json
926
926
 
927
927
 
928
928
 
@@ -964,8 +964,8 @@ group_id = "group_id_example" # String | The ID of a group. Returned with GET /a
964
964
 
965
965
  opts = {
966
966
  attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes.
967
- excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
968
- if_none_match: "if_none_match_example" # String | 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: \"42\". 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.
967
+ excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
968
+ if_none_match: "if_none_match_example" # String | 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: \"42\". 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.
969
969
  }
970
970
 
971
971
  begin
@@ -982,9 +982,9 @@ end
982
982
  Name | Type | Description | Notes
983
983
  ------------- | ------------- | ------------- | -------------
984
984
  **group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
985
- **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
986
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
987
- **if_none_match** | **String**| 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. | [optional] |
985
+ **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:meta, urn:ietf:params:scim:schemas:core:2.0:Group:meta.version, urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
986
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:meta, urn:ietf:params:scim:schemas:core:2.0:Group:meta.version, urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
987
+ **if_none_match** | **String**| 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. | [optional] |
988
988
  {: class="table table-striped"}
989
989
 
990
990
 
@@ -994,8 +994,8 @@ Name | Type | Description | Notes
994
994
 
995
995
  ### HTTP request headers
996
996
 
997
- - **Content-Type**: application/json, application/scim+json
998
- - **Accept**: application/json, application/scim+json
997
+ - **Content-Type**: application/scim+json, application/json
998
+ - **Accept**: application/scim+json, application/json
999
999
 
1000
1000
 
1001
1001
 
@@ -1033,13 +1033,13 @@ end
1033
1033
 
1034
1034
  api_instance = PureCloud::SCIMApi.new
1035
1035
 
1036
- filter = "displayName eq groupName" # String | Filters results.
1036
+ filter = "displayName eq groupName" # String | Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
1037
1037
 
1038
1038
  opts = {
1039
1039
  start_index: 1, # Integer | The 1-based index of the first query result.
1040
- count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users 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, and for Groups externalId, members).
1040
+ count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". 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)
1041
1041
  attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes.
1042
- excluded_attributes: ["excluded_attributes_example"] # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
1042
+ excluded_attributes: ["excluded_attributes_example"] # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
1043
1043
  }
1044
1044
 
1045
1045
  begin
@@ -1055,11 +1055,11 @@ end
1055
1055
 
1056
1056
  Name | Type | Description | Notes
1057
1057
  ------------- | ------------- | ------------- | -------------
1058
- **filter** | **String**| Filters results. | |
1058
+ **filter** | **String**| 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;. | |
1059
1059
  **start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
1060
- **count** | **Integer**| The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users 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, and for Groups externalId, members). | [optional] [default to 25] |
1061
- **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
1062
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
1060
+ **count** | **Integer**| 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) | [optional] [default to 25] |
1061
+ **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:meta, urn:ietf:params:scim:schemas:core:2.0:Group:meta.version, urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
1062
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, displayName, members, externalId, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:meta, urn:ietf:params:scim:schemas:core:2.0:Group:meta.version, urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
1063
1063
  {: class="table table-striped"}
1064
1064
 
1065
1065
 
@@ -1069,8 +1069,8 @@ Name | Type | Description | Notes
1069
1069
 
1070
1070
  ### HTTP request headers
1071
1071
 
1072
- - **Content-Type**: application/json, application/scim+json
1073
- - **Accept**: application/json, application/scim+json
1072
+ - **Content-Type**: application/scim+json, application/json
1073
+ - **Accept**: application/scim+json, application/json
1074
1074
 
1075
1075
 
1076
1076
 
@@ -1133,8 +1133,8 @@ Name | Type | Description | Notes
1133
1133
 
1134
1134
  ### HTTP request headers
1135
1135
 
1136
- - **Content-Type**: application/json, application/scim+json
1137
- - **Accept**: application/json, application/scim+json
1136
+ - **Content-Type**: application/scim+json, application/json
1137
+ - **Accept**: application/scim+json, application/json
1138
1138
 
1139
1139
 
1140
1140
 
@@ -1191,8 +1191,8 @@ This endpoint does not need any parameter.
1191
1191
 
1192
1192
  ### HTTP request headers
1193
1193
 
1194
- - **Content-Type**: application/json, application/scim+json
1195
- - **Accept**: application/json, application/scim+json
1194
+ - **Content-Type**: application/scim+json, application/json
1195
+ - **Accept**: application/scim+json, application/json
1196
1196
 
1197
1197
 
1198
1198
 
@@ -1202,7 +1202,7 @@ This endpoint does not need any parameter.
1202
1202
 
1203
1203
 
1204
1204
 
1205
- Get the SCIM schema by id
1205
+ Get a SCIM schema
1206
1206
 
1207
1207
 
1208
1208
 
@@ -1229,11 +1229,11 @@ end
1229
1229
 
1230
1230
  api_instance = PureCloud::SCIMApi.new
1231
1231
 
1232
- schema_id = "schema_id_example" # String | The ID of a schema.
1232
+ schema_id = "schema_id_example" # String | The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.
1233
1233
 
1234
1234
 
1235
1235
  begin
1236
- #Get the SCIM schema by id
1236
+ #Get a SCIM schema
1237
1237
  result = api_instance.get_scim_v2_schema(schema_id)
1238
1238
  p result
1239
1239
  rescue PureCloud::ApiError => e
@@ -1245,7 +1245,7 @@ end
1245
1245
 
1246
1246
  Name | Type | Description | Notes
1247
1247
  ------------- | ------------- | ------------- | -------------
1248
- **schema_id** | **String**| The ID of a schema. | <br />**Values**: urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User |
1248
+ **schema_id** | **String**| The ID of a schema. Returned with GET /api/v2/scim/v2/schemas. | <br />**Values**: urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User |
1249
1249
  {: class="table table-striped"}
1250
1250
 
1251
1251
 
@@ -1255,8 +1255,8 @@ Name | Type | Description | Notes
1255
1255
 
1256
1256
  ### HTTP request headers
1257
1257
 
1258
- - **Content-Type**: application/json, application/scim+json
1259
- - **Accept**: application/json, application/scim+json
1258
+ - **Content-Type**: application/scim+json, application/json
1259
+ - **Accept**: application/scim+json, application/json
1260
1260
 
1261
1261
 
1262
1262
 
@@ -1266,7 +1266,7 @@ Name | Type | Description | Notes
1266
1266
 
1267
1267
 
1268
1268
 
1269
- Get the SCIM schemas
1269
+ Get a list of SCIM schemas
1270
1270
 
1271
1271
 
1272
1272
 
@@ -1294,11 +1294,11 @@ end
1294
1294
  api_instance = PureCloud::SCIMApi.new
1295
1295
 
1296
1296
  opts = {
1297
- filter: "displayName eq groupName" # String | Filtered results are invalid and will result in a 403 (Unauthorized) return.
1297
+ filter: "displayName eq groupName" # String | Filtered results are invalid and return 403 Unauthorized.
1298
1298
  }
1299
1299
 
1300
1300
  begin
1301
- #Get the SCIM schemas
1301
+ #Get a list of SCIM schemas
1302
1302
  result = api_instance.get_scim_v2_schemas(opts)
1303
1303
  p result
1304
1304
  rescue PureCloud::ApiError => e
@@ -1310,7 +1310,7 @@ end
1310
1310
 
1311
1311
  Name | Type | Description | Notes
1312
1312
  ------------- | ------------- | ------------- | -------------
1313
- **filter** | **String**| Filtered results are invalid and will result in a 403 (Unauthorized) return. | [optional] |
1313
+ **filter** | **String**| Filtered results are invalid and return 403 Unauthorized. | [optional] |
1314
1314
  {: class="table table-striped"}
1315
1315
 
1316
1316
 
@@ -1320,8 +1320,8 @@ Name | Type | Description | Notes
1320
1320
 
1321
1321
  ### HTTP request headers
1322
1322
 
1323
- - **Content-Type**: application/json, application/scim+json
1324
- - **Accept**: application/json, application/scim+json
1323
+ - **Content-Type**: application/scim+json, application/json
1324
+ - **Accept**: application/scim+json, application/json
1325
1325
 
1326
1326
 
1327
1327
 
@@ -1385,8 +1385,8 @@ Name | Type | Description | Notes
1385
1385
 
1386
1386
  ### HTTP request headers
1387
1387
 
1388
- - **Content-Type**: application/json, application/scim+json
1389
- - **Accept**: application/json, application/scim+json
1388
+ - **Content-Type**: application/scim+json, application/json
1389
+ - **Accept**: application/scim+json, application/json
1390
1390
 
1391
1391
 
1392
1392
 
@@ -1445,8 +1445,8 @@ end
1445
1445
  Name | Type | Description | Notes
1446
1446
  ------------- | ------------- | ------------- | -------------
1447
1447
  **user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
1448
- **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1449
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1448
+ **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:core:2.0:User:meta, urn:ietf:params:scim:schemas:core:2.0:User:meta.version, urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds |
1449
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:core:2.0:User:meta, urn:ietf:params:scim:schemas:core:2.0:User:meta.version, urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds |
1450
1450
  **if_none_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. 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. | [optional] |
1451
1451
  {: class="table table-striped"}
1452
1452
 
@@ -1457,8 +1457,8 @@ Name | Type | Description | Notes
1457
1457
 
1458
1458
  ### HTTP request headers
1459
1459
 
1460
- - **Content-Type**: application/json, application/scim+json
1461
- - **Accept**: application/json, application/scim+json
1460
+ - **Content-Type**: application/scim+json, application/json
1461
+ - **Accept**: application/scim+json, application/json
1462
1462
 
1463
1463
 
1464
1464
 
@@ -1470,7 +1470,7 @@ Name | Type | Description | Notes
1470
1470
 
1471
1471
  Get a list of users
1472
1472
 
1473
- 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\".
1473
+ 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\".
1474
1474
 
1475
1475
  Wraps GET /api/v2/scim/v2/users
1476
1476
 
@@ -1497,10 +1497,10 @@ api_instance = PureCloud::SCIMApi.new
1497
1497
 
1498
1498
  opts = {
1499
1499
  start_index: 1, # Integer | The 1-based index of the first query result.
1500
- count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users 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, and for Groups externalId, members).
1500
+ count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". 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)
1501
1501
  attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
1502
1502
  excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
1503
- filter: "filter_example" # String | Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\".
1503
+ filter: "filter_example" # String | Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".
1504
1504
  }
1505
1505
 
1506
1506
  begin
@@ -1517,10 +1517,10 @@ end
1517
1517
  Name | Type | Description | Notes
1518
1518
  ------------- | ------------- | ------------- | -------------
1519
1519
  **start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
1520
- **count** | **Integer**| The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users 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, and for Groups externalId, members). | [optional] [default to 25] |
1521
- **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1522
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1523
- **filter** | **String**| 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;. | [optional] |
1520
+ **count** | **Integer**| 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) | [optional] [default to 25] |
1521
+ **attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:core:2.0:User:meta, urn:ietf:params:scim:schemas:core:2.0:User:meta.version, urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds |
1522
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| 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. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, meta, meta.version, meta.lastModified, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:core:2.0:User:meta, urn:ietf:params:scim:schemas:core:2.0:User:meta.version, urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds |
1523
+ **filter** | **String**| 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;. | [optional] |
1524
1524
  {: class="table table-striped"}
1525
1525
 
1526
1526
 
@@ -1530,8 +1530,8 @@ Name | Type | Description | Notes
1530
1530
 
1531
1531
  ### HTTP request headers
1532
1532
 
1533
- - **Content-Type**: application/json, application/scim+json
1534
- - **Accept**: application/json, application/scim+json
1533
+ - **Content-Type**: application/scim+json, application/json
1534
+ - **Accept**: application/scim+json, application/json
1535
1535
 
1536
1536
 
1537
1537
 
@@ -1602,8 +1602,8 @@ Name | Type | Description | Notes
1602
1602
 
1603
1603
  ### HTTP request headers
1604
1604
 
1605
- - **Content-Type**: application/json, application/scim+json
1606
- - **Accept**: application/json, application/scim+json
1605
+ - **Content-Type**: application/scim+json, application/json
1606
+ - **Accept**: application/scim+json, application/json
1607
1607
 
1608
1608
 
1609
1609
 
@@ -1679,8 +1679,8 @@ Name | Type | Description | Notes
1679
1679
 
1680
1680
  ### HTTP request headers
1681
1681
 
1682
- - **Content-Type**: application/json, application/scim+json
1683
- - **Accept**: application/json, application/scim+json
1682
+ - **Content-Type**: application/scim+json, application/json
1683
+ - **Accept**: application/scim+json, application/json
1684
1684
 
1685
1685
 
1686
1686
 
@@ -1751,8 +1751,8 @@ Name | Type | Description | Notes
1751
1751
 
1752
1752
  ### HTTP request headers
1753
1753
 
1754
- - **Content-Type**: application/json, application/scim+json
1755
- - **Accept**: application/json, application/scim+json
1754
+ - **Content-Type**: application/scim+json, application/json
1755
+ - **Accept**: application/scim+json, application/json
1756
1756
 
1757
1757
 
1758
1758
 
@@ -1828,8 +1828,8 @@ Name | Type | Description | Notes
1828
1828
 
1829
1829
  ### HTTP request headers
1830
1830
 
1831
- - **Content-Type**: application/json, application/scim+json
1832
- - **Accept**: application/json, application/scim+json
1831
+ - **Content-Type**: application/scim+json, application/json
1832
+ - **Accept**: application/scim+json, application/json
1833
1833
 
1834
1834
 
1835
1835
 
@@ -1839,9 +1839,9 @@ Name | Type | Description | Notes
1839
1839
 
1840
1840
 
1841
1841
 
1842
- The information used to create a group.
1842
+ Creates a group
1843
1843
 
1844
- 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.
1844
+ 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.
1845
1845
 
1846
1846
  Wraps POST /api/v2/scim/groups
1847
1847
 
@@ -1871,7 +1871,7 @@ body = PureCloud::ScimV2Group.new # ScimV2Group | The information used to create
1871
1871
 
1872
1872
 
1873
1873
  begin
1874
- #The information used to create a group.
1874
+ #Creates a group
1875
1875
  result = api_instance.post_scim_groups(body)
1876
1876
  p result
1877
1877
  rescue PureCloud::ApiError => e
@@ -1893,8 +1893,8 @@ Name | Type | Description | Notes
1893
1893
 
1894
1894
  ### HTTP request headers
1895
1895
 
1896
- - **Content-Type**: application/json, application/scim+json
1897
- - **Accept**: application/json, application/scim+json
1896
+ - **Content-Type**: application/scim+json, application/json
1897
+ - **Accept**: application/scim+json, application/json
1898
1898
 
1899
1899
 
1900
1900
 
@@ -1962,8 +1962,8 @@ Name | Type | Description | Notes
1962
1962
 
1963
1963
  ### HTTP request headers
1964
1964
 
1965
- - **Content-Type**: application/json, application/scim+json
1966
- - **Accept**: application/json, application/scim+json
1965
+ - **Content-Type**: application/scim+json, application/json
1966
+ - **Accept**: application/scim+json, application/json
1967
1967
 
1968
1968
 
1969
1969
 
@@ -1973,9 +1973,9 @@ Name | Type | Description | Notes
1973
1973
 
1974
1974
 
1975
1975
 
1976
- The information used to create a group.
1976
+ Create a group
1977
1977
 
1978
- 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.
1978
+ 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.
1979
1979
 
1980
1980
  Wraps POST /api/v2/scim/v2/groups
1981
1981
 
@@ -2001,11 +2001,11 @@ end
2001
2001
 
2002
2002
  api_instance = PureCloud::SCIMApi.new
2003
2003
 
2004
- body = PureCloud::ScimV2Group.new # ScimV2Group | The information used to create a group.
2004
+ body = PureCloud::ScimV2Group.new # ScimV2Group | Creates a group.
2005
2005
 
2006
2006
 
2007
2007
  begin
2008
- #The information used to create a group.
2008
+ #Create a group
2009
2009
  result = api_instance.post_scim_v2_groups(body)
2010
2010
  p result
2011
2011
  rescue PureCloud::ApiError => e
@@ -2017,7 +2017,7 @@ end
2017
2017
 
2018
2018
  Name | Type | Description | Notes
2019
2019
  ------------- | ------------- | ------------- | -------------
2020
- **body** | [**ScimV2Group**](ScimV2Group.html)| The information used to create a group. | |
2020
+ **body** | [**ScimV2Group**](ScimV2Group.html)| Creates a group. | |
2021
2021
  {: class="table table-striped"}
2022
2022
 
2023
2023
 
@@ -2027,8 +2027,8 @@ Name | Type | Description | Notes
2027
2027
 
2028
2028
  ### HTTP request headers
2029
2029
 
2030
- - **Content-Type**: application/json, application/scim+json
2031
- - **Accept**: application/json, application/scim+json
2030
+ - **Content-Type**: application/scim+json, application/json
2031
+ - **Accept**: application/scim+json, application/json
2032
2032
 
2033
2033
 
2034
2034
 
@@ -2096,8 +2096,8 @@ Name | Type | Description | Notes
2096
2096
 
2097
2097
  ### HTTP request headers
2098
2098
 
2099
- - **Content-Type**: application/json, application/scim+json
2100
- - **Accept**: application/json, application/scim+json
2099
+ - **Content-Type**: application/scim+json, application/json
2100
+ - **Accept**: application/scim+json, application/json
2101
2101
 
2102
2102
 
2103
2103
 
@@ -2168,8 +2168,8 @@ Name | Type | Description | Notes
2168
2168
 
2169
2169
  ### HTTP request headers
2170
2170
 
2171
- - **Content-Type**: application/json, application/scim+json
2172
- - **Accept**: application/json, application/scim+json
2171
+ - **Content-Type**: application/scim+json, application/json
2172
+ - **Accept**: application/scim+json, application/json
2173
2173
 
2174
2174
 
2175
2175
 
@@ -2245,8 +2245,8 @@ Name | Type | Description | Notes
2245
2245
 
2246
2246
  ### HTTP request headers
2247
2247
 
2248
- - **Content-Type**: application/json, application/scim+json
2249
- - **Accept**: application/json, application/scim+json
2248
+ - **Content-Type**: application/scim+json, application/json
2249
+ - **Accept**: application/scim+json, application/json
2250
2250
 
2251
2251
 
2252
2252
 
@@ -2317,8 +2317,8 @@ Name | Type | Description | Notes
2317
2317
 
2318
2318
  ### HTTP request headers
2319
2319
 
2320
- - **Content-Type**: application/json, application/scim+json
2321
- - **Accept**: application/json, application/scim+json
2320
+ - **Content-Type**: application/scim+json, application/json
2321
+ - **Accept**: application/scim+json, application/json
2322
2322
 
2323
2323
 
2324
2324
 
@@ -2394,8 +2394,8 @@ Name | Type | Description | Notes
2394
2394
 
2395
2395
  ### HTTP request headers
2396
2396
 
2397
- - **Content-Type**: application/json, application/scim+json
2398
- - **Accept**: application/json, application/scim+json
2397
+ - **Content-Type**: application/scim+json, application/json
2398
+ - **Accept**: application/scim+json, application/json
2399
2399
 
2400
2400
 
2401
2401