purecloudplatformclientv2 62.0.0 → 63.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (595) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ADFS.md +1 -1
  4. data/docs/ActionEntityListing.md +1 -1
  5. data/docs/AgentActivityEntityListing.md +1 -1
  6. data/docs/AnalyticsApi.md +32 -32
  7. data/docs/AnalyticsParticipant.md +1 -0
  8. data/docs/ArchitectApi.md +69 -0
  9. data/docs/ArrayNode.md +5 -5
  10. data/docs/AsyncConversationQuery.md +5 -5
  11. data/docs/AttemptLimitsEntityListing.md +1 -1
  12. data/docs/AuthorizationApi.md +7 -7
  13. data/docs/AuthzDivisionEntityListing.md +1 -1
  14. data/docs/CalibrationEntityListing.md +1 -1
  15. data/docs/CallConversationEntityListing.md +1 -1
  16. data/docs/CallHistoryConversationEntityListing.md +1 -1
  17. data/docs/CallableTimeSetEntityListing.md +1 -1
  18. data/docs/CallbackConversationEntityListing.md +1 -1
  19. data/docs/CampaignDivisionViewListing.md +1 -1
  20. data/docs/CampaignEntityListing.md +1 -1
  21. data/docs/CampaignRuleEntityListing.md +1 -1
  22. data/docs/CampaignSequenceEntityListing.md +1 -1
  23. data/docs/CertificateAuthorityEntityListing.md +1 -1
  24. data/docs/ChatConversationEntityListing.md +1 -1
  25. data/docs/ClientAppEntityListing.md +1 -1
  26. data/docs/CobrowseConversationEntityListing.md +1 -1
  27. data/docs/CommandStatusEntityListing.md +1 -1
  28. data/docs/ConsumedResourcesEntityListing.md +1 -1
  29. data/docs/ConsumingResourcesEntityListing.md +1 -1
  30. data/docs/ContactListDivisionViewListing.md +1 -1
  31. data/docs/ContactListEntityListing.md +1 -1
  32. data/docs/ContactListFilterEntityListing.md +1 -1
  33. data/docs/ContactListing.md +1 -1
  34. data/docs/ConversationAggregateDataContainer.md +14 -0
  35. data/docs/ConversationAggregateQueryClause.md +14 -0
  36. data/docs/ConversationAggregateQueryFilter.md +15 -0
  37. data/docs/ConversationAggregateQueryPredicate.md +17 -0
  38. data/docs/ConversationAggregateQueryResponse.md +13 -0
  39. data/docs/ConversationAggregationQuery.md +20 -0
  40. data/docs/ConversationAggregationView.md +16 -0
  41. data/docs/ConversationDetailQueryClause.md +14 -0
  42. data/docs/ConversationDetailQueryFilter.md +15 -0
  43. data/docs/ConversationDetailQueryPredicate.md +18 -0
  44. data/docs/ConversationEntityListing.md +1 -1
  45. data/docs/ConversationQuery.md +5 -5
  46. data/docs/ConversationsApi.md +286 -4
  47. data/docs/CreateQueueMediaAssociationRequest.md +1 -0
  48. data/docs/CredentialInfoListing.md +1 -1
  49. data/docs/CredentialTypeListing.md +1 -1
  50. data/docs/CustomerInteractionCenter.md +1 -1
  51. data/docs/DIDEntityListing.md +1 -1
  52. data/docs/DIDPoolEntityListing.md +1 -1
  53. data/docs/DataSchema.md +1 -1
  54. data/docs/DataTableImportJob.md +24 -0
  55. data/docs/DataTableRowEntityListing.md +1 -1
  56. data/docs/DataTablesDomainEntityListing.md +1 -1
  57. data/docs/DependencyObjectEntityListing.md +1 -1
  58. data/docs/DependencyTypeEntityListing.md +1 -1
  59. data/docs/DialerEventEntityListing.md +1 -1
  60. data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
  61. data/docs/DirectoryUserDevicesListing.md +1 -1
  62. data/docs/DncListDivisionViewListing.md +1 -1
  63. data/docs/DncListEntityListing.md +1 -1
  64. data/docs/DocumentAuditEntityListing.md +1 -1
  65. data/docs/DocumentEntityListing.md +1 -1
  66. data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
  67. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  68. data/docs/DomainEntityListing.md +1 -1
  69. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  70. data/docs/DomainEntityListingQueryResult.md +1 -1
  71. data/docs/DomainEntityListingSurveyForm.md +1 -1
  72. data/docs/DomainOrganizationRole.md +1 -1
  73. data/docs/DomainOrganizationRoleCreate.md +1 -1
  74. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  75. data/docs/EdgeEntityListing.md +1 -1
  76. data/docs/EdgeGroupEntityListing.md +1 -1
  77. data/docs/EdgeLineEntityListing.md +1 -1
  78. data/docs/EmailConversationEntityListing.md +1 -1
  79. data/docs/EmailMessageListing.md +1 -1
  80. data/docs/EmergencyGroupListing.md +1 -1
  81. data/docs/EncryptionKeyEntityListing.md +1 -1
  82. data/docs/EvaluationAggregateDataContainer.md +14 -0
  83. data/docs/EvaluationAggregateQueryClause.md +14 -0
  84. data/docs/EvaluationAggregateQueryFilter.md +15 -0
  85. data/docs/EvaluationAggregateQueryPredicate.md +17 -0
  86. data/docs/EvaluationAggregateQueryResponse.md +13 -0
  87. data/docs/EvaluationAggregationQuery.md +20 -0
  88. data/docs/EvaluationAggregationView.md +16 -0
  89. data/docs/EvaluationDetailQueryClause.md +14 -0
  90. data/docs/EvaluationDetailQueryFilter.md +15 -0
  91. data/docs/EvaluationDetailQueryPredicate.md +18 -0
  92. data/docs/EvaluationEntityListing.md +1 -1
  93. data/docs/EvaluationFormEntityListing.md +1 -1
  94. data/docs/EvaluatorActivityEntityListing.md +1 -1
  95. data/docs/ExtensionEntityListing.md +1 -1
  96. data/docs/ExtensionPoolEntityListing.md +1 -1
  97. data/docs/ExternalOrganizationListing.md +1 -1
  98. data/docs/FacebookIntegrationEntityListing.md +1 -1
  99. data/docs/FaxDocumentEntityListing.md +1 -1
  100. data/docs/{AggregateDataContainer.md → FlowAggregateDataContainer.md} +2 -2
  101. data/docs/FlowAggregateQueryClause.md +14 -0
  102. data/docs/FlowAggregateQueryFilter.md +15 -0
  103. data/docs/FlowAggregateQueryPredicate.md +17 -0
  104. data/docs/FlowAggregateQueryResponse.md +13 -0
  105. data/docs/{AggregationQuery.md → FlowAggregationQuery.md} +4 -4
  106. data/docs/{AnalyticsView.md → FlowAggregationView.md} +3 -3
  107. data/docs/FlowDivisionViewEntityListing.md +1 -1
  108. data/docs/FlowEntityListing.md +1 -1
  109. data/docs/{ObservationDataContainer.md → FlowObservationDataContainer.md} +2 -2
  110. data/docs/{ObservationQuery.md → FlowObservationQuery.md} +3 -3
  111. data/docs/FlowObservationQueryClause.md +14 -0
  112. data/docs/FlowObservationQueryFilter.md +15 -0
  113. data/docs/FlowObservationQueryPredicate.md +17 -0
  114. data/docs/FlowObservationQueryResponse.md +13 -0
  115. data/docs/FlowOutcomeListing.md +1 -1
  116. data/docs/FlowVersionEntityListing.md +1 -1
  117. data/docs/FlowsApi.md +8 -8
  118. data/docs/GDPRRequestEntityListing.md +1 -1
  119. data/docs/GDPRSubjectEntityListing.md +1 -1
  120. data/docs/GSuite.md +1 -1
  121. data/docs/GreetingListing.md +1 -1
  122. data/docs/GroupEntityListing.md +1 -1
  123. data/docs/GroupProfileEntityListing.md +1 -1
  124. data/docs/IVREntityListing.md +1 -1
  125. data/docs/IdentityNow.md +1 -1
  126. data/docs/InboundDomainEntityListing.md +1 -1
  127. data/docs/InboundRouteEntityListing.md +1 -1
  128. data/docs/IntegrationEntityListing.md +1 -1
  129. data/docs/IntegrationEventEntityListing.md +1 -1
  130. data/docs/IntegrationTypeEntityListing.md +1 -1
  131. data/docs/InteractionStatsAlertContainer.md +1 -1
  132. data/docs/InteractionStatsRuleContainer.md +1 -1
  133. data/docs/JsonNode.md +5 -5
  134. data/docs/KeywordSetEntityListing.md +1 -1
  135. data/docs/LanguageEntityListing.md +1 -1
  136. data/docs/LexBotAliasEntityListing.md +1 -1
  137. data/docs/LexBotEntityListing.md +1 -1
  138. data/docs/LibraryEntityListing.md +1 -1
  139. data/docs/LineBaseEntityListing.md +1 -1
  140. data/docs/LineEntityListing.md +1 -1
  141. data/docs/LineIntegrationEntityListing.md +1 -1
  142. data/docs/LocationEntityListing.md +1 -1
  143. data/docs/LocationSearchRequest.md +1 -0
  144. data/docs/LocationsApi.md +2 -2
  145. data/docs/LogicalInterfaceEntityListing.md +1 -1
  146. data/docs/ManagementUnitListing.md +1 -1
  147. data/docs/MediaEndpointStatDetailQueryClause.md +14 -0
  148. data/docs/MediaEndpointStatDetailQueryFilter.md +15 -0
  149. data/docs/MediaEndpointStatDetailQueryPredicate.md +17 -0
  150. data/docs/MessageConversationEntityListing.md +1 -1
  151. data/docs/MessagingIntegrationEntityListing.md +1 -1
  152. data/docs/MessagingStickerEntityListing.md +1 -1
  153. data/docs/NoteListing.md +1 -1
  154. data/docs/OAuthClientEntityListing.md +1 -1
  155. data/docs/OAuthProviderEntityListing.md +1 -1
  156. data/docs/ObjectsApi.md +1 -1
  157. data/docs/Okta.md +1 -1
  158. data/docs/OneLogin.md +1 -1
  159. data/docs/OrganizationPresenceEntityListing.md +1 -1
  160. data/docs/OrganizationRoleEntityListing.md +1 -1
  161. data/docs/OrphanRecordingListing.md +1 -1
  162. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  163. data/docs/OutboundRouteEntityListing.md +1 -1
  164. data/docs/PermissionCollectionEntityListing.md +1 -1
  165. data/docs/PhoneBaseEntityListing.md +1 -1
  166. data/docs/PhoneEntityListing.md +1 -1
  167. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  168. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  169. data/docs/PingIdentity.md +1 -1
  170. data/docs/PolicyEntityListing.md +1 -1
  171. data/docs/PresenceDetailQueryClause.md +14 -0
  172. data/docs/PresenceDetailQueryFilter.md +15 -0
  173. data/docs/PresenceDetailQueryPredicate.md +17 -0
  174. data/docs/PromptAssetEntityListing.md +1 -1
  175. data/docs/PromptEntityListing.md +1 -1
  176. data/docs/PureEngage.md +1 -1
  177. data/docs/QualityApi.md +8 -8
  178. data/docs/QualityAuditPage.md +1 -1
  179. data/docs/QueueEntityListing.md +1 -1
  180. data/docs/QueueMediaAssociation.md +1 -1
  181. data/docs/QueueMemberEntityListing.md +1 -1
  182. data/docs/QueueObservationDataContainer.md +14 -0
  183. data/docs/QueueObservationQuery.md +15 -0
  184. data/docs/QueueObservationQueryClause.md +14 -0
  185. data/docs/QueueObservationQueryFilter.md +15 -0
  186. data/docs/QueueObservationQueryPredicate.md +17 -0
  187. data/docs/{QualifierMappingObservationQueryResponse.md → QueueObservationQueryResponse.md} +3 -3
  188. data/docs/RecipientListing.md +1 -1
  189. data/docs/RecordingJob.md +1 -0
  190. data/docs/RecordingJobEntityListing.md +1 -1
  191. data/docs/RecordingJobsQuery.md +1 -1
  192. data/docs/RelationshipListing.md +1 -1
  193. data/docs/ReportMetaDataEntityListing.md +1 -1
  194. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  195. data/docs/ReportScheduleEntityListing.md +1 -1
  196. data/docs/ReportingExportJobListing.md +1 -1
  197. data/docs/ResponseEntityList.md +1 -1
  198. data/docs/ResponseEntityListing.md +1 -1
  199. data/docs/ResponseSetEntityListing.md +1 -1
  200. data/docs/RoutingApi.md +4 -4
  201. data/docs/RoutingStatusDetailQueryClause.md +14 -0
  202. data/docs/RoutingStatusDetailQueryFilter.md +15 -0
  203. data/docs/RoutingStatusDetailQueryPredicate.md +17 -0
  204. data/docs/RuleSetEntityListing.md +1 -1
  205. data/docs/SCIMApi.md +278 -0
  206. data/docs/Salesforce.md +1 -1
  207. data/docs/ScheduleEntityListing.md +1 -1
  208. data/docs/ScheduleGroupEntityListing.md +1 -1
  209. data/docs/SchemaCategoryEntityListing.md +1 -1
  210. data/docs/SchemaReferenceEntityListing.md +1 -1
  211. data/docs/ScimConfigResourceType.md +20 -0
  212. data/docs/ScimConfigResourceTypeSchemaExtension.md +14 -0
  213. data/docs/ScimConfigResourceTypesListResponse.md +17 -0
  214. data/docs/ScimError.md +16 -0
  215. data/docs/ScimServiceProviderConfig.md +9 -1
  216. data/docs/ScimServiceProviderConfigAuthenticationScheme.md +18 -0
  217. data/docs/ScimServiceProviderConfigBulkFeature.md +15 -0
  218. data/docs/ScimServiceProviderConfigFilterFeature.md +14 -0
  219. data/docs/ScimServiceProviderConfigSimpleFeature.md +13 -0
  220. data/docs/ScreenRecordingSessionListing.md +1 -1
  221. data/docs/ScriptEntityListing.md +1 -1
  222. data/docs/SearchApi.md +4 -4
  223. data/docs/SecurityProfileEntityListing.md +1 -1
  224. data/docs/SegmentDetailQueryClause.md +14 -0
  225. data/docs/SegmentDetailQueryFilter.md +15 -0
  226. data/docs/{AnalyticsQueryPredicate.md → SegmentDetailQueryPredicate.md} +4 -4
  227. data/docs/ShareEntityListing.md +1 -1
  228. data/docs/SiteEntityListing.md +1 -1
  229. data/docs/SkillEntityListing.md +1 -1
  230. data/docs/SmsAddressEntityListing.md +1 -1
  231. data/docs/SmsPhoneNumber.md +1 -0
  232. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  233. data/docs/StationEntityListing.md +1 -1
  234. data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
  235. data/docs/SuggestApi.md +2 -2
  236. data/docs/SurveyAggregateDataContainer.md +14 -0
  237. data/docs/SurveyAggregateQueryClause.md +14 -0
  238. data/docs/SurveyAggregateQueryFilter.md +15 -0
  239. data/docs/SurveyAggregateQueryPredicate.md +17 -0
  240. data/docs/SurveyAggregateQueryResponse.md +13 -0
  241. data/docs/SurveyAggregationQuery.md +20 -0
  242. data/docs/SurveyAggregationView.md +16 -0
  243. data/docs/SurveyDetailQueryClause.md +14 -0
  244. data/docs/SurveyDetailQueryFilter.md +15 -0
  245. data/docs/SurveyDetailQueryPredicate.md +18 -0
  246. data/docs/SurveyFormEntityListing.md +1 -1
  247. data/docs/SystemPromptAssetEntityListing.md +1 -1
  248. data/docs/SystemPromptEntityListing.md +1 -1
  249. data/docs/TagValueEntityListing.md +1 -1
  250. data/docs/TextMessageListing.md +1 -1
  251. data/docs/TimeZoneEntityListing.md +1 -1
  252. data/docs/TokensApi.md +2 -1
  253. data/docs/TrunkBaseEntityListing.md +1 -1
  254. data/docs/TrunkEntityListing.md +1 -1
  255. data/docs/TrunkMetabaseEntityListing.md +1 -1
  256. data/docs/TrustEntityListing.md +1 -1
  257. data/docs/TrustUserEntityListing.md +1 -1
  258. data/docs/TrustorEntityListing.md +1 -1
  259. data/docs/TtsEngineEntityListing.md +1 -1
  260. data/docs/TtsVoiceEntityListing.md +1 -1
  261. data/docs/TwitterIntegrationEntityListing.md +1 -1
  262. data/docs/UserActionCategoryEntityListing.md +1 -1
  263. data/docs/UserAggregateDataContainer.md +14 -0
  264. data/docs/UserAggregateQueryClause.md +14 -0
  265. data/docs/UserAggregateQueryFilter.md +15 -0
  266. data/docs/UserAggregateQueryPredicate.md +17 -0
  267. data/docs/{PresenceQueryResponse.md → UserAggregateQueryResponse.md} +3 -3
  268. data/docs/UserAggregationQuery.md +20 -0
  269. data/docs/UserAggregationView.md +16 -0
  270. data/docs/UserAuthorization.md +1 -1
  271. data/docs/UserDetailQueryClause.md +14 -0
  272. data/docs/UserDetailQueryFilter.md +15 -0
  273. data/docs/UserDetailQueryPredicate.md +17 -0
  274. data/docs/UserDetailsQuery.md +3 -3
  275. data/docs/UserEntityListing.md +1 -1
  276. data/docs/UserLanguageEntityListing.md +1 -1
  277. data/docs/UserObservationDataContainer.md +14 -0
  278. data/docs/UserObservationQuery.md +15 -0
  279. data/docs/UserObservationQueryClause.md +14 -0
  280. data/docs/UserObservationQueryFilter.md +15 -0
  281. data/docs/UserObservationQueryPredicate.md +17 -0
  282. data/docs/UserObservationQueryResponse.md +13 -0
  283. data/docs/UserProfileEntityListing.md +1 -1
  284. data/docs/UserQueueEntityListing.md +1 -1
  285. data/docs/UserRecordingEntityListing.md +1 -1
  286. data/docs/UserSkillEntityListing.md +1 -1
  287. data/docs/UsersApi.md +10 -10
  288. data/docs/VoicemailMessageEntityListing.md +1 -1
  289. data/docs/WebChatMemberInfoEntityList.md +1 -1
  290. data/docs/WhatsAppIntegrationEntityListing.md +1 -1
  291. data/docs/WorkspaceEntityListing.md +1 -1
  292. data/docs/WorkspaceMemberEntityListing.md +1 -1
  293. data/docs/WrapupCodeEntityListing.md +1 -1
  294. data/lib/purecloudplatformclientv2.rb +86 -12
  295. data/lib/purecloudplatformclientv2/api/analytics_api.rb +24 -24
  296. data/lib/purecloudplatformclientv2/api/architect_api.rb +75 -0
  297. data/lib/purecloudplatformclientv2/api/authorization_api.rb +8 -8
  298. data/lib/purecloudplatformclientv2/api/conversations_api.rb +343 -3
  299. data/lib/purecloudplatformclientv2/api/flows_api.rb +6 -6
  300. data/lib/purecloudplatformclientv2/api/locations_api.rb +2 -2
  301. data/lib/purecloudplatformclientv2/api/objects_api.rb +2 -2
  302. data/lib/purecloudplatformclientv2/api/quality_api.rb +6 -6
  303. data/lib/purecloudplatformclientv2/api/routing_api.rb +3 -3
  304. data/lib/purecloudplatformclientv2/api/scim_api.rb +332 -0
  305. data/lib/purecloudplatformclientv2/api/search_api.rb +2 -2
  306. data/lib/purecloudplatformclientv2/api/users_api.rb +8 -8
  307. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  308. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
  309. data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
  310. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
  311. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +1 -15
  312. data/lib/purecloudplatformclientv2/models/analytics_participant.rb +31 -3
  313. data/lib/purecloudplatformclientv2/models/array_node.rb +51 -51
  314. data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +27 -27
  315. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
  316. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
  317. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
  318. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
  319. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
  320. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
  321. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
  322. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
  323. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
  324. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
  325. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
  326. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
  327. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
  328. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
  329. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
  330. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
  331. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
  332. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
  333. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
  334. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
  335. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
  336. data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
  337. data/lib/purecloudplatformclientv2/models/conversation_aggregate_data_container.rb +231 -0
  338. data/lib/purecloudplatformclientv2/models/{analytics_query_clause.rb → conversation_aggregate_query_clause.rb} +3 -3
  339. data/lib/purecloudplatformclientv2/models/{analytics_query_filter.rb → conversation_aggregate_query_filter.rb} +4 -4
  340. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +348 -0
  341. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_response.rb +203 -0
  342. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +390 -0
  343. data/lib/purecloudplatformclientv2/models/conversation_aggregation_view.rb +323 -0
  344. data/lib/purecloudplatformclientv2/models/conversation_detail_query_clause.rb +254 -0
  345. data/lib/purecloudplatformclientv2/models/conversation_detail_query_filter.rb +277 -0
  346. data/lib/purecloudplatformclientv2/models/conversation_detail_query_predicate.rb +388 -0
  347. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
  348. data/lib/purecloudplatformclientv2/models/conversation_query.rb +27 -27
  349. data/lib/purecloudplatformclientv2/models/create_queue_media_association_request.rb +27 -1
  350. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
  351. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
  352. data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
  353. data/lib/purecloudplatformclientv2/models/data_schema.rb +1 -1
  354. data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +521 -0
  355. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
  356. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
  357. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
  358. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
  359. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
  360. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
  361. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
  362. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
  363. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
  364. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
  365. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
  366. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
  367. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
  368. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
  369. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
  370. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
  371. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
  372. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
  373. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
  374. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +1 -0
  375. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +1 -0
  376. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +1 -0
  377. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
  378. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
  379. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
  380. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
  381. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
  382. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
  383. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
  384. data/lib/purecloudplatformclientv2/models/evaluation_aggregate_data_container.rb +231 -0
  385. data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_clause.rb +254 -0
  386. data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_filter.rb +277 -0
  387. data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_predicate.rb +348 -0
  388. data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_response.rb +203 -0
  389. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +390 -0
  390. data/lib/purecloudplatformclientv2/models/{analytics_view.rb → evaluation_aggregation_view.rb} +17 -3
  391. data/lib/purecloudplatformclientv2/models/evaluation_detail_query_clause.rb +254 -0
  392. data/lib/purecloudplatformclientv2/models/evaluation_detail_query_filter.rb +277 -0
  393. data/lib/purecloudplatformclientv2/models/evaluation_detail_query_predicate.rb +388 -0
  394. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
  395. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
  396. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
  397. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
  398. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
  399. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
  400. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
  401. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
  402. data/lib/purecloudplatformclientv2/models/{aggregate_data_container.rb → flow_aggregate_data_container.rb} +1 -1
  403. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_clause.rb +254 -0
  404. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_filter.rb +277 -0
  405. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +348 -0
  406. data/lib/purecloudplatformclientv2/models/{aggregate_query_response.rb → flow_aggregate_query_response.rb} +2 -2
  407. data/lib/purecloudplatformclientv2/models/{aggregation_query.rb → flow_aggregation_query.rb} +3 -3
  408. data/lib/purecloudplatformclientv2/models/flow_aggregation_view.rb +323 -0
  409. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
  410. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
  411. data/lib/purecloudplatformclientv2/models/{observation_data_container.rb → flow_observation_data_container.rb} +1 -1
  412. data/lib/purecloudplatformclientv2/models/{observation_query.rb → flow_observation_query.rb} +2 -2
  413. data/lib/purecloudplatformclientv2/models/flow_observation_query_clause.rb +254 -0
  414. data/lib/purecloudplatformclientv2/models/flow_observation_query_filter.rb +277 -0
  415. data/lib/purecloudplatformclientv2/models/flow_observation_query_predicate.rb +348 -0
  416. data/lib/purecloudplatformclientv2/models/{observation_query_response.rb → flow_observation_query_response.rb} +2 -2
  417. data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
  418. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
  419. data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
  420. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
  421. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
  422. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
  423. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
  424. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
  425. data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
  426. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
  427. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
  428. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
  429. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
  430. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
  431. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
  432. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
  433. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
  434. data/lib/purecloudplatformclientv2/models/json_node.rb +51 -51
  435. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
  436. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
  437. data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
  438. data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
  439. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
  440. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
  441. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
  442. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
  443. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
  444. data/lib/purecloudplatformclientv2/models/location_search_request.rb +29 -1
  445. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
  446. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
  447. data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_clause.rb +254 -0
  448. data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_filter.rb +277 -0
  449. data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_predicate.rb +348 -0
  450. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
  451. data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
  452. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
  453. data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
  454. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
  455. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
  456. data/lib/purecloudplatformclientv2/models/observation_metric_data.rb +1 -15
  457. data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
  458. data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
  459. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
  460. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
  461. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
  462. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
  463. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
  464. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
  465. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
  466. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
  467. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
  468. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
  469. data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
  470. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
  471. data/lib/purecloudplatformclientv2/models/presence_detail_query_clause.rb +254 -0
  472. data/lib/purecloudplatformclientv2/models/presence_detail_query_filter.rb +277 -0
  473. data/lib/purecloudplatformclientv2/models/presence_detail_query_predicate.rb +348 -0
  474. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
  475. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
  476. data/lib/purecloudplatformclientv2/models/pure_engage.rb +12 -12
  477. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
  478. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
  479. data/lib/purecloudplatformclientv2/models/queue_media_association.rb +17 -17
  480. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
  481. data/lib/purecloudplatformclientv2/models/queue_observation_data_container.rb +231 -0
  482. data/lib/purecloudplatformclientv2/models/queue_observation_query.rb +263 -0
  483. data/lib/purecloudplatformclientv2/models/queue_observation_query_clause.rb +254 -0
  484. data/lib/purecloudplatformclientv2/models/queue_observation_query_filter.rb +277 -0
  485. data/lib/purecloudplatformclientv2/models/queue_observation_query_predicate.rb +348 -0
  486. data/lib/purecloudplatformclientv2/models/{qualifier_mapping_observation_query_response.rb → queue_observation_query_response.rb} +2 -2
  487. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
  488. data/lib/purecloudplatformclientv2/models/recording_job.rb +30 -4
  489. data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
  490. data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +1 -1
  491. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
  492. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
  493. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
  494. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
  495. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
  496. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
  497. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
  498. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
  499. data/lib/purecloudplatformclientv2/models/routing_status_detail_query_clause.rb +254 -0
  500. data/lib/purecloudplatformclientv2/models/routing_status_detail_query_filter.rb +277 -0
  501. data/lib/purecloudplatformclientv2/models/routing_status_detail_query_predicate.rb +348 -0
  502. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
  503. data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
  504. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
  505. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
  506. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
  507. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
  508. data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +389 -0
  509. data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +229 -0
  510. data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +311 -0
  511. data/lib/purecloudplatformclientv2/models/scim_error.rb +297 -0
  512. data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
  513. data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +215 -2
  514. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +362 -0
  515. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +255 -0
  516. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +229 -0
  517. data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +203 -0
  518. data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -2
  519. data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +2 -2
  520. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
  521. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
  522. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
  523. data/lib/purecloudplatformclientv2/models/segment_detail_query_clause.rb +254 -0
  524. data/lib/purecloudplatformclientv2/models/segment_detail_query_filter.rb +277 -0
  525. data/lib/purecloudplatformclientv2/models/{analytics_query_predicate.rb → segment_detail_query_predicate.rb} +7 -7
  526. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
  527. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
  528. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
  529. data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +12 -12
  530. data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +41 -1
  531. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
  532. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
  533. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
  534. data/lib/purecloudplatformclientv2/models/survey_aggregate_data_container.rb +231 -0
  535. data/lib/purecloudplatformclientv2/models/survey_aggregate_query_clause.rb +254 -0
  536. data/lib/purecloudplatformclientv2/models/survey_aggregate_query_filter.rb +277 -0
  537. data/lib/purecloudplatformclientv2/models/survey_aggregate_query_predicate.rb +348 -0
  538. data/lib/purecloudplatformclientv2/models/survey_aggregate_query_response.rb +203 -0
  539. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +390 -0
  540. data/lib/purecloudplatformclientv2/models/survey_aggregation_view.rb +323 -0
  541. data/lib/purecloudplatformclientv2/models/survey_detail_query_clause.rb +254 -0
  542. data/lib/purecloudplatformclientv2/models/survey_detail_query_filter.rb +277 -0
  543. data/lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb +388 -0
  544. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
  545. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
  546. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
  547. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
  548. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
  549. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
  550. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
  551. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
  552. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
  553. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
  554. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
  555. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
  556. data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
  557. data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
  558. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
  559. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
  560. data/lib/purecloudplatformclientv2/models/user_aggregate_data_container.rb +231 -0
  561. data/lib/purecloudplatformclientv2/models/user_aggregate_query_clause.rb +254 -0
  562. data/lib/purecloudplatformclientv2/models/user_aggregate_query_filter.rb +277 -0
  563. data/lib/purecloudplatformclientv2/models/user_aggregate_query_predicate.rb +348 -0
  564. data/lib/purecloudplatformclientv2/models/{presence_query_response.rb → user_aggregate_query_response.rb} +2 -2
  565. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +390 -0
  566. data/lib/purecloudplatformclientv2/models/user_aggregation_view.rb +323 -0
  567. data/lib/purecloudplatformclientv2/models/user_authorization.rb +1 -0
  568. data/lib/purecloudplatformclientv2/models/user_detail_query_clause.rb +254 -0
  569. data/lib/purecloudplatformclientv2/models/user_detail_query_filter.rb +277 -0
  570. data/lib/purecloudplatformclientv2/models/user_detail_query_predicate.rb +348 -0
  571. data/lib/purecloudplatformclientv2/models/user_details_query.rb +33 -34
  572. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
  573. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
  574. data/lib/purecloudplatformclientv2/models/user_observation_data_container.rb +231 -0
  575. data/lib/purecloudplatformclientv2/models/user_observation_query.rb +263 -0
  576. data/lib/purecloudplatformclientv2/models/user_observation_query_clause.rb +254 -0
  577. data/lib/purecloudplatformclientv2/models/user_observation_query_filter.rb +277 -0
  578. data/lib/purecloudplatformclientv2/models/user_observation_query_predicate.rb +348 -0
  579. data/lib/purecloudplatformclientv2/models/user_observation_query_response.rb +203 -0
  580. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
  581. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
  582. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
  583. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
  584. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
  585. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
  586. data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +12 -12
  587. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
  588. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
  589. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
  590. data/lib/purecloudplatformclientv2/version.rb +1 -1
  591. metadata +174 -26
  592. data/docs/AggregateQueryResponse.md +0 -13
  593. data/docs/AnalyticsQueryClause.md +0 -14
  594. data/docs/AnalyticsQueryFilter.md +0 -15
  595. data/docs/ObservationQueryResponse.md +0 -13
@@ -1181,7 +1181,7 @@ module PureCloud
1181
1181
  #
1182
1182
  # @param body query
1183
1183
  # @param [Hash] opts the optional parameters
1184
- # @return [AggregateQueryResponse]
1184
+ # @return [ConversationAggregateQueryResponse]
1185
1185
  def post_analytics_conversations_aggregates_query(body, opts = {})
1186
1186
  data, _status_code, _headers = post_analytics_conversations_aggregates_query_with_http_info(body, opts)
1187
1187
  return data
@@ -1191,7 +1191,7 @@ module PureCloud
1191
1191
  #
1192
1192
  # @param body query
1193
1193
  # @param [Hash] opts the optional parameters
1194
- # @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
1195
1195
  def post_analytics_conversations_aggregates_query_with_http_info(body, opts = {})
1196
1196
  if @api_client.config.debugging
1197
1197
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_conversations_aggregates_query ..."
@@ -1235,7 +1235,7 @@ module PureCloud
1235
1235
  :form_params => form_params,
1236
1236
  :body => post_body,
1237
1237
  :auth_names => auth_names,
1238
- :return_type => 'AggregateQueryResponse')
1238
+ :return_type => 'ConversationAggregateQueryResponse')
1239
1239
  if @api_client.config.debugging
1240
1240
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_conversations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1241
1241
  end
@@ -1376,7 +1376,7 @@ module PureCloud
1376
1376
  #
1377
1377
  # @param body query
1378
1378
  # @param [Hash] opts the optional parameters
1379
- # @return [AggregateQueryResponse]
1379
+ # @return [EvaluationAggregateQueryResponse]
1380
1380
  def post_analytics_evaluations_aggregates_query(body, opts = {})
1381
1381
  data, _status_code, _headers = post_analytics_evaluations_aggregates_query_with_http_info(body, opts)
1382
1382
  return data
@@ -1386,7 +1386,7 @@ module PureCloud
1386
1386
  #
1387
1387
  # @param body query
1388
1388
  # @param [Hash] opts the optional parameters
1389
- # @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
1390
1390
  def post_analytics_evaluations_aggregates_query_with_http_info(body, opts = {})
1391
1391
  if @api_client.config.debugging
1392
1392
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_evaluations_aggregates_query ..."
@@ -1430,7 +1430,7 @@ module PureCloud
1430
1430
  :form_params => form_params,
1431
1431
  :body => post_body,
1432
1432
  :auth_names => auth_names,
1433
- :return_type => 'AggregateQueryResponse')
1433
+ :return_type => 'EvaluationAggregateQueryResponse')
1434
1434
  if @api_client.config.debugging
1435
1435
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_evaluations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1436
1436
  end
@@ -1441,7 +1441,7 @@ module PureCloud
1441
1441
  #
1442
1442
  # @param body query
1443
1443
  # @param [Hash] opts the optional parameters
1444
- # @return [AggregateQueryResponse]
1444
+ # @return [FlowAggregateQueryResponse]
1445
1445
  def post_analytics_flows_aggregates_query(body, opts = {})
1446
1446
  data, _status_code, _headers = post_analytics_flows_aggregates_query_with_http_info(body, opts)
1447
1447
  return data
@@ -1451,7 +1451,7 @@ module PureCloud
1451
1451
  #
1452
1452
  # @param body query
1453
1453
  # @param [Hash] opts the optional parameters
1454
- # @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
1455
1455
  def post_analytics_flows_aggregates_query_with_http_info(body, opts = {})
1456
1456
  if @api_client.config.debugging
1457
1457
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_flows_aggregates_query ..."
@@ -1495,7 +1495,7 @@ module PureCloud
1495
1495
  :form_params => form_params,
1496
1496
  :body => post_body,
1497
1497
  :auth_names => auth_names,
1498
- :return_type => 'AggregateQueryResponse')
1498
+ :return_type => 'FlowAggregateQueryResponse')
1499
1499
  if @api_client.config.debugging
1500
1500
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_flows_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1501
1501
  end
@@ -1506,7 +1506,7 @@ module PureCloud
1506
1506
  #
1507
1507
  # @param body query
1508
1508
  # @param [Hash] opts the optional parameters
1509
- # @return [QualifierMappingObservationQueryResponse]
1509
+ # @return [FlowObservationQueryResponse]
1510
1510
  def post_analytics_flows_observations_query(body, opts = {})
1511
1511
  data, _status_code, _headers = post_analytics_flows_observations_query_with_http_info(body, opts)
1512
1512
  return data
@@ -1516,7 +1516,7 @@ module PureCloud
1516
1516
  #
1517
1517
  # @param body query
1518
1518
  # @param [Hash] opts the optional parameters
1519
- # @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
1520
1520
  def post_analytics_flows_observations_query_with_http_info(body, opts = {})
1521
1521
  if @api_client.config.debugging
1522
1522
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_flows_observations_query ..."
@@ -1560,7 +1560,7 @@ module PureCloud
1560
1560
  :form_params => form_params,
1561
1561
  :body => post_body,
1562
1562
  :auth_names => auth_names,
1563
- :return_type => 'QualifierMappingObservationQueryResponse')
1563
+ :return_type => 'FlowObservationQueryResponse')
1564
1564
  if @api_client.config.debugging
1565
1565
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_flows_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1566
1566
  end
@@ -1571,7 +1571,7 @@ module PureCloud
1571
1571
  #
1572
1572
  # @param body query
1573
1573
  # @param [Hash] opts the optional parameters
1574
- # @return [QualifierMappingObservationQueryResponse]
1574
+ # @return [QueueObservationQueryResponse]
1575
1575
  def post_analytics_queues_observations_query(body, opts = {})
1576
1576
  data, _status_code, _headers = post_analytics_queues_observations_query_with_http_info(body, opts)
1577
1577
  return data
@@ -1581,7 +1581,7 @@ module PureCloud
1581
1581
  #
1582
1582
  # @param body query
1583
1583
  # @param [Hash] opts the optional parameters
1584
- # @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
1585
1585
  def post_analytics_queues_observations_query_with_http_info(body, opts = {})
1586
1586
  if @api_client.config.debugging
1587
1587
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_queues_observations_query ..."
@@ -1625,7 +1625,7 @@ module PureCloud
1625
1625
  :form_params => form_params,
1626
1626
  :body => post_body,
1627
1627
  :auth_names => auth_names,
1628
- :return_type => 'QualifierMappingObservationQueryResponse')
1628
+ :return_type => 'QueueObservationQueryResponse')
1629
1629
  if @api_client.config.debugging
1630
1630
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_queues_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1631
1631
  end
@@ -1831,7 +1831,7 @@ module PureCloud
1831
1831
  #
1832
1832
  # @param body query
1833
1833
  # @param [Hash] opts the optional parameters
1834
- # @return [AggregateQueryResponse]
1834
+ # @return [SurveyAggregateQueryResponse]
1835
1835
  def post_analytics_surveys_aggregates_query(body, opts = {})
1836
1836
  data, _status_code, _headers = post_analytics_surveys_aggregates_query_with_http_info(body, opts)
1837
1837
  return data
@@ -1841,7 +1841,7 @@ module PureCloud
1841
1841
  #
1842
1842
  # @param body query
1843
1843
  # @param [Hash] opts the optional parameters
1844
- # @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
1845
1845
  def post_analytics_surveys_aggregates_query_with_http_info(body, opts = {})
1846
1846
  if @api_client.config.debugging
1847
1847
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_surveys_aggregates_query ..."
@@ -1885,7 +1885,7 @@ module PureCloud
1885
1885
  :form_params => form_params,
1886
1886
  :body => post_body,
1887
1887
  :auth_names => auth_names,
1888
- :return_type => 'AggregateQueryResponse')
1888
+ :return_type => 'SurveyAggregateQueryResponse')
1889
1889
  if @api_client.config.debugging
1890
1890
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_surveys_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1891
1891
  end
@@ -1896,7 +1896,7 @@ module PureCloud
1896
1896
  #
1897
1897
  # @param body query
1898
1898
  # @param [Hash] opts the optional parameters
1899
- # @return [PresenceQueryResponse]
1899
+ # @return [UserAggregateQueryResponse]
1900
1900
  def post_analytics_users_aggregates_query(body, opts = {})
1901
1901
  data, _status_code, _headers = post_analytics_users_aggregates_query_with_http_info(body, opts)
1902
1902
  return data
@@ -1906,7 +1906,7 @@ module PureCloud
1906
1906
  #
1907
1907
  # @param body query
1908
1908
  # @param [Hash] opts the optional parameters
1909
- # @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
1910
1910
  def post_analytics_users_aggregates_query_with_http_info(body, opts = {})
1911
1911
  if @api_client.config.debugging
1912
1912
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_aggregates_query ..."
@@ -1950,7 +1950,7 @@ module PureCloud
1950
1950
  :form_params => form_params,
1951
1951
  :body => post_body,
1952
1952
  :auth_names => auth_names,
1953
- :return_type => 'PresenceQueryResponse')
1953
+ :return_type => 'UserAggregateQueryResponse')
1954
1954
  if @api_client.config.debugging
1955
1955
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_users_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1956
1956
  end
@@ -2026,7 +2026,7 @@ module PureCloud
2026
2026
  #
2027
2027
  # @param body query
2028
2028
  # @param [Hash] opts the optional parameters
2029
- # @return [ObservationQueryResponse]
2029
+ # @return [UserObservationQueryResponse]
2030
2030
  def post_analytics_users_observations_query(body, opts = {})
2031
2031
  data, _status_code, _headers = post_analytics_users_observations_query_with_http_info(body, opts)
2032
2032
  return data
@@ -2036,7 +2036,7 @@ module PureCloud
2036
2036
  #
2037
2037
  # @param body query
2038
2038
  # @param [Hash] opts the optional parameters
2039
- # @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
2040
2040
  def post_analytics_users_observations_query_with_http_info(body, opts = {})
2041
2041
  if @api_client.config.debugging
2042
2042
  @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_observations_query ..."
@@ -2080,7 +2080,7 @@ module PureCloud
2080
2080
  :form_params => form_params,
2081
2081
  :body => post_body,
2082
2082
  :auth_names => auth_names,
2083
- :return_type => 'ObservationQueryResponse')
2083
+ :return_type => 'UserObservationQueryResponse')
2084
2084
  if @api_client.config.debugging
2085
2085
  @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_users_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2086
2086
  end
@@ -4276,6 +4276,81 @@ module PureCloud
4276
4276
  return data, status_code, headers
4277
4277
  end
4278
4278
 
4279
+ # Returns the state information about an import job
4280
+ # Returns the state information about an import job.
4281
+ # @param datatable_id id of datatable
4282
+ # @param import_job_id id of import job
4283
+ # @param [Hash] opts the optional parameters
4284
+ # @return [DataTableImportJob]
4285
+ def get_flows_datatable_import_job(datatable_id, import_job_id, opts = {})
4286
+ data, _status_code, _headers = get_flows_datatable_import_job_with_http_info(datatable_id, import_job_id, opts)
4287
+ return data
4288
+ end
4289
+
4290
+ # Returns the state information about an import job
4291
+ # Returns the state information about an import job.
4292
+ # @param datatable_id id of datatable
4293
+ # @param import_job_id id of import job
4294
+ # @param [Hash] opts the optional parameters
4295
+ # @return [Array<(DataTableImportJob, Fixnum, Hash)>] DataTableImportJob data, response status code and response headers
4296
+ def get_flows_datatable_import_job_with_http_info(datatable_id, import_job_id, opts = {})
4297
+ if @api_client.config.debugging
4298
+ @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_datatable_import_job ..."
4299
+ end
4300
+
4301
+
4302
+ # verify the required parameter 'datatable_id' is set
4303
+ fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.get_flows_datatable_import_job" if datatable_id.nil?
4304
+
4305
+
4306
+
4307
+
4308
+
4309
+
4310
+ # verify the required parameter 'import_job_id' is set
4311
+ fail ArgumentError, "Missing the required parameter 'import_job_id' when calling ArchitectApi.get_flows_datatable_import_job" if import_job_id.nil?
4312
+
4313
+
4314
+
4315
+
4316
+
4317
+ # resource path
4318
+ local_var_path = "/api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_id.to_s).sub('{' + 'importJobId' + '}', import_job_id.to_s)
4319
+
4320
+ # query parameters
4321
+ query_params = {}
4322
+
4323
+ # header parameters
4324
+ header_params = {}
4325
+
4326
+ # HTTP header 'Accept' (if needed)
4327
+ local_header_accept = ['application/json']
4328
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
4329
+
4330
+ # HTTP header 'Content-Type'
4331
+ local_header_content_type = ['application/json']
4332
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
4333
+
4334
+ # form parameters
4335
+ form_params = {}
4336
+
4337
+ # http body (model)
4338
+ post_body = nil
4339
+
4340
+ auth_names = ['PureCloud OAuth']
4341
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
4342
+ :header_params => header_params,
4343
+ :query_params => query_params,
4344
+ :form_params => form_params,
4345
+ :body => post_body,
4346
+ :auth_names => auth_names,
4347
+ :return_type => 'DataTableImportJob')
4348
+ if @api_client.config.debugging
4349
+ @api_client.config.logger.debug "API called: ArchitectApi#get_flows_datatable_import_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4350
+ end
4351
+ return data, status_code, headers
4352
+ end
4353
+
4279
4354
  # Returns a specific row for the datatable
4280
4355
  # Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.
4281
4356
  # @param datatable_id id of datatable
@@ -912,7 +912,7 @@ module PureCloud
912
912
  # Get the organization role specified by its ID.
913
913
  # @param role_id Role ID
914
914
  # @param [Hash] opts the optional parameters
915
- # @option opts [Array<String>] :expand Which fields, if any, to expand.
915
+ # @option opts [Array<String>] :expand Which fields, if any, to expand. \&quot;unusedPermissions\&quot; returns the permissions not used for the role
916
916
  # @return [DomainOrganizationRole]
917
917
  def get_authorization_role(role_id, opts = {})
918
918
  data, _status_code, _headers = get_authorization_role_with_http_info(role_id, opts)
@@ -923,7 +923,7 @@ module PureCloud
923
923
  # Get the organization role specified by its ID.
924
924
  # @param role_id Role ID
925
925
  # @param [Hash] opts the optional parameters
926
- # @option opts [Array<String>] :expand Which fields, if any, to expand.
926
+ # @option opts [Array<String>] :expand Which fields, if any, to expand. \&quot;unusedPermissions\&quot; returns the permissions not used for the role
927
927
  # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers
928
928
  def get_authorization_role_with_http_info(role_id, opts = {})
929
929
  if @api_client.config.debugging
@@ -1774,8 +1774,8 @@ module PureCloud
1774
1774
  fail ArgumentError, "Missing the required parameter 'object_type' when calling AuthorizationApi.post_authorization_division_object" if object_type.nil?
1775
1775
 
1776
1776
  # verify enum value
1777
- unless ['QUEUE', 'CAMPAIGN', 'CONTACTLIST', 'DNCLIST', 'MANAGEMENTUNIT', 'BUSINESSUNIT', 'FLOW', 'USER'].include?(object_type)
1778
- fail ArgumentError, "invalid value for 'object_type', must be one of QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, BUSINESSUNIT, FLOW, USER"
1777
+ unless ['QUEUE', 'CAMPAIGN', 'CONTACTLIST', 'DNCLIST', 'MESSAGINGCAMPAIGN', 'MANAGEMENTUNIT', 'BUSINESSUNIT', 'FLOW', 'USER'].include?(object_type)
1778
+ fail ArgumentError, "invalid value for 'object_type', must be one of QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MESSAGINGCAMPAIGN, MANAGEMENTUNIT, BUSINESSUNIT, FLOW, USER"
1779
1779
  end
1780
1780
 
1781
1781
 
@@ -1896,7 +1896,7 @@ module PureCloud
1896
1896
  # @param role_id Role ID
1897
1897
  # @param body Subjects and Divisions
1898
1898
  # @param [Hash] opts the optional parameters
1899
- # @option opts [String] :subject_type what the type of the subject is, PC_GROUP or PC_USER (default to PC_USER)
1899
+ # @option opts [String] :subject_type what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (default to PC_USER)
1900
1900
  # @return [nil]
1901
1901
  def post_authorization_role(role_id, body, opts = {})
1902
1902
  post_authorization_role_with_http_info(role_id, body, opts)
@@ -1908,7 +1908,7 @@ module PureCloud
1908
1908
  # @param role_id Role ID
1909
1909
  # @param body Subjects and Divisions
1910
1910
  # @param [Hash] opts the optional parameters
1911
- # @option opts [String] :subject_type what the type of the subject is, PC_GROUP or PC_USER
1911
+ # @option opts [String] :subject_type what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)
1912
1912
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1913
1913
  def post_authorization_role_with_http_info(role_id, body, opts = {})
1914
1914
  if @api_client.config.debugging
@@ -2194,7 +2194,7 @@ module PureCloud
2194
2194
  # @param division_id the id of the division to which to make the grant
2195
2195
  # @param role_id the id of the role to grant
2196
2196
  # @param [Hash] opts the optional parameters
2197
- # @option opts [String] :subject_type what the type of the subject is, PC_GROUP or PC_USER (default to PC_USER)
2197
+ # @option opts [String] :subject_type what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) (default to PC_USER)
2198
2198
  # @return [nil]
2199
2199
  def post_authorization_subject_division_role(subject_id, division_id, role_id, opts = {})
2200
2200
  post_authorization_subject_division_role_with_http_info(subject_id, division_id, role_id, opts)
@@ -2207,7 +2207,7 @@ module PureCloud
2207
2207
  # @param division_id the id of the division to which to make the grant
2208
2208
  # @param role_id the id of the role to grant
2209
2209
  # @param [Hash] opts the optional parameters
2210
- # @option opts [String] :subject_type what the type of the subject is, PC_GROUP or PC_USER
2210
+ # @option opts [String] :subject_type what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints)
2211
2211
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2212
2212
  def post_authorization_subject_division_role_with_http_info(subject_id, division_id, role_id, opts = {})
2213
2213
  if @api_client.config.debugging
@@ -2071,6 +2071,186 @@ module PureCloud
2071
2071
  return data, status_code, headers
2072
2072
  end
2073
2073
 
2074
+ # Get a web chat conversation message
2075
+ #
2076
+ # @param conversation_id conversationId
2077
+ # @param message_id messageId
2078
+ # @param [Hash] opts the optional parameters
2079
+ # @return [WebChatMessage]
2080
+ def get_conversations_chat_message(conversation_id, message_id, opts = {})
2081
+ data, _status_code, _headers = get_conversations_chat_message_with_http_info(conversation_id, message_id, opts)
2082
+ return data
2083
+ end
2084
+
2085
+ # Get a web chat conversation message
2086
+ #
2087
+ # @param conversation_id conversationId
2088
+ # @param message_id messageId
2089
+ # @param [Hash] opts the optional parameters
2090
+ # @return [Array<(WebChatMessage, Fixnum, Hash)>] WebChatMessage data, response status code and response headers
2091
+ def get_conversations_chat_message_with_http_info(conversation_id, message_id, opts = {})
2092
+ if @api_client.config.debugging
2093
+ @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_chat_message ..."
2094
+ end
2095
+
2096
+
2097
+ # verify the required parameter 'conversation_id' is set
2098
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_chat_message" if conversation_id.nil?
2099
+
2100
+
2101
+
2102
+
2103
+
2104
+
2105
+ # verify the required parameter 'message_id' is set
2106
+ fail ArgumentError, "Missing the required parameter 'message_id' when calling ConversationsApi.get_conversations_chat_message" if message_id.nil?
2107
+
2108
+
2109
+
2110
+
2111
+
2112
+ # resource path
2113
+ local_var_path = "/api/v2/conversations/chats/{conversationId}/messages/{messageId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s)
2114
+
2115
+ # query parameters
2116
+ query_params = {}
2117
+
2118
+ # header parameters
2119
+ header_params = {}
2120
+
2121
+ # HTTP header 'Accept' (if needed)
2122
+ local_header_accept = ['application/json']
2123
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2124
+
2125
+ # HTTP header 'Content-Type'
2126
+ local_header_content_type = ['application/json']
2127
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2128
+
2129
+ # form parameters
2130
+ form_params = {}
2131
+
2132
+ # http body (model)
2133
+ post_body = nil
2134
+
2135
+ auth_names = ['PureCloud OAuth']
2136
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2137
+ :header_params => header_params,
2138
+ :query_params => query_params,
2139
+ :form_params => form_params,
2140
+ :body => post_body,
2141
+ :auth_names => auth_names,
2142
+ :return_type => 'WebChatMessage')
2143
+ if @api_client.config.debugging
2144
+ @api_client.config.logger.debug "API called: ConversationsApi#get_conversations_chat_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2145
+ end
2146
+ return data, status_code, headers
2147
+ end
2148
+
2149
+ # Get the messages of a chat conversation.
2150
+ #
2151
+ # @param conversation_id conversationId
2152
+ # @param [Hash] opts the optional parameters
2153
+ # @option opts [String] :after If specified, get the messages chronologically after the id of this message
2154
+ # @option opts [String] :before If specified, get the messages chronologically before the id of this message
2155
+ # @option opts [String] :sort_order Sort order (default to ascending)
2156
+ # @option opts [Integer] :max_results Limit the returned number of messages, up to a maximum of 100 (default to 100)
2157
+ # @return [WebChatMessageEntityList]
2158
+ def get_conversations_chat_messages(conversation_id, opts = {})
2159
+ data, _status_code, _headers = get_conversations_chat_messages_with_http_info(conversation_id, opts)
2160
+ return data
2161
+ end
2162
+
2163
+ # Get the messages of a chat conversation.
2164
+ #
2165
+ # @param conversation_id conversationId
2166
+ # @param [Hash] opts the optional parameters
2167
+ # @option opts [String] :after If specified, get the messages chronologically after the id of this message
2168
+ # @option opts [String] :before If specified, get the messages chronologically before the id of this message
2169
+ # @option opts [String] :sort_order Sort order
2170
+ # @option opts [Integer] :max_results Limit the returned number of messages, up to a maximum of 100
2171
+ # @return [Array<(WebChatMessageEntityList, Fixnum, Hash)>] WebChatMessageEntityList data, response status code and response headers
2172
+ def get_conversations_chat_messages_with_http_info(conversation_id, opts = {})
2173
+ if @api_client.config.debugging
2174
+ @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_chat_messages ..."
2175
+ end
2176
+
2177
+
2178
+ # verify the required parameter 'conversation_id' is set
2179
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_chat_messages" if conversation_id.nil?
2180
+
2181
+
2182
+
2183
+
2184
+
2185
+
2186
+
2187
+
2188
+
2189
+
2190
+
2191
+
2192
+
2193
+
2194
+
2195
+
2196
+
2197
+
2198
+
2199
+
2200
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
2201
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
2202
+ end
2203
+
2204
+
2205
+
2206
+
2207
+
2208
+
2209
+
2210
+
2211
+
2212
+
2213
+ # resource path
2214
+ local_var_path = "/api/v2/conversations/chats/{conversationId}/messages".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
2215
+
2216
+ # query parameters
2217
+ query_params = {}
2218
+ query_params[:'after'] = opts[:'after'] if opts[:'after']
2219
+ query_params[:'before'] = opts[:'before'] if opts[:'before']
2220
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
2221
+ query_params[:'maxResults'] = opts[:'max_results'] if opts[:'max_results']
2222
+
2223
+ # header parameters
2224
+ header_params = {}
2225
+
2226
+ # HTTP header 'Accept' (if needed)
2227
+ local_header_accept = ['application/json']
2228
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2229
+
2230
+ # HTTP header 'Content-Type'
2231
+ local_header_content_type = ['application/json']
2232
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2233
+
2234
+ # form parameters
2235
+ form_params = {}
2236
+
2237
+ # http body (model)
2238
+ post_body = nil
2239
+
2240
+ auth_names = ['PureCloud OAuth']
2241
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2242
+ :header_params => header_params,
2243
+ :query_params => query_params,
2244
+ :form_params => form_params,
2245
+ :body => post_body,
2246
+ :auth_names => auth_names,
2247
+ :return_type => 'WebChatMessageEntityList')
2248
+ if @api_client.config.debugging
2249
+ @api_client.config.logger.debug "API called: ConversationsApi#get_conversations_chat_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2250
+ end
2251
+ return data, status_code, headers
2252
+ end
2253
+
2074
2254
  # Get the wrap-up for this conversation participant.
2075
2255
  #
2076
2256
  # @param conversation_id conversationId
@@ -6622,7 +6802,7 @@ module PureCloud
6622
6802
  #
6623
6803
  # @param body query
6624
6804
  # @param [Hash] opts the optional parameters
6625
- # @return [AggregateQueryResponse]
6805
+ # @return [ConversationAggregateQueryResponse]
6626
6806
  def post_analytics_conversations_aggregates_query(body, opts = {})
6627
6807
  data, _status_code, _headers = post_analytics_conversations_aggregates_query_with_http_info(body, opts)
6628
6808
  return data
@@ -6632,7 +6812,7 @@ module PureCloud
6632
6812
  #
6633
6813
  # @param body query
6634
6814
  # @param [Hash] opts the optional parameters
6635
- # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers
6815
+ # @return [Array<(ConversationAggregateQueryResponse, Fixnum, Hash)>] ConversationAggregateQueryResponse data, response status code and response headers
6636
6816
  def post_analytics_conversations_aggregates_query_with_http_info(body, opts = {})
6637
6817
  if @api_client.config.debugging
6638
6818
  @api_client.config.logger.debug "Calling API: ConversationsApi.post_analytics_conversations_aggregates_query ..."
@@ -6676,7 +6856,7 @@ module PureCloud
6676
6856
  :form_params => form_params,
6677
6857
  :body => post_body,
6678
6858
  :auth_names => auth_names,
6679
- :return_type => 'AggregateQueryResponse')
6859
+ :return_type => 'ConversationAggregateQueryResponse')
6680
6860
  if @api_client.config.debugging
6681
6861
  @api_client.config.logger.debug "API called: ConversationsApi#post_analytics_conversations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6682
6862
  end
@@ -7816,6 +7996,166 @@ module PureCloud
7816
7996
  return data, status_code, headers
7817
7997
  end
7818
7998
 
7999
+ # Send a message on behalf of a communication in a chat conversation.
8000
+ #
8001
+ # @param conversation_id conversationId
8002
+ # @param communication_id communicationId
8003
+ # @param body Message
8004
+ # @param [Hash] opts the optional parameters
8005
+ # @return [WebChatMessage]
8006
+ def post_conversations_chat_communication_messages(conversation_id, communication_id, body, opts = {})
8007
+ data, _status_code, _headers = post_conversations_chat_communication_messages_with_http_info(conversation_id, communication_id, body, opts)
8008
+ return data
8009
+ end
8010
+
8011
+ # Send a message on behalf of a communication in a chat conversation.
8012
+ #
8013
+ # @param conversation_id conversationId
8014
+ # @param communication_id communicationId
8015
+ # @param body Message
8016
+ # @param [Hash] opts the optional parameters
8017
+ # @return [Array<(WebChatMessage, Fixnum, Hash)>] WebChatMessage data, response status code and response headers
8018
+ def post_conversations_chat_communication_messages_with_http_info(conversation_id, communication_id, body, opts = {})
8019
+ if @api_client.config.debugging
8020
+ @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_chat_communication_messages ..."
8021
+ end
8022
+
8023
+
8024
+ # verify the required parameter 'conversation_id' is set
8025
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_chat_communication_messages" if conversation_id.nil?
8026
+
8027
+
8028
+
8029
+
8030
+
8031
+
8032
+ # verify the required parameter 'communication_id' is set
8033
+ fail ArgumentError, "Missing the required parameter 'communication_id' when calling ConversationsApi.post_conversations_chat_communication_messages" if communication_id.nil?
8034
+
8035
+
8036
+
8037
+
8038
+
8039
+
8040
+ # verify the required parameter 'body' is set
8041
+ fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversations_chat_communication_messages" if body.nil?
8042
+
8043
+
8044
+
8045
+
8046
+
8047
+ # resource path
8048
+ local_var_path = "/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'communicationId' + '}', communication_id.to_s)
8049
+
8050
+ # query parameters
8051
+ query_params = {}
8052
+
8053
+ # header parameters
8054
+ header_params = {}
8055
+
8056
+ # HTTP header 'Accept' (if needed)
8057
+ local_header_accept = ['application/json']
8058
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
8059
+
8060
+ # HTTP header 'Content-Type'
8061
+ local_header_content_type = ['application/json']
8062
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
8063
+
8064
+ # form parameters
8065
+ form_params = {}
8066
+
8067
+ # http body (model)
8068
+ post_body = @api_client.object_to_http_body(body)
8069
+
8070
+ auth_names = ['PureCloud OAuth']
8071
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
8072
+ :header_params => header_params,
8073
+ :query_params => query_params,
8074
+ :form_params => form_params,
8075
+ :body => post_body,
8076
+ :auth_names => auth_names,
8077
+ :return_type => 'WebChatMessage')
8078
+ if @api_client.config.debugging
8079
+ @api_client.config.logger.debug "API called: ConversationsApi#post_conversations_chat_communication_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8080
+ end
8081
+ return data, status_code, headers
8082
+ end
8083
+
8084
+ # Send a typing-indicator on behalf of a communication in a chat conversation.
8085
+ #
8086
+ # @param conversation_id conversationId
8087
+ # @param communication_id communicationId
8088
+ # @param [Hash] opts the optional parameters
8089
+ # @return [WebChatTyping]
8090
+ def post_conversations_chat_communication_typing(conversation_id, communication_id, opts = {})
8091
+ data, _status_code, _headers = post_conversations_chat_communication_typing_with_http_info(conversation_id, communication_id, opts)
8092
+ return data
8093
+ end
8094
+
8095
+ # Send a typing-indicator on behalf of a communication in a chat conversation.
8096
+ #
8097
+ # @param conversation_id conversationId
8098
+ # @param communication_id communicationId
8099
+ # @param [Hash] opts the optional parameters
8100
+ # @return [Array<(WebChatTyping, Fixnum, Hash)>] WebChatTyping data, response status code and response headers
8101
+ def post_conversations_chat_communication_typing_with_http_info(conversation_id, communication_id, opts = {})
8102
+ if @api_client.config.debugging
8103
+ @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_chat_communication_typing ..."
8104
+ end
8105
+
8106
+
8107
+ # verify the required parameter 'conversation_id' is set
8108
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_chat_communication_typing" if conversation_id.nil?
8109
+
8110
+
8111
+
8112
+
8113
+
8114
+
8115
+ # verify the required parameter 'communication_id' is set
8116
+ fail ArgumentError, "Missing the required parameter 'communication_id' when calling ConversationsApi.post_conversations_chat_communication_typing" if communication_id.nil?
8117
+
8118
+
8119
+
8120
+
8121
+
8122
+ # resource path
8123
+ local_var_path = "/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'communicationId' + '}', communication_id.to_s)
8124
+
8125
+ # query parameters
8126
+ query_params = {}
8127
+
8128
+ # header parameters
8129
+ header_params = {}
8130
+
8131
+ # HTTP header 'Accept' (if needed)
8132
+ local_header_accept = ['application/json']
8133
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
8134
+
8135
+ # HTTP header 'Content-Type'
8136
+ local_header_content_type = ['application/json']
8137
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
8138
+
8139
+ # form parameters
8140
+ form_params = {}
8141
+
8142
+ # http body (model)
8143
+ post_body = nil
8144
+
8145
+ auth_names = ['PureCloud OAuth']
8146
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
8147
+ :header_params => header_params,
8148
+ :query_params => query_params,
8149
+ :form_params => form_params,
8150
+ :body => post_body,
8151
+ :auth_names => auth_names,
8152
+ :return_type => 'WebChatTyping')
8153
+ if @api_client.config.debugging
8154
+ @api_client.config.logger.debug "API called: ConversationsApi#post_conversations_chat_communication_typing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8155
+ end
8156
+ return data, status_code, headers
8157
+ end
8158
+
7819
8159
  # Replace this participant with the specified user and/or address
7820
8160
  #
7821
8161
  # @param conversation_id conversationId