purecloudplatformclientv2 60.0.0 → 64.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (858) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActionEntityListing.md +1 -1
  4. data/docs/AgentActivityEntityListing.md +1 -1
  5. data/docs/AnalyticsApi.md +299 -32
  6. data/docs/AnalyticsConversationAsyncQueryResponse.md +14 -0
  7. data/docs/AnalyticsEvaluation.md +1 -1
  8. data/docs/AnalyticsParticipant.md +1 -0
  9. data/docs/ArchitectApi.md +85 -16
  10. data/docs/ArrayNode.md +4 -4
  11. data/docs/AsyncConversationQuery.md +6 -6
  12. data/docs/AsyncQueryResponse.md +13 -0
  13. data/docs/AsyncQueryStatus.md +17 -0
  14. data/docs/AttemptLimitsEntityListing.md +1 -1
  15. data/docs/Attribute.md +2 -2
  16. data/docs/AuthorizationApi.md +11 -7
  17. data/docs/AuthzDivisionEntityListing.md +1 -1
  18. data/docs/BillingApi.md +4 -4
  19. data/docs/BillingUsageReport.md +1 -0
  20. data/docs/CalibrationEntityListing.md +1 -1
  21. data/docs/CallConversationEntityListing.md +1 -1
  22. data/docs/CallHistoryConversationEntityListing.md +1 -1
  23. data/docs/CallMediaParticipant.md +6 -6
  24. data/docs/CallableContactsDiagnostic.md +4 -4
  25. data/docs/CallableTimeSetEntityListing.md +1 -1
  26. data/docs/CallbackConversationEntityListing.md +1 -1
  27. data/docs/CallbackMediaParticipant.md +5 -5
  28. data/docs/Campaign.md +11 -11
  29. data/docs/CampaignDivisionViewListing.md +1 -1
  30. data/docs/CampaignEntityListing.md +1 -1
  31. data/docs/CampaignInteraction.md +6 -6
  32. data/docs/CampaignInteractions.md +1 -1
  33. data/docs/CampaignProgress.md +2 -2
  34. data/docs/CampaignRuleActionEntities.md +2 -2
  35. data/docs/CampaignRuleEntities.md +2 -2
  36. data/docs/CampaignRuleEntityListing.md +1 -1
  37. data/docs/CampaignSchedule.md +1 -1
  38. data/docs/CampaignSequence.md +1 -1
  39. data/docs/CampaignSequenceEntityListing.md +1 -1
  40. data/docs/CertificateAuthorityEntityListing.md +1 -1
  41. data/docs/ChatConversationEntityListing.md +1 -1
  42. data/docs/ChatMediaParticipant.md +5 -5
  43. data/docs/ClientAppEntityListing.md +1 -1
  44. data/docs/CobrowseConversationEntityListing.md +1 -1
  45. data/docs/CobrowseMediaParticipant.md +5 -5
  46. data/docs/CommandStatusEntityListing.md +1 -1
  47. data/docs/ConsumedResourcesEntityListing.md +1 -1
  48. data/docs/ConsumingResourcesEntityListing.md +1 -1
  49. data/docs/ContactList.md +2 -2
  50. data/docs/ContactListDivisionViewListing.md +1 -1
  51. data/docs/ContactListEntityListing.md +1 -1
  52. data/docs/ContactListFilter.md +1 -1
  53. data/docs/ContactListFilterEntityListing.md +1 -1
  54. data/docs/ContactListing.md +1 -1
  55. data/docs/ConversationAggregateDataContainer.md +14 -0
  56. data/docs/ConversationAggregateQueryClause.md +14 -0
  57. data/docs/ConversationAggregateQueryFilter.md +15 -0
  58. data/docs/ConversationAggregateQueryPredicate.md +17 -0
  59. data/docs/ConversationAggregateQueryResponse.md +13 -0
  60. data/docs/ConversationAggregationQuery.md +20 -0
  61. data/docs/ConversationAggregationView.md +16 -0
  62. data/docs/ConversationDetailQueryClause.md +14 -0
  63. data/docs/ConversationDetailQueryFilter.md +15 -0
  64. data/docs/ConversationDetailQueryPredicate.md +18 -0
  65. data/docs/ConversationDivisionMembership.md +2 -2
  66. data/docs/ConversationEntityListing.md +1 -1
  67. data/docs/ConversationQuery.md +6 -6
  68. data/docs/ConversationsApi.md +2259 -498
  69. data/docs/CreateCallbackResponse.md +1 -1
  70. data/docs/CreateQueueMediaAssociationRequest.md +1 -0
  71. data/docs/CreateQueueRequest.md +2 -2
  72. data/docs/CreateShareResponse.md +4 -4
  73. data/docs/CreateUser.md +1 -0
  74. data/docs/CredentialInfoListing.md +1 -1
  75. data/docs/CredentialTypeListing.md +1 -1
  76. data/docs/DID.md +2 -2
  77. data/docs/DIDEntityListing.md +1 -1
  78. data/docs/DIDPoolEntityListing.md +1 -1
  79. data/docs/DataSchema.md +3 -3
  80. data/docs/DataTableImportJob.md +24 -0
  81. data/docs/DataTableRowEntityListing.md +1 -1
  82. data/docs/DataTablesDomainEntityListing.md +1 -1
  83. data/docs/DependencyObjectEntityListing.md +1 -1
  84. data/docs/DependencyStatus.md +2 -1
  85. data/docs/DependencyTypeEntityListing.md +1 -1
  86. data/docs/DialerEventEntityListing.md +1 -1
  87. data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
  88. data/docs/DirectoryUserDevicesListing.md +1 -1
  89. data/docs/DncList.md +1 -1
  90. data/docs/DncListCreate.md +1 -1
  91. data/docs/DncListDivisionViewListing.md +1 -1
  92. data/docs/DncListEntityListing.md +1 -1
  93. data/docs/Document.md +4 -4
  94. data/docs/DocumentAudit.md +2 -2
  95. data/docs/DocumentAuditEntityListing.md +1 -1
  96. data/docs/DocumentEntityListing.md +1 -1
  97. data/docs/DocumentUpload.md +1 -1
  98. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  99. data/docs/DomainEntityListing.md +1 -1
  100. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  101. data/docs/DomainEntityListingQueryResult.md +1 -1
  102. data/docs/DomainEntityListingSurveyForm.md +1 -1
  103. data/docs/{UriReference.md → DomainEntityRef.md} +2 -2
  104. data/docs/DomainOrganizationRole.md +1 -0
  105. data/docs/DomainOrganizationRoleCreate.md +1 -0
  106. data/docs/DomainOrganizationRoleUpdate.md +1 -0
  107. data/docs/EdgeEntityListing.md +1 -1
  108. data/docs/EdgeGroupEntityListing.md +1 -1
  109. data/docs/EdgeInterface.md +1 -1
  110. data/docs/EdgeLine.md +1 -1
  111. data/docs/EdgeLineEntityListing.md +1 -1
  112. data/docs/EdgeMetrics.md +1 -1
  113. data/docs/EdgeTrunkBase.md +1 -1
  114. data/docs/EmailConversationEntityListing.md +1 -1
  115. data/docs/EmailMediaParticipant.md +5 -5
  116. data/docs/EmailMessageListing.md +1 -1
  117. data/docs/EmbeddedIntegration.md +14 -0
  118. data/docs/EmergencyCallFlow.md +2 -2
  119. data/docs/EmergencyGroupListing.md +1 -1
  120. data/docs/EncryptionKeyEntityListing.md +1 -1
  121. data/docs/Endpoint.md +2 -2
  122. data/docs/EvaluationAggregateDataContainer.md +14 -0
  123. data/docs/EvaluationAggregateQueryClause.md +14 -0
  124. data/docs/EvaluationAggregateQueryFilter.md +15 -0
  125. data/docs/EvaluationAggregateQueryPredicate.md +17 -0
  126. data/docs/EvaluationAggregateQueryResponse.md +13 -0
  127. data/docs/EvaluationAggregationQuery.md +20 -0
  128. data/docs/EvaluationAggregationView.md +16 -0
  129. data/docs/EvaluationDetailQueryClause.md +14 -0
  130. data/docs/EvaluationDetailQueryFilter.md +15 -0
  131. data/docs/EvaluationDetailQueryPredicate.md +18 -0
  132. data/docs/EvaluationEntityListing.md +1 -1
  133. data/docs/EvaluationFormEntityListing.md +1 -1
  134. data/docs/EvaluatorActivityEntityListing.md +1 -1
  135. data/docs/EventLog.md +2 -2
  136. data/docs/Extension.md +2 -2
  137. data/docs/ExtensionEntityListing.md +1 -1
  138. data/docs/ExtensionPoolEntityListing.md +1 -1
  139. data/docs/ExternalOrganizationListing.md +1 -1
  140. data/docs/FacebookIntegration.md +3 -3
  141. data/docs/FacebookIntegrationEntityListing.md +1 -1
  142. data/docs/FaxDocument.md +2 -2
  143. data/docs/FaxDocumentEntityListing.md +1 -1
  144. data/docs/Flow.md +2 -1
  145. data/docs/{AggregateDataContainer.md → FlowAggregateDataContainer.md} +2 -2
  146. data/docs/FlowAggregateQueryClause.md +14 -0
  147. data/docs/FlowAggregateQueryFilter.md +15 -0
  148. data/docs/FlowAggregateQueryPredicate.md +17 -0
  149. data/docs/FlowAggregateQueryResponse.md +13 -0
  150. data/docs/{AggregationQuery.md → FlowAggregationQuery.md} +4 -4
  151. data/docs/{AnalyticsView.md → FlowAggregationView.md} +3 -3
  152. data/docs/FlowDivisionViewEntityListing.md +1 -1
  153. data/docs/FlowEntityListing.md +1 -1
  154. data/docs/{ObservationDataContainer.md → FlowObservationDataContainer.md} +2 -2
  155. data/docs/{ObservationQuery.md → FlowObservationQuery.md} +3 -3
  156. data/docs/FlowObservationQueryClause.md +14 -0
  157. data/docs/FlowObservationQueryFilter.md +15 -0
  158. data/docs/FlowObservationQueryPredicate.md +17 -0
  159. data/docs/FlowObservationQueryResponse.md +13 -0
  160. data/docs/FlowOutcomeListing.md +1 -1
  161. data/docs/FlowVersion.md +1 -0
  162. data/docs/FlowVersionEntityListing.md +1 -1
  163. data/docs/FlowsApi.md +8 -8
  164. data/docs/GDPRRequest.md +1 -1
  165. data/docs/GDPRRequestEntityListing.md +1 -1
  166. data/docs/GDPRSubjectEntityListing.md +1 -1
  167. data/docs/GreetingListing.md +1 -1
  168. data/docs/GroupContact.md +1 -0
  169. data/docs/GroupEntityListing.md +1 -1
  170. data/docs/GroupProfileEntityListing.md +1 -1
  171. data/docs/GroupsApi.md +1 -1
  172. data/docs/HistoryEntry.md +2 -1
  173. data/docs/HistoryListing.md +1 -0
  174. data/docs/IVR.md +4 -4
  175. data/docs/IVREntityListing.md +1 -1
  176. data/docs/InboundDomainEntityListing.md +1 -1
  177. data/docs/InboundRoute.md +5 -5
  178. data/docs/InboundRouteEntityListing.md +1 -1
  179. data/docs/IntegrationEntityListing.md +1 -1
  180. data/docs/IntegrationEventEntityListing.md +1 -1
  181. data/docs/IntegrationExport.md +2 -2
  182. data/docs/IntegrationTypeEntityListing.md +1 -1
  183. data/docs/InteractionStatsAlertContainer.md +1 -1
  184. data/docs/InteractionStatsRuleContainer.md +1 -1
  185. data/docs/JsonNode.md +4 -4
  186. data/docs/KeywordSetEntityListing.md +1 -1
  187. data/docs/LanguageEntityListing.md +1 -1
  188. data/docs/LexBotAliasEntityListing.md +1 -1
  189. data/docs/LexBotEntityListing.md +1 -1
  190. data/docs/LibraryEntityListing.md +1 -1
  191. data/docs/Line.md +6 -6
  192. data/docs/LineBase.md +1 -1
  193. data/docs/LineBaseEntityListing.md +1 -1
  194. data/docs/LineEntityListing.md +1 -1
  195. data/docs/LineIntegration.md +3 -3
  196. data/docs/LineIntegrationEntityListing.md +1 -1
  197. data/docs/Location.md +4 -4
  198. data/docs/{LocationUpdateDefinition.md → LocationCreateUpdateDefinition.md} +7 -6
  199. data/docs/LocationDefinition.md +1 -0
  200. data/docs/LocationEntityListing.md +1 -1
  201. data/docs/LocationSearchRequest.md +1 -0
  202. data/docs/LocationsApi.md +6 -6
  203. data/docs/LockInfo.md +1 -1
  204. data/docs/LogicalInterfaceEntityListing.md +1 -1
  205. data/docs/ManagementUnitListing.md +1 -1
  206. data/docs/Manager.md +2 -2
  207. data/docs/MediaEndpointStatDetailQueryClause.md +14 -0
  208. data/docs/MediaEndpointStatDetailQueryFilter.md +15 -0
  209. data/docs/MediaEndpointStatDetailQueryPredicate.md +17 -0
  210. data/docs/MessageConversationEntityListing.md +1 -1
  211. data/docs/MessageInfo.md +4 -4
  212. data/docs/MessageMediaParticipant.md +5 -5
  213. data/docs/MessagingApi.md +7 -1015
  214. data/docs/MessagingIntegration.md +3 -3
  215. data/docs/MessagingIntegrationEntityListing.md +1 -1
  216. data/docs/MessagingStickerEntityListing.md +1 -1
  217. data/docs/NoteListing.md +1 -1
  218. data/docs/OAuthClient.md +2 -2
  219. data/docs/OAuthClientEntityListing.md +1 -1
  220. data/docs/OAuthClientListing.md +2 -2
  221. data/docs/OAuthProviderEntityListing.md +1 -1
  222. data/docs/ObjectsApi.md +1 -1
  223. data/docs/Operation.md +1 -0
  224. data/docs/OrgOAuthClient.md +2 -2
  225. data/docs/OrganizationApi.md +133 -8
  226. data/docs/OrganizationPresenceEntityListing.md +1 -1
  227. data/docs/OrganizationRoleEntityListing.md +1 -1
  228. data/docs/OrphanRecordingListing.md +1 -1
  229. data/docs/OutboundApi.md +4 -4
  230. data/docs/OutboundRoute.md +1 -1
  231. data/docs/OutboundRouteBase.md +1 -1
  232. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  233. data/docs/OutboundRouteEntityListing.md +1 -1
  234. data/docs/PermissionCollectionEntityListing.md +1 -1
  235. data/docs/Phone.md +5 -5
  236. data/docs/PhoneBase.md +1 -1
  237. data/docs/PhoneBaseEntityListing.md +1 -1
  238. data/docs/PhoneEntityListing.md +1 -1
  239. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  240. data/docs/PhoneStatus.md +1 -1
  241. data/docs/Photo.md +2 -2
  242. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  243. data/docs/PolicyEntityListing.md +1 -1
  244. data/docs/PresenceDetailQueryClause.md +14 -0
  245. data/docs/PresenceDetailQueryFilter.md +15 -0
  246. data/docs/PresenceDetailQueryPredicate.md +17 -0
  247. data/docs/PromptAssetEntityListing.md +1 -1
  248. data/docs/PromptEntityListing.md +1 -1
  249. data/docs/QualityApi.md +8 -8
  250. data/docs/QualityAuditPage.md +1 -1
  251. data/docs/Queue.md +2 -2
  252. data/docs/QueueEmailAddress.md +1 -1
  253. data/docs/QueueEntityListing.md +1 -1
  254. data/docs/QueueMediaAssociation.md +1 -1
  255. data/docs/QueueMemberEntityListing.md +1 -1
  256. data/docs/QueueMessagingAddresses.md +1 -1
  257. data/docs/QueueObservationDataContainer.md +14 -0
  258. data/docs/QueueObservationQuery.md +15 -0
  259. data/docs/QueueObservationQueryClause.md +14 -0
  260. data/docs/QueueObservationQueryFilter.md +15 -0
  261. data/docs/QueueObservationQueryPredicate.md +17 -0
  262. data/docs/{QualifierMappingObservationQueryResponse.md → QueueObservationQueryResponse.md} +3 -3
  263. data/docs/QueueRequest.md +2 -2
  264. data/docs/QueueUtilizationDiagnostic.md +1 -1
  265. data/docs/RecipientListing.md +1 -1
  266. data/docs/Recording.md +4 -4
  267. data/docs/RecordingApi.md +11 -3
  268. data/docs/RecordingJob.md +1 -0
  269. data/docs/RecordingJobEntityListing.md +1 -1
  270. data/docs/RecordingJobsQuery.md +2 -0
  271. data/docs/RecordingMetadata.md +29 -0
  272. data/docs/RelationshipListing.md +1 -1
  273. data/docs/ReplaceResponse.md +1 -1
  274. data/docs/ReportMetaDataEntityListing.md +1 -1
  275. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  276. data/docs/ReportScheduleEntityListing.md +1 -1
  277. data/docs/ReportingExportJobListing.md +1 -1
  278. data/docs/ReportingExportJobRequest.md +1 -0
  279. data/docs/ReportingExportJobResponse.md +1 -0
  280. data/docs/Response.md +1 -1
  281. data/docs/ResponseEntityList.md +1 -1
  282. data/docs/ResponseEntityListing.md +1 -1
  283. data/docs/ResponseSetEntityListing.md +1 -1
  284. data/docs/RoutingApi.md +144 -7
  285. data/docs/RoutingStatusDetailQueryClause.md +14 -0
  286. data/docs/RoutingStatusDetailQueryFilter.md +15 -0
  287. data/docs/RoutingStatusDetailQueryPredicate.md +17 -0
  288. data/docs/RuleSet.md +2 -2
  289. data/docs/RuleSetDiagnostic.md +1 -1
  290. data/docs/RuleSetEntityListing.md +1 -1
  291. data/docs/SCIMApi.md +278 -0
  292. data/docs/ScheduleEntityListing.md +1 -1
  293. data/docs/ScheduleGroup.md +3 -3
  294. data/docs/ScheduleGroupEntityListing.md +1 -1
  295. data/docs/SchemaCategoryEntityListing.md +1 -1
  296. data/docs/SchemaReferenceEntityListing.md +1 -1
  297. data/docs/ScimConfigResourceType.md +20 -0
  298. data/docs/ScimConfigResourceTypeSchemaExtension.md +14 -0
  299. data/docs/ScimConfigResourceTypesListResponse.md +17 -0
  300. data/docs/ScimEmail.md +3 -3
  301. data/docs/ScimError.md +16 -0
  302. data/docs/ScimGroupListResponse.md +4 -4
  303. data/docs/ScimMetadata.md +4 -4
  304. data/docs/ScimPhoneNumber.md +3 -3
  305. data/docs/ScimServiceProviderConfig.md +9 -1
  306. data/docs/ScimServiceProviderConfigAuthenticationScheme.md +18 -0
  307. data/docs/ScimServiceProviderConfigBulkFeature.md +15 -0
  308. data/docs/ScimServiceProviderConfigFilterFeature.md +14 -0
  309. data/docs/ScimServiceProviderConfigSimpleFeature.md +13 -0
  310. data/docs/ScimUserListResponse.md +4 -4
  311. data/docs/ScimV2CreateUser.md +12 -12
  312. data/docs/ScimV2EnterpriseUser.md +3 -3
  313. data/docs/ScimV2Group.md +4 -4
  314. data/docs/ScimV2GroupReference.md +3 -4
  315. data/docs/ScimV2MemberReference.md +3 -4
  316. data/docs/ScimV2PatchOperation.md +3 -3
  317. data/docs/ScimV2PatchRequest.md +1 -1
  318. data/docs/ScimV2User.md +14 -13
  319. data/docs/ScreenRecordingSessionListing.md +1 -1
  320. data/docs/ScriptEntityListing.md +1 -1
  321. data/docs/SearchApi.md +4 -4
  322. data/docs/SecureSession.md +1 -1
  323. data/docs/SecurityProfileEntityListing.md +1 -1
  324. data/docs/SegmentDetailQueryClause.md +14 -0
  325. data/docs/SegmentDetailQueryFilter.md +15 -0
  326. data/docs/{AnalyticsQueryPredicate.md → SegmentDetailQueryPredicate.md} +4 -4
  327. data/docs/SequenceSchedule.md +1 -1
  328. data/docs/Share.md +4 -4
  329. data/docs/ShareEntityListing.md +1 -1
  330. data/docs/Site.md +2 -2
  331. data/docs/SiteEntityListing.md +1 -1
  332. data/docs/SkillEntityListing.md +1 -1
  333. data/docs/SmsAddress.md +21 -0
  334. data/docs/SmsAddressEntityListing.md +22 -0
  335. data/docs/SmsPhoneNumber.md +2 -0
  336. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  337. data/docs/SmsPhoneNumberProvision.md +1 -0
  338. data/docs/SpeechTextAnalyticsApi.md +14 -144
  339. data/docs/Station.md +2 -2
  340. data/docs/StationEntityListing.md +1 -1
  341. data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
  342. data/docs/SuggestApi.md +2 -2
  343. data/docs/Survey.md +1 -1
  344. data/docs/SurveyAggregateDataContainer.md +14 -0
  345. data/docs/SurveyAggregateQueryClause.md +14 -0
  346. data/docs/SurveyAggregateQueryFilter.md +15 -0
  347. data/docs/SurveyAggregateQueryPredicate.md +17 -0
  348. data/docs/SurveyAggregateQueryResponse.md +13 -0
  349. data/docs/SurveyAggregationQuery.md +20 -0
  350. data/docs/SurveyAggregationView.md +16 -0
  351. data/docs/SurveyAssignment.md +1 -1
  352. data/docs/SurveyDetailQueryClause.md +14 -0
  353. data/docs/SurveyDetailQueryFilter.md +15 -0
  354. data/docs/SurveyDetailQueryPredicate.md +18 -0
  355. data/docs/SurveyFormEntityListing.md +1 -1
  356. data/docs/SystemPromptAssetEntityListing.md +1 -1
  357. data/docs/SystemPromptEntityListing.md +1 -1
  358. data/docs/TagValueEntityListing.md +1 -1
  359. data/docs/TelephonyProvidersEdgeApi.md +10 -6
  360. data/docs/TextMessageListing.md +1 -1
  361. data/docs/TimeZoneEntityListing.md +1 -1
  362. data/docs/TimeZoneMappingPreview.md +1 -1
  363. data/docs/TokenInfo.md +1 -0
  364. data/docs/TokensApi.md +2 -1
  365. data/docs/TranscriptProperty.md +15 -0
  366. data/docs/Trunk.md +5 -5
  367. data/docs/TrunkBase.md +1 -1
  368. data/docs/TrunkBaseEntityListing.md +1 -1
  369. data/docs/TrunkEntityListing.md +1 -1
  370. data/docs/TrunkMetabaseEntityListing.md +1 -1
  371. data/docs/TrunkMetrics.md +2 -2
  372. data/docs/TrustEntityListing.md +1 -1
  373. data/docs/TrustUserEntityListing.md +1 -1
  374. data/docs/TrustorEntityListing.md +1 -1
  375. data/docs/TtsEngineEntityListing.md +1 -1
  376. data/docs/TtsVoiceEntityListing.md +1 -1
  377. data/docs/TwitterIntegration.md +3 -3
  378. data/docs/TwitterIntegrationEntityListing.md +1 -1
  379. data/docs/UserActionCategoryEntityListing.md +1 -1
  380. data/docs/UserAggregateDataContainer.md +14 -0
  381. data/docs/UserAggregateQueryClause.md +14 -0
  382. data/docs/UserAggregateQueryFilter.md +15 -0
  383. data/docs/UserAggregateQueryPredicate.md +17 -0
  384. data/docs/{PresenceQueryResponse.md → UserAggregateQueryResponse.md} +3 -3
  385. data/docs/UserAggregationQuery.md +20 -0
  386. data/docs/UserAggregationView.md +16 -0
  387. data/docs/UserAuthorization.md +1 -0
  388. data/docs/UserDetailQueryClause.md +14 -0
  389. data/docs/UserDetailQueryFilter.md +15 -0
  390. data/docs/UserDetailQueryPredicate.md +17 -0
  391. data/docs/UserDetailsQuery.md +3 -3
  392. data/docs/UserEntityListing.md +1 -1
  393. data/docs/UserLanguageEntityListing.md +1 -1
  394. data/docs/UserObservationDataContainer.md +14 -0
  395. data/docs/UserObservationQuery.md +15 -0
  396. data/docs/UserObservationQueryClause.md +14 -0
  397. data/docs/UserObservationQueryFilter.md +15 -0
  398. data/docs/UserObservationQueryPredicate.md +17 -0
  399. data/docs/UserObservationQueryResponse.md +13 -0
  400. data/docs/UserProfileEntityListing.md +1 -1
  401. data/docs/UserQueue.md +2 -2
  402. data/docs/UserQueueEntityListing.md +1 -1
  403. data/docs/UserRecording.md +2 -2
  404. data/docs/UserRecordingEntityListing.md +1 -1
  405. data/docs/UserSkillEntityListing.md +1 -1
  406. data/docs/UserTokensTopicTokenNotification.md +3 -0
  407. data/docs/UsersApi.md +19 -19
  408. data/docs/VoicemailMessageEntityListing.md +1 -1
  409. data/docs/WebChatDeployment.md +1 -1
  410. data/docs/WebChatMemberInfoEntityList.md +1 -1
  411. data/docs/WhatsAppIntegration.md +25 -0
  412. data/docs/WhatsAppIntegrationEntityListing.md +22 -0
  413. data/docs/WhatsAppIntegrationUpdateRequest.md +18 -0
  414. data/docs/WidgetDeployment.md +1 -1
  415. data/docs/WorkforceManagementApi.md +1 -1
  416. data/docs/Workspace.md +1 -1
  417. data/docs/WorkspaceEntityListing.md +1 -1
  418. data/docs/WorkspaceMember.md +2 -2
  419. data/docs/WorkspaceMemberEntityListing.md +1 -1
  420. data/docs/WrapupCodeEntityListing.md +1 -1
  421. data/lib/purecloudplatformclientv2.rb +99 -20
  422. data/lib/purecloudplatformclientv2/api/analytics_api.rb +292 -24
  423. data/lib/purecloudplatformclientv2/api/architect_api.rb +81 -6
  424. data/lib/purecloudplatformclientv2/api/authorization_api.rb +15 -6
  425. data/lib/purecloudplatformclientv2/api/billing_api.rb +4 -4
  426. data/lib/purecloudplatformclientv2/api/conversations_api.rb +2663 -810
  427. data/lib/purecloudplatformclientv2/api/flows_api.rb +6 -6
  428. data/lib/purecloudplatformclientv2/api/locations_api.rb +2 -2
  429. data/lib/purecloudplatformclientv2/api/messaging_api.rb +10 -1042
  430. data/lib/purecloudplatformclientv2/api/objects_api.rb +2 -2
  431. data/lib/purecloudplatformclientv2/api/organization_api.rb +124 -4
  432. data/lib/purecloudplatformclientv2/api/outbound_api.rb +6 -6
  433. data/lib/purecloudplatformclientv2/api/quality_api.rb +6 -6
  434. data/lib/purecloudplatformclientv2/api/recording_api.rb +51 -3
  435. data/lib/purecloudplatformclientv2/api/routing_api.rb +153 -6
  436. data/lib/purecloudplatformclientv2/api/scim_api.rb +332 -0
  437. data/lib/purecloudplatformclientv2/api/search_api.rb +2 -2
  438. data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +19 -139
  439. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +22 -4
  440. data/lib/purecloudplatformclientv2/api/users_api.rb +8 -8
  441. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +2 -2
  442. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  443. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
  444. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
  445. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +1 -15
  446. data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +229 -0
  447. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  448. data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
  449. data/lib/purecloudplatformclientv2/models/analytics_participant.rb +31 -3
  450. data/lib/purecloudplatformclientv2/models/array_node.rb +57 -57
  451. data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +28 -28
  452. data/lib/purecloudplatformclientv2/models/async_query_response.rb +202 -0
  453. data/lib/purecloudplatformclientv2/models/async_query_status.rb +320 -0
  454. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
  455. data/lib/purecloudplatformclientv2/models/attribute.rb +2 -2
  456. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
  457. data/lib/purecloudplatformclientv2/models/billing_usage_report.rb +41 -1
  458. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
  459. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
  460. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
  461. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +6 -6
  462. data/lib/purecloudplatformclientv2/models/callable_contacts_diagnostic.rb +4 -4
  463. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
  464. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
  465. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +5 -5
  466. data/lib/purecloudplatformclientv2/models/campaign.rb +11 -11
  467. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
  468. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
  469. data/lib/purecloudplatformclientv2/models/campaign_interaction.rb +6 -6
  470. data/lib/purecloudplatformclientv2/models/campaign_interactions.rb +1 -1
  471. data/lib/purecloudplatformclientv2/models/campaign_progress.rb +2 -2
  472. data/lib/purecloudplatformclientv2/models/campaign_rule_action_entities.rb +2 -2
  473. data/lib/purecloudplatformclientv2/models/campaign_rule_entities.rb +2 -2
  474. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
  475. data/lib/purecloudplatformclientv2/models/campaign_schedule.rb +1 -1
  476. data/lib/purecloudplatformclientv2/models/campaign_sequence.rb +1 -1
  477. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
  478. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
  479. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
  480. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +5 -5
  481. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
  482. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
  483. data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +5 -5
  484. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
  485. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
  486. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
  487. data/lib/purecloudplatformclientv2/models/contact_list.rb +2 -2
  488. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
  489. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
  490. data/lib/purecloudplatformclientv2/models/contact_list_filter.rb +1 -1
  491. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
  492. data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
  493. data/lib/purecloudplatformclientv2/models/conversation_aggregate_data_container.rb +231 -0
  494. data/lib/purecloudplatformclientv2/models/{analytics_query_clause.rb → conversation_aggregate_query_clause.rb} +3 -3
  495. data/lib/purecloudplatformclientv2/models/{analytics_query_filter.rb → conversation_aggregate_query_filter.rb} +4 -4
  496. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +348 -0
  497. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_response.rb +203 -0
  498. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +390 -0
  499. data/lib/purecloudplatformclientv2/models/conversation_aggregation_view.rb +323 -0
  500. data/lib/purecloudplatformclientv2/models/conversation_detail_query_clause.rb +254 -0
  501. data/lib/purecloudplatformclientv2/models/conversation_detail_query_filter.rb +277 -0
  502. data/lib/purecloudplatformclientv2/models/conversation_detail_query_predicate.rb +388 -0
  503. data/lib/purecloudplatformclientv2/models/conversation_division_membership.rb +2 -2
  504. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
  505. data/lib/purecloudplatformclientv2/models/conversation_query.rb +28 -28
  506. data/lib/purecloudplatformclientv2/models/create_callback_response.rb +1 -1
  507. data/lib/purecloudplatformclientv2/models/create_queue_media_association_request.rb +27 -1
  508. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +2 -2
  509. data/lib/purecloudplatformclientv2/models/create_share_response.rb +4 -4
  510. data/lib/purecloudplatformclientv2/models/create_user.rb +44 -4
  511. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
  512. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
  513. data/lib/purecloudplatformclientv2/models/data_schema.rb +3 -3
  514. data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +521 -0
  515. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
  516. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
  517. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  518. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  519. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
  520. data/lib/purecloudplatformclientv2/models/dependency_status.rb +28 -1
  521. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
  522. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
  523. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
  524. data/lib/purecloudplatformclientv2/models/did.rb +2 -2
  525. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
  526. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
  527. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
  528. data/lib/purecloudplatformclientv2/models/dnc_list.rb +1 -1
  529. data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +1 -1
  530. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
  531. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
  532. data/lib/purecloudplatformclientv2/models/document.rb +4 -4
  533. data/lib/purecloudplatformclientv2/models/document_audit.rb +2 -2
  534. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
  535. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
  536. data/lib/purecloudplatformclientv2/models/document_upload.rb +1 -1
  537. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
  538. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
  539. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
  540. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
  541. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
  542. data/lib/purecloudplatformclientv2/models/{uri_reference.rb → domain_entity_ref.rb} +1 -1
  543. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +29 -1
  544. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +29 -1
  545. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +29 -1
  546. data/lib/purecloudplatformclientv2/models/edge.rb +2 -2
  547. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
  548. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
  549. data/lib/purecloudplatformclientv2/models/edge_interface.rb +1 -1
  550. data/lib/purecloudplatformclientv2/models/edge_line.rb +1 -1
  551. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
  552. data/lib/purecloudplatformclientv2/models/edge_metrics.rb +1 -1
  553. data/lib/purecloudplatformclientv2/models/edge_trunk_base.rb +1 -1
  554. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
  555. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +5 -5
  556. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
  557. data/lib/purecloudplatformclientv2/models/{base_topic_entitiy.rb → embedded_integration.rb} +16 -41
  558. data/lib/purecloudplatformclientv2/models/emergency_call_flow.rb +2 -2
  559. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
  560. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
  561. data/lib/purecloudplatformclientv2/models/endpoint.rb +2 -2
  562. data/lib/purecloudplatformclientv2/models/evaluation_aggregate_data_container.rb +231 -0
  563. data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_clause.rb +254 -0
  564. data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_filter.rb +277 -0
  565. data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_predicate.rb +348 -0
  566. data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_response.rb +203 -0
  567. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +390 -0
  568. data/lib/purecloudplatformclientv2/models/{analytics_view.rb → evaluation_aggregation_view.rb} +17 -3
  569. data/lib/purecloudplatformclientv2/models/evaluation_detail_query_clause.rb +254 -0
  570. data/lib/purecloudplatformclientv2/models/evaluation_detail_query_filter.rb +277 -0
  571. data/lib/purecloudplatformclientv2/models/{create_topic_request.rb → evaluation_detail_query_predicate.rb} +91 -141
  572. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
  573. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
  574. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
  575. data/lib/purecloudplatformclientv2/models/event_log.rb +2 -2
  576. data/lib/purecloudplatformclientv2/models/extension.rb +2 -2
  577. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
  578. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
  579. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
  580. data/lib/purecloudplatformclientv2/models/facebook_integration.rb +3 -3
  581. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
  582. data/lib/purecloudplatformclientv2/models/fax_document.rb +2 -2
  583. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
  584. data/lib/purecloudplatformclientv2/models/flow.rb +30 -3
  585. data/lib/purecloudplatformclientv2/models/{aggregate_data_container.rb → flow_aggregate_data_container.rb} +1 -1
  586. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_clause.rb +254 -0
  587. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_filter.rb +277 -0
  588. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +348 -0
  589. data/lib/purecloudplatformclientv2/models/{aggregate_query_response.rb → flow_aggregate_query_response.rb} +2 -2
  590. data/lib/purecloudplatformclientv2/models/{aggregation_query.rb → flow_aggregation_query.rb} +3 -3
  591. data/lib/purecloudplatformclientv2/models/flow_aggregation_view.rb +323 -0
  592. data/lib/purecloudplatformclientv2/models/flow_division_view.rb +2 -2
  593. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
  594. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
  595. data/lib/purecloudplatformclientv2/models/{observation_data_container.rb → flow_observation_data_container.rb} +1 -1
  596. data/lib/purecloudplatformclientv2/models/{observation_query.rb → flow_observation_query.rb} +2 -2
  597. data/lib/purecloudplatformclientv2/models/flow_observation_query_clause.rb +254 -0
  598. data/lib/purecloudplatformclientv2/models/flow_observation_query_filter.rb +277 -0
  599. data/lib/purecloudplatformclientv2/models/flow_observation_query_predicate.rb +348 -0
  600. data/lib/purecloudplatformclientv2/models/{observation_query_response.rb → flow_observation_query_response.rb} +2 -2
  601. data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
  602. data/lib/purecloudplatformclientv2/models/flow_version.rb +26 -1
  603. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
  604. data/lib/purecloudplatformclientv2/models/gdpr_request.rb +1 -1
  605. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
  606. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
  607. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
  608. data/lib/purecloudplatformclientv2/models/group_contact.rb +27 -1
  609. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
  610. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
  611. data/lib/purecloudplatformclientv2/models/history_entry.rb +28 -1
  612. data/lib/purecloudplatformclientv2/models/history_listing.rb +26 -1
  613. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
  614. data/lib/purecloudplatformclientv2/models/inbound_route.rb +5 -5
  615. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
  616. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
  617. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
  618. data/lib/purecloudplatformclientv2/models/integration_export.rb +7 -2
  619. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
  620. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
  621. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
  622. data/lib/purecloudplatformclientv2/models/ivr.rb +4 -4
  623. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
  624. data/lib/purecloudplatformclientv2/models/json_node.rb +57 -57
  625. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
  626. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
  627. data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
  628. data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
  629. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
  630. data/lib/purecloudplatformclientv2/models/line.rb +6 -6
  631. data/lib/purecloudplatformclientv2/models/line_base.rb +1 -1
  632. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
  633. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
  634. data/lib/purecloudplatformclientv2/models/line_integration.rb +3 -3
  635. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
  636. data/lib/purecloudplatformclientv2/models/location.rb +4 -0
  637. data/lib/purecloudplatformclientv2/models/{location_update_definition.rb → location_create_update_definition.rb} +56 -25
  638. data/lib/purecloudplatformclientv2/models/location_definition.rb +27 -1
  639. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
  640. data/lib/purecloudplatformclientv2/models/location_search_request.rb +29 -1
  641. data/lib/purecloudplatformclientv2/models/lock_info.rb +1 -1
  642. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
  643. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
  644. data/lib/purecloudplatformclientv2/models/manager.rb +3 -3
  645. data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_clause.rb +254 -0
  646. data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_filter.rb +277 -0
  647. data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_predicate.rb +348 -0
  648. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
  649. data/lib/purecloudplatformclientv2/models/message_info.rb +4 -0
  650. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +5 -5
  651. data/lib/purecloudplatformclientv2/models/messaging_integration.rb +5 -5
  652. data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
  653. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
  654. data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
  655. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +2 -2
  656. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
  657. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +2 -2
  658. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
  659. data/lib/purecloudplatformclientv2/models/observation_metric_data.rb +1 -15
  660. data/lib/purecloudplatformclientv2/models/operation.rb +26 -1
  661. data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +2 -2
  662. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
  663. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
  664. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
  665. data/lib/purecloudplatformclientv2/models/outbound_route.rb +1 -1
  666. data/lib/purecloudplatformclientv2/models/outbound_route_base.rb +1 -1
  667. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
  668. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
  669. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
  670. data/lib/purecloudplatformclientv2/models/phone.rb +5 -5
  671. data/lib/purecloudplatformclientv2/models/phone_base.rb +1 -1
  672. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
  673. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
  674. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
  675. data/lib/purecloudplatformclientv2/models/phone_status.rb +1 -1
  676. data/lib/purecloudplatformclientv2/models/photo.rb +2 -2
  677. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
  678. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
  679. data/lib/purecloudplatformclientv2/models/presence_detail_query_clause.rb +254 -0
  680. data/lib/purecloudplatformclientv2/models/presence_detail_query_filter.rb +277 -0
  681. data/lib/purecloudplatformclientv2/models/presence_detail_query_predicate.rb +348 -0
  682. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
  683. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
  684. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
  685. data/lib/purecloudplatformclientv2/models/queue.rb +2 -2
  686. data/lib/purecloudplatformclientv2/models/queue_email_address.rb +1 -1
  687. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
  688. data/lib/purecloudplatformclientv2/models/queue_media_association.rb +17 -17
  689. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
  690. data/lib/purecloudplatformclientv2/models/queue_messaging_addresses.rb +1 -1
  691. data/lib/purecloudplatformclientv2/models/queue_observation_data_container.rb +231 -0
  692. data/lib/purecloudplatformclientv2/models/queue_observation_query.rb +263 -0
  693. data/lib/purecloudplatformclientv2/models/queue_observation_query_clause.rb +254 -0
  694. data/lib/purecloudplatformclientv2/models/queue_observation_query_filter.rb +277 -0
  695. data/lib/purecloudplatformclientv2/models/queue_observation_query_predicate.rb +348 -0
  696. data/lib/purecloudplatformclientv2/models/{qualifier_mapping_observation_query_response.rb → queue_observation_query_response.rb} +2 -2
  697. data/lib/purecloudplatformclientv2/models/queue_request.rb +2 -2
  698. data/lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb +1 -1
  699. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
  700. data/lib/purecloudplatformclientv2/models/recording.rb +4 -2
  701. data/lib/purecloudplatformclientv2/models/recording_job.rb +30 -4
  702. data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
  703. data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +55 -3
  704. data/lib/purecloudplatformclientv2/models/recording_metadata.rb +644 -0
  705. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
  706. data/lib/purecloudplatformclientv2/models/replace_response.rb +1 -1
  707. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
  708. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
  709. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
  710. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
  711. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +30 -4
  712. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +27 -1
  713. data/lib/purecloudplatformclientv2/models/response.rb +1 -1
  714. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
  715. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
  716. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
  717. data/lib/purecloudplatformclientv2/models/routing_status_detail_query_clause.rb +254 -0
  718. data/lib/purecloudplatformclientv2/models/routing_status_detail_query_filter.rb +277 -0
  719. data/lib/purecloudplatformclientv2/models/routing_status_detail_query_predicate.rb +348 -0
  720. data/lib/purecloudplatformclientv2/models/rule_set.rb +2 -2
  721. data/lib/purecloudplatformclientv2/models/rule_set_diagnostic.rb +1 -1
  722. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
  723. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
  724. data/lib/purecloudplatformclientv2/models/schedule_group.rb +3 -3
  725. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
  726. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
  727. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
  728. data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +389 -0
  729. data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +229 -0
  730. data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +311 -0
  731. data/lib/purecloudplatformclientv2/models/scim_email.rb +3 -3
  732. data/lib/purecloudplatformclientv2/models/{phrase.rb → scim_error.rb} +57 -57
  733. data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +4 -4
  734. data/lib/purecloudplatformclientv2/models/scim_metadata.rb +7 -7
  735. data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +3 -3
  736. data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +215 -2
  737. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +362 -0
  738. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +255 -0
  739. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +229 -0
  740. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +203 -0
  741. data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +4 -4
  742. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +21 -19
  743. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +3 -3
  744. data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +4 -4
  745. data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +6 -32
  746. data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +6 -32
  747. data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +3 -3
  748. data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +1 -1
  749. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +52 -24
  750. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
  751. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
  752. data/lib/purecloudplatformclientv2/models/secure_session.rb +1 -1
  753. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
  754. data/lib/purecloudplatformclientv2/models/segment_detail_query_clause.rb +254 -0
  755. data/lib/purecloudplatformclientv2/models/segment_detail_query_filter.rb +277 -0
  756. data/lib/purecloudplatformclientv2/models/{analytics_query_predicate.rb → segment_detail_query_predicate.rb} +7 -7
  757. data/lib/purecloudplatformclientv2/models/sequence_schedule.rb +1 -1
  758. data/lib/purecloudplatformclientv2/models/share.rb +4 -4
  759. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
  760. data/lib/purecloudplatformclientv2/models/site.rb +2 -2
  761. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
  762. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
  763. data/lib/purecloudplatformclientv2/models/{program.rb → sms_address.rb} +45 -83
  764. data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +428 -0
  765. data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +67 -1
  766. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
  767. data/lib/purecloudplatformclientv2/models/sms_phone_number_provision.rb +27 -1
  768. data/lib/purecloudplatformclientv2/models/station.rb +2 -2
  769. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
  770. data/lib/purecloudplatformclientv2/models/subject_division_grants.rb +2 -2
  771. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
  772. data/lib/purecloudplatformclientv2/models/survey.rb +1 -1
  773. data/lib/purecloudplatformclientv2/models/survey_aggregate_data_container.rb +231 -0
  774. data/lib/purecloudplatformclientv2/models/survey_aggregate_query_clause.rb +254 -0
  775. data/lib/purecloudplatformclientv2/models/survey_aggregate_query_filter.rb +277 -0
  776. data/lib/purecloudplatformclientv2/models/survey_aggregate_query_predicate.rb +348 -0
  777. data/lib/purecloudplatformclientv2/models/survey_aggregate_query_response.rb +203 -0
  778. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +390 -0
  779. data/lib/purecloudplatformclientv2/models/survey_aggregation_view.rb +323 -0
  780. data/lib/purecloudplatformclientv2/models/survey_assignment.rb +1 -1
  781. data/lib/purecloudplatformclientv2/models/survey_detail_query_clause.rb +254 -0
  782. data/lib/purecloudplatformclientv2/models/survey_detail_query_filter.rb +277 -0
  783. data/lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb +388 -0
  784. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
  785. data/lib/purecloudplatformclientv2/models/system_message_system_message.rb +4 -4
  786. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
  787. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
  788. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
  789. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
  790. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
  791. data/lib/purecloudplatformclientv2/models/time_zone_mapping_preview.rb +1 -1
  792. data/lib/purecloudplatformclientv2/models/token_info.rb +29 -1
  793. data/lib/purecloudplatformclientv2/models/{base_program_entity.rb → transcript_property.rb} +23 -22
  794. data/lib/purecloudplatformclientv2/models/trunk.rb +5 -5
  795. data/lib/purecloudplatformclientv2/models/trunk_base.rb +1 -1
  796. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
  797. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
  798. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
  799. data/lib/purecloudplatformclientv2/models/trunk_metrics.rb +2 -2
  800. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
  801. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
  802. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
  803. data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
  804. data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
  805. data/lib/purecloudplatformclientv2/models/twitter_integration.rb +3 -3
  806. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
  807. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
  808. data/lib/purecloudplatformclientv2/models/user_aggregate_data_container.rb +231 -0
  809. data/lib/purecloudplatformclientv2/models/user_aggregate_query_clause.rb +254 -0
  810. data/lib/purecloudplatformclientv2/models/user_aggregate_query_filter.rb +277 -0
  811. data/lib/purecloudplatformclientv2/models/user_aggregate_query_predicate.rb +348 -0
  812. data/lib/purecloudplatformclientv2/models/{presence_query_response.rb → user_aggregate_query_response.rb} +2 -2
  813. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +390 -0
  814. data/lib/purecloudplatformclientv2/models/user_aggregation_view.rb +323 -0
  815. data/lib/purecloudplatformclientv2/models/user_authorization.rb +29 -1
  816. data/lib/purecloudplatformclientv2/models/user_detail_query_clause.rb +254 -0
  817. data/lib/purecloudplatformclientv2/models/user_detail_query_filter.rb +277 -0
  818. data/lib/purecloudplatformclientv2/models/user_detail_query_predicate.rb +348 -0
  819. data/lib/purecloudplatformclientv2/models/user_details_query.rb +33 -34
  820. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
  821. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
  822. data/lib/purecloudplatformclientv2/models/user_observation_data_container.rb +231 -0
  823. data/lib/purecloudplatformclientv2/models/user_observation_query.rb +263 -0
  824. data/lib/purecloudplatformclientv2/models/user_observation_query_clause.rb +254 -0
  825. data/lib/purecloudplatformclientv2/models/user_observation_query_filter.rb +277 -0
  826. data/lib/purecloudplatformclientv2/models/user_observation_query_predicate.rb +348 -0
  827. data/lib/purecloudplatformclientv2/models/user_observation_query_response.rb +203 -0
  828. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
  829. data/lib/purecloudplatformclientv2/models/user_queue.rb +2 -2
  830. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
  831. data/lib/purecloudplatformclientv2/models/user_recording.rb +2 -2
  832. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
  833. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
  834. data/lib/purecloudplatformclientv2/models/user_tokens_topic_token_notification.rb +79 -4
  835. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
  836. data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +1 -1
  837. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
  838. data/lib/purecloudplatformclientv2/models/{topic.rb → whats_app_integration.rb} +120 -96
  839. data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +428 -0
  840. data/lib/purecloudplatformclientv2/models/whats_app_integration_update_request.rb +365 -0
  841. data/lib/purecloudplatformclientv2/models/widget_deployment.rb +1 -1
  842. data/lib/purecloudplatformclientv2/models/workspace.rb +1 -1
  843. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
  844. data/lib/purecloudplatformclientv2/models/workspace_member.rb +2 -2
  845. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
  846. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
  847. data/lib/purecloudplatformclientv2/version.rb +1 -1
  848. metadata +200 -42
  849. data/docs/AggregateQueryResponse.md +0 -13
  850. data/docs/AnalyticsQueryClause.md +0 -14
  851. data/docs/AnalyticsQueryFilter.md +0 -15
  852. data/docs/BaseProgramEntity.md +0 -15
  853. data/docs/BaseTopicEntitiy.md +0 -15
  854. data/docs/CreateTopicRequest.md +0 -20
  855. data/docs/ObservationQueryResponse.md +0 -13
  856. data/docs/Phrase.md +0 -15
  857. data/docs/Program.md +0 -22
  858. data/docs/Topic.md +0 -25
@@ -24,6 +24,70 @@ module PureCloud
24
24
  @api_client = api_client
25
25
  end
26
26
 
27
+ # Delete/cancel an async request
28
+ #
29
+ # @param job_id jobId
30
+ # @param [Hash] opts the optional parameters
31
+ # @return [nil]
32
+ def delete_analytics_conversations_details_job(job_id, opts = {})
33
+ delete_analytics_conversations_details_job_with_http_info(job_id, opts)
34
+ return nil
35
+ end
36
+
37
+ # Delete/cancel an async request
38
+ #
39
+ # @param job_id jobId
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
42
+ def delete_analytics_conversations_details_job_with_http_info(job_id, opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug "Calling API: AnalyticsApi.delete_analytics_conversations_details_job ..."
45
+ end
46
+
47
+
48
+ # verify the required parameter 'job_id' is set
49
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.delete_analytics_conversations_details_job" if job_id.nil?
50
+
51
+
52
+
53
+
54
+
55
+ # resource path
56
+ local_var_path = "/api/v2/analytics/conversations/details/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
57
+
58
+ # query parameters
59
+ query_params = {}
60
+
61
+ # header parameters
62
+ header_params = {}
63
+
64
+ # HTTP header 'Accept' (if needed)
65
+ local_header_accept = ['application/json']
66
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
67
+
68
+ # HTTP header 'Content-Type'
69
+ local_header_content_type = ['application/json']
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = nil
77
+
78
+ auth_names = ['PureCloud OAuth']
79
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
80
+ :header_params => header_params,
81
+ :query_params => query_params,
82
+ :form_params => form_params,
83
+ :body => post_body,
84
+ :auth_names => auth_names)
85
+ if @api_client.config.debugging
86
+ @api_client.config.logger.debug "API called: AnalyticsApi#delete_analytics_conversations_details_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
+ end
88
+ return data, status_code, headers
89
+ end
90
+
27
91
  # Delete a scheduled report job.
28
92
  #
29
93
  # @param schedule_id Schedule ID
@@ -217,6 +281,145 @@ module PureCloud
217
281
  return data, status_code, headers
218
282
  end
219
283
 
284
+ # Get status for async query for conversation details
285
+ #
286
+ # @param job_id jobId
287
+ # @param [Hash] opts the optional parameters
288
+ # @return [AsyncQueryStatus]
289
+ def get_analytics_conversations_details_job(job_id, opts = {})
290
+ data, _status_code, _headers = get_analytics_conversations_details_job_with_http_info(job_id, opts)
291
+ return data
292
+ end
293
+
294
+ # Get status for async query for conversation details
295
+ #
296
+ # @param job_id jobId
297
+ # @param [Hash] opts the optional parameters
298
+ # @return [Array<(AsyncQueryStatus, Fixnum, Hash)>] AsyncQueryStatus data, response status code and response headers
299
+ def get_analytics_conversations_details_job_with_http_info(job_id, opts = {})
300
+ if @api_client.config.debugging
301
+ @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_conversations_details_job ..."
302
+ end
303
+
304
+
305
+ # verify the required parameter 'job_id' is set
306
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.get_analytics_conversations_details_job" if job_id.nil?
307
+
308
+
309
+
310
+
311
+
312
+ # resource path
313
+ local_var_path = "/api/v2/analytics/conversations/details/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
314
+
315
+ # query parameters
316
+ query_params = {}
317
+
318
+ # header parameters
319
+ header_params = {}
320
+
321
+ # HTTP header 'Accept' (if needed)
322
+ local_header_accept = ['application/json']
323
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
324
+
325
+ # HTTP header 'Content-Type'
326
+ local_header_content_type = ['application/json']
327
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
328
+
329
+ # form parameters
330
+ form_params = {}
331
+
332
+ # http body (model)
333
+ post_body = nil
334
+
335
+ auth_names = ['PureCloud OAuth']
336
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
337
+ :header_params => header_params,
338
+ :query_params => query_params,
339
+ :form_params => form_params,
340
+ :body => post_body,
341
+ :auth_names => auth_names,
342
+ :return_type => 'AsyncQueryStatus')
343
+ if @api_client.config.debugging
344
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_conversations_details_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
345
+ end
346
+ return data, status_code, headers
347
+ end
348
+
349
+ # Fetch a page of results for an async query
350
+ #
351
+ # @param job_id jobId
352
+ # @param [Hash] opts the optional parameters
353
+ # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
354
+ # @return [AnalyticsConversationAsyncQueryResponse]
355
+ def get_analytics_conversations_details_job_results(job_id, opts = {})
356
+ data, _status_code, _headers = get_analytics_conversations_details_job_results_with_http_info(job_id, opts)
357
+ return data
358
+ end
359
+
360
+ # Fetch a page of results for an async query
361
+ #
362
+ # @param job_id jobId
363
+ # @param [Hash] opts the optional parameters
364
+ # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
365
+ # @return [Array<(AnalyticsConversationAsyncQueryResponse, Fixnum, Hash)>] AnalyticsConversationAsyncQueryResponse data, response status code and response headers
366
+ def get_analytics_conversations_details_job_results_with_http_info(job_id, opts = {})
367
+ if @api_client.config.debugging
368
+ @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_conversations_details_job_results ..."
369
+ end
370
+
371
+
372
+ # verify the required parameter 'job_id' is set
373
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.get_analytics_conversations_details_job_results" if job_id.nil?
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+ # resource path
386
+ local_var_path = "/api/v2/analytics/conversations/details/jobs/{jobId}/results".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
387
+
388
+ # query parameters
389
+ query_params = {}
390
+ query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']
391
+
392
+ # header parameters
393
+ header_params = {}
394
+
395
+ # HTTP header 'Accept' (if needed)
396
+ local_header_accept = ['application/json']
397
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
398
+
399
+ # HTTP header 'Content-Type'
400
+ local_header_content_type = ['application/json']
401
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
402
+
403
+ # form parameters
404
+ form_params = {}
405
+
406
+ # http body (model)
407
+ post_body = nil
408
+
409
+ auth_names = ['PureCloud OAuth']
410
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
411
+ :header_params => header_params,
412
+ :query_params => query_params,
413
+ :form_params => form_params,
414
+ :body => post_body,
415
+ :auth_names => auth_names,
416
+ :return_type => 'AnalyticsConversationAsyncQueryResponse')
417
+ if @api_client.config.debugging
418
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_conversations_details_job_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
419
+ end
420
+ return data, status_code, headers
421
+ end
422
+
220
423
  # Get all view export requests for a user
221
424
  #
222
425
  # @param [Hash] opts the optional parameters
@@ -978,7 +1181,7 @@ module PureCloud
978
1181
  #
979
1182
  # @param body query
980
1183
  # @param [Hash] opts the optional parameters
981
- # @return [AggregateQueryResponse]
1184
+ # @return [ConversationAggregateQueryResponse]
982
1185
  def post_analytics_conversations_aggregates_query(body, opts = {})
983
1186
  data, _status_code, _headers = post_analytics_conversations_aggregates_query_with_http_info(body, opts)
984
1187
  return data
@@ -988,7 +1191,7 @@ module PureCloud
988
1191
  #
989
1192
  # @param body query
990
1193
  # @param [Hash] opts the optional parameters
991
- # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers
1194
+ # @return [Array<(ConversationAggregateQueryResponse, Fixnum, Hash)>] ConversationAggregateQueryResponse data, response status code and response headers
992
1195
  def post_analytics_conversations_aggregates_query_with_http_info(body, opts = {})
993
1196
  if @api_client.config.debugging
994
1197
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_conversations_aggregates_query ..."
@@ -1032,13 +1235,78 @@ module PureCloud
1032
1235
  :form_params => form_params,
1033
1236
  :body => post_body,
1034
1237
  :auth_names => auth_names,
1035
- :return_type => 'AggregateQueryResponse')
1238
+ :return_type => 'ConversationAggregateQueryResponse')
1036
1239
  if @api_client.config.debugging
1037
1240
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_conversations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1038
1241
  end
1039
1242
  return data, status_code, headers
1040
1243
  end
1041
1244
 
1245
+ # Query for conversation details asynchronously
1246
+ #
1247
+ # @param body query
1248
+ # @param [Hash] opts the optional parameters
1249
+ # @return [AsyncQueryResponse]
1250
+ def post_analytics_conversations_details_jobs(body, opts = {})
1251
+ data, _status_code, _headers = post_analytics_conversations_details_jobs_with_http_info(body, opts)
1252
+ return data
1253
+ end
1254
+
1255
+ # Query for conversation details asynchronously
1256
+ #
1257
+ # @param body query
1258
+ # @param [Hash] opts the optional parameters
1259
+ # @return [Array<(AsyncQueryResponse, Fixnum, Hash)>] AsyncQueryResponse data, response status code and response headers
1260
+ def post_analytics_conversations_details_jobs_with_http_info(body, opts = {})
1261
+ if @api_client.config.debugging
1262
+ @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_conversations_details_jobs ..."
1263
+ end
1264
+
1265
+
1266
+ # verify the required parameter 'body' is set
1267
+ fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_conversations_details_jobs" if body.nil?
1268
+
1269
+
1270
+
1271
+
1272
+
1273
+ # resource path
1274
+ local_var_path = "/api/v2/analytics/conversations/details/jobs".sub('{format}','json')
1275
+
1276
+ # query parameters
1277
+ query_params = {}
1278
+
1279
+ # header parameters
1280
+ header_params = {}
1281
+
1282
+ # HTTP header 'Accept' (if needed)
1283
+ local_header_accept = ['application/json']
1284
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1285
+
1286
+ # HTTP header 'Content-Type'
1287
+ local_header_content_type = ['application/json']
1288
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1289
+
1290
+ # form parameters
1291
+ form_params = {}
1292
+
1293
+ # http body (model)
1294
+ post_body = @api_client.object_to_http_body(body)
1295
+
1296
+ auth_names = ['PureCloud OAuth']
1297
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1298
+ :header_params => header_params,
1299
+ :query_params => query_params,
1300
+ :form_params => form_params,
1301
+ :body => post_body,
1302
+ :auth_names => auth_names,
1303
+ :return_type => 'AsyncQueryResponse')
1304
+ if @api_client.config.debugging
1305
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_conversations_details_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1306
+ end
1307
+ return data, status_code, headers
1308
+ end
1309
+
1042
1310
  # Query for conversation details
1043
1311
  #
1044
1312
  # @param body query
@@ -1108,7 +1376,7 @@ module PureCloud
1108
1376
  #
1109
1377
  # @param body query
1110
1378
  # @param [Hash] opts the optional parameters
1111
- # @return [AggregateQueryResponse]
1379
+ # @return [EvaluationAggregateQueryResponse]
1112
1380
  def post_analytics_evaluations_aggregates_query(body, opts = {})
1113
1381
  data, _status_code, _headers = post_analytics_evaluations_aggregates_query_with_http_info(body, opts)
1114
1382
  return data
@@ -1118,7 +1386,7 @@ module PureCloud
1118
1386
  #
1119
1387
  # @param body query
1120
1388
  # @param [Hash] opts the optional parameters
1121
- # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers
1389
+ # @return [Array<(EvaluationAggregateQueryResponse, Fixnum, Hash)>] EvaluationAggregateQueryResponse data, response status code and response headers
1122
1390
  def post_analytics_evaluations_aggregates_query_with_http_info(body, opts = {})
1123
1391
  if @api_client.config.debugging
1124
1392
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_evaluations_aggregates_query ..."
@@ -1162,7 +1430,7 @@ module PureCloud
1162
1430
  :form_params => form_params,
1163
1431
  :body => post_body,
1164
1432
  :auth_names => auth_names,
1165
- :return_type => 'AggregateQueryResponse')
1433
+ :return_type => 'EvaluationAggregateQueryResponse')
1166
1434
  if @api_client.config.debugging
1167
1435
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_evaluations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1168
1436
  end
@@ -1173,7 +1441,7 @@ module PureCloud
1173
1441
  #
1174
1442
  # @param body query
1175
1443
  # @param [Hash] opts the optional parameters
1176
- # @return [AggregateQueryResponse]
1444
+ # @return [FlowAggregateQueryResponse]
1177
1445
  def post_analytics_flows_aggregates_query(body, opts = {})
1178
1446
  data, _status_code, _headers = post_analytics_flows_aggregates_query_with_http_info(body, opts)
1179
1447
  return data
@@ -1183,7 +1451,7 @@ module PureCloud
1183
1451
  #
1184
1452
  # @param body query
1185
1453
  # @param [Hash] opts the optional parameters
1186
- # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers
1454
+ # @return [Array<(FlowAggregateQueryResponse, Fixnum, Hash)>] FlowAggregateQueryResponse data, response status code and response headers
1187
1455
  def post_analytics_flows_aggregates_query_with_http_info(body, opts = {})
1188
1456
  if @api_client.config.debugging
1189
1457
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_flows_aggregates_query ..."
@@ -1227,7 +1495,7 @@ module PureCloud
1227
1495
  :form_params => form_params,
1228
1496
  :body => post_body,
1229
1497
  :auth_names => auth_names,
1230
- :return_type => 'AggregateQueryResponse')
1498
+ :return_type => 'FlowAggregateQueryResponse')
1231
1499
  if @api_client.config.debugging
1232
1500
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_flows_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1233
1501
  end
@@ -1238,7 +1506,7 @@ module PureCloud
1238
1506
  #
1239
1507
  # @param body query
1240
1508
  # @param [Hash] opts the optional parameters
1241
- # @return [QualifierMappingObservationQueryResponse]
1509
+ # @return [FlowObservationQueryResponse]
1242
1510
  def post_analytics_flows_observations_query(body, opts = {})
1243
1511
  data, _status_code, _headers = post_analytics_flows_observations_query_with_http_info(body, opts)
1244
1512
  return data
@@ -1248,7 +1516,7 @@ module PureCloud
1248
1516
  #
1249
1517
  # @param body query
1250
1518
  # @param [Hash] opts the optional parameters
1251
- # @return [Array<(QualifierMappingObservationQueryResponse, Fixnum, Hash)>] QualifierMappingObservationQueryResponse data, response status code and response headers
1519
+ # @return [Array<(FlowObservationQueryResponse, Fixnum, Hash)>] FlowObservationQueryResponse data, response status code and response headers
1252
1520
  def post_analytics_flows_observations_query_with_http_info(body, opts = {})
1253
1521
  if @api_client.config.debugging
1254
1522
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_flows_observations_query ..."
@@ -1292,7 +1560,7 @@ module PureCloud
1292
1560
  :form_params => form_params,
1293
1561
  :body => post_body,
1294
1562
  :auth_names => auth_names,
1295
- :return_type => 'QualifierMappingObservationQueryResponse')
1563
+ :return_type => 'FlowObservationQueryResponse')
1296
1564
  if @api_client.config.debugging
1297
1565
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_flows_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1298
1566
  end
@@ -1303,7 +1571,7 @@ module PureCloud
1303
1571
  #
1304
1572
  # @param body query
1305
1573
  # @param [Hash] opts the optional parameters
1306
- # @return [QualifierMappingObservationQueryResponse]
1574
+ # @return [QueueObservationQueryResponse]
1307
1575
  def post_analytics_queues_observations_query(body, opts = {})
1308
1576
  data, _status_code, _headers = post_analytics_queues_observations_query_with_http_info(body, opts)
1309
1577
  return data
@@ -1313,7 +1581,7 @@ module PureCloud
1313
1581
  #
1314
1582
  # @param body query
1315
1583
  # @param [Hash] opts the optional parameters
1316
- # @return [Array<(QualifierMappingObservationQueryResponse, Fixnum, Hash)>] QualifierMappingObservationQueryResponse data, response status code and response headers
1584
+ # @return [Array<(QueueObservationQueryResponse, Fixnum, Hash)>] QueueObservationQueryResponse data, response status code and response headers
1317
1585
  def post_analytics_queues_observations_query_with_http_info(body, opts = {})
1318
1586
  if @api_client.config.debugging
1319
1587
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_queues_observations_query ..."
@@ -1357,7 +1625,7 @@ module PureCloud
1357
1625
  :form_params => form_params,
1358
1626
  :body => post_body,
1359
1627
  :auth_names => auth_names,
1360
- :return_type => 'QualifierMappingObservationQueryResponse')
1628
+ :return_type => 'QueueObservationQueryResponse')
1361
1629
  if @api_client.config.debugging
1362
1630
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_queues_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1363
1631
  end
@@ -1563,7 +1831,7 @@ module PureCloud
1563
1831
  #
1564
1832
  # @param body query
1565
1833
  # @param [Hash] opts the optional parameters
1566
- # @return [AggregateQueryResponse]
1834
+ # @return [SurveyAggregateQueryResponse]
1567
1835
  def post_analytics_surveys_aggregates_query(body, opts = {})
1568
1836
  data, _status_code, _headers = post_analytics_surveys_aggregates_query_with_http_info(body, opts)
1569
1837
  return data
@@ -1573,7 +1841,7 @@ module PureCloud
1573
1841
  #
1574
1842
  # @param body query
1575
1843
  # @param [Hash] opts the optional parameters
1576
- # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers
1844
+ # @return [Array<(SurveyAggregateQueryResponse, Fixnum, Hash)>] SurveyAggregateQueryResponse data, response status code and response headers
1577
1845
  def post_analytics_surveys_aggregates_query_with_http_info(body, opts = {})
1578
1846
  if @api_client.config.debugging
1579
1847
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_surveys_aggregates_query ..."
@@ -1617,7 +1885,7 @@ module PureCloud
1617
1885
  :form_params => form_params,
1618
1886
  :body => post_body,
1619
1887
  :auth_names => auth_names,
1620
- :return_type => 'AggregateQueryResponse')
1888
+ :return_type => 'SurveyAggregateQueryResponse')
1621
1889
  if @api_client.config.debugging
1622
1890
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_surveys_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1623
1891
  end
@@ -1628,7 +1896,7 @@ module PureCloud
1628
1896
  #
1629
1897
  # @param body query
1630
1898
  # @param [Hash] opts the optional parameters
1631
- # @return [PresenceQueryResponse]
1899
+ # @return [UserAggregateQueryResponse]
1632
1900
  def post_analytics_users_aggregates_query(body, opts = {})
1633
1901
  data, _status_code, _headers = post_analytics_users_aggregates_query_with_http_info(body, opts)
1634
1902
  return data
@@ -1638,7 +1906,7 @@ module PureCloud
1638
1906
  #
1639
1907
  # @param body query
1640
1908
  # @param [Hash] opts the optional parameters
1641
- # @return [Array<(PresenceQueryResponse, Fixnum, Hash)>] PresenceQueryResponse data, response status code and response headers
1909
+ # @return [Array<(UserAggregateQueryResponse, Fixnum, Hash)>] UserAggregateQueryResponse data, response status code and response headers
1642
1910
  def post_analytics_users_aggregates_query_with_http_info(body, opts = {})
1643
1911
  if @api_client.config.debugging
1644
1912
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_aggregates_query ..."
@@ -1682,7 +1950,7 @@ module PureCloud
1682
1950
  :form_params => form_params,
1683
1951
  :body => post_body,
1684
1952
  :auth_names => auth_names,
1685
- :return_type => 'PresenceQueryResponse')
1953
+ :return_type => 'UserAggregateQueryResponse')
1686
1954
  if @api_client.config.debugging
1687
1955
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_users_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1688
1956
  end
@@ -1758,7 +2026,7 @@ module PureCloud
1758
2026
  #
1759
2027
  # @param body query
1760
2028
  # @param [Hash] opts the optional parameters
1761
- # @return [ObservationQueryResponse]
2029
+ # @return [UserObservationQueryResponse]
1762
2030
  def post_analytics_users_observations_query(body, opts = {})
1763
2031
  data, _status_code, _headers = post_analytics_users_observations_query_with_http_info(body, opts)
1764
2032
  return data
@@ -1768,7 +2036,7 @@ module PureCloud
1768
2036
  #
1769
2037
  # @param body query
1770
2038
  # @param [Hash] opts the optional parameters
1771
- # @return [Array<(ObservationQueryResponse, Fixnum, Hash)>] ObservationQueryResponse data, response status code and response headers
2039
+ # @return [Array<(UserObservationQueryResponse, Fixnum, Hash)>] UserObservationQueryResponse data, response status code and response headers
1772
2040
  def post_analytics_users_observations_query_with_http_info(body, opts = {})
1773
2041
  if @api_client.config.debugging
1774
2042
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_observations_query ..."
@@ -1812,7 +2080,7 @@ module PureCloud
1812
2080
  :form_params => form_params,
1813
2081
  :body => post_body,
1814
2082
  :auth_names => auth_names,
1815
- :return_type => 'ObservationQueryResponse')
2083
+ :return_type => 'UserObservationQueryResponse')
1816
2084
  if @api_client.config.debugging
1817
2085
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_users_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1818
2086
  end