purecloudplatformclientv2 61.0.0 → 62.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 (576) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActionEntityListing.md +2 -2
  4. data/docs/AgentActivityEntityListing.md +2 -2
  5. data/docs/AnalyticsApi.md +267 -0
  6. data/docs/AnalyticsConversationAsyncQueryResponse.md +14 -0
  7. data/docs/AnalyticsEvaluation.md +1 -1
  8. data/docs/ArrayNode.md +7 -7
  9. data/docs/AsyncQueryResponse.md +13 -0
  10. data/docs/AsyncQueryStatus.md +17 -0
  11. data/docs/AttemptLimitsEntityListing.md +2 -2
  12. data/docs/Attribute.md +2 -2
  13. data/docs/AuthorizationApi.md +6 -2
  14. data/docs/AuthzDivisionEntityListing.md +2 -2
  15. data/docs/BillingApi.md +4 -4
  16. data/docs/BillingUsageReport.md +1 -0
  17. data/docs/CalibrationEntityListing.md +2 -2
  18. data/docs/CallConversationEntityListing.md +2 -2
  19. data/docs/CallHistoryConversationEntityListing.md +2 -2
  20. data/docs/CallMediaParticipant.md +6 -6
  21. data/docs/CallableContactsDiagnostic.md +4 -4
  22. data/docs/CallableTimeSetEntityListing.md +2 -2
  23. data/docs/CallbackConversationEntityListing.md +2 -2
  24. data/docs/CallbackMediaParticipant.md +5 -5
  25. data/docs/Campaign.md +11 -11
  26. data/docs/CampaignDivisionViewListing.md +2 -2
  27. data/docs/CampaignEntityListing.md +2 -2
  28. data/docs/CampaignInteraction.md +6 -6
  29. data/docs/CampaignInteractions.md +1 -1
  30. data/docs/CampaignProgress.md +2 -2
  31. data/docs/CampaignRuleActionEntities.md +2 -2
  32. data/docs/CampaignRuleEntities.md +2 -2
  33. data/docs/CampaignRuleEntityListing.md +2 -2
  34. data/docs/CampaignSchedule.md +1 -1
  35. data/docs/CampaignSequence.md +1 -1
  36. data/docs/CampaignSequenceEntityListing.md +2 -2
  37. data/docs/CertificateAuthorityEntityListing.md +2 -2
  38. data/docs/ChatConversationEntityListing.md +2 -2
  39. data/docs/ChatMediaParticipant.md +5 -5
  40. data/docs/ClientAppEntityListing.md +2 -2
  41. data/docs/CobrowseConversationEntityListing.md +2 -2
  42. data/docs/CobrowseMediaParticipant.md +5 -5
  43. data/docs/CommandStatusEntityListing.md +2 -2
  44. data/docs/ConsumedResourcesEntityListing.md +2 -2
  45. data/docs/ConsumingResourcesEntityListing.md +2 -2
  46. data/docs/ContactList.md +2 -2
  47. data/docs/ContactListDivisionViewListing.md +2 -2
  48. data/docs/ContactListEntityListing.md +2 -2
  49. data/docs/ContactListFilter.md +1 -1
  50. data/docs/ContactListFilterEntityListing.md +2 -2
  51. data/docs/ContactListing.md +2 -2
  52. data/docs/ConversationDivisionMembership.md +2 -2
  53. data/docs/ConversationEntityListing.md +2 -2
  54. data/docs/ConversationsApi.md +471 -0
  55. data/docs/CreateCallbackResponse.md +1 -1
  56. data/docs/CreateQueueRequest.md +2 -2
  57. data/docs/CreateShareResponse.md +4 -4
  58. data/docs/CreateUser.md +1 -0
  59. data/docs/CredentialInfoListing.md +2 -2
  60. data/docs/CredentialTypeListing.md +2 -2
  61. data/docs/DID.md +2 -2
  62. data/docs/DIDEntityListing.md +2 -2
  63. data/docs/DIDPoolEntityListing.md +2 -2
  64. data/docs/DataSchema.md +1 -1
  65. data/docs/DataTableRowEntityListing.md +2 -2
  66. data/docs/DataTablesDomainEntityListing.md +2 -2
  67. data/docs/DependencyObjectEntityListing.md +2 -2
  68. data/docs/DependencyTypeEntityListing.md +2 -2
  69. data/docs/DialerEventEntityListing.md +2 -2
  70. data/docs/DialogflowAgentSummaryEntityListing.md +2 -2
  71. data/docs/DirectoryUserDevicesListing.md +2 -2
  72. data/docs/DncList.md +1 -1
  73. data/docs/DncListCreate.md +1 -1
  74. data/docs/DncListDivisionViewListing.md +2 -2
  75. data/docs/DncListEntityListing.md +2 -2
  76. data/docs/Document.md +4 -4
  77. data/docs/DocumentAudit.md +2 -2
  78. data/docs/DocumentAuditEntityListing.md +2 -2
  79. data/docs/DocumentEntityListing.md +2 -2
  80. data/docs/DocumentUpload.md +1 -1
  81. data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
  82. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
  83. data/docs/DomainEntityListing.md +2 -2
  84. data/docs/DomainEntityListingEvaluationForm.md +2 -2
  85. data/docs/DomainEntityListingQueryResult.md +2 -2
  86. data/docs/DomainEntityListingSurveyForm.md +2 -2
  87. data/docs/{UriReference.md → DomainEntityRef.md} +2 -2
  88. data/docs/DomainOrganizationRole.md +1 -0
  89. data/docs/DomainOrganizationRoleCreate.md +1 -0
  90. data/docs/DomainOrganizationRoleUpdate.md +1 -0
  91. data/docs/EdgeEntityListing.md +2 -2
  92. data/docs/EdgeGroupEntityListing.md +2 -2
  93. data/docs/EdgeInterface.md +1 -1
  94. data/docs/EdgeLine.md +1 -1
  95. data/docs/EdgeLineEntityListing.md +2 -2
  96. data/docs/EdgeMetrics.md +1 -1
  97. data/docs/EdgeTrunkBase.md +1 -1
  98. data/docs/EmailConversationEntityListing.md +2 -2
  99. data/docs/EmailMediaParticipant.md +5 -5
  100. data/docs/EmailMessageListing.md +2 -2
  101. data/docs/EmergencyCallFlow.md +2 -2
  102. data/docs/EmergencyGroupListing.md +2 -2
  103. data/docs/EncryptionKeyEntityListing.md +2 -2
  104. data/docs/Endpoint.md +2 -2
  105. data/docs/EvaluationEntityListing.md +2 -2
  106. data/docs/EvaluationFormEntityListing.md +2 -2
  107. data/docs/EvaluatorActivityEntityListing.md +2 -2
  108. data/docs/EventLog.md +2 -2
  109. data/docs/Extension.md +2 -2
  110. data/docs/ExtensionEntityListing.md +2 -2
  111. data/docs/ExtensionPoolEntityListing.md +2 -2
  112. data/docs/ExternalOrganizationListing.md +2 -2
  113. data/docs/FacebookIntegration.md +3 -3
  114. data/docs/FacebookIntegrationEntityListing.md +2 -2
  115. data/docs/FaxDocument.md +2 -2
  116. data/docs/FaxDocumentEntityListing.md +2 -2
  117. data/docs/FlowDivisionViewEntityListing.md +2 -2
  118. data/docs/FlowEntityListing.md +2 -2
  119. data/docs/FlowOutcomeListing.md +2 -2
  120. data/docs/FlowVersionEntityListing.md +2 -2
  121. data/docs/GDPRRequest.md +1 -1
  122. data/docs/GDPRRequestEntityListing.md +2 -2
  123. data/docs/GDPRSubjectEntityListing.md +2 -2
  124. data/docs/GreetingListing.md +2 -2
  125. data/docs/GroupEntityListing.md +2 -2
  126. data/docs/GroupProfileEntityListing.md +2 -2
  127. data/docs/GroupsApi.md +1 -1
  128. data/docs/IVR.md +4 -4
  129. data/docs/IVREntityListing.md +2 -2
  130. data/docs/InboundDomainEntityListing.md +2 -2
  131. data/docs/InboundRoute.md +5 -5
  132. data/docs/InboundRouteEntityListing.md +2 -2
  133. data/docs/IntegrationEntityListing.md +2 -2
  134. data/docs/IntegrationEventEntityListing.md +2 -2
  135. data/docs/IntegrationExport.md +2 -2
  136. data/docs/IntegrationTypeEntityListing.md +2 -2
  137. data/docs/InteractionStatsAlertContainer.md +2 -2
  138. data/docs/InteractionStatsRuleContainer.md +2 -2
  139. data/docs/JsonNode.md +7 -7
  140. data/docs/KeywordSetEntityListing.md +2 -2
  141. data/docs/LanguageEntityListing.md +2 -2
  142. data/docs/LexBotAliasEntityListing.md +2 -2
  143. data/docs/LexBotEntityListing.md +2 -2
  144. data/docs/LibraryEntityListing.md +2 -2
  145. data/docs/Line.md +6 -6
  146. data/docs/LineBase.md +1 -1
  147. data/docs/LineBaseEntityListing.md +2 -2
  148. data/docs/LineEntityListing.md +2 -2
  149. data/docs/LineIntegration.md +3 -3
  150. data/docs/LineIntegrationEntityListing.md +2 -2
  151. data/docs/LocationEntityListing.md +2 -2
  152. data/docs/LockInfo.md +1 -1
  153. data/docs/LogicalInterfaceEntityListing.md +2 -2
  154. data/docs/ManagementUnitListing.md +2 -2
  155. data/docs/Manager.md +1 -1
  156. data/docs/MessageConversationEntityListing.md +2 -2
  157. data/docs/MessageMediaParticipant.md +5 -5
  158. data/docs/MessagingIntegration.md +3 -3
  159. data/docs/MessagingIntegrationEntityListing.md +2 -2
  160. data/docs/MessagingStickerEntityListing.md +2 -2
  161. data/docs/NoteListing.md +2 -2
  162. data/docs/OAuthClient.md +2 -2
  163. data/docs/OAuthClientEntityListing.md +2 -2
  164. data/docs/OAuthClientListing.md +2 -2
  165. data/docs/OAuthProviderEntityListing.md +2 -2
  166. data/docs/OrgOAuthClient.md +2 -2
  167. data/docs/OrganizationPresenceEntityListing.md +2 -2
  168. data/docs/OrganizationRoleEntityListing.md +2 -2
  169. data/docs/OrphanRecordingListing.md +2 -2
  170. data/docs/OutboundApi.md +4 -4
  171. data/docs/OutboundRoute.md +1 -1
  172. data/docs/OutboundRouteBase.md +1 -1
  173. data/docs/OutboundRouteBaseEntityListing.md +2 -2
  174. data/docs/OutboundRouteEntityListing.md +2 -2
  175. data/docs/PermissionCollectionEntityListing.md +2 -2
  176. data/docs/Phone.md +5 -5
  177. data/docs/PhoneBase.md +1 -1
  178. data/docs/PhoneBaseEntityListing.md +2 -2
  179. data/docs/PhoneEntityListing.md +2 -2
  180. data/docs/PhoneMetaBaseEntityListing.md +2 -2
  181. data/docs/PhoneStatus.md +1 -1
  182. data/docs/Photo.md +1 -1
  183. data/docs/PhysicalInterfaceEntityListing.md +2 -2
  184. data/docs/PolicyEntityListing.md +2 -2
  185. data/docs/PromptAssetEntityListing.md +2 -2
  186. data/docs/PromptEntityListing.md +2 -2
  187. data/docs/QualityAuditPage.md +2 -2
  188. data/docs/Queue.md +2 -2
  189. data/docs/QueueEmailAddress.md +1 -1
  190. data/docs/QueueEntityListing.md +2 -2
  191. data/docs/QueueMemberEntityListing.md +2 -2
  192. data/docs/QueueMessagingAddresses.md +1 -1
  193. data/docs/QueueRequest.md +2 -2
  194. data/docs/QueueUtilizationDiagnostic.md +1 -1
  195. data/docs/RecipientListing.md +2 -2
  196. data/docs/RecordingJobEntityListing.md +2 -2
  197. data/docs/RecordingJobsQuery.md +2 -1
  198. data/docs/RelationshipListing.md +2 -2
  199. data/docs/ReplaceResponse.md +1 -1
  200. data/docs/ReportMetaDataEntityListing.md +2 -2
  201. data/docs/ReportRunEntryEntityDomainListing.md +2 -2
  202. data/docs/ReportScheduleEntityListing.md +2 -2
  203. data/docs/ReportingExportJobListing.md +2 -2
  204. data/docs/Response.md +1 -1
  205. data/docs/ResponseEntityList.md +2 -2
  206. data/docs/ResponseEntityListing.md +2 -2
  207. data/docs/ResponseSetEntityListing.md +2 -2
  208. data/docs/RoutingApi.md +3 -1
  209. data/docs/RuleSet.md +2 -2
  210. data/docs/RuleSetDiagnostic.md +1 -1
  211. data/docs/RuleSetEntityListing.md +2 -2
  212. data/docs/ScheduleEntityListing.md +2 -2
  213. data/docs/ScheduleGroup.md +3 -3
  214. data/docs/ScheduleGroupEntityListing.md +2 -2
  215. data/docs/SchemaCategoryEntityListing.md +2 -2
  216. data/docs/SchemaReferenceEntityListing.md +2 -2
  217. data/docs/ScimGroupListResponse.md +4 -4
  218. data/docs/ScimPhoneNumber.md +1 -1
  219. data/docs/ScimUserListResponse.md +4 -4
  220. data/docs/ScimV2CreateUser.md +2 -3
  221. data/docs/ScimV2Group.md +2 -2
  222. data/docs/ScimV2GroupReference.md +2 -3
  223. data/docs/ScimV2MemberReference.md +2 -3
  224. data/docs/ScimV2User.md +4 -4
  225. data/docs/ScreenRecordingSessionListing.md +2 -2
  226. data/docs/ScriptEntityListing.md +2 -2
  227. data/docs/SearchApi.md +2 -2
  228. data/docs/SecureSession.md +1 -1
  229. data/docs/SecurityProfileEntityListing.md +2 -2
  230. data/docs/SequenceSchedule.md +1 -1
  231. data/docs/Share.md +4 -4
  232. data/docs/ShareEntityListing.md +2 -2
  233. data/docs/Site.md +2 -2
  234. data/docs/SiteEntityListing.md +2 -2
  235. data/docs/SkillEntityListing.md +2 -2
  236. data/docs/SmsAddressEntityListing.md +2 -2
  237. data/docs/SmsPhoneNumberEntityListing.md +2 -2
  238. data/docs/SpeechTextAnalyticsApi.md +80 -0
  239. data/docs/Station.md +2 -2
  240. data/docs/StationEntityListing.md +2 -2
  241. data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
  242. data/docs/SuggestApi.md +2 -2
  243. data/docs/Survey.md +1 -1
  244. data/docs/SurveyAssignment.md +1 -1
  245. data/docs/SurveyFormEntityListing.md +2 -2
  246. data/docs/SystemPromptAssetEntityListing.md +2 -2
  247. data/docs/SystemPromptEntityListing.md +2 -2
  248. data/docs/TagValueEntityListing.md +2 -2
  249. data/docs/TextMessageListing.md +2 -2
  250. data/docs/TimeZoneEntityListing.md +2 -2
  251. data/docs/TimeZoneMappingPreview.md +1 -1
  252. data/docs/TranscriptProperty.md +15 -0
  253. data/docs/Trunk.md +5 -5
  254. data/docs/TrunkBase.md +1 -1
  255. data/docs/TrunkBaseEntityListing.md +2 -2
  256. data/docs/TrunkEntityListing.md +2 -2
  257. data/docs/TrunkMetabaseEntityListing.md +2 -2
  258. data/docs/TrunkMetrics.md +2 -2
  259. data/docs/TrustEntityListing.md +2 -2
  260. data/docs/TrustUserEntityListing.md +2 -2
  261. data/docs/TrustorEntityListing.md +2 -2
  262. data/docs/TtsEngineEntityListing.md +2 -2
  263. data/docs/TtsVoiceEntityListing.md +2 -2
  264. data/docs/TwitterIntegration.md +3 -3
  265. data/docs/TwitterIntegrationEntityListing.md +2 -2
  266. data/docs/UserActionCategoryEntityListing.md +2 -2
  267. data/docs/UserAuthorization.md +1 -0
  268. data/docs/UserEntityListing.md +2 -2
  269. data/docs/UserLanguageEntityListing.md +2 -2
  270. data/docs/UserProfileEntityListing.md +2 -2
  271. data/docs/UserQueue.md +2 -2
  272. data/docs/UserQueueEntityListing.md +2 -2
  273. data/docs/UserRecording.md +2 -2
  274. data/docs/UserRecordingEntityListing.md +2 -2
  275. data/docs/UserSkillEntityListing.md +2 -2
  276. data/docs/UsersApi.md +9 -9
  277. data/docs/VoicemailMessageEntityListing.md +2 -2
  278. data/docs/WebChatDeployment.md +1 -1
  279. data/docs/WebChatMemberInfoEntityList.md +2 -2
  280. data/docs/WhatsAppIntegration.md +25 -0
  281. data/docs/WhatsAppIntegrationEntityListing.md +22 -0
  282. data/docs/WhatsAppIntegrationUpdateRequest.md +18 -0
  283. data/docs/WidgetDeployment.md +1 -1
  284. data/docs/Workspace.md +1 -1
  285. data/docs/WorkspaceEntityListing.md +2 -2
  286. data/docs/WorkspaceMember.md +2 -2
  287. data/docs/WorkspaceMemberEntityListing.md +2 -2
  288. data/docs/WrapupCodeEntityListing.md +2 -2
  289. data/lib/purecloudplatformclientv2.rb +9 -1
  290. data/lib/purecloudplatformclientv2/api/analytics_api.rb +268 -0
  291. data/lib/purecloudplatformclientv2/api/authorization_api.rb +9 -0
  292. data/lib/purecloudplatformclientv2/api/billing_api.rb +4 -4
  293. data/lib/purecloudplatformclientv2/api/conversations_api.rb +481 -0
  294. data/lib/purecloudplatformclientv2/api/outbound_api.rb +6 -6
  295. data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
  296. data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +102 -0
  297. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  298. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +13 -13
  299. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +13 -13
  300. data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +229 -0
  301. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  302. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
  303. data/lib/purecloudplatformclientv2/models/array_node.rb +75 -75
  304. data/lib/purecloudplatformclientv2/models/async_query_response.rb +202 -0
  305. data/lib/purecloudplatformclientv2/models/async_query_status.rb +320 -0
  306. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +13 -13
  307. data/lib/purecloudplatformclientv2/models/attribute.rb +2 -2
  308. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +13 -13
  309. data/lib/purecloudplatformclientv2/models/billing_usage_report.rb +41 -1
  310. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +13 -13
  311. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +13 -13
  312. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +13 -13
  313. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +6 -6
  314. data/lib/purecloudplatformclientv2/models/callable_contacts_diagnostic.rb +4 -4
  315. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +13 -13
  316. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +13 -13
  317. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +5 -5
  318. data/lib/purecloudplatformclientv2/models/campaign.rb +11 -11
  319. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +13 -13
  320. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +13 -13
  321. data/lib/purecloudplatformclientv2/models/campaign_interaction.rb +6 -6
  322. data/lib/purecloudplatformclientv2/models/campaign_interactions.rb +1 -1
  323. data/lib/purecloudplatformclientv2/models/campaign_progress.rb +2 -2
  324. data/lib/purecloudplatformclientv2/models/campaign_rule_action_entities.rb +2 -2
  325. data/lib/purecloudplatformclientv2/models/campaign_rule_entities.rb +2 -2
  326. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +13 -13
  327. data/lib/purecloudplatformclientv2/models/campaign_schedule.rb +1 -1
  328. data/lib/purecloudplatformclientv2/models/campaign_sequence.rb +1 -1
  329. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +13 -13
  330. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +13 -13
  331. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +13 -13
  332. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +5 -5
  333. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +13 -13
  334. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +13 -13
  335. data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +5 -5
  336. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +13 -13
  337. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +13 -13
  338. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +13 -13
  339. data/lib/purecloudplatformclientv2/models/contact_list.rb +2 -2
  340. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +13 -13
  341. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +13 -13
  342. data/lib/purecloudplatformclientv2/models/contact_list_filter.rb +1 -1
  343. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +13 -13
  344. data/lib/purecloudplatformclientv2/models/contact_listing.rb +13 -13
  345. data/lib/purecloudplatformclientv2/models/conversation_division_membership.rb +2 -2
  346. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +13 -13
  347. data/lib/purecloudplatformclientv2/models/create_callback_response.rb +1 -1
  348. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +2 -2
  349. data/lib/purecloudplatformclientv2/models/create_share_response.rb +4 -4
  350. data/lib/purecloudplatformclientv2/models/create_user.rb +44 -4
  351. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +13 -13
  352. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +13 -13
  353. data/lib/purecloudplatformclientv2/models/data_schema.rb +1 -1
  354. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +13 -13
  355. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +13 -13
  356. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +13 -13
  357. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +13 -13
  358. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +13 -13
  359. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +13 -13
  360. data/lib/purecloudplatformclientv2/models/did.rb +2 -2
  361. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +13 -13
  362. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +13 -13
  363. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +13 -13
  364. data/lib/purecloudplatformclientv2/models/dnc_list.rb +1 -1
  365. data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +1 -1
  366. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +13 -13
  367. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +13 -13
  368. data/lib/purecloudplatformclientv2/models/document.rb +4 -4
  369. data/lib/purecloudplatformclientv2/models/document_audit.rb +2 -2
  370. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +13 -13
  371. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +13 -13
  372. data/lib/purecloudplatformclientv2/models/document_upload.rb +1 -1
  373. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
  374. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +13 -13
  375. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +13 -13
  376. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +13 -13
  377. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +13 -13
  378. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +13 -13
  379. data/lib/purecloudplatformclientv2/models/{uri_reference.rb → domain_entity_ref.rb} +1 -1
  380. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +28 -1
  381. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +28 -1
  382. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +28 -1
  383. data/lib/purecloudplatformclientv2/models/edge.rb +2 -2
  384. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +13 -13
  385. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +13 -13
  386. data/lib/purecloudplatformclientv2/models/edge_interface.rb +1 -1
  387. data/lib/purecloudplatformclientv2/models/edge_line.rb +1 -1
  388. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +13 -13
  389. data/lib/purecloudplatformclientv2/models/edge_metrics.rb +1 -1
  390. data/lib/purecloudplatformclientv2/models/edge_trunk_base.rb +1 -1
  391. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +13 -13
  392. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +5 -5
  393. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +13 -13
  394. data/lib/purecloudplatformclientv2/models/emergency_call_flow.rb +2 -2
  395. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +13 -13
  396. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +13 -13
  397. data/lib/purecloudplatformclientv2/models/endpoint.rb +2 -2
  398. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +13 -13
  399. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +13 -13
  400. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +13 -13
  401. data/lib/purecloudplatformclientv2/models/event_log.rb +2 -2
  402. data/lib/purecloudplatformclientv2/models/extension.rb +2 -2
  403. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +13 -13
  404. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +13 -13
  405. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +13 -13
  406. data/lib/purecloudplatformclientv2/models/facebook_integration.rb +3 -3
  407. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +13 -13
  408. data/lib/purecloudplatformclientv2/models/fax_document.rb +2 -2
  409. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +13 -13
  410. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +13 -13
  411. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +13 -13
  412. data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +13 -13
  413. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +13 -13
  414. data/lib/purecloudplatformclientv2/models/gdpr_request.rb +1 -1
  415. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +13 -13
  416. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +13 -13
  417. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +13 -13
  418. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +13 -13
  419. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +13 -13
  420. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +13 -13
  421. data/lib/purecloudplatformclientv2/models/inbound_route.rb +5 -5
  422. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +13 -13
  423. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +13 -13
  424. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +13 -13
  425. data/lib/purecloudplatformclientv2/models/integration_export.rb +7 -2
  426. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +13 -13
  427. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +13 -13
  428. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +13 -13
  429. data/lib/purecloudplatformclientv2/models/ivr.rb +4 -4
  430. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +13 -13
  431. data/lib/purecloudplatformclientv2/models/json_node.rb +75 -75
  432. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +13 -13
  433. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +13 -13
  434. data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +13 -13
  435. data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +13 -13
  436. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +13 -13
  437. data/lib/purecloudplatformclientv2/models/line.rb +6 -6
  438. data/lib/purecloudplatformclientv2/models/line_base.rb +1 -1
  439. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +13 -13
  440. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +13 -13
  441. data/lib/purecloudplatformclientv2/models/line_integration.rb +3 -3
  442. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +13 -13
  443. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +13 -13
  444. data/lib/purecloudplatformclientv2/models/lock_info.rb +1 -1
  445. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +13 -13
  446. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +13 -13
  447. data/lib/purecloudplatformclientv2/models/manager.rb +2 -2
  448. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +13 -13
  449. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +5 -5
  450. data/lib/purecloudplatformclientv2/models/messaging_integration.rb +3 -3
  451. data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +13 -13
  452. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +13 -13
  453. data/lib/purecloudplatformclientv2/models/note_listing.rb +13 -13
  454. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +2 -2
  455. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +13 -13
  456. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +2 -2
  457. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +13 -13
  458. data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +2 -2
  459. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +13 -13
  460. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +13 -13
  461. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +13 -13
  462. data/lib/purecloudplatformclientv2/models/outbound_route.rb +1 -1
  463. data/lib/purecloudplatformclientv2/models/outbound_route_base.rb +1 -1
  464. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +13 -13
  465. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +13 -13
  466. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +13 -13
  467. data/lib/purecloudplatformclientv2/models/phone.rb +5 -5
  468. data/lib/purecloudplatformclientv2/models/phone_base.rb +1 -1
  469. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +13 -13
  470. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +13 -13
  471. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +13 -13
  472. data/lib/purecloudplatformclientv2/models/phone_status.rb +1 -1
  473. data/lib/purecloudplatformclientv2/models/photo.rb +1 -1
  474. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +13 -13
  475. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +13 -13
  476. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +13 -13
  477. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +13 -13
  478. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +13 -13
  479. data/lib/purecloudplatformclientv2/models/queue.rb +2 -2
  480. data/lib/purecloudplatformclientv2/models/queue_email_address.rb +1 -1
  481. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +13 -13
  482. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +13 -13
  483. data/lib/purecloudplatformclientv2/models/queue_messaging_addresses.rb +1 -1
  484. data/lib/purecloudplatformclientv2/models/queue_request.rb +2 -2
  485. data/lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb +1 -1
  486. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +13 -13
  487. data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +13 -13
  488. data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +27 -6
  489. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +13 -13
  490. data/lib/purecloudplatformclientv2/models/replace_response.rb +1 -1
  491. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +13 -13
  492. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +13 -13
  493. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +13 -13
  494. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +13 -13
  495. data/lib/purecloudplatformclientv2/models/response.rb +1 -1
  496. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +13 -13
  497. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +13 -13
  498. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +13 -13
  499. data/lib/purecloudplatformclientv2/models/rule_set.rb +2 -2
  500. data/lib/purecloudplatformclientv2/models/rule_set_diagnostic.rb +1 -1
  501. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +13 -13
  502. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +13 -13
  503. data/lib/purecloudplatformclientv2/models/schedule_group.rb +3 -3
  504. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +13 -13
  505. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +13 -13
  506. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +13 -13
  507. data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +4 -4
  508. data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +1 -1
  509. data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +4 -4
  510. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -29
  511. data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +2 -2
  512. data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +3 -29
  513. data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +3 -29
  514. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +17 -17
  515. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +13 -13
  516. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +13 -13
  517. data/lib/purecloudplatformclientv2/models/secure_session.rb +1 -1
  518. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +13 -13
  519. data/lib/purecloudplatformclientv2/models/sequence_schedule.rb +1 -1
  520. data/lib/purecloudplatformclientv2/models/share.rb +4 -4
  521. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +13 -13
  522. data/lib/purecloudplatformclientv2/models/site.rb +2 -2
  523. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +13 -13
  524. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +13 -13
  525. data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +13 -13
  526. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +13 -13
  527. data/lib/purecloudplatformclientv2/models/station.rb +2 -2
  528. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +13 -13
  529. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +13 -13
  530. data/lib/purecloudplatformclientv2/models/survey.rb +1 -1
  531. data/lib/purecloudplatformclientv2/models/survey_assignment.rb +1 -1
  532. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +13 -13
  533. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +13 -13
  534. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +13 -13
  535. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +13 -13
  536. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +13 -13
  537. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +13 -13
  538. data/lib/purecloudplatformclientv2/models/time_zone_mapping_preview.rb +1 -1
  539. data/lib/purecloudplatformclientv2/models/transcript_property.rb +254 -0
  540. data/lib/purecloudplatformclientv2/models/trunk.rb +5 -5
  541. data/lib/purecloudplatformclientv2/models/trunk_base.rb +1 -1
  542. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +13 -13
  543. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +13 -13
  544. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +13 -13
  545. data/lib/purecloudplatformclientv2/models/trunk_metrics.rb +2 -2
  546. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +13 -13
  547. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +13 -13
  548. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +13 -13
  549. data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +13 -13
  550. data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +13 -13
  551. data/lib/purecloudplatformclientv2/models/twitter_integration.rb +3 -3
  552. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +13 -13
  553. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +13 -13
  554. data/lib/purecloudplatformclientv2/models/user_authorization.rb +28 -1
  555. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +13 -13
  556. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +13 -13
  557. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +13 -13
  558. data/lib/purecloudplatformclientv2/models/user_queue.rb +2 -2
  559. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +13 -13
  560. data/lib/purecloudplatformclientv2/models/user_recording.rb +2 -2
  561. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +13 -13
  562. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +13 -13
  563. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +13 -13
  564. data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +1 -1
  565. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +13 -13
  566. data/lib/purecloudplatformclientv2/models/whats_app_integration.rb +562 -0
  567. data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +428 -0
  568. data/lib/purecloudplatformclientv2/models/whats_app_integration_update_request.rb +365 -0
  569. data/lib/purecloudplatformclientv2/models/widget_deployment.rb +1 -1
  570. data/lib/purecloudplatformclientv2/models/workspace.rb +1 -1
  571. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +13 -13
  572. data/lib/purecloudplatformclientv2/models/workspace_member.rb +2 -2
  573. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +13 -13
  574. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +13 -13
  575. data/lib/purecloudplatformclientv2/version.rb +1 -1
  576. metadata +20 -4
@@ -8,7 +8,7 @@ title: SecureSession
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **flow** | [**UriReference**](UriReference.html) | The flow to execute securely | |
11
+ | **flow** | [**DomainEntityRef**](DomainEntityRef.html) | The flow to execute securely | |
12
12
  | **user_data** | **String** | Customer-provided data | [optional] |
13
13
  | **state** | **String** | The current state of a secure session | |
14
14
  | **source_participant_id** | **String** | Unique identifier for the participant initiating the secure session. | [optional] |
@@ -13,9 +13,9 @@ title: SecurityProfileEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,7 +14,7 @@ title: SequenceSchedule
14
14
  | **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
15
15
  | **intervals** | [**Array<ScheduleInterval>**](ScheduleInterval.html) | A list of intervals during which to run the associated CampaignSequence. | |
16
16
  | **time_zone** | **String** | The time zone for this SequenceSchedule. For example, Africa/Abidjan. | |
17
- | **sequence** | [**UriReference**](UriReference.html) | The CampaignSequence that this SequenceSchedule is for. | |
17
+ | **sequence** | [**DomainEntityRef**](DomainEntityRef.html) | The CampaignSequence that this SequenceSchedule is for. | |
18
18
  | **self_uri** | **String** | The URI for this object | [optional] |
19
19
  {: class="table table-striped"}
20
20
 
@@ -10,11 +10,11 @@ title: Share
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **shared_entity_type** | **String** | | [optional] |
13
- | **shared_entity** | [**UriReference**](UriReference.html) | | [optional] |
13
+ | **shared_entity** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
14
14
  | **member_type** | **String** | | [optional] |
15
- | **member** | [**UriReference**](UriReference.html) | | [optional] |
16
- | **shared_by** | [**UriReference**](UriReference.html) | | [optional] |
17
- | **workspace** | [**UriReference**](UriReference.html) | | [optional] |
15
+ | **member** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
16
+ | **shared_by** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
17
+ | **workspace** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
18
18
  | **user** | [**User**](User.html) | | [optional] |
19
19
  | **group** | [**Group**](Group.html) | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
@@ -13,9 +13,9 @@ title: ShareEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -18,8 +18,8 @@ title: Site
18
18
  | **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
19
19
  | **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
20
20
  | **created_by_app** | **String** | The application that created the resource. | [optional] |
21
- | **primary_sites** | [**Array<UriReference>**](UriReference.html) | | [optional] |
22
- | **secondary_sites** | [**Array<UriReference>**](UriReference.html) | | [optional] |
21
+ | **primary_sites** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | | [optional] |
22
+ | **secondary_sites** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | | [optional] |
23
23
  | **primary_edges** | [**Array<Edge>**](Edge.html) | | [optional] |
24
24
  | **secondary_edges** | [**Array<Edge>**](Edge.html) | | [optional] |
25
25
  | **addresses** | [**Array<Contact>**](Contact.html) | | [optional] |
@@ -13,9 +13,9 @@ title: SiteEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: SkillEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: SmsAddressEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: SmsPhoneNumberEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -0,0 +1,80 @@
1
+ ---
2
+ title: SpeechTextAnalyticsApi
3
+ ---
4
+
5
+ ## PureCloud::SpeechTextAnalyticsApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | Description
10
+ ------------- | ------------- | -------------
11
+ [**get_conversation_transcriptproperty**](SpeechTextAnalyticsApi.html#get_conversation_transcriptproperty) | Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
12
+ {: class="table table-striped"}
13
+
14
+ <a name="get_conversation_transcriptproperty"></a>
15
+
16
+ ## [**TranscriptProperty**](TranscriptProperty.html) get_conversation_transcriptproperty(conversation_id, communication_id)
17
+
18
+
19
+
20
+ Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
21
+
22
+
23
+
24
+ Wraps GET /api/v2/conversations/{conversationId}/transcriptproperties/{communicationId}
25
+
26
+ Requires NO permissions:
27
+
28
+
29
+
30
+ ### Example
31
+ ```{"language":"ruby"}
32
+ # load the gem
33
+ require 'purecloudplatformclientv2'
34
+ # setup authorization
35
+ @secret = ENV['PURECLOUD_SECRET']
36
+ @id = ENV['PURECLOUD_CLIENT_ID']
37
+ environment = "mypurecloud.com"
38
+
39
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
40
+
41
+ PureCloud.configure do |config|
42
+ config.access_token = @authToken
43
+ end
44
+
45
+ api_instance = PureCloud::SpeechTextAnalyticsApi.new
46
+
47
+ conversation_id = "conversation_id_example" # String | Conversation ID
48
+
49
+ communication_id = "communication_id_example" # String | Communication ID
50
+
51
+
52
+ begin
53
+ #Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
54
+ result = api_instance.get_conversation_transcriptproperty(conversation_id, communication_id)
55
+ p result
56
+ rescue PureCloud::ApiError => e
57
+ puts "Exception when calling SpeechTextAnalyticsApi->get_conversation_transcriptproperty: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ Name | Type | Description | Notes
64
+ ------------- | ------------- | ------------- | -------------
65
+ **conversation_id** | **String**| Conversation ID | |
66
+ **communication_id** | **String**| Communication ID | |
67
+ {: class="table table-striped"}
68
+
69
+
70
+ ### Return type
71
+
72
+ [**TranscriptProperty**](TranscriptProperty.html)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: application/json
77
+ - **Accept**: application/json
78
+
79
+
80
+
@@ -13,8 +13,8 @@ title: Station
13
13
  | **status** | **String** | | [optional] |
14
14
  | **user_id** | **String** | The Id of the user currently logged in and associated with the station. | [optional] |
15
15
  | **web_rtc_user_id** | **String** | The Id of the user configured for the station if it is of type inin_webrtc_softphone. Empty if station type is not inin_webrtc_softphone. | [optional] |
16
- | **primary_edge** | [**UriReference**](UriReference.html) | | [optional] |
17
- | **secondary_edge** | [**UriReference**](UriReference.html) | | [optional] |
16
+ | **primary_edge** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
17
+ | **secondary_edge** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
18
18
  | **type** | **String** | | [optional] |
19
19
  | **line_appearance_id** | **String** | | [optional] |
20
20
  | **web_rtc_media_dscp** | **Integer** | The default or configured value of media dscp for the station. Empty if station type is not inin_webrtc_softphone. | [optional] |
@@ -13,9 +13,9 @@ title: StationEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: SubjectDivisionGrantsEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -68,7 +68,7 @@ end
68
68
  Name | Type | Description | Notes
69
69
  ------------- | ------------- | ------------- | -------------
70
70
  **q64** | **String**| q64 | |
71
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
71
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, authorization.unusedRoles, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
72
72
  **profile** | **BOOLEAN**| profile | [optional] [default to true] |
73
73
  {: class="table table-striped"}
74
74
 
@@ -138,7 +138,7 @@ end
138
138
  Name | Type | Description | Notes
139
139
  ------------- | ------------- | ------------- | -------------
140
140
  **q64** | **String**| q64 | |
141
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
141
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, authorization.unusedRoles, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
142
142
  **profile** | **BOOLEAN**| profile | [optional] [default to true] |
143
143
  {: class="table table-striped"}
144
144
 
@@ -11,7 +11,7 @@ title: Survey
11
11
  | **name** | **String** | | [optional] |
12
12
  | **conversation** | [**Conversation**](Conversation.html) | | [optional] |
13
13
  | **survey_form** | [**SurveyForm**](SurveyForm.html) | Survey form used for this survey. | [optional] |
14
- | **agent** | [**UriReference**](UriReference.html) | | [optional] |
14
+ | **agent** | [**DomainEntityRef**](DomainEntityRef.html) | | [optional] |
15
15
  | **status** | **String** | | [optional] |
16
16
  | **queue** | [**QueueReference**](QueueReference.html) | | [optional] |
17
17
  | **answers** | [**SurveyScoringSet**](SurveyScoringSet.html) | | [optional] |
@@ -8,7 +8,7 @@ title: SurveyAssignment
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **survey_form** | [**PublishedSurveyFormReference**](PublishedSurveyFormReference.html) | The survey form used for this survey. | [optional] |
11
- | **flow** | [**UriReference**](UriReference.html) | The URI reference to the flow associated with this survey. | [optional] |
11
+ | **flow** | [**DomainEntityRef**](DomainEntityRef.html) | The URI reference to the flow associated with this survey. | [optional] |
12
12
  | **invite_time_interval** | **String** | An ISO 8601 repeated interval consisting of the number of repetitions, the start datetime, and the interval (e.g. R2/2018-03-01T13:00:00Z/P1M10DT2H30M). Total duration must not exceed 90 days. | [optional] |
13
13
  | **sending_user** | **String** | User together with sendingDomain used to send email, null to use no-reply | [optional] |
14
14
  | **sending_domain** | **String** | Validated email domain, required | |
@@ -13,9 +13,9 @@ title: SurveyFormEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: SystemPromptAssetEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: SystemPromptEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: TagValueEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: TextMessageListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: TimeZoneEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -7,7 +7,7 @@ title: TimeZoneMappingPreview
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **contact_list** | [**UriReference**](UriReference.html) | The associated ContactList | [optional] |
10
+ | **contact_list** | [**DomainEntityRef**](DomainEntityRef.html) | The associated ContactList | [optional] |
11
11
  | **contacts_per_time_zone** | **Hash&lt;String, Integer&gt;** | The number of contacts per time zone that mapped to only that time zone | [optional] |
12
12
  | **contacts_mapped_using_zip_code** | **Hash&lt;String, Integer&gt;** | The number of contacts per time zone that mapped to only that time zone and were mapped using the zip code column | [optional] |
13
13
  | **contacts_mapped_to_a_single_zone** | **Integer** | The total number of contacts that mapped to a single time zone | [optional] |
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: TranscriptProperty
3
+ ---
4
+ ## PureCloud::TranscriptProperty
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **url** | **String** | The pre-signed S3 URL of the transcript | [optional] |
11
+ | **conversation** | [**AddressableEntityRef**](AddressableEntityRef.html) | The conversation reference | [optional] |
12
+ | **communication_id** | **String** | The communication ID | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -19,13 +19,13 @@ title: Trunk
19
19
  | **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
20
20
  | **created_by_app** | **String** | The application that created the resource. | [optional] |
21
21
  | **trunk_type** | **String** | The type of this trunk. | [optional] |
22
- | **edge** | [**UriReference**](UriReference.html) | The Edge using this trunk. | [optional] |
23
- | **trunk_base** | [**UriReference**](UriReference.html) | The trunk base configuration used on this trunk. | [optional] |
24
- | **trunk_metabase** | [**UriReference**](UriReference.html) | The metabase used to create this trunk. | [optional] |
25
- | **edge_group** | [**UriReference**](UriReference.html) | The edge group associated with this trunk. | [optional] |
22
+ | **edge** | [**DomainEntityRef**](DomainEntityRef.html) | The Edge using this trunk. | [optional] |
23
+ | **trunk_base** | [**DomainEntityRef**](DomainEntityRef.html) | The trunk base configuration used on this trunk. | [optional] |
24
+ | **trunk_metabase** | [**DomainEntityRef**](DomainEntityRef.html) | The metabase used to create this trunk. | [optional] |
25
+ | **edge_group** | [**DomainEntityRef**](DomainEntityRef.html) | The edge group associated with this trunk. | [optional] |
26
26
  | **in_service** | **BOOLEAN** | True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base. | [optional] |
27
27
  | **enabled** | **BOOLEAN** | True if the Edge used by this trunk is in-service | [optional] |
28
- | **logical_interface** | [**UriReference**](UriReference.html) | The Logical Interface on the Edge to which the trunk is assigned. | [optional] |
28
+ | **logical_interface** | [**DomainEntityRef**](DomainEntityRef.html) | The Logical Interface on the Edge to which the trunk is assigned. | [optional] |
29
29
  | **connected_status** | [**TrunkConnectedStatus**](TrunkConnectedStatus.html) | The connected status of the trunk | [optional] |
30
30
  | **options_status** | [**Array&lt;TrunkMetricsOptions&gt;**](TrunkMetricsOptions.html) | The trunk optionsStatus | [optional] |
31
31
  | **registers_status** | [**Array&lt;TrunkMetricsRegisters&gt;**](TrunkMetricsRegisters.html) | The trunk registersStatus | [optional] |
@@ -18,7 +18,7 @@ title: TrunkBase
18
18
  | **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
19
19
  | **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
20
20
  | **created_by_app** | **String** | The application that created the resource. | [optional] |
21
- | **trunk_metabase** | [**UriReference**](UriReference.html) | The meta-base this trunk is based on. | |
21
+ | **trunk_metabase** | [**DomainEntityRef**](DomainEntityRef.html) | The meta-base this trunk is based on. | |
22
22
  | **properties** | **Hash&lt;String, Object&gt;** | | [optional] |
23
23
  | **trunk_type** | **String** | The type of this trunk base. | |
24
24
  | **managed** | **BOOLEAN** | Is this trunk being managed remotely. This property is synchronized with the managed property of the Edge Group to which it is assigned. | [optional] |
@@ -13,9 +13,9 @@ title: TrunkBaseEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: TrunkEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: TrunkMetabaseEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21