purecloudplatformclientv2 90.0.0 → 95.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (748) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  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/AnalyticsSession.md +4 -0
  9. data/docs/ArchitectApi.md +51 -49
  10. data/docs/ArrayNode.md +5 -5
  11. data/docs/AttemptLimitsEntityListing.md +1 -1
  12. data/docs/AuditApi.md +70 -0
  13. data/docs/AuditRealtimeQueryRequest.md +18 -0
  14. data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
  15. data/docs/AuthzDivisionEntityListing.md +1 -1
  16. data/docs/AvailableTopic.md +1 -0
  17. data/docs/Biography.md +1 -0
  18. data/docs/BuAgentScheduleActivity.md +2 -0
  19. data/docs/ButtonComponent.md +16 -0
  20. data/docs/CalibrationEntityListing.md +1 -1
  21. data/docs/Call.md +1 -0
  22. data/docs/CallBasic.md +1 -0
  23. data/docs/CallConversationEntityListing.md +1 -1
  24. data/docs/CallHistoryConversationEntityListing.md +1 -1
  25. data/docs/CallableTimeSetEntityListing.md +1 -1
  26. data/docs/Callback.md +1 -0
  27. data/docs/CallbackBasic.md +1 -0
  28. data/docs/CallbackConversationEntityListing.md +1 -1
  29. data/docs/CampaignDivisionViewListing.md +1 -1
  30. data/docs/CampaignEntityListing.md +1 -1
  31. data/docs/CampaignRuleEntityListing.md +1 -1
  32. data/docs/CampaignSequenceEntityListing.md +1 -1
  33. data/docs/CertificateAuthorityEntityListing.md +1 -1
  34. data/docs/ChatConversationEntityListing.md +1 -1
  35. data/docs/ClientAppEntityListing.md +1 -1
  36. data/docs/CoachingAnnotationList.md +1 -1
  37. data/docs/CoachingApi.md +35 -28
  38. data/docs/CoachingAppointmentResponseList.md +1 -1
  39. data/docs/CoachingNotification.md +1 -1
  40. data/docs/CoachingNotificationList.md +1 -1
  41. data/docs/CobrowseConversationEntityListing.md +1 -1
  42. data/docs/Cobrowsesession.md +1 -0
  43. data/docs/CommandStatusEntityListing.md +1 -1
  44. data/docs/CommonCampaign.md +17 -0
  45. data/docs/CommonCampaignDivisionView.md +17 -0
  46. data/docs/CommonCampaignDivisionViewEntityListing.md +22 -0
  47. data/docs/CommonCampaignEntityListing.md +22 -0
  48. data/docs/ConsumedResourcesEntityListing.md +1 -1
  49. data/docs/ConsumingResourcesEntityListing.md +1 -1
  50. data/docs/Contact.md +1 -0
  51. data/docs/ContactListDivisionViewListing.md +1 -1
  52. data/docs/ContactListEntityListing.md +1 -1
  53. data/docs/ContactListFilterEntityListing.md +1 -1
  54. data/docs/ContactListing.md +1 -1
  55. data/docs/ContentActions.md +17 -0
  56. data/docs/ContentAttachment.md +19 -0
  57. data/docs/ContentGeneric.md +19 -0
  58. data/docs/ContentList.md +19 -0
  59. data/docs/ContentLocation.md +17 -0
  60. data/docs/ContentNotificationTemplate.md +17 -0
  61. data/docs/ContentQuickReply.md +16 -0
  62. data/docs/ConversationAggregationQuery.md +1 -1
  63. data/docs/ConversationAssociation.md +1 -1
  64. data/docs/ConversationChat.md +1 -0
  65. data/docs/ConversationEntityListing.md +1 -1
  66. data/docs/ConversationEventTopicAfterCallWork.md +15 -0
  67. data/docs/ConversationEventTopicCall.md +1 -0
  68. data/docs/ConversationEventTopicCallback.md +1 -0
  69. data/docs/ConversationEventTopicChat.md +1 -0
  70. data/docs/ConversationEventTopicCobrowse.md +1 -0
  71. data/docs/ConversationEventTopicEmail.md +1 -0
  72. data/docs/ConversationEventTopicMessage.md +2 -0
  73. data/docs/ConversationEventTopicScreenshare.md +1 -0
  74. data/docs/ConversationEventTopicSocialExpression.md +1 -0
  75. data/docs/ConversationEventTopicVideo.md +1 -0
  76. data/docs/ConversationsApi.md +73 -4
  77. data/docs/CreateCoachingAppointmentRequest.md +1 -1
  78. data/docs/CredentialInfoListing.md +1 -1
  79. data/docs/CredentialTypeListing.md +1 -1
  80. data/docs/CursorContactListing.md +16 -0
  81. data/docs/CursorNoteListing.md +16 -0
  82. data/docs/CursorOrganizationListing.md +16 -0
  83. data/docs/CursorRelationshipListing.md +16 -0
  84. data/docs/DIDEntityListing.md +1 -1
  85. data/docs/DIDPoolEntityListing.md +1 -1
  86. data/docs/DataTableRowEntityListing.md +1 -1
  87. data/docs/DataTablesDomainEntityListing.md +1 -1
  88. data/docs/DependencyObjectEntityListing.md +1 -1
  89. data/docs/DependencyTypeEntityListing.md +1 -1
  90. data/docs/DialerEventEntityListing.md +1 -1
  91. data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
  92. data/docs/DirectoryUserDevicesListing.md +1 -1
  93. data/docs/DivsPermittedEntityListing.md +1 -1
  94. data/docs/DncListDivisionViewListing.md +1 -1
  95. data/docs/DncListEntityListing.md +1 -1
  96. data/docs/DocumentAuditEntityListing.md +1 -1
  97. data/docs/DocumentEntityListing.md +1 -1
  98. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  99. data/docs/DomainEntityListing.md +1 -1
  100. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  101. data/docs/DomainEntityListingQueryResult.md +1 -1
  102. data/docs/DomainEntityListingSurveyForm.md +1 -1
  103. data/docs/DomainOrganizationRole.md +1 -1
  104. data/docs/DomainOrganizationRoleCreate.md +1 -1
  105. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  106. data/docs/EdgeEntityListing.md +1 -1
  107. data/docs/EdgeGroup.md +1 -0
  108. data/docs/EdgeGroupEntityListing.md +1 -1
  109. data/docs/EdgeLineEntityListing.md +1 -1
  110. data/docs/Education.md +17 -0
  111. data/docs/Email.md +1 -0
  112. data/docs/EmailConversationEntityListing.md +1 -1
  113. data/docs/EmailMessageListing.md +1 -1
  114. data/docs/EmergencyGroupListing.md +1 -1
  115. data/docs/EncryptionKeyEntityListing.md +1 -1
  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/GenericSAML.md +1 -1
  135. data/docs/GoogleDialogflowCustomSettings.md +13 -0
  136. data/docs/GreetingListing.md +1 -1
  137. data/docs/GroupEntityListing.md +1 -1
  138. data/docs/GroupProfileEntityListing.md +1 -1
  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/IVREntityListing.md +1 -1
  144. data/docs/InboundDomainEntityListing.md +1 -1
  145. data/docs/InboundRouteEntityListing.md +1 -1
  146. data/docs/IntegrationEntityListing.md +1 -1
  147. data/docs/IntegrationEventEntityListing.md +1 -1
  148. data/docs/IntegrationTypeEntityListing.md +1 -1
  149. data/docs/InteractionStatsAlertContainer.md +1 -1
  150. data/docs/InteractionStatsRuleContainer.md +1 -1
  151. data/docs/JourneyAggregateDataContainer.md +14 -0
  152. data/docs/JourneyAggregateQueryClause.md +14 -0
  153. data/docs/JourneyAggregateQueryFilter.md +15 -0
  154. data/docs/JourneyAggregateQueryPredicate.md +17 -0
  155. data/docs/JourneyAggregateQueryResponse.md +13 -0
  156. data/docs/JourneyAggregationQuery.md +21 -0
  157. data/docs/JourneyAggregationView.md +16 -0
  158. data/docs/JourneyApi.md +78 -0
  159. data/docs/JsonNode.md +5 -5
  160. data/docs/KeywordSetEntityListing.md +1 -1
  161. data/docs/KnowledgeSearchRequest.md +3 -3
  162. data/docs/LanguageEntityListing.md +1 -1
  163. data/docs/LanguageUnderstandingApi.md +165 -31
  164. data/docs/LexBotAliasEntityListing.md +1 -1
  165. data/docs/LexBotEntityListing.md +1 -1
  166. data/docs/LibraryEntityListing.md +1 -1
  167. data/docs/LineBaseEntityListing.md +1 -1
  168. data/docs/LineEntityListing.md +1 -1
  169. data/docs/LineIntegrationEntityListing.md +1 -1
  170. data/docs/ListItemComponent.md +19 -0
  171. data/docs/LocationEntityListing.md +1 -1
  172. data/docs/LogicalInterfaceEntityListing.md +1 -1
  173. data/docs/Message.md +1 -0
  174. data/docs/MessageContent.md +19 -0
  175. data/docs/MessageConversationEntityListing.md +1 -1
  176. data/docs/MessagingCampaign.md +28 -0
  177. data/docs/MessagingCampaignDivisionView.md +16 -0
  178. data/docs/MessagingCampaignDivisionViewEntityListing.md +22 -0
  179. data/docs/MessagingCampaignEntityListing.md +22 -0
  180. data/docs/MessagingIntegrationEntityListing.md +1 -1
  181. data/docs/MessagingStickerEntityListing.md +1 -1
  182. data/docs/NluDomainListing.md +1 -1
  183. data/docs/NluDomainVersion.md +2 -1
  184. data/docs/NluDomainVersionListing.md +1 -1
  185. data/docs/NluFeedbackListing.md +1 -1
  186. data/docs/NoteListing.md +1 -1
  187. data/docs/NotificationTemplateBody.md +14 -0
  188. data/docs/NotificationTemplateFooter.md +13 -0
  189. data/docs/NotificationTemplateHeader.md +16 -0
  190. data/docs/NotificationTemplateParameter.md +14 -0
  191. data/docs/NotificationsApi.md +1 -1
  192. data/docs/OAuthClient.md +1 -0
  193. data/docs/OAuthClientEntityListing.md +1 -1
  194. data/docs/OAuthClientListing.md +1 -0
  195. data/docs/OAuthClientRequest.md +1 -0
  196. data/docs/OAuthProviderEntityListing.md +1 -1
  197. data/docs/ObservationValue.md +3 -1
  198. data/docs/OrgOAuthClient.md +1 -0
  199. data/docs/OrganizationPresenceEntityListing.md +1 -1
  200. data/docs/OrganizationRoleEntityListing.md +1 -1
  201. data/docs/OrphanRecordingListing.md +1 -1
  202. data/docs/OutboundApi.md +881 -76
  203. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  204. data/docs/OutboundRouteEntityListing.md +1 -1
  205. data/docs/PermissionCollectionEntityListing.md +1 -1
  206. data/docs/PhoneBaseEntityListing.md +1 -1
  207. data/docs/PhoneCapabilities.md +1 -0
  208. data/docs/PhoneEntityListing.md +1 -1
  209. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  210. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  211. data/docs/PolicyEntityListing.md +1 -1
  212. data/docs/PostTextMessage.md +15 -0
  213. data/docs/PostTextRequest.md +23 -0
  214. data/docs/PostTextResponse.md +20 -0
  215. data/docs/PresenceApi.md +206 -6
  216. data/docs/PresenceExpand.md +17 -0
  217. data/docs/PromptAssetEntityListing.md +1 -1
  218. data/docs/PromptEntityListing.md +1 -1
  219. data/docs/QualityAuditPage.md +1 -1
  220. data/docs/QueueConversationEventTopicAfterCallWork.md +15 -0
  221. data/docs/QueueConversationEventTopicCall.md +1 -0
  222. data/docs/QueueConversationEventTopicCallback.md +1 -0
  223. data/docs/QueueConversationEventTopicChat.md +1 -0
  224. data/docs/QueueConversationEventTopicCobrowse.md +1 -0
  225. data/docs/QueueConversationEventTopicEmail.md +1 -0
  226. data/docs/QueueConversationEventTopicMessage.md +2 -0
  227. data/docs/QueueConversationEventTopicScreenshare.md +1 -0
  228. data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
  229. data/docs/QueueConversationEventTopicVideo.md +1 -0
  230. data/docs/QueueConversationSocialExpressionEventTopicAfterCallWork.md +15 -0
  231. data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
  232. data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
  233. data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
  234. data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
  235. data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
  236. data/docs/QueueConversationSocialExpressionEventTopicMessage.md +2 -0
  237. data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
  238. data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
  239. data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
  240. data/docs/QueueConversationVideoEventTopicAfterCallWork.md +15 -0
  241. data/docs/QueueConversationVideoEventTopicCall.md +1 -0
  242. data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
  243. data/docs/QueueConversationVideoEventTopicChat.md +1 -0
  244. data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
  245. data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
  246. data/docs/QueueConversationVideoEventTopicMessage.md +2 -0
  247. data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
  248. data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
  249. data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
  250. data/docs/QueueEntityListing.md +1 -1
  251. data/docs/QueueMemberEntityListing.md +1 -1
  252. data/docs/RecipientListing.md +1 -1
  253. data/docs/Recording.md +1 -0
  254. data/docs/RecordingApi.md +2 -2
  255. data/docs/RecordingJobEntityListing.md +1 -1
  256. data/docs/RelationshipListing.md +1 -1
  257. data/docs/ReportMetaDataEntityListing.md +1 -1
  258. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  259. data/docs/ReportScheduleEntityListing.md +1 -1
  260. data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
  261. data/docs/ReportingExportJobListing.md +1 -1
  262. data/docs/ReportingExportJobRequest.md +2 -0
  263. data/docs/ReportingExportJobResponse.md +3 -0
  264. data/docs/ReportingExportMetadataJobListing.md +1 -1
  265. data/docs/ResponseEntityList.md +1 -1
  266. data/docs/ResponseEntityListing.md +1 -1
  267. data/docs/ResponseSetEntityListing.md +1 -1
  268. data/docs/RoutingApi.md +13 -13
  269. data/docs/RuleSetEntityListing.md +1 -1
  270. data/docs/SCIMApi.md +92 -104
  271. data/docs/ScheduleEntityListing.md +1 -1
  272. data/docs/ScheduleGroupEntityListing.md +1 -1
  273. data/docs/SchemaCategoryEntityListing.md +1 -1
  274. data/docs/SchemaReferenceEntityListing.md +1 -1
  275. data/docs/ScimConfigResourceType.md +2 -2
  276. data/docs/ScimGenesysUserExternalId.md +14 -0
  277. data/docs/ScimMetadata.md +2 -2
  278. data/docs/ScimUserExtensions.md +3 -2
  279. data/docs/ScimUserRole.md +1 -1
  280. data/docs/ScimUserRoutingLanguage.md +2 -2
  281. data/docs/ScimUserRoutingSkill.md +2 -2
  282. data/docs/ScimV2CreateUser.md +3 -3
  283. data/docs/ScimV2Group.md +1 -1
  284. data/docs/ScimV2SchemaAttribute.md +11 -11
  285. data/docs/ScimV2SchemaDefinition.md +5 -5
  286. data/docs/ScimV2SchemaListResponse.md +1 -1
  287. data/docs/ScimV2User.md +4 -4
  288. data/docs/ScreenRecordingSessionListing.md +1 -1
  289. data/docs/Screenshare.md +1 -0
  290. data/docs/ScriptEntityListing.md +1 -1
  291. data/docs/SearchApi.md +3 -1
  292. data/docs/SecurityProfileEntityListing.md +1 -1
  293. data/docs/ShareEntityListing.md +1 -1
  294. data/docs/SiteEntityListing.md +1 -1
  295. data/docs/SkillEntityListing.md +1 -1
  296. data/docs/SmsAddressEntityListing.md +1 -1
  297. data/docs/SmsConfig.md +15 -0
  298. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  299. data/docs/SmsPhoneNumberRef.md +14 -0
  300. data/docs/SocialExpression.md +1 -0
  301. data/docs/SpeechTextAnalyticsApi.md +81 -0
  302. data/docs/StationEntityListing.md +1 -1
  303. data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
  304. data/docs/SurveyAggregationQuery.md +1 -1
  305. data/docs/SurveyForm.md +0 -2
  306. data/docs/SurveyFormEntityListing.md +1 -1
  307. data/docs/SystemPromptAssetEntityListing.md +1 -1
  308. data/docs/SystemPromptEntityListing.md +1 -1
  309. data/docs/TagValueEntityListing.md +1 -1
  310. data/docs/TelephonyProvidersEdgeApi.md +6 -2
  311. data/docs/TextMessageListing.md +1 -1
  312. data/docs/TextbotsApi.md +78 -0
  313. data/docs/TimeZoneEntityListing.md +1 -1
  314. data/docs/TranscriptUrl.md +13 -0
  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 +2 -1
  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 +17 -5
  339. data/docs/Video.md +1 -0
  340. data/docs/ViewFilter.md +4 -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 +74 -0
  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/coaching_api.rb +28 -9
  371. data/lib/purecloudplatformclientv2/api/conversations_api.rb +79 -4
  372. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +305 -13
  373. data/lib/purecloudplatformclientv2/api/journey_api.rb +92 -0
  374. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +191 -32
  375. data/lib/purecloudplatformclientv2/api/outbound_api.rb +1215 -155
  376. data/lib/purecloudplatformclientv2/api/presence_api.rb +213 -8
  377. data/lib/purecloudplatformclientv2/api/recording_api.rb +3 -3
  378. data/lib/purecloudplatformclientv2/api/scim_api.rb +74 -74
  379. data/lib/purecloudplatformclientv2/api/search_api.rb +13 -0
  380. data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +102 -0
  381. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +18 -0
  382. data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
  383. data/lib/purecloudplatformclientv2/api/users_api.rb +78 -0
  384. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
  385. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  386. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
  387. data/lib/purecloudplatformclientv2/models/after_call_work.rb +267 -0
  388. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
  389. data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
  390. data/lib/purecloudplatformclientv2/models/analytics_session.rb +124 -4
  391. data/lib/purecloudplatformclientv2/models/array_node.rb +51 -51
  392. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
  393. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
  394. data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +2 -2
  395. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +2 -2
  396. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +2 -2
  397. data/lib/purecloudplatformclientv2/models/audit_query_service.rb +2 -2
  398. data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
  399. data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
  400. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
  401. data/lib/purecloudplatformclientv2/models/available_topic.rb +32 -4
  402. data/lib/purecloudplatformclientv2/models/biography.rb +32 -4
  403. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
  404. data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
  405. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
  406. data/lib/purecloudplatformclientv2/models/call.rb +30 -4
  407. data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
  408. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
  409. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
  410. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
  411. data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
  412. data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
  413. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
  414. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
  415. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
  416. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
  417. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
  418. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
  419. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
  420. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
  421. data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +12 -12
  422. data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +12 -12
  423. data/lib/purecloudplatformclientv2/models/coaching_notification.rb +1 -1
  424. data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +12 -12
  425. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
  426. data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
  427. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
  428. data/lib/purecloudplatformclientv2/models/common_campaign.rb +320 -0
  429. data/lib/purecloudplatformclientv2/models/common_campaign_division_view.rb +320 -0
  430. data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +428 -0
  431. data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +428 -0
  432. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
  433. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
  434. data/lib/purecloudplatformclientv2/models/contact.rb +29 -4
  435. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
  436. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
  437. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
  438. data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
  439. data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
  440. data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
  441. data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
  442. data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
  443. data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
  444. data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
  445. data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
  446. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  447. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
  448. data/lib/purecloudplatformclientv2/models/conversation_association.rb +1 -1
  449. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
  450. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
  451. data/lib/purecloudplatformclientv2/models/conversation_event_topic_after_call_work.rb +265 -0
  452. data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
  453. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
  454. data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
  455. data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
  456. data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
  457. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +51 -1
  458. data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
  459. data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
  460. data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
  461. data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb +1 -1
  462. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
  463. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
  464. data/lib/purecloudplatformclientv2/models/cursor_contact_listing.rb +278 -0
  465. data/lib/purecloudplatformclientv2/models/cursor_note_listing.rb +278 -0
  466. data/lib/purecloudplatformclientv2/models/cursor_organization_listing.rb +278 -0
  467. data/lib/purecloudplatformclientv2/models/cursor_relationship_listing.rb +278 -0
  468. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
  469. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
  470. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  471. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  472. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
  473. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
  474. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
  475. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
  476. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
  477. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
  478. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
  479. data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +12 -12
  480. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
  481. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
  482. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
  483. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
  484. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
  485. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
  486. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
  487. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
  488. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
  489. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  490. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  491. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  492. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
  493. data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
  494. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
  495. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
  496. data/lib/purecloudplatformclientv2/models/education.rb +304 -0
  497. data/lib/purecloudplatformclientv2/models/email.rb +30 -4
  498. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
  499. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
  500. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
  501. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
  502. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
  503. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
  504. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
  505. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
  506. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  507. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
  508. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
  509. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
  510. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
  511. data/lib/purecloudplatformclientv2/models/facebook_integration_update_request.rb +228 -0
  512. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
  513. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  514. data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
  515. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
  516. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
  517. data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
  518. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
  519. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
  520. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
  521. data/lib/purecloudplatformclientv2/models/generic_saml.rb +12 -12
  522. data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
  523. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
  524. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
  525. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
  526. data/lib/purecloudplatformclientv2/models/historical_adherence_actuals.rb +268 -0
  527. data/lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb +462 -0
  528. data/lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb +466 -0
  529. data/lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb +430 -0
  530. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
  531. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
  532. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
  533. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
  534. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
  535. data/lib/purecloudplatformclientv2/models/intent_feedback.rb +2 -2
  536. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
  537. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
  538. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
  539. data/lib/purecloudplatformclientv2/models/journey_aggregate_data_container.rb +231 -0
  540. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_clause.rb +254 -0
  541. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_filter.rb +277 -0
  542. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_predicate.rb +348 -0
  543. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_response.rb +203 -0
  544. data/lib/purecloudplatformclientv2/models/journey_aggregation_query.rb +435 -0
  545. data/lib/purecloudplatformclientv2/models/journey_aggregation_view.rb +323 -0
  546. data/lib/purecloudplatformclientv2/models/json_node.rb +51 -51
  547. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
  548. data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +0 -15
  549. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
  550. data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
  551. data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
  552. data/lib/purecloudplatformclientv2/models/library.rb +2 -2
  553. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
  554. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
  555. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
  556. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
  557. data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
  558. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
  559. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
  560. data/lib/purecloudplatformclientv2/models/message.rb +30 -4
  561. data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
  562. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
  563. data/lib/purecloudplatformclientv2/models/messaging_campaign.rb +621 -0
  564. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view.rb +279 -0
  565. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +428 -0
  566. data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +428 -0
  567. data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
  568. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
  569. data/lib/purecloudplatformclientv2/models/nlu_domain_listing.rb +12 -12
  570. data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +32 -1
  571. data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +12 -12
  572. data/lib/purecloudplatformclientv2/models/nlu_feedback_listing.rb +12 -12
  573. data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
  574. data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
  575. data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
  576. data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
  577. data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
  578. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +41 -1
  579. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
  580. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +41 -1
  581. data/lib/purecloudplatformclientv2/models/o_auth_client_request.rb +44 -4
  582. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
  583. data/lib/purecloudplatformclientv2/models/observation_value.rb +70 -2
  584. data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +41 -1
  585. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
  586. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
  587. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
  588. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
  589. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
  590. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
  591. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
  592. data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +29 -4
  593. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
  594. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
  595. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
  596. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
  597. data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
  598. data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
  599. data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
  600. data/lib/purecloudplatformclientv2/models/presence_expand.rb +309 -0
  601. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
  602. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
  603. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
  604. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_after_call_work.rb +265 -0
  605. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
  606. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
  607. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
  608. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
  609. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
  610. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +51 -1
  611. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
  612. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
  613. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
  614. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_after_call_work.rb +265 -0
  615. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
  616. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
  617. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
  618. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
  619. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
  620. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +51 -1
  621. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
  622. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
  623. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
  624. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_after_call_work.rb +265 -0
  625. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
  626. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
  627. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
  628. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
  629. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
  630. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +51 -1
  631. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
  632. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
  633. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
  634. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
  635. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
  636. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
  637. data/lib/purecloudplatformclientv2/models/recording.rb +41 -1
  638. data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
  639. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
  640. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
  641. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
  642. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
  643. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
  644. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
  645. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +53 -1
  646. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +78 -1
  647. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +12 -12
  648. data/lib/purecloudplatformclientv2/models/response.rb +2 -2
  649. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
  650. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
  651. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
  652. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
  653. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
  654. data/lib/purecloudplatformclientv2/models/schedule_generation_message.rb +2 -2
  655. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
  656. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
  657. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
  658. data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +2 -2
  659. data/lib/purecloudplatformclientv2/models/scim_genesys_user_external_id.rb +229 -0
  660. data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
  661. data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
  662. data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +35 -7
  663. data/lib/purecloudplatformclientv2/models/scim_user_role.rb +1 -1
  664. data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +3 -3
  665. data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +3 -3
  666. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -2
  667. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
  668. data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +1 -1
  669. data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +12 -12
  670. data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +6 -6
  671. data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +2 -2
  672. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +4 -3
  673. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
  674. data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
  675. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
  676. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
  677. data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
  678. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
  679. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
  680. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
  681. data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +12 -12
  682. data/lib/purecloudplatformclientv2/models/sms_config.rb +269 -0
  683. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
  684. data/lib/purecloudplatformclientv2/models/sms_phone_number_ref.rb +232 -0
  685. data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
  686. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
  687. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
  688. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
  689. data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
  690. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
  691. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
  692. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
  693. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
  694. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
  695. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
  696. data/lib/purecloudplatformclientv2/models/transcript_url.rb +202 -0
  697. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
  698. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
  699. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
  700. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
  701. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
  702. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
  703. data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
  704. data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
  705. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
  706. data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +45 -5
  707. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
  708. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
  709. data/lib/purecloudplatformclientv2/models/user_app_entity_listing.rb +12 -12
  710. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
  711. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
  712. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
  713. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
  714. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
  715. data/lib/purecloudplatformclientv2/models/user_routing_language.rb +4 -4
  716. data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +1 -1
  717. data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +1 -1
  718. data/lib/purecloudplatformclientv2/models/user_search_request.rb +44 -4
  719. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
  720. data/lib/purecloudplatformclientv2/models/video.rb +30 -4
  721. data/lib/purecloudplatformclientv2/models/view_filter.rb +114 -4
  722. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
  723. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
  724. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
  725. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
  726. data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +30 -4
  727. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
  728. data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +4 -4
  729. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
  730. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
  731. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
  732. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
  733. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
  734. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
  735. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
  736. data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +228 -0
  737. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +27 -1
  738. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper.rb +258 -0
  739. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_purge_request_status_topic_historical_data_upload_purge_request_update.rb +215 -0
  740. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time.rb +276 -0
  741. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update.rb +390 -0
  742. data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +280 -0
  743. data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +12 -12
  744. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
  745. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
  746. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
  747. data/lib/purecloudplatformclientv2/version.rb +1 -1
  748. metadata +151 -3
@@ -12,8 +12,8 @@ title: DomainEntityListingQueryResult
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -12,8 +12,8 @@ title: DomainEntityListingSurveyForm
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -16,8 +16,8 @@ title: DomainOrganizationRole
16
16
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
17
17
  | **user_count** | **Integer** | | [optional] |
18
18
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
19
- | **base** | **BOOLEAN** | | [optional] |
20
19
  | **default** | **BOOLEAN** | | [optional] |
20
+ | **base** | **BOOLEAN** | | [optional] |
21
21
  | **self_uri** | **String** | The URI for this object | [optional] |
22
22
  {: class="table table-striped"}
23
23
 
@@ -16,8 +16,8 @@ title: DomainOrganizationRoleCreate
16
16
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
17
17
  | **user_count** | **Integer** | | [optional] |
18
18
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
19
- | **base** | **BOOLEAN** | | [optional] |
20
19
  | **default** | **BOOLEAN** | | [optional] |
20
+ | **base** | **BOOLEAN** | | [optional] |
21
21
  | **self_uri** | **String** | The URI for this object | [optional] |
22
22
  {: class="table table-striped"}
23
23
 
@@ -16,8 +16,8 @@ title: DomainOrganizationRoleUpdate
16
16
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
17
17
  | **user_count** | **Integer** | | [optional] |
18
18
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
19
- | **base** | **BOOLEAN** | | [optional] |
20
19
  | **default** | **BOOLEAN** | | [optional] |
20
+ | **base** | **BOOLEAN** | | [optional] |
21
21
  | **self_uri** | **String** | The URI for this object | [optional] |
22
22
  {: class="table table-striped"}
23
23
 
@@ -12,8 +12,8 @@ title: EdgeEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -19,6 +19,7 @@ title: EdgeGroup
19
19
  | **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
20
20
  | **created_by_app** | **String** | The application that created the resource. | [optional] |
21
21
  | **managed** | **BOOLEAN** | Is this edge group being managed remotely. | [optional] |
22
+ | **hybrid** | **BOOLEAN** | Is this edge group hybrid. | [optional] |
22
23
  | **edge_trunk_base_assignment** | [**TrunkBaseAssignment**](TrunkBaseAssignment.html) | A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication. | |
23
24
  | **phone_trunk_bases** | [**Array<TrunkBase>**](TrunkBase.html) | Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication. | |
24
25
  | **self_uri** | **String** | The URI for this object | [optional] |
@@ -12,8 +12,8 @@ title: EdgeGroupEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -12,8 +12,8 @@ title: EdgeLineEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: Education
3
+ ---
4
+ ## PureCloud::Education
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **school** | **String** | | [optional] |
11
+ | **field_of_study** | **String** | | [optional] |
12
+ | **notes** | **String** | Notes about education has a 2000 character limit | [optional] |
13
+ | **date_start** | **Date** | Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | [optional] |
14
+ | **date_end** | **Date** | Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -29,6 +29,7 @@ title: Email
29
29
  | **draft_attachments** | [**Array<Attachment>**](Attachment.html) | A list of uploaded attachments on the email draft. | [optional] |
30
30
  | **spam** | **BOOLEAN** | Indicates if the inbound email was marked as spam. | [optional] |
31
31
  | **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
32
+ | **after_call_work** | [**AfterCallWork**](AfterCallWork.html) | After-call work for the communication. | [optional] |
32
33
  {: class="table table-striped"}
33
34
 
34
35
 
@@ -12,8 +12,8 @@ title: EmailConversationEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -12,8 +12,8 @@ title: EmailMessageListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -12,8 +12,8 @@ title: EmergencyGroupListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -12,8 +12,8 @@ title: EncryptionKeyEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -9,7 +9,7 @@ title: EvaluationAggregationQuery
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
11
11
  | **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
12
- | **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
12
+ | **time_zone** | **String** | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
13
13
  | **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
14
14
  | **filter** | [**EvaluationAggregateQueryFilter**](EvaluationAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
15
15
  | **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
@@ -12,8 +12,8 @@ title: EvaluationEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -12,8 +12,8 @@ title: EvaluationFormEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -12,8 +12,8 @@ title: EvaluatorActivityEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -12,8 +12,8 @@ title: ExtensionEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -12,8 +12,8 @@ title: ExtensionPoolEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
- | **next_uri** | **String** | | [optional] |
16
15
  | **self_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
17
  | **last_uri** | **String** | | [optional] |
18
18
  | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
@@ -35,6 +35,10 @@ Method | Description
35
35
  [**get_externalcontacts_organizations_schemas**](ExternalContactsApi.html#get_externalcontacts_organizations_schemas) | Get a list of schemas.
36
36
  [**get_externalcontacts_relationship**](ExternalContactsApi.html#get_externalcontacts_relationship) | Fetch a relationship
37
37
  [**get_externalcontacts_reversewhitepageslookup**](ExternalContactsApi.html#get_externalcontacts_reversewhitepageslookup) | Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
38
+ [**get_externalcontacts_scan_contacts**](ExternalContactsApi.html#get_externalcontacts_scan_contacts) | Scan for external contacts using paging
39
+ [**get_externalcontacts_scan_notes**](ExternalContactsApi.html#get_externalcontacts_scan_notes) | Scan for notes using paging
40
+ [**get_externalcontacts_scan_organizations**](ExternalContactsApi.html#get_externalcontacts_scan_organizations) | Scan for external organizations using paging
41
+ [**get_externalcontacts_scan_relationships**](ExternalContactsApi.html#get_externalcontacts_scan_relationships) | Scan for relationships
38
42
  [**post_externalcontacts_contact_notes**](ExternalContactsApi.html#post_externalcontacts_contact_notes) | Create a note for an external contact
39
43
  [**post_externalcontacts_contacts**](ExternalContactsApi.html#post_externalcontacts_contacts) | Create an external contact
40
44
  [**post_externalcontacts_contacts_schemas**](ExternalContactsApi.html#post_externalcontacts_contacts_schemas) | Create a schema
@@ -45,7 +49,7 @@ Method | Description
45
49
  [**put_externalcontacts_contact**](ExternalContactsApi.html#put_externalcontacts_contact) | Update an external contact
46
50
  [**put_externalcontacts_contact_note**](ExternalContactsApi.html#put_externalcontacts_contact_note) | Update a note for an external contact
47
51
  [**put_externalcontacts_contacts_schema**](ExternalContactsApi.html#put_externalcontacts_contacts_schema) | Update a schema
48
- [**put_externalcontacts_conversation**](ExternalContactsApi.html#put_externalcontacts_conversation) | Associate an external contact with a conversation
52
+ [**put_externalcontacts_conversation**](ExternalContactsApi.html#put_externalcontacts_conversation) | Associate/disassociate an external contact with a conversation
49
53
  [**put_externalcontacts_organization**](ExternalContactsApi.html#put_externalcontacts_organization) | Update an external organization
50
54
  [**put_externalcontacts_organization_note**](ExternalContactsApi.html#put_externalcontacts_organization_note) | Update a note for an external organization
51
55
  [**put_externalcontacts_organization_trustor_trustor_id**](ExternalContactsApi.html#put_externalcontacts_organization_trustor_trustor_id) | Links a Trustor with an External Organization
@@ -1907,6 +1911,278 @@ Name | Type | Description | Notes
1907
1911
 
1908
1912
 
1909
1913
 
1914
+ <a name="get_externalcontacts_scan_contacts"></a>
1915
+
1916
+ ## [**CursorContactListing**](CursorContactListing.html) get_externalcontacts_scan_contacts(opts)
1917
+
1918
+
1919
+
1920
+ Scan for external contacts using paging
1921
+
1922
+
1923
+
1924
+ Wraps GET /api/v2/externalcontacts/scan/contacts
1925
+
1926
+ Requires ANY permissions:
1927
+
1928
+ * externalContacts:contact:view
1929
+
1930
+
1931
+ ### Example
1932
+ ```{"language":"ruby"}
1933
+ # load the gem
1934
+ require 'purecloudplatformclientv2'
1935
+ # setup authorization
1936
+ @secret = ENV['PURECLOUD_SECRET']
1937
+ @id = ENV['PURECLOUD_CLIENT_ID']
1938
+ environment = "mypurecloud.com"
1939
+
1940
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1941
+
1942
+ PureCloud.configure do |config|
1943
+ config.access_token = @authToken
1944
+ end
1945
+
1946
+ api_instance = PureCloud::ExternalContactsApi.new
1947
+
1948
+ opts = {
1949
+ limit: 56, # Integer | The number of contacts per page; must be between 10 and 200, default is 100)
1950
+ cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
1951
+ }
1952
+
1953
+ begin
1954
+ #Scan for external contacts using paging
1955
+ result = api_instance.get_externalcontacts_scan_contacts(opts)
1956
+ p result
1957
+ rescue PureCloud::ApiError => e
1958
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_contacts: #{e}"
1959
+ end
1960
+ ```
1961
+
1962
+ ### Parameters
1963
+
1964
+ Name | Type | Description | Notes
1965
+ ------------- | ------------- | ------------- | -------------
1966
+ **limit** | **Integer**| The number of contacts per page; must be between 10 and 200, default is 100) | [optional] |
1967
+ **cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional] |
1968
+ {: class="table table-striped"}
1969
+
1970
+
1971
+ ### Return type
1972
+
1973
+ [**CursorContactListing**](CursorContactListing.html)
1974
+
1975
+ ### HTTP request headers
1976
+
1977
+ - **Content-Type**: application/json
1978
+ - **Accept**: application/json
1979
+
1980
+
1981
+
1982
+ <a name="get_externalcontacts_scan_notes"></a>
1983
+
1984
+ ## [**CursorNoteListing**](CursorNoteListing.html) get_externalcontacts_scan_notes(opts)
1985
+
1986
+
1987
+
1988
+ Scan for notes using paging
1989
+
1990
+
1991
+
1992
+ Wraps GET /api/v2/externalcontacts/scan/notes
1993
+
1994
+ Requires ANY permissions:
1995
+
1996
+ * externalContacts:contact:view
1997
+
1998
+
1999
+ ### Example
2000
+ ```{"language":"ruby"}
2001
+ # load the gem
2002
+ require 'purecloudplatformclientv2'
2003
+ # setup authorization
2004
+ @secret = ENV['PURECLOUD_SECRET']
2005
+ @id = ENV['PURECLOUD_CLIENT_ID']
2006
+ environment = "mypurecloud.com"
2007
+
2008
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2009
+
2010
+ PureCloud.configure do |config|
2011
+ config.access_token = @authToken
2012
+ end
2013
+
2014
+ api_instance = PureCloud::ExternalContactsApi.new
2015
+
2016
+ opts = {
2017
+ limit: 56, # Integer | The number of notes per page; must be between 10 and 200, default is 100)
2018
+ cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
2019
+ }
2020
+
2021
+ begin
2022
+ #Scan for notes using paging
2023
+ result = api_instance.get_externalcontacts_scan_notes(opts)
2024
+ p result
2025
+ rescue PureCloud::ApiError => e
2026
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_notes: #{e}"
2027
+ end
2028
+ ```
2029
+
2030
+ ### Parameters
2031
+
2032
+ Name | Type | Description | Notes
2033
+ ------------- | ------------- | ------------- | -------------
2034
+ **limit** | **Integer**| The number of notes per page; must be between 10 and 200, default is 100) | [optional] |
2035
+ **cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional] |
2036
+ {: class="table table-striped"}
2037
+
2038
+
2039
+ ### Return type
2040
+
2041
+ [**CursorNoteListing**](CursorNoteListing.html)
2042
+
2043
+ ### HTTP request headers
2044
+
2045
+ - **Content-Type**: application/json
2046
+ - **Accept**: application/json
2047
+
2048
+
2049
+
2050
+ <a name="get_externalcontacts_scan_organizations"></a>
2051
+
2052
+ ## [**CursorOrganizationListing**](CursorOrganizationListing.html) get_externalcontacts_scan_organizations(opts)
2053
+
2054
+
2055
+
2056
+ Scan for external organizations using paging
2057
+
2058
+
2059
+
2060
+ Wraps GET /api/v2/externalcontacts/scan/organizations
2061
+
2062
+ Requires ANY permissions:
2063
+
2064
+ * externalContacts:externalOrganization:view
2065
+
2066
+
2067
+ ### Example
2068
+ ```{"language":"ruby"}
2069
+ # load the gem
2070
+ require 'purecloudplatformclientv2'
2071
+ # setup authorization
2072
+ @secret = ENV['PURECLOUD_SECRET']
2073
+ @id = ENV['PURECLOUD_CLIENT_ID']
2074
+ environment = "mypurecloud.com"
2075
+
2076
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2077
+
2078
+ PureCloud.configure do |config|
2079
+ config.access_token = @authToken
2080
+ end
2081
+
2082
+ api_instance = PureCloud::ExternalContactsApi.new
2083
+
2084
+ opts = {
2085
+ limit: 56, # Integer | The number of organizations per page; must be between 10 and 200, default is 100)
2086
+ cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
2087
+ }
2088
+
2089
+ begin
2090
+ #Scan for external organizations using paging
2091
+ result = api_instance.get_externalcontacts_scan_organizations(opts)
2092
+ p result
2093
+ rescue PureCloud::ApiError => e
2094
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_organizations: #{e}"
2095
+ end
2096
+ ```
2097
+
2098
+ ### Parameters
2099
+
2100
+ Name | Type | Description | Notes
2101
+ ------------- | ------------- | ------------- | -------------
2102
+ **limit** | **Integer**| The number of organizations per page; must be between 10 and 200, default is 100) | [optional] |
2103
+ **cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional] |
2104
+ {: class="table table-striped"}
2105
+
2106
+
2107
+ ### Return type
2108
+
2109
+ [**CursorOrganizationListing**](CursorOrganizationListing.html)
2110
+
2111
+ ### HTTP request headers
2112
+
2113
+ - **Content-Type**: application/json
2114
+ - **Accept**: application/json
2115
+
2116
+
2117
+
2118
+ <a name="get_externalcontacts_scan_relationships"></a>
2119
+
2120
+ ## [**CursorRelationshipListing**](CursorRelationshipListing.html) get_externalcontacts_scan_relationships(opts)
2121
+
2122
+
2123
+
2124
+ Scan for relationships
2125
+
2126
+
2127
+
2128
+ Wraps GET /api/v2/externalcontacts/scan/relationships
2129
+
2130
+ Requires ANY permissions:
2131
+
2132
+ * externalContacts:contact:view
2133
+
2134
+
2135
+ ### Example
2136
+ ```{"language":"ruby"}
2137
+ # load the gem
2138
+ require 'purecloudplatformclientv2'
2139
+ # setup authorization
2140
+ @secret = ENV['PURECLOUD_SECRET']
2141
+ @id = ENV['PURECLOUD_CLIENT_ID']
2142
+ environment = "mypurecloud.com"
2143
+
2144
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2145
+
2146
+ PureCloud.configure do |config|
2147
+ config.access_token = @authToken
2148
+ end
2149
+
2150
+ api_instance = PureCloud::ExternalContactsApi.new
2151
+
2152
+ opts = {
2153
+ limit: 56, # Integer | The number of relationships per page; must be between 10 and 200, default is 100)
2154
+ cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
2155
+ }
2156
+
2157
+ begin
2158
+ #Scan for relationships
2159
+ result = api_instance.get_externalcontacts_scan_relationships(opts)
2160
+ p result
2161
+ rescue PureCloud::ApiError => e
2162
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_relationships: #{e}"
2163
+ end
2164
+ ```
2165
+
2166
+ ### Parameters
2167
+
2168
+ Name | Type | Description | Notes
2169
+ ------------- | ------------- | ------------- | -------------
2170
+ **limit** | **Integer**| The number of relationships per page; must be between 10 and 200, default is 100) | [optional] |
2171
+ **cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional] |
2172
+ {: class="table table-striped"}
2173
+
2174
+
2175
+ ### Return type
2176
+
2177
+ [**CursorRelationshipListing**](CursorRelationshipListing.html)
2178
+
2179
+ ### HTTP request headers
2180
+
2181
+ - **Content-Type**: application/json
2182
+ - **Accept**: application/json
2183
+
2184
+
2185
+
1910
2186
  <a name="post_externalcontacts_contact_notes"></a>
1911
2187
 
1912
2188
  ## [**Note**](Note.html) post_externalcontacts_contact_notes(contact_id, body)
@@ -2579,13 +2855,13 @@ Name | Type | Description | Notes
2579
2855
 
2580
2856
  <a name="put_externalcontacts_conversation"></a>
2581
2857
 
2582
- ## put_externalcontacts_conversation(conversation_id, body)
2858
+ ## put_externalcontacts_conversation(body, conversation_id)
2583
2859
 
2584
2860
 
2585
2861
 
2586
- Associate an external contact with a conversation
2587
-
2862
+ Associate/disassociate an external contact with a conversation
2588
2863
 
2864
+ To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.
2589
2865
 
2590
2866
  Wraps PUT /api/v2/externalcontacts/conversations/{conversationId}
2591
2867
 
@@ -2611,14 +2887,14 @@ end
2611
2887
 
2612
2888
  api_instance = PureCloud::ExternalContactsApi.new
2613
2889
 
2614
- conversation_id = "conversation_id_example" # String | Conversation ID
2615
-
2616
2890
  body = PureCloud::ConversationAssociation.new # ConversationAssociation | ConversationAssociation
2617
2891
 
2892
+ conversation_id = "conversation_id_example" # String | Conversation ID
2893
+
2618
2894
 
2619
2895
  begin
2620
- #Associate an external contact with a conversation
2621
- api_instance.put_externalcontacts_conversation(conversation_id, body)
2896
+ #Associate/disassociate an external contact with a conversation
2897
+ api_instance.put_externalcontacts_conversation(body, conversation_id)
2622
2898
  rescue PureCloud::ApiError => e
2623
2899
  puts "Exception when calling ExternalContactsApi->put_externalcontacts_conversation: #{e}"
2624
2900
  end
@@ -2628,8 +2904,8 @@ end
2628
2904
 
2629
2905
  Name | Type | Description | Notes
2630
2906
  ------------- | ------------- | ------------- | -------------
2631
- **conversation_id** | **String**| Conversation ID | |
2632
2907
  **body** | [**ConversationAssociation**](ConversationAssociation.html)| ConversationAssociation | |
2908
+ **conversation_id** | **String**| Conversation ID | |
2633
2909
  {: class="table table-striped"}
2634
2910
 
2635
2911