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
@@ -11,11 +11,11 @@ title: PhoneMetaBaseEntityListing
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
 
@@ -11,11 +11,11 @@ title: PhysicalInterfaceEntityListing
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
 
@@ -11,11 +11,11 @@ title: PolicyEntityListing
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
 
@@ -11,11 +11,11 @@ title: PromptAssetEntityListing
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
 
@@ -11,11 +11,11 @@ title: PromptEntityListing
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
 
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: PublishForm
3
+ ---
4
+ ## PureCloud::PublishForm
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **published** | **BOOLEAN** | Is this form published | |
11
+ | **context_id** | **String** | Unique Id for all versions of this form | |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -11,6 +11,8 @@ Method | Description
11
11
  [**delete_quality_calibration**](QualityApi.html#delete_quality_calibration) | Delete a calibration by id.
12
12
  [**delete_quality_conversation_evaluation**](QualityApi.html#delete_quality_conversation_evaluation) | Delete an evaluation
13
13
  [**delete_quality_form**](QualityApi.html#delete_quality_form) | Delete an evaluation form.
14
+ [**delete_quality_forms_evaluation**](QualityApi.html#delete_quality_forms_evaluation) | Delete an evaluation form.
15
+ [**delete_quality_forms_survey**](QualityApi.html#delete_quality_forms_survey) | Delete a survey form.
14
16
  [**delete_quality_keywordset**](QualityApi.html#delete_quality_keywordset) | Delete a keywordSet by id.
15
17
  [**delete_quality_keywordsets**](QualityApi.html#delete_quality_keywordsets) | Delete keyword sets
16
18
  [**get_quality_agents_activity**](QualityApi.html#get_quality_agents_activity) | Gets a list of Agent Activities
@@ -23,21 +25,38 @@ Method | Description
23
25
  [**get_quality_form**](QualityApi.html#get_quality_form) | Get an evaluation form
24
26
  [**get_quality_form_versions**](QualityApi.html#get_quality_form_versions) | Gets all the revisions for a specific evaluation.
25
27
  [**get_quality_forms**](QualityApi.html#get_quality_forms) | Get the list of evaluation forms
28
+ [**get_quality_forms_evaluation**](QualityApi.html#get_quality_forms_evaluation) | Get an evaluation form
29
+ [**get_quality_forms_evaluation_versions**](QualityApi.html#get_quality_forms_evaluation_versions) | Gets all the revisions for a specific evaluation.
30
+ [**get_quality_forms_evaluations**](QualityApi.html#get_quality_forms_evaluations) | Get the list of evaluation forms
31
+ [**get_quality_forms_survey**](QualityApi.html#get_quality_forms_survey) | Get a survey form
32
+ [**get_quality_forms_survey_versions**](QualityApi.html#get_quality_forms_survey_versions) | Gets all the revisions for a specific survey.
33
+ [**get_quality_forms_surveys**](QualityApi.html#get_quality_forms_surveys) | Get the list of survey forms
26
34
  [**get_quality_keywordset**](QualityApi.html#get_quality_keywordset) | Get a keywordSet by id.
27
35
  [**get_quality_keywordsets**](QualityApi.html#get_quality_keywordsets) | Get the list of keyword sets
28
36
  [**get_quality_publishedform**](QualityApi.html#get_quality_publishedform) | Get the published evaluation forms.
29
37
  [**get_quality_publishedforms**](QualityApi.html#get_quality_publishedforms) | Get the published evaluation forms.
38
+ [**get_quality_publishedforms_evaluation**](QualityApi.html#get_quality_publishedforms_evaluation) | Get the most recent published version of an evaluation form.
39
+ [**get_quality_publishedforms_evaluations**](QualityApi.html#get_quality_publishedforms_evaluations) | Get the published evaluation forms.
40
+ [**get_quality_publishedforms_survey**](QualityApi.html#get_quality_publishedforms_survey) | Get the most recent published version of a survey form.
41
+ [**get_quality_publishedforms_surveys**](QualityApi.html#get_quality_publishedforms_surveys) | Get the published survey forms.
42
+ [**patch_quality_forms_survey**](QualityApi.html#patch_quality_forms_survey) | Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.
30
43
  [**post_analytics_evaluations_aggregates_query**](QualityApi.html#post_analytics_evaluations_aggregates_query) | Query for evaluation aggregates
31
44
  [**post_quality_calibrations**](QualityApi.html#post_quality_calibrations) | Create a calibration
32
45
  [**post_quality_conversation_evaluations**](QualityApi.html#post_quality_conversation_evaluations) | Create an evaluation
33
46
  [**post_quality_evaluations_scoring**](QualityApi.html#post_quality_evaluations_scoring) | Score evaluation
34
47
  [**post_quality_forms**](QualityApi.html#post_quality_forms) | Create an evaluation form.
48
+ [**post_quality_forms_evaluations**](QualityApi.html#post_quality_forms_evaluations) | Create an evaluation form.
49
+ [**post_quality_forms_surveys**](QualityApi.html#post_quality_forms_surveys) | Create a survey form.
35
50
  [**post_quality_keywordsets**](QualityApi.html#post_quality_keywordsets) | Create a Keyword Set
36
51
  [**post_quality_publishedforms**](QualityApi.html#post_quality_publishedforms) | Publish an evaluation form.
52
+ [**post_quality_publishedforms_evaluations**](QualityApi.html#post_quality_publishedforms_evaluations) | Publish an evaluation form.
53
+ [**post_quality_publishedforms_surveys**](QualityApi.html#post_quality_publishedforms_surveys) | Publish a survey form.
37
54
  [**post_quality_spotability**](QualityApi.html#post_quality_spotability) | Retrieve the spotability statistic
38
55
  [**put_quality_calibration**](QualityApi.html#put_quality_calibration) | Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
39
56
  [**put_quality_conversation_evaluation**](QualityApi.html#put_quality_conversation_evaluation) | Update an evaluation
40
57
  [**put_quality_form**](QualityApi.html#put_quality_form) | Update an evaluation form.
58
+ [**put_quality_forms_evaluation**](QualityApi.html#put_quality_forms_evaluation) | Update an evaluation form.
59
+ [**put_quality_forms_survey**](QualityApi.html#put_quality_forms_survey) | Update a survey form.
41
60
  [**put_quality_keywordset**](QualityApi.html#put_quality_keywordset) | Update a keywordSet to the specified keywordSet via PUT.
42
61
  {: class="table table-striped"}
43
62
 
@@ -227,6 +246,122 @@ nil (empty response body)
227
246
 
228
247
 
229
248
 
249
+ <a name="delete_quality_forms_evaluation"></a>
250
+
251
+ ## - delete_quality_forms_evaluation(form_id)
252
+
253
+ Delete an evaluation form.
254
+
255
+
256
+
257
+ Wraps DELETE /api/v2/quality/forms/evaluations/{formId}
258
+
259
+
260
+ ### Example
261
+ ~~~ruby
262
+ # load the gem
263
+ require 'purecloudplatformclientv2'
264
+ # setup authorization
265
+ @secret = ENV['PURECLOUD_SECRET']
266
+ @id = ENV['PURECLOUD_CLIENT_ID']
267
+ environment = "mypurecloud.com"
268
+
269
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
270
+
271
+ PureCloud.configure do |config|
272
+ config.access_token = @authToken
273
+ end
274
+
275
+ api_instance = PureCloud::QualityApi.new
276
+
277
+ form_id = "form_id_example" # String | Form ID
278
+
279
+
280
+ begin
281
+ #Delete an evaluation form.
282
+ api_instance.delete_quality_forms_evaluation(form_id)
283
+ rescue PureCloud::ApiError => e
284
+ puts "Exception when calling QualityApi->delete_quality_forms_evaluation: #{e}"
285
+ end
286
+ ~~~
287
+
288
+ ### Parameters
289
+
290
+ Name | Type | Description | Notes
291
+ ------------- | ------------- | ------------- | -------------
292
+ **form_id** | **String**| Form ID | |
293
+ {: class="table table-striped"}
294
+
295
+
296
+ ### Return type
297
+
298
+ nil (empty response body)
299
+
300
+ ### HTTP request headers
301
+
302
+ - **Content-Type**: application/json
303
+ - **Accept**: application/json
304
+
305
+
306
+
307
+ <a name="delete_quality_forms_survey"></a>
308
+
309
+ ## - delete_quality_forms_survey(form_id)
310
+
311
+ Delete a survey form.
312
+
313
+
314
+
315
+ Wraps DELETE /api/v2/quality/forms/surveys/{formId}
316
+
317
+
318
+ ### Example
319
+ ~~~ruby
320
+ # load the gem
321
+ require 'purecloudplatformclientv2'
322
+ # setup authorization
323
+ @secret = ENV['PURECLOUD_SECRET']
324
+ @id = ENV['PURECLOUD_CLIENT_ID']
325
+ environment = "mypurecloud.com"
326
+
327
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
328
+
329
+ PureCloud.configure do |config|
330
+ config.access_token = @authToken
331
+ end
332
+
333
+ api_instance = PureCloud::QualityApi.new
334
+
335
+ form_id = "form_id_example" # String | Form ID
336
+
337
+
338
+ begin
339
+ #Delete a survey form.
340
+ api_instance.delete_quality_forms_survey(form_id)
341
+ rescue PureCloud::ApiError => e
342
+ puts "Exception when calling QualityApi->delete_quality_forms_survey: #{e}"
343
+ end
344
+ ~~~
345
+
346
+ ### Parameters
347
+
348
+ Name | Type | Description | Notes
349
+ ------------- | ------------- | ------------- | -------------
350
+ **form_id** | **String**| Form ID | |
351
+ {: class="table table-striped"}
352
+
353
+
354
+ ### Return type
355
+
356
+ nil (empty response body)
357
+
358
+ ### HTTP request headers
359
+
360
+ - **Content-Type**: application/json
361
+ - **Accept**: application/json
362
+
363
+
364
+
230
365
  <a name="delete_quality_keywordset"></a>
231
366
 
232
367
  ## - delete_quality_keywordset(keyword_set_id)
@@ -1082,15 +1217,15 @@ Name | Type | Description | Notes
1082
1217
 
1083
1218
 
1084
1219
 
1085
- <a name="get_quality_keywordset"></a>
1220
+ <a name="get_quality_forms_evaluation"></a>
1086
1221
 
1087
- ## -[**KeywordSet**](KeywordSet.html) get_quality_keywordset(keyword_set_id)
1222
+ ## -[**EvaluationForm**](EvaluationForm.html) get_quality_forms_evaluation(form_id)
1088
1223
 
1089
- Get a keywordSet by id.
1224
+ Get an evaluation form
1090
1225
 
1091
1226
 
1092
1227
 
1093
- Wraps GET /api/v2/quality/keywordsets/{keywordSetId}
1228
+ Wraps GET /api/v2/quality/forms/evaluations/{formId}
1094
1229
 
1095
1230
 
1096
1231
  ### Example
@@ -1110,15 +1245,15 @@ end
1110
1245
 
1111
1246
  api_instance = PureCloud::QualityApi.new
1112
1247
 
1113
- keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID
1248
+ form_id = "form_id_example" # String | Form ID
1114
1249
 
1115
1250
 
1116
1251
  begin
1117
- #Get a keywordSet by id.
1118
- result = api_instance.get_quality_keywordset(keyword_set_id)
1252
+ #Get an evaluation form
1253
+ result = api_instance.get_quality_forms_evaluation(form_id)
1119
1254
  p result
1120
1255
  rescue PureCloud::ApiError => e
1121
- puts "Exception when calling QualityApi->get_quality_keywordset: #{e}"
1256
+ puts "Exception when calling QualityApi->get_quality_forms_evaluation: #{e}"
1122
1257
  end
1123
1258
  ~~~
1124
1259
 
@@ -1126,13 +1261,13 @@ end
1126
1261
 
1127
1262
  Name | Type | Description | Notes
1128
1263
  ------------- | ------------- | ------------- | -------------
1129
- **keyword_set_id** | **String**| KeywordSet ID | |
1264
+ **form_id** | **String**| Form ID | |
1130
1265
  {: class="table table-striped"}
1131
1266
 
1132
1267
 
1133
1268
  ### Return type
1134
1269
 
1135
- [**KeywordSet**](KeywordSet.html)
1270
+ [**EvaluationForm**](EvaluationForm.html)
1136
1271
 
1137
1272
  ### HTTP request headers
1138
1273
 
@@ -1141,15 +1276,15 @@ Name | Type | Description | Notes
1141
1276
 
1142
1277
 
1143
1278
 
1144
- <a name="get_quality_keywordsets"></a>
1279
+ <a name="get_quality_forms_evaluation_versions"></a>
1145
1280
 
1146
- ## -[**KeywordSetEntityListing**](KeywordSetEntityListing.html) get_quality_keywordsets(opts)
1281
+ ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_forms_evaluation_versions(form_id, opts)
1147
1282
 
1148
- Get the list of keyword sets
1283
+ Gets all the revisions for a specific evaluation.
1149
1284
 
1150
1285
 
1151
1286
 
1152
- Wraps GET /api/v2/quality/keywordsets
1287
+ Wraps GET /api/v2/quality/forms/evaluations/{formId}/versions
1153
1288
 
1154
1289
 
1155
1290
  ### Example
@@ -1169,25 +1304,19 @@ end
1169
1304
 
1170
1305
  api_instance = PureCloud::QualityApi.new
1171
1306
 
1307
+ form_id = "form_id_example" # String | Form ID
1308
+
1172
1309
  opts = {
1173
- page_size: 25, # Integer | The total page size requested
1174
- page_number: 1, # Integer | The page number requested
1175
- sort_by: "sort_by_example", # String | variable name requested to sort by
1176
- expand: nil, # Array<Object> | variable name requested by expand list
1177
- next_page: "next_page_example", # String | next page token
1178
- previous_page: "previous_page_example", # String | Previous page token
1179
- name: "name_example", # String | the keyword set name - used for filtering results in searches.
1180
- queue_id: "queue_id_example", # String | the queue id - used for filtering results in searches.
1181
- agent_id: "agent_id_example", # String | the agent id - used for filtering results in searches.
1182
- operator: "operator_example" # String | If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.
1310
+ page_size: 25, # Integer | Page size
1311
+ page_number: 1 # Integer | Page number
1183
1312
  }
1184
1313
 
1185
1314
  begin
1186
- #Get the list of keyword sets
1187
- result = api_instance.get_quality_keywordsets(opts)
1315
+ #Gets all the revisions for a specific evaluation.
1316
+ result = api_instance.get_quality_forms_evaluation_versions(form_id, opts)
1188
1317
  p result
1189
1318
  rescue PureCloud::ApiError => e
1190
- puts "Exception when calling QualityApi->get_quality_keywordsets: #{e}"
1319
+ puts "Exception when calling QualityApi->get_quality_forms_evaluation_versions: #{e}"
1191
1320
  end
1192
1321
  ~~~
1193
1322
 
@@ -1195,22 +1324,15 @@ end
1195
1324
 
1196
1325
  Name | Type | Description | Notes
1197
1326
  ------------- | ------------- | ------------- | -------------
1198
- **page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
1199
- **page_number** | **Integer**| The page number requested | [optional] [default to 1] |
1200
- **sort_by** | **String**| variable name requested to sort by | [optional] |
1201
- **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional] |
1202
- **next_page** | **String**| next page token | [optional] |
1203
- **previous_page** | **String**| Previous page token | [optional] |
1204
- **name** | **String**| the keyword set name - used for filtering results in searches. | [optional] |
1205
- **queue_id** | **String**| the queue id - used for filtering results in searches. | [optional] |
1206
- **agent_id** | **String**| the agent id - used for filtering results in searches. | [optional] |
1207
- **operator** | **String**| If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters. | [optional] <br />**Values**: AND, OR |
1327
+ **form_id** | **String**| Form ID | |
1328
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
1329
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1208
1330
  {: class="table table-striped"}
1209
1331
 
1210
1332
 
1211
1333
  ### Return type
1212
1334
 
1213
- [**KeywordSetEntityListing**](KeywordSetEntityListing.html)
1335
+ [**EvaluationFormEntityListing**](EvaluationFormEntityListing.html)
1214
1336
 
1215
1337
  ### HTTP request headers
1216
1338
 
@@ -1219,15 +1341,15 @@ Name | Type | Description | Notes
1219
1341
 
1220
1342
 
1221
1343
 
1222
- <a name="get_quality_publishedform"></a>
1344
+ <a name="get_quality_forms_evaluations"></a>
1223
1345
 
1224
- ## -[**EvaluationForm**](EvaluationForm.html) get_quality_publishedform(form_id)
1346
+ ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_forms_evaluations(opts)
1225
1347
 
1226
- Get the published evaluation forms.
1348
+ Get the list of evaluation forms
1227
1349
 
1228
1350
 
1229
1351
 
1230
- Wraps GET /api/v2/quality/publishedforms/{formId}
1352
+ Wraps GET /api/v2/quality/forms/evaluations
1231
1353
 
1232
1354
 
1233
1355
  ### Example
@@ -1247,15 +1369,22 @@ end
1247
1369
 
1248
1370
  api_instance = PureCloud::QualityApi.new
1249
1371
 
1250
- form_id = "form_id_example" # String | Form ID
1251
-
1372
+ opts = {
1373
+ page_size: 25, # Integer | The total page size requested
1374
+ page_number: 1, # Integer | The page number requested
1375
+ sort_by: "sort_by_example", # String | variable name requested to sort by
1376
+ next_page: "next_page_example", # String | next page token
1377
+ previous_page: "previous_page_example", # String | Previous page token
1378
+ expand: "expand_example", # String | Expand
1379
+ name: "name_example" # String | Name
1380
+ }
1252
1381
 
1253
1382
  begin
1254
- #Get the published evaluation forms.
1255
- result = api_instance.get_quality_publishedform(form_id)
1383
+ #Get the list of evaluation forms
1384
+ result = api_instance.get_quality_forms_evaluations(opts)
1256
1385
  p result
1257
1386
  rescue PureCloud::ApiError => e
1258
- puts "Exception when calling QualityApi->get_quality_publishedform: #{e}"
1387
+ puts "Exception when calling QualityApi->get_quality_forms_evaluations: #{e}"
1259
1388
  end
1260
1389
  ~~~
1261
1390
 
@@ -1263,13 +1392,19 @@ end
1263
1392
 
1264
1393
  Name | Type | Description | Notes
1265
1394
  ------------- | ------------- | ------------- | -------------
1266
- **form_id** | **String**| Form ID | |
1395
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
1396
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1] |
1397
+ **sort_by** | **String**| variable name requested to sort by | [optional] |
1398
+ **next_page** | **String**| next page token | [optional] |
1399
+ **previous_page** | **String**| Previous page token | [optional] |
1400
+ **expand** | **String**| Expand | [optional] |
1401
+ **name** | **String**| Name | [optional] |
1267
1402
  {: class="table table-striped"}
1268
1403
 
1269
1404
 
1270
1405
  ### Return type
1271
1406
 
1272
- [**EvaluationForm**](EvaluationForm.html)
1407
+ [**EvaluationFormEntityListing**](EvaluationFormEntityListing.html)
1273
1408
 
1274
1409
  ### HTTP request headers
1275
1410
 
@@ -1278,15 +1413,15 @@ Name | Type | Description | Notes
1278
1413
 
1279
1414
 
1280
1415
 
1281
- <a name="get_quality_publishedforms"></a>
1416
+ <a name="get_quality_forms_survey"></a>
1282
1417
 
1283
- ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_publishedforms(opts)
1418
+ ## -[**SurveyForm**](SurveyForm.html) get_quality_forms_survey(form_id)
1284
1419
 
1285
- Get the published evaluation forms.
1420
+ Get a survey form
1286
1421
 
1287
1422
 
1288
1423
 
1289
- Wraps GET /api/v2/quality/publishedforms
1424
+ Wraps GET /api/v2/quality/forms/surveys/{formId}
1290
1425
 
1291
1426
 
1292
1427
  ### Example
@@ -1306,18 +1441,15 @@ end
1306
1441
 
1307
1442
  api_instance = PureCloud::QualityApi.new
1308
1443
 
1309
- opts = {
1310
- page_size: 25, # Integer | Page size
1311
- page_number: 1, # Integer | Page number
1312
- name: "name_example" # String | Name
1313
- }
1444
+ form_id = "form_id_example" # String | Form ID
1445
+
1314
1446
 
1315
1447
  begin
1316
- #Get the published evaluation forms.
1317
- result = api_instance.get_quality_publishedforms(opts)
1448
+ #Get a survey form
1449
+ result = api_instance.get_quality_forms_survey(form_id)
1318
1450
  p result
1319
1451
  rescue PureCloud::ApiError => e
1320
- puts "Exception when calling QualityApi->get_quality_publishedforms: #{e}"
1452
+ puts "Exception when calling QualityApi->get_quality_forms_survey: #{e}"
1321
1453
  end
1322
1454
  ~~~
1323
1455
 
@@ -1325,15 +1457,13 @@ end
1325
1457
 
1326
1458
  Name | Type | Description | Notes
1327
1459
  ------------- | ------------- | ------------- | -------------
1328
- **page_size** | **Integer**| Page size | [optional] [default to 25] |
1329
- **page_number** | **Integer**| Page number | [optional] [default to 1] |
1330
- **name** | **String**| Name | [optional] |
1460
+ **form_id** | **String**| Form ID | |
1331
1461
  {: class="table table-striped"}
1332
1462
 
1333
1463
 
1334
1464
  ### Return type
1335
1465
 
1336
- [**EvaluationFormEntityListing**](EvaluationFormEntityListing.html)
1466
+ [**SurveyForm**](SurveyForm.html)
1337
1467
 
1338
1468
  ### HTTP request headers
1339
1469
 
@@ -1342,15 +1472,15 @@ Name | Type | Description | Notes
1342
1472
 
1343
1473
 
1344
1474
 
1345
- <a name="post_analytics_evaluations_aggregates_query"></a>
1475
+ <a name="get_quality_forms_survey_versions"></a>
1346
1476
 
1347
- ## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_evaluations_aggregates_query(body)
1477
+ ## -[**SurveyFormEntityListing**](SurveyFormEntityListing.html) get_quality_forms_survey_versions(form_id, opts)
1348
1478
 
1349
- Query for evaluation aggregates
1479
+ Gets all the revisions for a specific survey.
1350
1480
 
1351
1481
 
1352
1482
 
1353
- Wraps POST /api/v2/analytics/evaluations/aggregates/query
1483
+ Wraps GET /api/v2/quality/forms/surveys/{formId}/versions
1354
1484
 
1355
1485
 
1356
1486
  ### Example
@@ -1370,15 +1500,19 @@ end
1370
1500
 
1371
1501
  api_instance = PureCloud::QualityApi.new
1372
1502
 
1373
- body = PureCloud::AggregationQuery.new # AggregationQuery | query
1503
+ form_id = "form_id_example" # String | Form ID
1374
1504
 
1505
+ opts = {
1506
+ page_size: 25, # Integer | Page size
1507
+ page_number: 1 # Integer | Page number
1508
+ }
1375
1509
 
1376
1510
  begin
1377
- #Query for evaluation aggregates
1378
- result = api_instance.post_analytics_evaluations_aggregates_query(body)
1511
+ #Gets all the revisions for a specific survey.
1512
+ result = api_instance.get_quality_forms_survey_versions(form_id, opts)
1379
1513
  p result
1380
1514
  rescue PureCloud::ApiError => e
1381
- puts "Exception when calling QualityApi->post_analytics_evaluations_aggregates_query: #{e}"
1515
+ puts "Exception when calling QualityApi->get_quality_forms_survey_versions: #{e}"
1382
1516
  end
1383
1517
  ~~~
1384
1518
 
@@ -1386,13 +1520,15 @@ end
1386
1520
 
1387
1521
  Name | Type | Description | Notes
1388
1522
  ------------- | ------------- | ------------- | -------------
1389
- **body** | [**AggregationQuery**](AggregationQuery.html)| query | |
1523
+ **form_id** | **String**| Form ID | |
1524
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
1525
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1390
1526
  {: class="table table-striped"}
1391
1527
 
1392
1528
 
1393
1529
  ### Return type
1394
1530
 
1395
- [**AggregateQueryResponse**](AggregateQueryResponse.html)
1531
+ [**SurveyFormEntityListing**](SurveyFormEntityListing.html)
1396
1532
 
1397
1533
  ### HTTP request headers
1398
1534
 
@@ -1401,15 +1537,15 @@ Name | Type | Description | Notes
1401
1537
 
1402
1538
 
1403
1539
 
1404
- <a name="post_quality_calibrations"></a>
1540
+ <a name="get_quality_forms_surveys"></a>
1405
1541
 
1406
- ## -[**Calibration**](Calibration.html) post_quality_calibrations(body, opts)
1542
+ ## -[**SurveyFormEntityListing**](SurveyFormEntityListing.html) get_quality_forms_surveys(opts)
1407
1543
 
1408
- Create a calibration
1544
+ Get the list of survey forms
1409
1545
 
1410
1546
 
1411
1547
 
1412
- Wraps POST /api/v2/quality/calibrations
1548
+ Wraps GET /api/v2/quality/forms/surveys
1413
1549
 
1414
1550
 
1415
1551
  ### Example
@@ -1429,18 +1565,22 @@ end
1429
1565
 
1430
1566
  api_instance = PureCloud::QualityApi.new
1431
1567
 
1432
- body = PureCloud::CalibrationCreate.new # CalibrationCreate | calibration
1433
-
1434
1568
  opts = {
1435
- expand: "expand_example" # String | calibratorId
1569
+ page_size: 25, # Integer | The total page size requested
1570
+ page_number: 1, # Integer | The page number requested
1571
+ sort_by: "sort_by_example", # String | variable name requested to sort by
1572
+ next_page: "next_page_example", # String | next page token
1573
+ previous_page: "previous_page_example", # String | Previous page token
1574
+ expand: "expand_example", # String | Expand
1575
+ name: "name_example" # String | Name
1436
1576
  }
1437
1577
 
1438
1578
  begin
1439
- #Create a calibration
1440
- result = api_instance.post_quality_calibrations(body, opts)
1579
+ #Get the list of survey forms
1580
+ result = api_instance.get_quality_forms_surveys(opts)
1441
1581
  p result
1442
1582
  rescue PureCloud::ApiError => e
1443
- puts "Exception when calling QualityApi->post_quality_calibrations: #{e}"
1583
+ puts "Exception when calling QualityApi->get_quality_forms_surveys: #{e}"
1444
1584
  end
1445
1585
  ~~~
1446
1586
 
@@ -1448,14 +1588,19 @@ end
1448
1588
 
1449
1589
  Name | Type | Description | Notes
1450
1590
  ------------- | ------------- | ------------- | -------------
1451
- **body** | [**CalibrationCreate**](CalibrationCreate.html)| calibration | |
1452
- **expand** | **String**| calibratorId | [optional] |
1591
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
1592
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1] |
1593
+ **sort_by** | **String**| variable name requested to sort by | [optional] |
1594
+ **next_page** | **String**| next page token | [optional] |
1595
+ **previous_page** | **String**| Previous page token | [optional] |
1596
+ **expand** | **String**| Expand | [optional] |
1597
+ **name** | **String**| Name | [optional] |
1453
1598
  {: class="table table-striped"}
1454
1599
 
1455
1600
 
1456
1601
  ### Return type
1457
1602
 
1458
- [**Calibration**](Calibration.html)
1603
+ [**SurveyFormEntityListing**](SurveyFormEntityListing.html)
1459
1604
 
1460
1605
  ### HTTP request headers
1461
1606
 
@@ -1464,15 +1609,830 @@ Name | Type | Description | Notes
1464
1609
 
1465
1610
 
1466
1611
 
1467
- <a name="post_quality_conversation_evaluations"></a>
1612
+ <a name="get_quality_keywordset"></a>
1468
1613
 
1469
- ## -[**Evaluation**](Evaluation.html) post_quality_conversation_evaluations(conversation_id, body, opts)
1614
+ ## -[**KeywordSet**](KeywordSet.html) get_quality_keywordset(keyword_set_id)
1470
1615
 
1471
- Create an evaluation
1616
+ Get a keywordSet by id.
1617
+
1618
+
1619
+
1620
+ Wraps GET /api/v2/quality/keywordsets/{keywordSetId}
1621
+
1622
+
1623
+ ### Example
1624
+ ~~~ruby
1625
+ # load the gem
1626
+ require 'purecloudplatformclientv2'
1627
+ # setup authorization
1628
+ @secret = ENV['PURECLOUD_SECRET']
1629
+ @id = ENV['PURECLOUD_CLIENT_ID']
1630
+ environment = "mypurecloud.com"
1631
+
1632
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1633
+
1634
+ PureCloud.configure do |config|
1635
+ config.access_token = @authToken
1636
+ end
1637
+
1638
+ api_instance = PureCloud::QualityApi.new
1639
+
1640
+ keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID
1641
+
1642
+
1643
+ begin
1644
+ #Get a keywordSet by id.
1645
+ result = api_instance.get_quality_keywordset(keyword_set_id)
1646
+ p result
1647
+ rescue PureCloud::ApiError => e
1648
+ puts "Exception when calling QualityApi->get_quality_keywordset: #{e}"
1649
+ end
1650
+ ~~~
1651
+
1652
+ ### Parameters
1653
+
1654
+ Name | Type | Description | Notes
1655
+ ------------- | ------------- | ------------- | -------------
1656
+ **keyword_set_id** | **String**| KeywordSet ID | |
1657
+ {: class="table table-striped"}
1658
+
1659
+
1660
+ ### Return type
1661
+
1662
+ [**KeywordSet**](KeywordSet.html)
1663
+
1664
+ ### HTTP request headers
1665
+
1666
+ - **Content-Type**: application/json
1667
+ - **Accept**: application/json
1668
+
1669
+
1670
+
1671
+ <a name="get_quality_keywordsets"></a>
1672
+
1673
+ ## -[**KeywordSetEntityListing**](KeywordSetEntityListing.html) get_quality_keywordsets(opts)
1674
+
1675
+ Get the list of keyword sets
1676
+
1677
+
1678
+
1679
+ Wraps GET /api/v2/quality/keywordsets
1680
+
1681
+
1682
+ ### Example
1683
+ ~~~ruby
1684
+ # load the gem
1685
+ require 'purecloudplatformclientv2'
1686
+ # setup authorization
1687
+ @secret = ENV['PURECLOUD_SECRET']
1688
+ @id = ENV['PURECLOUD_CLIENT_ID']
1689
+ environment = "mypurecloud.com"
1690
+
1691
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1692
+
1693
+ PureCloud.configure do |config|
1694
+ config.access_token = @authToken
1695
+ end
1696
+
1697
+ api_instance = PureCloud::QualityApi.new
1698
+
1699
+ opts = {
1700
+ page_size: 25, # Integer | The total page size requested
1701
+ page_number: 1, # Integer | The page number requested
1702
+ sort_by: "sort_by_example", # String | variable name requested to sort by
1703
+ expand: nil, # Array<Object> | variable name requested by expand list
1704
+ next_page: "next_page_example", # String | next page token
1705
+ previous_page: "previous_page_example", # String | Previous page token
1706
+ name: "name_example", # String | the keyword set name - used for filtering results in searches.
1707
+ queue_id: "queue_id_example", # String | the queue id - used for filtering results in searches.
1708
+ agent_id: "agent_id_example", # String | the agent id - used for filtering results in searches.
1709
+ operator: "operator_example" # String | If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.
1710
+ }
1711
+
1712
+ begin
1713
+ #Get the list of keyword sets
1714
+ result = api_instance.get_quality_keywordsets(opts)
1715
+ p result
1716
+ rescue PureCloud::ApiError => e
1717
+ puts "Exception when calling QualityApi->get_quality_keywordsets: #{e}"
1718
+ end
1719
+ ~~~
1720
+
1721
+ ### Parameters
1722
+
1723
+ Name | Type | Description | Notes
1724
+ ------------- | ------------- | ------------- | -------------
1725
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
1726
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1] |
1727
+ **sort_by** | **String**| variable name requested to sort by | [optional] |
1728
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional] |
1729
+ **next_page** | **String**| next page token | [optional] |
1730
+ **previous_page** | **String**| Previous page token | [optional] |
1731
+ **name** | **String**| the keyword set name - used for filtering results in searches. | [optional] |
1732
+ **queue_id** | **String**| the queue id - used for filtering results in searches. | [optional] |
1733
+ **agent_id** | **String**| the agent id - used for filtering results in searches. | [optional] |
1734
+ **operator** | **String**| If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters. | [optional] <br />**Values**: AND, OR |
1735
+ {: class="table table-striped"}
1736
+
1737
+
1738
+ ### Return type
1739
+
1740
+ [**KeywordSetEntityListing**](KeywordSetEntityListing.html)
1741
+
1742
+ ### HTTP request headers
1743
+
1744
+ - **Content-Type**: application/json
1745
+ - **Accept**: application/json
1746
+
1747
+
1748
+
1749
+ <a name="get_quality_publishedform"></a>
1750
+
1751
+ ## -[**EvaluationForm**](EvaluationForm.html) get_quality_publishedform(form_id)
1752
+
1753
+ Get the published evaluation forms.
1754
+
1755
+
1756
+
1757
+ Wraps GET /api/v2/quality/publishedforms/{formId}
1758
+
1759
+
1760
+ ### Example
1761
+ ~~~ruby
1762
+ # load the gem
1763
+ require 'purecloudplatformclientv2'
1764
+ # setup authorization
1765
+ @secret = ENV['PURECLOUD_SECRET']
1766
+ @id = ENV['PURECLOUD_CLIENT_ID']
1767
+ environment = "mypurecloud.com"
1768
+
1769
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1770
+
1771
+ PureCloud.configure do |config|
1772
+ config.access_token = @authToken
1773
+ end
1774
+
1775
+ api_instance = PureCloud::QualityApi.new
1776
+
1777
+ form_id = "form_id_example" # String | Form ID
1778
+
1779
+
1780
+ begin
1781
+ #Get the published evaluation forms.
1782
+ result = api_instance.get_quality_publishedform(form_id)
1783
+ p result
1784
+ rescue PureCloud::ApiError => e
1785
+ puts "Exception when calling QualityApi->get_quality_publishedform: #{e}"
1786
+ end
1787
+ ~~~
1788
+
1789
+ ### Parameters
1790
+
1791
+ Name | Type | Description | Notes
1792
+ ------------- | ------------- | ------------- | -------------
1793
+ **form_id** | **String**| Form ID | |
1794
+ {: class="table table-striped"}
1795
+
1796
+
1797
+ ### Return type
1798
+
1799
+ [**EvaluationForm**](EvaluationForm.html)
1800
+
1801
+ ### HTTP request headers
1802
+
1803
+ - **Content-Type**: application/json
1804
+ - **Accept**: application/json
1805
+
1806
+
1807
+
1808
+ <a name="get_quality_publishedforms"></a>
1809
+
1810
+ ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_publishedforms(opts)
1811
+
1812
+ Get the published evaluation forms.
1813
+
1814
+
1815
+
1816
+ Wraps GET /api/v2/quality/publishedforms
1817
+
1818
+
1819
+ ### Example
1820
+ ~~~ruby
1821
+ # load the gem
1822
+ require 'purecloudplatformclientv2'
1823
+ # setup authorization
1824
+ @secret = ENV['PURECLOUD_SECRET']
1825
+ @id = ENV['PURECLOUD_CLIENT_ID']
1826
+ environment = "mypurecloud.com"
1827
+
1828
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1829
+
1830
+ PureCloud.configure do |config|
1831
+ config.access_token = @authToken
1832
+ end
1833
+
1834
+ api_instance = PureCloud::QualityApi.new
1835
+
1836
+ opts = {
1837
+ page_size: 25, # Integer | Page size
1838
+ page_number: 1, # Integer | Page number
1839
+ name: "name_example" # String | Name
1840
+ }
1841
+
1842
+ begin
1843
+ #Get the published evaluation forms.
1844
+ result = api_instance.get_quality_publishedforms(opts)
1845
+ p result
1846
+ rescue PureCloud::ApiError => e
1847
+ puts "Exception when calling QualityApi->get_quality_publishedforms: #{e}"
1848
+ end
1849
+ ~~~
1850
+
1851
+ ### Parameters
1852
+
1853
+ Name | Type | Description | Notes
1854
+ ------------- | ------------- | ------------- | -------------
1855
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
1856
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1857
+ **name** | **String**| Name | [optional] |
1858
+ {: class="table table-striped"}
1859
+
1860
+
1861
+ ### Return type
1862
+
1863
+ [**EvaluationFormEntityListing**](EvaluationFormEntityListing.html)
1864
+
1865
+ ### HTTP request headers
1866
+
1867
+ - **Content-Type**: application/json
1868
+ - **Accept**: application/json
1869
+
1870
+
1871
+
1872
+ <a name="get_quality_publishedforms_evaluation"></a>
1873
+
1874
+ ## -[**EvaluationForm**](EvaluationForm.html) get_quality_publishedforms_evaluation(form_id)
1875
+
1876
+ Get the most recent published version of an evaluation form.
1877
+
1878
+
1879
+
1880
+ Wraps GET /api/v2/quality/publishedforms/evaluations/{formId}
1881
+
1882
+
1883
+ ### Example
1884
+ ~~~ruby
1885
+ # load the gem
1886
+ require 'purecloudplatformclientv2'
1887
+ # setup authorization
1888
+ @secret = ENV['PURECLOUD_SECRET']
1889
+ @id = ENV['PURECLOUD_CLIENT_ID']
1890
+ environment = "mypurecloud.com"
1891
+
1892
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1893
+
1894
+ PureCloud.configure do |config|
1895
+ config.access_token = @authToken
1896
+ end
1897
+
1898
+ api_instance = PureCloud::QualityApi.new
1899
+
1900
+ form_id = "form_id_example" # String | Form ID
1901
+
1902
+
1903
+ begin
1904
+ #Get the most recent published version of an evaluation form.
1905
+ result = api_instance.get_quality_publishedforms_evaluation(form_id)
1906
+ p result
1907
+ rescue PureCloud::ApiError => e
1908
+ puts "Exception when calling QualityApi->get_quality_publishedforms_evaluation: #{e}"
1909
+ end
1910
+ ~~~
1911
+
1912
+ ### Parameters
1913
+
1914
+ Name | Type | Description | Notes
1915
+ ------------- | ------------- | ------------- | -------------
1916
+ **form_id** | **String**| Form ID | |
1917
+ {: class="table table-striped"}
1918
+
1919
+
1920
+ ### Return type
1921
+
1922
+ [**EvaluationForm**](EvaluationForm.html)
1923
+
1924
+ ### HTTP request headers
1925
+
1926
+ - **Content-Type**: application/json
1927
+ - **Accept**: application/json
1928
+
1929
+
1930
+
1931
+ <a name="get_quality_publishedforms_evaluations"></a>
1932
+
1933
+ ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_publishedforms_evaluations(opts)
1934
+
1935
+ Get the published evaluation forms.
1936
+
1937
+
1938
+
1939
+ Wraps GET /api/v2/quality/publishedforms/evaluations
1940
+
1941
+
1942
+ ### Example
1943
+ ~~~ruby
1944
+ # load the gem
1945
+ require 'purecloudplatformclientv2'
1946
+ # setup authorization
1947
+ @secret = ENV['PURECLOUD_SECRET']
1948
+ @id = ENV['PURECLOUD_CLIENT_ID']
1949
+ environment = "mypurecloud.com"
1950
+
1951
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1952
+
1953
+ PureCloud.configure do |config|
1954
+ config.access_token = @authToken
1955
+ end
1956
+
1957
+ api_instance = PureCloud::QualityApi.new
1958
+
1959
+ opts = {
1960
+ page_size: 25, # Integer | Page size
1961
+ page_number: 1, # Integer | Page number
1962
+ name: "name_example" # String | Name
1963
+ }
1964
+
1965
+ begin
1966
+ #Get the published evaluation forms.
1967
+ result = api_instance.get_quality_publishedforms_evaluations(opts)
1968
+ p result
1969
+ rescue PureCloud::ApiError => e
1970
+ puts "Exception when calling QualityApi->get_quality_publishedforms_evaluations: #{e}"
1971
+ end
1972
+ ~~~
1973
+
1974
+ ### Parameters
1975
+
1976
+ Name | Type | Description | Notes
1977
+ ------------- | ------------- | ------------- | -------------
1978
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
1979
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1980
+ **name** | **String**| Name | [optional] |
1981
+ {: class="table table-striped"}
1982
+
1983
+
1984
+ ### Return type
1985
+
1986
+ [**EvaluationFormEntityListing**](EvaluationFormEntityListing.html)
1987
+
1988
+ ### HTTP request headers
1989
+
1990
+ - **Content-Type**: application/json
1991
+ - **Accept**: application/json
1992
+
1993
+
1994
+
1995
+ <a name="get_quality_publishedforms_survey"></a>
1996
+
1997
+ ## -[**SurveyForm**](SurveyForm.html) get_quality_publishedforms_survey(form_id)
1998
+
1999
+ Get the most recent published version of a survey form.
2000
+
2001
+
2002
+
2003
+ Wraps GET /api/v2/quality/publishedforms/surveys/{formId}
2004
+
2005
+
2006
+ ### Example
2007
+ ~~~ruby
2008
+ # load the gem
2009
+ require 'purecloudplatformclientv2'
2010
+ # setup authorization
2011
+ @secret = ENV['PURECLOUD_SECRET']
2012
+ @id = ENV['PURECLOUD_CLIENT_ID']
2013
+ environment = "mypurecloud.com"
2014
+
2015
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2016
+
2017
+ PureCloud.configure do |config|
2018
+ config.access_token = @authToken
2019
+ end
2020
+
2021
+ api_instance = PureCloud::QualityApi.new
2022
+
2023
+ form_id = "form_id_example" # String | Form ID
2024
+
2025
+
2026
+ begin
2027
+ #Get the most recent published version of a survey form.
2028
+ result = api_instance.get_quality_publishedforms_survey(form_id)
2029
+ p result
2030
+ rescue PureCloud::ApiError => e
2031
+ puts "Exception when calling QualityApi->get_quality_publishedforms_survey: #{e}"
2032
+ end
2033
+ ~~~
2034
+
2035
+ ### Parameters
2036
+
2037
+ Name | Type | Description | Notes
2038
+ ------------- | ------------- | ------------- | -------------
2039
+ **form_id** | **String**| Form ID | |
2040
+ {: class="table table-striped"}
2041
+
2042
+
2043
+ ### Return type
2044
+
2045
+ [**SurveyForm**](SurveyForm.html)
2046
+
2047
+ ### HTTP request headers
2048
+
2049
+ - **Content-Type**: application/json
2050
+ - **Accept**: application/json
2051
+
2052
+
2053
+
2054
+ <a name="get_quality_publishedforms_surveys"></a>
2055
+
2056
+ ## -[**SurveyFormEntityListing**](SurveyFormEntityListing.html) get_quality_publishedforms_surveys(opts)
2057
+
2058
+ Get the published survey forms.
2059
+
2060
+
2061
+
2062
+ Wraps GET /api/v2/quality/publishedforms/surveys
2063
+
2064
+
2065
+ ### Example
2066
+ ~~~ruby
2067
+ # load the gem
2068
+ require 'purecloudplatformclientv2'
2069
+ # setup authorization
2070
+ @secret = ENV['PURECLOUD_SECRET']
2071
+ @id = ENV['PURECLOUD_CLIENT_ID']
2072
+ environment = "mypurecloud.com"
2073
+
2074
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2075
+
2076
+ PureCloud.configure do |config|
2077
+ config.access_token = @authToken
2078
+ end
2079
+
2080
+ api_instance = PureCloud::QualityApi.new
2081
+
2082
+ opts = {
2083
+ page_size: 25, # Integer | Page size
2084
+ page_number: 1, # Integer | Page number
2085
+ name: "name_example" # String | Name
2086
+ }
2087
+
2088
+ begin
2089
+ #Get the published survey forms.
2090
+ result = api_instance.get_quality_publishedforms_surveys(opts)
2091
+ p result
2092
+ rescue PureCloud::ApiError => e
2093
+ puts "Exception when calling QualityApi->get_quality_publishedforms_surveys: #{e}"
2094
+ end
2095
+ ~~~
2096
+
2097
+ ### Parameters
2098
+
2099
+ Name | Type | Description | Notes
2100
+ ------------- | ------------- | ------------- | -------------
2101
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
2102
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
2103
+ **name** | **String**| Name | [optional] |
2104
+ {: class="table table-striped"}
2105
+
2106
+
2107
+ ### Return type
2108
+
2109
+ [**SurveyFormEntityListing**](SurveyFormEntityListing.html)
2110
+
2111
+ ### HTTP request headers
2112
+
2113
+ - **Content-Type**: application/json
2114
+ - **Accept**: application/json
2115
+
2116
+
2117
+
2118
+ <a name="patch_quality_forms_survey"></a>
2119
+
2120
+ ## -[**SurveyForm**](SurveyForm.html) patch_quality_forms_survey(form_id, body)
2121
+
2122
+ Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.
2123
+
2124
+
2125
+
2126
+ Wraps PATCH /api/v2/quality/forms/surveys/{formId}
2127
+
2128
+
2129
+ ### Example
2130
+ ~~~ruby
2131
+ # load the gem
2132
+ require 'purecloudplatformclientv2'
2133
+ # setup authorization
2134
+ @secret = ENV['PURECLOUD_SECRET']
2135
+ @id = ENV['PURECLOUD_CLIENT_ID']
2136
+ environment = "mypurecloud.com"
2137
+
2138
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2139
+
2140
+ PureCloud.configure do |config|
2141
+ config.access_token = @authToken
2142
+ end
2143
+
2144
+ api_instance = PureCloud::QualityApi.new
2145
+
2146
+ form_id = "form_id_example" # String | Form ID
2147
+
2148
+ body = PureCloud::SurveyForm.new # SurveyForm | Survey form
2149
+
2150
+
2151
+ begin
2152
+ #Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.
2153
+ result = api_instance.patch_quality_forms_survey(form_id, body)
2154
+ p result
2155
+ rescue PureCloud::ApiError => e
2156
+ puts "Exception when calling QualityApi->patch_quality_forms_survey: #{e}"
2157
+ end
2158
+ ~~~
2159
+
2160
+ ### Parameters
2161
+
2162
+ Name | Type | Description | Notes
2163
+ ------------- | ------------- | ------------- | -------------
2164
+ **form_id** | **String**| Form ID | |
2165
+ **body** | [**SurveyForm**](SurveyForm.html)| Survey form | |
2166
+ {: class="table table-striped"}
2167
+
2168
+
2169
+ ### Return type
2170
+
2171
+ [**SurveyForm**](SurveyForm.html)
2172
+
2173
+ ### HTTP request headers
2174
+
2175
+ - **Content-Type**: application/json
2176
+ - **Accept**: application/json
2177
+
2178
+
2179
+
2180
+ <a name="post_analytics_evaluations_aggregates_query"></a>
2181
+
2182
+ ## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_evaluations_aggregates_query(body)
2183
+
2184
+ Query for evaluation aggregates
2185
+
2186
+
2187
+
2188
+ Wraps POST /api/v2/analytics/evaluations/aggregates/query
2189
+
2190
+
2191
+ ### Example
2192
+ ~~~ruby
2193
+ # load the gem
2194
+ require 'purecloudplatformclientv2'
2195
+ # setup authorization
2196
+ @secret = ENV['PURECLOUD_SECRET']
2197
+ @id = ENV['PURECLOUD_CLIENT_ID']
2198
+ environment = "mypurecloud.com"
2199
+
2200
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2201
+
2202
+ PureCloud.configure do |config|
2203
+ config.access_token = @authToken
2204
+ end
2205
+
2206
+ api_instance = PureCloud::QualityApi.new
2207
+
2208
+ body = PureCloud::AggregationQuery.new # AggregationQuery | query
2209
+
2210
+
2211
+ begin
2212
+ #Query for evaluation aggregates
2213
+ result = api_instance.post_analytics_evaluations_aggregates_query(body)
2214
+ p result
2215
+ rescue PureCloud::ApiError => e
2216
+ puts "Exception when calling QualityApi->post_analytics_evaluations_aggregates_query: #{e}"
2217
+ end
2218
+ ~~~
2219
+
2220
+ ### Parameters
2221
+
2222
+ Name | Type | Description | Notes
2223
+ ------------- | ------------- | ------------- | -------------
2224
+ **body** | [**AggregationQuery**](AggregationQuery.html)| query | |
2225
+ {: class="table table-striped"}
2226
+
2227
+
2228
+ ### Return type
2229
+
2230
+ [**AggregateQueryResponse**](AggregateQueryResponse.html)
2231
+
2232
+ ### HTTP request headers
2233
+
2234
+ - **Content-Type**: application/json
2235
+ - **Accept**: application/json
2236
+
2237
+
2238
+
2239
+ <a name="post_quality_calibrations"></a>
2240
+
2241
+ ## -[**Calibration**](Calibration.html) post_quality_calibrations(body, opts)
2242
+
2243
+ Create a calibration
2244
+
2245
+
2246
+
2247
+ Wraps POST /api/v2/quality/calibrations
2248
+
2249
+
2250
+ ### Example
2251
+ ~~~ruby
2252
+ # load the gem
2253
+ require 'purecloudplatformclientv2'
2254
+ # setup authorization
2255
+ @secret = ENV['PURECLOUD_SECRET']
2256
+ @id = ENV['PURECLOUD_CLIENT_ID']
2257
+ environment = "mypurecloud.com"
2258
+
2259
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2260
+
2261
+ PureCloud.configure do |config|
2262
+ config.access_token = @authToken
2263
+ end
2264
+
2265
+ api_instance = PureCloud::QualityApi.new
2266
+
2267
+ body = PureCloud::CalibrationCreate.new # CalibrationCreate | calibration
2268
+
2269
+ opts = {
2270
+ expand: "expand_example" # String | calibratorId
2271
+ }
2272
+
2273
+ begin
2274
+ #Create a calibration
2275
+ result = api_instance.post_quality_calibrations(body, opts)
2276
+ p result
2277
+ rescue PureCloud::ApiError => e
2278
+ puts "Exception when calling QualityApi->post_quality_calibrations: #{e}"
2279
+ end
2280
+ ~~~
2281
+
2282
+ ### Parameters
2283
+
2284
+ Name | Type | Description | Notes
2285
+ ------------- | ------------- | ------------- | -------------
2286
+ **body** | [**CalibrationCreate**](CalibrationCreate.html)| calibration | |
2287
+ **expand** | **String**| calibratorId | [optional] |
2288
+ {: class="table table-striped"}
2289
+
2290
+
2291
+ ### Return type
2292
+
2293
+ [**Calibration**](Calibration.html)
2294
+
2295
+ ### HTTP request headers
2296
+
2297
+ - **Content-Type**: application/json
2298
+ - **Accept**: application/json
2299
+
2300
+
2301
+
2302
+ <a name="post_quality_conversation_evaluations"></a>
2303
+
2304
+ ## -[**Evaluation**](Evaluation.html) post_quality_conversation_evaluations(conversation_id, body, opts)
2305
+
2306
+ Create an evaluation
2307
+
2308
+
2309
+
2310
+ Wraps POST /api/v2/quality/conversations/{conversationId}/evaluations
2311
+
2312
+
2313
+ ### Example
2314
+ ~~~ruby
2315
+ # load the gem
2316
+ require 'purecloudplatformclientv2'
2317
+ # setup authorization
2318
+ @secret = ENV['PURECLOUD_SECRET']
2319
+ @id = ENV['PURECLOUD_CLIENT_ID']
2320
+ environment = "mypurecloud.com"
2321
+
2322
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2323
+
2324
+ PureCloud.configure do |config|
2325
+ config.access_token = @authToken
2326
+ end
2327
+
2328
+ api_instance = PureCloud::QualityApi.new
2329
+
2330
+ conversation_id = "conversation_id_example" # String | conversationId
2331
+
2332
+ body = PureCloud::Evaluation.new # Evaluation | evaluation
2333
+
2334
+ opts = {
2335
+ expand: "expand_example" # String | evaluatorId
2336
+ }
2337
+
2338
+ begin
2339
+ #Create an evaluation
2340
+ result = api_instance.post_quality_conversation_evaluations(conversation_id, body, opts)
2341
+ p result
2342
+ rescue PureCloud::ApiError => e
2343
+ puts "Exception when calling QualityApi->post_quality_conversation_evaluations: #{e}"
2344
+ end
2345
+ ~~~
2346
+
2347
+ ### Parameters
2348
+
2349
+ Name | Type | Description | Notes
2350
+ ------------- | ------------- | ------------- | -------------
2351
+ **conversation_id** | **String**| conversationId | |
2352
+ **body** | [**Evaluation**](Evaluation.html)| evaluation | |
2353
+ **expand** | **String**| evaluatorId | [optional] |
2354
+ {: class="table table-striped"}
2355
+
2356
+
2357
+ ### Return type
2358
+
2359
+ [**Evaluation**](Evaluation.html)
2360
+
2361
+ ### HTTP request headers
2362
+
2363
+ - **Content-Type**: application/json
2364
+ - **Accept**: application/json
2365
+
2366
+
2367
+
2368
+ <a name="post_quality_evaluations_scoring"></a>
2369
+
2370
+ ## -[**EvaluationScoringSet**](EvaluationScoringSet.html) post_quality_evaluations_scoring(body)
2371
+
2372
+ Score evaluation
2373
+
2374
+
2375
+
2376
+ Wraps POST /api/v2/quality/evaluations/scoring
2377
+
2378
+
2379
+ ### Example
2380
+ ~~~ruby
2381
+ # load the gem
2382
+ require 'purecloudplatformclientv2'
2383
+ # setup authorization
2384
+ @secret = ENV['PURECLOUD_SECRET']
2385
+ @id = ENV['PURECLOUD_CLIENT_ID']
2386
+ environment = "mypurecloud.com"
2387
+
2388
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2389
+
2390
+ PureCloud.configure do |config|
2391
+ config.access_token = @authToken
2392
+ end
2393
+
2394
+ api_instance = PureCloud::QualityApi.new
2395
+
2396
+ body = PureCloud::EvaluationFormAndScoringSet.new # EvaluationFormAndScoringSet | evaluationAndScoringSet
2397
+
2398
+
2399
+ begin
2400
+ #Score evaluation
2401
+ result = api_instance.post_quality_evaluations_scoring(body)
2402
+ p result
2403
+ rescue PureCloud::ApiError => e
2404
+ puts "Exception when calling QualityApi->post_quality_evaluations_scoring: #{e}"
2405
+ end
2406
+ ~~~
2407
+
2408
+ ### Parameters
2409
+
2410
+ Name | Type | Description | Notes
2411
+ ------------- | ------------- | ------------- | -------------
2412
+ **body** | [**EvaluationFormAndScoringSet**](EvaluationFormAndScoringSet.html)| evaluationAndScoringSet | |
2413
+ {: class="table table-striped"}
2414
+
2415
+
2416
+ ### Return type
2417
+
2418
+ [**EvaluationScoringSet**](EvaluationScoringSet.html)
2419
+
2420
+ ### HTTP request headers
2421
+
2422
+ - **Content-Type**: application/json
2423
+ - **Accept**: application/json
2424
+
2425
+
2426
+
2427
+ <a name="post_quality_forms"></a>
2428
+
2429
+ ## -[**EvaluationForm**](EvaluationForm.html) post_quality_forms(body)
2430
+
2431
+ Create an evaluation form.
1472
2432
 
1473
2433
 
1474
2434
 
1475
- Wraps POST /api/v2/quality/conversations/{conversationId}/evaluations
2435
+ Wraps POST /api/v2/quality/forms
1476
2436
 
1477
2437
 
1478
2438
  ### Example
@@ -1492,20 +2452,15 @@ end
1492
2452
 
1493
2453
  api_instance = PureCloud::QualityApi.new
1494
2454
 
1495
- conversation_id = "conversation_id_example" # String | conversationId
1496
-
1497
- body = PureCloud::Evaluation.new # Evaluation | evaluation
2455
+ body = PureCloud::EvaluationForm.new # EvaluationForm | Evaluation form
1498
2456
 
1499
- opts = {
1500
- expand: "expand_example" # String | evaluatorId
1501
- }
1502
2457
 
1503
2458
  begin
1504
- #Create an evaluation
1505
- result = api_instance.post_quality_conversation_evaluations(conversation_id, body, opts)
2459
+ #Create an evaluation form.
2460
+ result = api_instance.post_quality_forms(body)
1506
2461
  p result
1507
2462
  rescue PureCloud::ApiError => e
1508
- puts "Exception when calling QualityApi->post_quality_conversation_evaluations: #{e}"
2463
+ puts "Exception when calling QualityApi->post_quality_forms: #{e}"
1509
2464
  end
1510
2465
  ~~~
1511
2466
 
@@ -1513,15 +2468,13 @@ end
1513
2468
 
1514
2469
  Name | Type | Description | Notes
1515
2470
  ------------- | ------------- | ------------- | -------------
1516
- **conversation_id** | **String**| conversationId | |
1517
- **body** | [**Evaluation**](Evaluation.html)| evaluation | |
1518
- **expand** | **String**| evaluatorId | [optional] |
2471
+ **body** | [**EvaluationForm**](EvaluationForm.html)| Evaluation form | |
1519
2472
  {: class="table table-striped"}
1520
2473
 
1521
2474
 
1522
2475
  ### Return type
1523
2476
 
1524
- [**Evaluation**](Evaluation.html)
2477
+ [**EvaluationForm**](EvaluationForm.html)
1525
2478
 
1526
2479
  ### HTTP request headers
1527
2480
 
@@ -1530,15 +2483,15 @@ Name | Type | Description | Notes
1530
2483
 
1531
2484
 
1532
2485
 
1533
- <a name="post_quality_evaluations_scoring"></a>
2486
+ <a name="post_quality_forms_evaluations"></a>
1534
2487
 
1535
- ## -[**EvaluationScoringSet**](EvaluationScoringSet.html) post_quality_evaluations_scoring(body)
2488
+ ## -[**EvaluationForm**](EvaluationForm.html) post_quality_forms_evaluations(body)
1536
2489
 
1537
- Score evaluation
2490
+ Create an evaluation form.
1538
2491
 
1539
2492
 
1540
2493
 
1541
- Wraps POST /api/v2/quality/evaluations/scoring
2494
+ Wraps POST /api/v2/quality/forms/evaluations
1542
2495
 
1543
2496
 
1544
2497
  ### Example
@@ -1558,15 +2511,15 @@ end
1558
2511
 
1559
2512
  api_instance = PureCloud::QualityApi.new
1560
2513
 
1561
- body = PureCloud::EvaluationFormAndScoringSet.new # EvaluationFormAndScoringSet | evaluationAndScoringSet
2514
+ body = PureCloud::EvaluationForm.new # EvaluationForm | Evaluation form
1562
2515
 
1563
2516
 
1564
2517
  begin
1565
- #Score evaluation
1566
- result = api_instance.post_quality_evaluations_scoring(body)
2518
+ #Create an evaluation form.
2519
+ result = api_instance.post_quality_forms_evaluations(body)
1567
2520
  p result
1568
2521
  rescue PureCloud::ApiError => e
1569
- puts "Exception when calling QualityApi->post_quality_evaluations_scoring: #{e}"
2522
+ puts "Exception when calling QualityApi->post_quality_forms_evaluations: #{e}"
1570
2523
  end
1571
2524
  ~~~
1572
2525
 
@@ -1574,13 +2527,13 @@ end
1574
2527
 
1575
2528
  Name | Type | Description | Notes
1576
2529
  ------------- | ------------- | ------------- | -------------
1577
- **body** | [**EvaluationFormAndScoringSet**](EvaluationFormAndScoringSet.html)| evaluationAndScoringSet | |
2530
+ **body** | [**EvaluationForm**](EvaluationForm.html)| Evaluation form | |
1578
2531
  {: class="table table-striped"}
1579
2532
 
1580
2533
 
1581
2534
  ### Return type
1582
2535
 
1583
- [**EvaluationScoringSet**](EvaluationScoringSet.html)
2536
+ [**EvaluationForm**](EvaluationForm.html)
1584
2537
 
1585
2538
  ### HTTP request headers
1586
2539
 
@@ -1589,15 +2542,15 @@ Name | Type | Description | Notes
1589
2542
 
1590
2543
 
1591
2544
 
1592
- <a name="post_quality_forms"></a>
2545
+ <a name="post_quality_forms_surveys"></a>
1593
2546
 
1594
- ## -[**EvaluationForm**](EvaluationForm.html) post_quality_forms(body)
2547
+ ## -[**SurveyForm**](SurveyForm.html) post_quality_forms_surveys(body)
1595
2548
 
1596
- Create an evaluation form.
2549
+ Create a survey form.
1597
2550
 
1598
2551
 
1599
2552
 
1600
- Wraps POST /api/v2/quality/forms
2553
+ Wraps POST /api/v2/quality/forms/surveys
1601
2554
 
1602
2555
 
1603
2556
  ### Example
@@ -1617,15 +2570,15 @@ end
1617
2570
 
1618
2571
  api_instance = PureCloud::QualityApi.new
1619
2572
 
1620
- body = PureCloud::EvaluationForm.new # EvaluationForm | Evaluation form
2573
+ body = PureCloud::SurveyForm.new # SurveyForm | Survey form
1621
2574
 
1622
2575
 
1623
2576
  begin
1624
- #Create an evaluation form.
1625
- result = api_instance.post_quality_forms(body)
2577
+ #Create a survey form.
2578
+ result = api_instance.post_quality_forms_surveys(body)
1626
2579
  p result
1627
2580
  rescue PureCloud::ApiError => e
1628
- puts "Exception when calling QualityApi->post_quality_forms: #{e}"
2581
+ puts "Exception when calling QualityApi->post_quality_forms_surveys: #{e}"
1629
2582
  end
1630
2583
  ~~~
1631
2584
 
@@ -1633,13 +2586,13 @@ end
1633
2586
 
1634
2587
  Name | Type | Description | Notes
1635
2588
  ------------- | ------------- | ------------- | -------------
1636
- **body** | [**EvaluationForm**](EvaluationForm.html)| Evaluation form | |
2589
+ **body** | [**SurveyForm**](SurveyForm.html)| Survey form | |
1637
2590
  {: class="table table-striped"}
1638
2591
 
1639
2592
 
1640
2593
  ### Return type
1641
2594
 
1642
- [**EvaluationForm**](EvaluationForm.html)
2595
+ [**SurveyForm**](SurveyForm.html)
1643
2596
 
1644
2597
  ### HTTP request headers
1645
2598
 
@@ -1770,6 +2723,124 @@ Name | Type | Description | Notes
1770
2723
 
1771
2724
 
1772
2725
 
2726
+ <a name="post_quality_publishedforms_evaluations"></a>
2727
+
2728
+ ## -[**EvaluationForm**](EvaluationForm.html) post_quality_publishedforms_evaluations(body)
2729
+
2730
+ Publish an evaluation form.
2731
+
2732
+
2733
+
2734
+ Wraps POST /api/v2/quality/publishedforms/evaluations
2735
+
2736
+
2737
+ ### Example
2738
+ ~~~ruby
2739
+ # load the gem
2740
+ require 'purecloudplatformclientv2'
2741
+ # setup authorization
2742
+ @secret = ENV['PURECLOUD_SECRET']
2743
+ @id = ENV['PURECLOUD_CLIENT_ID']
2744
+ environment = "mypurecloud.com"
2745
+
2746
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2747
+
2748
+ PureCloud.configure do |config|
2749
+ config.access_token = @authToken
2750
+ end
2751
+
2752
+ api_instance = PureCloud::QualityApi.new
2753
+
2754
+ body = PureCloud::PublishForm.new # PublishForm | Evaluation form
2755
+
2756
+
2757
+ begin
2758
+ #Publish an evaluation form.
2759
+ result = api_instance.post_quality_publishedforms_evaluations(body)
2760
+ p result
2761
+ rescue PureCloud::ApiError => e
2762
+ puts "Exception when calling QualityApi->post_quality_publishedforms_evaluations: #{e}"
2763
+ end
2764
+ ~~~
2765
+
2766
+ ### Parameters
2767
+
2768
+ Name | Type | Description | Notes
2769
+ ------------- | ------------- | ------------- | -------------
2770
+ **body** | [**PublishForm**](PublishForm.html)| Evaluation form | |
2771
+ {: class="table table-striped"}
2772
+
2773
+
2774
+ ### Return type
2775
+
2776
+ [**EvaluationForm**](EvaluationForm.html)
2777
+
2778
+ ### HTTP request headers
2779
+
2780
+ - **Content-Type**: application/json
2781
+ - **Accept**: application/json
2782
+
2783
+
2784
+
2785
+ <a name="post_quality_publishedforms_surveys"></a>
2786
+
2787
+ ## -[**SurveyForm**](SurveyForm.html) post_quality_publishedforms_surveys(body)
2788
+
2789
+ Publish a survey form.
2790
+
2791
+
2792
+
2793
+ Wraps POST /api/v2/quality/publishedforms/surveys
2794
+
2795
+
2796
+ ### Example
2797
+ ~~~ruby
2798
+ # load the gem
2799
+ require 'purecloudplatformclientv2'
2800
+ # setup authorization
2801
+ @secret = ENV['PURECLOUD_SECRET']
2802
+ @id = ENV['PURECLOUD_CLIENT_ID']
2803
+ environment = "mypurecloud.com"
2804
+
2805
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2806
+
2807
+ PureCloud.configure do |config|
2808
+ config.access_token = @authToken
2809
+ end
2810
+
2811
+ api_instance = PureCloud::QualityApi.new
2812
+
2813
+ body = PureCloud::PublishForm.new # PublishForm | Survey form
2814
+
2815
+
2816
+ begin
2817
+ #Publish a survey form.
2818
+ result = api_instance.post_quality_publishedforms_surveys(body)
2819
+ p result
2820
+ rescue PureCloud::ApiError => e
2821
+ puts "Exception when calling QualityApi->post_quality_publishedforms_surveys: #{e}"
2822
+ end
2823
+ ~~~
2824
+
2825
+ ### Parameters
2826
+
2827
+ Name | Type | Description | Notes
2828
+ ------------- | ------------- | ------------- | -------------
2829
+ **body** | [**PublishForm**](PublishForm.html)| Survey form | |
2830
+ {: class="table table-striped"}
2831
+
2832
+
2833
+ ### Return type
2834
+
2835
+ [**SurveyForm**](SurveyForm.html)
2836
+
2837
+ ### HTTP request headers
2838
+
2839
+ - **Content-Type**: application/json
2840
+ - **Accept**: application/json
2841
+
2842
+
2843
+
1773
2844
  <a name="post_quality_spotability"></a>
1774
2845
 
1775
2846
  ## -[**KeywordSet**](KeywordSet.html) post_quality_spotability(opts)
@@ -2023,6 +3094,130 @@ Name | Type | Description | Notes
2023
3094
 
2024
3095
 
2025
3096
 
3097
+ <a name="put_quality_forms_evaluation"></a>
3098
+
3099
+ ## -[**EvaluationForm**](EvaluationForm.html) put_quality_forms_evaluation(form_id, body)
3100
+
3101
+ Update an evaluation form.
3102
+
3103
+
3104
+
3105
+ Wraps PUT /api/v2/quality/forms/evaluations/{formId}
3106
+
3107
+
3108
+ ### Example
3109
+ ~~~ruby
3110
+ # load the gem
3111
+ require 'purecloudplatformclientv2'
3112
+ # setup authorization
3113
+ @secret = ENV['PURECLOUD_SECRET']
3114
+ @id = ENV['PURECLOUD_CLIENT_ID']
3115
+ environment = "mypurecloud.com"
3116
+
3117
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3118
+
3119
+ PureCloud.configure do |config|
3120
+ config.access_token = @authToken
3121
+ end
3122
+
3123
+ api_instance = PureCloud::QualityApi.new
3124
+
3125
+ form_id = "form_id_example" # String | Form ID
3126
+
3127
+ body = PureCloud::EvaluationForm.new # EvaluationForm | Evaluation form
3128
+
3129
+
3130
+ begin
3131
+ #Update an evaluation form.
3132
+ result = api_instance.put_quality_forms_evaluation(form_id, body)
3133
+ p result
3134
+ rescue PureCloud::ApiError => e
3135
+ puts "Exception when calling QualityApi->put_quality_forms_evaluation: #{e}"
3136
+ end
3137
+ ~~~
3138
+
3139
+ ### Parameters
3140
+
3141
+ Name | Type | Description | Notes
3142
+ ------------- | ------------- | ------------- | -------------
3143
+ **form_id** | **String**| Form ID | |
3144
+ **body** | [**EvaluationForm**](EvaluationForm.html)| Evaluation form | |
3145
+ {: class="table table-striped"}
3146
+
3147
+
3148
+ ### Return type
3149
+
3150
+ [**EvaluationForm**](EvaluationForm.html)
3151
+
3152
+ ### HTTP request headers
3153
+
3154
+ - **Content-Type**: application/json
3155
+ - **Accept**: application/json
3156
+
3157
+
3158
+
3159
+ <a name="put_quality_forms_survey"></a>
3160
+
3161
+ ## -[**SurveyForm**](SurveyForm.html) put_quality_forms_survey(form_id, body)
3162
+
3163
+ Update a survey form.
3164
+
3165
+
3166
+
3167
+ Wraps PUT /api/v2/quality/forms/surveys/{formId}
3168
+
3169
+
3170
+ ### Example
3171
+ ~~~ruby
3172
+ # load the gem
3173
+ require 'purecloudplatformclientv2'
3174
+ # setup authorization
3175
+ @secret = ENV['PURECLOUD_SECRET']
3176
+ @id = ENV['PURECLOUD_CLIENT_ID']
3177
+ environment = "mypurecloud.com"
3178
+
3179
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3180
+
3181
+ PureCloud.configure do |config|
3182
+ config.access_token = @authToken
3183
+ end
3184
+
3185
+ api_instance = PureCloud::QualityApi.new
3186
+
3187
+ form_id = "form_id_example" # String | Form ID
3188
+
3189
+ body = PureCloud::SurveyForm.new # SurveyForm | Survey form
3190
+
3191
+
3192
+ begin
3193
+ #Update a survey form.
3194
+ result = api_instance.put_quality_forms_survey(form_id, body)
3195
+ p result
3196
+ rescue PureCloud::ApiError => e
3197
+ puts "Exception when calling QualityApi->put_quality_forms_survey: #{e}"
3198
+ end
3199
+ ~~~
3200
+
3201
+ ### Parameters
3202
+
3203
+ Name | Type | Description | Notes
3204
+ ------------- | ------------- | ------------- | -------------
3205
+ **form_id** | **String**| Form ID | |
3206
+ **body** | [**SurveyForm**](SurveyForm.html)| Survey form | |
3207
+ {: class="table table-striped"}
3208
+
3209
+
3210
+ ### Return type
3211
+
3212
+ [**SurveyForm**](SurveyForm.html)
3213
+
3214
+ ### HTTP request headers
3215
+
3216
+ - **Content-Type**: application/json
3217
+ - **Accept**: application/json
3218
+
3219
+
3220
+
2026
3221
  <a name="put_quality_keywordset"></a>
2027
3222
 
2028
3223
  ## -[**KeywordSet**](KeywordSet.html) put_quality_keywordset(keyword_set_id, body)