purecloudplatformclientv2 53.0.0 → 54.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 (425) 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/AttemptLimitsEntityListing.md +2 -2
  6. data/docs/AuthzDivisionEntityListing.md +2 -2
  7. data/docs/CalibrationEntityListing.md +2 -2
  8. data/docs/CallConversationEntityListing.md +2 -2
  9. data/docs/CallHistoryConversationEntityListing.md +2 -2
  10. data/docs/CallableTimeSetEntityListing.md +2 -2
  11. data/docs/CallbackConversationEntityListing.md +2 -2
  12. data/docs/CampaignDivisionViewListing.md +2 -2
  13. data/docs/CampaignEntityListing.md +2 -2
  14. data/docs/CampaignRuleEntityListing.md +2 -2
  15. data/docs/CampaignSequenceEntityListing.md +2 -2
  16. data/docs/CertificateAuthorityEntityListing.md +2 -2
  17. data/docs/ChatConversationEntityListing.md +2 -2
  18. data/docs/ClientAppEntityListing.md +2 -2
  19. data/docs/CobrowseConversationEntityListing.md +2 -2
  20. data/docs/CommandStatusEntityListing.md +2 -2
  21. data/docs/ConsumedResourcesEntityListing.md +2 -2
  22. data/docs/ConsumingResourcesEntityListing.md +2 -2
  23. data/docs/ContactListDivisionViewListing.md +2 -2
  24. data/docs/ContactListEntityListing.md +2 -2
  25. data/docs/ContactListFilterEntityListing.md +2 -2
  26. data/docs/ContactListing.md +2 -2
  27. data/docs/ConversationEntityListing.md +2 -2
  28. data/docs/CredentialInfoListing.md +2 -2
  29. data/docs/CredentialTypeListing.md +2 -2
  30. data/docs/DIDEntityListing.md +2 -2
  31. data/docs/DIDPoolEntityListing.md +2 -2
  32. data/docs/DataTableRowEntityListing.md +2 -2
  33. data/docs/DataTablesDomainEntityListing.md +2 -2
  34. data/docs/DependencyObjectEntityListing.md +2 -2
  35. data/docs/DependencyTypeEntityListing.md +2 -2
  36. data/docs/DialerEventEntityListing.md +2 -2
  37. data/docs/DirectoryUserDevicesListing.md +2 -2
  38. data/docs/DncListDivisionViewListing.md +2 -2
  39. data/docs/DncListEntityListing.md +2 -2
  40. data/docs/DocumentAuditEntityListing.md +2 -2
  41. data/docs/DocumentEntityListing.md +2 -2
  42. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
  43. data/docs/DomainEntityListing.md +2 -2
  44. data/docs/DomainEntityListingEvaluationForm.md +2 -2
  45. data/docs/DomainEntityListingQueryResult.md +2 -2
  46. data/docs/DomainEntityListingSurveyForm.md +2 -2
  47. data/docs/EdgeEntityListing.md +2 -2
  48. data/docs/EdgeGroupEntityListing.md +2 -2
  49. data/docs/EdgeLineEntityListing.md +2 -2
  50. data/docs/EmailConversationEntityListing.md +2 -2
  51. data/docs/EmailMessageListing.md +2 -2
  52. data/docs/EmergencyGroupListing.md +2 -2
  53. data/docs/EncryptionKeyEntityListing.md +2 -2
  54. data/docs/EvaluationEntityListing.md +2 -2
  55. data/docs/EvaluationFormEntityListing.md +2 -2
  56. data/docs/EvaluatorActivityEntityListing.md +2 -2
  57. data/docs/ExtensionEntityListing.md +2 -2
  58. data/docs/ExtensionPoolEntityListing.md +2 -2
  59. data/docs/ExternalOrganizationListing.md +2 -2
  60. data/docs/FacebookIntegrationEntityListing.md +2 -2
  61. data/docs/FaxDocumentEntityListing.md +2 -2
  62. data/docs/FlowDivisionViewEntityListing.md +2 -2
  63. data/docs/FlowEntityListing.md +2 -2
  64. data/docs/FlowVersionEntityListing.md +2 -2
  65. data/docs/GDPRRequestEntityListing.md +2 -2
  66. data/docs/GDPRSubjectEntityListing.md +2 -2
  67. data/docs/GreetingListing.md +2 -2
  68. data/docs/GroupEntityListing.md +2 -2
  69. data/docs/GroupProfileEntityListing.md +2 -2
  70. data/docs/IVREntityListing.md +2 -2
  71. data/docs/InboundDomainEntityListing.md +2 -2
  72. data/docs/InboundRouteEntityListing.md +2 -2
  73. data/docs/IntegrationEntityListing.md +2 -2
  74. data/docs/IntegrationEventEntityListing.md +2 -2
  75. data/docs/IntegrationTypeEntityListing.md +2 -2
  76. data/docs/InteractionStatsAlertContainer.md +2 -2
  77. data/docs/InteractionStatsRuleContainer.md +2 -2
  78. data/docs/KeywordSetEntityListing.md +2 -2
  79. data/docs/LanguageEntityListing.md +2 -2
  80. data/docs/LibraryEntityListing.md +2 -2
  81. data/docs/LineBaseEntityListing.md +2 -2
  82. data/docs/LineEntityListing.md +2 -2
  83. data/docs/LineIntegrationEntityListing.md +2 -2
  84. data/docs/LocationEntityListing.md +2 -2
  85. data/docs/LocationsApi.md +1 -2
  86. data/docs/LogicalInterfaceEntityListing.md +2 -2
  87. data/docs/ManagementUnitListing.md +2 -2
  88. data/docs/MessageConversationEntityListing.md +2 -2
  89. data/docs/MessagingStickerEntityListing.md +2 -2
  90. data/docs/NoteListing.md +2 -2
  91. data/docs/OAuthClientEntityListing.md +2 -2
  92. data/docs/OAuthProviderEntityListing.md +2 -2
  93. data/docs/OrganizationPresenceEntityListing.md +2 -2
  94. data/docs/OrganizationRoleEntityListing.md +2 -2
  95. data/docs/OrphanRecordingListing.md +2 -2
  96. data/docs/OutboundRouteBaseEntityListing.md +2 -2
  97. data/docs/OutboundRouteEntityListing.md +2 -2
  98. data/docs/PermissionCollectionEntityListing.md +2 -2
  99. data/docs/PhoneBaseEntityListing.md +2 -2
  100. data/docs/PhoneEntityListing.md +2 -2
  101. data/docs/PhoneMetaBaseEntityListing.md +2 -2
  102. data/docs/PhysicalInterfaceEntityListing.md +2 -2
  103. data/docs/PolicyEntityListing.md +2 -2
  104. data/docs/PromptAssetEntityListing.md +2 -2
  105. data/docs/PromptEntityListing.md +2 -2
  106. data/docs/QualityAuditPage.md +2 -2
  107. data/docs/QueueEntityListing.md +2 -2
  108. data/docs/QueueMemberEntityListing.md +2 -2
  109. data/docs/RecipientListing.md +2 -2
  110. data/docs/RelationshipListing.md +2 -2
  111. data/docs/ReportMetaDataEntityListing.md +2 -2
  112. data/docs/ReportRunEntryEntityDomainListing.md +2 -2
  113. data/docs/ReportScheduleEntityListing.md +2 -2
  114. data/docs/ReportingExportJobListing.md +2 -2
  115. data/docs/ResponseEntityList.md +2 -2
  116. data/docs/ResponseEntityListing.md +2 -2
  117. data/docs/ResponseSetEntityListing.md +2 -2
  118. data/docs/RuleSetEntityListing.md +2 -2
  119. data/docs/ScheduleEntityListing.md +2 -2
  120. data/docs/ScheduleGroupEntityListing.md +2 -2
  121. data/docs/SchemaCategoryEntityListing.md +2 -2
  122. data/docs/SchemaReferenceEntityListing.md +2 -2
  123. data/docs/ScreenRecordingSessionListing.md +2 -2
  124. data/docs/ScriptEntityListing.md +2 -2
  125. data/docs/SecurityProfileEntityListing.md +2 -2
  126. data/docs/ShareEntityListing.md +2 -2
  127. data/docs/ShiftTradeResponse.md +1 -1
  128. data/docs/SiteEntityListing.md +2 -2
  129. data/docs/SkillEntityListing.md +2 -2
  130. data/docs/SmsPhoneNumberEntityListing.md +2 -2
  131. data/docs/StationEntityListing.md +2 -2
  132. data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
  133. data/docs/SurveyFormEntityListing.md +2 -2
  134. data/docs/SystemPromptAssetEntityListing.md +2 -2
  135. data/docs/SystemPromptEntityListing.md +2 -2
  136. data/docs/TagValueEntityListing.md +2 -2
  137. data/docs/TextMessageListing.md +2 -2
  138. data/docs/TimeZoneEntityListing.md +2 -2
  139. data/docs/TrunkBaseEntityListing.md +2 -2
  140. data/docs/TrunkEntityListing.md +2 -2
  141. data/docs/TrunkMetabaseEntityListing.md +2 -2
  142. data/docs/TrustEntityListing.md +2 -2
  143. data/docs/TrustUserEntityListing.md +2 -2
  144. data/docs/TrustorEntityListing.md +2 -2
  145. data/docs/TwitterIntegrationEntityListing.md +2 -2
  146. data/docs/UserActionCategoryEntityListing.md +2 -2
  147. data/docs/UserEntityListing.md +2 -2
  148. data/docs/UserLanguageEntityListing.md +2 -2
  149. data/docs/UserProfileEntityListing.md +2 -2
  150. data/docs/UserQueueEntityListing.md +2 -2
  151. data/docs/UserRecordingEntityListing.md +2 -2
  152. data/docs/UserSkillEntityListing.md +2 -2
  153. data/docs/VoicemailMessageEntityListing.md +2 -2
  154. data/docs/WfmAgent.md +4 -4
  155. data/docs/WorkforceManagementApi.md +0 -652
  156. data/docs/WorkspaceEntityListing.md +2 -2
  157. data/docs/WorkspaceMemberEntityListing.md +2 -2
  158. data/docs/WrapupCodeEntityListing.md +2 -2
  159. data/lib/purecloudplatformclientv2.rb +0 -54
  160. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +53 -751
  161. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  162. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +13 -13
  163. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +13 -13
  164. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +13 -13
  165. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +13 -13
  166. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +13 -13
  167. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +13 -13
  168. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +13 -13
  169. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +13 -13
  170. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +13 -13
  171. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +13 -13
  172. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +13 -13
  173. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +13 -13
  174. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +13 -13
  175. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +13 -13
  176. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +13 -13
  177. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +13 -13
  178. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +13 -13
  179. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +13 -13
  180. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +13 -13
  181. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +13 -13
  182. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +13 -13
  183. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +13 -13
  184. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +13 -13
  185. data/lib/purecloudplatformclientv2/models/contact_listing.rb +13 -13
  186. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +13 -13
  187. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +13 -13
  188. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +13 -13
  189. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +13 -13
  190. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +13 -13
  191. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +13 -13
  192. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +13 -13
  193. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +13 -13
  194. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +13 -13
  195. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +13 -13
  196. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +13 -13
  197. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +13 -13
  198. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +13 -13
  199. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +13 -13
  200. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +13 -13
  201. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +13 -13
  202. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +13 -13
  203. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +13 -13
  204. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +13 -13
  205. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +13 -13
  206. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +13 -13
  207. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +13 -13
  208. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +13 -13
  209. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +13 -13
  210. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +13 -13
  211. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +13 -13
  212. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +13 -13
  213. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +13 -13
  214. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +13 -13
  215. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +13 -13
  216. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +13 -13
  217. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +13 -13
  218. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +13 -13
  219. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +13 -13
  220. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +13 -13
  221. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +13 -13
  222. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +13 -13
  223. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +13 -13
  224. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +13 -13
  225. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +13 -13
  226. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +13 -13
  227. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +13 -13
  228. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +13 -13
  229. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +13 -13
  230. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +13 -13
  231. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +13 -13
  232. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +13 -13
  233. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +13 -13
  234. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +13 -13
  235. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +13 -13
  236. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +13 -13
  237. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +13 -13
  238. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +13 -13
  239. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +13 -13
  240. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +13 -13
  241. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +13 -13
  242. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +13 -13
  243. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +13 -13
  244. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +13 -13
  245. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +13 -13
  246. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +13 -13
  247. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +13 -13
  248. data/lib/purecloudplatformclientv2/models/note_listing.rb +13 -13
  249. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +13 -13
  250. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +13 -13
  251. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +13 -13
  252. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +13 -13
  253. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +13 -13
  254. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +13 -13
  255. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +13 -13
  256. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +13 -13
  257. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +13 -13
  258. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +13 -13
  259. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +13 -13
  260. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +13 -13
  261. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +13 -13
  262. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +13 -13
  263. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +13 -13
  264. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +13 -13
  265. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +13 -13
  266. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +13 -13
  267. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +13 -13
  268. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +13 -13
  269. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +13 -13
  270. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +13 -13
  271. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +13 -13
  272. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +13 -13
  273. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +13 -13
  274. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +13 -13
  275. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +13 -13
  276. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +13 -13
  277. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +13 -13
  278. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +13 -13
  279. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +13 -13
  280. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +13 -13
  281. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +13 -13
  282. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +13 -13
  283. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +13 -13
  284. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +13 -13
  285. data/lib/purecloudplatformclientv2/models/shift_trade_response.rb +1 -1
  286. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +13 -13
  287. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +13 -13
  288. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +13 -13
  289. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +13 -13
  290. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +13 -13
  291. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +13 -13
  292. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +13 -13
  293. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +13 -13
  294. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +13 -13
  295. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +13 -13
  296. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +13 -13
  297. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +13 -13
  298. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +13 -13
  299. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +13 -13
  300. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +13 -13
  301. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +13 -13
  302. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +13 -13
  303. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +13 -13
  304. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +13 -13
  305. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +13 -13
  306. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +13 -13
  307. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +13 -13
  308. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +13 -13
  309. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +13 -13
  310. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +13 -13
  311. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +13 -13
  312. data/lib/purecloudplatformclientv2/models/wfm_agent.rb +55 -55
  313. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +13 -13
  314. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +13 -13
  315. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +13 -13
  316. data/lib/purecloudplatformclientv2/version.rb +1 -1
  317. metadata +2 -110
  318. data/docs/ActionMap.md +0 -30
  319. data/docs/ActionMapAction.md +0 -16
  320. data/docs/ActionProperties.md +0 -14
  321. data/docs/ActionSurvey.md +0 -13
  322. data/docs/ActionTarget.md +0 -15
  323. data/docs/Activation.md +0 -14
  324. data/docs/AddShiftTradeRequest.md +0 -17
  325. data/docs/Browser.md +0 -23
  326. data/docs/Context.md +0 -13
  327. data/docs/ContextPattern.md +0 -13
  328. data/docs/Criteria.md +0 -16
  329. data/docs/Cursors.md +0 -14
  330. data/docs/CustomEventAttribute.md +0 -14
  331. data/docs/Device.md +0 -20
  332. data/docs/EntityTypeCriteria.md +0 -17
  333. data/docs/Event.md +0 -24
  334. data/docs/EventAction.md +0 -17
  335. data/docs/EventCondition.md +0 -15
  336. data/docs/EventListing.md +0 -16
  337. data/docs/GenericActionEvent.md +0 -16
  338. data/docs/GenericEventAction.md +0 -18
  339. data/docs/Journey.md +0 -13
  340. data/docs/JourneyApi.md +0 -85
  341. data/docs/JourneyCampaign.md +0 -19
  342. data/docs/JourneyGeolocation.md +0 -22
  343. data/docs/JourneyPage.md +0 -22
  344. data/docs/JourneyPattern.md +0 -14
  345. data/docs/JourneySegment.md +0 -25
  346. data/docs/JourneySurveyQuestion.md +0 -17
  347. data/docs/MatchShiftTradeRequest.md +0 -15
  348. data/docs/MatchShiftTradeResponse.md +0 -15
  349. data/docs/Outcome.md +0 -24
  350. data/docs/OutcomeAchievedEvent.md +0 -22
  351. data/docs/OutcomeProbabilityCondition.md +0 -15
  352. data/docs/Referrer.md +0 -21
  353. data/docs/SearchShiftTradeResponse.md +0 -15
  354. data/docs/SearchShiftTradesRequest.md +0 -14
  355. data/docs/SearchShiftTradesResponse.md +0 -13
  356. data/docs/SegmentAssignedEvent.md +0 -22
  357. data/docs/Session.md +0 -15
  358. data/docs/ShiftTradeActivityPreviewResponse.md +0 -16
  359. data/docs/ShiftTradeMatchReviewResponse.md +0 -16
  360. data/docs/ShiftTradeMatchReviewUserResponse.md +0 -17
  361. data/docs/ShiftTradeMatchViolation.md +0 -14
  362. data/docs/ShiftTradePreviewResponse.md +0 -13
  363. data/docs/ShiftTradeResponseAcceptableIntervals.md +0 -14
  364. data/docs/UpdateAgentRequest.md +0 -13
  365. data/docs/UpdateShiftTradeRequest.md +0 -16
  366. data/docs/UpdateShiftTradeStateRequest.md +0 -14
  367. data/docs/UrlCondition.md +0 -14
  368. data/docs/WebActionEvent.md +0 -26
  369. data/docs/WebEvent.md +0 -25
  370. data/docs/WeekShiftTradeListResponse.md +0 -13
  371. data/docs/WeekShiftTradeResponse.md +0 -14
  372. data/lib/purecloudplatformclientv2/api/journey_api.rb +0 -119
  373. data/lib/purecloudplatformclientv2/models/action_map.rb +0 -666
  374. data/lib/purecloudplatformclientv2/models/action_map_action.rb +0 -299
  375. data/lib/purecloudplatformclientv2/models/action_properties.rb +0 -228
  376. data/lib/purecloudplatformclientv2/models/action_survey.rb +0 -209
  377. data/lib/purecloudplatformclientv2/models/action_target.rb +0 -253
  378. data/lib/purecloudplatformclientv2/models/activation.rb +0 -233
  379. data/lib/purecloudplatformclientv2/models/add_shift_trade_request.rb +0 -317
  380. data/lib/purecloudplatformclientv2/models/browser.rb +0 -472
  381. data/lib/purecloudplatformclientv2/models/context.rb +0 -209
  382. data/lib/purecloudplatformclientv2/models/context_pattern.rb +0 -209
  383. data/lib/purecloudplatformclientv2/models/criteria.rb +0 -311
  384. data/lib/purecloudplatformclientv2/models/cursors.rb +0 -226
  385. data/lib/purecloudplatformclientv2/models/custom_event_attribute.rb +0 -228
  386. data/lib/purecloudplatformclientv2/models/device.rb +0 -418
  387. data/lib/purecloudplatformclientv2/models/entity_type_criteria.rb +0 -351
  388. data/lib/purecloudplatformclientv2/models/event.rb +0 -503
  389. data/lib/purecloudplatformclientv2/models/event_action.rb +0 -339
  390. data/lib/purecloudplatformclientv2/models/event_condition.rb +0 -280
  391. data/lib/purecloudplatformclientv2/models/event_listing.rb +0 -278
  392. data/lib/purecloudplatformclientv2/models/generic_action_event.rb +0 -285
  393. data/lib/purecloudplatformclientv2/models/generic_event_action.rb +0 -365
  394. data/lib/purecloudplatformclientv2/models/journey.rb +0 -209
  395. data/lib/purecloudplatformclientv2/models/journey_campaign.rb +0 -358
  396. data/lib/purecloudplatformclientv2/models/journey_geolocation.rb +0 -436
  397. data/lib/purecloudplatformclientv2/models/journey_page.rb +0 -458
  398. data/lib/purecloudplatformclientv2/models/journey_pattern.rb +0 -235
  399. data/lib/purecloudplatformclientv2/models/journey_segment.rb +0 -518
  400. data/lib/purecloudplatformclientv2/models/journey_survey_question.rb +0 -341
  401. data/lib/purecloudplatformclientv2/models/match_shift_trade_request.rb +0 -264
  402. data/lib/purecloudplatformclientv2/models/match_shift_trade_response.rb +0 -258
  403. data/lib/purecloudplatformclientv2/models/outcome.rb +0 -492
  404. data/lib/purecloudplatformclientv2/models/outcome_achieved_event.rb +0 -441
  405. data/lib/purecloudplatformclientv2/models/outcome_probability_condition.rb +0 -264
  406. data/lib/purecloudplatformclientv2/models/referrer.rb +0 -444
  407. data/lib/purecloudplatformclientv2/models/search_shift_trade_response.rb +0 -256
  408. data/lib/purecloudplatformclientv2/models/search_shift_trades_request.rb +0 -235
  409. data/lib/purecloudplatformclientv2/models/search_shift_trades_response.rb +0 -204
  410. data/lib/purecloudplatformclientv2/models/segment_assigned_event.rb +0 -441
  411. data/lib/purecloudplatformclientv2/models/session.rb +0 -253
  412. data/lib/purecloudplatformclientv2/models/shift_trade_activity_preview_response.rb +0 -280
  413. data/lib/purecloudplatformclientv2/models/shift_trade_match_review_response.rb +0 -284
  414. data/lib/purecloudplatformclientv2/models/shift_trade_match_review_user_response.rb +0 -306
  415. data/lib/purecloudplatformclientv2/models/shift_trade_match_violation.rb +0 -244
  416. data/lib/purecloudplatformclientv2/models/shift_trade_preview_response.rb +0 -204
  417. data/lib/purecloudplatformclientv2/models/shift_trade_response_acceptable_intervals.rb +0 -228
  418. data/lib/purecloudplatformclientv2/models/update_agent_request.rb +0 -202
  419. data/lib/purecloudplatformclientv2/models/update_shift_trade_request.rb +0 -286
  420. data/lib/purecloudplatformclientv2/models/update_shift_trade_state_request.rb +0 -252
  421. data/lib/purecloudplatformclientv2/models/url_condition.rb +0 -254
  422. data/lib/purecloudplatformclientv2/models/web_action_event.rb +0 -545
  423. data/lib/purecloudplatformclientv2/models/web_event.rb +0 -521
  424. data/lib/purecloudplatformclientv2/models/week_shift_trade_list_response.rb +0 -203
  425. data/lib/purecloudplatformclientv2/models/week_shift_trade_response.rb +0 -228
data/docs/ActionMap.md DELETED
@@ -1,30 +0,0 @@
1
- ---
2
- title: ActionMap
3
- ---
4
- ## PureCloud::ActionMap
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
12
- | **version** | **Integer** | The version of the action map. | [optional] |
13
- | **is_active** | **BOOLEAN** | Whether the action map is active. | [optional] |
14
- | **display_name** | **String** | Display name of the action map. | |
15
- | **trigger_with_segments** | **Array<String>** | Trigger action map if any segment in the list is assigned to a given customer. | |
16
- | **trigger_with_event_conditions** | [**Array<EventCondition>**](EventCondition.html) | List of event conditions that must be satisfied to trigger the action map. | [optional] |
17
- | **trigger_with_outcome_probability_conditions** | [**Array<OutcomeProbabilityCondition>**](OutcomeProbabilityCondition.html) | Probability conditions for outcomes that must be satisfied to trigger the action map. | [optional] |
18
- | **page_url_conditions** | [**Array<UrlCondition>**](UrlCondition.html) | URL conditions that a page must match for web actions to be displayable. | |
19
- | **activation** | [**Activation**](Activation.html) | Type of activation. | [optional] |
20
- | **weight** | **Integer** | Weight of the action map with higher number denoting higher weight. | [optional] |
21
- | **action** | [**ActionMapAction**](ActionMapAction.html) | The action that will be executed if this action map is triggered. | [optional] |
22
- | **estimated_wait_time_limit** | **Integer** | The estimated wait time limit above which actions will not be offered. | [optional] |
23
- | **self_uri** | **String** | The URI for this object | [optional] |
24
- | **created_date** | **DateTime** | Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
25
- | **modified_date** | **DateTime** | Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
26
- | **start_date** | **DateTime** | Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
27
- | **end_date** | **DateTime** | Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
28
- {: class="table table-striped"}
29
-
30
-
data/docs/ActionMapAction.md DELETED
@@ -1,16 +0,0 @@
1
- ---
2
- title: ActionMapAction
3
- ---
4
- ## PureCloud::ActionMapAction
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **media_type** | **String** | Media type of action. | |
11
- | **action_target_id** | **String** | Action target ID. | [optional] |
12
- | **is_pacing_enabled** | **BOOLEAN** | Whether this action should be throttled. | [optional] |
13
- | **props** | [**ActionProperties**](ActionProperties.html) | Additional properties. | [optional] |
14
- {: class="table table-striped"}
15
-
16
-
data/docs/ActionProperties.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: ActionProperties
3
- ---
4
- ## PureCloud::ActionProperties
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **webchat_prompt** | **String** | Prompt message shown to user, used for webchat type action. | [optional] |
11
- | **webchat_survey** | [**ActionSurvey**](ActionSurvey.html) | Survey provided to the user, used for webchat type action. | [optional] |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/ActionSurvey.md DELETED
@@ -1,13 +0,0 @@
1
- ---
2
- title: ActionSurvey
3
- ---
4
- ## PureCloud::ActionSurvey
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **questions** | [**Array<JourneySurveyQuestion>**](JourneySurveyQuestion.html) | Questions shown to the user. | |
11
- {: class="table table-striped"}
12
-
13
-
data/docs/ActionTarget.md DELETED
@@ -1,15 +0,0 @@
1
- ---
2
- title: ActionTarget
3
- ---
4
- ## PureCloud::ActionTarget
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
12
- | **self_uri** | **String** | The URI for this object | [optional] |
13
- {: class="table table-striped"}
14
-
15
-
data/docs/Activation.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: Activation
3
- ---
4
- ## PureCloud::Activation
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **type** | **String** | Type of activation. | |
11
- | **delay_in_seconds** | **Integer** | Activation delay time amount. | [optional] |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/AddShiftTradeRequest.md DELETED
@@ -1,17 +0,0 @@
1
- ---
2
- title: AddShiftTradeRequest
3
- ---
4
- ## PureCloud::AddShiftTradeRequest
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **schedule_id** | **String** | The ID of the schedule to which the initiating and receiving shifts belong | |
11
- | **initiating_shift_id** | **String** | The ID of the shift that the initiating user wants to give up | |
12
- | **receiving_user_id** | **String** | The ID of the user to whom to send the request (for use in direct trade requests) | [optional] |
13
- | **expiration** | **DateTime** | When this shift trade request should expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
- | **acceptable_intervals** | [**Array<ShiftTradeResponseAcceptableIntervals>**](ShiftTradeResponseAcceptableIntervals.html) | | [optional] |
15
- {: class="table table-striped"}
16
-
17
-
data/docs/Browser.md DELETED
@@ -1,23 +0,0 @@
1
- ---
2
- title: Browser
3
- ---
4
- ## PureCloud::Browser
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **family** | **String** | Browser family (e.g. Chrome, Safari, Firefox). | |
11
- | **version** | **String** | Browser version (e.g. 68.0.3440.84). | |
12
- | **lang** | **String** | Language the browser is set to. Must conform to BCP 47. | [optional] |
13
- | **fingerprint** | **String** | Fingerprint generated by looking at the individual browser features. | [optional] |
14
- | **is_mobile** | **BOOLEAN** | Flag that is true for mobile devices. | [optional] |
15
- | **view_height** | **Integer** | Browser's viewport height. | [optional] |
16
- | **view_width** | **Integer** | Browser's viewport width. | [optional] |
17
- | **features_flash** | **BOOLEAN** | Whether Flash is installed. | [optional] |
18
- | **features_java** | **BOOLEAN** | Whether Java is installed. | [optional] |
19
- | **features_pdf** | **BOOLEAN** | Whether the browser recognizes PDFs. | [optional] |
20
- | **features_webrtc** | **BOOLEAN** | Whether WebRTC is supported. | [optional] |
21
- {: class="table table-striped"}
22
-
23
-
data/docs/Context.md DELETED
@@ -1,13 +0,0 @@
1
- ---
2
- title: Context
3
- ---
4
- ## PureCloud::Context
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **patterns** | [**Array<ContextPattern>**](ContextPattern.html) | A list of one or more patterns to match. | |
11
- {: class="table table-striped"}
12
-
13
-
data/docs/ContextPattern.md DELETED
@@ -1,13 +0,0 @@
1
- ---
2
- title: ContextPattern
3
- ---
4
- ## PureCloud::ContextPattern
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **criteria** | [**Array<EntityTypeCriteria>**](EntityTypeCriteria.html) | A list of one or more criteria to satisfy. | |
11
- {: class="table table-striped"}
12
-
13
-
data/docs/Criteria.md DELETED
@@ -1,16 +0,0 @@
1
- ---
2
- title: Criteria
3
- ---
4
- ## PureCloud::Criteria
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **key** | **String** | The criteria key. | |
11
- | **values** | **Array<String>** | The criteria values. | |
12
- | **should_ignore_case** | **BOOLEAN** | Should criteria be case insensitive. | |
13
- | **operator** | **String** | The comparison operator. | [optional] |
14
- {: class="table table-striped"}
15
-
16
-
data/docs/Cursors.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: Cursors
3
- ---
4
- ## PureCloud::Cursors
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **before** | **String** | | [optional] |
11
- | **after** | **String** | | [optional] |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/CustomEventAttribute.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: CustomEventAttribute
3
- ---
4
- ## PureCloud::CustomEventAttribute
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **data_type** | **String** | The data type of the custom attribute. | [optional] |
11
- | **value** | **String** | The value of the custom attribute. | [optional] |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/Device.md DELETED
@@ -1,20 +0,0 @@
1
- ---
2
- title: Device
3
- ---
4
- ## PureCloud::Device
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **category** | **String** | Device category. | |
11
- | **type** | **String** | Device type (e.g. iPad, iPhone, Other). | |
12
- | **is_mobile** | **BOOLEAN** | Flag that is true for mobile devices. | [optional] |
13
- | **screen_height** | **Integer** | Device's screen height. | [optional] |
14
- | **screen_width** | **Integer** | Device's screen width. | [optional] |
15
- | **fingerprint** | **String** | Fingerprint generated by looking at the individual device features. | [optional] |
16
- | **os_family** | **String** | Operating system family. | |
17
- | **os_version** | **String** | Operating system version. | |
18
- {: class="table table-striped"}
19
-
20
-
data/docs/EntityTypeCriteria.md DELETED
@@ -1,17 +0,0 @@
1
- ---
2
- title: EntityTypeCriteria
3
- ---
4
- ## PureCloud::EntityTypeCriteria
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **key** | **String** | The criteria key. | |
11
- | **values** | **Array<String>** | The criteria values. | |
12
- | **should_ignore_case** | **BOOLEAN** | Should criteria be case insensitive. | |
13
- | **operator** | **String** | The comparison operator. | [optional] |
14
- | **entity_type** | **String** | The entity to match the pattern against. | [optional] |
15
- {: class="table table-striped"}
16
-
17
-
data/docs/Event.md DELETED
@@ -1,24 +0,0 @@
1
- ---
2
- title: Event
3
- ---
4
- ## PureCloud::Event
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | System-generated UUID for the event. | [optional] |
11
- | **correlation_id** | **String** | UUID corresponding to triggering action that caused this event (e.g. HTTP POST, SIP invite, another event). | [optional] |
12
- | **customer_id** | **String** | Primary identifier of the customer in the source of the events. | |
13
- | **customer_id_type** | **String** | Type of primary identifier (e.g. cookie, email, phone, salesforce). | |
14
- | **session** | [**Session**](Session.html) | The session that the event belongs to. | [optional] |
15
- | **event_type** | **String** | The name representing the type of event. | |
16
- | **generic_action_event** | [**GenericActionEvent**](GenericActionEvent.html) | Event triggered by generic actions. | [optional] |
17
- | **outcome_achieved_event** | [**OutcomeAchievedEvent**](OutcomeAchievedEvent.html) | Event where a customer has achieved a specific outcome or goal. | [optional] |
18
- | **segment_assigned_event** | [**SegmentAssignedEvent**](SegmentAssignedEvent.html) | Event where a customer has been assigned or tagged with a specific segment. | [optional] |
19
- | **web_action_event** | [**WebActionEvent**](WebActionEvent.html) | Event triggered by web actions. | [optional] |
20
- | **web_event** | [**WebEvent**](WebEvent.html) | Event that tracks user interactions with content in a browser such as pageviews, downloads, mobile ad clicks, etc. | [optional] |
21
- | **created_date** | **DateTime** | Timestamp indicating when the event actually took place. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
22
- {: class="table table-striped"}
23
-
24
-
data/docs/EventAction.md DELETED
@@ -1,17 +0,0 @@
1
- ---
2
- title: EventAction
3
- ---
4
- ## PureCloud::EventAction
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | ID of the action. | |
11
- | **state** | **String** | Current state of the action (e.g. qualified, succeeded, errored). | [optional] |
12
- | **media_type** | **String** | The media type used to deliver the action (e.g. email, webhook). | [optional] |
13
- | **prompt** | **String** | Prompt of the action to be displayed/sent to the visitor. | [optional] |
14
- | **created_date** | **DateTime** | Timestamp indicating when the action was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
- {: class="table table-striped"}
16
-
17
-
data/docs/EventCondition.md DELETED
@@ -1,15 +0,0 @@
1
- ---
2
- title: EventCondition
3
- ---
4
- ## PureCloud::EventCondition
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **key** | **String** | The event key. | |
11
- | **values** | **Array<String>** | The event values. | |
12
- | **operator** | **String** | The comparison operator. | [optional] |
13
- {: class="table table-striped"}
14
-
15
-
data/docs/EventListing.md DELETED
@@ -1,16 +0,0 @@
1
- ---
2
- title: EventListing
3
- ---
4
- ## PureCloud::EventListing
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **entities** | [**Array<Event>**](Event.html) | | [optional] |
11
- | **next_uri** | **String** | | [optional] |
12
- | **self_uri** | **String** | | [optional] |
13
- | **previous_uri** | **String** | | [optional] |
14
- {: class="table table-striped"}
15
-
16
-
data/docs/GenericActionEvent.md DELETED
@@ -1,16 +0,0 @@
1
- ---
2
- title: GenericActionEvent
3
- ---
4
- ## PureCloud::GenericActionEvent
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **action** | [**GenericEventAction**](GenericEventAction.html) | The action that triggered the event. | |
11
- | **action_map** | [**ActionMap**](ActionMap.html) | The action map that triggered the action. | [optional] |
12
- | **error_code** | **String** | Code of the error returned when the action fails. | [optional] |
13
- | **error_message** | **String** | Message of the error returned when the action fails. | [optional] |
14
- {: class="table table-striped"}
15
-
16
-
data/docs/GenericEventAction.md DELETED
@@ -1,18 +0,0 @@
1
- ---
2
- title: GenericEventAction
3
- ---
4
- ## PureCloud::GenericEventAction
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | ID of the action. | |
11
- | **state** | **String** | Current state of the action (e.g. qualified, succeeded, errored). | [optional] |
12
- | **media_type** | **String** | The media type used to deliver the action (e.g. email, webhook). | [optional] |
13
- | **prompt** | **String** | Prompt of the action to be displayed/sent to the visitor. | [optional] |
14
- | **media_address** | **String** | Address of the media type used to deliver the action (e.g. email address, webhook URL). | [optional] |
15
- | **created_date** | **DateTime** | Timestamp indicating when the action was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
- {: class="table table-striped"}
17
-
18
-
data/docs/Journey.md DELETED
@@ -1,13 +0,0 @@
1
- ---
2
- title: Journey
3
- ---
4
- ## PureCloud::Journey
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **patterns** | [**Array<JourneyPattern>**](JourneyPattern.html) | A list of zero or more patterns to match. | |
11
- {: class="table table-striped"}
12
-
13
-
data/docs/JourneyApi.md DELETED
@@ -1,85 +0,0 @@
1
- ---
2
- title: JourneyApi
3
- ---
4
-
5
- ## PureCloud::JourneyApi
6
-
7
- All URIs are relative to *https://api.mypurecloud.com*
8
-
9
- Method | Description
10
- ------------- | ------------- | -------------
11
- [**get_journey_session_events**](JourneyApi.html#get_journey_session_events) | Retrieve all events for a given session.
12
- {: class="table table-striped"}
13
-
14
- <a name="get_journey_session_events"></a>
15
-
16
- ## [**EventListing**](EventListing.html) get_journey_session_events(session_id, opts)
17
-
18
-
19
-
20
- Retrieve all events for a given session.
21
-
22
-
23
-
24
- Wraps GET /api/v2/journey/sessions/{sessionId}/events
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::JourneyApi.new
46
-
47
- session_id = "session_id_example" # String | System-generated UUID that represents the session the event is a part of.
48
-
49
- opts = {
50
- before: "before_example", # String | The cursor that points to the start of the set of entities that has been returned.
51
- after: "after_example", # String | The cursor that points to the end of the set of entities that has been returned.
52
- limit: "limit_example" # String | Number of entities to return. Maximum of 200.
53
- }
54
-
55
- begin
56
- #Retrieve all events for a given session.
57
- result = api_instance.get_journey_session_events(session_id, opts)
58
- p result
59
- rescue PureCloud::ApiError => e
60
- puts "Exception when calling JourneyApi->get_journey_session_events: #{e}"
61
- end
62
- ```
63
-
64
- ### Parameters
65
-
66
- Name | Type | Description | Notes
67
- ------------- | ------------- | ------------- | -------------
68
- **session_id** | **String**| System-generated UUID that represents the session the event is a part of. | |
69
- **before** | **String**| The cursor that points to the start of the set of entities that has been returned. | [optional] |
70
- **after** | **String**| The cursor that points to the end of the set of entities that has been returned. | [optional] |
71
- **limit** | **String**| Number of entities to return. Maximum of 200. | [optional] |
72
- {: class="table table-striped"}
73
-
74
-
75
- ### Return type
76
-
77
- [**EventListing**](EventListing.html)
78
-
79
- ### HTTP request headers
80
-
81
- - **Content-Type**: application/json
82
- - **Accept**: application/json
83
-
84
-
85
-