purecloudplatformclientv2 24.0.0 → 25.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 (305) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -2
  3. data/docs/ActionEntityListing.md +2 -2
  4. data/docs/AgentActivity.md +6 -0
  5. data/docs/AgentActivityEntityListing.md +2 -2
  6. data/docs/AnalyticsSession.md +1 -0
  7. data/docs/AnalyticsSessionMetric.md +15 -0
  8. data/docs/AttemptLimitsEntityListing.md +2 -2
  9. data/docs/AttributeEntityListing.md +2 -2
  10. data/docs/CalibrationEntityListing.md +2 -2
  11. data/docs/CallConversationEntityListing.md +2 -2
  12. data/docs/CallHistoryConversationEntityListing.md +2 -2
  13. data/docs/CallableTimeSetEntityListing.md +2 -2
  14. data/docs/CallbackConversationEntityListing.md +2 -2
  15. data/docs/CampaignEntityListing.md +2 -2
  16. data/docs/CampaignRuleEntityListing.md +2 -2
  17. data/docs/CampaignSequenceEntityListing.md +2 -2
  18. data/docs/CertificateAuthorityEntityListing.md +2 -2
  19. data/docs/ChatConversationEntityListing.md +2 -2
  20. data/docs/CobrowseConversationEntityListing.md +2 -2
  21. data/docs/CommandStatusEntityListing.md +2 -2
  22. data/docs/ConsumedResourcesEntityListing.md +2 -2
  23. data/docs/ConsumingResourcesEntityListing.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/ConversationsApi.md +4 -4
  29. data/docs/CreateEmailRequest.md +4 -4
  30. data/docs/DIDEntityListing.md +2 -2
  31. data/docs/DIDPoolEntityListing.md +2 -2
  32. data/docs/DependencyObjectEntityListing.md +2 -2
  33. data/docs/DependencyTypeEntityListing.md +2 -2
  34. data/docs/DialerEventEntityListing.md +2 -2
  35. data/docs/DirectoryUserDevicesListing.md +2 -2
  36. data/docs/DncListEntityListing.md +2 -2
  37. data/docs/DocumentAuditEntityListing.md +2 -2
  38. data/docs/DocumentEntityListing.md +2 -2
  39. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
  40. data/docs/DomainEntityListing.md +2 -2
  41. data/docs/DomainEntityListingEvaluationForm.md +2 -2
  42. data/docs/DomainEntityListingQueryResult.md +2 -2
  43. data/docs/DomainEntityListingSurveyForm.md +22 -0
  44. data/docs/EdgeEntityListing.md +2 -2
  45. data/docs/EdgeGroupEntityListing.md +2 -2
  46. data/docs/EdgeLineEntityListing.md +2 -2
  47. data/docs/EmailConversationEntityListing.md +2 -2
  48. data/docs/EmailMessageListing.md +2 -2
  49. data/docs/EncryptionKeyEntityListing.md +2 -2
  50. data/docs/EndpointEntityListing.md +2 -2
  51. data/docs/EvaluationEntityListing.md +2 -2
  52. data/docs/EvaluationForm.md +0 -1
  53. data/docs/EvaluationFormEntityListing.md +2 -2
  54. data/docs/EvaluatorActivityEntityListing.md +2 -2
  55. data/docs/ExtensionEntityListing.md +2 -2
  56. data/docs/ExtensionPoolEntityListing.md +2 -2
  57. data/docs/ExternalOrganizationListing.md +2 -2
  58. data/docs/FaxDocumentEntityListing.md +2 -2
  59. data/docs/FlowEntityListing.md +2 -2
  60. data/docs/FlowVersionEntityListing.md +2 -2
  61. data/docs/GreetingListing.md +2 -2
  62. data/docs/GroupEntityListing.md +2 -2
  63. data/docs/IVREntityListing.md +2 -2
  64. data/docs/InboundDomainEntityListing.md +2 -2
  65. data/docs/InboundRouteEntityListing.md +2 -2
  66. data/docs/InteractionStatsAlertContainer.md +2 -2
  67. data/docs/InteractionStatsRuleContainer.md +2 -2
  68. data/docs/JsonNode.md +1 -1
  69. data/docs/KeywordSetEntityListing.md +2 -2
  70. data/docs/LanguageEntityListing.md +2 -2
  71. data/docs/LibraryEntityListing.md +2 -2
  72. data/docs/LineBaseEntityListing.md +2 -2
  73. data/docs/LineEntityListing.md +2 -2
  74. data/docs/LocationEntityListing.md +2 -2
  75. data/docs/LogicalInterfaceEntityListing.md +2 -2
  76. data/docs/ManagementUnitListing.md +2 -2
  77. data/docs/NoteListing.md +2 -2
  78. data/docs/OAuthClientEntityListing.md +2 -2
  79. data/docs/OAuthProviderEntityListing.md +2 -2
  80. data/docs/OrganizationPresenceEntityListing.md +2 -2
  81. data/docs/OrganizationRoleEntityListing.md +2 -2
  82. data/docs/OrphanRecordingListing.md +2 -2
  83. data/docs/OutboundApi.md +6 -4
  84. data/docs/OutboundRouteBaseEntityListing.md +2 -2
  85. data/docs/OutboundRouteEntityListing.md +2 -2
  86. data/docs/PermissionCollectionEntityListing.md +2 -2
  87. data/docs/PhoneBaseEntityListing.md +2 -2
  88. data/docs/PhoneEntityListing.md +2 -2
  89. data/docs/PhoneMetaBaseEntityListing.md +2 -2
  90. data/docs/PhysicalInterfaceEntityListing.md +2 -2
  91. data/docs/PolicyEntityListing.md +2 -2
  92. data/docs/PromptAssetEntityListing.md +2 -2
  93. data/docs/PromptEntityListing.md +2 -2
  94. data/docs/PublishForm.md +14 -0
  95. data/docs/QualityApi.md +1320 -125
  96. data/docs/QualityAuditPage.md +2 -2
  97. data/docs/Question.md +5 -5
  98. data/docs/QueueEntityListing.md +2 -2
  99. data/docs/QueueMemberEntityListing.md +2 -2
  100. data/docs/RelationshipListing.md +2 -2
  101. data/docs/ReportMetaDataEntityListing.md +2 -2
  102. data/docs/ReportRunEntryEntityDomainListing.md +2 -2
  103. data/docs/ReportScheduleEntityListing.md +2 -2
  104. data/docs/ResponseEntityList.md +2 -2
  105. data/docs/ResponseEntityListing.md +2 -2
  106. data/docs/ResponseSetEntityListing.md +2 -2
  107. data/docs/RuleSetEntityListing.md +2 -2
  108. data/docs/ScheduleEntityListing.md +2 -2
  109. data/docs/ScheduleGroupEntityListing.md +2 -2
  110. data/docs/SchemaCategoryEntityListing.md +2 -2
  111. data/docs/SchemaReferenceEntityListing.md +2 -2
  112. data/docs/ScreenRecordingSessionListing.md +2 -2
  113. data/docs/ScriptEntityListing.md +2 -2
  114. data/docs/SecurityProfileEntityListing.md +2 -2
  115. data/docs/ShareEntityListing.md +2 -2
  116. data/docs/SiteEntityListing.md +2 -2
  117. data/docs/SkillEntityListing.md +2 -2
  118. data/docs/StationEntityListing.md +2 -2
  119. data/docs/SurveyForm.md +23 -0
  120. data/docs/SurveyFormEntityListing.md +22 -0
  121. data/docs/SystemPromptAssetEntityListing.md +2 -2
  122. data/docs/SystemPromptEntityListing.md +2 -2
  123. data/docs/TagValueEntityListing.md +2 -2
  124. data/docs/TimeZoneEntityListing.md +2 -2
  125. data/docs/TrunkBaseEntityListing.md +2 -2
  126. data/docs/TrunkEntityListing.md +2 -2
  127. data/docs/TrunkMetabaseEntityListing.md +2 -2
  128. data/docs/TrustEntityListing.md +2 -2
  129. data/docs/TrustUserEntityListing.md +2 -2
  130. data/docs/TrustorEntityListing.md +2 -2
  131. data/docs/UserEntityListing.md +2 -2
  132. data/docs/UserProfileEntityListing.md +2 -2
  133. data/docs/UserQueueEntityListing.md +2 -2
  134. data/docs/UserRecordingEntityListing.md +2 -2
  135. data/docs/UserSkillEntityListing.md +2 -2
  136. data/docs/VoicemailMessageEntityListing.md +2 -2
  137. data/docs/WebChatApi.md +535 -0
  138. data/docs/WebChatDeployment.md +19 -0
  139. data/docs/WebChatDeploymentEntityListing.md +15 -0
  140. data/docs/WebChatSettings.md +13 -0
  141. data/docs/WfmMoveAgentsCompleteNotification.md +15 -0
  142. data/docs/WfmMoveAgentsCompleteNotificationManagementUnit.md +13 -0
  143. data/docs/WfmMoveAgentsCompleteNotificationMoveAgentResults.md +14 -0
  144. data/docs/WfmMoveAgentsCompleteNotificationUser.md +13 -0
  145. data/docs/WfmMoveAgentsCompleteNotificationWfmMoveAgentData.md +14 -0
  146. data/docs/WfmUpdateAgentDetailsCompleteNotification.md +13 -0
  147. data/docs/WorkspaceEntityListing.md +2 -2
  148. data/docs/WorkspaceMemberEntityListing.md +2 -2
  149. data/docs/WrapupCodeEntityListing.md +2 -2
  150. data/lib/purecloudplatformclientv2.rb +15 -0
  151. data/lib/purecloudplatformclientv2/api/conversations_api.rb +4 -4
  152. data/lib/purecloudplatformclientv2/api/outbound_api.rb +13 -4
  153. data/lib/purecloudplatformclientv2/api/quality_api.rb +1652 -213
  154. data/lib/purecloudplatformclientv2/api/web_chat_api.rb +590 -0
  155. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  156. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +25 -25
  157. data/lib/purecloudplatformclientv2/models/agent_activity.rb +151 -1
  158. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +25 -25
  159. data/lib/purecloudplatformclientv2/models/analytics_session.rb +32 -4
  160. data/lib/purecloudplatformclientv2/models/analytics_session_metric.rb +269 -0
  161. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +25 -25
  162. data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +25 -25
  163. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +25 -25
  164. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +25 -25
  165. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +25 -25
  166. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +25 -25
  167. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +25 -25
  168. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +25 -25
  169. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +25 -25
  170. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +25 -25
  171. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +25 -25
  172. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +25 -25
  173. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +25 -25
  174. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +25 -25
  175. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +25 -25
  176. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +25 -25
  177. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +25 -25
  178. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +25 -25
  179. data/lib/purecloudplatformclientv2/models/contact_listing.rb +25 -25
  180. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +25 -25
  181. data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +2 -2
  182. data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +2 -2
  183. data/lib/purecloudplatformclientv2/models/create_activity_code_request.rb +15 -1
  184. data/lib/purecloudplatformclientv2/models/create_email_request.rb +4 -4
  185. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +25 -25
  186. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +25 -25
  187. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +25 -25
  188. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +25 -25
  189. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +25 -25
  190. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +25 -25
  191. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +25 -25
  192. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +25 -25
  193. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +25 -25
  194. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +25 -25
  195. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +25 -25
  196. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +25 -25
  197. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +25 -25
  198. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +428 -0
  199. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +25 -25
  200. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +25 -25
  201. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +25 -25
  202. data/lib/purecloudplatformclientv2/models/email.rb +2 -2
  203. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +25 -25
  204. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +25 -25
  205. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +25 -25
  206. data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +25 -25
  207. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +25 -25
  208. data/lib/purecloudplatformclientv2/models/evaluation_form.rb +1 -32
  209. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +25 -25
  210. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +25 -25
  211. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +25 -25
  212. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +25 -25
  213. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +25 -25
  214. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +25 -25
  215. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +25 -25
  216. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +25 -25
  217. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +25 -25
  218. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +25 -25
  219. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +25 -25
  220. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +25 -25
  221. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +25 -25
  222. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +25 -25
  223. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +25 -25
  224. data/lib/purecloudplatformclientv2/models/json_node.rb +17 -17
  225. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +25 -25
  226. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +25 -25
  227. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +25 -25
  228. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +25 -25
  229. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +25 -25
  230. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +25 -25
  231. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +25 -25
  232. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +25 -25
  233. data/lib/purecloudplatformclientv2/models/note_listing.rb +25 -25
  234. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +25 -25
  235. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +25 -25
  236. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +25 -25
  237. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +25 -25
  238. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +25 -25
  239. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +25 -25
  240. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +25 -25
  241. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +25 -25
  242. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +25 -25
  243. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +25 -25
  244. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +25 -25
  245. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +25 -25
  246. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +25 -25
  247. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +25 -25
  248. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +25 -25
  249. data/lib/purecloudplatformclientv2/models/publish_form.rb +238 -0
  250. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +25 -25
  251. data/lib/purecloudplatformclientv2/models/question.rb +67 -50
  252. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +25 -25
  253. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +25 -25
  254. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +25 -25
  255. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +25 -25
  256. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +25 -25
  257. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +25 -25
  258. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +25 -25
  259. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +25 -25
  260. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +25 -25
  261. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +25 -25
  262. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +25 -25
  263. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +25 -25
  264. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +25 -25
  265. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +25 -25
  266. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +25 -25
  267. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +25 -25
  268. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +25 -25
  269. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +25 -25
  270. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +25 -25
  271. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +25 -25
  272. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +25 -25
  273. data/lib/purecloudplatformclientv2/models/survey_form.rb +479 -0
  274. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +428 -0
  275. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +25 -25
  276. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +25 -25
  277. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +25 -25
  278. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +25 -25
  279. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +25 -25
  280. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +25 -25
  281. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +25 -25
  282. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +25 -25
  283. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +25 -25
  284. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +25 -25
  285. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +25 -25
  286. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +25 -25
  287. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +25 -25
  288. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +25 -25
  289. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +2 -2
  290. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +25 -25
  291. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +25 -25
  292. data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +354 -0
  293. data/lib/purecloudplatformclientv2/models/web_chat_deployment_entity_listing.rb +253 -0
  294. data/lib/purecloudplatformclientv2/models/web_chat_settings.rb +201 -0
  295. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification.rb +253 -0
  296. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification_management_unit.rb +201 -0
  297. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification_move_agent_results.rb +240 -0
  298. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification_user.rb +201 -0
  299. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification_wfm_move_agent_data.rb +240 -0
  300. data/lib/purecloudplatformclientv2/models/wfm_update_agent_details_complete_notification.rb +215 -0
  301. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +25 -25
  302. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +25 -25
  303. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +25 -25
  304. data/lib/purecloudplatformclientv2/version.rb +1 -1
  305. metadata +32 -2
data/docs/TrunkBaseEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: TrunkBaseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/TrunkEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: TrunkEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/TrunkMetabaseEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: TrunkMetabaseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/TrustEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: TrustEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/TrustUserEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: TrustUserEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/TrustorEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: TrustorEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/UserEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: UserEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/UserProfileEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: UserProfileEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/UserQueueEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: UserQueueEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/UserRecordingEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: UserRecordingEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/UserSkillEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: UserSkillEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/VoicemailMessageEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: VoicemailMessageEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/WebChatApi.md ADDED
@@ -0,0 +1,535 @@
1
+ ---
2
+ title: WebChatApi
3
+ ---
4
+
5
+ ## PureCloud::WebChatApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | Description
10
+ ------------- | ------------- | -------------
11
+ [**delete_webchat_deployment**](WebChatApi.html#delete_webchat_deployment) | Delete a WebChat deployment
12
+ [**delete_webchat_settings**](WebChatApi.html#delete_webchat_settings) | Remove WebChat deployment settings
13
+ [**get_webchat_deployment**](WebChatApi.html#get_webchat_deployment) | Get a WebChat deployment
14
+ [**get_webchat_deployments**](WebChatApi.html#get_webchat_deployments) | List WebChat deployments
15
+ [**get_webchat_settings**](WebChatApi.html#get_webchat_settings) | Get WebChat deployment settings
16
+ [**post_webchat_deployments**](WebChatApi.html#post_webchat_deployments) | Create WebChat deployment
17
+ [**post_webchat_settings**](WebChatApi.html#post_webchat_settings) | Create WebChat deployment settings
18
+ [**put_webchat_deployment**](WebChatApi.html#put_webchat_deployment) | Update a WebChat deployment
19
+ [**put_webchat_settings**](WebChatApi.html#put_webchat_settings) | Update WebChat deployment settings
20
+ {: class="table table-striped"}
21
+
22
+ <a name="delete_webchat_deployment"></a>
23
+
24
+ ## - delete_webchat_deployment(deployment_id)
25
+
26
+ Delete a WebChat deployment
27
+
28
+
29
+
30
+ Wraps DELETE /api/v2/webchat/deployments/{deploymentId}
31
+
32
+
33
+ ### Example
34
+ ~~~ruby
35
+ # load the gem
36
+ require 'purecloudplatformclientv2'
37
+ # setup authorization
38
+ @secret = ENV['PURECLOUD_SECRET']
39
+ @id = ENV['PURECLOUD_CLIENT_ID']
40
+ environment = "mypurecloud.com"
41
+
42
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
43
+
44
+ PureCloud.configure do |config|
45
+ config.access_token = @authToken
46
+ end
47
+
48
+ api_instance = PureCloud::WebChatApi.new
49
+
50
+ deployment_id = "deployment_id_example" # String | Deployment Id
51
+
52
+
53
+ begin
54
+ #Delete a WebChat deployment
55
+ api_instance.delete_webchat_deployment(deployment_id)
56
+ rescue PureCloud::ApiError => e
57
+ puts "Exception when calling WebChatApi->delete_webchat_deployment: #{e}"
58
+ end
59
+ ~~~
60
+
61
+ ### Parameters
62
+
63
+ Name | Type | Description | Notes
64
+ ------------- | ------------- | ------------- | -------------
65
+ **deployment_id** | **String**| Deployment Id | |
66
+ {: class="table table-striped"}
67
+
68
+
69
+ ### Return type
70
+
71
+ nil (empty response body)
72
+
73
+ ### HTTP request headers
74
+
75
+ - **Content-Type**: application/json
76
+ - **Accept**: application/json
77
+
78
+
79
+
80
+ <a name="delete_webchat_settings"></a>
81
+
82
+ ## - delete_webchat_settings
83
+
84
+ Remove WebChat deployment settings
85
+
86
+
87
+
88
+ Wraps DELETE /api/v2/webchat/settings
89
+
90
+
91
+ ### Example
92
+ ~~~ruby
93
+ # load the gem
94
+ require 'purecloudplatformclientv2'
95
+ # setup authorization
96
+ @secret = ENV['PURECLOUD_SECRET']
97
+ @id = ENV['PURECLOUD_CLIENT_ID']
98
+ environment = "mypurecloud.com"
99
+
100
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
101
+
102
+ PureCloud.configure do |config|
103
+ config.access_token = @authToken
104
+ end
105
+
106
+ api_instance = PureCloud::WebChatApi.new
107
+
108
+ begin
109
+ #Remove WebChat deployment settings
110
+ api_instance.delete_webchat_settings
111
+ rescue PureCloud::ApiError => e
112
+ puts "Exception when calling WebChatApi->delete_webchat_settings: #{e}"
113
+ end
114
+ ~~~
115
+
116
+ ### Parameters
117
+ This endpoint does not need any parameter.
118
+ {: class="table table-striped"}
119
+
120
+
121
+ ### Return type
122
+
123
+ nil (empty response body)
124
+
125
+ ### HTTP request headers
126
+
127
+ - **Content-Type**: application/json
128
+ - **Accept**: application/json
129
+
130
+
131
+
132
+ <a name="get_webchat_deployment"></a>
133
+
134
+ ## -[**WebChatDeployment**](WebChatDeployment.html) get_webchat_deployment(deployment_id)
135
+
136
+ Get a WebChat deployment
137
+
138
+
139
+
140
+ Wraps GET /api/v2/webchat/deployments/{deploymentId}
141
+
142
+
143
+ ### Example
144
+ ~~~ruby
145
+ # load the gem
146
+ require 'purecloudplatformclientv2'
147
+ # setup authorization
148
+ @secret = ENV['PURECLOUD_SECRET']
149
+ @id = ENV['PURECLOUD_CLIENT_ID']
150
+ environment = "mypurecloud.com"
151
+
152
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
153
+
154
+ PureCloud.configure do |config|
155
+ config.access_token = @authToken
156
+ end
157
+
158
+ api_instance = PureCloud::WebChatApi.new
159
+
160
+ deployment_id = "deployment_id_example" # String | Deployment Id
161
+
162
+
163
+ begin
164
+ #Get a WebChat deployment
165
+ result = api_instance.get_webchat_deployment(deployment_id)
166
+ p result
167
+ rescue PureCloud::ApiError => e
168
+ puts "Exception when calling WebChatApi->get_webchat_deployment: #{e}"
169
+ end
170
+ ~~~
171
+
172
+ ### Parameters
173
+
174
+ Name | Type | Description | Notes
175
+ ------------- | ------------- | ------------- | -------------
176
+ **deployment_id** | **String**| Deployment Id | |
177
+ {: class="table table-striped"}
178
+
179
+
180
+ ### Return type
181
+
182
+ [**WebChatDeployment**](WebChatDeployment.html)
183
+
184
+ ### HTTP request headers
185
+
186
+ - **Content-Type**: application/json
187
+ - **Accept**: application/json
188
+
189
+
190
+
191
+ <a name="get_webchat_deployments"></a>
192
+
193
+ ## -[**WebChatDeploymentEntityListing**](WebChatDeploymentEntityListing.html) get_webchat_deployments
194
+
195
+ List WebChat deployments
196
+
197
+
198
+
199
+ Wraps GET /api/v2/webchat/deployments
200
+
201
+
202
+ ### Example
203
+ ~~~ruby
204
+ # load the gem
205
+ require 'purecloudplatformclientv2'
206
+ # setup authorization
207
+ @secret = ENV['PURECLOUD_SECRET']
208
+ @id = ENV['PURECLOUD_CLIENT_ID']
209
+ environment = "mypurecloud.com"
210
+
211
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
212
+
213
+ PureCloud.configure do |config|
214
+ config.access_token = @authToken
215
+ end
216
+
217
+ api_instance = PureCloud::WebChatApi.new
218
+
219
+ begin
220
+ #List WebChat deployments
221
+ result = api_instance.get_webchat_deployments
222
+ p result
223
+ rescue PureCloud::ApiError => e
224
+ puts "Exception when calling WebChatApi->get_webchat_deployments: #{e}"
225
+ end
226
+ ~~~
227
+
228
+ ### Parameters
229
+ This endpoint does not need any parameter.
230
+ {: class="table table-striped"}
231
+
232
+
233
+ ### Return type
234
+
235
+ [**WebChatDeploymentEntityListing**](WebChatDeploymentEntityListing.html)
236
+
237
+ ### HTTP request headers
238
+
239
+ - **Content-Type**: application/json
240
+ - **Accept**: application/json
241
+
242
+
243
+
244
+ <a name="get_webchat_settings"></a>
245
+
246
+ ## -[**WebChatSettings**](WebChatSettings.html) get_webchat_settings
247
+
248
+ Get WebChat deployment settings
249
+
250
+
251
+
252
+ Wraps GET /api/v2/webchat/settings
253
+
254
+
255
+ ### Example
256
+ ~~~ruby
257
+ # load the gem
258
+ require 'purecloudplatformclientv2'
259
+ # setup authorization
260
+ @secret = ENV['PURECLOUD_SECRET']
261
+ @id = ENV['PURECLOUD_CLIENT_ID']
262
+ environment = "mypurecloud.com"
263
+
264
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
265
+
266
+ PureCloud.configure do |config|
267
+ config.access_token = @authToken
268
+ end
269
+
270
+ api_instance = PureCloud::WebChatApi.new
271
+
272
+ begin
273
+ #Get WebChat deployment settings
274
+ result = api_instance.get_webchat_settings
275
+ p result
276
+ rescue PureCloud::ApiError => e
277
+ puts "Exception when calling WebChatApi->get_webchat_settings: #{e}"
278
+ end
279
+ ~~~
280
+
281
+ ### Parameters
282
+ This endpoint does not need any parameter.
283
+ {: class="table table-striped"}
284
+
285
+
286
+ ### Return type
287
+
288
+ [**WebChatSettings**](WebChatSettings.html)
289
+
290
+ ### HTTP request headers
291
+
292
+ - **Content-Type**: application/json
293
+ - **Accept**: application/json
294
+
295
+
296
+
297
+ <a name="post_webchat_deployments"></a>
298
+
299
+ ## -[**WebChatDeployment**](WebChatDeployment.html) post_webchat_deployments(body)
300
+
301
+ Create WebChat deployment
302
+
303
+
304
+
305
+ Wraps POST /api/v2/webchat/deployments
306
+
307
+
308
+ ### Example
309
+ ~~~ruby
310
+ # load the gem
311
+ require 'purecloudplatformclientv2'
312
+ # setup authorization
313
+ @secret = ENV['PURECLOUD_SECRET']
314
+ @id = ENV['PURECLOUD_CLIENT_ID']
315
+ environment = "mypurecloud.com"
316
+
317
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
318
+
319
+ PureCloud.configure do |config|
320
+ config.access_token = @authToken
321
+ end
322
+
323
+ api_instance = PureCloud::WebChatApi.new
324
+
325
+ body = PureCloud::WebChatDeployment.new # WebChatDeployment | Deployment
326
+
327
+
328
+ begin
329
+ #Create WebChat deployment
330
+ result = api_instance.post_webchat_deployments(body)
331
+ p result
332
+ rescue PureCloud::ApiError => e
333
+ puts "Exception when calling WebChatApi->post_webchat_deployments: #{e}"
334
+ end
335
+ ~~~
336
+
337
+ ### Parameters
338
+
339
+ Name | Type | Description | Notes
340
+ ------------- | ------------- | ------------- | -------------
341
+ **body** | [**WebChatDeployment**](WebChatDeployment.html)| Deployment | |
342
+ {: class="table table-striped"}
343
+
344
+
345
+ ### Return type
346
+
347
+ [**WebChatDeployment**](WebChatDeployment.html)
348
+
349
+ ### HTTP request headers
350
+
351
+ - **Content-Type**: application/json
352
+ - **Accept**: application/json
353
+
354
+
355
+
356
+ <a name="post_webchat_settings"></a>
357
+
358
+ ## -[**WebChatSettings**](WebChatSettings.html) post_webchat_settings(body)
359
+
360
+ Create WebChat deployment settings
361
+
362
+
363
+
364
+ Wraps POST /api/v2/webchat/settings
365
+
366
+
367
+ ### Example
368
+ ~~~ruby
369
+ # load the gem
370
+ require 'purecloudplatformclientv2'
371
+ # setup authorization
372
+ @secret = ENV['PURECLOUD_SECRET']
373
+ @id = ENV['PURECLOUD_CLIENT_ID']
374
+ environment = "mypurecloud.com"
375
+
376
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
377
+
378
+ PureCloud.configure do |config|
379
+ config.access_token = @authToken
380
+ end
381
+
382
+ api_instance = PureCloud::WebChatApi.new
383
+
384
+ body = PureCloud::WebChatSettings.new # WebChatSettings | webChatSettings
385
+
386
+
387
+ begin
388
+ #Create WebChat deployment settings
389
+ result = api_instance.post_webchat_settings(body)
390
+ p result
391
+ rescue PureCloud::ApiError => e
392
+ puts "Exception when calling WebChatApi->post_webchat_settings: #{e}"
393
+ end
394
+ ~~~
395
+
396
+ ### Parameters
397
+
398
+ Name | Type | Description | Notes
399
+ ------------- | ------------- | ------------- | -------------
400
+ **body** | [**WebChatSettings**](WebChatSettings.html)| webChatSettings | |
401
+ {: class="table table-striped"}
402
+
403
+
404
+ ### Return type
405
+
406
+ [**WebChatSettings**](WebChatSettings.html)
407
+
408
+ ### HTTP request headers
409
+
410
+ - **Content-Type**: application/json
411
+ - **Accept**: application/json
412
+
413
+
414
+
415
+ <a name="put_webchat_deployment"></a>
416
+
417
+ ## -[**WebChatDeployment**](WebChatDeployment.html) put_webchat_deployment(deployment_id, body)
418
+
419
+ Update a WebChat deployment
420
+
421
+
422
+
423
+ Wraps PUT /api/v2/webchat/deployments/{deploymentId}
424
+
425
+
426
+ ### Example
427
+ ~~~ruby
428
+ # load the gem
429
+ require 'purecloudplatformclientv2'
430
+ # setup authorization
431
+ @secret = ENV['PURECLOUD_SECRET']
432
+ @id = ENV['PURECLOUD_CLIENT_ID']
433
+ environment = "mypurecloud.com"
434
+
435
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
436
+
437
+ PureCloud.configure do |config|
438
+ config.access_token = @authToken
439
+ end
440
+
441
+ api_instance = PureCloud::WebChatApi.new
442
+
443
+ deployment_id = "deployment_id_example" # String | Deployment Id
444
+
445
+ body = PureCloud::WebChatDeployment.new # WebChatDeployment | Deployment
446
+
447
+
448
+ begin
449
+ #Update a WebChat deployment
450
+ result = api_instance.put_webchat_deployment(deployment_id, body)
451
+ p result
452
+ rescue PureCloud::ApiError => e
453
+ puts "Exception when calling WebChatApi->put_webchat_deployment: #{e}"
454
+ end
455
+ ~~~
456
+
457
+ ### Parameters
458
+
459
+ Name | Type | Description | Notes
460
+ ------------- | ------------- | ------------- | -------------
461
+ **deployment_id** | **String**| Deployment Id | |
462
+ **body** | [**WebChatDeployment**](WebChatDeployment.html)| Deployment | |
463
+ {: class="table table-striped"}
464
+
465
+
466
+ ### Return type
467
+
468
+ [**WebChatDeployment**](WebChatDeployment.html)
469
+
470
+ ### HTTP request headers
471
+
472
+ - **Content-Type**: application/json
473
+ - **Accept**: application/json
474
+
475
+
476
+
477
+ <a name="put_webchat_settings"></a>
478
+
479
+ ## -[**WebChatSettings**](WebChatSettings.html) put_webchat_settings(body)
480
+
481
+ Update WebChat deployment settings
482
+
483
+
484
+
485
+ Wraps PUT /api/v2/webchat/settings
486
+
487
+
488
+ ### Example
489
+ ~~~ruby
490
+ # load the gem
491
+ require 'purecloudplatformclientv2'
492
+ # setup authorization
493
+ @secret = ENV['PURECLOUD_SECRET']
494
+ @id = ENV['PURECLOUD_CLIENT_ID']
495
+ environment = "mypurecloud.com"
496
+
497
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
498
+
499
+ PureCloud.configure do |config|
500
+ config.access_token = @authToken
501
+ end
502
+
503
+ api_instance = PureCloud::WebChatApi.new
504
+
505
+ body = PureCloud::WebChatSettings.new # WebChatSettings | webChatSettings
506
+
507
+
508
+ begin
509
+ #Update WebChat deployment settings
510
+ result = api_instance.put_webchat_settings(body)
511
+ p result
512
+ rescue PureCloud::ApiError => e
513
+ puts "Exception when calling WebChatApi->put_webchat_settings: #{e}"
514
+ end
515
+ ~~~
516
+
517
+ ### Parameters
518
+
519
+ Name | Type | Description | Notes
520
+ ------------- | ------------- | ------------- | -------------
521
+ **body** | [**WebChatSettings**](WebChatSettings.html)| webChatSettings | |
522
+ {: class="table table-striped"}
523
+
524
+
525
+ ### Return type
526
+
527
+ [**WebChatSettings**](WebChatSettings.html)
528
+
529
+ ### HTTP request headers
530
+
531
+ - **Content-Type**: application/json
532
+ - **Accept**: application/json
533
+
534
+
535
+