purecloudplatformclientv2 2.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1825) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +56 -0
  3. data/docs/ADFS.md +20 -0
  4. data/docs/Actions.md +13 -0
  5. data/docs/ActivityCode.md +20 -0
  6. data/docs/ActivityCodeContainer.md +13 -0
  7. data/docs/AcwSettings.md +14 -0
  8. data/docs/Address.md +17 -0
  9. data/docs/AddressableEntityUser.md +14 -0
  10. data/docs/AddressableLicenseDefinition.md +14 -0
  11. data/docs/Adjacents.md +15 -0
  12. data/docs/Agent.md +13 -0
  13. data/docs/AgentActivity.md +19 -0
  14. data/docs/AgentActivityEntityListing.md +22 -0
  15. data/docs/AgentEvaluatorActivity.md +19 -0
  16. data/docs/AggregateDataContainer.md +14 -0
  17. data/docs/AggregateMetricData.md +15 -0
  18. data/docs/AggregateQueryResponse.md +13 -0
  19. data/docs/AggregateViewData.md +14 -0
  20. data/docs/AggregationQuery.md +20 -0
  21. data/docs/AggregationRange.md +14 -0
  22. data/docs/AggregationResult.md +17 -0
  23. data/docs/AggregationResultEntry.md +16 -0
  24. data/docs/AlertingApi.md +2129 -0
  25. data/docs/AnalyticsApi.md +1347 -0
  26. data/docs/AnalyticsConversation.md +17 -0
  27. data/docs/AnalyticsConversationQueryResponse.md +14 -0
  28. data/docs/AnalyticsConversationSegment.md +36 -0
  29. data/docs/AnalyticsEvaluation.md +22 -0
  30. data/docs/AnalyticsParticipant.md +19 -0
  31. data/docs/AnalyticsProperty.md +15 -0
  32. data/docs/AnalyticsQueryAggregation.md +17 -0
  33. data/docs/AnalyticsQueryClause.md +14 -0
  34. data/docs/AnalyticsQueryFilter.md +15 -0
  35. data/docs/AnalyticsQueryPredicate.md +20 -0
  36. data/docs/AnalyticsRoutingStatusRecord.md +16 -0
  37. data/docs/AnalyticsSession.md +44 -0
  38. data/docs/AnalyticsUserDetail.md +15 -0
  39. data/docs/AnalyticsUserDetailsQueryResponse.md +14 -0
  40. data/docs/AnalyticsUserPresenceRecord.md +17 -0
  41. data/docs/AnalyticsView.md +16 -0
  42. data/docs/Annotation.md +30 -0
  43. data/docs/AnswerOption.md +15 -0
  44. data/docs/ArchitectApi.md +2924 -0
  45. data/docs/ArchiveRetention.md +14 -0
  46. data/docs/Attachment.md +17 -0
  47. data/docs/AttemptLimits.md +22 -0
  48. data/docs/AttemptLimitsEntityListing.md +22 -0
  49. data/docs/AttemptLimitsNotification.md +24 -0
  50. data/docs/AttemptLimitsNotificationRecallEntries.md +15 -0
  51. data/docs/AttemptLimitsNotificationRecallEntry.md +15 -0
  52. data/docs/Attribute.md +21 -0
  53. data/docs/AttributeEntityListing.md +22 -0
  54. data/docs/AttributeFilterItem.md +15 -0
  55. data/docs/AttributeQueryRequest.md +15 -0
  56. data/docs/AttributesApi.md +377 -0
  57. data/docs/AuditChange.md +16 -0
  58. data/docs/AuditEntity.md +16 -0
  59. data/docs/AuditEntityReference.md +17 -0
  60. data/docs/AuditFacet.md +14 -0
  61. data/docs/AuditFilter.md +16 -0
  62. data/docs/AuditMessage.md +28 -0
  63. data/docs/AuditSearchResult.md +18 -0
  64. data/docs/AuditUser.md +15 -0
  65. data/docs/AuthorizationApi.md +1067 -0
  66. data/docs/AvailableLanguageList.md +13 -0
  67. data/docs/AvailableTopic.md +16 -0
  68. data/docs/AvailableTopicEntityListing.md +13 -0
  69. data/docs/AvailableTranslations.md +14 -0
  70. data/docs/Bullseye.md +13 -0
  71. data/docs/Calibration.md +28 -0
  72. data/docs/CalibrationAssignment.md +16 -0
  73. data/docs/CalibrationCreate.md +28 -0
  74. data/docs/CalibrationEntityListing.md +22 -0
  75. data/docs/Call.md +31 -0
  76. data/docs/CallBasic.md +31 -0
  77. data/docs/CallCommand.md +13 -0
  78. data/docs/CallConversation.md +18 -0
  79. data/docs/CallConversationEntityListing.md +22 -0
  80. data/docs/CallConversationNotification.md +17 -0
  81. data/docs/CallConversationNotificationCallMediaParticipant.md +48 -0
  82. data/docs/CallConversationNotificationDetail.md +16 -0
  83. data/docs/CallConversationNotificationErrorBody.md +22 -0
  84. data/docs/CallConversationNotificationErrorInfo.md +22 -0
  85. data/docs/CallConversationNotificationFaxStatus.md +20 -0
  86. data/docs/CallConversationNotificationParticipants.md +48 -0
  87. data/docs/CallConversationNotificationUriReference.md +14 -0
  88. data/docs/CallConversationNotificationWrapup.md +18 -0
  89. data/docs/CallForwarding.md +19 -0
  90. data/docs/CallMediaParticipant.md +48 -0
  91. data/docs/CallMediaPolicy.md +14 -0
  92. data/docs/CallMediaPolicyConditions.md +19 -0
  93. data/docs/CallRecord.md +14 -0
  94. data/docs/CallableContactsDiagnostic.md +16 -0
  95. data/docs/CallableTime.md +14 -0
  96. data/docs/CallableTimeSet.md +19 -0
  97. data/docs/CallableTimeSetEntityListing.md +22 -0
  98. data/docs/CallableTimeSetNotification.md +19 -0
  99. data/docs/CallableTimeSetNotificationCallableTime.md +15 -0
  100. data/docs/CallableTimeSetNotificationCallableTimes.md +15 -0
  101. data/docs/CallableTimeSetNotificationTimeSlot.md +16 -0
  102. data/docs/CallableTimeSetNotificationTimeSlots.md +16 -0
  103. data/docs/Callback.md +30 -0
  104. data/docs/CallbackBasic.md +30 -0
  105. data/docs/CallbackConversation.md +17 -0
  106. data/docs/CallbackConversationEntityListing.md +22 -0
  107. data/docs/CallbackConversationNotification.md +16 -0
  108. data/docs/CallbackConversationNotificationCallbackMediaParticipant.md +44 -0
  109. data/docs/CallbackConversationNotificationDetail.md +16 -0
  110. data/docs/CallbackConversationNotificationDialerPreview.md +18 -0
  111. data/docs/CallbackConversationNotificationErrorBody.md +22 -0
  112. data/docs/CallbackConversationNotificationErrorInfo.md +22 -0
  113. data/docs/CallbackConversationNotificationErrorInfoDetails.md +16 -0
  114. data/docs/CallbackConversationNotificationParticipants.md +44 -0
  115. data/docs/CallbackConversationNotificationPhoneNumberColumn.md +15 -0
  116. data/docs/CallbackConversationNotificationUriReference.md +14 -0
  117. data/docs/CallbackConversationNotificationWrapup.md +18 -0
  118. data/docs/CallbackIdentifier.md +14 -0
  119. data/docs/CallbackMediaParticipant.md +44 -0
  120. data/docs/Campaign.md +41 -0
  121. data/docs/CampaignDiagnostics.md +16 -0
  122. data/docs/CampaignEntityListing.md +22 -0
  123. data/docs/CampaignInteraction.md +33 -0
  124. data/docs/CampaignInteractions.md +18 -0
  125. data/docs/CampaignNotification.md +43 -0
  126. data/docs/CampaignNotificationContactSort.md +16 -0
  127. data/docs/CampaignNotificationErrors.md +15 -0
  128. data/docs/CampaignNotificationPhoneColumn.md +15 -0
  129. data/docs/CampaignNotificationPhoneColumns.md +15 -0
  130. data/docs/CampaignNotificationRestErrorDetail.md +15 -0
  131. data/docs/CampaignNotificationUriReference.md +14 -0
  132. data/docs/CampaignProgress.md +17 -0
  133. data/docs/CampaignProgressNotification.md +17 -0
  134. data/docs/CampaignProgressNotificationUriReference.md +14 -0
  135. data/docs/CampaignRule.md +23 -0
  136. data/docs/CampaignRuleAction.md +16 -0
  137. data/docs/CampaignRuleActionEntities.md +15 -0
  138. data/docs/CampaignRuleCondition.md +15 -0
  139. data/docs/CampaignRuleEntities.md +14 -0
  140. data/docs/CampaignRuleEntityListing.md +22 -0
  141. data/docs/CampaignRuleNotification.md +23 -0
  142. data/docs/CampaignRuleNotificationCampaignRuleAction.md +17 -0
  143. data/docs/CampaignRuleNotificationCampaignRuleActionEntities.md +16 -0
  144. data/docs/CampaignRuleNotificationCampaignRuleActions.md +17 -0
  145. data/docs/CampaignRuleNotificationCampaignRuleCondition.md +16 -0
  146. data/docs/CampaignRuleNotificationCampaignRuleConditions.md +16 -0
  147. data/docs/CampaignRuleNotificationCampaignRuleEntities.md +14 -0
  148. data/docs/CampaignRuleNotificationUriReference.md +14 -0
  149. data/docs/CampaignRuleParameters.md +16 -0
  150. data/docs/CampaignSchedule.md +21 -0
  151. data/docs/CampaignScheduleNotification.md +21 -0
  152. data/docs/CampaignScheduleNotificationIntervals.md +15 -0
  153. data/docs/CampaignScheduleNotificationScheduleInterval.md +15 -0
  154. data/docs/CampaignScheduleNotificationUriReference.md +14 -0
  155. data/docs/CampaignSequence.md +23 -0
  156. data/docs/CampaignSequenceEntityListing.md +22 -0
  157. data/docs/CampaignSequenceNotification.md +23 -0
  158. data/docs/CampaignSequenceNotificationUriReference.md +14 -0
  159. data/docs/CampaignStats.md +18 -0
  160. data/docs/CampaignTimeSlot.md +15 -0
  161. data/docs/Certificate.md +13 -0
  162. data/docs/CertificateAuthorityEntityListing.md +22 -0
  163. data/docs/CertificateDetails.md +19 -0
  164. data/docs/Change.md +16 -0
  165. data/docs/Channel.md +14 -0
  166. data/docs/ChannelEntityListing.md +13 -0
  167. data/docs/ChannelTopic.md +14 -0
  168. data/docs/ChannelTopicEntityListing.md +13 -0
  169. data/docs/Chat.md +13 -0
  170. data/docs/ChatConversation.md +17 -0
  171. data/docs/ChatConversationEntityListing.md +22 -0
  172. data/docs/ChatConversationNotification.md +16 -0
  173. data/docs/ChatConversationNotificationChatMediaParticipant.md +38 -0
  174. data/docs/ChatConversationNotificationDetail.md +16 -0
  175. data/docs/ChatConversationNotificationErrorBody.md +22 -0
  176. data/docs/ChatConversationNotificationErrorInfo.md +22 -0
  177. data/docs/ChatConversationNotificationParticipants.md +38 -0
  178. data/docs/ChatConversationNotificationUriReference.md +14 -0
  179. data/docs/ChatConversationNotificationWrapup.md +18 -0
  180. data/docs/ChatMediaParticipant.md +38 -0
  181. data/docs/ChatMediaPolicy.md +14 -0
  182. data/docs/ChatMediaPolicyConditions.md +18 -0
  183. data/docs/ChatMessage.md +21 -0
  184. data/docs/ChatMessageUser.md +17 -0
  185. data/docs/CobrowseConversation.md +17 -0
  186. data/docs/CobrowseConversationEntityListing.md +22 -0
  187. data/docs/CobrowseConversationNotification.md +16 -0
  188. data/docs/CobrowseConversationNotificationCobrowseMediaParticipant.md +42 -0
  189. data/docs/CobrowseConversationNotificationDetail.md +16 -0
  190. data/docs/CobrowseConversationNotificationErrorBody.md +22 -0
  191. data/docs/CobrowseConversationNotificationErrorInfo.md +22 -0
  192. data/docs/CobrowseConversationNotificationParticipants.md +42 -0
  193. data/docs/CobrowseConversationNotificationUriReference.md +14 -0
  194. data/docs/CobrowseConversationNotificationWrapup.md +18 -0
  195. data/docs/CobrowseMediaParticipant.md +42 -0
  196. data/docs/Cobrowsesession.md +25 -0
  197. data/docs/CommandStatus.md +20 -0
  198. data/docs/CommandStatusEntityListing.md +22 -0
  199. data/docs/Condition.md +19 -0
  200. data/docs/ConnectRate.md +15 -0
  201. data/docs/ConsultTransfer.md +14 -0
  202. data/docs/ConsultTransferResponse.md +13 -0
  203. data/docs/ConsultTransferUpdate.md +13 -0
  204. data/docs/ConsumedResourcesEntityListing.md +22 -0
  205. data/docs/ConsumingResourcesEntityListing.md +22 -0
  206. data/docs/Contact.md +16 -0
  207. data/docs/ContactAddress.md +18 -0
  208. data/docs/ContactCallbackRequest.md +17 -0
  209. data/docs/ContactList.md +25 -0
  210. data/docs/ContactListEntityListing.md +22 -0
  211. data/docs/ContactListNotification.md +25 -0
  212. data/docs/ContactListNotificationContactPhoneNumberColumn.md +16 -0
  213. data/docs/ContactListNotificationImportStatus.md +18 -0
  214. data/docs/ContactListNotificationPhoneColumns.md +16 -0
  215. data/docs/ContactListNotificationUriReference.md +14 -0
  216. data/docs/ContactListing.md +22 -0
  217. data/docs/ContactPhoneNumberColumn.md +15 -0
  218. data/docs/ContactSort.md +15 -0
  219. data/docs/ContentAttributeFilterItem.md +15 -0
  220. data/docs/ContentFacetFilterItem.md +16 -0
  221. data/docs/ContentFilterItem.md +16 -0
  222. data/docs/ContentManagementApi.md +2470 -0
  223. data/docs/ContentQueryRequest.md +20 -0
  224. data/docs/ContentSortItem.md +14 -0
  225. data/docs/Conversation.md +23 -0
  226. data/docs/ConversationAssociation.md +15 -0
  227. data/docs/ConversationBasic.md +18 -0
  228. data/docs/ConversationChat.md +24 -0
  229. data/docs/ConversationEntityListing.md +22 -0
  230. data/docs/ConversationNotification.md +17 -0
  231. data/docs/ConversationNotificationAddress.md +18 -0
  232. data/docs/ConversationNotificationCall.md +32 -0
  233. data/docs/ConversationNotificationCallback.md +30 -0
  234. data/docs/ConversationNotificationCallbacks.md +30 -0
  235. data/docs/ConversationNotificationCalls.md +32 -0
  236. data/docs/ConversationNotificationChat.md +22 -0
  237. data/docs/ConversationNotificationChats.md +22 -0
  238. data/docs/ConversationNotificationCobrowse.md +26 -0
  239. data/docs/ConversationNotificationCobrowsesessions.md +26 -0
  240. data/docs/ConversationNotificationDialerPreview.md +18 -0
  241. data/docs/ConversationNotificationDisconnectReason.md +15 -0
  242. data/docs/ConversationNotificationDisconnectReasons.md +15 -0
  243. data/docs/ConversationNotificationEmail.md +24 -0
  244. data/docs/ConversationNotificationEmails.md +24 -0
  245. data/docs/ConversationNotificationErrorDetails.md +20 -0
  246. data/docs/ConversationNotificationErrorInfo.md +20 -0
  247. data/docs/ConversationNotificationFaxStatus.md +20 -0
  248. data/docs/ConversationNotificationParticipant.md +40 -0
  249. data/docs/ConversationNotificationParticipants.md +40 -0
  250. data/docs/ConversationNotificationPhoneNumberColumn.md +15 -0
  251. data/docs/ConversationNotificationScreenshare.md +22 -0
  252. data/docs/ConversationNotificationScreenshares.md +22 -0
  253. data/docs/ConversationNotificationSelf.md +18 -0
  254. data/docs/ConversationNotificationSocialExpression.md +26 -0
  255. data/docs/ConversationNotificationSocialExpressions.md +26 -0
  256. data/docs/ConversationNotificationVideo.md +24 -0
  257. data/docs/ConversationNotificationVideos.md +24 -0
  258. data/docs/ConversationNotificationWrapup.md +18 -0
  259. data/docs/ConversationQuery.md +20 -0
  260. data/docs/ConversationsApi.md +4864 -0
  261. data/docs/CopyVoicemailMessage.md +15 -0
  262. data/docs/CoverSheet.md +14 -0
  263. data/docs/CreateCallRequest.md +21 -0
  264. data/docs/CreateCallResponse.md +15 -0
  265. data/docs/CreateCallbackCommand.md +20 -0
  266. data/docs/CreateCallbackResponse.md +14 -0
  267. data/docs/CreateEmailRequest.md +24 -0
  268. data/docs/CreateQueueRequest.md +35 -0
  269. data/docs/CreateShareRequest.md +17 -0
  270. data/docs/CreateShareRequestMember.md +14 -0
  271. data/docs/CreateShareResponse.md +23 -0
  272. data/docs/CreateUser.md +18 -0
  273. data/docs/CreateWebChatRequest.md +19 -0
  274. data/docs/CurrentUserScheduleRequestBody.md +14 -0
  275. data/docs/CustomerInteractionCenter.md +19 -0
  276. data/docs/DID.md +28 -0
  277. data/docs/DIDEntityListing.md +22 -0
  278. data/docs/DIDPool.md +28 -0
  279. data/docs/DIDPoolEntityListing.md +22 -0
  280. data/docs/DefaultGreetingList.md +22 -0
  281. data/docs/DeleteRetention.md +13 -0
  282. data/docs/Dependency.md +19 -0
  283. data/docs/DependencyObject.md +21 -0
  284. data/docs/DependencyObjectEntityListing.md +22 -0
  285. data/docs/DependencyStatus.md +21 -0
  286. data/docs/DependencyType.md +16 -0
  287. data/docs/DependencyTypeEntityListing.md +22 -0
  288. data/docs/Destination.md +16 -0
  289. data/docs/Detail.md +16 -0
  290. data/docs/DialerAction.md +16 -0
  291. data/docs/DialerAuditRequest.md +16 -0
  292. data/docs/DialerContact.md +20 -0
  293. data/docs/DialerPreview.md +17 -0
  294. data/docs/DialerRule.md +18 -0
  295. data/docs/DigitLength.md +14 -0
  296. data/docs/DisconnectReason.md +15 -0
  297. data/docs/DncList.md +24 -0
  298. data/docs/DncListCreate.md +24 -0
  299. data/docs/DncListEntityListing.md +22 -0
  300. data/docs/DncListNotification.md +24 -0
  301. data/docs/DncListNotificationImportStatus.md +18 -0
  302. data/docs/Document.md +43 -0
  303. data/docs/DocumentAttribute.md +14 -0
  304. data/docs/DocumentAudit.md +28 -0
  305. data/docs/DocumentAuditEntityListing.md +22 -0
  306. data/docs/DocumentDataV2Notification.md +26 -0
  307. data/docs/DocumentDataV2NotificationCreatedBy.md +14 -0
  308. data/docs/DocumentDataV2NotificationLockData.md +15 -0
  309. data/docs/DocumentDataV2NotificationLockInfo.md +15 -0
  310. data/docs/DocumentDataV2NotificationUserData.md +14 -0
  311. data/docs/DocumentDataV2NotificationWorkspace.md +13 -0
  312. data/docs/DocumentDataV2NotificationWorkspaceData.md +13 -0
  313. data/docs/DocumentEntityListing.md +22 -0
  314. data/docs/DocumentThumbnail.md +16 -0
  315. data/docs/DocumentUpdate.md +21 -0
  316. data/docs/DocumentUpload.md +16 -0
  317. data/docs/DocumentationResult.md +32 -0
  318. data/docs/DocumentationSearchCriteria.md +20 -0
  319. data/docs/DocumentationSearchRequest.md +17 -0
  320. data/docs/DocumentationSearchResponse.md +21 -0
  321. data/docs/DomainCapabilities.md +18 -0
  322. data/docs/DomainCertificateAuthority.md +28 -0
  323. data/docs/DomainEdgeSoftwareUpdateDto.md +22 -0
  324. data/docs/DomainEdgeSoftwareVersionDto.md +20 -0
  325. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +22 -0
  326. data/docs/DomainEntity.md +15 -0
  327. data/docs/DomainEntityListing.md +22 -0
  328. data/docs/DomainEntityListingEvaluationForm.md +22 -0
  329. data/docs/DomainEntityListingQueryResult.md +22 -0
  330. data/docs/DomainLogicalInterface.md +45 -0
  331. data/docs/DomainNetworkAddress.md +16 -0
  332. data/docs/DomainNetworkCommandResponse.md +16 -0
  333. data/docs/DomainNetworkRoute.md +17 -0
  334. data/docs/DomainOrgRoleDifference.md +17 -0
  335. data/docs/DomainOrganizationProduct.md +13 -0
  336. data/docs/DomainOrganizationRole.md +23 -0
  337. data/docs/DomainOrganizationRoleCreate.md +23 -0
  338. data/docs/DomainOrganizationRoleUpdate.md +23 -0
  339. data/docs/DomainPermission.md +17 -0
  340. data/docs/DomainPermissionCollection.md +17 -0
  341. data/docs/DomainPermissionPolicy.md +20 -0
  342. data/docs/DomainPhysicalCapabilities.md +14 -0
  343. data/docs/DomainPhysicalInterface.md +29 -0
  344. data/docs/DomainResourceConditionNode.md +17 -0
  345. data/docs/DomainResourceConditionValue.md +16 -0
  346. data/docs/DomainRole.md +14 -0
  347. data/docs/DomainSchemaReference.md +24 -0
  348. data/docs/DownloadResponse.md +15 -0
  349. data/docs/DurationCondition.md +15 -0
  350. data/docs/Edge.md +50 -0
  351. data/docs/EdgeAutoUpdateConfig.md +16 -0
  352. data/docs/EdgeEntityListing.md +22 -0
  353. data/docs/EdgeGroup.md +27 -0
  354. data/docs/EdgeGroupEntityListing.md +22 -0
  355. data/docs/EdgeInterface.md +20 -0
  356. data/docs/EdgeLine.md +32 -0
  357. data/docs/EdgeLineEntityListing.md +22 -0
  358. data/docs/EdgeLogsJob.md +25 -0
  359. data/docs/EdgeLogsJobFile.md +30 -0
  360. data/docs/EdgeLogsJobRequest.md +15 -0
  361. data/docs/EdgeLogsJobResponse.md +24 -0
  362. data/docs/EdgeLogsJobUploadRequest.md +13 -0
  363. data/docs/EdgeRebootParameters.md +13 -0
  364. data/docs/EdgeServiceStateRequest.md +14 -0
  365. data/docs/EdgeTrunkBase.md +27 -0
  366. data/docs/EdgeVersionInformation.md +13 -0
  367. data/docs/EdgeVersionReport.md +14 -0
  368. data/docs/Email.md +26 -0
  369. data/docs/EmailAddress.md +14 -0
  370. data/docs/EmailAttachment.md +17 -0
  371. data/docs/EmailConversation.md +17 -0
  372. data/docs/EmailConversationEntityListing.md +22 -0
  373. data/docs/EmailConversationNotification.md +16 -0
  374. data/docs/EmailConversationNotificationDetail.md +16 -0
  375. data/docs/EmailConversationNotificationEmailMediaParticipant.md +39 -0
  376. data/docs/EmailConversationNotificationErrorBody.md +22 -0
  377. data/docs/EmailConversationNotificationErrorInfo.md +22 -0
  378. data/docs/EmailConversationNotificationParticipants.md +39 -0
  379. data/docs/EmailConversationNotificationUriReference.md +14 -0
  380. data/docs/EmailConversationNotificationWrapup.md +18 -0
  381. data/docs/EmailMediaParticipant.md +39 -0
  382. data/docs/EmailMediaPolicy.md +14 -0
  383. data/docs/EmailMediaPolicyConditions.md +17 -0
  384. data/docs/EmailMessage.md +24 -0
  385. data/docs/EmailMessageListing.md +22 -0
  386. data/docs/EmailSetup.md +13 -0
  387. data/docs/Empty.md +12 -0
  388. data/docs/EncryptionKey.md +18 -0
  389. data/docs/EncryptionKeyEntityListing.md +22 -0
  390. data/docs/Endpoint.md +30 -0
  391. data/docs/EndpointEntityListing.md +22 -0
  392. data/docs/Entry.md +14 -0
  393. data/docs/ErrorBody.md +22 -0
  394. data/docs/ErrorDetails.md +20 -0
  395. data/docs/EstimatedWaitTimePredictions.md +13 -0
  396. data/docs/Evaluation.md +32 -0
  397. data/docs/EvaluationAssignment.md +14 -0
  398. data/docs/EvaluationEntityListing.md +22 -0
  399. data/docs/EvaluationForm.md +21 -0
  400. data/docs/EvaluationFormAndScoringSet.md +14 -0
  401. data/docs/EvaluationFormEntityListing.md +22 -0
  402. data/docs/EvaluationScoringSet.md +18 -0
  403. data/docs/EvaluatorActivity.md +22 -0
  404. data/docs/EvaluatorActivityEntityListing.md +22 -0
  405. data/docs/ExpansionCriterium.md +14 -0
  406. data/docs/ExportUri.md +14 -0
  407. data/docs/ExportUriNotification.md +15 -0
  408. data/docs/Extension.md +28 -0
  409. data/docs/ExtensionEntityListing.md +22 -0
  410. data/docs/ExtensionPool.md +26 -0
  411. data/docs/ExtensionPoolEntityListing.md +22 -0
  412. data/docs/ExternalContact.md +32 -0
  413. data/docs/ExternalContactsApi.md +1886 -0
  414. data/docs/ExternalDataSource.md +14 -0
  415. data/docs/ExternalOrganization.md +30 -0
  416. data/docs/ExternalOrganizationListing.md +22 -0
  417. data/docs/FacetEntry.md +20 -0
  418. data/docs/FacetInfo.md +14 -0
  419. data/docs/FacetKeyAttribute.md +15 -0
  420. data/docs/FacetStatistics.md +19 -0
  421. data/docs/FacetTerm.md +18 -0
  422. data/docs/FailedObject.md +16 -0
  423. data/docs/FaxApi.md +371 -0
  424. data/docs/FaxDataV2Notification.md +29 -0
  425. data/docs/FaxDataV2NotificationLockData.md +15 -0
  426. data/docs/FaxDataV2NotificationLockInfo.md +15 -0
  427. data/docs/FaxDataV2NotificationUserData.md +14 -0
  428. data/docs/FaxDataV2NotificationWorkspaceData.md +13 -0
  429. data/docs/FaxDocument.md +30 -0
  430. data/docs/FaxDocumentEntityListing.md +22 -0
  431. data/docs/FaxSendRequest.md +21 -0
  432. data/docs/FaxSendResponse.md +17 -0
  433. data/docs/FaxStatus.md +20 -0
  434. data/docs/FaxSummary.md +15 -0
  435. data/docs/FeatureState.md +13 -0
  436. data/docs/FieldConfig.md +20 -0
  437. data/docs/FieldConfigs.md +16 -0
  438. data/docs/FieldList.md +21 -0
  439. data/docs/Flow.md +28 -0
  440. data/docs/FlowEntityListing.md +22 -0
  441. data/docs/FlowVersion.md +24 -0
  442. data/docs/FlowVersionEntityListing.md +22 -0
  443. data/docs/GSuite.md +20 -0
  444. data/docs/Geolocation.md +23 -0
  445. data/docs/GeolocationApi.md +255 -0
  446. data/docs/GeolocationNotification.md +17 -0
  447. data/docs/GeolocationSettings.md +17 -0
  448. data/docs/Greeting.md +24 -0
  449. data/docs/GreetingAudioFile.md +15 -0
  450. data/docs/GreetingListing.md +22 -0
  451. data/docs/GreetingMediaInfo.md +15 -0
  452. data/docs/GreetingOwner.md +15 -0
  453. data/docs/GreetingsApi.md +999 -0
  454. data/docs/Group.md +25 -0
  455. data/docs/GroupContact.md +16 -0
  456. data/docs/GroupEntityListing.md +22 -0
  457. data/docs/GroupMembersUpdate.md +14 -0
  458. data/docs/GroupSearchCriteria.md +20 -0
  459. data/docs/GroupSearchRequest.md +17 -0
  460. data/docs/GroupUpdate.md +22 -0
  461. data/docs/GroupsApi.md +700 -0
  462. data/docs/GroupsSearchResponse.md +21 -0
  463. data/docs/HeartBeatAlert.md +24 -0
  464. data/docs/HeartBeatAlertContainer.md +22 -0
  465. data/docs/HeartBeatAlertNotification.md +22 -0
  466. data/docs/HeartBeatAlertNotificationNotificationUser.md +14 -0
  467. data/docs/HeartBeatAlertNotificationNotificationUsers.md +14 -0
  468. data/docs/HeartBeatRule.md +22 -0
  469. data/docs/HeartBeatRuleContainer.md +22 -0
  470. data/docs/HeartBeatRuleNotification.md +21 -0
  471. data/docs/HeartBeatRuleNotificationNotificationUser.md +14 -0
  472. data/docs/IdentityNow.md +20 -0
  473. data/docs/IdentityProviderApi.md +1578 -0
  474. data/docs/ImportStatus.md +17 -0
  475. data/docs/ImportStatusNotification.md +18 -0
  476. data/docs/InboundDomain.md +17 -0
  477. data/docs/InboundDomainEntityListing.md +22 -0
  478. data/docs/InboundRoute.md +23 -0
  479. data/docs/InboundRouteEntityListing.md +22 -0
  480. data/docs/InitiateScreenRecording.md +15 -0
  481. data/docs/InteractionStatAlertNotification.md +28 -0
  482. data/docs/InteractionStatAlertNotificationNotificationUser.md +14 -0
  483. data/docs/InteractionStatRuleNotification.md +26 -0
  484. data/docs/InteractionStatRuleNotificationNotificationUser.md +14 -0
  485. data/docs/InteractionStatsAlert.md +29 -0
  486. data/docs/InteractionStatsAlertContainer.md +22 -0
  487. data/docs/InteractionStatsRule.md +26 -0
  488. data/docs/InteractionStatsRuleContainer.md +22 -0
  489. data/docs/IntradayDataUpdateNotification.md +19 -0
  490. data/docs/IntradayDataUpdateNotificationForecastDataPerInterval.md +15 -0
  491. data/docs/IntradayDataUpdateNotificationHistoricalAgentDataPerInterval.md +14 -0
  492. data/docs/IntradayDataUpdateNotificationHistoricalQueueDataPerInterval.md +20 -0
  493. data/docs/IntradayDataUpdateNotificationIntradayDataGroup.md +19 -0
  494. data/docs/IntradayDataUpdateNotificationIntradayDataGroupings.md +19 -0
  495. data/docs/IntradayDataUpdateNotificationIntradayForecastData.md +15 -0
  496. data/docs/IntradayDataUpdateNotificationIntradayHistoricalAgentData.md +14 -0
  497. data/docs/IntradayDataUpdateNotificationIntradayHistoricalQueueData.md +20 -0
  498. data/docs/IntradayDataUpdateNotificationIntradayMetric.md +14 -0
  499. data/docs/IntradayDataUpdateNotificationIntradayPerformancePredictionAgentData.md +13 -0
  500. data/docs/IntradayDataUpdateNotificationIntradayPerformancePredictionQueueData.md +15 -0
  501. data/docs/IntradayDataUpdateNotificationIntradayScheduleData.md +14 -0
  502. data/docs/IntradayDataUpdateNotificationMetrics.md +14 -0
  503. data/docs/IntradayDataUpdateNotificationPerformancePredictionAgentDataPerInterval.md +13 -0
  504. data/docs/IntradayDataUpdateNotificationPerformancePredictionQueueDataPerInterval.md +15 -0
  505. data/docs/IntradayDataUpdateNotificationScheduleDataPerInterval.md +14 -0
  506. data/docs/JsonNode.md +33 -0
  507. data/docs/JsonNodeSearchResponse.md +22 -0
  508. data/docs/JsonSchemaDocument.md +19 -0
  509. data/docs/KeyRotationSchedule.md +16 -0
  510. data/docs/Keyword.md +25 -0
  511. data/docs/KeywordSet.md +21 -0
  512. data/docs/KeywordSetEntityListing.md +22 -0
  513. data/docs/Language.md +18 -0
  514. data/docs/LanguageEntityListing.md +22 -0
  515. data/docs/LanguagesApi.md +611 -0
  516. data/docs/Library.md +18 -0
  517. data/docs/LibraryEntityListing.md +22 -0
  518. data/docs/LicenseApi.md +362 -0
  519. data/docs/LicenseAssignmentRequest.md +15 -0
  520. data/docs/LicenseBatchAssignmentRequest.md +13 -0
  521. data/docs/LicenseDefinition.md +17 -0
  522. data/docs/LicenseDefinitionListing.md +22 -0
  523. data/docs/LicenseOrganization.md +16 -0
  524. data/docs/LicenseUpdateResponse.md +13 -0
  525. data/docs/LicenseUpdateStatus.md +15 -0
  526. data/docs/LicenseUser.md +15 -0
  527. data/docs/Line.md +33 -0
  528. data/docs/LineBase.md +26 -0
  529. data/docs/LineBaseEntityListing.md +22 -0
  530. data/docs/LineEntityListing.md +22 -0
  531. data/docs/LineStatus.md +17 -0
  532. data/docs/LocalEncryptionConfiguration.md +18 -0
  533. data/docs/LocalEncryptionConfigurationListing.md +15 -0
  534. data/docs/LocalEncryptionKeyRequest.md +15 -0
  535. data/docs/Location.md +17 -0
  536. data/docs/LocationAddress.md +19 -0
  537. data/docs/LocationDefinition.md +21 -0
  538. data/docs/LocationEmergencyNumber.md +15 -0
  539. data/docs/LocationSearchCriteria.md +20 -0
  540. data/docs/LocationSearchRequest.md +17 -0
  541. data/docs/LocationsApi.md +261 -0
  542. data/docs/LocationsSearchResponse.md +21 -0
  543. data/docs/LockInfo.md +16 -0
  544. data/docs/LogicalInterfaceEntityListing.md +22 -0
  545. data/docs/ManagementUnit.md +18 -0
  546. data/docs/MaxParticipants.md +13 -0
  547. data/docs/MediaParticipantRequest.md +19 -0
  548. data/docs/MediaPolicies.md +15 -0
  549. data/docs/MediaResult.md +14 -0
  550. data/docs/MediaSetting.md +14 -0
  551. data/docs/MediaSummary.md +14 -0
  552. data/docs/MediaSummaryDetail.md +14 -0
  553. data/docs/MemberEntity.md +13 -0
  554. data/docs/MetaData.md +15 -0
  555. data/docs/Metabase.md +24 -0
  556. data/docs/MeteredEvaluationAssignment.md +18 -0
  557. data/docs/Note.md +20 -0
  558. data/docs/NoteListing.md +22 -0
  559. data/docs/NotificationsApi.md +426 -0
  560. data/docs/Number.md +14 -0
  561. data/docs/NumberPlan.md +31 -0
  562. data/docs/NumericRange.md +16 -0
  563. data/docs/OAuthApi.md +368 -0
  564. data/docs/OAuthClient.md +21 -0
  565. data/docs/OAuthClientEntityListing.md +22 -0
  566. data/docs/OAuthClientListing.md +20 -0
  567. data/docs/OAuthProvider.md +16 -0
  568. data/docs/OAuthProviderEntityListing.md +22 -0
  569. data/docs/ObservationDataContainer.md +14 -0
  570. data/docs/ObservationQuery.md +14 -0
  571. data/docs/ObservationQueryResponse.md +13 -0
  572. data/docs/Okta.md +19 -0
  573. data/docs/OneLogin.md +19 -0
  574. data/docs/Operation.md +21 -0
  575. data/docs/OrgMediaUtilization.md +15 -0
  576. data/docs/Organization.md +25 -0
  577. data/docs/OrganizationApi.md +250 -0
  578. data/docs/OrganizationFeatures.md +25 -0
  579. data/docs/OrganizationPresence.md +23 -0
  580. data/docs/OrganizationPresenceEntityListing.md +22 -0
  581. data/docs/OrganizationProductEntityListing.md +17 -0
  582. data/docs/OrganizationRoleEntityListing.md +22 -0
  583. data/docs/OrphanRecording.md +24 -0
  584. data/docs/OrphanRecordingListing.md +22 -0
  585. data/docs/OrphanUpdateRequest.md +15 -0
  586. data/docs/OutOfOffice.md +19 -0
  587. data/docs/OutOfOfficeNotification.md +17 -0
  588. data/docs/OutOfOfficeNotificationUser.md +13 -0
  589. data/docs/OutboundApi.md +4766 -0
  590. data/docs/OutboundRoute.md +30 -0
  591. data/docs/OutboundRouteBase.md +28 -0
  592. data/docs/OutboundRouteBaseEntityListing.md +22 -0
  593. data/docs/OutboundRouteEntityListing.md +22 -0
  594. data/docs/PINConfiguration.md +14 -0
  595. data/docs/Page.md +20 -0
  596. data/docs/PagingSpec.md +14 -0
  597. data/docs/Parameter.md +16 -0
  598. data/docs/ParsedCertificate.md +13 -0
  599. data/docs/Participant.md +48 -0
  600. data/docs/ParticipantAttributes.md +13 -0
  601. data/docs/ParticipantBasic.md +48 -0
  602. data/docs/PermissionCollectionEntityListing.md +22 -0
  603. data/docs/Permissions.md +15 -0
  604. data/docs/Phone.md +37 -0
  605. data/docs/PhoneBase.md +28 -0
  606. data/docs/PhoneBaseEntityListing.md +22 -0
  607. data/docs/PhoneCapabilities.md +18 -0
  608. data/docs/PhoneColumn.md +14 -0
  609. data/docs/PhoneEntityListing.md +22 -0
  610. data/docs/PhoneMetaBaseEntityListing.md +22 -0
  611. data/docs/PhoneNumber.md +18 -0
  612. data/docs/PhoneNumberColumn.md +14 -0
  613. data/docs/PhoneNumberStatus.md +13 -0
  614. data/docs/PhoneStatus.md +22 -0
  615. data/docs/PhonesReboot.md +14 -0
  616. data/docs/PhysicalInterfaceEntityListing.md +22 -0
  617. data/docs/PingIdentity.md +20 -0
  618. data/docs/Policy.md +24 -0
  619. data/docs/PolicyActions.md +20 -0
  620. data/docs/PolicyConditions.md +20 -0
  621. data/docs/PolicyCreate.md +24 -0
  622. data/docs/PolicyEntityListing.md +22 -0
  623. data/docs/PolicyErrorMessage.md +19 -0
  624. data/docs/PolicyErrors.md +13 -0
  625. data/docs/PredictionResults.md +15 -0
  626. data/docs/PresenceApi.md +508 -0
  627. data/docs/PresenceQueryResponse.md +14 -0
  628. data/docs/Prompt.md +18 -0
  629. data/docs/PromptAsset.md +24 -0
  630. data/docs/PromptAssetCreate.md +24 -0
  631. data/docs/PromptAssetEntityListing.md +22 -0
  632. data/docs/PromptEntityListing.md +22 -0
  633. data/docs/PropertyIndexRequest.md +15 -0
  634. data/docs/ProvisionInfo.md +15 -0
  635. data/docs/PureCloud.md +16 -0
  636. data/docs/QualifierMappingObservationQueryResponse.md +14 -0
  637. data/docs/QualityApi.md +2084 -0
  638. data/docs/QualityAudit.md +23 -0
  639. data/docs/QualityAuditPage.md +22 -0
  640. data/docs/QueryFacetInfo.md +14 -0
  641. data/docs/QueryRequest.md +20 -0
  642. data/docs/QueryResult.md +16 -0
  643. data/docs/QueryResults.md +14 -0
  644. data/docs/Question.md +24 -0
  645. data/docs/QuestionGroup.md +22 -0
  646. data/docs/QuestionGroupScore.md +23 -0
  647. data/docs/QuestionScore.md +18 -0
  648. data/docs/Queue.md +34 -0
  649. data/docs/QueueEmailAddress.md +14 -0
  650. data/docs/QueueEntityListing.md +22 -0
  651. data/docs/QueueMember.md +20 -0
  652. data/docs/QueueMemberEntityListing.md +22 -0
  653. data/docs/QueueMemberNotification.md +16 -0
  654. data/docs/QueueUtilizationDiagnostic.md +21 -0
  655. data/docs/Reaction.md +15 -0
  656. data/docs/RecallEntry.md +14 -0
  657. data/docs/Recording.md +34 -0
  658. data/docs/RecordingApi.md +2089 -0
  659. data/docs/RecordingDataV2Notification.md +29 -0
  660. data/docs/RecordingDataV2NotificationConversationData.md +13 -0
  661. data/docs/RecordingDataV2NotificationLockData.md +15 -0
  662. data/docs/RecordingDataV2NotificationLockInfo.md +15 -0
  663. data/docs/RecordingDataV2NotificationUserData.md +14 -0
  664. data/docs/RecordingDataV2NotificationWorkspaceData.md +13 -0
  665. data/docs/RecordingEmailMessage.md +22 -0
  666. data/docs/RecordingSettings.md +13 -0
  667. data/docs/Relationship.md +19 -0
  668. data/docs/RelationshipListing.md +22 -0
  669. data/docs/ReplaceRequest.md +15 -0
  670. data/docs/ReplaceResponse.md +18 -0
  671. data/docs/ReportMetaData.md +21 -0
  672. data/docs/ReportMetaDataEntityListing.md +22 -0
  673. data/docs/ReportRunEntry.md +23 -0
  674. data/docs/ReportRunEntryEntityDomainListing.md +22 -0
  675. data/docs/ReportSchedule.md +29 -0
  676. data/docs/ReportScheduleEntityListing.md +22 -0
  677. data/docs/ResourceConditionNode.md +17 -0
  678. data/docs/ResourceConditionValue.md +14 -0
  679. data/docs/ResourcePermissionPolicy.md +23 -0
  680. data/docs/Response.md +23 -0
  681. data/docs/ResponseEntityList.md +22 -0
  682. data/docs/ResponseEntityListing.md +22 -0
  683. data/docs/ResponseFilter.md +15 -0
  684. data/docs/ResponseManagementApi.md +699 -0
  685. data/docs/ResponseQueryRequest.md +15 -0
  686. data/docs/ResponseQueryResults.md +13 -0
  687. data/docs/ResponseSet.md +19 -0
  688. data/docs/ResponseSetEntityListing.md +22 -0
  689. data/docs/ResponseSetNotification.md +19 -0
  690. data/docs/ResponseSetNotificationReaction.md +16 -0
  691. data/docs/ResponseSetNotificationResponses.md +16 -0
  692. data/docs/ResponseSubstitution.md +15 -0
  693. data/docs/ResponseText.md +14 -0
  694. data/docs/RestErrorDetail.md +14 -0
  695. data/docs/RetentionDuration.md +14 -0
  696. data/docs/ReverseWhitepagesLookupResult.md +14 -0
  697. data/docs/Ring.md +14 -0
  698. data/docs/RoutingApi.md +2763 -0
  699. data/docs/RoutingData.md +17 -0
  700. data/docs/RoutingSkill.md +18 -0
  701. data/docs/RoutingStatus.md +15 -0
  702. data/docs/RoutingStatusAlert.md +23 -0
  703. data/docs/RoutingStatusAlertContainer.md +22 -0
  704. data/docs/RoutingStatusRule.md +22 -0
  705. data/docs/RoutingStatusRuleContainer.md +22 -0
  706. data/docs/RuleSet.md +21 -0
  707. data/docs/RuleSetDiagnostic.md +14 -0
  708. data/docs/RuleSetEntityListing.md +22 -0
  709. data/docs/RuleSetNotification.md +21 -0
  710. data/docs/RuleSetNotificationAction.md +17 -0
  711. data/docs/RuleSetNotificationActions.md +17 -0
  712. data/docs/RuleSetNotificationCondition.md +20 -0
  713. data/docs/RuleSetNotificationConditions.md +20 -0
  714. data/docs/RuleSetNotificationRule.md +19 -0
  715. data/docs/RuleSetNotificationRules.md +19 -0
  716. data/docs/RuleSetNotificationUriReference.md +14 -0
  717. data/docs/RunNowResponse.md +15 -0
  718. data/docs/Salesforce.md +19 -0
  719. data/docs/ScheduleInterval.md +14 -0
  720. data/docs/SchemaCategory.md +24 -0
  721. data/docs/SchemaCategoryEntityListing.md +22 -0
  722. data/docs/SchemaReferenceEntityListing.md +22 -0
  723. data/docs/ScreenRecordingSession.md +19 -0
  724. data/docs/ScreenRecordingSessionListing.md +22 -0
  725. data/docs/ScreenRecordingSessionRequest.md +15 -0
  726. data/docs/ScreenShareConversationNotification.md +16 -0
  727. data/docs/ScreenShareConversationNotificationDetail.md +16 -0
  728. data/docs/ScreenShareConversationNotificationErrorBody.md +22 -0
  729. data/docs/ScreenShareConversationNotificationErrorInfo.md +22 -0
  730. data/docs/ScreenShareConversationNotificationParticipants.md +40 -0
  731. data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md +40 -0
  732. data/docs/ScreenShareConversationNotificationUriReference.md +14 -0
  733. data/docs/ScreenShareConversationNotificationWrapup.md +18 -0
  734. data/docs/Screenshare.md +22 -0
  735. data/docs/Script.md +26 -0
  736. data/docs/ScriptEntityListing.md +22 -0
  737. data/docs/ScriptsApi.md +592 -0
  738. data/docs/SearchAggregation.md +18 -0
  739. data/docs/SearchApi.md +888 -0
  740. data/docs/SearchCriteria.md +20 -0
  741. data/docs/SearchRequest.md +21 -0
  742. data/docs/Section.md +16 -0
  743. data/docs/SecurityProfile.md +16 -0
  744. data/docs/SecurityProfileEntityListing.md +22 -0
  745. data/docs/Segment.md +17 -0
  746. data/docs/SequenceSchedule.md +21 -0
  747. data/docs/SequenceScheduleNotification.md +21 -0
  748. data/docs/SequenceScheduleNotificationScheduleInterval.md +15 -0
  749. data/docs/SequenceScheduleNotificationUriReference.md +14 -0
  750. data/docs/ServerDate.md +13 -0
  751. data/docs/ServiceContext.md +13 -0
  752. data/docs/ServiceLevel.md +14 -0
  753. data/docs/Share.md +23 -0
  754. data/docs/ShareEntityListing.md +22 -0
  755. data/docs/SharedEntity.md +13 -0
  756. data/docs/SharedResponse.md +17 -0
  757. data/docs/Site.md +33 -0
  758. data/docs/SiteEntityListing.md +22 -0
  759. data/docs/SkillEntityListing.md +22 -0
  760. data/docs/SkillsToRemove.md +15 -0
  761. data/docs/SocialConversationNotification.md +16 -0
  762. data/docs/SocialConversationNotificationDetail.md +16 -0
  763. data/docs/SocialConversationNotificationErrorBody.md +22 -0
  764. data/docs/SocialConversationNotificationErrorInfo.md +22 -0
  765. data/docs/SocialConversationNotificationParticipants.md +41 -0
  766. data/docs/SocialConversationNotificationSocialMediaParticipant.md +41 -0
  767. data/docs/SocialConversationNotificationUriReference.md +14 -0
  768. data/docs/SocialConversationNotificationWrapup.md +18 -0
  769. data/docs/SocialExpression.md +26 -0
  770. data/docs/SortItem.md +14 -0
  771. data/docs/Station.md +22 -0
  772. data/docs/StationEntityListing.md +22 -0
  773. data/docs/StationsApi.md +203 -0
  774. data/docs/StatisticalResponse.md +15 -0
  775. data/docs/StatisticalSummary.md +21 -0
  776. data/docs/StreetAddress.md +20 -0
  777. data/docs/SubscriberResponse.md +14 -0
  778. data/docs/SuggestApi.md +272 -0
  779. data/docs/SuggestSearchCriteria.md +19 -0
  780. data/docs/SuggestSearchRequest.md +15 -0
  781. data/docs/SystemPresence.md +15 -0
  782. data/docs/SystemPrompt.md +17 -0
  783. data/docs/SystemPromptAsset.md +25 -0
  784. data/docs/SystemPromptAssetEntityListing.md +22 -0
  785. data/docs/SystemPromptEntityListing.md +22 -0
  786. data/docs/TagQueryRequest.md +15 -0
  787. data/docs/TagValue.md +17 -0
  788. data/docs/TagValueEntityListing.md +22 -0
  789. data/docs/TelephonyProvidersEdgeApi.md +7507 -0
  790. data/docs/TermAttribute.md +15 -0
  791. data/docs/Ticker.md +14 -0
  792. data/docs/TimeAllowed.md +15 -0
  793. data/docs/TimeInterval.md +14 -0
  794. data/docs/TimeOffRequest.md +30 -0
  795. data/docs/TimeOffRequestList.md +16 -0
  796. data/docs/TimeOffRequestPatch.md +13 -0
  797. data/docs/TimeOffRequestUpdateNotification.md +28 -0
  798. data/docs/TimeOffRequestUpdateNotificationUser.md +13 -0
  799. data/docs/TimeSlot.md +15 -0
  800. data/docs/TimeZone.md +16 -0
  801. data/docs/TimeZoneEntityListing.md +22 -0
  802. data/docs/TokensApi.md +66 -0
  803. data/docs/TransferRequest.md +17 -0
  804. data/docs/Trunk.md +31 -0
  805. data/docs/TrunkBase.md +28 -0
  806. data/docs/TrunkBaseAssignment.md +14 -0
  807. data/docs/TrunkBaseEntityListing.md +22 -0
  808. data/docs/TrunkEntityListing.md +22 -0
  809. data/docs/TrunkMetabaseEntityListing.md +22 -0
  810. data/docs/TrunkRecordingEnabledCount.md +14 -0
  811. data/docs/TwitterId.md +17 -0
  812. data/docs/UnreadMetric.md +13 -0
  813. data/docs/UnreadStatus.md +13 -0
  814. data/docs/UriReference.md +15 -0
  815. data/docs/Usage.md +13 -0
  816. data/docs/UsageItem.md +15 -0
  817. data/docs/User.md +36 -0
  818. data/docs/UserAgentInfo.md +15 -0
  819. data/docs/UserAuthorization.md +15 -0
  820. data/docs/UserConversationSummary.md +19 -0
  821. data/docs/UserConversationSummaryNotification.md +19 -0
  822. data/docs/UserConversationSummaryNotificationCall.md +14 -0
  823. data/docs/UserConversationSummaryNotificationCallContactCenter.md +14 -0
  824. data/docs/UserConversationSummaryNotificationMediaSummary.md +14 -0
  825. data/docs/UserConversationSummaryNotificationMediaSummaryDetail.md +14 -0
  826. data/docs/UserDetailsQuery.md +20 -0
  827. data/docs/UserEntityListing.md +22 -0
  828. data/docs/UserImage.md +14 -0
  829. data/docs/UserListScheduleRequestBody.md +15 -0
  830. data/docs/UserMe.md +48 -0
  831. data/docs/UserParam.md +14 -0
  832. data/docs/UserPresence.md +20 -0
  833. data/docs/UserPresenceAlert.md +25 -0
  834. data/docs/UserPresenceAlertContainer.md +22 -0
  835. data/docs/UserPresenceNotification.md +16 -0
  836. data/docs/UserPresenceNotificationOrganizationPresence.md +14 -0
  837. data/docs/UserPresenceNotificationPresenceDefinition.md +14 -0
  838. data/docs/UserPresenceRule.md +23 -0
  839. data/docs/UserPresenceRuleContainer.md +22 -0
  840. data/docs/UserQueue.md +35 -0
  841. data/docs/UserQueueEntityListing.md +22 -0
  842. data/docs/UserRecording.md +25 -0
  843. data/docs/UserRecordingEntityListing.md +22 -0
  844. data/docs/UserRecordingsApi.md +385 -0
  845. data/docs/UserRoutingSkill.md +18 -0
  846. data/docs/UserRoutingSkillPost.md +16 -0
  847. data/docs/UserRoutingStatusNotification.md +13 -0
  848. data/docs/UserRoutingStatusNotificationRoutingStatus.md +14 -0
  849. data/docs/UserSchedule.md +14 -0
  850. data/docs/UserScheduleActivity.md +18 -0
  851. data/docs/UserScheduleAdherence.md +26 -0
  852. data/docs/UserScheduleAdherenceUpdateNotification.md +22 -0
  853. data/docs/UserScheduleAdherenceUpdateNotificationUser.md +13 -0
  854. data/docs/UserScheduleContainer.md +14 -0
  855. data/docs/UserScheduleFullDayTimeOffMarker.md +17 -0
  856. data/docs/UserScheduleShift.md +15 -0
  857. data/docs/UserSearchCriteria.md +20 -0
  858. data/docs/UserSearchRequest.md +18 -0
  859. data/docs/UserSkillEntityListing.md +22 -0
  860. data/docs/UserStation.md +19 -0
  861. data/docs/UserStations.md +16 -0
  862. data/docs/UserStationsNotification.md +13 -0
  863. data/docs/UserStationsNotificationAssociatedStation.md +15 -0
  864. data/docs/UserStationsNotificationUser.md +13 -0
  865. data/docs/UserStationsNotificationUserStation.md +15 -0
  866. data/docs/UsersApi.md +2641 -0
  867. data/docs/UsersSearchResponse.md +21 -0
  868. data/docs/UtilitiesApi.md +189 -0
  869. data/docs/Utilization.md +13 -0
  870. data/docs/ValidateAddressRequest.md +13 -0
  871. data/docs/ValidateAddressResponse.md +14 -0
  872. data/docs/Video.md +23 -0
  873. data/docs/VideoConversationNotification.md +16 -0
  874. data/docs/VideoConversationNotificationDetail.md +16 -0
  875. data/docs/VideoConversationNotificationErrorBody.md +22 -0
  876. data/docs/VideoConversationNotificationErrorInfo.md +22 -0
  877. data/docs/VideoConversationNotificationParticipants.md +42 -0
  878. data/docs/VideoConversationNotificationUriReference.md +14 -0
  879. data/docs/VideoConversationNotificationVideoMediaParticipant.md +42 -0
  880. data/docs/VideoConversationNotificationWrapup.md +18 -0
  881. data/docs/VisibilityCondition.md +14 -0
  882. data/docs/VmPairingInfo.md +16 -0
  883. data/docs/VoicemailApi.md +1336 -0
  884. data/docs/VoicemailCopyRecord.md +15 -0
  885. data/docs/VoicemailGroupPolicy.md +18 -0
  886. data/docs/VoicemailMailboxInfo.md +18 -0
  887. data/docs/VoicemailMediaInfo.md +15 -0
  888. data/docs/VoicemailMessage.md +29 -0
  889. data/docs/VoicemailMessageEntityListing.md +22 -0
  890. data/docs/VoicemailMessageNotification.md +24 -0
  891. data/docs/VoicemailOrganizationPolicy.md +19 -0
  892. data/docs/VoicemailSearchCriteria.md +20 -0
  893. data/docs/VoicemailSearchRequest.md +18 -0
  894. data/docs/VoicemailUserPolicy.md +16 -0
  895. data/docs/VoicemailsSearchResponse.md +21 -0
  896. data/docs/WfmUserEntityListing.md +13 -0
  897. data/docs/WorkforceManagementApi.md +699 -0
  898. data/docs/Workspace.md +24 -0
  899. data/docs/WorkspaceCreate.md +15 -0
  900. data/docs/WorkspaceEntityListing.md +22 -0
  901. data/docs/WorkspaceMember.md +21 -0
  902. data/docs/WorkspaceMemberEntityListing.md +22 -0
  903. data/docs/WorkspaceSummary.md +14 -0
  904. data/docs/WrapUpCodeMapping.md +20 -0
  905. data/docs/WrapUpCodeMappingNotification.md +19 -0
  906. data/docs/Wrapup.md +19 -0
  907. data/docs/WrapupCode.md +19 -0
  908. data/docs/WrapupCodeEntityListing.md +22 -0
  909. data/git_push.sh +52 -0
  910. data/lib/purecloudplatformclientv2.rb +949 -0
  911. data/lib/purecloudplatformclientv2/api/alerting_api.rb +2016 -0
  912. data/lib/purecloudplatformclientv2/api/analytics_api.rb +1301 -0
  913. data/lib/purecloudplatformclientv2/api/architect_api.rb +2860 -0
  914. data/lib/purecloudplatformclientv2/api/attributes_api.rb +374 -0
  915. data/lib/purecloudplatformclientv2/api/authorization_api.rb +1043 -0
  916. data/lib/purecloudplatformclientv2/api/content_management_api.rb +2416 -0
  917. data/lib/purecloudplatformclientv2/api/conversations_api.rb +4725 -0
  918. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +1810 -0
  919. data/lib/purecloudplatformclientv2/api/fax_api.rb +370 -0
  920. data/lib/purecloudplatformclientv2/api/geolocation_api.rb +263 -0
  921. data/lib/purecloudplatformclientv2/api/greetings_api.rb +974 -0
  922. data/lib/purecloudplatformclientv2/api/groups_api.rb +696 -0
  923. data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +1547 -0
  924. data/lib/purecloudplatformclientv2/api/languages_api.rb +604 -0
  925. data/lib/purecloudplatformclientv2/api/license_api.rb +357 -0
  926. data/lib/purecloudplatformclientv2/api/locations_api.rb +267 -0
  927. data/lib/purecloudplatformclientv2/api/notifications_api.rb +424 -0
  928. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +368 -0
  929. data/lib/purecloudplatformclientv2/api/organization_api.rb +262 -0
  930. data/lib/purecloudplatformclientv2/api/outbound_api.rb +4670 -0
  931. data/lib/purecloudplatformclientv2/api/presence_api.rb +505 -0
  932. data/lib/purecloudplatformclientv2/api/quality_api.rb +2069 -0
  933. data/lib/purecloudplatformclientv2/api/recording_api.rb +2042 -0
  934. data/lib/purecloudplatformclientv2/api/response_management_api.rb +693 -0
  935. data/lib/purecloudplatformclientv2/api/routing_api.rb +2690 -0
  936. data/lib/purecloudplatformclientv2/api/scripts_api.rb +597 -0
  937. data/lib/purecloudplatformclientv2/api/search_api.rb +862 -0
  938. data/lib/purecloudplatformclientv2/api/stations_api.rb +212 -0
  939. data/lib/purecloudplatformclientv2/api/suggest_api.rb +275 -0
  940. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +7258 -0
  941. data/lib/purecloudplatformclientv2/api/tokens_api.rb +80 -0
  942. data/lib/purecloudplatformclientv2/api/user_recordings_api.rb +385 -0
  943. data/lib/purecloudplatformclientv2/api/users_api.rb +2557 -0
  944. data/lib/purecloudplatformclientv2/api/utilities_api.rb +196 -0
  945. data/lib/purecloudplatformclientv2/api/voicemail_api.rb +1294 -0
  946. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +675 -0
  947. data/lib/purecloudplatformclientv2/api_client.rb +336 -0
  948. data/lib/purecloudplatformclientv2/api_error.rb +40 -0
  949. data/lib/purecloudplatformclientv2/configuration.rb +170 -0
  950. data/lib/purecloudplatformclientv2/models/actions.rb +180 -0
  951. data/lib/purecloudplatformclientv2/models/activity_code.rb +264 -0
  952. data/lib/purecloudplatformclientv2/models/activity_code_container.rb +182 -0
  953. data/lib/purecloudplatformclientv2/models/acw_settings.rb +203 -0
  954. data/lib/purecloudplatformclientv2/models/address.rb +219 -0
  955. data/lib/purecloudplatformclientv2/models/addressable_entity_user.rb +189 -0
  956. data/lib/purecloudplatformclientv2/models/addressable_license_definition.rb +189 -0
  957. data/lib/purecloudplatformclientv2/models/adfs.rb +243 -0
  958. data/lib/purecloudplatformclientv2/models/adjacents.rb +202 -0
  959. data/lib/purecloudplatformclientv2/models/agent.rb +179 -0
  960. data/lib/purecloudplatformclientv2/models/agent_activity.rb +236 -0
  961. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +261 -0
  962. data/lib/purecloudplatformclientv2/models/agent_evaluator_activity.rb +234 -0
  963. data/lib/purecloudplatformclientv2/models/aggregate_data_container.rb +192 -0
  964. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +210 -0
  965. data/lib/purecloudplatformclientv2/models/aggregate_query_response.rb +180 -0
  966. data/lib/purecloudplatformclientv2/models/aggregate_view_data.rb +187 -0
  967. data/lib/purecloudplatformclientv2/models/aggregation_query.rb +255 -0
  968. data/lib/purecloudplatformclientv2/models/aggregation_range.rb +189 -0
  969. data/lib/purecloudplatformclientv2/models/aggregation_result.rb +232 -0
  970. data/lib/purecloudplatformclientv2/models/aggregation_result_entry.rb +208 -0
  971. data/lib/purecloudplatformclientv2/models/analytics_conversation.rb +220 -0
  972. data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +191 -0
  973. data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb +427 -0
  974. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +259 -0
  975. data/lib/purecloudplatformclientv2/models/analytics_participant.rb +248 -0
  976. data/lib/purecloudplatformclientv2/models/analytics_property.rb +225 -0
  977. data/lib/purecloudplatformclientv2/models/analytics_query_aggregation.rb +235 -0
  978. data/lib/purecloudplatformclientv2/models/analytics_query_clause.rb +213 -0
  979. data/lib/purecloudplatformclientv2/models/analytics_query_filter.rb +221 -0
  980. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +319 -0
  981. data/lib/purecloudplatformclientv2/models/analytics_routing_status_record.rb +223 -0
  982. data/lib/purecloudplatformclientv2/models/analytics_session.rb +490 -0
  983. data/lib/purecloudplatformclientv2/models/analytics_user_detail.rb +203 -0
  984. data/lib/purecloudplatformclientv2/models/analytics_user_details_query_response.rb +191 -0
  985. data/lib/purecloudplatformclientv2/models/analytics_user_presence_record.rb +233 -0
  986. data/lib/purecloudplatformclientv2/models/analytics_view.rb +235 -0
  987. data/lib/purecloudplatformclientv2/models/annotation.rb +355 -0
  988. data/lib/purecloudplatformclientv2/models/answer_option.rb +196 -0
  989. data/lib/purecloudplatformclientv2/models/archive_retention.rb +201 -0
  990. data/lib/purecloudplatformclientv2/models/attachment.rb +214 -0
  991. data/lib/purecloudplatformclientv2/models/attempt_limits.rb +280 -0
  992. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +261 -0
  993. data/lib/purecloudplatformclientv2/models/attempt_limits_notification.rb +293 -0
  994. data/lib/purecloudplatformclientv2/models/attempt_limits_notification_recall_entries.rb +196 -0
  995. data/lib/purecloudplatformclientv2/models/attempt_limits_notification_recall_entry.rb +196 -0
  996. data/lib/purecloudplatformclientv2/models/attribute.rb +259 -0
  997. data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +261 -0
  998. data/lib/purecloudplatformclientv2/models/attribute_filter_item.rb +212 -0
  999. data/lib/purecloudplatformclientv2/models/attribute_query_request.rb +200 -0
  1000. data/lib/purecloudplatformclientv2/models/audit_change.rb +209 -0
  1001. data/lib/purecloudplatformclientv2/models/audit_entity.rb +213 -0
  1002. data/lib/purecloudplatformclientv2/models/audit_entity_reference.rb +228 -0
  1003. data/lib/purecloudplatformclientv2/models/audit_facet.rb +197 -0
  1004. data/lib/purecloudplatformclientv2/models/audit_filter.rb +227 -0
  1005. data/lib/purecloudplatformclientv2/models/audit_message.rb +349 -0
  1006. data/lib/purecloudplatformclientv2/models/audit_search_result.rb +231 -0
  1007. data/lib/purecloudplatformclientv2/models/audit_user.rb +203 -0
  1008. data/lib/purecloudplatformclientv2/models/available_language_list.rb +180 -0
  1009. data/lib/purecloudplatformclientv2/models/available_topic.rb +210 -0
  1010. data/lib/purecloudplatformclientv2/models/available_topic_entity_listing.rb +180 -0
  1011. data/lib/purecloudplatformclientv2/models/available_translations.rb +191 -0
  1012. data/lib/purecloudplatformclientv2/models/bullseye.rb +180 -0
  1013. data/lib/purecloudplatformclientv2/models/calibration.rb +320 -0
  1014. data/lib/purecloudplatformclientv2/models/calibration_assignment.rb +207 -0
  1015. data/lib/purecloudplatformclientv2/models/calibration_create.rb +325 -0
  1016. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +261 -0
  1017. data/lib/purecloudplatformclientv2/models/call.rb +418 -0
  1018. data/lib/purecloudplatformclientv2/models/call_basic.rb +418 -0
  1019. data/lib/purecloudplatformclientv2/models/call_command.rb +183 -0
  1020. data/lib/purecloudplatformclientv2/models/call_conversation.rb +245 -0
  1021. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +261 -0
  1022. data/lib/purecloudplatformclientv2/models/call_conversation_notification.rb +232 -0
  1023. data/lib/purecloudplatformclientv2/models/call_conversation_notification_call_media_participant.rb +551 -0
  1024. data/lib/purecloudplatformclientv2/models/call_conversation_notification_detail.rb +205 -0
  1025. data/lib/purecloudplatformclientv2/models/call_conversation_notification_error_body.rb +265 -0
  1026. data/lib/purecloudplatformclientv2/models/call_conversation_notification_error_info.rb +265 -0
  1027. data/lib/purecloudplatformclientv2/models/call_conversation_notification_fax_status.rb +241 -0
  1028. data/lib/purecloudplatformclientv2/models/call_conversation_notification_participants.rb +551 -0
  1029. data/lib/purecloudplatformclientv2/models/call_conversation_notification_uri_reference.rb +187 -0
  1030. data/lib/purecloudplatformclientv2/models/call_conversation_notification_wrapup.rb +225 -0
  1031. data/lib/purecloudplatformclientv2/models/call_forwarding.rb +235 -0
  1032. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +587 -0
  1033. data/lib/purecloudplatformclientv2/models/call_media_policy.rb +189 -0
  1034. data/lib/purecloudplatformclientv2/models/call_media_policy_conditions.rb +242 -0
  1035. data/lib/purecloudplatformclientv2/models/call_record.rb +189 -0
  1036. data/lib/purecloudplatformclientv2/models/callable_contacts_diagnostic.rb +213 -0
  1037. data/lib/purecloudplatformclientv2/models/callable_time.rb +195 -0
  1038. data/lib/purecloudplatformclientv2/models/callable_time_set.rb +244 -0
  1039. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +261 -0
  1040. data/lib/purecloudplatformclientv2/models/callable_time_set_notification.rb +234 -0
  1041. data/lib/purecloudplatformclientv2/models/callable_time_set_notification_callable_time.rb +198 -0
  1042. data/lib/purecloudplatformclientv2/models/callable_time_set_notification_callable_times.rb +198 -0
  1043. data/lib/purecloudplatformclientv2/models/callable_time_set_notification_time_slot.rb +205 -0
  1044. data/lib/purecloudplatformclientv2/models/callable_time_set_notification_time_slots.rb +205 -0
  1045. data/lib/purecloudplatformclientv2/models/callback.rb +395 -0
  1046. data/lib/purecloudplatformclientv2/models/callback_basic.rb +395 -0
  1047. data/lib/purecloudplatformclientv2/models/callback_conversation.rb +222 -0
  1048. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +261 -0
  1049. data/lib/purecloudplatformclientv2/models/callback_conversation_notification.rb +209 -0
  1050. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_callback_media_participant.rb +503 -0
  1051. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_detail.rb +205 -0
  1052. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_dialer_preview.rb +225 -0
  1053. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_error_body.rb +265 -0
  1054. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_error_info.rb +265 -0
  1055. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_error_info_details.rb +205 -0
  1056. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_participants.rb +503 -0
  1057. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_phone_number_column.rb +196 -0
  1058. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_uri_reference.rb +187 -0
  1059. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_wrapup.rb +225 -0
  1060. data/lib/purecloudplatformclientv2/models/callback_identifier.rb +211 -0
  1061. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +535 -0
  1062. data/lib/purecloudplatformclientv2/models/campaign.rb +514 -0
  1063. data/lib/purecloudplatformclientv2/models/campaign_diagnostics.rb +211 -0
  1064. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +261 -0
  1065. data/lib/purecloudplatformclientv2/models/campaign_interaction.rb +384 -0
  1066. data/lib/purecloudplatformclientv2/models/campaign_interactions.rb +233 -0
  1067. data/lib/purecloudplatformclientv2/models/campaign_notification.rb +488 -0
  1068. data/lib/purecloudplatformclientv2/models/campaign_notification_contact_sort.rb +219 -0
  1069. data/lib/purecloudplatformclientv2/models/campaign_notification_errors.rb +196 -0
  1070. data/lib/purecloudplatformclientv2/models/campaign_notification_phone_column.rb +196 -0
  1071. data/lib/purecloudplatformclientv2/models/campaign_notification_phone_columns.rb +196 -0
  1072. data/lib/purecloudplatformclientv2/models/campaign_notification_rest_error_detail.rb +196 -0
  1073. data/lib/purecloudplatformclientv2/models/campaign_notification_uri_reference.rb +187 -0
  1074. data/lib/purecloudplatformclientv2/models/campaign_progress.rb +227 -0
  1075. data/lib/purecloudplatformclientv2/models/campaign_progress_notification.rb +214 -0
  1076. data/lib/purecloudplatformclientv2/models/campaign_progress_notification_uri_reference.rb +187 -0
  1077. data/lib/purecloudplatformclientv2/models/campaign_rule.rb +292 -0
  1078. data/lib/purecloudplatformclientv2/models/campaign_rule_action.rb +219 -0
  1079. data/lib/purecloudplatformclientv2/models/campaign_rule_action_entities.rb +200 -0
  1080. data/lib/purecloudplatformclientv2/models/campaign_rule_condition.rb +210 -0
  1081. data/lib/purecloudplatformclientv2/models/campaign_rule_entities.rb +191 -0
  1082. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +261 -0
  1083. data/lib/purecloudplatformclientv2/models/campaign_rule_notification.rb +272 -0
  1084. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_action.rb +230 -0
  1085. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_action_entities.rb +209 -0
  1086. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_actions.rb +230 -0
  1087. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_condition.rb +221 -0
  1088. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_conditions.rb +221 -0
  1089. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_entities.rb +191 -0
  1090. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_uri_reference.rb +187 -0
  1091. data/lib/purecloudplatformclientv2/models/campaign_rule_parameters.rb +251 -0
  1092. data/lib/purecloudplatformclientv2/models/campaign_schedule.rb +272 -0
  1093. data/lib/purecloudplatformclientv2/models/campaign_schedule_notification.rb +252 -0
  1094. data/lib/purecloudplatformclientv2/models/campaign_schedule_notification_intervals.rb +196 -0
  1095. data/lib/purecloudplatformclientv2/models/campaign_schedule_notification_schedule_interval.rb +196 -0
  1096. data/lib/purecloudplatformclientv2/models/campaign_schedule_notification_uri_reference.rb +187 -0
  1097. data/lib/purecloudplatformclientv2/models/campaign_sequence.rb +306 -0
  1098. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +261 -0
  1099. data/lib/purecloudplatformclientv2/models/campaign_sequence_notification.rb +284 -0
  1100. data/lib/purecloudplatformclientv2/models/campaign_sequence_notification_uri_reference.rb +187 -0
  1101. data/lib/purecloudplatformclientv2/models/campaign_stats.rb +229 -0
  1102. data/lib/purecloudplatformclientv2/models/campaign_time_slot.rb +203 -0
  1103. data/lib/purecloudplatformclientv2/models/certificate.rb +184 -0
  1104. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +261 -0
  1105. data/lib/purecloudplatformclientv2/models/certificate_details.rb +238 -0
  1106. data/lib/purecloudplatformclientv2/models/change.rb +212 -0
  1107. data/lib/purecloudplatformclientv2/models/channel.rb +188 -0
  1108. data/lib/purecloudplatformclientv2/models/channel_entity_listing.rb +180 -0
  1109. data/lib/purecloudplatformclientv2/models/channel_topic.rb +189 -0
  1110. data/lib/purecloudplatformclientv2/models/channel_topic_entity_listing.rb +180 -0
  1111. data/lib/purecloudplatformclientv2/models/chat.rb +178 -0
  1112. data/lib/purecloudplatformclientv2/models/chat_conversation.rb +222 -0
  1113. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +261 -0
  1114. data/lib/purecloudplatformclientv2/models/chat_conversation_notification.rb +209 -0
  1115. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_chat_media_participant.rb +447 -0
  1116. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_detail.rb +205 -0
  1117. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_error_body.rb +265 -0
  1118. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_error_info.rb +265 -0
  1119. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_participants.rb +447 -0
  1120. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_uri_reference.rb +187 -0
  1121. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_wrapup.rb +225 -0
  1122. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +473 -0
  1123. data/lib/purecloudplatformclientv2/models/chat_media_policy.rb +189 -0
  1124. data/lib/purecloudplatformclientv2/models/chat_media_policy_conditions.rb +231 -0
  1125. data/lib/purecloudplatformclientv2/models/chat_message.rb +250 -0
  1126. data/lib/purecloudplatformclientv2/models/chat_message_user.rb +216 -0
  1127. data/lib/purecloudplatformclientv2/models/cobrowse_conversation.rb +222 -0
  1128. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +261 -0
  1129. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification.rb +209 -0
  1130. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +485 -0
  1131. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_detail.rb +205 -0
  1132. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_error_body.rb +265 -0
  1133. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_error_info.rb +265 -0
  1134. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_participants.rb +485 -0
  1135. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_uri_reference.rb +187 -0
  1136. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_wrapup.rb +225 -0
  1137. data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +515 -0
  1138. data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +331 -0
  1139. data/lib/purecloudplatformclientv2/models/command_status.rb +272 -0
  1140. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +261 -0
  1141. data/lib/purecloudplatformclientv2/models/condition.rb +283 -0
  1142. data/lib/purecloudplatformclientv2/models/connect_rate.rb +199 -0
  1143. data/lib/purecloudplatformclientv2/models/consult_transfer.rb +207 -0
  1144. data/lib/purecloudplatformclientv2/models/consult_transfer_response.rb +183 -0
  1145. data/lib/purecloudplatformclientv2/models/consult_transfer_update.rb +197 -0
  1146. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +261 -0
  1147. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +261 -0
  1148. data/lib/purecloudplatformclientv2/models/contact.rb +235 -0
  1149. data/lib/purecloudplatformclientv2/models/contact_address.rb +223 -0
  1150. data/lib/purecloudplatformclientv2/models/contact_callback_request.rb +239 -0
  1151. data/lib/purecloudplatformclientv2/models/contact_list.rb +312 -0
  1152. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +261 -0
  1153. data/lib/purecloudplatformclientv2/models/contact_list_notification.rb +292 -0
  1154. data/lib/purecloudplatformclientv2/models/contact_list_notification_contact_phone_number_column.rb +205 -0
  1155. data/lib/purecloudplatformclientv2/models/contact_list_notification_import_status.rb +237 -0
  1156. data/lib/purecloudplatformclientv2/models/contact_list_notification_phone_columns.rb +205 -0
  1157. data/lib/purecloudplatformclientv2/models/contact_list_notification_uri_reference.rb +187 -0
  1158. data/lib/purecloudplatformclientv2/models/contact_listing.rb +261 -0
  1159. data/lib/purecloudplatformclientv2/models/contact_phone_number_column.rb +207 -0
  1160. data/lib/purecloudplatformclientv2/models/contact_sort.rb +212 -0
  1161. data/lib/purecloudplatformclientv2/models/content_attribute_filter_item.rb +212 -0
  1162. data/lib/purecloudplatformclientv2/models/content_facet_filter_item.rb +235 -0
  1163. data/lib/purecloudplatformclientv2/models/content_filter_item.rb +235 -0
  1164. data/lib/purecloudplatformclientv2/models/content_query_request.rb +249 -0
  1165. data/lib/purecloudplatformclientv2/models/content_sort_item.rb +187 -0
  1166. data/lib/purecloudplatformclientv2/models/conversation.rb +318 -0
  1167. data/lib/purecloudplatformclientv2/models/conversation_association.rb +225 -0
  1168. data/lib/purecloudplatformclientv2/models/conversation_basic.rb +233 -0
  1169. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +333 -0
  1170. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +261 -0
  1171. data/lib/purecloudplatformclientv2/models/conversation_notification.rb +216 -0
  1172. data/lib/purecloudplatformclientv2/models/conversation_notification_address.rb +223 -0
  1173. data/lib/purecloudplatformclientv2/models/conversation_notification_call.rb +407 -0
  1174. data/lib/purecloudplatformclientv2/models/conversation_notification_callback.rb +375 -0
  1175. data/lib/purecloudplatformclientv2/models/conversation_notification_callbacks.rb +375 -0
  1176. data/lib/purecloudplatformclientv2/models/conversation_notification_calls.rb +407 -0
  1177. data/lib/purecloudplatformclientv2/models/conversation_notification_chat.rb +287 -0
  1178. data/lib/purecloudplatformclientv2/models/conversation_notification_chats.rb +287 -0
  1179. data/lib/purecloudplatformclientv2/models/conversation_notification_cobrowse.rb +325 -0
  1180. data/lib/purecloudplatformclientv2/models/conversation_notification_cobrowsesessions.rb +325 -0
  1181. data/lib/purecloudplatformclientv2/models/conversation_notification_dialer_preview.rb +225 -0
  1182. data/lib/purecloudplatformclientv2/models/conversation_notification_disconnect_reason.rb +210 -0
  1183. data/lib/purecloudplatformclientv2/models/conversation_notification_disconnect_reasons.rb +210 -0
  1184. data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +305 -0
  1185. data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +305 -0
  1186. data/lib/purecloudplatformclientv2/models/conversation_notification_error_details.rb +243 -0
  1187. data/lib/purecloudplatformclientv2/models/conversation_notification_error_info.rb +243 -0
  1188. data/lib/purecloudplatformclientv2/models/conversation_notification_fax_status.rb +241 -0
  1189. data/lib/purecloudplatformclientv2/models/conversation_notification_participant.rb +439 -0
  1190. data/lib/purecloudplatformclientv2/models/conversation_notification_participants.rb +439 -0
  1191. data/lib/purecloudplatformclientv2/models/conversation_notification_phone_number_column.rb +196 -0
  1192. data/lib/purecloudplatformclientv2/models/conversation_notification_screenshare.rb +287 -0
  1193. data/lib/purecloudplatformclientv2/models/conversation_notification_screenshares.rb +287 -0
  1194. data/lib/purecloudplatformclientv2/models/conversation_notification_self.rb +223 -0
  1195. data/lib/purecloudplatformclientv2/models/conversation_notification_social_expression.rb +323 -0
  1196. data/lib/purecloudplatformclientv2/models/conversation_notification_social_expressions.rb +323 -0
  1197. data/lib/purecloudplatformclientv2/models/conversation_notification_video.rb +305 -0
  1198. data/lib/purecloudplatformclientv2/models/conversation_notification_videos.rb +305 -0
  1199. data/lib/purecloudplatformclientv2/models/conversation_notification_wrapup.rb +225 -0
  1200. data/lib/purecloudplatformclientv2/models/conversation_query.rb +285 -0
  1201. data/lib/purecloudplatformclientv2/models/copy_voicemail_message.rb +204 -0
  1202. data/lib/purecloudplatformclientv2/models/cover_sheet.rb +189 -0
  1203. data/lib/purecloudplatformclientv2/models/create_call_request.rb +265 -0
  1204. data/lib/purecloudplatformclientv2/models/create_call_response.rb +198 -0
  1205. data/lib/purecloudplatformclientv2/models/create_callback_command.rb +257 -0
  1206. data/lib/purecloudplatformclientv2/models/create_callback_response.rb +199 -0
  1207. data/lib/purecloudplatformclientv2/models/create_email_request.rb +315 -0
  1208. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +433 -0
  1209. data/lib/purecloudplatformclientv2/models/create_share_request.rb +255 -0
  1210. data/lib/purecloudplatformclientv2/models/create_share_request_member.rb +201 -0
  1211. data/lib/purecloudplatformclientv2/models/create_share_response.rb +302 -0
  1212. data/lib/purecloudplatformclientv2/models/create_user.rb +241 -0
  1213. data/lib/purecloudplatformclientv2/models/create_web_chat_request.rb +251 -0
  1214. data/lib/purecloudplatformclientv2/models/current_user_schedule_request_body.rb +198 -0
  1215. data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +234 -0
  1216. data/lib/purecloudplatformclientv2/models/default_greeting_list.rb +279 -0
  1217. data/lib/purecloudplatformclientv2/models/delete_retention.rb +178 -0
  1218. data/lib/purecloudplatformclientv2/models/dependency.rb +248 -0
  1219. data/lib/purecloudplatformclientv2/models/dependency_object.rb +270 -0
  1220. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +261 -0
  1221. data/lib/purecloudplatformclientv2/models/dependency_status.rb +270 -0
  1222. data/lib/purecloudplatformclientv2/models/dependency_type.rb +207 -0
  1223. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +261 -0
  1224. data/lib/purecloudplatformclientv2/models/destination.rb +210 -0
  1225. data/lib/purecloudplatformclientv2/models/detail.rb +205 -0
  1226. data/lib/purecloudplatformclientv2/models/dialer_action.rb +261 -0
  1227. data/lib/purecloudplatformclientv2/models/dialer_audit_request.rb +215 -0
  1228. data/lib/purecloudplatformclientv2/models/dialer_contact.rb +258 -0
  1229. data/lib/purecloudplatformclientv2/models/dialer_preview.rb +220 -0
  1230. data/lib/purecloudplatformclientv2/models/dialer_rule.rb +259 -0
  1231. data/lib/purecloudplatformclientv2/models/did.rb +351 -0
  1232. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +261 -0
  1233. data/lib/purecloudplatformclientv2/models/did_pool.rb +361 -0
  1234. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +261 -0
  1235. data/lib/purecloudplatformclientv2/models/digit_length.rb +187 -0
  1236. data/lib/purecloudplatformclientv2/models/disconnect_reason.rb +213 -0
  1237. data/lib/purecloudplatformclientv2/models/dnc_list.rb +309 -0
  1238. data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +309 -0
  1239. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +261 -0
  1240. data/lib/purecloudplatformclientv2/models/dnc_list_notification.rb +293 -0
  1241. data/lib/purecloudplatformclientv2/models/dnc_list_notification_import_status.rb +237 -0
  1242. data/lib/purecloudplatformclientv2/models/document.rb +506 -0
  1243. data/lib/purecloudplatformclientv2/models/document_attribute.rb +189 -0
  1244. data/lib/purecloudplatformclientv2/models/document_audit.rb +374 -0
  1245. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +261 -0
  1246. data/lib/purecloudplatformclientv2/models/document_data_v2_notification.rb +295 -0
  1247. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_created_by.rb +187 -0
  1248. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_lock_data.rb +196 -0
  1249. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_lock_info.rb +196 -0
  1250. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_user_data.rb +187 -0
  1251. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_workspace.rb +178 -0
  1252. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_workspace_data.rb +178 -0
  1253. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +261 -0
  1254. data/lib/purecloudplatformclientv2/models/document_thumbnail.rb +205 -0
  1255. data/lib/purecloudplatformclientv2/models/document_update.rb +267 -0
  1256. data/lib/purecloudplatformclientv2/models/document_upload.rb +219 -0
  1257. data/lib/purecloudplatformclientv2/models/documentation_result.rb +393 -0
  1258. data/lib/purecloudplatformclientv2/models/documentation_search_criteria.rb +287 -0
  1259. data/lib/purecloudplatformclientv2/models/documentation_search_request.rb +234 -0
  1260. data/lib/purecloudplatformclientv2/models/documentation_search_response.rb +287 -0
  1261. data/lib/purecloudplatformclientv2/models/domain_capabilities.rb +229 -0
  1262. data/lib/purecloudplatformclientv2/models/domain_certificate_authority.rb +371 -0
  1263. data/lib/purecloudplatformclientv2/models/domain_edge_software_update_dto.rb +281 -0
  1264. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +244 -0
  1265. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +261 -0
  1266. data/lib/purecloudplatformclientv2/models/domain_entity.rb +198 -0
  1267. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +261 -0
  1268. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +261 -0
  1269. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +261 -0
  1270. data/lib/purecloudplatformclientv2/models/domain_logical_interface.rb +552 -0
  1271. data/lib/purecloudplatformclientv2/models/domain_network_address.rb +237 -0
  1272. data/lib/purecloudplatformclientv2/models/domain_network_command_response.rb +205 -0
  1273. data/lib/purecloudplatformclientv2/models/domain_network_route.rb +233 -0
  1274. data/lib/purecloudplatformclientv2/models/domain_org_role_difference.rb +220 -0
  1275. data/lib/purecloudplatformclientv2/models/domain_organization_product.rb +178 -0
  1276. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +275 -0
  1277. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +280 -0
  1278. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +280 -0
  1279. data/lib/purecloudplatformclientv2/models/domain_permission.rb +214 -0
  1280. data/lib/purecloudplatformclientv2/models/domain_permission_collection.rb +218 -0
  1281. data/lib/purecloudplatformclientv2/models/domain_permission_policy.rb +245 -0
  1282. data/lib/purecloudplatformclientv2/models/domain_physical_capabilities.rb +187 -0
  1283. data/lib/purecloudplatformclientv2/models/domain_physical_interface.rb +345 -0
  1284. data/lib/purecloudplatformclientv2/models/domain_resource_condition_node.rb +246 -0
  1285. data/lib/purecloudplatformclientv2/models/domain_resource_condition_value.rb +219 -0
  1286. data/lib/purecloudplatformclientv2/models/domain_role.rb +189 -0
  1287. data/lib/purecloudplatformclientv2/models/domain_schema_reference.rb +300 -0
  1288. data/lib/purecloudplatformclientv2/models/download_response.rb +198 -0
  1289. data/lib/purecloudplatformclientv2/models/duration_condition.rb +210 -0
  1290. data/lib/purecloudplatformclientv2/models/edge.rb +594 -0
  1291. data/lib/purecloudplatformclientv2/models/edge_auto_update_config.rb +207 -0
  1292. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +261 -0
  1293. data/lib/purecloudplatformclientv2/models/edge_group.rb +340 -0
  1294. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +261 -0
  1295. data/lib/purecloudplatformclientv2/models/edge_interface.rb +245 -0
  1296. data/lib/purecloudplatformclientv2/models/edge_line.rb +388 -0
  1297. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +261 -0
  1298. data/lib/purecloudplatformclientv2/models/edge_logs_job.rb +312 -0
  1299. data/lib/purecloudplatformclientv2/models/edge_logs_job_file.rb +374 -0
  1300. data/lib/purecloudplatformclientv2/models/edge_logs_job_request.rb +199 -0
  1301. data/lib/purecloudplatformclientv2/models/edge_logs_job_response.rb +300 -0
  1302. data/lib/purecloudplatformclientv2/models/edge_logs_job_upload_request.rb +185 -0
  1303. data/lib/purecloudplatformclientv2/models/edge_reboot_parameters.rb +179 -0
  1304. data/lib/purecloudplatformclientv2/models/edge_service_state_request.rb +193 -0
  1305. data/lib/purecloudplatformclientv2/models/edge_trunk_base.rb +353 -0
  1306. data/lib/purecloudplatformclientv2/models/edge_version_information.rb +178 -0
  1307. data/lib/purecloudplatformclientv2/models/edge_version_report.rb +187 -0
  1308. data/lib/purecloudplatformclientv2/models/email.rb +352 -0
  1309. data/lib/purecloudplatformclientv2/models/email_address.rb +187 -0
  1310. data/lib/purecloudplatformclientv2/models/email_attachment.rb +214 -0
  1311. data/lib/purecloudplatformclientv2/models/email_conversation.rb +222 -0
  1312. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +261 -0
  1313. data/lib/purecloudplatformclientv2/models/email_conversation_notification.rb +209 -0
  1314. data/lib/purecloudplatformclientv2/models/email_conversation_notification_detail.rb +205 -0
  1315. data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +456 -0
  1316. data/lib/purecloudplatformclientv2/models/email_conversation_notification_error_body.rb +265 -0
  1317. data/lib/purecloudplatformclientv2/models/email_conversation_notification_error_info.rb +265 -0
  1318. data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +456 -0
  1319. data/lib/purecloudplatformclientv2/models/email_conversation_notification_uri_reference.rb +187 -0
  1320. data/lib/purecloudplatformclientv2/models/email_conversation_notification_wrapup.rb +225 -0
  1321. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +483 -0
  1322. data/lib/purecloudplatformclientv2/models/email_media_policy.rb +189 -0
  1323. data/lib/purecloudplatformclientv2/models/email_media_policy_conditions.rb +222 -0
  1324. data/lib/purecloudplatformclientv2/models/email_message.rb +308 -0
  1325. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +261 -0
  1326. data/lib/purecloudplatformclientv2/models/email_setup.rb +179 -0
  1327. data/lib/purecloudplatformclientv2/models/empty.rb +169 -0
  1328. data/lib/purecloudplatformclientv2/models/encryption_key.rb +228 -0
  1329. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +261 -0
  1330. data/lib/purecloudplatformclientv2/models/endpoint.rb +363 -0
  1331. data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +261 -0
  1332. data/lib/purecloudplatformclientv2/models/entry.rb +189 -0
  1333. data/lib/purecloudplatformclientv2/models/error_body.rb +265 -0
  1334. data/lib/purecloudplatformclientv2/models/error_details.rb +243 -0
  1335. data/lib/purecloudplatformclientv2/models/estimated_wait_time_predictions.rb +185 -0
  1336. data/lib/purecloudplatformclientv2/models/evaluation.rb +387 -0
  1337. data/lib/purecloudplatformclientv2/models/evaluation_assignment.rb +187 -0
  1338. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +261 -0
  1339. data/lib/purecloudplatformclientv2/models/evaluation_form.rb +270 -0
  1340. data/lib/purecloudplatformclientv2/models/evaluation_form_and_scoring_set.rb +187 -0
  1341. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +261 -0
  1342. data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +225 -0
  1343. data/lib/purecloudplatformclientv2/models/evaluator_activity.rb +261 -0
  1344. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +261 -0
  1345. data/lib/purecloudplatformclientv2/models/expansion_criterium.rb +201 -0
  1346. data/lib/purecloudplatformclientv2/models/export_uri.rb +188 -0
  1347. data/lib/purecloudplatformclientv2/models/export_uri_notification.rb +196 -0
  1348. data/lib/purecloudplatformclientv2/models/extension.rb +351 -0
  1349. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +261 -0
  1350. data/lib/purecloudplatformclientv2/models/extension_pool.rb +320 -0
  1351. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +261 -0
  1352. data/lib/purecloudplatformclientv2/models/external_contact.rb +366 -0
  1353. data/lib/purecloudplatformclientv2/models/external_data_source.rb +204 -0
  1354. data/lib/purecloudplatformclientv2/models/external_organization.rb +349 -0
  1355. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +261 -0
  1356. data/lib/purecloudplatformclientv2/models/facet_entry.rb +257 -0
  1357. data/lib/purecloudplatformclientv2/models/facet_info.rb +191 -0
  1358. data/lib/purecloudplatformclientv2/models/facet_key_attribute.rb +196 -0
  1359. data/lib/purecloudplatformclientv2/models/facet_statistics.rb +234 -0
  1360. data/lib/purecloudplatformclientv2/models/facet_term.rb +224 -0
  1361. data/lib/purecloudplatformclientv2/models/failed_object.rb +205 -0
  1362. data/lib/purecloudplatformclientv2/models/fax_data_v2_notification.rb +322 -0
  1363. data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_lock_data.rb +196 -0
  1364. data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_lock_info.rb +196 -0
  1365. data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_user_data.rb +187 -0
  1366. data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_workspace_data.rb +178 -0
  1367. data/lib/purecloudplatformclientv2/models/fax_document.rb +337 -0
  1368. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +261 -0
  1369. data/lib/purecloudplatformclientv2/models/fax_send_request.rb +278 -0
  1370. data/lib/purecloudplatformclientv2/models/fax_send_response.rb +230 -0
  1371. data/lib/purecloudplatformclientv2/models/fax_status.rb +249 -0
  1372. data/lib/purecloudplatformclientv2/models/fax_summary.rb +196 -0
  1373. data/lib/purecloudplatformclientv2/models/feature_state.rb +178 -0
  1374. data/lib/purecloudplatformclientv2/models/field_config.rb +259 -0
  1375. data/lib/purecloudplatformclientv2/models/field_configs.rb +205 -0
  1376. data/lib/purecloudplatformclientv2/models/field_list.rb +254 -0
  1377. data/lib/purecloudplatformclientv2/models/flow.rb +336 -0
  1378. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +261 -0
  1379. data/lib/purecloudplatformclientv2/models/flow_version.rb +293 -0
  1380. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +261 -0
  1381. data/lib/purecloudplatformclientv2/models/g_suite.rb +243 -0
  1382. data/lib/purecloudplatformclientv2/models/geolocation.rb +274 -0
  1383. data/lib/purecloudplatformclientv2/models/geolocation_notification.rb +214 -0
  1384. data/lib/purecloudplatformclientv2/models/geolocation_settings.rb +216 -0
  1385. data/lib/purecloudplatformclientv2/models/greeting.rb +324 -0
  1386. data/lib/purecloudplatformclientv2/models/greeting_audio_file.rb +196 -0
  1387. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +261 -0
  1388. data/lib/purecloudplatformclientv2/models/greeting_media_info.rb +197 -0
  1389. data/lib/purecloudplatformclientv2/models/greeting_owner.rb +198 -0
  1390. data/lib/purecloudplatformclientv2/models/group.rb +358 -0
  1391. data/lib/purecloudplatformclientv2/models/group_contact.rb +249 -0
  1392. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +261 -0
  1393. data/lib/purecloudplatformclientv2/models/group_members_update.rb +199 -0
  1394. data/lib/purecloudplatformclientv2/models/group_search_criteria.rb +287 -0
  1395. data/lib/purecloudplatformclientv2/models/group_search_request.rb +234 -0
  1396. data/lib/purecloudplatformclientv2/models/group_update.rb +302 -0
  1397. data/lib/purecloudplatformclientv2/models/groups_search_response.rb +287 -0
  1398. data/lib/purecloudplatformclientv2/models/heart_beat_alert.rb +338 -0
  1399. data/lib/purecloudplatformclientv2/models/heart_beat_alert_container.rb +261 -0
  1400. data/lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb +277 -0
  1401. data/lib/purecloudplatformclientv2/models/heart_beat_alert_notification_notification_user.rb +187 -0
  1402. data/lib/purecloudplatformclientv2/models/heart_beat_alert_notification_notification_users.rb +187 -0
  1403. data/lib/purecloudplatformclientv2/models/heart_beat_rule.rb +315 -0
  1404. data/lib/purecloudplatformclientv2/models/heart_beat_rule_container.rb +261 -0
  1405. data/lib/purecloudplatformclientv2/models/heart_beat_rule_notification.rb +268 -0
  1406. data/lib/purecloudplatformclientv2/models/heart_beat_rule_notification_notification_user.rb +187 -0
  1407. data/lib/purecloudplatformclientv2/models/identity_now.rb +243 -0
  1408. data/lib/purecloudplatformclientv2/models/import_status.rb +249 -0
  1409. data/lib/purecloudplatformclientv2/models/import_status_notification.rb +237 -0
  1410. data/lib/purecloudplatformclientv2/models/inbound_domain.rb +236 -0
  1411. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +261 -0
  1412. data/lib/purecloudplatformclientv2/models/inbound_route.rb +292 -0
  1413. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +261 -0
  1414. data/lib/purecloudplatformclientv2/models/initiate_screen_recording.rb +196 -0
  1415. data/lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb +387 -0
  1416. data/lib/purecloudplatformclientv2/models/interaction_stat_alert_notification_notification_user.rb +187 -0
  1417. data/lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb +369 -0
  1418. data/lib/purecloudplatformclientv2/models/interaction_stat_rule_notification_notification_user.rb +187 -0
  1419. data/lib/purecloudplatformclientv2/models/interaction_stats_alert.rb +464 -0
  1420. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +261 -0
  1421. data/lib/purecloudplatformclientv2/models/interaction_stats_rule.rb +427 -0
  1422. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +261 -0
  1423. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification.rb +238 -0
  1424. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_forecast_data_per_interval.rb +196 -0
  1425. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_historical_agent_data_per_interval.rb +187 -0
  1426. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_historical_queue_data_per_interval.rb +241 -0
  1427. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +258 -0
  1428. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +258 -0
  1429. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_forecast_data.rb +196 -0
  1430. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_historical_agent_data.rb +187 -0
  1431. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_historical_queue_data.rb +241 -0
  1432. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_metric.rb +201 -0
  1433. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_performance_prediction_agent_data.rb +178 -0
  1434. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_performance_prediction_queue_data.rb +196 -0
  1435. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_schedule_data.rb +187 -0
  1436. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_metrics.rb +201 -0
  1437. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_performance_prediction_agent_data_per_interval.rb +178 -0
  1438. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_performance_prediction_queue_data_per_interval.rb +196 -0
  1439. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_schedule_data_per_interval.rb +187 -0
  1440. data/lib/purecloudplatformclientv2/models/json_node.rb +372 -0
  1441. data/lib/purecloudplatformclientv2/models/json_node_search_response.rb +294 -0
  1442. data/lib/purecloudplatformclientv2/models/json_schema_document.rb +237 -0
  1443. data/lib/purecloudplatformclientv2/models/key_rotation_schedule.rb +226 -0
  1444. data/lib/purecloudplatformclientv2/models/keyword.rb +319 -0
  1445. data/lib/purecloudplatformclientv2/models/keyword_set.rb +275 -0
  1446. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +261 -0
  1447. data/lib/purecloudplatformclientv2/models/language.rb +245 -0
  1448. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +261 -0
  1449. data/lib/purecloudplatformclientv2/models/library.rb +231 -0
  1450. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +261 -0
  1451. data/lib/purecloudplatformclientv2/models/license_assignment_request.rb +215 -0
  1452. data/lib/purecloudplatformclientv2/models/license_batch_assignment_request.rb +185 -0
  1453. data/lib/purecloudplatformclientv2/models/license_definition.rb +218 -0
  1454. data/lib/purecloudplatformclientv2/models/license_definition_listing.rb +261 -0
  1455. data/lib/purecloudplatformclientv2/models/license_organization.rb +209 -0
  1456. data/lib/purecloudplatformclientv2/models/license_update_response.rb +180 -0
  1457. data/lib/purecloudplatformclientv2/models/license_update_status.rb +196 -0
  1458. data/lib/purecloudplatformclientv2/models/license_user.rb +200 -0
  1459. data/lib/purecloudplatformclientv2/models/line.rb +385 -0
  1460. data/lib/purecloudplatformclientv2/models/line_base.rb +320 -0
  1461. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +261 -0
  1462. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +261 -0
  1463. data/lib/purecloudplatformclientv2/models/line_status.rb +221 -0
  1464. data/lib/purecloudplatformclientv2/models/local_encryption_configuration.rb +240 -0
  1465. data/lib/purecloudplatformclientv2/models/local_encryption_configuration_listing.rb +198 -0
  1466. data/lib/purecloudplatformclientv2/models/local_encryption_key_request.rb +211 -0
  1467. data/lib/purecloudplatformclientv2/models/location.rb +216 -0
  1468. data/lib/purecloudplatformclientv2/models/location_address.rb +232 -0
  1469. data/lib/purecloudplatformclientv2/models/location_definition.rb +269 -0
  1470. data/lib/purecloudplatformclientv2/models/location_emergency_number.rb +211 -0
  1471. data/lib/purecloudplatformclientv2/models/location_search_criteria.rb +287 -0
  1472. data/lib/purecloudplatformclientv2/models/location_search_request.rb +234 -0
  1473. data/lib/purecloudplatformclientv2/models/locations_search_response.rb +287 -0
  1474. data/lib/purecloudplatformclientv2/models/lock_info.rb +221 -0
  1475. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +261 -0
  1476. data/lib/purecloudplatformclientv2/models/management_unit.rb +247 -0
  1477. data/lib/purecloudplatformclientv2/models/max_participants.rb +179 -0
  1478. data/lib/purecloudplatformclientv2/models/media_participant_request.rb +253 -0
  1479. data/lib/purecloudplatformclientv2/models/media_policies.rb +199 -0
  1480. data/lib/purecloudplatformclientv2/models/media_result.rb +189 -0
  1481. data/lib/purecloudplatformclientv2/models/media_setting.rb +187 -0
  1482. data/lib/purecloudplatformclientv2/models/media_summary.rb +187 -0
  1483. data/lib/purecloudplatformclientv2/models/media_summary_detail.rb +187 -0
  1484. data/lib/purecloudplatformclientv2/models/member_entity.rb +178 -0
  1485. data/lib/purecloudplatformclientv2/models/meta_data.rb +198 -0
  1486. data/lib/purecloudplatformclientv2/models/metabase.rb +300 -0
  1487. data/lib/purecloudplatformclientv2/models/metered_evaluation_assignment.rb +225 -0
  1488. data/lib/purecloudplatformclientv2/models/note.rb +253 -0
  1489. data/lib/purecloudplatformclientv2/models/note_listing.rb +261 -0
  1490. data/lib/purecloudplatformclientv2/models/number.rb +187 -0
  1491. data/lib/purecloudplatformclientv2/models/number_plan.rb +365 -0
  1492. data/lib/purecloudplatformclientv2/models/numeric_range.rb +209 -0
  1493. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +284 -0
  1494. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +261 -0
  1495. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +256 -0
  1496. data/lib/purecloudplatformclientv2/models/o_auth_provider.rb +207 -0
  1497. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +261 -0
  1498. data/lib/purecloudplatformclientv2/models/observation_data_container.rb +192 -0
  1499. data/lib/purecloudplatformclientv2/models/observation_query.rb +195 -0
  1500. data/lib/purecloudplatformclientv2/models/observation_query_response.rb +180 -0
  1501. data/lib/purecloudplatformclientv2/models/okta.rb +234 -0
  1502. data/lib/purecloudplatformclientv2/models/one_login.rb +234 -0
  1503. data/lib/purecloudplatformclientv2/models/operation.rb +284 -0
  1504. data/lib/purecloudplatformclientv2/models/org_media_utilization.rb +201 -0
  1505. data/lib/purecloudplatformclientv2/models/organization.rb +314 -0
  1506. data/lib/purecloudplatformclientv2/models/organization_features.rb +286 -0
  1507. data/lib/purecloudplatformclientv2/models/organization_presence.rb +279 -0
  1508. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +261 -0
  1509. data/lib/purecloudplatformclientv2/models/organization_product_entity_listing.rb +216 -0
  1510. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +261 -0
  1511. data/lib/purecloudplatformclientv2/models/orphan_recording.rb +338 -0
  1512. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +261 -0
  1513. data/lib/purecloudplatformclientv2/models/orphan_update_request.rb +199 -0
  1514. data/lib/purecloudplatformclientv2/models/out_of_office.rb +236 -0
  1515. data/lib/purecloudplatformclientv2/models/out_of_office_notification.rb +214 -0
  1516. data/lib/purecloudplatformclientv2/models/out_of_office_notification_user.rb +178 -0
  1517. data/lib/purecloudplatformclientv2/models/outbound_route.rb +380 -0
  1518. data/lib/purecloudplatformclientv2/models/outbound_route_base.rb +360 -0
  1519. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +261 -0
  1520. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +261 -0
  1521. data/lib/purecloudplatformclientv2/models/page.rb +249 -0
  1522. data/lib/purecloudplatformclientv2/models/paging_spec.rb +197 -0
  1523. data/lib/purecloudplatformclientv2/models/parameter.rb +233 -0
  1524. data/lib/purecloudplatformclientv2/models/parsed_certificate.rb +182 -0
  1525. data/lib/purecloudplatformclientv2/models/participant.rb +554 -0
  1526. data/lib/purecloudplatformclientv2/models/participant_attributes.rb +181 -0
  1527. data/lib/purecloudplatformclientv2/models/participant_basic.rb +554 -0
  1528. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +261 -0
  1529. data/lib/purecloudplatformclientv2/models/permissions.rb +204 -0
  1530. data/lib/purecloudplatformclientv2/models/phone.rb +440 -0
  1531. data/lib/purecloudplatformclientv2/models/phone_base.rb +350 -0
  1532. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +261 -0
  1533. data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +223 -0
  1534. data/lib/purecloudplatformclientv2/models/phone_column.rb +197 -0
  1535. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +261 -0
  1536. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +261 -0
  1537. data/lib/purecloudplatformclientv2/models/phone_number.rb +223 -0
  1538. data/lib/purecloudplatformclientv2/models/phone_number_column.rb +187 -0
  1539. data/lib/purecloudplatformclientv2/models/phone_number_status.rb +179 -0
  1540. data/lib/purecloudplatformclientv2/models/phone_status.rb +312 -0
  1541. data/lib/purecloudplatformclientv2/models/phones_reboot.rb +191 -0
  1542. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +261 -0
  1543. data/lib/purecloudplatformclientv2/models/pin_configuration.rb +187 -0
  1544. data/lib/purecloudplatformclientv2/models/ping_identity.rb +243 -0
  1545. data/lib/purecloudplatformclientv2/models/policy.rb +284 -0
  1546. data/lib/purecloudplatformclientv2/models/policy_actions.rb +250 -0
  1547. data/lib/purecloudplatformclientv2/models/policy_conditions.rb +253 -0
  1548. data/lib/purecloudplatformclientv2/models/policy_create.rb +289 -0
  1549. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +261 -0
  1550. data/lib/purecloudplatformclientv2/models/policy_error_message.rb +235 -0
  1551. data/lib/purecloudplatformclientv2/models/policy_errors.rb +180 -0
  1552. data/lib/purecloudplatformclientv2/models/prediction_results.rb +235 -0
  1553. data/lib/purecloudplatformclientv2/models/presence_query_response.rb +192 -0
  1554. data/lib/purecloudplatformclientv2/models/prompt.rb +232 -0
  1555. data/lib/purecloudplatformclientv2/models/prompt_asset.rb +281 -0
  1556. data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +286 -0
  1557. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +261 -0
  1558. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +261 -0
  1559. data/lib/purecloudplatformclientv2/models/property_index_request.rb +213 -0
  1560. data/lib/purecloudplatformclientv2/models/provision_info.rb +199 -0
  1561. data/lib/purecloudplatformclientv2/models/pure_cloud.rb +207 -0
  1562. data/lib/purecloudplatformclientv2/models/qualifier_mapping_observation_query_response.rb +192 -0
  1563. data/lib/purecloudplatformclientv2/models/quality_audit.rb +272 -0
  1564. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +261 -0
  1565. data/lib/purecloudplatformclientv2/models/query_facet_info.rb +191 -0
  1566. data/lib/purecloudplatformclientv2/models/query_request.rb +249 -0
  1567. data/lib/purecloudplatformclientv2/models/query_result.rb +207 -0
  1568. data/lib/purecloudplatformclientv2/models/query_results.rb +187 -0
  1569. data/lib/purecloudplatformclientv2/models/question.rb +279 -0
  1570. data/lib/purecloudplatformclientv2/models/question_group.rb +261 -0
  1571. data/lib/purecloudplatformclientv2/models/question_group_score.rb +270 -0
  1572. data/lib/purecloudplatformclientv2/models/question_score.rb +223 -0
  1573. data/lib/purecloudplatformclientv2/models/queue.rb +423 -0
  1574. data/lib/purecloudplatformclientv2/models/queue_email_address.rb +187 -0
  1575. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +261 -0
  1576. data/lib/purecloudplatformclientv2/models/queue_member.rb +243 -0
  1577. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +261 -0
  1578. data/lib/purecloudplatformclientv2/models/queue_member_notification.rb +205 -0
  1579. data/lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb +259 -0
  1580. data/lib/purecloudplatformclientv2/models/reaction.rb +210 -0
  1581. data/lib/purecloudplatformclientv2/models/recall_entry.rb +187 -0
  1582. data/lib/purecloudplatformclientv2/models/recording.rb +418 -0
  1583. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification.rb +322 -0
  1584. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_conversation_data.rb +178 -0
  1585. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_lock_data.rb +196 -0
  1586. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_lock_info.rb +196 -0
  1587. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_user_data.rb +187 -0
  1588. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_workspace_data.rb +178 -0
  1589. data/lib/purecloudplatformclientv2/models/recording_email_message.rb +268 -0
  1590. data/lib/purecloudplatformclientv2/models/recording_settings.rb +178 -0
  1591. data/lib/purecloudplatformclientv2/models/relationship.rb +252 -0
  1592. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +261 -0
  1593. data/lib/purecloudplatformclientv2/models/replace_request.rb +196 -0
  1594. data/lib/purecloudplatformclientv2/models/replace_response.rb +237 -0
  1595. data/lib/purecloudplatformclientv2/models/report_meta_data.rb +258 -0
  1596. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +261 -0
  1597. data/lib/purecloudplatformclientv2/models/report_run_entry.rb +285 -0
  1598. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +261 -0
  1599. data/lib/purecloudplatformclientv2/models/report_schedule.rb +340 -0
  1600. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +261 -0
  1601. data/lib/purecloudplatformclientv2/models/resource_condition_node.rb +246 -0
  1602. data/lib/purecloudplatformclientv2/models/resource_condition_value.rb +201 -0
  1603. data/lib/purecloudplatformclientv2/models/resource_permission_policy.rb +272 -0
  1604. data/lib/purecloudplatformclientv2/models/response.rb +307 -0
  1605. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +262 -0
  1606. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +261 -0
  1607. data/lib/purecloudplatformclientv2/models/response_filter.rb +228 -0
  1608. data/lib/purecloudplatformclientv2/models/response_query_request.rb +202 -0
  1609. data/lib/purecloudplatformclientv2/models/response_query_results.rb +184 -0
  1610. data/lib/purecloudplatformclientv2/models/response_set.rb +244 -0
  1611. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +261 -0
  1612. data/lib/purecloudplatformclientv2/models/response_set_notification.rb +234 -0
  1613. data/lib/purecloudplatformclientv2/models/response_set_notification_reaction.rb +219 -0
  1614. data/lib/purecloudplatformclientv2/models/response_set_notification_responses.rb +219 -0
  1615. data/lib/purecloudplatformclientv2/models/response_substitution.rb +204 -0
  1616. data/lib/purecloudplatformclientv2/models/response_text.rb +208 -0
  1617. data/lib/purecloudplatformclientv2/models/rest_error_detail.rb +193 -0
  1618. data/lib/purecloudplatformclientv2/models/retention_duration.rb +187 -0
  1619. data/lib/purecloudplatformclientv2/models/reverse_whitepages_lookup_result.rb +191 -0
  1620. data/lib/purecloudplatformclientv2/models/ring.rb +189 -0
  1621. data/lib/purecloudplatformclientv2/models/routing_data.rb +227 -0
  1622. data/lib/purecloudplatformclientv2/models/routing_skill.rb +247 -0
  1623. data/lib/purecloudplatformclientv2/models/routing_status.rb +213 -0
  1624. data/lib/purecloudplatformclientv2/models/routing_status_alert.rb +329 -0
  1625. data/lib/purecloudplatformclientv2/models/routing_status_alert_container.rb +261 -0
  1626. data/lib/purecloudplatformclientv2/models/routing_status_rule.rb +315 -0
  1627. data/lib/purecloudplatformclientv2/models/routing_status_rule_container.rb +261 -0
  1628. data/lib/purecloudplatformclientv2/models/rule_set.rb +264 -0
  1629. data/lib/purecloudplatformclientv2/models/rule_set_diagnostic.rb +191 -0
  1630. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +261 -0
  1631. data/lib/purecloudplatformclientv2/models/rule_set_notification.rb +252 -0
  1632. data/lib/purecloudplatformclientv2/models/rule_set_notification_action.rb +216 -0
  1633. data/lib/purecloudplatformclientv2/models/rule_set_notification_actions.rb +216 -0
  1634. data/lib/purecloudplatformclientv2/models/rule_set_notification_condition.rb +271 -0
  1635. data/lib/purecloudplatformclientv2/models/rule_set_notification_conditions.rb +271 -0
  1636. data/lib/purecloudplatformclientv2/models/rule_set_notification_rule.rb +250 -0
  1637. data/lib/purecloudplatformclientv2/models/rule_set_notification_rules.rb +250 -0
  1638. data/lib/purecloudplatformclientv2/models/rule_set_notification_uri_reference.rb +187 -0
  1639. data/lib/purecloudplatformclientv2/models/run_now_response.rb +198 -0
  1640. data/lib/purecloudplatformclientv2/models/salesforce.rb +234 -0
  1641. data/lib/purecloudplatformclientv2/models/schedule_interval.rb +189 -0
  1642. data/lib/purecloudplatformclientv2/models/schema_category.rb +300 -0
  1643. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +261 -0
  1644. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +261 -0
  1645. data/lib/purecloudplatformclientv2/models/screen_recording_session.rb +236 -0
  1646. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +261 -0
  1647. data/lib/purecloudplatformclientv2/models/screen_recording_session_request.rb +213 -0
  1648. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification.rb +209 -0
  1649. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_detail.rb +205 -0
  1650. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_error_body.rb +265 -0
  1651. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_error_info.rb +265 -0
  1652. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_participants.rb +465 -0
  1653. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_screen_share_media_participant.rb +465 -0
  1654. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_uri_reference.rb +187 -0
  1655. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_wrapup.rb +225 -0
  1656. data/lib/purecloudplatformclientv2/models/screenshare.rb +299 -0
  1657. data/lib/purecloudplatformclientv2/models/script.rb +303 -0
  1658. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +261 -0
  1659. data/lib/purecloudplatformclientv2/models/search_aggregation.rb +245 -0
  1660. data/lib/purecloudplatformclientv2/models/search_criteria.rb +282 -0
  1661. data/lib/purecloudplatformclientv2/models/search_request.rb +287 -0
  1662. data/lib/purecloudplatformclientv2/models/section.rb +207 -0
  1663. data/lib/purecloudplatformclientv2/models/security_profile.rb +209 -0
  1664. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +261 -0
  1665. data/lib/purecloudplatformclientv2/models/segment.rb +227 -0
  1666. data/lib/purecloudplatformclientv2/models/sequence_schedule.rb +272 -0
  1667. data/lib/purecloudplatformclientv2/models/sequence_schedule_notification.rb +252 -0
  1668. data/lib/purecloudplatformclientv2/models/sequence_schedule_notification_schedule_interval.rb +196 -0
  1669. data/lib/purecloudplatformclientv2/models/sequence_schedule_notification_uri_reference.rb +187 -0
  1670. data/lib/purecloudplatformclientv2/models/server_date.rb +179 -0
  1671. data/lib/purecloudplatformclientv2/models/service_context.rb +179 -0
  1672. data/lib/purecloudplatformclientv2/models/service_level.rb +187 -0
  1673. data/lib/purecloudplatformclientv2/models/share.rb +298 -0
  1674. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +261 -0
  1675. data/lib/purecloudplatformclientv2/models/shared_entity.rb +178 -0
  1676. data/lib/purecloudplatformclientv2/models/shared_response.rb +214 -0
  1677. data/lib/purecloudplatformclientv2/models/site.rb +399 -0
  1678. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +261 -0
  1679. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +261 -0
  1680. data/lib/purecloudplatformclientv2/models/skills_to_remove.rb +196 -0
  1681. data/lib/purecloudplatformclientv2/models/social_conversation_notification.rb +209 -0
  1682. data/lib/purecloudplatformclientv2/models/social_conversation_notification_detail.rb +205 -0
  1683. data/lib/purecloudplatformclientv2/models/social_conversation_notification_error_body.rb +265 -0
  1684. data/lib/purecloudplatformclientv2/models/social_conversation_notification_error_info.rb +265 -0
  1685. data/lib/purecloudplatformclientv2/models/social_conversation_notification_participants.rb +474 -0
  1686. data/lib/purecloudplatformclientv2/models/social_conversation_notification_social_media_participant.rb +474 -0
  1687. data/lib/purecloudplatformclientv2/models/social_conversation_notification_uri_reference.rb +187 -0
  1688. data/lib/purecloudplatformclientv2/models/social_conversation_notification_wrapup.rb +225 -0
  1689. data/lib/purecloudplatformclientv2/models/social_expression.rb +339 -0
  1690. data/lib/purecloudplatformclientv2/models/sort_item.rb +187 -0
  1691. data/lib/purecloudplatformclientv2/models/station.rb +275 -0
  1692. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +261 -0
  1693. data/lib/purecloudplatformclientv2/models/statistical_response.rb +200 -0
  1694. data/lib/purecloudplatformclientv2/models/statistical_summary.rb +250 -0
  1695. data/lib/purecloudplatformclientv2/models/street_address.rb +256 -0
  1696. data/lib/purecloudplatformclientv2/models/subscriber_response.rb +195 -0
  1697. data/lib/purecloudplatformclientv2/models/suggest_search_criteria.rb +259 -0
  1698. data/lib/purecloudplatformclientv2/models/suggest_search_request.rb +213 -0
  1699. data/lib/purecloudplatformclientv2/models/system_presence.rb +198 -0
  1700. data/lib/purecloudplatformclientv2/models/system_prompt.rb +218 -0
  1701. data/lib/purecloudplatformclientv2/models/system_prompt_asset.rb +309 -0
  1702. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +261 -0
  1703. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +261 -0
  1704. data/lib/purecloudplatformclientv2/models/tag_query_request.rb +196 -0
  1705. data/lib/purecloudplatformclientv2/models/tag_value.rb +223 -0
  1706. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +261 -0
  1707. data/lib/purecloudplatformclientv2/models/term_attribute.rb +210 -0
  1708. data/lib/purecloudplatformclientv2/models/ticker.rb +197 -0
  1709. data/lib/purecloudplatformclientv2/models/time_allowed.rb +198 -0
  1710. data/lib/purecloudplatformclientv2/models/time_interval.rb +187 -0
  1711. data/lib/purecloudplatformclientv2/models/time_off_request.rb +390 -0
  1712. data/lib/purecloudplatformclientv2/models/time_off_request_list.rb +209 -0
  1713. data/lib/purecloudplatformclientv2/models/time_off_request_patch.rb +178 -0
  1714. data/lib/purecloudplatformclientv2/models/time_off_request_update_notification.rb +331 -0
  1715. data/lib/purecloudplatformclientv2/models/time_off_request_update_notification_user.rb +178 -0
  1716. data/lib/purecloudplatformclientv2/models/time_slot.rb +199 -0
  1717. data/lib/purecloudplatformclientv2/models/time_zone.rb +207 -0
  1718. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +261 -0
  1719. data/lib/purecloudplatformclientv2/models/transfer_request.rb +219 -0
  1720. data/lib/purecloudplatformclientv2/models/trunk.rb +384 -0
  1721. data/lib/purecloudplatformclientv2/models/trunk_base.rb +363 -0
  1722. data/lib/purecloudplatformclientv2/models/trunk_base_assignment.rb +189 -0
  1723. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +261 -0
  1724. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +261 -0
  1725. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +261 -0
  1726. data/lib/purecloudplatformclientv2/models/trunk_recording_enabled_count.rb +189 -0
  1727. data/lib/purecloudplatformclientv2/models/twitter_id.rb +220 -0
  1728. data/lib/purecloudplatformclientv2/models/unread_metric.rb +179 -0
  1729. data/lib/purecloudplatformclientv2/models/unread_status.rb +179 -0
  1730. data/lib/purecloudplatformclientv2/models/uri_reference.rb +196 -0
  1731. data/lib/purecloudplatformclientv2/models/usage.rb +180 -0
  1732. data/lib/purecloudplatformclientv2/models/usage_item.rb +210 -0
  1733. data/lib/purecloudplatformclientv2/models/user.rb +431 -0
  1734. data/lib/purecloudplatformclientv2/models/user_agent_info.rb +199 -0
  1735. data/lib/purecloudplatformclientv2/models/user_authorization.rb +204 -0
  1736. data/lib/purecloudplatformclientv2/models/user_conversation_summary.rb +232 -0
  1737. data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification.rb +232 -0
  1738. data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_call.rb +187 -0
  1739. data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_call_contact_center.rb +187 -0
  1740. data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_media_summary.rb +187 -0
  1741. data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_media_summary_detail.rb +187 -0
  1742. data/lib/purecloudplatformclientv2/models/user_details_query.rb +273 -0
  1743. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +261 -0
  1744. data/lib/purecloudplatformclientv2/models/user_image.rb +188 -0
  1745. data/lib/purecloudplatformclientv2/models/user_list_schedule_request_body.rb +214 -0
  1746. data/lib/purecloudplatformclientv2/models/user_me.rb +565 -0
  1747. data/lib/purecloudplatformclientv2/models/user_param.rb +187 -0
  1748. data/lib/purecloudplatformclientv2/models/user_presence.rb +246 -0
  1749. data/lib/purecloudplatformclientv2/models/user_presence_alert.rb +352 -0
  1750. data/lib/purecloudplatformclientv2/models/user_presence_alert_container.rb +261 -0
  1751. data/lib/purecloudplatformclientv2/models/user_presence_notification.rb +205 -0
  1752. data/lib/purecloudplatformclientv2/models/user_presence_notification_organization_presence.rb +187 -0
  1753. data/lib/purecloudplatformclientv2/models/user_presence_notification_presence_definition.rb +187 -0
  1754. data/lib/purecloudplatformclientv2/models/user_presence_rule.rb +329 -0
  1755. data/lib/purecloudplatformclientv2/models/user_presence_rule_container.rb +261 -0
  1756. data/lib/purecloudplatformclientv2/models/user_queue.rb +432 -0
  1757. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +261 -0
  1758. data/lib/purecloudplatformclientv2/models/user_recording.rb +292 -0
  1759. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +261 -0
  1760. data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +243 -0
  1761. data/lib/purecloudplatformclientv2/models/user_routing_skill_post.rb +218 -0
  1762. data/lib/purecloudplatformclientv2/models/user_routing_status_notification.rb +178 -0
  1763. data/lib/purecloudplatformclientv2/models/user_routing_status_notification_routing_status.rb +201 -0
  1764. data/lib/purecloudplatformclientv2/models/user_schedule.rb +194 -0
  1765. data/lib/purecloudplatformclientv2/models/user_schedule_activity.rb +230 -0
  1766. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +392 -0
  1767. data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification.rb +273 -0
  1768. data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification_user.rb +178 -0
  1769. data/lib/purecloudplatformclientv2/models/user_schedule_container.rb +192 -0
  1770. data/lib/purecloudplatformclientv2/models/user_schedule_full_day_time_off_marker.rb +220 -0
  1771. data/lib/purecloudplatformclientv2/models/user_schedule_shift.rb +202 -0
  1772. data/lib/purecloudplatformclientv2/models/user_search_criteria.rb +287 -0
  1773. data/lib/purecloudplatformclientv2/models/user_search_request.rb +246 -0
  1774. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +261 -0
  1775. data/lib/purecloudplatformclientv2/models/user_station.rb +237 -0
  1776. data/lib/purecloudplatformclientv2/models/user_stations.rb +209 -0
  1777. data/lib/purecloudplatformclientv2/models/user_stations_notification.rb +178 -0
  1778. data/lib/purecloudplatformclientv2/models/user_stations_notification_associated_station.rb +196 -0
  1779. data/lib/purecloudplatformclientv2/models/user_stations_notification_user.rb +178 -0
  1780. data/lib/purecloudplatformclientv2/models/user_stations_notification_user_station.rb +196 -0
  1781. data/lib/purecloudplatformclientv2/models/users_search_response.rb +287 -0
  1782. data/lib/purecloudplatformclientv2/models/utilization.rb +181 -0
  1783. data/lib/purecloudplatformclientv2/models/validate_address_request.rb +179 -0
  1784. data/lib/purecloudplatformclientv2/models/validate_address_response.rb +193 -0
  1785. data/lib/purecloudplatformclientv2/models/video.rb +307 -0
  1786. data/lib/purecloudplatformclientv2/models/video_conversation_notification.rb +209 -0
  1787. data/lib/purecloudplatformclientv2/models/video_conversation_notification_detail.rb +205 -0
  1788. data/lib/purecloudplatformclientv2/models/video_conversation_notification_error_body.rb +265 -0
  1789. data/lib/purecloudplatformclientv2/models/video_conversation_notification_error_info.rb +265 -0
  1790. data/lib/purecloudplatformclientv2/models/video_conversation_notification_participants.rb +483 -0
  1791. data/lib/purecloudplatformclientv2/models/video_conversation_notification_uri_reference.rb +187 -0
  1792. data/lib/purecloudplatformclientv2/models/video_conversation_notification_video_media_participant.rb +483 -0
  1793. data/lib/purecloudplatformclientv2/models/video_conversation_notification_wrapup.rb +225 -0
  1794. data/lib/purecloudplatformclientv2/models/visibility_condition.rb +204 -0
  1795. data/lib/purecloudplatformclientv2/models/vm_pairing_info.rb +206 -0
  1796. data/lib/purecloudplatformclientv2/models/voicemail_copy_record.rb +199 -0
  1797. data/lib/purecloudplatformclientv2/models/voicemail_group_policy.rb +228 -0
  1798. data/lib/purecloudplatformclientv2/models/voicemail_mailbox_info.rb +229 -0
  1799. data/lib/purecloudplatformclientv2/models/voicemail_media_info.rb +197 -0
  1800. data/lib/purecloudplatformclientv2/models/voicemail_message.rb +341 -0
  1801. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +261 -0
  1802. data/lib/purecloudplatformclientv2/models/voicemail_message_notification.rb +277 -0
  1803. data/lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb +239 -0
  1804. data/lib/purecloudplatformclientv2/models/voicemail_search_criteria.rb +287 -0
  1805. data/lib/purecloudplatformclientv2/models/voicemail_search_request.rb +246 -0
  1806. data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +209 -0
  1807. data/lib/purecloudplatformclientv2/models/voicemails_search_response.rb +287 -0
  1808. data/lib/purecloudplatformclientv2/models/wfm_user_entity_listing.rb +180 -0
  1809. data/lib/purecloudplatformclientv2/models/workspace.rb +302 -0
  1810. data/lib/purecloudplatformclientv2/models/workspace_create.rb +201 -0
  1811. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +261 -0
  1812. data/lib/purecloudplatformclientv2/models/workspace_member.rb +271 -0
  1813. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +261 -0
  1814. data/lib/purecloudplatformclientv2/models/workspace_summary.rb +187 -0
  1815. data/lib/purecloudplatformclientv2/models/wrap_up_code_mapping.rb +252 -0
  1816. data/lib/purecloudplatformclientv2/models/wrap_up_code_mapping_notification.rb +236 -0
  1817. data/lib/purecloudplatformclientv2/models/wrapup.rb +241 -0
  1818. data/lib/purecloudplatformclientv2/models/wrapup_code.rb +241 -0
  1819. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +261 -0
  1820. data/lib/purecloudplatformclientv2/version.rb +19 -0
  1821. data/purecloudplatformclientv2.gemspec +32 -0
  1822. data/spec/api_client_spec.rb +273 -0
  1823. data/spec/configuration_spec.rb +25 -0
  1824. data/spec/spec_helper.rb +99 -0
  1825. metadata +2050 -0
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: PresenceQueryResponse
3
+ ---
4
+ ## PureCloud::PresenceQueryResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **system_to_organization_mappings** | **Hash<String, Array<String>>** | A mapping from system presence to a list of organization presence ids | [optional] |
11
+ | **results** | [**Array<AggregateDataContainer>**](AggregateDataContainer.html) | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
data/docs/Prompt.md ADDED
@@ -0,0 +1,18 @@
1
+ ---
2
+ title: Prompt
3
+ ---
4
+ ## PureCloud::Prompt
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | The prompt name. | |
12
+ | **description** | **String** | | [optional] |
13
+ | **resources** | [**Array<PromptAsset>**](PromptAsset.html) | | [optional] |
14
+ | **current_operation** | [**Operation**](Operation.html) | | [optional] |
15
+ | **self_uri** | **String** | The URI for this object | [optional] |
16
+ {: class="table table-striped"}
17
+
18
+
@@ -0,0 +1,24 @@
1
+ ---
2
+ title: PromptAsset
3
+ ---
4
+ ## PureCloud::PromptAsset
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **prompt_id** | **String** | | [optional] |
13
+ | **language** | **String** | | [optional] |
14
+ | **media_uri** | **String** | | [optional] |
15
+ | **tts_string** | **String** | | [optional] |
16
+ | **upload_status** | **String** | | [optional] |
17
+ | **upload_uri** | **String** | | [optional] |
18
+ | **language_default** | **BOOLEAN** | | [optional] |
19
+ | **tags** | **Hash<String, Array<String>>** | | [optional] |
20
+ | **duration_seconds** | **Float** | | [optional] |
21
+ | **self_uri** | **String** | The URI for this object | [optional] |
22
+ {: class="table table-striped"}
23
+
24
+
@@ -0,0 +1,24 @@
1
+ ---
2
+ title: PromptAssetCreate
3
+ ---
4
+ ## PureCloud::PromptAssetCreate
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **prompt_id** | **String** | | [optional] |
13
+ | **language** | **String** | The prompt language. | |
14
+ | **media_uri** | **String** | | [optional] |
15
+ | **tts_string** | **String** | | [optional] |
16
+ | **upload_status** | **String** | | [optional] |
17
+ | **upload_uri** | **String** | | [optional] |
18
+ | **language_default** | **BOOLEAN** | | [optional] |
19
+ | **tags** | **Hash<String, Array<String>>** | | [optional] |
20
+ | **duration_seconds** | **Float** | | [optional] |
21
+ | **self_uri** | **String** | The URI for this object | [optional] |
22
+ {: class="table table-striped"}
23
+
24
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: PromptAssetEntityListing
3
+ ---
4
+ ## PureCloud::PromptAssetEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<PromptAsset>**](PromptAsset.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: PromptEntityListing
3
+ ---
4
+ ## PureCloud::PromptEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<Prompt>**](Prompt.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: PropertyIndexRequest
3
+ ---
4
+ ## PureCloud::PropertyIndexRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **session_id** | **String** | Attach properties to a segment in the indicated session | |
11
+ | **target_date** | **DateTime** | Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
12
+ | **properties** | [**Array<AnalyticsProperty>**](AnalyticsProperty.html) | The list of properties to index | |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: ProvisionInfo
3
+ ---
4
+ ## PureCloud::ProvisionInfo
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **time** | **DateTime** | The time at which this phone was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
11
+ | **source** | **String** | The source of the provisioning | [optional] |
12
+ | **error_info** | **String** | The error information from the provision process, if any | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
data/docs/PureCloud.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: PureCloud
3
+ ---
4
+ ## PureCloud::PureCloud
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **disabled** | **BOOLEAN** | | [optional] |
13
+ | **self_uri** | **String** | The URI for this object | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: QualifierMappingObservationQueryResponse
3
+ ---
4
+ ## PureCloud::QualifierMappingObservationQueryResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **system_to_organization_mappings** | **Hash<String, Array<String>>** | A mapping from system presence to a list of organization presence ids | [optional] |
11
+ | **results** | [**Array<ObservationDataContainer>**](ObservationDataContainer.html) | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,2084 @@
1
+ ---
2
+ title: QualityApi
3
+ ---
4
+
5
+ ## PureCloud::QualityApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | Description
10
+ ------------- | ------------- | -------------
11
+ [**delete_quality_calibration**](QualityApi.html#delete_quality_calibration) | Delete a calibration by id.
12
+ [**delete_quality_conversation_evaluation**](QualityApi.html#delete_quality_conversation_evaluation) | Delete an evaluation
13
+ [**delete_quality_form**](QualityApi.html#delete_quality_form) | Delete an evaluation form.
14
+ [**delete_quality_keywordset**](QualityApi.html#delete_quality_keywordset) | Delete a keywordSet by id.
15
+ [**delete_quality_keywordsets**](QualityApi.html#delete_quality_keywordsets) | Delete keyword sets
16
+ [**get_quality_agents_activity**](QualityApi.html#get_quality_agents_activity) | Gets a list of Agent Activities
17
+ [**get_quality_calibration**](QualityApi.html#get_quality_calibration) | Get a calibration by id.
18
+ [**get_quality_calibrations**](QualityApi.html#get_quality_calibrations) | Get the list of calibrations
19
+ [**get_quality_conversation_audits**](QualityApi.html#get_quality_conversation_audits) | Get audits for conversation or recording
20
+ [**get_quality_conversation_evaluation**](QualityApi.html#get_quality_conversation_evaluation) | Get an evaluation
21
+ [**get_quality_evaluations_query**](QualityApi.html#get_quality_evaluations_query) | Queries Evaluations and returns a paged list
22
+ [**get_quality_evaluators_activity**](QualityApi.html#get_quality_evaluators_activity) | Get an evaluator activity
23
+ [**get_quality_form**](QualityApi.html#get_quality_form) | Get an evaluation form
24
+ [**get_quality_form_versions**](QualityApi.html#get_quality_form_versions) | Gets all the revisions for a specific evaluation.
25
+ [**get_quality_forms**](QualityApi.html#get_quality_forms) | Get the list of evaluation forms
26
+ [**get_quality_keywordset**](QualityApi.html#get_quality_keywordset) | Get a keywordSet by id.
27
+ [**get_quality_keywordsets**](QualityApi.html#get_quality_keywordsets) | Get the list of keyword sets
28
+ [**get_quality_publishedform**](QualityApi.html#get_quality_publishedform) | Get the published evaluation forms.
29
+ [**get_quality_publishedforms**](QualityApi.html#get_quality_publishedforms) | Get the published evaluation forms.
30
+ [**post_analytics_evaluations_aggregates_query**](QualityApi.html#post_analytics_evaluations_aggregates_query) | Query for evaluation aggregates
31
+ [**post_quality_calibrations**](QualityApi.html#post_quality_calibrations) | Create a calibration
32
+ [**post_quality_conversation_evaluations**](QualityApi.html#post_quality_conversation_evaluations) | Create an evaluation
33
+ [**post_quality_evaluations_scoring**](QualityApi.html#post_quality_evaluations_scoring) | Score evaluation
34
+ [**post_quality_forms**](QualityApi.html#post_quality_forms) | Create an evaluation form.
35
+ [**post_quality_keywordsets**](QualityApi.html#post_quality_keywordsets) | Create a Keyword Set
36
+ [**post_quality_publishedforms**](QualityApi.html#post_quality_publishedforms) | Publish an evaluation form.
37
+ [**post_quality_spotability**](QualityApi.html#post_quality_spotability) | Retrieve the spotability statistic
38
+ [**put_quality_calibration**](QualityApi.html#put_quality_calibration) | Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
39
+ [**put_quality_conversation_evaluation**](QualityApi.html#put_quality_conversation_evaluation) | Update an evaluation
40
+ [**put_quality_form**](QualityApi.html#put_quality_form) | Update an evaluation form.
41
+ [**put_quality_keywordset**](QualityApi.html#put_quality_keywordset) | Update a keywordSet to the specified keywordSet via PUT.
42
+ {: class="table table-striped"}
43
+
44
+ <a name="delete_quality_calibration"></a>
45
+
46
+ ## -[**Calibration**](Calibration.html) delete_quality_calibration(calibration_id, calibrator_id)
47
+
48
+ Delete a calibration by id.
49
+
50
+
51
+
52
+ Wraps DELETE /api/v2/quality/calibrations/{calibrationId}
53
+
54
+
55
+ ### Example
56
+ ~~~ruby
57
+ # load the gem
58
+ require 'purecloudplatformclientv2'
59
+ # setup authorization
60
+ @secret = ENV['PURECLOUD_SECRET']
61
+ @id = ENV['PURECLOUD_CLIENT_ID']
62
+ environment = "mypurecloud.com"
63
+
64
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
65
+
66
+ PureCloud.configure do |config|
67
+ config.access_token = @authToken
68
+ end
69
+
70
+ api_instance = PureCloud::QualityApi.new
71
+
72
+ calibration_id = "calibration_id_example" # String | Calibration ID
73
+
74
+ calibrator_id = "calibrator_id_example" # String | calibratorId
75
+
76
+
77
+ begin
78
+ #Delete a calibration by id.
79
+ result = api_instance.delete_quality_calibration(calibration_id, calibrator_id)
80
+ p result
81
+ rescue PureCloud::ApiError => e
82
+ puts "Exception when calling QualityApi->delete_quality_calibration: #{e}"
83
+ end
84
+ ~~~
85
+
86
+ ### Parameters
87
+
88
+ Name | Type | Description | Notes
89
+ ------------- | ------------- | ------------- | -------------
90
+ **calibration_id** | **String**| Calibration ID |
91
+ **calibrator_id** | **String**| calibratorId |
92
+ {: class="table table-striped"}
93
+
94
+
95
+ ### Return type
96
+
97
+ [**Calibration**](Calibration.html)
98
+
99
+ ### HTTP request headers
100
+
101
+ - **Content-Type**: application/json
102
+ - **Accept**: application/json
103
+
104
+
105
+
106
+ <a name="delete_quality_conversation_evaluation"></a>
107
+
108
+ ## -[**Evaluation**](Evaluation.html) delete_quality_conversation_evaluation(conversation_id, evaluation_id, opts)
109
+
110
+ Delete an evaluation
111
+
112
+
113
+
114
+ Wraps DELETE /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
115
+
116
+
117
+ ### Example
118
+ ~~~ruby
119
+ # load the gem
120
+ require 'purecloudplatformclientv2'
121
+ # setup authorization
122
+ @secret = ENV['PURECLOUD_SECRET']
123
+ @id = ENV['PURECLOUD_CLIENT_ID']
124
+ environment = "mypurecloud.com"
125
+
126
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
127
+
128
+ PureCloud.configure do |config|
129
+ config.access_token = @authToken
130
+ end
131
+
132
+ api_instance = PureCloud::QualityApi.new
133
+
134
+ conversation_id = "conversation_id_example" # String | conversationId
135
+
136
+ evaluation_id = "evaluation_id_example" # String | evaluationId
137
+
138
+ opts = {
139
+ expand: "expand_example" # String | evaluatorId
140
+ }
141
+
142
+ begin
143
+ #Delete an evaluation
144
+ result = api_instance.delete_quality_conversation_evaluation(conversation_id, evaluation_id, opts)
145
+ p result
146
+ rescue PureCloud::ApiError => e
147
+ puts "Exception when calling QualityApi->delete_quality_conversation_evaluation: #{e}"
148
+ end
149
+ ~~~
150
+
151
+ ### Parameters
152
+
153
+ Name | Type | Description | Notes
154
+ ------------- | ------------- | ------------- | -------------
155
+ **conversation_id** | **String**| conversationId |
156
+ **evaluation_id** | **String**| evaluationId |
157
+ **expand** | **String**| evaluatorId | [optional]
158
+ {: class="table table-striped"}
159
+
160
+
161
+ ### Return type
162
+
163
+ [**Evaluation**](Evaluation.html)
164
+
165
+ ### HTTP request headers
166
+
167
+ - **Content-Type**: application/json
168
+ - **Accept**: application/json
169
+
170
+
171
+
172
+ <a name="delete_quality_form"></a>
173
+
174
+ ## -String** delete_quality_form(form_id)
175
+
176
+ Delete an evaluation form.
177
+
178
+
179
+
180
+ Wraps DELETE /api/v2/quality/forms/{formId}
181
+
182
+
183
+ ### Example
184
+ ~~~ruby
185
+ # load the gem
186
+ require 'purecloudplatformclientv2'
187
+ # setup authorization
188
+ @secret = ENV['PURECLOUD_SECRET']
189
+ @id = ENV['PURECLOUD_CLIENT_ID']
190
+ environment = "mypurecloud.com"
191
+
192
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
193
+
194
+ PureCloud.configure do |config|
195
+ config.access_token = @authToken
196
+ end
197
+
198
+ api_instance = PureCloud::QualityApi.new
199
+
200
+ form_id = "form_id_example" # String | Form ID
201
+
202
+
203
+ begin
204
+ #Delete an evaluation form.
205
+ result = api_instance.delete_quality_form(form_id)
206
+ p result
207
+ rescue PureCloud::ApiError => e
208
+ puts "Exception when calling QualityApi->delete_quality_form: #{e}"
209
+ end
210
+ ~~~
211
+
212
+ ### Parameters
213
+
214
+ Name | Type | Description | Notes
215
+ ------------- | ------------- | ------------- | -------------
216
+ **form_id** | **String**| Form ID |
217
+ {: class="table table-striped"}
218
+
219
+
220
+ ### Return type
221
+
222
+ **String**
223
+
224
+ ### HTTP request headers
225
+
226
+ - **Content-Type**: application/json
227
+ - **Accept**: application/json
228
+
229
+
230
+
231
+ <a name="delete_quality_keywordset"></a>
232
+
233
+ ## - delete_quality_keywordset(keyword_set_id)
234
+
235
+ Delete a keywordSet by id.
236
+
237
+
238
+
239
+ Wraps DELETE /api/v2/quality/keywordsets/{keywordSetId}
240
+
241
+
242
+ ### Example
243
+ ~~~ruby
244
+ # load the gem
245
+ require 'purecloudplatformclientv2'
246
+ # setup authorization
247
+ @secret = ENV['PURECLOUD_SECRET']
248
+ @id = ENV['PURECLOUD_CLIENT_ID']
249
+ environment = "mypurecloud.com"
250
+
251
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
252
+
253
+ PureCloud.configure do |config|
254
+ config.access_token = @authToken
255
+ end
256
+
257
+ api_instance = PureCloud::QualityApi.new
258
+
259
+ keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID
260
+
261
+
262
+ begin
263
+ #Delete a keywordSet by id.
264
+ api_instance.delete_quality_keywordset(keyword_set_id)
265
+ rescue PureCloud::ApiError => e
266
+ puts "Exception when calling QualityApi->delete_quality_keywordset: #{e}"
267
+ end
268
+ ~~~
269
+
270
+ ### Parameters
271
+
272
+ Name | Type | Description | Notes
273
+ ------------- | ------------- | ------------- | -------------
274
+ **keyword_set_id** | **String**| KeywordSet ID |
275
+ {: class="table table-striped"}
276
+
277
+
278
+ ### Return type
279
+
280
+ nil (empty response body)
281
+
282
+ ### HTTP request headers
283
+
284
+ - **Content-Type**: application/json
285
+ - **Accept**: application/json
286
+
287
+
288
+
289
+ <a name="delete_quality_keywordsets"></a>
290
+
291
+ ## -String** delete_quality_keywordsets(ids)
292
+
293
+ Delete keyword sets
294
+
295
+ Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.
296
+
297
+ Wraps DELETE /api/v2/quality/keywordsets
298
+
299
+
300
+ ### Example
301
+ ~~~ruby
302
+ # load the gem
303
+ require 'purecloudplatformclientv2'
304
+ # setup authorization
305
+ @secret = ENV['PURECLOUD_SECRET']
306
+ @id = ENV['PURECLOUD_CLIENT_ID']
307
+ environment = "mypurecloud.com"
308
+
309
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
310
+
311
+ PureCloud.configure do |config|
312
+ config.access_token = @authToken
313
+ end
314
+
315
+ api_instance = PureCloud::QualityApi.new
316
+
317
+ ids = "ids_example" # String | A comma-delimited list of valid KeywordSet ids
318
+
319
+
320
+ begin
321
+ #Delete keyword sets
322
+ result = api_instance.delete_quality_keywordsets(ids)
323
+ p result
324
+ rescue PureCloud::ApiError => e
325
+ puts "Exception when calling QualityApi->delete_quality_keywordsets: #{e}"
326
+ end
327
+ ~~~
328
+
329
+ ### Parameters
330
+
331
+ Name | Type | Description | Notes
332
+ ------------- | ------------- | ------------- | -------------
333
+ **ids** | **String**| A comma-delimited list of valid KeywordSet ids |
334
+ {: class="table table-striped"}
335
+
336
+
337
+ ### Return type
338
+
339
+ **String**
340
+
341
+ ### HTTP request headers
342
+
343
+ - **Content-Type**: application/json
344
+ - **Accept**: application/json
345
+
346
+
347
+
348
+ <a name="get_quality_agents_activity"></a>
349
+
350
+ ## -[**AgentActivityEntityListing**](AgentActivityEntityListing.html) get_quality_agents_activity(opts)
351
+
352
+ Gets a list of Agent Activities
353
+
354
+ Including the number of evaluations and average evaluation score
355
+
356
+ Wraps GET /api/v2/quality/agents/activity
357
+
358
+
359
+ ### Example
360
+ ~~~ruby
361
+ # load the gem
362
+ require 'purecloudplatformclientv2'
363
+ # setup authorization
364
+ @secret = ENV['PURECLOUD_SECRET']
365
+ @id = ENV['PURECLOUD_CLIENT_ID']
366
+ environment = "mypurecloud.com"
367
+
368
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
369
+
370
+ PureCloud.configure do |config|
371
+ config.access_token = @authToken
372
+ end
373
+
374
+ api_instance = PureCloud::QualityApi.new
375
+
376
+ opts = {
377
+ page_size: 25, # Integer | The total page size requested
378
+ page_number: 1, # Integer | The page number requested
379
+ sort_by: "sort_by_example", # String | variable name requested to sort by
380
+ expand: nil, # Array<Object> | variable name requested by expand list
381
+ next_page: "next_page_example", # String | next page token
382
+ previous_page: "previous_page_example", # String | Previous page token
383
+ start_time: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
384
+ end_time: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
385
+ agent_user_id: nil, # Array<Object> | user id of agent requested
386
+ evaluator_user_id: "evaluator_user_id_example", # String | user id of the evaluator
387
+ name: "name_example", # String | name
388
+ group: "group_example" # String | group id
389
+ }
390
+
391
+ begin
392
+ #Gets a list of Agent Activities
393
+ result = api_instance.get_quality_agents_activity(opts)
394
+ p result
395
+ rescue PureCloud::ApiError => e
396
+ puts "Exception when calling QualityApi->get_quality_agents_activity: #{e}"
397
+ end
398
+ ~~~
399
+
400
+ ### Parameters
401
+
402
+ Name | Type | Description | Notes
403
+ ------------- | ------------- | ------------- | -------------
404
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
405
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1]
406
+ **sort_by** | **String**| variable name requested to sort by | [optional]
407
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional]
408
+ **next_page** | **String**| next page token | [optional]
409
+ **previous_page** | **String**| Previous page token | [optional]
410
+ **start_time** | **DateTime**| Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional]
411
+ **end_time** | **DateTime**| End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional]
412
+ **agent_user_id** | [**Array&lt;Object&gt;**](Object.html)| user id of agent requested | [optional]
413
+ **evaluator_user_id** | **String**| user id of the evaluator | [optional]
414
+ **name** | **String**| name | [optional]
415
+ **group** | **String**| group id | [optional]
416
+ {: class="table table-striped"}
417
+
418
+
419
+ ### Return type
420
+
421
+ [**AgentActivityEntityListing**](AgentActivityEntityListing.html)
422
+
423
+ ### HTTP request headers
424
+
425
+ - **Content-Type**: application/json
426
+ - **Accept**: application/json
427
+
428
+
429
+
430
+ <a name="get_quality_calibration"></a>
431
+
432
+ ## -[**Calibration**](Calibration.html) get_quality_calibration(calibration_id, calibrator_id)
433
+
434
+ Get a calibration by id.
435
+
436
+
437
+
438
+ Wraps GET /api/v2/quality/calibrations/{calibrationId}
439
+
440
+
441
+ ### Example
442
+ ~~~ruby
443
+ # load the gem
444
+ require 'purecloudplatformclientv2'
445
+ # setup authorization
446
+ @secret = ENV['PURECLOUD_SECRET']
447
+ @id = ENV['PURECLOUD_CLIENT_ID']
448
+ environment = "mypurecloud.com"
449
+
450
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
451
+
452
+ PureCloud.configure do |config|
453
+ config.access_token = @authToken
454
+ end
455
+
456
+ api_instance = PureCloud::QualityApi.new
457
+
458
+ calibration_id = "calibration_id_example" # String | Calibration ID
459
+
460
+ calibrator_id = "calibrator_id_example" # String | calibratorId
461
+
462
+
463
+ begin
464
+ #Get a calibration by id.
465
+ result = api_instance.get_quality_calibration(calibration_id, calibrator_id)
466
+ p result
467
+ rescue PureCloud::ApiError => e
468
+ puts "Exception when calling QualityApi->get_quality_calibration: #{e}"
469
+ end
470
+ ~~~
471
+
472
+ ### Parameters
473
+
474
+ Name | Type | Description | Notes
475
+ ------------- | ------------- | ------------- | -------------
476
+ **calibration_id** | **String**| Calibration ID |
477
+ **calibrator_id** | **String**| calibratorId |
478
+ {: class="table table-striped"}
479
+
480
+
481
+ ### Return type
482
+
483
+ [**Calibration**](Calibration.html)
484
+
485
+ ### HTTP request headers
486
+
487
+ - **Content-Type**: application/json
488
+ - **Accept**: application/json
489
+
490
+
491
+
492
+ <a name="get_quality_calibrations"></a>
493
+
494
+ ## -[**CalibrationEntityListing**](CalibrationEntityListing.html) get_quality_calibrations(calibrator_id, opts)
495
+
496
+ Get the list of calibrations
497
+
498
+
499
+
500
+ Wraps GET /api/v2/quality/calibrations
501
+
502
+
503
+ ### Example
504
+ ~~~ruby
505
+ # load the gem
506
+ require 'purecloudplatformclientv2'
507
+ # setup authorization
508
+ @secret = ENV['PURECLOUD_SECRET']
509
+ @id = ENV['PURECLOUD_CLIENT_ID']
510
+ environment = "mypurecloud.com"
511
+
512
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
513
+
514
+ PureCloud.configure do |config|
515
+ config.access_token = @authToken
516
+ end
517
+
518
+ api_instance = PureCloud::QualityApi.new
519
+
520
+ calibrator_id = "calibrator_id_example" # String | user id of calibrator
521
+
522
+ opts = {
523
+ page_size: 25, # Integer | The total page size requested
524
+ page_number: 1, # Integer | The page number requested
525
+ sort_by: "sort_by_example", # String | variable name requested to sort by
526
+ expand: nil, # Array<Object> | variable name requested by expand list
527
+ next_page: "next_page_example", # String | next page token
528
+ previous_page: "previous_page_example", # String | Previous page token
529
+ conversation_id: "conversation_id_example", # String | conversation id
530
+ start_time: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
531
+ end_time: DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
532
+ }
533
+
534
+ begin
535
+ #Get the list of calibrations
536
+ result = api_instance.get_quality_calibrations(calibrator_id, opts)
537
+ p result
538
+ rescue PureCloud::ApiError => e
539
+ puts "Exception when calling QualityApi->get_quality_calibrations: #{e}"
540
+ end
541
+ ~~~
542
+
543
+ ### Parameters
544
+
545
+ Name | Type | Description | Notes
546
+ ------------- | ------------- | ------------- | -------------
547
+ **calibrator_id** | **String**| user id of calibrator |
548
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
549
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1]
550
+ **sort_by** | **String**| variable name requested to sort by | [optional]
551
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional]
552
+ **next_page** | **String**| next page token | [optional]
553
+ **previous_page** | **String**| Previous page token | [optional]
554
+ **conversation_id** | **String**| conversation id | [optional]
555
+ **start_time** | **DateTime**| Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional]
556
+ **end_time** | **DateTime**| end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional]
557
+ {: class="table table-striped"}
558
+
559
+
560
+ ### Return type
561
+
562
+ [**CalibrationEntityListing**](CalibrationEntityListing.html)
563
+
564
+ ### HTTP request headers
565
+
566
+ - **Content-Type**: application/json
567
+ - **Accept**: application/json
568
+
569
+
570
+
571
+ <a name="get_quality_conversation_audits"></a>
572
+
573
+ ## -[**QualityAuditPage**](QualityAuditPage.html) get_quality_conversation_audits(conversation_id, opts)
574
+
575
+ Get audits for conversation or recording
576
+
577
+
578
+
579
+ Wraps GET /api/v2/quality/conversations/{conversationId}/audits
580
+
581
+
582
+ ### Example
583
+ ~~~ruby
584
+ # load the gem
585
+ require 'purecloudplatformclientv2'
586
+ # setup authorization
587
+ @secret = ENV['PURECLOUD_SECRET']
588
+ @id = ENV['PURECLOUD_CLIENT_ID']
589
+ environment = "mypurecloud.com"
590
+
591
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
592
+
593
+ PureCloud.configure do |config|
594
+ config.access_token = @authToken
595
+ end
596
+
597
+ api_instance = PureCloud::QualityApi.new
598
+
599
+ conversation_id = "conversation_id_example" # String | Conversation ID
600
+
601
+ opts = {
602
+ page_size: 25, # Integer | The total page size requested
603
+ page_number: 1, # Integer | The page number requested
604
+ sort_by: "sort_by_example", # String | variable name requested to sort by
605
+ expand: nil, # Array<Object> | variable name requested by expand list
606
+ next_page: "next_page_example", # String | next page token
607
+ previous_page: "previous_page_example", # String | Previous page token
608
+ recording_id: "recording_id_example", # String | id of the recording
609
+ entity_type: "RECORDING" # String | entity type options: Recording, Calibration, Evaluation, Annotation
610
+ }
611
+
612
+ begin
613
+ #Get audits for conversation or recording
614
+ result = api_instance.get_quality_conversation_audits(conversation_id, opts)
615
+ p result
616
+ rescue PureCloud::ApiError => e
617
+ puts "Exception when calling QualityApi->get_quality_conversation_audits: #{e}"
618
+ end
619
+ ~~~
620
+
621
+ ### Parameters
622
+
623
+ Name | Type | Description | Notes
624
+ ------------- | ------------- | ------------- | -------------
625
+ **conversation_id** | **String**| Conversation ID |
626
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
627
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1]
628
+ **sort_by** | **String**| variable name requested to sort by | [optional]
629
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional]
630
+ **next_page** | **String**| next page token | [optional]
631
+ **previous_page** | **String**| Previous page token | [optional]
632
+ **recording_id** | **String**| id of the recording | [optional]
633
+ **entity_type** | **String**| entity type options: Recording, Calibration, Evaluation, Annotation | [optional] [default to RECORDING]
634
+ {: class="table table-striped"}
635
+
636
+
637
+ ### Return type
638
+
639
+ [**QualityAuditPage**](QualityAuditPage.html)
640
+
641
+ ### HTTP request headers
642
+
643
+ - **Content-Type**: application/json
644
+ - **Accept**: application/json
645
+
646
+
647
+
648
+ <a name="get_quality_conversation_evaluation"></a>
649
+
650
+ ## -[**Evaluation**](Evaluation.html) get_quality_conversation_evaluation(conversation_id, evaluation_id, opts)
651
+
652
+ Get an evaluation
653
+
654
+
655
+
656
+ Wraps GET /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
657
+
658
+
659
+ ### Example
660
+ ~~~ruby
661
+ # load the gem
662
+ require 'purecloudplatformclientv2'
663
+ # setup authorization
664
+ @secret = ENV['PURECLOUD_SECRET']
665
+ @id = ENV['PURECLOUD_CLIENT_ID']
666
+ environment = "mypurecloud.com"
667
+
668
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
669
+
670
+ PureCloud.configure do |config|
671
+ config.access_token = @authToken
672
+ end
673
+
674
+ api_instance = PureCloud::QualityApi.new
675
+
676
+ conversation_id = "conversation_id_example" # String | conversationId
677
+
678
+ evaluation_id = "evaluation_id_example" # String | evaluationId
679
+
680
+ opts = {
681
+ expand: "expand_example" # String | agent, evaluator, evaluationForm
682
+ }
683
+
684
+ begin
685
+ #Get an evaluation
686
+ result = api_instance.get_quality_conversation_evaluation(conversation_id, evaluation_id, opts)
687
+ p result
688
+ rescue PureCloud::ApiError => e
689
+ puts "Exception when calling QualityApi->get_quality_conversation_evaluation: #{e}"
690
+ end
691
+ ~~~
692
+
693
+ ### Parameters
694
+
695
+ Name | Type | Description | Notes
696
+ ------------- | ------------- | ------------- | -------------
697
+ **conversation_id** | **String**| conversationId |
698
+ **evaluation_id** | **String**| evaluationId |
699
+ **expand** | **String**| agent, evaluator, evaluationForm | [optional]
700
+ {: class="table table-striped"}
701
+
702
+
703
+ ### Return type
704
+
705
+ [**Evaluation**](Evaluation.html)
706
+
707
+ ### HTTP request headers
708
+
709
+ - **Content-Type**: application/json
710
+ - **Accept**: application/json
711
+
712
+
713
+
714
+ <a name="get_quality_evaluations_query"></a>
715
+
716
+ ## -[**EvaluationEntityListing**](EvaluationEntityListing.html) get_quality_evaluations_query(opts)
717
+
718
+ Queries Evaluations and returns a paged list
719
+
720
+ Query params must include one of conversationId, evaluatorUserId, or agentUserId
721
+
722
+ Wraps GET /api/v2/quality/evaluations/query
723
+
724
+
725
+ ### Example
726
+ ~~~ruby
727
+ # load the gem
728
+ require 'purecloudplatformclientv2'
729
+ # setup authorization
730
+ @secret = ENV['PURECLOUD_SECRET']
731
+ @id = ENV['PURECLOUD_CLIENT_ID']
732
+ environment = "mypurecloud.com"
733
+
734
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
735
+
736
+ PureCloud.configure do |config|
737
+ config.access_token = @authToken
738
+ end
739
+
740
+ api_instance = PureCloud::QualityApi.new
741
+
742
+ opts = {
743
+ page_size: 25, # Integer | The total page size requested
744
+ page_number: 1, # Integer | The page number requested
745
+ sort_by: "sort_by_example", # String | variable name requested to sort by
746
+ expand: nil, # Array<Object> | variable name requested by expand list
747
+ next_page: "next_page_example", # String | next page token
748
+ previous_page: "previous_page_example", # String | Previous page token
749
+ conversation_id: "conversation_id_example", # String | conversationId specified
750
+ agent_user_id: "agent_user_id_example", # String | user id of the agent
751
+ evaluator_user_id: "evaluator_user_id_example", # String | evaluator user id
752
+ queue_id: "queue_id_example", # String | queue id
753
+ start_time: "start_time_example", # String | start time of the evaluation query
754
+ end_time: "end_time_example", # String | end time of the evaluation query
755
+ evaluation_state: nil, # Array<Object> | evaluation state options: Pending, InProgress, Finished
756
+ is_released: true, # BOOLEAN | the evaluation has been released
757
+ agent_has_read: true, # BOOLEAN | agent has the evaluation
758
+ expand_answer_total_scores: true, # BOOLEAN | get the total scores for evaluations
759
+ maximum: 56 # Integer | maximum
760
+ }
761
+
762
+ begin
763
+ #Queries Evaluations and returns a paged list
764
+ result = api_instance.get_quality_evaluations_query(opts)
765
+ p result
766
+ rescue PureCloud::ApiError => e
767
+ puts "Exception when calling QualityApi->get_quality_evaluations_query: #{e}"
768
+ end
769
+ ~~~
770
+
771
+ ### Parameters
772
+
773
+ Name | Type | Description | Notes
774
+ ------------- | ------------- | ------------- | -------------
775
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
776
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1]
777
+ **sort_by** | **String**| variable name requested to sort by | [optional]
778
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional]
779
+ **next_page** | **String**| next page token | [optional]
780
+ **previous_page** | **String**| Previous page token | [optional]
781
+ **conversation_id** | **String**| conversationId specified | [optional]
782
+ **agent_user_id** | **String**| user id of the agent | [optional]
783
+ **evaluator_user_id** | **String**| evaluator user id | [optional]
784
+ **queue_id** | **String**| queue id | [optional]
785
+ **start_time** | **String**| start time of the evaluation query | [optional]
786
+ **end_time** | **String**| end time of the evaluation query | [optional]
787
+ **evaluation_state** | [**Array&lt;Object&gt;**](Object.html)| evaluation state options: Pending, InProgress, Finished | [optional]
788
+ **is_released** | **BOOLEAN**| the evaluation has been released | [optional]
789
+ **agent_has_read** | **BOOLEAN**| agent has the evaluation | [optional]
790
+ **expand_answer_total_scores** | **BOOLEAN**| get the total scores for evaluations | [optional]
791
+ **maximum** | **Integer**| maximum | [optional]
792
+ {: class="table table-striped"}
793
+
794
+
795
+ ### Return type
796
+
797
+ [**EvaluationEntityListing**](EvaluationEntityListing.html)
798
+
799
+ ### HTTP request headers
800
+
801
+ - **Content-Type**: application/json
802
+ - **Accept**: application/json
803
+
804
+
805
+
806
+ <a name="get_quality_evaluators_activity"></a>
807
+
808
+ ## -[**EvaluatorActivityEntityListing**](EvaluatorActivityEntityListing.html) get_quality_evaluators_activity(opts)
809
+
810
+ Get an evaluator activity
811
+
812
+
813
+
814
+ Wraps GET /api/v2/quality/evaluators/activity
815
+
816
+
817
+ ### Example
818
+ ~~~ruby
819
+ # load the gem
820
+ require 'purecloudplatformclientv2'
821
+ # setup authorization
822
+ @secret = ENV['PURECLOUD_SECRET']
823
+ @id = ENV['PURECLOUD_CLIENT_ID']
824
+ environment = "mypurecloud.com"
825
+
826
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
827
+
828
+ PureCloud.configure do |config|
829
+ config.access_token = @authToken
830
+ end
831
+
832
+ api_instance = PureCloud::QualityApi.new
833
+
834
+ opts = {
835
+ page_size: 25, # Integer | The total page size requested
836
+ page_number: 1, # Integer | The page number requested
837
+ sort_by: "sort_by_example", # String | variable name requested to sort by
838
+ expand: nil, # Array<Object> | variable name requested by expand list
839
+ next_page: "next_page_example", # String | next page token
840
+ previous_page: "previous_page_example", # String | Previous page token
841
+ start_time: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
842
+ end_time: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
843
+ name: "name_example", # String | Evaluator name
844
+ permission: nil, # Array<Object> | permission strings
845
+ group: "group_example" # String | group id
846
+ }
847
+
848
+ begin
849
+ #Get an evaluator activity
850
+ result = api_instance.get_quality_evaluators_activity(opts)
851
+ p result
852
+ rescue PureCloud::ApiError => e
853
+ puts "Exception when calling QualityApi->get_quality_evaluators_activity: #{e}"
854
+ end
855
+ ~~~
856
+
857
+ ### Parameters
858
+
859
+ Name | Type | Description | Notes
860
+ ------------- | ------------- | ------------- | -------------
861
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
862
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1]
863
+ **sort_by** | **String**| variable name requested to sort by | [optional]
864
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional]
865
+ **next_page** | **String**| next page token | [optional]
866
+ **previous_page** | **String**| Previous page token | [optional]
867
+ **start_time** | **DateTime**| The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional]
868
+ **end_time** | **DateTime**| The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional]
869
+ **name** | **String**| Evaluator name | [optional]
870
+ **permission** | [**Array&lt;Object&gt;**](Object.html)| permission strings | [optional]
871
+ **group** | **String**| group id | [optional]
872
+ {: class="table table-striped"}
873
+
874
+
875
+ ### Return type
876
+
877
+ [**EvaluatorActivityEntityListing**](EvaluatorActivityEntityListing.html)
878
+
879
+ ### HTTP request headers
880
+
881
+ - **Content-Type**: application/json
882
+ - **Accept**: application/json
883
+
884
+
885
+
886
+ <a name="get_quality_form"></a>
887
+
888
+ ## -[**EvaluationForm**](EvaluationForm.html) get_quality_form(form_id)
889
+
890
+ Get an evaluation form
891
+
892
+
893
+
894
+ Wraps GET /api/v2/quality/forms/{formId}
895
+
896
+
897
+ ### Example
898
+ ~~~ruby
899
+ # load the gem
900
+ require 'purecloudplatformclientv2'
901
+ # setup authorization
902
+ @secret = ENV['PURECLOUD_SECRET']
903
+ @id = ENV['PURECLOUD_CLIENT_ID']
904
+ environment = "mypurecloud.com"
905
+
906
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
907
+
908
+ PureCloud.configure do |config|
909
+ config.access_token = @authToken
910
+ end
911
+
912
+ api_instance = PureCloud::QualityApi.new
913
+
914
+ form_id = "form_id_example" # String | Form ID
915
+
916
+
917
+ begin
918
+ #Get an evaluation form
919
+ result = api_instance.get_quality_form(form_id)
920
+ p result
921
+ rescue PureCloud::ApiError => e
922
+ puts "Exception when calling QualityApi->get_quality_form: #{e}"
923
+ end
924
+ ~~~
925
+
926
+ ### Parameters
927
+
928
+ Name | Type | Description | Notes
929
+ ------------- | ------------- | ------------- | -------------
930
+ **form_id** | **String**| Form ID |
931
+ {: class="table table-striped"}
932
+
933
+
934
+ ### Return type
935
+
936
+ [**EvaluationForm**](EvaluationForm.html)
937
+
938
+ ### HTTP request headers
939
+
940
+ - **Content-Type**: application/json
941
+ - **Accept**: application/json
942
+
943
+
944
+
945
+ <a name="get_quality_form_versions"></a>
946
+
947
+ ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_form_versions(form_id, opts)
948
+
949
+ Gets all the revisions for a specific evaluation.
950
+
951
+
952
+
953
+ Wraps GET /api/v2/quality/forms/{formId}/versions
954
+
955
+
956
+ ### Example
957
+ ~~~ruby
958
+ # load the gem
959
+ require 'purecloudplatformclientv2'
960
+ # setup authorization
961
+ @secret = ENV['PURECLOUD_SECRET']
962
+ @id = ENV['PURECLOUD_CLIENT_ID']
963
+ environment = "mypurecloud.com"
964
+
965
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
966
+
967
+ PureCloud.configure do |config|
968
+ config.access_token = @authToken
969
+ end
970
+
971
+ api_instance = PureCloud::QualityApi.new
972
+
973
+ form_id = "form_id_example" # String | Form ID
974
+
975
+ opts = {
976
+ page_size: 25, # Integer | Page size
977
+ page_number: 1 # Integer | Page number
978
+ }
979
+
980
+ begin
981
+ #Gets all the revisions for a specific evaluation.
982
+ result = api_instance.get_quality_form_versions(form_id, opts)
983
+ p result
984
+ rescue PureCloud::ApiError => e
985
+ puts "Exception when calling QualityApi->get_quality_form_versions: #{e}"
986
+ end
987
+ ~~~
988
+
989
+ ### Parameters
990
+
991
+ Name | Type | Description | Notes
992
+ ------------- | ------------- | ------------- | -------------
993
+ **form_id** | **String**| Form ID |
994
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
995
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
996
+ {: class="table table-striped"}
997
+
998
+
999
+ ### Return type
1000
+
1001
+ [**EvaluationFormEntityListing**](EvaluationFormEntityListing.html)
1002
+
1003
+ ### HTTP request headers
1004
+
1005
+ - **Content-Type**: application/json
1006
+ - **Accept**: application/json
1007
+
1008
+
1009
+
1010
+ <a name="get_quality_forms"></a>
1011
+
1012
+ ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_forms(opts)
1013
+
1014
+ Get the list of evaluation forms
1015
+
1016
+
1017
+
1018
+ Wraps GET /api/v2/quality/forms
1019
+
1020
+
1021
+ ### Example
1022
+ ~~~ruby
1023
+ # load the gem
1024
+ require 'purecloudplatformclientv2'
1025
+ # setup authorization
1026
+ @secret = ENV['PURECLOUD_SECRET']
1027
+ @id = ENV['PURECLOUD_CLIENT_ID']
1028
+ environment = "mypurecloud.com"
1029
+
1030
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1031
+
1032
+ PureCloud.configure do |config|
1033
+ config.access_token = @authToken
1034
+ end
1035
+
1036
+ api_instance = PureCloud::QualityApi.new
1037
+
1038
+ opts = {
1039
+ page_size: 25, # Integer | The total page size requested
1040
+ page_number: 1, # Integer | The page number requested
1041
+ sort_by: "sort_by_example", # String | variable name requested to sort by
1042
+ next_page: "next_page_example", # String | next page token
1043
+ previous_page: "previous_page_example", # String | Previous page token
1044
+ expand: "expand_example", # String | Expand
1045
+ name: "name_example" # String | Name
1046
+ }
1047
+
1048
+ begin
1049
+ #Get the list of evaluation forms
1050
+ result = api_instance.get_quality_forms(opts)
1051
+ p result
1052
+ rescue PureCloud::ApiError => e
1053
+ puts "Exception when calling QualityApi->get_quality_forms: #{e}"
1054
+ end
1055
+ ~~~
1056
+
1057
+ ### Parameters
1058
+
1059
+ Name | Type | Description | Notes
1060
+ ------------- | ------------- | ------------- | -------------
1061
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
1062
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1]
1063
+ **sort_by** | **String**| variable name requested to sort by | [optional]
1064
+ **next_page** | **String**| next page token | [optional]
1065
+ **previous_page** | **String**| Previous page token | [optional]
1066
+ **expand** | **String**| Expand | [optional]
1067
+ **name** | **String**| Name | [optional]
1068
+ {: class="table table-striped"}
1069
+
1070
+
1071
+ ### Return type
1072
+
1073
+ [**EvaluationFormEntityListing**](EvaluationFormEntityListing.html)
1074
+
1075
+ ### HTTP request headers
1076
+
1077
+ - **Content-Type**: application/json
1078
+ - **Accept**: application/json
1079
+
1080
+
1081
+
1082
+ <a name="get_quality_keywordset"></a>
1083
+
1084
+ ## -[**KeywordSet**](KeywordSet.html) get_quality_keywordset(keyword_set_id)
1085
+
1086
+ Get a keywordSet by id.
1087
+
1088
+
1089
+
1090
+ Wraps GET /api/v2/quality/keywordsets/{keywordSetId}
1091
+
1092
+
1093
+ ### Example
1094
+ ~~~ruby
1095
+ # load the gem
1096
+ require 'purecloudplatformclientv2'
1097
+ # setup authorization
1098
+ @secret = ENV['PURECLOUD_SECRET']
1099
+ @id = ENV['PURECLOUD_CLIENT_ID']
1100
+ environment = "mypurecloud.com"
1101
+
1102
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1103
+
1104
+ PureCloud.configure do |config|
1105
+ config.access_token = @authToken
1106
+ end
1107
+
1108
+ api_instance = PureCloud::QualityApi.new
1109
+
1110
+ keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID
1111
+
1112
+
1113
+ begin
1114
+ #Get a keywordSet by id.
1115
+ result = api_instance.get_quality_keywordset(keyword_set_id)
1116
+ p result
1117
+ rescue PureCloud::ApiError => e
1118
+ puts "Exception when calling QualityApi->get_quality_keywordset: #{e}"
1119
+ end
1120
+ ~~~
1121
+
1122
+ ### Parameters
1123
+
1124
+ Name | Type | Description | Notes
1125
+ ------------- | ------------- | ------------- | -------------
1126
+ **keyword_set_id** | **String**| KeywordSet ID |
1127
+ {: class="table table-striped"}
1128
+
1129
+
1130
+ ### Return type
1131
+
1132
+ [**KeywordSet**](KeywordSet.html)
1133
+
1134
+ ### HTTP request headers
1135
+
1136
+ - **Content-Type**: application/json
1137
+ - **Accept**: application/json
1138
+
1139
+
1140
+
1141
+ <a name="get_quality_keywordsets"></a>
1142
+
1143
+ ## -[**KeywordSetEntityListing**](KeywordSetEntityListing.html) get_quality_keywordsets(opts)
1144
+
1145
+ Get the list of keyword sets
1146
+
1147
+
1148
+
1149
+ Wraps GET /api/v2/quality/keywordsets
1150
+
1151
+
1152
+ ### Example
1153
+ ~~~ruby
1154
+ # load the gem
1155
+ require 'purecloudplatformclientv2'
1156
+ # setup authorization
1157
+ @secret = ENV['PURECLOUD_SECRET']
1158
+ @id = ENV['PURECLOUD_CLIENT_ID']
1159
+ environment = "mypurecloud.com"
1160
+
1161
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1162
+
1163
+ PureCloud.configure do |config|
1164
+ config.access_token = @authToken
1165
+ end
1166
+
1167
+ api_instance = PureCloud::QualityApi.new
1168
+
1169
+ opts = {
1170
+ page_size: 25, # Integer | The total page size requested
1171
+ page_number: 1, # Integer | The page number requested
1172
+ sort_by: "sort_by_example", # String | variable name requested to sort by
1173
+ expand: nil, # Array<Object> | variable name requested by expand list
1174
+ next_page: "next_page_example", # String | next page token
1175
+ previous_page: "previous_page_example", # String | Previous page token
1176
+ name: "name_example", # String | the keyword set name - used for filtering results in searches.
1177
+ queue_id: "queue_id_example", # String | the queue id - used for filtering results in searches.
1178
+ agent_id: "agent_id_example", # String | the agent id - used for filtering results in searches.
1179
+ operator: "operator_example" # String | If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.
1180
+ }
1181
+
1182
+ begin
1183
+ #Get the list of keyword sets
1184
+ result = api_instance.get_quality_keywordsets(opts)
1185
+ p result
1186
+ rescue PureCloud::ApiError => e
1187
+ puts "Exception when calling QualityApi->get_quality_keywordsets: #{e}"
1188
+ end
1189
+ ~~~
1190
+
1191
+ ### Parameters
1192
+
1193
+ Name | Type | Description | Notes
1194
+ ------------- | ------------- | ------------- | -------------
1195
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
1196
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1]
1197
+ **sort_by** | **String**| variable name requested to sort by | [optional]
1198
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional]
1199
+ **next_page** | **String**| next page token | [optional]
1200
+ **previous_page** | **String**| Previous page token | [optional]
1201
+ **name** | **String**| the keyword set name - used for filtering results in searches. | [optional]
1202
+ **queue_id** | **String**| the queue id - used for filtering results in searches. | [optional]
1203
+ **agent_id** | **String**| the agent id - used for filtering results in searches. | [optional]
1204
+ **operator** | **String**| If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters. | [optional]
1205
+ {: class="table table-striped"}
1206
+
1207
+
1208
+ ### Return type
1209
+
1210
+ [**KeywordSetEntityListing**](KeywordSetEntityListing.html)
1211
+
1212
+ ### HTTP request headers
1213
+
1214
+ - **Content-Type**: application/json
1215
+ - **Accept**: application/json
1216
+
1217
+
1218
+
1219
+ <a name="get_quality_publishedform"></a>
1220
+
1221
+ ## -[**EvaluationForm**](EvaluationForm.html) get_quality_publishedform(form_id)
1222
+
1223
+ Get the published evaluation forms.
1224
+
1225
+
1226
+
1227
+ Wraps GET /api/v2/quality/publishedforms/{formId}
1228
+
1229
+
1230
+ ### Example
1231
+ ~~~ruby
1232
+ # load the gem
1233
+ require 'purecloudplatformclientv2'
1234
+ # setup authorization
1235
+ @secret = ENV['PURECLOUD_SECRET']
1236
+ @id = ENV['PURECLOUD_CLIENT_ID']
1237
+ environment = "mypurecloud.com"
1238
+
1239
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1240
+
1241
+ PureCloud.configure do |config|
1242
+ config.access_token = @authToken
1243
+ end
1244
+
1245
+ api_instance = PureCloud::QualityApi.new
1246
+
1247
+ form_id = "form_id_example" # String | Form ID
1248
+
1249
+
1250
+ begin
1251
+ #Get the published evaluation forms.
1252
+ result = api_instance.get_quality_publishedform(form_id)
1253
+ p result
1254
+ rescue PureCloud::ApiError => e
1255
+ puts "Exception when calling QualityApi->get_quality_publishedform: #{e}"
1256
+ end
1257
+ ~~~
1258
+
1259
+ ### Parameters
1260
+
1261
+ Name | Type | Description | Notes
1262
+ ------------- | ------------- | ------------- | -------------
1263
+ **form_id** | **String**| Form ID |
1264
+ {: class="table table-striped"}
1265
+
1266
+
1267
+ ### Return type
1268
+
1269
+ [**EvaluationForm**](EvaluationForm.html)
1270
+
1271
+ ### HTTP request headers
1272
+
1273
+ - **Content-Type**: application/json
1274
+ - **Accept**: application/json
1275
+
1276
+
1277
+
1278
+ <a name="get_quality_publishedforms"></a>
1279
+
1280
+ ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_publishedforms(opts)
1281
+
1282
+ Get the published evaluation forms.
1283
+
1284
+
1285
+
1286
+ Wraps GET /api/v2/quality/publishedforms
1287
+
1288
+
1289
+ ### Example
1290
+ ~~~ruby
1291
+ # load the gem
1292
+ require 'purecloudplatformclientv2'
1293
+ # setup authorization
1294
+ @secret = ENV['PURECLOUD_SECRET']
1295
+ @id = ENV['PURECLOUD_CLIENT_ID']
1296
+ environment = "mypurecloud.com"
1297
+
1298
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1299
+
1300
+ PureCloud.configure do |config|
1301
+ config.access_token = @authToken
1302
+ end
1303
+
1304
+ api_instance = PureCloud::QualityApi.new
1305
+
1306
+ opts = {
1307
+ page_size: 25, # Integer | Page size
1308
+ page_number: 1, # Integer | Page number
1309
+ name: "name_example" # String | Name
1310
+ }
1311
+
1312
+ begin
1313
+ #Get the published evaluation forms.
1314
+ result = api_instance.get_quality_publishedforms(opts)
1315
+ p result
1316
+ rescue PureCloud::ApiError => e
1317
+ puts "Exception when calling QualityApi->get_quality_publishedforms: #{e}"
1318
+ end
1319
+ ~~~
1320
+
1321
+ ### Parameters
1322
+
1323
+ Name | Type | Description | Notes
1324
+ ------------- | ------------- | ------------- | -------------
1325
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
1326
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
1327
+ **name** | **String**| Name | [optional]
1328
+ {: class="table table-striped"}
1329
+
1330
+
1331
+ ### Return type
1332
+
1333
+ [**EvaluationFormEntityListing**](EvaluationFormEntityListing.html)
1334
+
1335
+ ### HTTP request headers
1336
+
1337
+ - **Content-Type**: application/json
1338
+ - **Accept**: application/json
1339
+
1340
+
1341
+
1342
+ <a name="post_analytics_evaluations_aggregates_query"></a>
1343
+
1344
+ ## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_evaluations_aggregates_query(body)
1345
+
1346
+ Query for evaluation aggregates
1347
+
1348
+
1349
+
1350
+ Wraps POST /api/v2/analytics/evaluations/aggregates/query
1351
+
1352
+
1353
+ ### Example
1354
+ ~~~ruby
1355
+ # load the gem
1356
+ require 'purecloudplatformclientv2'
1357
+ # setup authorization
1358
+ @secret = ENV['PURECLOUD_SECRET']
1359
+ @id = ENV['PURECLOUD_CLIENT_ID']
1360
+ environment = "mypurecloud.com"
1361
+
1362
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1363
+
1364
+ PureCloud.configure do |config|
1365
+ config.access_token = @authToken
1366
+ end
1367
+
1368
+ api_instance = PureCloud::QualityApi.new
1369
+
1370
+ body = PureCloud::AggregationQuery.new # AggregationQuery | query
1371
+
1372
+
1373
+ begin
1374
+ #Query for evaluation aggregates
1375
+ result = api_instance.post_analytics_evaluations_aggregates_query(body)
1376
+ p result
1377
+ rescue PureCloud::ApiError => e
1378
+ puts "Exception when calling QualityApi->post_analytics_evaluations_aggregates_query: #{e}"
1379
+ end
1380
+ ~~~
1381
+
1382
+ ### Parameters
1383
+
1384
+ Name | Type | Description | Notes
1385
+ ------------- | ------------- | ------------- | -------------
1386
+ **body** | [**AggregationQuery**](AggregationQuery.html)| query |
1387
+ {: class="table table-striped"}
1388
+
1389
+
1390
+ ### Return type
1391
+
1392
+ [**AggregateQueryResponse**](AggregateQueryResponse.html)
1393
+
1394
+ ### HTTP request headers
1395
+
1396
+ - **Content-Type**: application/json
1397
+ - **Accept**: application/json
1398
+
1399
+
1400
+
1401
+ <a name="post_quality_calibrations"></a>
1402
+
1403
+ ## -[**Calibration**](Calibration.html) post_quality_calibrations(body, opts)
1404
+
1405
+ Create a calibration
1406
+
1407
+
1408
+
1409
+ Wraps POST /api/v2/quality/calibrations
1410
+
1411
+
1412
+ ### Example
1413
+ ~~~ruby
1414
+ # load the gem
1415
+ require 'purecloudplatformclientv2'
1416
+ # setup authorization
1417
+ @secret = ENV['PURECLOUD_SECRET']
1418
+ @id = ENV['PURECLOUD_CLIENT_ID']
1419
+ environment = "mypurecloud.com"
1420
+
1421
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1422
+
1423
+ PureCloud.configure do |config|
1424
+ config.access_token = @authToken
1425
+ end
1426
+
1427
+ api_instance = PureCloud::QualityApi.new
1428
+
1429
+ body = PureCloud::CalibrationCreate.new # CalibrationCreate | calibration
1430
+
1431
+ opts = {
1432
+ expand: "expand_example" # String | calibratorId
1433
+ }
1434
+
1435
+ begin
1436
+ #Create a calibration
1437
+ result = api_instance.post_quality_calibrations(body, opts)
1438
+ p result
1439
+ rescue PureCloud::ApiError => e
1440
+ puts "Exception when calling QualityApi->post_quality_calibrations: #{e}"
1441
+ end
1442
+ ~~~
1443
+
1444
+ ### Parameters
1445
+
1446
+ Name | Type | Description | Notes
1447
+ ------------- | ------------- | ------------- | -------------
1448
+ **body** | [**CalibrationCreate**](CalibrationCreate.html)| calibration |
1449
+ **expand** | **String**| calibratorId | [optional]
1450
+ {: class="table table-striped"}
1451
+
1452
+
1453
+ ### Return type
1454
+
1455
+ [**Calibration**](Calibration.html)
1456
+
1457
+ ### HTTP request headers
1458
+
1459
+ - **Content-Type**: application/json
1460
+ - **Accept**: application/json
1461
+
1462
+
1463
+
1464
+ <a name="post_quality_conversation_evaluations"></a>
1465
+
1466
+ ## -[**Evaluation**](Evaluation.html) post_quality_conversation_evaluations(conversation_id, body, opts)
1467
+
1468
+ Create an evaluation
1469
+
1470
+
1471
+
1472
+ Wraps POST /api/v2/quality/conversations/{conversationId}/evaluations
1473
+
1474
+
1475
+ ### Example
1476
+ ~~~ruby
1477
+ # load the gem
1478
+ require 'purecloudplatformclientv2'
1479
+ # setup authorization
1480
+ @secret = ENV['PURECLOUD_SECRET']
1481
+ @id = ENV['PURECLOUD_CLIENT_ID']
1482
+ environment = "mypurecloud.com"
1483
+
1484
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1485
+
1486
+ PureCloud.configure do |config|
1487
+ config.access_token = @authToken
1488
+ end
1489
+
1490
+ api_instance = PureCloud::QualityApi.new
1491
+
1492
+ conversation_id = "conversation_id_example" # String | conversationId
1493
+
1494
+ body = PureCloud::Evaluation.new # Evaluation | evaluation
1495
+
1496
+ opts = {
1497
+ expand: "expand_example" # String | evaluatorId
1498
+ }
1499
+
1500
+ begin
1501
+ #Create an evaluation
1502
+ result = api_instance.post_quality_conversation_evaluations(conversation_id, body, opts)
1503
+ p result
1504
+ rescue PureCloud::ApiError => e
1505
+ puts "Exception when calling QualityApi->post_quality_conversation_evaluations: #{e}"
1506
+ end
1507
+ ~~~
1508
+
1509
+ ### Parameters
1510
+
1511
+ Name | Type | Description | Notes
1512
+ ------------- | ------------- | ------------- | -------------
1513
+ **conversation_id** | **String**| conversationId |
1514
+ **body** | [**Evaluation**](Evaluation.html)| evaluation |
1515
+ **expand** | **String**| evaluatorId | [optional]
1516
+ {: class="table table-striped"}
1517
+
1518
+
1519
+ ### Return type
1520
+
1521
+ [**Evaluation**](Evaluation.html)
1522
+
1523
+ ### HTTP request headers
1524
+
1525
+ - **Content-Type**: application/json
1526
+ - **Accept**: application/json
1527
+
1528
+
1529
+
1530
+ <a name="post_quality_evaluations_scoring"></a>
1531
+
1532
+ ## -[**EvaluationScoringSet**](EvaluationScoringSet.html) post_quality_evaluations_scoring(body)
1533
+
1534
+ Score evaluation
1535
+
1536
+
1537
+
1538
+ Wraps POST /api/v2/quality/evaluations/scoring
1539
+
1540
+
1541
+ ### Example
1542
+ ~~~ruby
1543
+ # load the gem
1544
+ require 'purecloudplatformclientv2'
1545
+ # setup authorization
1546
+ @secret = ENV['PURECLOUD_SECRET']
1547
+ @id = ENV['PURECLOUD_CLIENT_ID']
1548
+ environment = "mypurecloud.com"
1549
+
1550
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1551
+
1552
+ PureCloud.configure do |config|
1553
+ config.access_token = @authToken
1554
+ end
1555
+
1556
+ api_instance = PureCloud::QualityApi.new
1557
+
1558
+ body = PureCloud::EvaluationFormAndScoringSet.new # EvaluationFormAndScoringSet | evaluationAndScoringSet
1559
+
1560
+
1561
+ begin
1562
+ #Score evaluation
1563
+ result = api_instance.post_quality_evaluations_scoring(body)
1564
+ p result
1565
+ rescue PureCloud::ApiError => e
1566
+ puts "Exception when calling QualityApi->post_quality_evaluations_scoring: #{e}"
1567
+ end
1568
+ ~~~
1569
+
1570
+ ### Parameters
1571
+
1572
+ Name | Type | Description | Notes
1573
+ ------------- | ------------- | ------------- | -------------
1574
+ **body** | [**EvaluationFormAndScoringSet**](EvaluationFormAndScoringSet.html)| evaluationAndScoringSet |
1575
+ {: class="table table-striped"}
1576
+
1577
+
1578
+ ### Return type
1579
+
1580
+ [**EvaluationScoringSet**](EvaluationScoringSet.html)
1581
+
1582
+ ### HTTP request headers
1583
+
1584
+ - **Content-Type**: application/json
1585
+ - **Accept**: application/json
1586
+
1587
+
1588
+
1589
+ <a name="post_quality_forms"></a>
1590
+
1591
+ ## -[**EvaluationForm**](EvaluationForm.html) post_quality_forms(body)
1592
+
1593
+ Create an evaluation form.
1594
+
1595
+
1596
+
1597
+ Wraps POST /api/v2/quality/forms
1598
+
1599
+
1600
+ ### Example
1601
+ ~~~ruby
1602
+ # load the gem
1603
+ require 'purecloudplatformclientv2'
1604
+ # setup authorization
1605
+ @secret = ENV['PURECLOUD_SECRET']
1606
+ @id = ENV['PURECLOUD_CLIENT_ID']
1607
+ environment = "mypurecloud.com"
1608
+
1609
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1610
+
1611
+ PureCloud.configure do |config|
1612
+ config.access_token = @authToken
1613
+ end
1614
+
1615
+ api_instance = PureCloud::QualityApi.new
1616
+
1617
+ body = PureCloud::EvaluationForm.new # EvaluationForm | Evaluation form
1618
+
1619
+
1620
+ begin
1621
+ #Create an evaluation form.
1622
+ result = api_instance.post_quality_forms(body)
1623
+ p result
1624
+ rescue PureCloud::ApiError => e
1625
+ puts "Exception when calling QualityApi->post_quality_forms: #{e}"
1626
+ end
1627
+ ~~~
1628
+
1629
+ ### Parameters
1630
+
1631
+ Name | Type | Description | Notes
1632
+ ------------- | ------------- | ------------- | -------------
1633
+ **body** | [**EvaluationForm**](EvaluationForm.html)| Evaluation form |
1634
+ {: class="table table-striped"}
1635
+
1636
+
1637
+ ### Return type
1638
+
1639
+ [**EvaluationForm**](EvaluationForm.html)
1640
+
1641
+ ### HTTP request headers
1642
+
1643
+ - **Content-Type**: application/json
1644
+ - **Accept**: application/json
1645
+
1646
+
1647
+
1648
+ <a name="post_quality_keywordsets"></a>
1649
+
1650
+ ## -[**KeywordSet**](KeywordSet.html) post_quality_keywordsets(body, opts)
1651
+
1652
+ Create a Keyword Set
1653
+
1654
+
1655
+
1656
+ Wraps POST /api/v2/quality/keywordsets
1657
+
1658
+
1659
+ ### Example
1660
+ ~~~ruby
1661
+ # load the gem
1662
+ require 'purecloudplatformclientv2'
1663
+ # setup authorization
1664
+ @secret = ENV['PURECLOUD_SECRET']
1665
+ @id = ENV['PURECLOUD_CLIENT_ID']
1666
+ environment = "mypurecloud.com"
1667
+
1668
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1669
+
1670
+ PureCloud.configure do |config|
1671
+ config.access_token = @authToken
1672
+ end
1673
+
1674
+ api_instance = PureCloud::QualityApi.new
1675
+
1676
+ body = PureCloud::KeywordSet.new # KeywordSet | keywordSet
1677
+
1678
+ opts = {
1679
+ expand: "expand_example" # String | queueId
1680
+ }
1681
+
1682
+ begin
1683
+ #Create a Keyword Set
1684
+ result = api_instance.post_quality_keywordsets(body, opts)
1685
+ p result
1686
+ rescue PureCloud::ApiError => e
1687
+ puts "Exception when calling QualityApi->post_quality_keywordsets: #{e}"
1688
+ end
1689
+ ~~~
1690
+
1691
+ ### Parameters
1692
+
1693
+ Name | Type | Description | Notes
1694
+ ------------- | ------------- | ------------- | -------------
1695
+ **body** | [**KeywordSet**](KeywordSet.html)| keywordSet |
1696
+ **expand** | **String**| queueId | [optional]
1697
+ {: class="table table-striped"}
1698
+
1699
+
1700
+ ### Return type
1701
+
1702
+ [**KeywordSet**](KeywordSet.html)
1703
+
1704
+ ### HTTP request headers
1705
+
1706
+ - **Content-Type**: application/json
1707
+ - **Accept**: application/json
1708
+
1709
+
1710
+
1711
+ <a name="post_quality_publishedforms"></a>
1712
+
1713
+ ## -[**EvaluationForm**](EvaluationForm.html) post_quality_publishedforms(body)
1714
+
1715
+ Publish an evaluation form.
1716
+
1717
+
1718
+
1719
+ Wraps POST /api/v2/quality/publishedforms
1720
+
1721
+
1722
+ ### Example
1723
+ ~~~ruby
1724
+ # load the gem
1725
+ require 'purecloudplatformclientv2'
1726
+ # setup authorization
1727
+ @secret = ENV['PURECLOUD_SECRET']
1728
+ @id = ENV['PURECLOUD_CLIENT_ID']
1729
+ environment = "mypurecloud.com"
1730
+
1731
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1732
+
1733
+ PureCloud.configure do |config|
1734
+ config.access_token = @authToken
1735
+ end
1736
+
1737
+ api_instance = PureCloud::QualityApi.new
1738
+
1739
+ body = PureCloud::EvaluationForm.new # EvaluationForm | Evaluation form
1740
+
1741
+
1742
+ begin
1743
+ #Publish an evaluation form.
1744
+ result = api_instance.post_quality_publishedforms(body)
1745
+ p result
1746
+ rescue PureCloud::ApiError => e
1747
+ puts "Exception when calling QualityApi->post_quality_publishedforms: #{e}"
1748
+ end
1749
+ ~~~
1750
+
1751
+ ### Parameters
1752
+
1753
+ Name | Type | Description | Notes
1754
+ ------------- | ------------- | ------------- | -------------
1755
+ **body** | [**EvaluationForm**](EvaluationForm.html)| Evaluation form |
1756
+ {: class="table table-striped"}
1757
+
1758
+
1759
+ ### Return type
1760
+
1761
+ [**EvaluationForm**](EvaluationForm.html)
1762
+
1763
+ ### HTTP request headers
1764
+
1765
+ - **Content-Type**: application/json
1766
+ - **Accept**: application/json
1767
+
1768
+
1769
+
1770
+ <a name="post_quality_spotability"></a>
1771
+
1772
+ ## -[**KeywordSet**](KeywordSet.html) post_quality_spotability(opts)
1773
+
1774
+ Retrieve the spotability statistic
1775
+
1776
+
1777
+
1778
+ Wraps POST /api/v2/quality/spotability
1779
+
1780
+
1781
+ ### Example
1782
+ ~~~ruby
1783
+ # load the gem
1784
+ require 'purecloudplatformclientv2'
1785
+ # setup authorization
1786
+ @secret = ENV['PURECLOUD_SECRET']
1787
+ @id = ENV['PURECLOUD_CLIENT_ID']
1788
+ environment = "mypurecloud.com"
1789
+
1790
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1791
+
1792
+ PureCloud.configure do |config|
1793
+ config.access_token = @authToken
1794
+ end
1795
+
1796
+ api_instance = PureCloud::QualityApi.new
1797
+
1798
+ opts = {
1799
+ body: PureCloud::KeywordSet.new # KeywordSet | Keyword Set
1800
+ }
1801
+
1802
+ begin
1803
+ #Retrieve the spotability statistic
1804
+ result = api_instance.post_quality_spotability(opts)
1805
+ p result
1806
+ rescue PureCloud::ApiError => e
1807
+ puts "Exception when calling QualityApi->post_quality_spotability: #{e}"
1808
+ end
1809
+ ~~~
1810
+
1811
+ ### Parameters
1812
+
1813
+ Name | Type | Description | Notes
1814
+ ------------- | ------------- | ------------- | -------------
1815
+ **body** | [**KeywordSet**](KeywordSet.html)| Keyword Set | [optional]
1816
+ {: class="table table-striped"}
1817
+
1818
+
1819
+ ### Return type
1820
+
1821
+ [**KeywordSet**](KeywordSet.html)
1822
+
1823
+ ### HTTP request headers
1824
+
1825
+ - **Content-Type**: application/json
1826
+ - **Accept**: application/json
1827
+
1828
+
1829
+
1830
+ <a name="put_quality_calibration"></a>
1831
+
1832
+ ## -[**Calibration**](Calibration.html) put_quality_calibration(calibration_id, body)
1833
+
1834
+ Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
1835
+
1836
+
1837
+
1838
+ Wraps PUT /api/v2/quality/calibrations/{calibrationId}
1839
+
1840
+
1841
+ ### Example
1842
+ ~~~ruby
1843
+ # load the gem
1844
+ require 'purecloudplatformclientv2'
1845
+ # setup authorization
1846
+ @secret = ENV['PURECLOUD_SECRET']
1847
+ @id = ENV['PURECLOUD_CLIENT_ID']
1848
+ environment = "mypurecloud.com"
1849
+
1850
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1851
+
1852
+ PureCloud.configure do |config|
1853
+ config.access_token = @authToken
1854
+ end
1855
+
1856
+ api_instance = PureCloud::QualityApi.new
1857
+
1858
+ calibration_id = "calibration_id_example" # String | Calibration ID
1859
+
1860
+ body = PureCloud::Calibration.new # Calibration | Calibration
1861
+
1862
+
1863
+ begin
1864
+ #Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
1865
+ result = api_instance.put_quality_calibration(calibration_id, body)
1866
+ p result
1867
+ rescue PureCloud::ApiError => e
1868
+ puts "Exception when calling QualityApi->put_quality_calibration: #{e}"
1869
+ end
1870
+ ~~~
1871
+
1872
+ ### Parameters
1873
+
1874
+ Name | Type | Description | Notes
1875
+ ------------- | ------------- | ------------- | -------------
1876
+ **calibration_id** | **String**| Calibration ID |
1877
+ **body** | [**Calibration**](Calibration.html)| Calibration |
1878
+ {: class="table table-striped"}
1879
+
1880
+
1881
+ ### Return type
1882
+
1883
+ [**Calibration**](Calibration.html)
1884
+
1885
+ ### HTTP request headers
1886
+
1887
+ - **Content-Type**: application/json
1888
+ - **Accept**: application/json
1889
+
1890
+
1891
+
1892
+ <a name="put_quality_conversation_evaluation"></a>
1893
+
1894
+ ## -[**Evaluation**](Evaluation.html) put_quality_conversation_evaluation(conversation_id, evaluation_id, body, opts)
1895
+
1896
+ Update an evaluation
1897
+
1898
+
1899
+
1900
+ Wraps PUT /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
1901
+
1902
+
1903
+ ### Example
1904
+ ~~~ruby
1905
+ # load the gem
1906
+ require 'purecloudplatformclientv2'
1907
+ # setup authorization
1908
+ @secret = ENV['PURECLOUD_SECRET']
1909
+ @id = ENV['PURECLOUD_CLIENT_ID']
1910
+ environment = "mypurecloud.com"
1911
+
1912
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1913
+
1914
+ PureCloud.configure do |config|
1915
+ config.access_token = @authToken
1916
+ end
1917
+
1918
+ api_instance = PureCloud::QualityApi.new
1919
+
1920
+ conversation_id = "conversation_id_example" # String | conversationId
1921
+
1922
+ evaluation_id = "evaluation_id_example" # String | evaluationId
1923
+
1924
+ body = PureCloud::Evaluation.new # Evaluation | evaluation
1925
+
1926
+ opts = {
1927
+ expand: "expand_example" # String | evaluatorId
1928
+ }
1929
+
1930
+ begin
1931
+ #Update an evaluation
1932
+ result = api_instance.put_quality_conversation_evaluation(conversation_id, evaluation_id, body, opts)
1933
+ p result
1934
+ rescue PureCloud::ApiError => e
1935
+ puts "Exception when calling QualityApi->put_quality_conversation_evaluation: #{e}"
1936
+ end
1937
+ ~~~
1938
+
1939
+ ### Parameters
1940
+
1941
+ Name | Type | Description | Notes
1942
+ ------------- | ------------- | ------------- | -------------
1943
+ **conversation_id** | **String**| conversationId |
1944
+ **evaluation_id** | **String**| evaluationId |
1945
+ **body** | [**Evaluation**](Evaluation.html)| evaluation |
1946
+ **expand** | **String**| evaluatorId | [optional]
1947
+ {: class="table table-striped"}
1948
+
1949
+
1950
+ ### Return type
1951
+
1952
+ [**Evaluation**](Evaluation.html)
1953
+
1954
+ ### HTTP request headers
1955
+
1956
+ - **Content-Type**: application/json
1957
+ - **Accept**: application/json
1958
+
1959
+
1960
+
1961
+ <a name="put_quality_form"></a>
1962
+
1963
+ ## -[**EvaluationForm**](EvaluationForm.html) put_quality_form(form_id, body)
1964
+
1965
+ Update an evaluation form.
1966
+
1967
+
1968
+
1969
+ Wraps PUT /api/v2/quality/forms/{formId}
1970
+
1971
+
1972
+ ### Example
1973
+ ~~~ruby
1974
+ # load the gem
1975
+ require 'purecloudplatformclientv2'
1976
+ # setup authorization
1977
+ @secret = ENV['PURECLOUD_SECRET']
1978
+ @id = ENV['PURECLOUD_CLIENT_ID']
1979
+ environment = "mypurecloud.com"
1980
+
1981
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1982
+
1983
+ PureCloud.configure do |config|
1984
+ config.access_token = @authToken
1985
+ end
1986
+
1987
+ api_instance = PureCloud::QualityApi.new
1988
+
1989
+ form_id = "form_id_example" # String | Form ID
1990
+
1991
+ body = PureCloud::EvaluationForm.new # EvaluationForm | Evaluation form
1992
+
1993
+
1994
+ begin
1995
+ #Update an evaluation form.
1996
+ result = api_instance.put_quality_form(form_id, body)
1997
+ p result
1998
+ rescue PureCloud::ApiError => e
1999
+ puts "Exception when calling QualityApi->put_quality_form: #{e}"
2000
+ end
2001
+ ~~~
2002
+
2003
+ ### Parameters
2004
+
2005
+ Name | Type | Description | Notes
2006
+ ------------- | ------------- | ------------- | -------------
2007
+ **form_id** | **String**| Form ID |
2008
+ **body** | [**EvaluationForm**](EvaluationForm.html)| Evaluation form |
2009
+ {: class="table table-striped"}
2010
+
2011
+
2012
+ ### Return type
2013
+
2014
+ [**EvaluationForm**](EvaluationForm.html)
2015
+
2016
+ ### HTTP request headers
2017
+
2018
+ - **Content-Type**: application/json
2019
+ - **Accept**: application/json
2020
+
2021
+
2022
+
2023
+ <a name="put_quality_keywordset"></a>
2024
+
2025
+ ## -[**KeywordSet**](KeywordSet.html) put_quality_keywordset(keyword_set_id, body)
2026
+
2027
+ Update a keywordSet to the specified keywordSet via PUT.
2028
+
2029
+
2030
+
2031
+ Wraps PUT /api/v2/quality/keywordsets/{keywordSetId}
2032
+
2033
+
2034
+ ### Example
2035
+ ~~~ruby
2036
+ # load the gem
2037
+ require 'purecloudplatformclientv2'
2038
+ # setup authorization
2039
+ @secret = ENV['PURECLOUD_SECRET']
2040
+ @id = ENV['PURECLOUD_CLIENT_ID']
2041
+ environment = "mypurecloud.com"
2042
+
2043
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2044
+
2045
+ PureCloud.configure do |config|
2046
+ config.access_token = @authToken
2047
+ end
2048
+
2049
+ api_instance = PureCloud::QualityApi.new
2050
+
2051
+ keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID
2052
+
2053
+ body = PureCloud::KeywordSet.new # KeywordSet | keywordSet
2054
+
2055
+
2056
+ begin
2057
+ #Update a keywordSet to the specified keywordSet via PUT.
2058
+ result = api_instance.put_quality_keywordset(keyword_set_id, body)
2059
+ p result
2060
+ rescue PureCloud::ApiError => e
2061
+ puts "Exception when calling QualityApi->put_quality_keywordset: #{e}"
2062
+ end
2063
+ ~~~
2064
+
2065
+ ### Parameters
2066
+
2067
+ Name | Type | Description | Notes
2068
+ ------------- | ------------- | ------------- | -------------
2069
+ **keyword_set_id** | **String**| KeywordSet ID |
2070
+ **body** | [**KeywordSet**](KeywordSet.html)| keywordSet |
2071
+ {: class="table table-striped"}
2072
+
2073
+
2074
+ ### Return type
2075
+
2076
+ [**KeywordSet**](KeywordSet.html)
2077
+
2078
+ ### HTTP request headers
2079
+
2080
+ - **Content-Type**: application/json
2081
+ - **Accept**: application/json
2082
+
2083
+
2084
+