purecloud 0.58.1 → 0.59.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (349) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/bin/notificationMappings.json +16 -0
  4. data/config-ruby.json +1 -1
  5. data/doc_out/AgentActivityEntityListing.html.md +2 -2
  6. data/doc_out/AnalyticsApi.html.md +57 -0
  7. data/doc_out/AnalyticsConversationSegment.html.md +2 -0
  8. data/doc_out/AnalyticsRoutingStatusRecord.html.md +16 -0
  9. data/doc_out/AnalyticsSession.html.md +8 -0
  10. data/doc_out/AnalyticsUserDetail.html.md +15 -0
  11. data/doc_out/AnalyticsUserDetailsQueryResponse.html.md +14 -0
  12. data/doc_out/AnalyticsUserPresenceRecord.html.md +17 -0
  13. data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
  14. data/doc_out/AttributeEntityListing.html.md +2 -2
  15. data/doc_out/CalibrationEntityListing.html.md +2 -2
  16. data/doc_out/CallConversationEntityListing.html.md +2 -2
  17. data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -1
  18. data/doc_out/CallConversationNotificationParticipants.html.md +1 -1
  19. data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
  20. data/doc_out/CallbackConversationEntityListing.html.md +2 -2
  21. data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -1
  22. data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -1
  23. data/doc_out/CampaignEntityListing.html.md +2 -2
  24. data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
  25. data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
  26. data/doc_out/ChannelEntityListing.html.md +2 -2
  27. data/doc_out/ChatConversationEntityListing.html.md +2 -2
  28. data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -1
  29. data/doc_out/ChatConversationNotificationParticipants.html.md +1 -1
  30. data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
  31. data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -1
  32. data/doc_out/CobrowseConversationNotificationParticipants.html.md +1 -1
  33. data/doc_out/CommandStatusEntityListing.html.md +2 -2
  34. data/doc_out/ContactListEntityListing.html.md +2 -2
  35. data/doc_out/ContentManagementApi.html.md +69 -0
  36. data/doc_out/ConversationEntityListing.html.md +2 -2
  37. data/doc_out/ConversationNotificationParticipant.html.md +1 -1
  38. data/doc_out/ConversationNotificationParticipants.html.md +13 -13
  39. data/doc_out/{ConversationNotificationScreenShare.html.md → ConversationNotificationScreenshare.html.md} +2 -2
  40. data/doc_out/{ConversationNotificationScreenShares.html.md → ConversationNotificationScreenshares.html.md} +2 -2
  41. data/doc_out/DIDEntityListing.html.md +2 -2
  42. data/doc_out/DIDPoolEntityListing.html.md +2 -2
  43. data/doc_out/DncListEntityListing.html.md +2 -2
  44. data/doc_out/DocumentAuditEntityListing.html.md +2 -2
  45. data/doc_out/DocumentDataNotification.html.md +28 -0
  46. data/doc_out/{CallbackConversationNotificationUser.html.md → DocumentDataNotificationCreatedBy.html.md} +2 -2
  47. data/doc_out/DocumentDataNotificationLockData.html.md +15 -0
  48. data/doc_out/DocumentDataNotificationLockInfo.html.md +15 -0
  49. data/doc_out/DocumentDataNotificationUserData.html.md +14 -0
  50. data/doc_out/DocumentDataNotificationWorkspace.html.md +13 -0
  51. data/doc_out/DocumentDataNotificationWorkspaceData.html.md +13 -0
  52. data/doc_out/DocumentEntityListing.html.md +2 -2
  53. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
  54. data/doc_out/DomainEntityListing.html.md +2 -2
  55. data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
  56. data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
  57. data/doc_out/EdgeEntityListing.html.md +2 -2
  58. data/doc_out/EdgeGroupEntityListing.html.md +2 -2
  59. data/doc_out/EdgeLineEntityListing.html.md +2 -2
  60. data/doc_out/EmailConversationEntityListing.html.md +2 -2
  61. data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -1
  62. data/doc_out/EmailConversationNotificationParticipants.html.md +1 -1
  63. data/doc_out/EmailMessageListing.html.md +2 -2
  64. data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
  65. data/doc_out/EndpointEntityListing.html.md +2 -2
  66. data/doc_out/EvaluationEntityListing.html.md +2 -2
  67. data/doc_out/EvaluationFormEntityListing.html.md +2 -2
  68. data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
  69. data/doc_out/ExtensionEntityListing.html.md +2 -2
  70. data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
  71. data/doc_out/FaxDataNotification.html.md +31 -0
  72. data/doc_out/FaxDataNotificationLockData.html.md +15 -0
  73. data/doc_out/FaxDataNotificationLockInfo.html.md +15 -0
  74. data/doc_out/FaxDataNotificationUserData.html.md +14 -0
  75. data/doc_out/FaxDataNotificationWorkspaceData.html.md +13 -0
  76. data/doc_out/FaxDocumentEntityListing.html.md +2 -2
  77. data/doc_out/GroupEntityListing.html.md +2 -2
  78. data/doc_out/GroupsApi.html.md +3 -1
  79. data/doc_out/HeartBeatAlertContainer.html.md +2 -2
  80. data/doc_out/HeartBeatRuleContainer.html.md +2 -2
  81. data/doc_out/InboundDomainEntityListing.html.md +2 -2
  82. data/doc_out/InboundRouteEntityListing.html.md +2 -2
  83. data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
  84. data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
  85. data/doc_out/KeywordSetEntityListing.html.md +2 -2
  86. data/doc_out/LanguageEntityListing.html.md +2 -2
  87. data/doc_out/LibraryEntityListing.html.md +2 -2
  88. data/doc_out/LineBaseEntityListing.html.md +2 -2
  89. data/doc_out/LineEntityListing.html.md +2 -2
  90. data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
  91. data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
  92. data/doc_out/OAuthClientEntityListing.html.md +2 -2
  93. data/doc_out/OAuthProviderEntityListing.html.md +2 -2
  94. data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
  95. data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
  96. data/doc_out/OrphanRecordingListing.html.md +2 -2
  97. data/doc_out/OutOfOfficeNotification.html.md +1 -1
  98. data/doc_out/OutboundRouteEntityListing.html.md +2 -2
  99. data/doc_out/Page.html.md +20 -0
  100. data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
  101. data/doc_out/PhoneBaseEntityListing.html.md +2 -2
  102. data/doc_out/PhoneEntityListing.html.md +2 -2
  103. data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
  104. data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
  105. data/doc_out/PolicyEntityListing.html.md +2 -2
  106. data/doc_out/PresenceApi.html.md +3 -4
  107. data/doc_out/QualityAuditPage.html.md +2 -2
  108. data/doc_out/QueueEmailAddress.html.md +1 -1
  109. data/doc_out/QueueEntityListing.html.md +2 -2
  110. data/doc_out/QueueMemberEntityListing.html.md +2 -2
  111. data/doc_out/RecordingApi.html.md +2 -2
  112. data/doc_out/RecordingDataNotification.html.md +31 -0
  113. data/doc_out/RecordingDataNotificationConversationData.html.md +13 -0
  114. data/doc_out/RecordingDataNotificationLockData.html.md +15 -0
  115. data/doc_out/RecordingDataNotificationLockInfo.html.md +15 -0
  116. data/doc_out/RecordingDataNotificationUserData.html.md +14 -0
  117. data/doc_out/RecordingDataNotificationWorkspaceData.html.md +13 -0
  118. data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
  119. data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
  120. data/doc_out/ReportScheduleEntityListing.html.md +2 -2
  121. data/doc_out/ResponseEntityList.html.md +2 -2
  122. data/doc_out/ResponseEntityListing.html.md +2 -2
  123. data/doc_out/ResponseSetEntityListing.html.md +2 -2
  124. data/doc_out/RuleSetEntityListing.html.md +2 -2
  125. data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
  126. data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
  127. data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
  128. data/doc_out/ScreenShareConversationNotificationParticipants.html.md +1 -1
  129. data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -1
  130. data/doc_out/Script.html.md +26 -0
  131. data/doc_out/ScriptEntityListing.html.md +22 -0
  132. data/doc_out/ScriptsApi.html.md +557 -0
  133. data/doc_out/SecurityProfileEntityListing.html.md +2 -2
  134. data/doc_out/ShareEntityListing.html.md +2 -2
  135. data/doc_out/SiteEntityListing.html.md +2 -2
  136. data/doc_out/SkillEntityListing.html.md +2 -2
  137. data/doc_out/SocialConversationNotificationParticipants.html.md +1 -1
  138. data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -1
  139. data/doc_out/StationEntityListing.html.md +2 -2
  140. data/doc_out/TagValueEntityListing.html.md +2 -2
  141. data/doc_out/TelephonyProvidersEdgeApi.html.md +5 -3
  142. data/doc_out/TimeOffRequest.html.md +30 -0
  143. data/doc_out/TimeOffRequestList.html.md +16 -0
  144. data/doc_out/TimeOffRequestPatch.html.md +13 -0
  145. data/doc_out/TimeZoneEntityListing.html.md +2 -2
  146. data/doc_out/TrunkBaseEntityListing.html.md +2 -2
  147. data/doc_out/TrunkEntityListing.html.md +2 -2
  148. data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
  149. data/doc_out/UserDetailsQuery.html.md +20 -0
  150. data/doc_out/UserEntityListing.html.md +2 -2
  151. data/doc_out/UserQueueEntityListing.html.md +2 -2
  152. data/doc_out/UserRecordingEntityListing.html.md +2 -2
  153. data/doc_out/UserSkillEntityListing.html.md +2 -2
  154. data/doc_out/UsersApi.html.md +73 -12
  155. data/doc_out/UsersEntityListing.html.md +2 -2
  156. data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
  157. data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
  158. data/doc_out/WorkforceManagementApi.html.md +302 -0
  159. data/doc_out/WorkspaceEntityListing.html.md +2 -2
  160. data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
  161. data/doc_out/WrapupCodeEntityListing.html.md +2 -2
  162. data/doc_out/index.html.md +3 -3
  163. data/lib/purecloud.rb +32 -3
  164. data/lib/purecloud/api/analytics_api.rb +60 -0
  165. data/lib/purecloud/api/content_management_api.rb +75 -0
  166. data/lib/purecloud/api/groups_api.rb +3 -0
  167. data/lib/purecloud/api/outbound_api.rb +16 -16
  168. data/lib/purecloud/api/presence_api.rb +5 -6
  169. data/lib/purecloud/api/recording_api.rb +2 -2
  170. data/lib/purecloud/api/scripts_api.rb +617 -0
  171. data/lib/purecloud/api/telephony_providers_edge_api.rb +7 -4
  172. data/lib/purecloud/api/users_api.rb +84 -20
  173. data/lib/purecloud/api/workforce_management_api.rb +317 -0
  174. data/lib/purecloud/api_client.rb +1 -1
  175. data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
  176. data/lib/purecloud/models/analytics_conversation_segment.rb +28 -4
  177. data/lib/purecloud/models/analytics_routing_status_record.rb +208 -0
  178. data/lib/purecloud/models/analytics_session.rb +83 -1
  179. data/lib/purecloud/models/analytics_user_detail.rb +192 -0
  180. data/lib/purecloud/models/analytics_user_details_query_response.rb +179 -0
  181. data/lib/purecloud/models/analytics_user_presence_record.rb +219 -0
  182. data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
  183. data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
  184. data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
  185. data/lib/purecloud/models/call.rb +4 -4
  186. data/lib/purecloud/models/call_conversation.rb +1 -1
  187. data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
  188. data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +1 -1
  189. data/lib/purecloud/models/call_conversation_notification_participants.rb +1 -1
  190. data/lib/purecloud/models/call_media_participant.rb +4 -4
  191. data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
  192. data/lib/purecloud/models/callback.rb +3 -3
  193. data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
  194. data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +1 -1
  195. data/lib/purecloud/models/callback_conversation_notification_participants.rb +1 -1
  196. data/lib/purecloud/models/callback_media_participant.rb +3 -3
  197. data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
  198. data/lib/purecloud/models/campaign_sequence.rb +1 -1
  199. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
  200. data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
  201. data/lib/purecloud/models/channel_entity_listing.rb +17 -17
  202. data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
  203. data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +1 -1
  204. data/lib/purecloud/models/chat_conversation_notification_participants.rb +1 -1
  205. data/lib/purecloud/models/chat_media_participant.rb +3 -3
  206. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
  207. data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
  208. data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +1 -1
  209. data/lib/purecloud/models/cobrowse_media_participant.rb +3 -3
  210. data/lib/purecloud/models/cobrowsesession.rb +2 -2
  211. data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
  212. data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
  213. data/lib/purecloud/models/conversation.rb +1 -1
  214. data/lib/purecloud/models/conversation_chat.rb +3 -3
  215. data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
  216. data/lib/purecloud/models/conversation_notification_participant.rb +8 -8
  217. data/lib/purecloud/models/conversation_notification_participants.rb +128 -128
  218. data/lib/purecloud/models/{conversation_notification_screen_share.rb → conversation_notification_screenshare.rb} +1 -1
  219. data/lib/purecloud/models/{conversation_notification_screen_shares.rb → conversation_notification_screenshares.rb} +1 -1
  220. data/lib/purecloud/models/did_entity_listing.rb +17 -17
  221. data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
  222. data/lib/purecloud/models/disconnect_reason.rb +1 -1
  223. data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
  224. data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
  225. data/lib/purecloud/models/document_data_notification.rb +315 -0
  226. data/lib/purecloud/models/{callback_conversation_notification_user.rb → document_data_notification_created_by.rb} +1 -1
  227. data/lib/purecloud/models/document_data_notification_lock_data.rb +185 -0
  228. data/lib/purecloud/models/document_data_notification_lock_info.rb +185 -0
  229. data/lib/purecloud/models/document_data_notification_user_data.rb +175 -0
  230. data/lib/purecloud/models/document_data_notification_workspace.rb +165 -0
  231. data/lib/purecloud/models/document_data_notification_workspace_data.rb +165 -0
  232. data/lib/purecloud/models/document_entity_listing.rb +17 -17
  233. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
  234. data/lib/purecloud/models/domain_entity_listing.rb +17 -17
  235. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
  236. data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
  237. data/lib/purecloud/models/edge_entity_listing.rb +17 -17
  238. data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
  239. data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
  240. data/lib/purecloud/models/email.rb +3 -3
  241. data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
  242. data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +1 -1
  243. data/lib/purecloud/models/email_conversation_notification_participants.rb +1 -1
  244. data/lib/purecloud/models/email_media_participant.rb +3 -3
  245. data/lib/purecloud/models/email_message_listing.rb +17 -17
  246. data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
  247. data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
  248. data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
  249. data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
  250. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
  251. data/lib/purecloud/models/extension_entity_listing.rb +17 -17
  252. data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
  253. data/lib/purecloud/models/fax_data_notification.rb +345 -0
  254. data/lib/purecloud/models/fax_data_notification_lock_data.rb +185 -0
  255. data/lib/purecloud/models/fax_data_notification_lock_info.rb +185 -0
  256. data/lib/purecloud/models/fax_data_notification_user_data.rb +175 -0
  257. data/lib/purecloud/models/fax_data_notification_workspace_data.rb +165 -0
  258. data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
  259. data/lib/purecloud/models/group_entity_listing.rb +17 -17
  260. data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
  261. data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
  262. data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
  263. data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
  264. data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
  265. data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
  266. data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
  267. data/lib/purecloud/models/language_entity_listing.rb +17 -17
  268. data/lib/purecloud/models/library_entity_listing.rb +17 -17
  269. data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
  270. data/lib/purecloud/models/line_entity_listing.rb +17 -17
  271. data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
  272. data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
  273. data/lib/purecloud/models/media_participant_request.rb +1 -1
  274. data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
  275. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
  276. data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
  277. data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
  278. data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
  279. data/lib/purecloud/models/out_of_office_notification.rb +1 -1
  280. data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
  281. data/lib/purecloud/models/page.rb +243 -0
  282. data/lib/purecloud/models/participant.rb +1 -1
  283. data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
  284. data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
  285. data/lib/purecloud/models/phone_entity_listing.rb +17 -17
  286. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
  287. data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
  288. data/lib/purecloud/models/policy_entity_listing.rb +17 -17
  289. data/lib/purecloud/models/quality_audit_page.rb +17 -17
  290. data/lib/purecloud/models/queue_email_address.rb +1 -1
  291. data/lib/purecloud/models/queue_entity_listing.rb +17 -17
  292. data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
  293. data/lib/purecloud/models/recording_data_notification.rb +345 -0
  294. data/lib/purecloud/models/recording_data_notification_conversation_data.rb +165 -0
  295. data/lib/purecloud/models/recording_data_notification_lock_data.rb +185 -0
  296. data/lib/purecloud/models/recording_data_notification_lock_info.rb +185 -0
  297. data/lib/purecloud/models/recording_data_notification_user_data.rb +175 -0
  298. data/lib/purecloud/models/recording_data_notification_workspace_data.rb +165 -0
  299. data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
  300. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
  301. data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
  302. data/lib/purecloud/models/response_entity_list.rb +17 -17
  303. data/lib/purecloud/models/response_entity_listing.rb +17 -17
  304. data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
  305. data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
  306. data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
  307. data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
  308. data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
  309. data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +1 -1
  310. data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
  311. data/lib/purecloud/models/screenshare.rb +2 -2
  312. data/lib/purecloud/models/script.rb +303 -0
  313. data/lib/purecloud/models/script_entity_listing.rb +257 -0
  314. data/lib/purecloud/models/search_aggregation.rb +1 -1
  315. data/lib/purecloud/models/search_criteria.rb +1 -1
  316. data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
  317. data/lib/purecloud/models/share_entity_listing.rb +17 -17
  318. data/lib/purecloud/models/site_entity_listing.rb +17 -17
  319. data/lib/purecloud/models/skill_entity_listing.rb +17 -17
  320. data/lib/purecloud/models/social_conversation_notification_participants.rb +1 -1
  321. data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +1 -1
  322. data/lib/purecloud/models/social_expression.rb +2 -2
  323. data/lib/purecloud/models/station_entity_listing.rb +17 -17
  324. data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
  325. data/lib/purecloud/models/time_off_request.rb +369 -0
  326. data/lib/purecloud/models/time_off_request_list.rb +199 -0
  327. data/lib/purecloud/models/time_off_request_patch.rb +167 -0
  328. data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
  329. data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
  330. data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
  331. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
  332. data/lib/purecloud/models/user_details_query.rb +262 -0
  333. data/lib/purecloud/models/user_entity_listing.rb +17 -17
  334. data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
  335. data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
  336. data/lib/purecloud/models/user_schedule_adherence.rb +3 -3
  337. data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
  338. data/lib/purecloud/models/users_entity_listing.rb +17 -17
  339. data/lib/purecloud/models/video.rb +2 -2
  340. data/lib/purecloud/models/video_conversation_notification_participants.rb +1 -1
  341. data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +1 -1
  342. data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
  343. data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
  344. data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
  345. data/lib/purecloud/version.rb +1 -1
  346. data/newVersion.md +1 -1
  347. data/swagger.json +1 -1
  348. data/version.json +1 -1
  349. metadata +66 -8
@@ -11,11 +11,11 @@ title: QueueEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: QueueMemberEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -298,7 +298,7 @@ api_instance = PureCloud::RecordingApi.new
298
298
  conversation_id = "conversation_id_example" # String | Conversation ID
299
299
 
300
300
  opts = {
301
- max_wait_ms: 5000, # Integer | The maximum number of milliseconds to wait for the recording to be ready.
301
+ max_wait_ms: 5000, # Integer | The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value.
302
302
  format_id: "WEBM" # String | The desired media format
303
303
  }
304
304
 
@@ -316,7 +316,7 @@ end
316
316
  Name | Type | Description | Notes
317
317
  ------------- | ------------- | ------------- | -------------
318
318
  **conversation_id** | **String**| Conversation ID |
319
- **max_wait_ms** | **Integer**| The maximum number of milliseconds to wait for the recording to be ready. | [optional] [default to 5000]
319
+ **max_wait_ms** | **Integer**| The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. | [optional] [default to 5000]
320
320
  **format_id** | **String**| The desired media format | [optional] [default to WEBM]
321
321
  {: class="table table-striped"}
322
322
 
@@ -0,0 +1,31 @@
1
+ ---
2
+ title: RecordingDataNotification
3
+ ---
4
+ ## PureCloud::RecordingDataNotification
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **date_created** | **String** | | [optional] |
13
+ | **date_modified** | **String** | | [optional] |
14
+ | **workspace** | [**DocumentDataNotificationWorkspace**](DocumentDataNotificationWorkspace.html) | | [optional] |
15
+ | **created_by** | [**DocumentDataNotificationCreatedBy**](DocumentDataNotificationCreatedBy.html) | | [optional] |
16
+ | **content_type** | **String** | | [optional] |
17
+ | **content_length** | **Integer** | | [optional] |
18
+ | **filename** | **String** | | [optional] |
19
+ | **file_name** | **String** | | [optional] |
20
+ | **change_number** | **Integer** | | [optional] |
21
+ | **date_uploaded** | **String** | | [optional] |
22
+ | **uploaded_by** | [**RecordingDataNotificationUserData**](RecordingDataNotificationUserData.html) | | [optional] |
23
+ | **lock_info** | [**RecordingDataNotificationLockInfo**](RecordingDataNotificationLockInfo.html) | | [optional] |
24
+ | **page_count** | **Integer** | | [optional] |
25
+ | **self_uri** | **String** | | [optional] |
26
+ | **duration_millieconds** | **Integer** | | [optional] |
27
+ | **conversation** | [**DocumentDataNotificationWorkspace**](DocumentDataNotificationWorkspace.html) | | [optional] |
28
+ | **read** | **BOOLEAN** | | [optional] |
29
+ {: class="table table-striped"}
30
+
31
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: RecordingDataNotificationConversationData
3
+ ---
4
+ ## PureCloud::RecordingDataNotificationConversationData
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: RecordingDataNotificationLockData
3
+ ---
4
+ ## PureCloud::RecordingDataNotificationLockData
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **locked_by** | [**RecordingDataNotificationUserData**](RecordingDataNotificationUserData.html) | | [optional] |
11
+ | **date_created** | **String** | | [optional] |
12
+ | **date_expires** | **String** | | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: RecordingDataNotificationLockInfo
3
+ ---
4
+ ## PureCloud::RecordingDataNotificationLockInfo
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **locked_by** | [**RecordingDataNotificationUserData**](RecordingDataNotificationUserData.html) | | [optional] |
11
+ | **date_created** | **String** | | [optional] |
12
+ | **date_expires** | **String** | | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: RecordingDataNotificationUserData
3
+ ---
4
+ ## PureCloud::RecordingDataNotificationUserData
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: RecordingDataNotificationWorkspaceData
3
+ ---
4
+ ## PureCloud::RecordingDataNotificationWorkspaceData
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -11,11 +11,11 @@ title: ReportMetaDataEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ReportRunEntryEntityDomainListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ReportScheduleEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ResponseEntityList
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ResponseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ResponseSetEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: RuleSetEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: SchemaCategoryEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: SchemaReferenceEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ScreenRecordingSessionListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -33,7 +33,7 @@ title: ScreenShareConversationNotificationParticipants
33
33
  | **context** | **String** | | [optional] |
34
34
  | **start_hold_time** | **DateTime** | | [optional] |
35
35
  | **attributes** | **Hash<String, String>** | | [optional] |
36
- | **user** | [**CallbackConversationNotificationUser**](CallbackConversationNotificationUser.html) | | [optional] |
36
+ | **user** | [**DocumentDataNotificationCreatedBy**](DocumentDataNotificationCreatedBy.html) | | [optional] |
37
37
  {: class="table table-striped"}
38
38
 
39
39
 
@@ -21,7 +21,7 @@ title: ScreenShareConversationNotificationScreenShareMediaParticipant
21
21
  | **held** | **BOOLEAN** | | [optional] |
22
22
  | **wrapup_required** | **BOOLEAN** | | [optional] |
23
23
  | **wrapup_prompt** | **String** | | [optional] |
24
- | **user** | [**CallbackConversationNotificationUser**](CallbackConversationNotificationUser.html) | | [optional] |
24
+ | **user** | [**DocumentDataNotificationCreatedBy**](DocumentDataNotificationCreatedBy.html) | | [optional] |
25
25
  | **queue** | [**ScreenShareConversationNotificationUriReference**](ScreenShareConversationNotificationUriReference.html) | | [optional] |
26
26
  | **attributes** | **Hash<String, String>** | | [optional] |
27
27
  | **error_info** | [**ScreenShareConversationNotificationErrorInfo**](ScreenShareConversationNotificationErrorInfo.html) | | [optional] |
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: Script
3
+ ---
4
+ ## PureCloud::Script
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_id** | **String** | | [optional] |
13
+ | **created_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ | **published_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
+ | **version_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
17
+ | **start_page_id** | **String** | | [optional] |
18
+ | **start_page_name** | **String** | | [optional] |
19
+ | **features** | **Object** | | [optional] |
20
+ | **variables** | **Object** | | [optional] |
21
+ | **custom_actions** | **Object** | | [optional] |
22
+ | **pages** | [**Array<Page>**](Page.html) | | [optional] |
23
+ | **self_uri** | **String** | The URI for this object | [optional] |
24
+ {: class="table table-striped"}
25
+
26
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: ScriptEntityListing
3
+ ---
4
+ ## PureCloud::ScriptEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<Script>**](Script.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
17
+ | **last_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -0,0 +1,557 @@
1
+ ---
2
+ title: ScriptsApi
3
+ ---
4
+
5
+ ## PureCloud::ScriptsApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | HTTP request | Description
10
+ ------------- | ------------- | -------------
11
+ |[**get_published**](ScriptsApi.html#get_published) | **GET** /api/v2/scripts/published | Get the published scripts.|
12
+ |[**get_published_script_id**](ScriptsApi.html#get_published_script_id) | **GET** /api/v2/scripts/published/{scriptId} | Get the published script.|
13
+ |[**get_published_script_id_pages**](ScriptsApi.html#get_published_script_id_pages) | **GET** /api/v2/scripts/published/{scriptId}/pages | Get the list of published pages|
14
+ |[**get_published_script_id_pages_page_id**](ScriptsApi.html#get_published_script_id_pages_page_id) | **GET** /api/v2/scripts/published/{scriptId}/pages/{pageId} | Get the published page.|
15
+ |[**get_published_script_id_variables**](ScriptsApi.html#get_published_script_id_variables) | **GET** /api/v2/scripts/published/{scriptId}/variables | Get the published variables|
16
+ |[**get_script_id**](ScriptsApi.html#get_script_id) | **GET** /api/v2/scripts/{scriptId} | Get a script|
17
+ |[**get_script_id_pages**](ScriptsApi.html#get_script_id_pages) | **GET** /api/v2/scripts/{scriptId}/pages | Get the list of pages|
18
+ |[**get_script_id_pages_page_id**](ScriptsApi.html#get_script_id_pages_page_id) | **GET** /api/v2/scripts/{scriptId}/pages/{pageId} | Get a page|
19
+ |[**get_scripts**](ScriptsApi.html#get_scripts) | **GET** /api/v2/scripts | Get the list of scripts|
20
+ {: class="table table-striped"}
21
+
22
+ <a name="get_published"></a>
23
+
24
+ ## -[**ScriptEntityListing**](ScriptEntityListing.html) get_published(opts)
25
+
26
+ Get the published scripts.
27
+
28
+
29
+
30
+ ### Example
31
+ ~~~ruby
32
+ # load the gem
33
+ require 'purecloud'
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::ScriptsApi.new
46
+
47
+ opts = {
48
+ page_size: 25, # Integer | Page size
49
+ page_number: 1, # Integer | Page number
50
+ expand: "expand_example", # String | Expand
51
+ name: "name_example", # String | Name filter
52
+ feature: "feature_example", # String | Feature filter
53
+ flow_id: "flow_id_example" # String | Secure flow id filter
54
+ }
55
+
56
+ begin
57
+ #Get the published scripts.
58
+ result = api_instance.get_published(opts)
59
+ p result
60
+ rescue PureCloud::ApiError => e
61
+ puts "Exception when calling ScriptsApi->get_published: #{e}"
62
+ end
63
+ ~~~
64
+
65
+ ### Parameters
66
+
67
+ Name | Type | Description | Notes
68
+ ------------- | ------------- | ------------- | -------------
69
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
70
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
71
+ **expand** | **String**| Expand | [optional]
72
+ **name** | **String**| Name filter | [optional]
73
+ **feature** | **String**| Feature filter | [optional]
74
+ **flow_id** | **String**| Secure flow id filter | [optional]
75
+ {: class="table table-striped"}
76
+
77
+
78
+ ### Return type
79
+
80
+ [**ScriptEntityListing**](ScriptEntityListing.html)
81
+
82
+ ### HTTP request headers
83
+
84
+ - **Content-Type**: application/json
85
+ - **Accept**: application/json
86
+
87
+
88
+
89
+ <a name="get_published_script_id"></a>
90
+
91
+ ## -[**Script**](Script.html) get_published_script_id(script_id)
92
+
93
+ Get the published script.
94
+
95
+
96
+
97
+ ### Example
98
+ ~~~ruby
99
+ # load the gem
100
+ require 'purecloud'
101
+ # setup authorization
102
+ @secret = ENV['PURECLOUD_SECRET']
103
+ @id = ENV['PURECLOUD_CLIENT_ID']
104
+ environment = "mypurecloud.com"
105
+
106
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
107
+
108
+ PureCloud.configure do |config|
109
+ config.access_token = @authToken
110
+ end
111
+
112
+ api_instance = PureCloud::ScriptsApi.new
113
+
114
+ script_id = "script_id_example" # String | Script ID
115
+
116
+
117
+ begin
118
+ #Get the published script.
119
+ result = api_instance.get_published_script_id(script_id)
120
+ p result
121
+ rescue PureCloud::ApiError => e
122
+ puts "Exception when calling ScriptsApi->get_published_script_id: #{e}"
123
+ end
124
+ ~~~
125
+
126
+ ### Parameters
127
+
128
+ Name | Type | Description | Notes
129
+ ------------- | ------------- | ------------- | -------------
130
+ **script_id** | **String**| Script ID |
131
+ {: class="table table-striped"}
132
+
133
+
134
+ ### Return type
135
+
136
+ [**Script**](Script.html)
137
+
138
+ ### HTTP request headers
139
+
140
+ - **Content-Type**: application/json
141
+ - **Accept**: application/json
142
+
143
+
144
+
145
+ <a name="get_published_script_id_pages"></a>
146
+
147
+ ## -[**Array&lt;Page&gt;**](Page.html) get_published_script_id_pages(script_id)
148
+
149
+ Get the list of published pages
150
+
151
+
152
+
153
+ ### Example
154
+ ~~~ruby
155
+ # load the gem
156
+ require 'purecloud'
157
+ # setup authorization
158
+ @secret = ENV['PURECLOUD_SECRET']
159
+ @id = ENV['PURECLOUD_CLIENT_ID']
160
+ environment = "mypurecloud.com"
161
+
162
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
163
+
164
+ PureCloud.configure do |config|
165
+ config.access_token = @authToken
166
+ end
167
+
168
+ api_instance = PureCloud::ScriptsApi.new
169
+
170
+ script_id = "script_id_example" # String | Script ID
171
+
172
+
173
+ begin
174
+ #Get the list of published pages
175
+ result = api_instance.get_published_script_id_pages(script_id)
176
+ p result
177
+ rescue PureCloud::ApiError => e
178
+ puts "Exception when calling ScriptsApi->get_published_script_id_pages: #{e}"
179
+ end
180
+ ~~~
181
+
182
+ ### Parameters
183
+
184
+ Name | Type | Description | Notes
185
+ ------------- | ------------- | ------------- | -------------
186
+ **script_id** | **String**| Script ID |
187
+ {: class="table table-striped"}
188
+
189
+
190
+ ### Return type
191
+
192
+ [**Array&lt;Page&gt;**](Page.html)
193
+
194
+ ### HTTP request headers
195
+
196
+ - **Content-Type**: application/json
197
+ - **Accept**: application/json
198
+
199
+
200
+
201
+ <a name="get_published_script_id_pages_page_id"></a>
202
+
203
+ ## -[**Page**](Page.html) get_published_script_id_pages_page_id(script_id, page_id)
204
+
205
+ Get the published page.
206
+
207
+
208
+
209
+ ### Example
210
+ ~~~ruby
211
+ # load the gem
212
+ require 'purecloud'
213
+ # setup authorization
214
+ @secret = ENV['PURECLOUD_SECRET']
215
+ @id = ENV['PURECLOUD_CLIENT_ID']
216
+ environment = "mypurecloud.com"
217
+
218
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
219
+
220
+ PureCloud.configure do |config|
221
+ config.access_token = @authToken
222
+ end
223
+
224
+ api_instance = PureCloud::ScriptsApi.new
225
+
226
+ script_id = "script_id_example" # String | Script ID
227
+
228
+ page_id = "page_id_example" # String | Page ID
229
+
230
+
231
+ begin
232
+ #Get the published page.
233
+ result = api_instance.get_published_script_id_pages_page_id(script_id, page_id)
234
+ p result
235
+ rescue PureCloud::ApiError => e
236
+ puts "Exception when calling ScriptsApi->get_published_script_id_pages_page_id: #{e}"
237
+ end
238
+ ~~~
239
+
240
+ ### Parameters
241
+
242
+ Name | Type | Description | Notes
243
+ ------------- | ------------- | ------------- | -------------
244
+ **script_id** | **String**| Script ID |
245
+ **page_id** | **String**| Page ID |
246
+ {: class="table table-striped"}
247
+
248
+
249
+ ### Return type
250
+
251
+ [**Page**](Page.html)
252
+
253
+ ### HTTP request headers
254
+
255
+ - **Content-Type**: application/json
256
+ - **Accept**: application/json
257
+
258
+
259
+
260
+ <a name="get_published_script_id_variables"></a>
261
+
262
+ ## -Object** get_published_script_id_variables(script_id)
263
+
264
+ Get the published variables
265
+
266
+
267
+
268
+ ### Example
269
+ ~~~ruby
270
+ # load the gem
271
+ require 'purecloud'
272
+ # setup authorization
273
+ @secret = ENV['PURECLOUD_SECRET']
274
+ @id = ENV['PURECLOUD_CLIENT_ID']
275
+ environment = "mypurecloud.com"
276
+
277
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
278
+
279
+ PureCloud.configure do |config|
280
+ config.access_token = @authToken
281
+ end
282
+
283
+ api_instance = PureCloud::ScriptsApi.new
284
+
285
+ script_id = "script_id_example" # String | Script ID
286
+
287
+
288
+ begin
289
+ #Get the published variables
290
+ result = api_instance.get_published_script_id_variables(script_id)
291
+ p result
292
+ rescue PureCloud::ApiError => e
293
+ puts "Exception when calling ScriptsApi->get_published_script_id_variables: #{e}"
294
+ end
295
+ ~~~
296
+
297
+ ### Parameters
298
+
299
+ Name | Type | Description | Notes
300
+ ------------- | ------------- | ------------- | -------------
301
+ **script_id** | **String**| Script ID |
302
+ {: class="table table-striped"}
303
+
304
+
305
+ ### Return type
306
+
307
+ **Object**
308
+
309
+ ### HTTP request headers
310
+
311
+ - **Content-Type**: application/json
312
+ - **Accept**: application/json
313
+
314
+
315
+
316
+ <a name="get_script_id"></a>
317
+
318
+ ## -[**Script**](Script.html) get_script_id(script_id)
319
+
320
+ Get a script
321
+
322
+
323
+
324
+ ### Example
325
+ ~~~ruby
326
+ # load the gem
327
+ require 'purecloud'
328
+ # setup authorization
329
+ @secret = ENV['PURECLOUD_SECRET']
330
+ @id = ENV['PURECLOUD_CLIENT_ID']
331
+ environment = "mypurecloud.com"
332
+
333
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
334
+
335
+ PureCloud.configure do |config|
336
+ config.access_token = @authToken
337
+ end
338
+
339
+ api_instance = PureCloud::ScriptsApi.new
340
+
341
+ script_id = "script_id_example" # String | Script ID
342
+
343
+
344
+ begin
345
+ #Get a script
346
+ result = api_instance.get_script_id(script_id)
347
+ p result
348
+ rescue PureCloud::ApiError => e
349
+ puts "Exception when calling ScriptsApi->get_script_id: #{e}"
350
+ end
351
+ ~~~
352
+
353
+ ### Parameters
354
+
355
+ Name | Type | Description | Notes
356
+ ------------- | ------------- | ------------- | -------------
357
+ **script_id** | **String**| Script ID |
358
+ {: class="table table-striped"}
359
+
360
+
361
+ ### Return type
362
+
363
+ [**Script**](Script.html)
364
+
365
+ ### HTTP request headers
366
+
367
+ - **Content-Type**: application/json
368
+ - **Accept**: application/json
369
+
370
+
371
+
372
+ <a name="get_script_id_pages"></a>
373
+
374
+ ## -[**Array&lt;Page&gt;**](Page.html) get_script_id_pages(script_id)
375
+
376
+ Get the list of pages
377
+
378
+
379
+
380
+ ### Example
381
+ ~~~ruby
382
+ # load the gem
383
+ require 'purecloud'
384
+ # setup authorization
385
+ @secret = ENV['PURECLOUD_SECRET']
386
+ @id = ENV['PURECLOUD_CLIENT_ID']
387
+ environment = "mypurecloud.com"
388
+
389
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
390
+
391
+ PureCloud.configure do |config|
392
+ config.access_token = @authToken
393
+ end
394
+
395
+ api_instance = PureCloud::ScriptsApi.new
396
+
397
+ script_id = "script_id_example" # String | Script ID
398
+
399
+
400
+ begin
401
+ #Get the list of pages
402
+ result = api_instance.get_script_id_pages(script_id)
403
+ p result
404
+ rescue PureCloud::ApiError => e
405
+ puts "Exception when calling ScriptsApi->get_script_id_pages: #{e}"
406
+ end
407
+ ~~~
408
+
409
+ ### Parameters
410
+
411
+ Name | Type | Description | Notes
412
+ ------------- | ------------- | ------------- | -------------
413
+ **script_id** | **String**| Script ID |
414
+ {: class="table table-striped"}
415
+
416
+
417
+ ### Return type
418
+
419
+ [**Array&lt;Page&gt;**](Page.html)
420
+
421
+ ### HTTP request headers
422
+
423
+ - **Content-Type**: application/json
424
+ - **Accept**: application/json
425
+
426
+
427
+
428
+ <a name="get_script_id_pages_page_id"></a>
429
+
430
+ ## -[**Page**](Page.html) get_script_id_pages_page_id(script_id, page_id)
431
+
432
+ Get a page
433
+
434
+
435
+
436
+ ### Example
437
+ ~~~ruby
438
+ # load the gem
439
+ require 'purecloud'
440
+ # setup authorization
441
+ @secret = ENV['PURECLOUD_SECRET']
442
+ @id = ENV['PURECLOUD_CLIENT_ID']
443
+ environment = "mypurecloud.com"
444
+
445
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
446
+
447
+ PureCloud.configure do |config|
448
+ config.access_token = @authToken
449
+ end
450
+
451
+ api_instance = PureCloud::ScriptsApi.new
452
+
453
+ script_id = "script_id_example" # String | Script ID
454
+
455
+ page_id = "page_id_example" # String | Page ID
456
+
457
+
458
+ begin
459
+ #Get a page
460
+ result = api_instance.get_script_id_pages_page_id(script_id, page_id)
461
+ p result
462
+ rescue PureCloud::ApiError => e
463
+ puts "Exception when calling ScriptsApi->get_script_id_pages_page_id: #{e}"
464
+ end
465
+ ~~~
466
+
467
+ ### Parameters
468
+
469
+ Name | Type | Description | Notes
470
+ ------------- | ------------- | ------------- | -------------
471
+ **script_id** | **String**| Script ID |
472
+ **page_id** | **String**| Page ID |
473
+ {: class="table table-striped"}
474
+
475
+
476
+ ### Return type
477
+
478
+ [**Page**](Page.html)
479
+
480
+ ### HTTP request headers
481
+
482
+ - **Content-Type**: application/json
483
+ - **Accept**: application/json
484
+
485
+
486
+
487
+ <a name="get_scripts"></a>
488
+
489
+ ## -[**ScriptEntityListing**](ScriptEntityListing.html) get_scripts(opts)
490
+
491
+ Get the list of scripts
492
+
493
+
494
+
495
+ ### Example
496
+ ~~~ruby
497
+ # load the gem
498
+ require 'purecloud'
499
+ # setup authorization
500
+ @secret = ENV['PURECLOUD_SECRET']
501
+ @id = ENV['PURECLOUD_CLIENT_ID']
502
+ environment = "mypurecloud.com"
503
+
504
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
505
+
506
+ PureCloud.configure do |config|
507
+ config.access_token = @authToken
508
+ end
509
+
510
+ api_instance = PureCloud::ScriptsApi.new
511
+
512
+ opts = {
513
+ page_size: 25, # Integer | Page size
514
+ page_number: 1, # Integer | Page number
515
+ expand: "expand_example", # String | Expand
516
+ name: "name_example", # String | Name filter
517
+ feature: "feature_example", # String | Feature filter
518
+ flow_id: "flow_id_example", # String | Secure flow id filter
519
+ sort_by: "sort_by_example", # String | SortBy
520
+ sort_order: "sort_order_example" # String | SortOrder
521
+ }
522
+
523
+ begin
524
+ #Get the list of scripts
525
+ result = api_instance.get_scripts(opts)
526
+ p result
527
+ rescue PureCloud::ApiError => e
528
+ puts "Exception when calling ScriptsApi->get_scripts: #{e}"
529
+ end
530
+ ~~~
531
+
532
+ ### Parameters
533
+
534
+ Name | Type | Description | Notes
535
+ ------------- | ------------- | ------------- | -------------
536
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
537
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
538
+ **expand** | **String**| Expand | [optional]
539
+ **name** | **String**| Name filter | [optional]
540
+ **feature** | **String**| Feature filter | [optional]
541
+ **flow_id** | **String**| Secure flow id filter | [optional]
542
+ **sort_by** | **String**| SortBy | [optional]
543
+ **sort_order** | **String**| SortOrder | [optional]
544
+ {: class="table table-striped"}
545
+
546
+
547
+ ### Return type
548
+
549
+ [**ScriptEntityListing**](ScriptEntityListing.html)
550
+
551
+ ### HTTP request headers
552
+
553
+ - **Content-Type**: application/json
554
+ - **Accept**: application/json
555
+
556
+
557
+