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
@@ -0,0 +1,19 @@
1
+ ---
2
+ title: WebChatDeployment
3
+ ---
4
+ ## PureCloud::WebChatDeployment
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **description** | **String** | | [optional] |
13
+ | **authentication_required** | **BOOLEAN** | | [optional] |
14
+ | **authentication_url** | **String** | URL for third party service authenticating webchat clients. See https://github.com/MyPureCloud/authenticated-web-chat-server-examples | [optional] |
15
+ | **disabled** | **BOOLEAN** | | [optional] |
16
+ | **self_uri** | **String** | The URI for this object | [optional] |
17
+ {: class="table table-striped"}
18
+
19
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: WebChatDeploymentEntityListing
3
+ ---
4
+ ## PureCloud::WebChatDeploymentEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **total** | **Integer** | | [optional] |
11
+ | **entities** | [**Array<WebChatDeployment>**](WebChatDeployment.html) | | [optional] |
12
+ | **self_uri** | **String** | | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: WebChatSettings
3
+ ---
4
+ ## PureCloud::WebChatSettings
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **require_deployment** | **BOOLEAN** | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: WfmMoveAgentsCompleteNotification
3
+ ---
4
+ ## PureCloud::WfmMoveAgentsCompleteNotification
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **requesting_user** | [**DocumentDataV2NotificationWorkspace**](DocumentDataV2NotificationWorkspace.html) | | [optional] |
11
+ | **destination_management_unit** | [**DocumentDataV2NotificationWorkspace**](DocumentDataV2NotificationWorkspace.html) | | [optional] |
12
+ | **move_agent_results** | [**Array<WfmMoveAgentsCompleteNotificationMoveAgentResults>**](WfmMoveAgentsCompleteNotificationMoveAgentResults.html) | | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: WfmMoveAgentsCompleteNotificationManagementUnit
3
+ ---
4
+ ## PureCloud::WfmMoveAgentsCompleteNotificationManagementUnit
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: WfmMoveAgentsCompleteNotificationMoveAgentResults
3
+ ---
4
+ ## PureCloud::WfmMoveAgentsCompleteNotificationMoveAgentResults
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **user** | [**WfmMoveAgentsCompleteNotificationUser**](WfmMoveAgentsCompleteNotificationUser.html) | | [optional] |
11
+ | **move_agent_result** | **String** | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: WfmMoveAgentsCompleteNotificationUser
3
+ ---
4
+ ## PureCloud::WfmMoveAgentsCompleteNotificationUser
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: WfmMoveAgentsCompleteNotificationWfmMoveAgentData
3
+ ---
4
+ ## PureCloud::WfmMoveAgentsCompleteNotificationWfmMoveAgentData
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **user** | [**WfmMoveAgentsCompleteNotificationUser**](WfmMoveAgentsCompleteNotificationUser.html) | | [optional] |
11
+ | **move_agent_result** | **String** | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: WfmUpdateAgentDetailsCompleteNotification
3
+ ---
4
+ ## PureCloud::WfmUpdateAgentDetailsCompleteNotification
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **result** | **String** | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -11,11 +11,11 @@ title: WorkspaceEntityListing
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: WorkspaceMemberEntityListing
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: WrapupCodeEntityListing
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
 
@@ -70,6 +70,7 @@ require 'purecloudplatformclientv2/models/analytics_query_filter'
70
70
  require 'purecloudplatformclientv2/models/analytics_query_predicate'
71
71
  require 'purecloudplatformclientv2/models/analytics_routing_status_record'
72
72
  require 'purecloudplatformclientv2/models/analytics_session'
73
+ require 'purecloudplatformclientv2/models/analytics_session_metric'
73
74
  require 'purecloudplatformclientv2/models/analytics_user_detail'
74
75
  require 'purecloudplatformclientv2/models/analytics_user_details_query_response'
75
76
  require 'purecloudplatformclientv2/models/analytics_user_presence_record'
@@ -415,6 +416,7 @@ require 'purecloudplatformclientv2/models/domain_entity'
415
416
  require 'purecloudplatformclientv2/models/domain_entity_listing'
416
417
  require 'purecloudplatformclientv2/models/domain_entity_listing_evaluation_form'
417
418
  require 'purecloudplatformclientv2/models/domain_entity_listing_query_result'
419
+ require 'purecloudplatformclientv2/models/domain_entity_listing_survey_form'
418
420
  require 'purecloudplatformclientv2/models/domain_logical_interface'
419
421
  require 'purecloudplatformclientv2/models/domain_network_address'
420
422
  require 'purecloudplatformclientv2/models/domain_network_command_response'
@@ -789,6 +791,7 @@ require 'purecloudplatformclientv2/models/prompt_resource_notification_notificat
789
791
  require 'purecloudplatformclientv2/models/property_index_request'
790
792
  require 'purecloudplatformclientv2/models/provision_info'
791
793
  require 'purecloudplatformclientv2/models/publish_draft_input'
794
+ require 'purecloudplatformclientv2/models/publish_form'
792
795
  require 'purecloudplatformclientv2/models/pure_cloud'
793
796
  require 'purecloudplatformclientv2/models/qualifier_mapping_observation_query_response'
794
797
  require 'purecloudplatformclientv2/models/quality_audit'
@@ -943,6 +946,8 @@ require 'purecloudplatformclientv2/models/street_address'
943
946
  require 'purecloudplatformclientv2/models/subscriber_response'
944
947
  require 'purecloudplatformclientv2/models/suggest_search_criteria'
945
948
  require 'purecloudplatformclientv2/models/suggest_search_request'
949
+ require 'purecloudplatformclientv2/models/survey_form'
950
+ require 'purecloudplatformclientv2/models/survey_form_entity_listing'
946
951
  require 'purecloudplatformclientv2/models/system_presence'
947
952
  require 'purecloudplatformclientv2/models/system_prompt'
948
953
  require 'purecloudplatformclientv2/models/system_prompt_asset'
@@ -1088,10 +1093,19 @@ require 'purecloudplatformclientv2/models/voicemail_search_criteria'
1088
1093
  require 'purecloudplatformclientv2/models/voicemail_search_request'
1089
1094
  require 'purecloudplatformclientv2/models/voicemail_user_policy'
1090
1095
  require 'purecloudplatformclientv2/models/voicemails_search_response'
1096
+ require 'purecloudplatformclientv2/models/web_chat_deployment'
1097
+ require 'purecloudplatformclientv2/models/web_chat_deployment_entity_listing'
1098
+ require 'purecloudplatformclientv2/models/web_chat_settings'
1091
1099
  require 'purecloudplatformclientv2/models/wfm_historical_adherence_calculations_complete_notice_notification'
1092
1100
  require 'purecloudplatformclientv2/models/wfm_historical_adherence_query'
1093
1101
  require 'purecloudplatformclientv2/models/wfm_historical_adherence_response'
1094
1102
  require 'purecloudplatformclientv2/models/wfm_intraday_queue_listing'
1103
+ require 'purecloudplatformclientv2/models/wfm_move_agents_complete_notification'
1104
+ require 'purecloudplatformclientv2/models/wfm_move_agents_complete_notification_management_unit'
1105
+ require 'purecloudplatformclientv2/models/wfm_move_agents_complete_notification_move_agent_results'
1106
+ require 'purecloudplatformclientv2/models/wfm_move_agents_complete_notification_user'
1107
+ require 'purecloudplatformclientv2/models/wfm_move_agents_complete_notification_wfm_move_agent_data'
1108
+ require 'purecloudplatformclientv2/models/wfm_update_agent_details_complete_notification'
1095
1109
  require 'purecloudplatformclientv2/models/wfm_user_entity_listing'
1096
1110
  require 'purecloudplatformclientv2/models/wfm_versioned_entity_metadata'
1097
1111
  require 'purecloudplatformclientv2/models/workspace'
@@ -1147,6 +1161,7 @@ require 'purecloudplatformclientv2/api/user_recordings_api'
1147
1161
  require 'purecloudplatformclientv2/api/users_api'
1148
1162
  require 'purecloudplatformclientv2/api/utilities_api'
1149
1163
  require 'purecloudplatformclientv2/api/voicemail_api'
1164
+ require 'purecloudplatformclientv2/api/web_chat_api'
1150
1165
  require 'purecloudplatformclientv2/api/workforce_management_api'
1151
1166
 
1152
1167
  module PureCloud
@@ -5828,7 +5828,7 @@ module PureCloud
5828
5828
  return data, status_code, headers
5829
5829
  end
5830
5830
 
5831
- # Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based.This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
5831
+ # Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
5832
5832
  #
5833
5833
  # @param conversation_id conversationId
5834
5834
  # @param body Send external email reply
@@ -5839,7 +5839,7 @@ module PureCloud
5839
5839
  return data
5840
5840
  end
5841
5841
 
5842
- # Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based.This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
5842
+ # Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
5843
5843
  #
5844
5844
  # @param conversation_id conversationId
5845
5845
  # @param body Send external email reply
@@ -6063,7 +6063,7 @@ module PureCloud
6063
6063
  end
6064
6064
 
6065
6065
  # Create an email conversation
6066
- #
6066
+ # If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.
6067
6067
  # @param body Create email request
6068
6068
  # @param [Hash] opts the optional parameters
6069
6069
  # @return [EmailConversation]
@@ -6073,7 +6073,7 @@ module PureCloud
6073
6073
  end
6074
6074
 
6075
6075
  # Create an email conversation
6076
- #
6076
+ # If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.
6077
6077
  # @param body Create email request
6078
6078
  # @param [Hash] opts the optional parameters
6079
6079
  # @return [Array<(EmailConversation, Fixnum, Hash)>] EmailConversation data, response status code and response headers
@@ -4815,8 +4815,9 @@ module PureCloud
4815
4815
  # @param contact_list_id Contact List ID
4816
4816
  # @param body Contact
4817
4817
  # @param [Hash] opts the optional parameters
4818
- # @option opts [BOOLEAN] :priority Contact priority. True means the contact(s) will be dialed next, false means the contact will go to the end of the contact queue.
4819
- # @option opts [BOOLEAN] :clear_system_data Clear system data. True means the system data stored on the contact will be cleared if the contact already exists (attempts, callable status, etc), false means it won&#39;t.
4818
+ # @option opts [BOOLEAN] :priority Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.
4819
+ # @option opts [BOOLEAN] :clear_system_data Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won&#39;t.
4820
+ # @option opts [BOOLEAN] :do_not_queue Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed; False means that updated contacts will be requeued, according to the &#39;priority&#39; parameter.
4820
4821
  # @return [Array<DialerContact>]
4821
4822
  def post_outbound_contactlist_contacts(contact_list_id, body, opts = {})
4822
4823
  data, _status_code, _headers = post_outbound_contactlist_contacts_with_http_info(contact_list_id, body, opts)
@@ -4828,8 +4829,9 @@ module PureCloud
4828
4829
  # @param contact_list_id Contact List ID
4829
4830
  # @param body Contact
4830
4831
  # @param [Hash] opts the optional parameters
4831
- # @option opts [BOOLEAN] :priority Contact priority. True means the contact(s) will be dialed next, false means the contact will go to the end of the contact queue.
4832
- # @option opts [BOOLEAN] :clear_system_data Clear system data. True means the system data stored on the contact will be cleared if the contact already exists (attempts, callable status, etc), false means it won&#39;t.
4832
+ # @option opts [BOOLEAN] :priority Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.
4833
+ # @option opts [BOOLEAN] :clear_system_data Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won&#39;t.
4834
+ # @option opts [BOOLEAN] :do_not_queue Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed; False means that updated contacts will be requeued, according to the &#39;priority&#39; parameter.
4833
4835
  # @return [Array<(Array<DialerContact>, Fixnum, Hash)>] Array<DialerContact> data, response status code and response headers
4834
4836
  def post_outbound_contactlist_contacts_with_http_info(contact_list_id, body, opts = {})
4835
4837
  if @api_client.config.debugging
@@ -4861,6 +4863,12 @@ module PureCloud
4861
4863
 
4862
4864
 
4863
4865
 
4866
+
4867
+
4868
+
4869
+
4870
+
4871
+
4864
4872
 
4865
4873
 
4866
4874
 
@@ -4871,6 +4879,7 @@ module PureCloud
4871
4879
  query_params = {}
4872
4880
  query_params[:'priority'] = opts[:'priority'] if opts[:'priority']
4873
4881
  query_params[:'clearSystemData'] = opts[:'clear_system_data'] if opts[:'clear_system_data']
4882
+ query_params[:'doNotQueue'] = opts[:'do_not_queue'] if opts[:'do_not_queue']
4874
4883
 
4875
4884
  # header parameters
4876
4885
  header_params = {}
@@ -248,6 +248,134 @@ module PureCloud
248
248
  return data, status_code, headers
249
249
  end
250
250
 
251
+ # Delete an evaluation form.
252
+ #
253
+ # @param form_id Form ID
254
+ # @param [Hash] opts the optional parameters
255
+ # @return [nil]
256
+ def delete_quality_forms_evaluation(form_id, opts = {})
257
+ delete_quality_forms_evaluation_with_http_info(form_id, opts)
258
+ return nil
259
+ end
260
+
261
+ # Delete an evaluation form.
262
+ #
263
+ # @param form_id Form ID
264
+ # @param [Hash] opts the optional parameters
265
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
266
+ def delete_quality_forms_evaluation_with_http_info(form_id, opts = {})
267
+ if @api_client.config.debugging
268
+ @api_client.config.logger.debug "Calling API: QualityApi.delete_quality_forms_evaluation ..."
269
+ end
270
+
271
+
272
+ # verify the required parameter 'form_id' is set
273
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.delete_quality_forms_evaluation" if form_id.nil?
274
+
275
+
276
+
277
+
278
+
279
+ # resource path
280
+ local_var_path = "/api/v2/quality/forms/evaluations/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
281
+
282
+ # query parameters
283
+ query_params = {}
284
+
285
+ # header parameters
286
+ header_params = {}
287
+
288
+ # HTTP header 'Accept' (if needed)
289
+ local_header_accept = ['application/json']
290
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
291
+
292
+ # HTTP header 'Content-Type'
293
+ local_header_content_type = ['application/json']
294
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
295
+
296
+ # form parameters
297
+ form_params = {}
298
+
299
+ # http body (model)
300
+ post_body = nil
301
+
302
+ auth_names = ['PureCloud Auth']
303
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
304
+ :header_params => header_params,
305
+ :query_params => query_params,
306
+ :form_params => form_params,
307
+ :body => post_body,
308
+ :auth_names => auth_names)
309
+ if @api_client.config.debugging
310
+ @api_client.config.logger.debug "API called: QualityApi#delete_quality_forms_evaluation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
311
+ end
312
+ return data, status_code, headers
313
+ end
314
+
315
+ # Delete a survey form.
316
+ #
317
+ # @param form_id Form ID
318
+ # @param [Hash] opts the optional parameters
319
+ # @return [nil]
320
+ def delete_quality_forms_survey(form_id, opts = {})
321
+ delete_quality_forms_survey_with_http_info(form_id, opts)
322
+ return nil
323
+ end
324
+
325
+ # Delete a survey form.
326
+ #
327
+ # @param form_id Form ID
328
+ # @param [Hash] opts the optional parameters
329
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
330
+ def delete_quality_forms_survey_with_http_info(form_id, opts = {})
331
+ if @api_client.config.debugging
332
+ @api_client.config.logger.debug "Calling API: QualityApi.delete_quality_forms_survey ..."
333
+ end
334
+
335
+
336
+ # verify the required parameter 'form_id' is set
337
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.delete_quality_forms_survey" if form_id.nil?
338
+
339
+
340
+
341
+
342
+
343
+ # resource path
344
+ local_var_path = "/api/v2/quality/forms/surveys/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
345
+
346
+ # query parameters
347
+ query_params = {}
348
+
349
+ # header parameters
350
+ header_params = {}
351
+
352
+ # HTTP header 'Accept' (if needed)
353
+ local_header_accept = ['application/json']
354
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
355
+
356
+ # HTTP header 'Content-Type'
357
+ local_header_content_type = ['application/json']
358
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
359
+
360
+ # form parameters
361
+ form_params = {}
362
+
363
+ # http body (model)
364
+ post_body = nil
365
+
366
+ auth_names = ['PureCloud Auth']
367
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
368
+ :header_params => header_params,
369
+ :query_params => query_params,
370
+ :form_params => form_params,
371
+ :body => post_body,
372
+ :auth_names => auth_names)
373
+ if @api_client.config.debugging
374
+ @api_client.config.logger.debug "API called: QualityApi#delete_quality_forms_survey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
375
+ end
376
+ return data, status_code, headers
377
+ end
378
+
251
379
  # Delete a keywordSet by id.
252
380
  #
253
381
  # @param keyword_set_id KeywordSet ID
@@ -1628,36 +1756,36 @@ module PureCloud
1628
1756
  return data, status_code, headers
1629
1757
  end
1630
1758
 
1631
- # Get a keywordSet by id.
1759
+ # Get an evaluation form
1632
1760
  #
1633
- # @param keyword_set_id KeywordSet ID
1761
+ # @param form_id Form ID
1634
1762
  # @param [Hash] opts the optional parameters
1635
- # @return [KeywordSet]
1636
- def get_quality_keywordset(keyword_set_id, opts = {})
1637
- data, _status_code, _headers = get_quality_keywordset_with_http_info(keyword_set_id, opts)
1763
+ # @return [EvaluationForm]
1764
+ def get_quality_forms_evaluation(form_id, opts = {})
1765
+ data, _status_code, _headers = get_quality_forms_evaluation_with_http_info(form_id, opts)
1638
1766
  return data
1639
1767
  end
1640
1768
 
1641
- # Get a keywordSet by id.
1769
+ # Get an evaluation form
1642
1770
  #
1643
- # @param keyword_set_id KeywordSet ID
1771
+ # @param form_id Form ID
1644
1772
  # @param [Hash] opts the optional parameters
1645
- # @return [Array<(KeywordSet, Fixnum, Hash)>] KeywordSet data, response status code and response headers
1646
- def get_quality_keywordset_with_http_info(keyword_set_id, opts = {})
1773
+ # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
1774
+ def get_quality_forms_evaluation_with_http_info(form_id, opts = {})
1647
1775
  if @api_client.config.debugging
1648
- @api_client.config.logger.debug "Calling API: QualityApi.get_quality_keywordset ..."
1776
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_forms_evaluation ..."
1649
1777
  end
1650
1778
 
1651
1779
 
1652
- # verify the required parameter 'keyword_set_id' is set
1653
- fail ArgumentError, "Missing the required parameter 'keyword_set_id' when calling QualityApi.get_quality_keywordset" if keyword_set_id.nil?
1780
+ # verify the required parameter 'form_id' is set
1781
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.get_quality_forms_evaluation" if form_id.nil?
1654
1782
 
1655
1783
 
1656
1784
 
1657
1785
 
1658
1786
 
1659
1787
  # resource path
1660
- local_var_path = "/api/v2/quality/keywordsets/{keywordSetId}".sub('{format}','json').sub('{' + 'keywordSetId' + '}', keyword_set_id.to_s)
1788
+ local_var_path = "/api/v2/quality/forms/evaluations/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
1661
1789
 
1662
1790
  # query parameters
1663
1791
  query_params = {}
@@ -1686,52 +1814,41 @@ module PureCloud
1686
1814
  :form_params => form_params,
1687
1815
  :body => post_body,
1688
1816
  :auth_names => auth_names,
1689
- :return_type => 'KeywordSet')
1817
+ :return_type => 'EvaluationForm')
1690
1818
  if @api_client.config.debugging
1691
- @api_client.config.logger.debug "API called: QualityApi#get_quality_keywordset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1819
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_forms_evaluation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1692
1820
  end
1693
1821
  return data, status_code, headers
1694
1822
  end
1695
1823
 
1696
- # Get the list of keyword sets
1824
+ # Gets all the revisions for a specific evaluation.
1697
1825
  #
1826
+ # @param form_id Form ID
1698
1827
  # @param [Hash] opts the optional parameters
1699
- # @option opts [Integer] :page_size The total page size requested (default to 25)
1700
- # @option opts [Integer] :page_number The page number requested (default to 1)
1701
- # @option opts [String] :sort_by variable name requested to sort by
1702
- # @option opts [Array<Object>] :expand variable name requested by expand list
1703
- # @option opts [String] :next_page next page token
1704
- # @option opts [String] :previous_page Previous page token
1705
- # @option opts [String] :name the keyword set name - used for filtering results in searches.
1706
- # @option opts [String] :queue_id the queue id - used for filtering results in searches.
1707
- # @option opts [String] :agent_id the agent id - used for filtering results in searches.
1708
- # @option opts [String] :operator If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.
1709
- # @return [KeywordSetEntityListing]
1710
- def get_quality_keywordsets(opts = {})
1711
- data, _status_code, _headers = get_quality_keywordsets_with_http_info(opts)
1828
+ # @option opts [Integer] :page_size Page size (default to 25)
1829
+ # @option opts [Integer] :page_number Page number (default to 1)
1830
+ # @return [EvaluationFormEntityListing]
1831
+ def get_quality_forms_evaluation_versions(form_id, opts = {})
1832
+ data, _status_code, _headers = get_quality_forms_evaluation_versions_with_http_info(form_id, opts)
1712
1833
  return data
1713
1834
  end
1714
1835
 
1715
- # Get the list of keyword sets
1836
+ # Gets all the revisions for a specific evaluation.
1716
1837
  #
1838
+ # @param form_id Form ID
1717
1839
  # @param [Hash] opts the optional parameters
1718
- # @option opts [Integer] :page_size The total page size requested
1719
- # @option opts [Integer] :page_number The page number requested
1720
- # @option opts [String] :sort_by variable name requested to sort by
1721
- # @option opts [Array<Object>] :expand variable name requested by expand list
1722
- # @option opts [String] :next_page next page token
1723
- # @option opts [String] :previous_page Previous page token
1724
- # @option opts [String] :name the keyword set name - used for filtering results in searches.
1725
- # @option opts [String] :queue_id the queue id - used for filtering results in searches.
1726
- # @option opts [String] :agent_id the agent id - used for filtering results in searches.
1727
- # @option opts [String] :operator If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.
1728
- # @return [Array<(KeywordSetEntityListing, Fixnum, Hash)>] KeywordSetEntityListing data, response status code and response headers
1729
- def get_quality_keywordsets_with_http_info(opts = {})
1840
+ # @option opts [Integer] :page_size Page size
1841
+ # @option opts [Integer] :page_number Page number
1842
+ # @return [Array<(EvaluationFormEntityListing, Fixnum, Hash)>] EvaluationFormEntityListing data, response status code and response headers
1843
+ def get_quality_forms_evaluation_versions_with_http_info(form_id, opts = {})
1730
1844
  if @api_client.config.debugging
1731
- @api_client.config.logger.debug "Calling API: QualityApi.get_quality_keywordsets ..."
1845
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_forms_evaluation_versions ..."
1732
1846
  end
1733
1847
 
1734
1848
 
1849
+ # verify the required parameter 'form_id' is set
1850
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.get_quality_forms_evaluation_versions" if form_id.nil?
1851
+
1735
1852
 
1736
1853
 
1737
1854
 
@@ -1748,7 +1865,76 @@ module PureCloud
1748
1865
 
1749
1866
 
1750
1867
 
1868
+ # resource path
1869
+ local_var_path = "/api/v2/quality/forms/evaluations/{formId}/versions".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
1870
+
1871
+ # query parameters
1872
+ query_params = {}
1873
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1874
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1875
+
1876
+ # header parameters
1877
+ header_params = {}
1878
+
1879
+ # HTTP header 'Accept' (if needed)
1880
+ local_header_accept = ['application/json']
1881
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1882
+
1883
+ # HTTP header 'Content-Type'
1884
+ local_header_content_type = ['application/json']
1885
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1886
+
1887
+ # form parameters
1888
+ form_params = {}
1889
+
1890
+ # http body (model)
1891
+ post_body = nil
1751
1892
 
1893
+ auth_names = ['PureCloud Auth']
1894
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1895
+ :header_params => header_params,
1896
+ :query_params => query_params,
1897
+ :form_params => form_params,
1898
+ :body => post_body,
1899
+ :auth_names => auth_names,
1900
+ :return_type => 'EvaluationFormEntityListing')
1901
+ if @api_client.config.debugging
1902
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_forms_evaluation_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1903
+ end
1904
+ return data, status_code, headers
1905
+ end
1906
+
1907
+ # Get the list of evaluation forms
1908
+ #
1909
+ # @param [Hash] opts the optional parameters
1910
+ # @option opts [Integer] :page_size The total page size requested (default to 25)
1911
+ # @option opts [Integer] :page_number The page number requested (default to 1)
1912
+ # @option opts [String] :sort_by variable name requested to sort by
1913
+ # @option opts [String] :next_page next page token
1914
+ # @option opts [String] :previous_page Previous page token
1915
+ # @option opts [String] :expand Expand
1916
+ # @option opts [String] :name Name
1917
+ # @return [EvaluationFormEntityListing]
1918
+ def get_quality_forms_evaluations(opts = {})
1919
+ data, _status_code, _headers = get_quality_forms_evaluations_with_http_info(opts)
1920
+ return data
1921
+ end
1922
+
1923
+ # Get the list of evaluation forms
1924
+ #
1925
+ # @param [Hash] opts the optional parameters
1926
+ # @option opts [Integer] :page_size The total page size requested
1927
+ # @option opts [Integer] :page_number The page number requested
1928
+ # @option opts [String] :sort_by variable name requested to sort by
1929
+ # @option opts [String] :next_page next page token
1930
+ # @option opts [String] :previous_page Previous page token
1931
+ # @option opts [String] :expand Expand
1932
+ # @option opts [String] :name Name
1933
+ # @return [Array<(EvaluationFormEntityListing, Fixnum, Hash)>] EvaluationFormEntityListing data, response status code and response headers
1934
+ def get_quality_forms_evaluations_with_http_info(opts = {})
1935
+ if @api_client.config.debugging
1936
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_forms_evaluations ..."
1937
+ end
1752
1938
 
1753
1939
 
1754
1940
 
@@ -1788,28 +1974,22 @@ module PureCloud
1788
1974
 
1789
1975
 
1790
1976
 
1791
- if opts[:'operator'] && !['AND', 'OR'].include?(opts[:'operator'])
1792
- fail ArgumentError, 'invalid value for "operator", must be one of AND, OR'
1793
- end
1794
1977
 
1795
1978
 
1796
1979
 
1797
1980
 
1798
1981
  # resource path
1799
- local_var_path = "/api/v2/quality/keywordsets".sub('{format}','json')
1982
+ local_var_path = "/api/v2/quality/forms/evaluations".sub('{format}','json')
1800
1983
 
1801
1984
  # query parameters
1802
1985
  query_params = {}
1803
1986
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1804
1987
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1805
1988
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1806
- query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1807
1989
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
1808
1990
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
1991
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1809
1992
  query_params[:'name'] = opts[:'name'] if opts[:'name']
1810
- query_params[:'queueId'] = opts[:'queue_id'] if opts[:'queue_id']
1811
- query_params[:'agentId'] = opts[:'agent_id'] if opts[:'agent_id']
1812
- query_params[:'operator'] = opts[:'operator'] if opts[:'operator']
1813
1993
 
1814
1994
  # header parameters
1815
1995
  header_params = {}
@@ -1835,43 +2015,1039 @@ module PureCloud
1835
2015
  :form_params => form_params,
1836
2016
  :body => post_body,
1837
2017
  :auth_names => auth_names,
1838
- :return_type => 'KeywordSetEntityListing')
2018
+ :return_type => 'EvaluationFormEntityListing')
1839
2019
  if @api_client.config.debugging
1840
- @api_client.config.logger.debug "API called: QualityApi#get_quality_keywordsets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2020
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_forms_evaluations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1841
2021
  end
1842
2022
  return data, status_code, headers
1843
2023
  end
1844
2024
 
1845
- # Get the published evaluation forms.
2025
+ # Get a survey form
1846
2026
  #
1847
2027
  # @param form_id Form ID
1848
2028
  # @param [Hash] opts the optional parameters
1849
- # @return [EvaluationForm]
1850
- def get_quality_publishedform(form_id, opts = {})
1851
- data, _status_code, _headers = get_quality_publishedform_with_http_info(form_id, opts)
2029
+ # @return [SurveyForm]
2030
+ def get_quality_forms_survey(form_id, opts = {})
2031
+ data, _status_code, _headers = get_quality_forms_survey_with_http_info(form_id, opts)
1852
2032
  return data
1853
2033
  end
1854
2034
 
1855
- # Get the published evaluation forms.
2035
+ # Get a survey form
1856
2036
  #
1857
2037
  # @param form_id Form ID
1858
2038
  # @param [Hash] opts the optional parameters
1859
- # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
2039
+ # @return [Array<(SurveyForm, Fixnum, Hash)>] SurveyForm data, response status code and response headers
2040
+ def get_quality_forms_survey_with_http_info(form_id, opts = {})
2041
+ if @api_client.config.debugging
2042
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_forms_survey ..."
2043
+ end
2044
+
2045
+
2046
+ # verify the required parameter 'form_id' is set
2047
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.get_quality_forms_survey" if form_id.nil?
2048
+
2049
+
2050
+
2051
+
2052
+
2053
+ # resource path
2054
+ local_var_path = "/api/v2/quality/forms/surveys/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
2055
+
2056
+ # query parameters
2057
+ query_params = {}
2058
+
2059
+ # header parameters
2060
+ header_params = {}
2061
+
2062
+ # HTTP header 'Accept' (if needed)
2063
+ local_header_accept = ['application/json']
2064
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2065
+
2066
+ # HTTP header 'Content-Type'
2067
+ local_header_content_type = ['application/json']
2068
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2069
+
2070
+ # form parameters
2071
+ form_params = {}
2072
+
2073
+ # http body (model)
2074
+ post_body = nil
2075
+
2076
+ auth_names = ['PureCloud Auth']
2077
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2078
+ :header_params => header_params,
2079
+ :query_params => query_params,
2080
+ :form_params => form_params,
2081
+ :body => post_body,
2082
+ :auth_names => auth_names,
2083
+ :return_type => 'SurveyForm')
2084
+ if @api_client.config.debugging
2085
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_forms_survey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2086
+ end
2087
+ return data, status_code, headers
2088
+ end
2089
+
2090
+ # Gets all the revisions for a specific survey.
2091
+ #
2092
+ # @param form_id Form ID
2093
+ # @param [Hash] opts the optional parameters
2094
+ # @option opts [Integer] :page_size Page size (default to 25)
2095
+ # @option opts [Integer] :page_number Page number (default to 1)
2096
+ # @return [SurveyFormEntityListing]
2097
+ def get_quality_forms_survey_versions(form_id, opts = {})
2098
+ data, _status_code, _headers = get_quality_forms_survey_versions_with_http_info(form_id, opts)
2099
+ return data
2100
+ end
2101
+
2102
+ # Gets all the revisions for a specific survey.
2103
+ #
2104
+ # @param form_id Form ID
2105
+ # @param [Hash] opts the optional parameters
2106
+ # @option opts [Integer] :page_size Page size
2107
+ # @option opts [Integer] :page_number Page number
2108
+ # @return [Array<(SurveyFormEntityListing, Fixnum, Hash)>] SurveyFormEntityListing data, response status code and response headers
2109
+ def get_quality_forms_survey_versions_with_http_info(form_id, opts = {})
2110
+ if @api_client.config.debugging
2111
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_forms_survey_versions ..."
2112
+ end
2113
+
2114
+
2115
+ # verify the required parameter 'form_id' is set
2116
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.get_quality_forms_survey_versions" if form_id.nil?
2117
+
2118
+
2119
+
2120
+
2121
+
2122
+
2123
+
2124
+
2125
+
2126
+
2127
+
2128
+
2129
+
2130
+
2131
+
2132
+
2133
+
2134
+ # resource path
2135
+ local_var_path = "/api/v2/quality/forms/surveys/{formId}/versions".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
2136
+
2137
+ # query parameters
2138
+ query_params = {}
2139
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2140
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2141
+
2142
+ # header parameters
2143
+ header_params = {}
2144
+
2145
+ # HTTP header 'Accept' (if needed)
2146
+ local_header_accept = ['application/json']
2147
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2148
+
2149
+ # HTTP header 'Content-Type'
2150
+ local_header_content_type = ['application/json']
2151
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2152
+
2153
+ # form parameters
2154
+ form_params = {}
2155
+
2156
+ # http body (model)
2157
+ post_body = nil
2158
+
2159
+ auth_names = ['PureCloud Auth']
2160
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2161
+ :header_params => header_params,
2162
+ :query_params => query_params,
2163
+ :form_params => form_params,
2164
+ :body => post_body,
2165
+ :auth_names => auth_names,
2166
+ :return_type => 'SurveyFormEntityListing')
2167
+ if @api_client.config.debugging
2168
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_forms_survey_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2169
+ end
2170
+ return data, status_code, headers
2171
+ end
2172
+
2173
+ # Get the list of survey forms
2174
+ #
2175
+ # @param [Hash] opts the optional parameters
2176
+ # @option opts [Integer] :page_size The total page size requested (default to 25)
2177
+ # @option opts [Integer] :page_number The page number requested (default to 1)
2178
+ # @option opts [String] :sort_by variable name requested to sort by
2179
+ # @option opts [String] :next_page next page token
2180
+ # @option opts [String] :previous_page Previous page token
2181
+ # @option opts [String] :expand Expand
2182
+ # @option opts [String] :name Name
2183
+ # @return [SurveyFormEntityListing]
2184
+ def get_quality_forms_surveys(opts = {})
2185
+ data, _status_code, _headers = get_quality_forms_surveys_with_http_info(opts)
2186
+ return data
2187
+ end
2188
+
2189
+ # Get the list of survey forms
2190
+ #
2191
+ # @param [Hash] opts the optional parameters
2192
+ # @option opts [Integer] :page_size The total page size requested
2193
+ # @option opts [Integer] :page_number The page number requested
2194
+ # @option opts [String] :sort_by variable name requested to sort by
2195
+ # @option opts [String] :next_page next page token
2196
+ # @option opts [String] :previous_page Previous page token
2197
+ # @option opts [String] :expand Expand
2198
+ # @option opts [String] :name Name
2199
+ # @return [Array<(SurveyFormEntityListing, Fixnum, Hash)>] SurveyFormEntityListing data, response status code and response headers
2200
+ def get_quality_forms_surveys_with_http_info(opts = {})
2201
+ if @api_client.config.debugging
2202
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_forms_surveys ..."
2203
+ end
2204
+
2205
+
2206
+
2207
+
2208
+
2209
+
2210
+
2211
+
2212
+
2213
+
2214
+
2215
+
2216
+
2217
+
2218
+
2219
+
2220
+
2221
+
2222
+
2223
+
2224
+
2225
+
2226
+
2227
+
2228
+
2229
+
2230
+
2231
+
2232
+
2233
+
2234
+
2235
+
2236
+
2237
+
2238
+
2239
+
2240
+
2241
+
2242
+
2243
+
2244
+
2245
+
2246
+
2247
+ # resource path
2248
+ local_var_path = "/api/v2/quality/forms/surveys".sub('{format}','json')
2249
+
2250
+ # query parameters
2251
+ query_params = {}
2252
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2253
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2254
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
2255
+ query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
2256
+ query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
2257
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
2258
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
2259
+
2260
+ # header parameters
2261
+ header_params = {}
2262
+
2263
+ # HTTP header 'Accept' (if needed)
2264
+ local_header_accept = ['application/json']
2265
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2266
+
2267
+ # HTTP header 'Content-Type'
2268
+ local_header_content_type = ['application/json']
2269
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2270
+
2271
+ # form parameters
2272
+ form_params = {}
2273
+
2274
+ # http body (model)
2275
+ post_body = nil
2276
+
2277
+ auth_names = ['PureCloud Auth']
2278
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2279
+ :header_params => header_params,
2280
+ :query_params => query_params,
2281
+ :form_params => form_params,
2282
+ :body => post_body,
2283
+ :auth_names => auth_names,
2284
+ :return_type => 'SurveyFormEntityListing')
2285
+ if @api_client.config.debugging
2286
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_forms_surveys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2287
+ end
2288
+ return data, status_code, headers
2289
+ end
2290
+
2291
+ # Get a keywordSet by id.
2292
+ #
2293
+ # @param keyword_set_id KeywordSet ID
2294
+ # @param [Hash] opts the optional parameters
2295
+ # @return [KeywordSet]
2296
+ def get_quality_keywordset(keyword_set_id, opts = {})
2297
+ data, _status_code, _headers = get_quality_keywordset_with_http_info(keyword_set_id, opts)
2298
+ return data
2299
+ end
2300
+
2301
+ # Get a keywordSet by id.
2302
+ #
2303
+ # @param keyword_set_id KeywordSet ID
2304
+ # @param [Hash] opts the optional parameters
2305
+ # @return [Array<(KeywordSet, Fixnum, Hash)>] KeywordSet data, response status code and response headers
2306
+ def get_quality_keywordset_with_http_info(keyword_set_id, opts = {})
2307
+ if @api_client.config.debugging
2308
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_keywordset ..."
2309
+ end
2310
+
2311
+
2312
+ # verify the required parameter 'keyword_set_id' is set
2313
+ fail ArgumentError, "Missing the required parameter 'keyword_set_id' when calling QualityApi.get_quality_keywordset" if keyword_set_id.nil?
2314
+
2315
+
2316
+
2317
+
2318
+
2319
+ # resource path
2320
+ local_var_path = "/api/v2/quality/keywordsets/{keywordSetId}".sub('{format}','json').sub('{' + 'keywordSetId' + '}', keyword_set_id.to_s)
2321
+
2322
+ # query parameters
2323
+ query_params = {}
2324
+
2325
+ # header parameters
2326
+ header_params = {}
2327
+
2328
+ # HTTP header 'Accept' (if needed)
2329
+ local_header_accept = ['application/json']
2330
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2331
+
2332
+ # HTTP header 'Content-Type'
2333
+ local_header_content_type = ['application/json']
2334
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2335
+
2336
+ # form parameters
2337
+ form_params = {}
2338
+
2339
+ # http body (model)
2340
+ post_body = nil
2341
+
2342
+ auth_names = ['PureCloud Auth']
2343
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2344
+ :header_params => header_params,
2345
+ :query_params => query_params,
2346
+ :form_params => form_params,
2347
+ :body => post_body,
2348
+ :auth_names => auth_names,
2349
+ :return_type => 'KeywordSet')
2350
+ if @api_client.config.debugging
2351
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_keywordset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2352
+ end
2353
+ return data, status_code, headers
2354
+ end
2355
+
2356
+ # Get the list of keyword sets
2357
+ #
2358
+ # @param [Hash] opts the optional parameters
2359
+ # @option opts [Integer] :page_size The total page size requested (default to 25)
2360
+ # @option opts [Integer] :page_number The page number requested (default to 1)
2361
+ # @option opts [String] :sort_by variable name requested to sort by
2362
+ # @option opts [Array<Object>] :expand variable name requested by expand list
2363
+ # @option opts [String] :next_page next page token
2364
+ # @option opts [String] :previous_page Previous page token
2365
+ # @option opts [String] :name the keyword set name - used for filtering results in searches.
2366
+ # @option opts [String] :queue_id the queue id - used for filtering results in searches.
2367
+ # @option opts [String] :agent_id the agent id - used for filtering results in searches.
2368
+ # @option opts [String] :operator If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.
2369
+ # @return [KeywordSetEntityListing]
2370
+ def get_quality_keywordsets(opts = {})
2371
+ data, _status_code, _headers = get_quality_keywordsets_with_http_info(opts)
2372
+ return data
2373
+ end
2374
+
2375
+ # Get the list of keyword sets
2376
+ #
2377
+ # @param [Hash] opts the optional parameters
2378
+ # @option opts [Integer] :page_size The total page size requested
2379
+ # @option opts [Integer] :page_number The page number requested
2380
+ # @option opts [String] :sort_by variable name requested to sort by
2381
+ # @option opts [Array<Object>] :expand variable name requested by expand list
2382
+ # @option opts [String] :next_page next page token
2383
+ # @option opts [String] :previous_page Previous page token
2384
+ # @option opts [String] :name the keyword set name - used for filtering results in searches.
2385
+ # @option opts [String] :queue_id the queue id - used for filtering results in searches.
2386
+ # @option opts [String] :agent_id the agent id - used for filtering results in searches.
2387
+ # @option opts [String] :operator If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.
2388
+ # @return [Array<(KeywordSetEntityListing, Fixnum, Hash)>] KeywordSetEntityListing data, response status code and response headers
2389
+ def get_quality_keywordsets_with_http_info(opts = {})
2390
+ if @api_client.config.debugging
2391
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_keywordsets ..."
2392
+ end
2393
+
2394
+
2395
+
2396
+
2397
+
2398
+
2399
+
2400
+
2401
+
2402
+
2403
+
2404
+
2405
+
2406
+
2407
+
2408
+
2409
+
2410
+
2411
+
2412
+
2413
+
2414
+
2415
+
2416
+
2417
+
2418
+
2419
+
2420
+
2421
+
2422
+
2423
+
2424
+
2425
+
2426
+
2427
+
2428
+
2429
+
2430
+
2431
+
2432
+
2433
+
2434
+
2435
+
2436
+
2437
+
2438
+
2439
+
2440
+
2441
+
2442
+
2443
+
2444
+
2445
+
2446
+
2447
+
2448
+
2449
+
2450
+
2451
+ if opts[:'operator'] && !['AND', 'OR'].include?(opts[:'operator'])
2452
+ fail ArgumentError, 'invalid value for "operator", must be one of AND, OR'
2453
+ end
2454
+
2455
+
2456
+
2457
+
2458
+ # resource path
2459
+ local_var_path = "/api/v2/quality/keywordsets".sub('{format}','json')
2460
+
2461
+ # query parameters
2462
+ query_params = {}
2463
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2464
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2465
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
2466
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
2467
+ query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
2468
+ query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
2469
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
2470
+ query_params[:'queueId'] = opts[:'queue_id'] if opts[:'queue_id']
2471
+ query_params[:'agentId'] = opts[:'agent_id'] if opts[:'agent_id']
2472
+ query_params[:'operator'] = opts[:'operator'] if opts[:'operator']
2473
+
2474
+ # header parameters
2475
+ header_params = {}
2476
+
2477
+ # HTTP header 'Accept' (if needed)
2478
+ local_header_accept = ['application/json']
2479
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2480
+
2481
+ # HTTP header 'Content-Type'
2482
+ local_header_content_type = ['application/json']
2483
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2484
+
2485
+ # form parameters
2486
+ form_params = {}
2487
+
2488
+ # http body (model)
2489
+ post_body = nil
2490
+
2491
+ auth_names = ['PureCloud Auth']
2492
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2493
+ :header_params => header_params,
2494
+ :query_params => query_params,
2495
+ :form_params => form_params,
2496
+ :body => post_body,
2497
+ :auth_names => auth_names,
2498
+ :return_type => 'KeywordSetEntityListing')
2499
+ if @api_client.config.debugging
2500
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_keywordsets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2501
+ end
2502
+ return data, status_code, headers
2503
+ end
2504
+
2505
+ # Get the published evaluation forms.
2506
+ #
2507
+ # @param form_id Form ID
2508
+ # @param [Hash] opts the optional parameters
2509
+ # @return [EvaluationForm]
2510
+ def get_quality_publishedform(form_id, opts = {})
2511
+ data, _status_code, _headers = get_quality_publishedform_with_http_info(form_id, opts)
2512
+ return data
2513
+ end
2514
+
2515
+ # Get the published evaluation forms.
2516
+ #
2517
+ # @param form_id Form ID
2518
+ # @param [Hash] opts the optional parameters
2519
+ # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
1860
2520
  def get_quality_publishedform_with_http_info(form_id, opts = {})
1861
2521
  if @api_client.config.debugging
1862
- @api_client.config.logger.debug "Calling API: QualityApi.get_quality_publishedform ..."
2522
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_publishedform ..."
2523
+ end
2524
+
2525
+
2526
+ # verify the required parameter 'form_id' is set
2527
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.get_quality_publishedform" if form_id.nil?
2528
+
2529
+
2530
+
2531
+
2532
+
2533
+ # resource path
2534
+ local_var_path = "/api/v2/quality/publishedforms/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
2535
+
2536
+ # query parameters
2537
+ query_params = {}
2538
+
2539
+ # header parameters
2540
+ header_params = {}
2541
+
2542
+ # HTTP header 'Accept' (if needed)
2543
+ local_header_accept = ['application/json']
2544
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2545
+
2546
+ # HTTP header 'Content-Type'
2547
+ local_header_content_type = ['application/json']
2548
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2549
+
2550
+ # form parameters
2551
+ form_params = {}
2552
+
2553
+ # http body (model)
2554
+ post_body = nil
2555
+
2556
+ auth_names = ['PureCloud Auth']
2557
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2558
+ :header_params => header_params,
2559
+ :query_params => query_params,
2560
+ :form_params => form_params,
2561
+ :body => post_body,
2562
+ :auth_names => auth_names,
2563
+ :return_type => 'EvaluationForm')
2564
+ if @api_client.config.debugging
2565
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_publishedform\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2566
+ end
2567
+ return data, status_code, headers
2568
+ end
2569
+
2570
+ # Get the published evaluation forms.
2571
+ #
2572
+ # @param [Hash] opts the optional parameters
2573
+ # @option opts [Integer] :page_size Page size (default to 25)
2574
+ # @option opts [Integer] :page_number Page number (default to 1)
2575
+ # @option opts [String] :name Name
2576
+ # @return [EvaluationFormEntityListing]
2577
+ def get_quality_publishedforms(opts = {})
2578
+ data, _status_code, _headers = get_quality_publishedforms_with_http_info(opts)
2579
+ return data
2580
+ end
2581
+
2582
+ # Get the published evaluation forms.
2583
+ #
2584
+ # @param [Hash] opts the optional parameters
2585
+ # @option opts [Integer] :page_size Page size
2586
+ # @option opts [Integer] :page_number Page number
2587
+ # @option opts [String] :name Name
2588
+ # @return [Array<(EvaluationFormEntityListing, Fixnum, Hash)>] EvaluationFormEntityListing data, response status code and response headers
2589
+ def get_quality_publishedforms_with_http_info(opts = {})
2590
+ if @api_client.config.debugging
2591
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_publishedforms ..."
2592
+ end
2593
+
2594
+
2595
+
2596
+
2597
+
2598
+
2599
+
2600
+
2601
+
2602
+
2603
+
2604
+
2605
+
2606
+
2607
+
2608
+
2609
+
2610
+
2611
+
2612
+ # resource path
2613
+ local_var_path = "/api/v2/quality/publishedforms".sub('{format}','json')
2614
+
2615
+ # query parameters
2616
+ query_params = {}
2617
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2618
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2619
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
2620
+
2621
+ # header parameters
2622
+ header_params = {}
2623
+
2624
+ # HTTP header 'Accept' (if needed)
2625
+ local_header_accept = ['application/json']
2626
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2627
+
2628
+ # HTTP header 'Content-Type'
2629
+ local_header_content_type = ['application/json']
2630
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2631
+
2632
+ # form parameters
2633
+ form_params = {}
2634
+
2635
+ # http body (model)
2636
+ post_body = nil
2637
+
2638
+ auth_names = ['PureCloud Auth']
2639
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2640
+ :header_params => header_params,
2641
+ :query_params => query_params,
2642
+ :form_params => form_params,
2643
+ :body => post_body,
2644
+ :auth_names => auth_names,
2645
+ :return_type => 'EvaluationFormEntityListing')
2646
+ if @api_client.config.debugging
2647
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_publishedforms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2648
+ end
2649
+ return data, status_code, headers
2650
+ end
2651
+
2652
+ # Get the most recent published version of an evaluation form.
2653
+ #
2654
+ # @param form_id Form ID
2655
+ # @param [Hash] opts the optional parameters
2656
+ # @return [EvaluationForm]
2657
+ def get_quality_publishedforms_evaluation(form_id, opts = {})
2658
+ data, _status_code, _headers = get_quality_publishedforms_evaluation_with_http_info(form_id, opts)
2659
+ return data
2660
+ end
2661
+
2662
+ # Get the most recent published version of an evaluation form.
2663
+ #
2664
+ # @param form_id Form ID
2665
+ # @param [Hash] opts the optional parameters
2666
+ # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
2667
+ def get_quality_publishedforms_evaluation_with_http_info(form_id, opts = {})
2668
+ if @api_client.config.debugging
2669
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_publishedforms_evaluation ..."
2670
+ end
2671
+
2672
+
2673
+ # verify the required parameter 'form_id' is set
2674
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.get_quality_publishedforms_evaluation" if form_id.nil?
2675
+
2676
+
2677
+
2678
+
2679
+
2680
+ # resource path
2681
+ local_var_path = "/api/v2/quality/publishedforms/evaluations/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
2682
+
2683
+ # query parameters
2684
+ query_params = {}
2685
+
2686
+ # header parameters
2687
+ header_params = {}
2688
+
2689
+ # HTTP header 'Accept' (if needed)
2690
+ local_header_accept = ['application/json']
2691
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2692
+
2693
+ # HTTP header 'Content-Type'
2694
+ local_header_content_type = ['application/json']
2695
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2696
+
2697
+ # form parameters
2698
+ form_params = {}
2699
+
2700
+ # http body (model)
2701
+ post_body = nil
2702
+
2703
+ auth_names = ['PureCloud Auth']
2704
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2705
+ :header_params => header_params,
2706
+ :query_params => query_params,
2707
+ :form_params => form_params,
2708
+ :body => post_body,
2709
+ :auth_names => auth_names,
2710
+ :return_type => 'EvaluationForm')
2711
+ if @api_client.config.debugging
2712
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_publishedforms_evaluation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2713
+ end
2714
+ return data, status_code, headers
2715
+ end
2716
+
2717
+ # Get the published evaluation forms.
2718
+ #
2719
+ # @param [Hash] opts the optional parameters
2720
+ # @option opts [Integer] :page_size Page size (default to 25)
2721
+ # @option opts [Integer] :page_number Page number (default to 1)
2722
+ # @option opts [String] :name Name
2723
+ # @return [EvaluationFormEntityListing]
2724
+ def get_quality_publishedforms_evaluations(opts = {})
2725
+ data, _status_code, _headers = get_quality_publishedforms_evaluations_with_http_info(opts)
2726
+ return data
2727
+ end
2728
+
2729
+ # Get the published evaluation forms.
2730
+ #
2731
+ # @param [Hash] opts the optional parameters
2732
+ # @option opts [Integer] :page_size Page size
2733
+ # @option opts [Integer] :page_number Page number
2734
+ # @option opts [String] :name Name
2735
+ # @return [Array<(EvaluationFormEntityListing, Fixnum, Hash)>] EvaluationFormEntityListing data, response status code and response headers
2736
+ def get_quality_publishedforms_evaluations_with_http_info(opts = {})
2737
+ if @api_client.config.debugging
2738
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_publishedforms_evaluations ..."
2739
+ end
2740
+
2741
+
2742
+
2743
+
2744
+
2745
+
2746
+
2747
+
2748
+
2749
+
2750
+
2751
+
2752
+
2753
+
2754
+
2755
+
2756
+
2757
+
2758
+
2759
+ # resource path
2760
+ local_var_path = "/api/v2/quality/publishedforms/evaluations".sub('{format}','json')
2761
+
2762
+ # query parameters
2763
+ query_params = {}
2764
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2765
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2766
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
2767
+
2768
+ # header parameters
2769
+ header_params = {}
2770
+
2771
+ # HTTP header 'Accept' (if needed)
2772
+ local_header_accept = ['application/json']
2773
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2774
+
2775
+ # HTTP header 'Content-Type'
2776
+ local_header_content_type = ['application/json']
2777
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2778
+
2779
+ # form parameters
2780
+ form_params = {}
2781
+
2782
+ # http body (model)
2783
+ post_body = nil
2784
+
2785
+ auth_names = ['PureCloud Auth']
2786
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2787
+ :header_params => header_params,
2788
+ :query_params => query_params,
2789
+ :form_params => form_params,
2790
+ :body => post_body,
2791
+ :auth_names => auth_names,
2792
+ :return_type => 'EvaluationFormEntityListing')
2793
+ if @api_client.config.debugging
2794
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_publishedforms_evaluations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2795
+ end
2796
+ return data, status_code, headers
2797
+ end
2798
+
2799
+ # Get the most recent published version of a survey form.
2800
+ #
2801
+ # @param form_id Form ID
2802
+ # @param [Hash] opts the optional parameters
2803
+ # @return [SurveyForm]
2804
+ def get_quality_publishedforms_survey(form_id, opts = {})
2805
+ data, _status_code, _headers = get_quality_publishedforms_survey_with_http_info(form_id, opts)
2806
+ return data
2807
+ end
2808
+
2809
+ # Get the most recent published version of a survey form.
2810
+ #
2811
+ # @param form_id Form ID
2812
+ # @param [Hash] opts the optional parameters
2813
+ # @return [Array<(SurveyForm, Fixnum, Hash)>] SurveyForm data, response status code and response headers
2814
+ def get_quality_publishedforms_survey_with_http_info(form_id, opts = {})
2815
+ if @api_client.config.debugging
2816
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_publishedforms_survey ..."
2817
+ end
2818
+
2819
+
2820
+ # verify the required parameter 'form_id' is set
2821
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.get_quality_publishedforms_survey" if form_id.nil?
2822
+
2823
+
2824
+
2825
+
2826
+
2827
+ # resource path
2828
+ local_var_path = "/api/v2/quality/publishedforms/surveys/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
2829
+
2830
+ # query parameters
2831
+ query_params = {}
2832
+
2833
+ # header parameters
2834
+ header_params = {}
2835
+
2836
+ # HTTP header 'Accept' (if needed)
2837
+ local_header_accept = ['application/json']
2838
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2839
+
2840
+ # HTTP header 'Content-Type'
2841
+ local_header_content_type = ['application/json']
2842
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2843
+
2844
+ # form parameters
2845
+ form_params = {}
2846
+
2847
+ # http body (model)
2848
+ post_body = nil
2849
+
2850
+ auth_names = ['PureCloud Auth']
2851
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2852
+ :header_params => header_params,
2853
+ :query_params => query_params,
2854
+ :form_params => form_params,
2855
+ :body => post_body,
2856
+ :auth_names => auth_names,
2857
+ :return_type => 'SurveyForm')
2858
+ if @api_client.config.debugging
2859
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_publishedforms_survey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2860
+ end
2861
+ return data, status_code, headers
2862
+ end
2863
+
2864
+ # Get the published survey forms.
2865
+ #
2866
+ # @param [Hash] opts the optional parameters
2867
+ # @option opts [Integer] :page_size Page size (default to 25)
2868
+ # @option opts [Integer] :page_number Page number (default to 1)
2869
+ # @option opts [String] :name Name
2870
+ # @return [SurveyFormEntityListing]
2871
+ def get_quality_publishedforms_surveys(opts = {})
2872
+ data, _status_code, _headers = get_quality_publishedforms_surveys_with_http_info(opts)
2873
+ return data
2874
+ end
2875
+
2876
+ # Get the published survey forms.
2877
+ #
2878
+ # @param [Hash] opts the optional parameters
2879
+ # @option opts [Integer] :page_size Page size
2880
+ # @option opts [Integer] :page_number Page number
2881
+ # @option opts [String] :name Name
2882
+ # @return [Array<(SurveyFormEntityListing, Fixnum, Hash)>] SurveyFormEntityListing data, response status code and response headers
2883
+ def get_quality_publishedforms_surveys_with_http_info(opts = {})
2884
+ if @api_client.config.debugging
2885
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_publishedforms_surveys ..."
2886
+ end
2887
+
2888
+
2889
+
2890
+
2891
+
2892
+
2893
+
2894
+
2895
+
2896
+
2897
+
2898
+
2899
+
2900
+
2901
+
2902
+
2903
+
2904
+
2905
+
2906
+ # resource path
2907
+ local_var_path = "/api/v2/quality/publishedforms/surveys".sub('{format}','json')
2908
+
2909
+ # query parameters
2910
+ query_params = {}
2911
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2912
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2913
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
2914
+
2915
+ # header parameters
2916
+ header_params = {}
2917
+
2918
+ # HTTP header 'Accept' (if needed)
2919
+ local_header_accept = ['application/json']
2920
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2921
+
2922
+ # HTTP header 'Content-Type'
2923
+ local_header_content_type = ['application/json']
2924
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2925
+
2926
+ # form parameters
2927
+ form_params = {}
2928
+
2929
+ # http body (model)
2930
+ post_body = nil
2931
+
2932
+ auth_names = ['PureCloud Auth']
2933
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2934
+ :header_params => header_params,
2935
+ :query_params => query_params,
2936
+ :form_params => form_params,
2937
+ :body => post_body,
2938
+ :auth_names => auth_names,
2939
+ :return_type => 'SurveyFormEntityListing')
2940
+ if @api_client.config.debugging
2941
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_publishedforms_surveys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2942
+ end
2943
+ return data, status_code, headers
2944
+ end
2945
+
2946
+ # 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.
2947
+ #
2948
+ # @param form_id Form ID
2949
+ # @param body Survey form
2950
+ # @param [Hash] opts the optional parameters
2951
+ # @return [SurveyForm]
2952
+ def patch_quality_forms_survey(form_id, body, opts = {})
2953
+ data, _status_code, _headers = patch_quality_forms_survey_with_http_info(form_id, body, opts)
2954
+ return data
2955
+ end
2956
+
2957
+ # 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.
2958
+ #
2959
+ # @param form_id Form ID
2960
+ # @param body Survey form
2961
+ # @param [Hash] opts the optional parameters
2962
+ # @return [Array<(SurveyForm, Fixnum, Hash)>] SurveyForm data, response status code and response headers
2963
+ def patch_quality_forms_survey_with_http_info(form_id, body, opts = {})
2964
+ if @api_client.config.debugging
2965
+ @api_client.config.logger.debug "Calling API: QualityApi.patch_quality_forms_survey ..."
2966
+ end
2967
+
2968
+
2969
+ # verify the required parameter 'form_id' is set
2970
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.patch_quality_forms_survey" if form_id.nil?
2971
+
2972
+
2973
+
2974
+
2975
+
2976
+
2977
+ # verify the required parameter 'body' is set
2978
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.patch_quality_forms_survey" if body.nil?
2979
+
2980
+
2981
+
2982
+
2983
+
2984
+ # resource path
2985
+ local_var_path = "/api/v2/quality/forms/surveys/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
2986
+
2987
+ # query parameters
2988
+ query_params = {}
2989
+
2990
+ # header parameters
2991
+ header_params = {}
2992
+
2993
+ # HTTP header 'Accept' (if needed)
2994
+ local_header_accept = ['application/json']
2995
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2996
+
2997
+ # HTTP header 'Content-Type'
2998
+ local_header_content_type = ['application/json']
2999
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3000
+
3001
+ # form parameters
3002
+ form_params = {}
3003
+
3004
+ # http body (model)
3005
+ post_body = @api_client.object_to_http_body(body)
3006
+
3007
+ auth_names = ['PureCloud Auth']
3008
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
3009
+ :header_params => header_params,
3010
+ :query_params => query_params,
3011
+ :form_params => form_params,
3012
+ :body => post_body,
3013
+ :auth_names => auth_names,
3014
+ :return_type => 'SurveyForm')
3015
+ if @api_client.config.debugging
3016
+ @api_client.config.logger.debug "API called: QualityApi#patch_quality_forms_survey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3017
+ end
3018
+ return data, status_code, headers
3019
+ end
3020
+
3021
+ # Query for evaluation aggregates
3022
+ #
3023
+ # @param body query
3024
+ # @param [Hash] opts the optional parameters
3025
+ # @return [AggregateQueryResponse]
3026
+ def post_analytics_evaluations_aggregates_query(body, opts = {})
3027
+ data, _status_code, _headers = post_analytics_evaluations_aggregates_query_with_http_info(body, opts)
3028
+ return data
3029
+ end
3030
+
3031
+ # Query for evaluation aggregates
3032
+ #
3033
+ # @param body query
3034
+ # @param [Hash] opts the optional parameters
3035
+ # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers
3036
+ def post_analytics_evaluations_aggregates_query_with_http_info(body, opts = {})
3037
+ if @api_client.config.debugging
3038
+ @api_client.config.logger.debug "Calling API: QualityApi.post_analytics_evaluations_aggregates_query ..."
1863
3039
  end
1864
3040
 
1865
3041
 
1866
- # verify the required parameter 'form_id' is set
1867
- fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.get_quality_publishedform" if form_id.nil?
3042
+ # verify the required parameter 'body' is set
3043
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_analytics_evaluations_aggregates_query" if body.nil?
1868
3044
 
1869
3045
 
1870
3046
 
1871
3047
 
1872
3048
 
1873
3049
  # resource path
1874
- local_var_path = "/api/v2/quality/publishedforms/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
3050
+ local_var_path = "/api/v2/analytics/evaluations/aggregates/query".sub('{format}','json')
1875
3051
 
1876
3052
  # query parameters
1877
3053
  query_params = {}
@@ -1891,53 +3067,131 @@ module PureCloud
1891
3067
  form_params = {}
1892
3068
 
1893
3069
  # http body (model)
1894
- post_body = nil
3070
+ post_body = @api_client.object_to_http_body(body)
1895
3071
 
1896
3072
  auth_names = ['PureCloud Auth']
1897
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3073
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1898
3074
  :header_params => header_params,
1899
3075
  :query_params => query_params,
1900
3076
  :form_params => form_params,
1901
3077
  :body => post_body,
1902
3078
  :auth_names => auth_names,
1903
- :return_type => 'EvaluationForm')
3079
+ :return_type => 'AggregateQueryResponse')
1904
3080
  if @api_client.config.debugging
1905
- @api_client.config.logger.debug "API called: QualityApi#get_quality_publishedform\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3081
+ @api_client.config.logger.debug "API called: QualityApi#post_analytics_evaluations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1906
3082
  end
1907
3083
  return data, status_code, headers
1908
3084
  end
1909
3085
 
1910
- # Get the published evaluation forms.
3086
+ # Create a calibration
1911
3087
  #
3088
+ # @param body calibration
1912
3089
  # @param [Hash] opts the optional parameters
1913
- # @option opts [Integer] :page_size Page size (default to 25)
1914
- # @option opts [Integer] :page_number Page number (default to 1)
1915
- # @option opts [String] :name Name
1916
- # @return [EvaluationFormEntityListing]
1917
- def get_quality_publishedforms(opts = {})
1918
- data, _status_code, _headers = get_quality_publishedforms_with_http_info(opts)
3090
+ # @option opts [String] :expand calibratorId
3091
+ # @return [Calibration]
3092
+ def post_quality_calibrations(body, opts = {})
3093
+ data, _status_code, _headers = post_quality_calibrations_with_http_info(body, opts)
1919
3094
  return data
1920
3095
  end
1921
3096
 
1922
- # Get the published evaluation forms.
3097
+ # Create a calibration
1923
3098
  #
3099
+ # @param body calibration
1924
3100
  # @param [Hash] opts the optional parameters
1925
- # @option opts [Integer] :page_size Page size
1926
- # @option opts [Integer] :page_number Page number
1927
- # @option opts [String] :name Name
1928
- # @return [Array<(EvaluationFormEntityListing, Fixnum, Hash)>] EvaluationFormEntityListing data, response status code and response headers
1929
- def get_quality_publishedforms_with_http_info(opts = {})
3101
+ # @option opts [String] :expand calibratorId
3102
+ # @return [Array<(Calibration, Fixnum, Hash)>] Calibration data, response status code and response headers
3103
+ def post_quality_calibrations_with_http_info(body, opts = {})
1930
3104
  if @api_client.config.debugging
1931
- @api_client.config.logger.debug "Calling API: QualityApi.get_quality_publishedforms ..."
3105
+ @api_client.config.logger.debug "Calling API: QualityApi.post_quality_calibrations ..."
3106
+ end
3107
+
3108
+
3109
+ # verify the required parameter 'body' is set
3110
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_calibrations" if body.nil?
3111
+
3112
+
3113
+
3114
+
3115
+
3116
+
3117
+
3118
+
3119
+
3120
+
3121
+
3122
+ # resource path
3123
+ local_var_path = "/api/v2/quality/calibrations".sub('{format}','json')
3124
+
3125
+ # query parameters
3126
+ query_params = {}
3127
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
3128
+
3129
+ # header parameters
3130
+ header_params = {}
3131
+
3132
+ # HTTP header 'Accept' (if needed)
3133
+ local_header_accept = ['application/json']
3134
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3135
+
3136
+ # HTTP header 'Content-Type'
3137
+ local_header_content_type = ['application/json']
3138
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3139
+
3140
+ # form parameters
3141
+ form_params = {}
3142
+
3143
+ # http body (model)
3144
+ post_body = @api_client.object_to_http_body(body)
3145
+
3146
+ auth_names = ['PureCloud Auth']
3147
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3148
+ :header_params => header_params,
3149
+ :query_params => query_params,
3150
+ :form_params => form_params,
3151
+ :body => post_body,
3152
+ :auth_names => auth_names,
3153
+ :return_type => 'Calibration')
3154
+ if @api_client.config.debugging
3155
+ @api_client.config.logger.debug "API called: QualityApi#post_quality_calibrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3156
+ end
3157
+ return data, status_code, headers
3158
+ end
3159
+
3160
+ # Create an evaluation
3161
+ #
3162
+ # @param conversation_id conversationId
3163
+ # @param body evaluation
3164
+ # @param [Hash] opts the optional parameters
3165
+ # @option opts [String] :expand evaluatorId
3166
+ # @return [Evaluation]
3167
+ def post_quality_conversation_evaluations(conversation_id, body, opts = {})
3168
+ data, _status_code, _headers = post_quality_conversation_evaluations_with_http_info(conversation_id, body, opts)
3169
+ return data
3170
+ end
3171
+
3172
+ # Create an evaluation
3173
+ #
3174
+ # @param conversation_id conversationId
3175
+ # @param body evaluation
3176
+ # @param [Hash] opts the optional parameters
3177
+ # @option opts [String] :expand evaluatorId
3178
+ # @return [Array<(Evaluation, Fixnum, Hash)>] Evaluation data, response status code and response headers
3179
+ def post_quality_conversation_evaluations_with_http_info(conversation_id, body, opts = {})
3180
+ if @api_client.config.debugging
3181
+ @api_client.config.logger.debug "Calling API: QualityApi.post_quality_conversation_evaluations ..."
1932
3182
  end
1933
3183
 
1934
3184
 
3185
+ # verify the required parameter 'conversation_id' is set
3186
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling QualityApi.post_quality_conversation_evaluations" if conversation_id.nil?
1935
3187
 
1936
3188
 
1937
3189
 
1938
3190
 
1939
3191
 
1940
3192
 
3193
+ # verify the required parameter 'body' is set
3194
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_conversation_evaluations" if body.nil?
1941
3195
 
1942
3196
 
1943
3197
 
@@ -1950,13 +3204,11 @@ module PureCloud
1950
3204
 
1951
3205
 
1952
3206
  # resource path
1953
- local_var_path = "/api/v2/quality/publishedforms".sub('{format}','json')
3207
+ local_var_path = "/api/v2/quality/conversations/{conversationId}/evaluations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
1954
3208
 
1955
3209
  # query parameters
1956
3210
  query_params = {}
1957
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1958
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1959
- query_params[:'name'] = opts[:'name'] if opts[:'name']
3211
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1960
3212
 
1961
3213
  # header parameters
1962
3214
  header_params = {}
@@ -1973,52 +3225,52 @@ module PureCloud
1973
3225
  form_params = {}
1974
3226
 
1975
3227
  # http body (model)
1976
- post_body = nil
3228
+ post_body = @api_client.object_to_http_body(body)
1977
3229
 
1978
3230
  auth_names = ['PureCloud Auth']
1979
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3231
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1980
3232
  :header_params => header_params,
1981
3233
  :query_params => query_params,
1982
3234
  :form_params => form_params,
1983
3235
  :body => post_body,
1984
3236
  :auth_names => auth_names,
1985
- :return_type => 'EvaluationFormEntityListing')
3237
+ :return_type => 'Evaluation')
1986
3238
  if @api_client.config.debugging
1987
- @api_client.config.logger.debug "API called: QualityApi#get_quality_publishedforms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3239
+ @api_client.config.logger.debug "API called: QualityApi#post_quality_conversation_evaluations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1988
3240
  end
1989
3241
  return data, status_code, headers
1990
3242
  end
1991
3243
 
1992
- # Query for evaluation aggregates
3244
+ # Score evaluation
1993
3245
  #
1994
- # @param body query
3246
+ # @param body evaluationAndScoringSet
1995
3247
  # @param [Hash] opts the optional parameters
1996
- # @return [AggregateQueryResponse]
1997
- def post_analytics_evaluations_aggregates_query(body, opts = {})
1998
- data, _status_code, _headers = post_analytics_evaluations_aggregates_query_with_http_info(body, opts)
3248
+ # @return [EvaluationScoringSet]
3249
+ def post_quality_evaluations_scoring(body, opts = {})
3250
+ data, _status_code, _headers = post_quality_evaluations_scoring_with_http_info(body, opts)
1999
3251
  return data
2000
3252
  end
2001
3253
 
2002
- # Query for evaluation aggregates
3254
+ # Score evaluation
2003
3255
  #
2004
- # @param body query
3256
+ # @param body evaluationAndScoringSet
2005
3257
  # @param [Hash] opts the optional parameters
2006
- # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers
2007
- def post_analytics_evaluations_aggregates_query_with_http_info(body, opts = {})
3258
+ # @return [Array<(EvaluationScoringSet, Fixnum, Hash)>] EvaluationScoringSet data, response status code and response headers
3259
+ def post_quality_evaluations_scoring_with_http_info(body, opts = {})
2008
3260
  if @api_client.config.debugging
2009
- @api_client.config.logger.debug "Calling API: QualityApi.post_analytics_evaluations_aggregates_query ..."
3261
+ @api_client.config.logger.debug "Calling API: QualityApi.post_quality_evaluations_scoring ..."
2010
3262
  end
2011
3263
 
2012
3264
 
2013
3265
  # verify the required parameter 'body' is set
2014
- fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_analytics_evaluations_aggregates_query" if body.nil?
3266
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_evaluations_scoring" if body.nil?
2015
3267
 
2016
3268
 
2017
3269
 
2018
3270
 
2019
3271
 
2020
3272
  # resource path
2021
- local_var_path = "/api/v2/analytics/evaluations/aggregates/query".sub('{format}','json')
3273
+ local_var_path = "/api/v2/quality/evaluations/scoring".sub('{format}','json')
2022
3274
 
2023
3275
  # query parameters
2024
3276
  query_params = {}
@@ -2047,55 +3299,111 @@ module PureCloud
2047
3299
  :form_params => form_params,
2048
3300
  :body => post_body,
2049
3301
  :auth_names => auth_names,
2050
- :return_type => 'AggregateQueryResponse')
3302
+ :return_type => 'EvaluationScoringSet')
2051
3303
  if @api_client.config.debugging
2052
- @api_client.config.logger.debug "API called: QualityApi#post_analytics_evaluations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3304
+ @api_client.config.logger.debug "API called: QualityApi#post_quality_evaluations_scoring\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2053
3305
  end
2054
3306
  return data, status_code, headers
2055
3307
  end
2056
3308
 
2057
- # Create a calibration
3309
+ # Create an evaluation form.
2058
3310
  #
2059
- # @param body calibration
3311
+ # @param body Evaluation form
2060
3312
  # @param [Hash] opts the optional parameters
2061
- # @option opts [String] :expand calibratorId
2062
- # @return [Calibration]
2063
- def post_quality_calibrations(body, opts = {})
2064
- data, _status_code, _headers = post_quality_calibrations_with_http_info(body, opts)
3313
+ # @return [EvaluationForm]
3314
+ def post_quality_forms(body, opts = {})
3315
+ data, _status_code, _headers = post_quality_forms_with_http_info(body, opts)
2065
3316
  return data
2066
3317
  end
2067
3318
 
2068
- # Create a calibration
3319
+ # Create an evaluation form.
2069
3320
  #
2070
- # @param body calibration
3321
+ # @param body Evaluation form
2071
3322
  # @param [Hash] opts the optional parameters
2072
- # @option opts [String] :expand calibratorId
2073
- # @return [Array<(Calibration, Fixnum, Hash)>] Calibration data, response status code and response headers
2074
- def post_quality_calibrations_with_http_info(body, opts = {})
3323
+ # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
3324
+ def post_quality_forms_with_http_info(body, opts = {})
2075
3325
  if @api_client.config.debugging
2076
- @api_client.config.logger.debug "Calling API: QualityApi.post_quality_calibrations ..."
3326
+ @api_client.config.logger.debug "Calling API: QualityApi.post_quality_forms ..."
2077
3327
  end
2078
3328
 
2079
3329
 
2080
3330
  # verify the required parameter 'body' is set
2081
- fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_calibrations" if body.nil?
3331
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_forms" if body.nil?
3332
+
3333
+
2082
3334
 
2083
3335
 
2084
3336
 
3337
+ # resource path
3338
+ local_var_path = "/api/v2/quality/forms".sub('{format}','json')
3339
+
3340
+ # query parameters
3341
+ query_params = {}
3342
+
3343
+ # header parameters
3344
+ header_params = {}
3345
+
3346
+ # HTTP header 'Accept' (if needed)
3347
+ local_header_accept = ['application/json']
3348
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3349
+
3350
+ # HTTP header 'Content-Type'
3351
+ local_header_content_type = ['application/json']
3352
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3353
+
3354
+ # form parameters
3355
+ form_params = {}
3356
+
3357
+ # http body (model)
3358
+ post_body = @api_client.object_to_http_body(body)
2085
3359
 
3360
+ auth_names = ['PureCloud Auth']
3361
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3362
+ :header_params => header_params,
3363
+ :query_params => query_params,
3364
+ :form_params => form_params,
3365
+ :body => post_body,
3366
+ :auth_names => auth_names,
3367
+ :return_type => 'EvaluationForm')
3368
+ if @api_client.config.debugging
3369
+ @api_client.config.logger.debug "API called: QualityApi#post_quality_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3370
+ end
3371
+ return data, status_code, headers
3372
+ end
3373
+
3374
+ # Create an evaluation form.
3375
+ #
3376
+ # @param body Evaluation form
3377
+ # @param [Hash] opts the optional parameters
3378
+ # @return [EvaluationForm]
3379
+ def post_quality_forms_evaluations(body, opts = {})
3380
+ data, _status_code, _headers = post_quality_forms_evaluations_with_http_info(body, opts)
3381
+ return data
3382
+ end
3383
+
3384
+ # Create an evaluation form.
3385
+ #
3386
+ # @param body Evaluation form
3387
+ # @param [Hash] opts the optional parameters
3388
+ # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
3389
+ def post_quality_forms_evaluations_with_http_info(body, opts = {})
3390
+ if @api_client.config.debugging
3391
+ @api_client.config.logger.debug "Calling API: QualityApi.post_quality_forms_evaluations ..."
3392
+ end
2086
3393
 
2087
3394
 
3395
+ # verify the required parameter 'body' is set
3396
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_forms_evaluations" if body.nil?
2088
3397
 
2089
3398
 
2090
3399
 
2091
3400
 
2092
3401
 
2093
3402
  # resource path
2094
- local_var_path = "/api/v2/quality/calibrations".sub('{format}','json')
3403
+ local_var_path = "/api/v2/quality/forms/evaluations".sub('{format}','json')
2095
3404
 
2096
3405
  # query parameters
2097
3406
  query_params = {}
2098
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
2099
3407
 
2100
3408
  # header parameters
2101
3409
  header_params = {}
@@ -2121,65 +3429,46 @@ module PureCloud
2121
3429
  :form_params => form_params,
2122
3430
  :body => post_body,
2123
3431
  :auth_names => auth_names,
2124
- :return_type => 'Calibration')
3432
+ :return_type => 'EvaluationForm')
2125
3433
  if @api_client.config.debugging
2126
- @api_client.config.logger.debug "API called: QualityApi#post_quality_calibrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3434
+ @api_client.config.logger.debug "API called: QualityApi#post_quality_forms_evaluations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2127
3435
  end
2128
3436
  return data, status_code, headers
2129
3437
  end
2130
3438
 
2131
- # Create an evaluation
3439
+ # Create a survey form.
2132
3440
  #
2133
- # @param conversation_id conversationId
2134
- # @param body evaluation
3441
+ # @param body Survey form
2135
3442
  # @param [Hash] opts the optional parameters
2136
- # @option opts [String] :expand evaluatorId
2137
- # @return [Evaluation]
2138
- def post_quality_conversation_evaluations(conversation_id, body, opts = {})
2139
- data, _status_code, _headers = post_quality_conversation_evaluations_with_http_info(conversation_id, body, opts)
3443
+ # @return [SurveyForm]
3444
+ def post_quality_forms_surveys(body, opts = {})
3445
+ data, _status_code, _headers = post_quality_forms_surveys_with_http_info(body, opts)
2140
3446
  return data
2141
3447
  end
2142
3448
 
2143
- # Create an evaluation
3449
+ # Create a survey form.
2144
3450
  #
2145
- # @param conversation_id conversationId
2146
- # @param body evaluation
3451
+ # @param body Survey form
2147
3452
  # @param [Hash] opts the optional parameters
2148
- # @option opts [String] :expand evaluatorId
2149
- # @return [Array<(Evaluation, Fixnum, Hash)>] Evaluation data, response status code and response headers
2150
- def post_quality_conversation_evaluations_with_http_info(conversation_id, body, opts = {})
3453
+ # @return [Array<(SurveyForm, Fixnum, Hash)>] SurveyForm data, response status code and response headers
3454
+ def post_quality_forms_surveys_with_http_info(body, opts = {})
2151
3455
  if @api_client.config.debugging
2152
- @api_client.config.logger.debug "Calling API: QualityApi.post_quality_conversation_evaluations ..."
3456
+ @api_client.config.logger.debug "Calling API: QualityApi.post_quality_forms_surveys ..."
2153
3457
  end
2154
3458
 
2155
3459
 
2156
- # verify the required parameter 'conversation_id' is set
2157
- fail ArgumentError, "Missing the required parameter 'conversation_id' when calling QualityApi.post_quality_conversation_evaluations" if conversation_id.nil?
2158
-
2159
-
2160
-
2161
-
2162
-
2163
-
2164
3460
  # verify the required parameter 'body' is set
2165
- fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_conversation_evaluations" if body.nil?
2166
-
2167
-
2168
-
2169
-
2170
-
2171
-
3461
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_forms_surveys" if body.nil?
2172
3462
 
2173
3463
 
2174
3464
 
2175
3465
 
2176
3466
 
2177
3467
  # resource path
2178
- local_var_path = "/api/v2/quality/conversations/{conversationId}/evaluations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
3468
+ local_var_path = "/api/v2/quality/forms/surveys".sub('{format}','json')
2179
3469
 
2180
3470
  # query parameters
2181
3471
  query_params = {}
2182
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
2183
3472
 
2184
3473
  # header parameters
2185
3474
  header_params = {}
@@ -2205,46 +3494,55 @@ module PureCloud
2205
3494
  :form_params => form_params,
2206
3495
  :body => post_body,
2207
3496
  :auth_names => auth_names,
2208
- :return_type => 'Evaluation')
3497
+ :return_type => 'SurveyForm')
2209
3498
  if @api_client.config.debugging
2210
- @api_client.config.logger.debug "API called: QualityApi#post_quality_conversation_evaluations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3499
+ @api_client.config.logger.debug "API called: QualityApi#post_quality_forms_surveys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2211
3500
  end
2212
3501
  return data, status_code, headers
2213
3502
  end
2214
3503
 
2215
- # Score evaluation
3504
+ # Create a Keyword Set
2216
3505
  #
2217
- # @param body evaluationAndScoringSet
3506
+ # @param body keywordSet
2218
3507
  # @param [Hash] opts the optional parameters
2219
- # @return [EvaluationScoringSet]
2220
- def post_quality_evaluations_scoring(body, opts = {})
2221
- data, _status_code, _headers = post_quality_evaluations_scoring_with_http_info(body, opts)
3508
+ # @option opts [String] :expand queueId
3509
+ # @return [KeywordSet]
3510
+ def post_quality_keywordsets(body, opts = {})
3511
+ data, _status_code, _headers = post_quality_keywordsets_with_http_info(body, opts)
2222
3512
  return data
2223
3513
  end
2224
3514
 
2225
- # Score evaluation
3515
+ # Create a Keyword Set
2226
3516
  #
2227
- # @param body evaluationAndScoringSet
3517
+ # @param body keywordSet
2228
3518
  # @param [Hash] opts the optional parameters
2229
- # @return [Array<(EvaluationScoringSet, Fixnum, Hash)>] EvaluationScoringSet data, response status code and response headers
2230
- def post_quality_evaluations_scoring_with_http_info(body, opts = {})
3519
+ # @option opts [String] :expand queueId
3520
+ # @return [Array<(KeywordSet, Fixnum, Hash)>] KeywordSet data, response status code and response headers
3521
+ def post_quality_keywordsets_with_http_info(body, opts = {})
2231
3522
  if @api_client.config.debugging
2232
- @api_client.config.logger.debug "Calling API: QualityApi.post_quality_evaluations_scoring ..."
3523
+ @api_client.config.logger.debug "Calling API: QualityApi.post_quality_keywordsets ..."
2233
3524
  end
2234
3525
 
2235
3526
 
2236
3527
  # verify the required parameter 'body' is set
2237
- fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_evaluations_scoring" if body.nil?
3528
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_keywordsets" if body.nil?
3529
+
3530
+
3531
+
3532
+
3533
+
3534
+
2238
3535
 
2239
3536
 
2240
3537
 
2241
3538
 
2242
3539
 
2243
3540
  # resource path
2244
- local_var_path = "/api/v2/quality/evaluations/scoring".sub('{format}','json')
3541
+ local_var_path = "/api/v2/quality/keywordsets".sub('{format}','json')
2245
3542
 
2246
3543
  # query parameters
2247
3544
  query_params = {}
3545
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
2248
3546
 
2249
3547
  # header parameters
2250
3548
  header_params = {}
@@ -2270,43 +3568,43 @@ module PureCloud
2270
3568
  :form_params => form_params,
2271
3569
  :body => post_body,
2272
3570
  :auth_names => auth_names,
2273
- :return_type => 'EvaluationScoringSet')
3571
+ :return_type => 'KeywordSet')
2274
3572
  if @api_client.config.debugging
2275
- @api_client.config.logger.debug "API called: QualityApi#post_quality_evaluations_scoring\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3573
+ @api_client.config.logger.debug "API called: QualityApi#post_quality_keywordsets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2276
3574
  end
2277
3575
  return data, status_code, headers
2278
3576
  end
2279
3577
 
2280
- # Create an evaluation form.
3578
+ # Publish an evaluation form.
2281
3579
  #
2282
3580
  # @param body Evaluation form
2283
3581
  # @param [Hash] opts the optional parameters
2284
3582
  # @return [EvaluationForm]
2285
- def post_quality_forms(body, opts = {})
2286
- data, _status_code, _headers = post_quality_forms_with_http_info(body, opts)
3583
+ def post_quality_publishedforms(body, opts = {})
3584
+ data, _status_code, _headers = post_quality_publishedforms_with_http_info(body, opts)
2287
3585
  return data
2288
3586
  end
2289
3587
 
2290
- # Create an evaluation form.
3588
+ # Publish an evaluation form.
2291
3589
  #
2292
3590
  # @param body Evaluation form
2293
3591
  # @param [Hash] opts the optional parameters
2294
3592
  # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
2295
- def post_quality_forms_with_http_info(body, opts = {})
3593
+ def post_quality_publishedforms_with_http_info(body, opts = {})
2296
3594
  if @api_client.config.debugging
2297
- @api_client.config.logger.debug "Calling API: QualityApi.post_quality_forms ..."
3595
+ @api_client.config.logger.debug "Calling API: QualityApi.post_quality_publishedforms ..."
2298
3596
  end
2299
3597
 
2300
3598
 
2301
3599
  # verify the required parameter 'body' is set
2302
- fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_forms" if body.nil?
3600
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_publishedforms" if body.nil?
2303
3601
 
2304
3602
 
2305
3603
 
2306
3604
 
2307
3605
 
2308
3606
  # resource path
2309
- local_var_path = "/api/v2/quality/forms".sub('{format}','json')
3607
+ local_var_path = "/api/v2/quality/publishedforms".sub('{format}','json')
2310
3608
 
2311
3609
  # query parameters
2312
3610
  query_params = {}
@@ -2337,53 +3635,44 @@ module PureCloud
2337
3635
  :auth_names => auth_names,
2338
3636
  :return_type => 'EvaluationForm')
2339
3637
  if @api_client.config.debugging
2340
- @api_client.config.logger.debug "API called: QualityApi#post_quality_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3638
+ @api_client.config.logger.debug "API called: QualityApi#post_quality_publishedforms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2341
3639
  end
2342
3640
  return data, status_code, headers
2343
3641
  end
2344
3642
 
2345
- # Create a Keyword Set
3643
+ # Publish an evaluation form.
2346
3644
  #
2347
- # @param body keywordSet
3645
+ # @param body Evaluation form
2348
3646
  # @param [Hash] opts the optional parameters
2349
- # @option opts [String] :expand queueId
2350
- # @return [KeywordSet]
2351
- def post_quality_keywordsets(body, opts = {})
2352
- data, _status_code, _headers = post_quality_keywordsets_with_http_info(body, opts)
3647
+ # @return [EvaluationForm]
3648
+ def post_quality_publishedforms_evaluations(body, opts = {})
3649
+ data, _status_code, _headers = post_quality_publishedforms_evaluations_with_http_info(body, opts)
2353
3650
  return data
2354
3651
  end
2355
3652
 
2356
- # Create a Keyword Set
3653
+ # Publish an evaluation form.
2357
3654
  #
2358
- # @param body keywordSet
3655
+ # @param body Evaluation form
2359
3656
  # @param [Hash] opts the optional parameters
2360
- # @option opts [String] :expand queueId
2361
- # @return [Array<(KeywordSet, Fixnum, Hash)>] KeywordSet data, response status code and response headers
2362
- def post_quality_keywordsets_with_http_info(body, opts = {})
3657
+ # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
3658
+ def post_quality_publishedforms_evaluations_with_http_info(body, opts = {})
2363
3659
  if @api_client.config.debugging
2364
- @api_client.config.logger.debug "Calling API: QualityApi.post_quality_keywordsets ..."
3660
+ @api_client.config.logger.debug "Calling API: QualityApi.post_quality_publishedforms_evaluations ..."
2365
3661
  end
2366
3662
 
2367
3663
 
2368
3664
  # verify the required parameter 'body' is set
2369
- fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_keywordsets" if body.nil?
2370
-
2371
-
2372
-
2373
-
2374
-
2375
-
3665
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_publishedforms_evaluations" if body.nil?
2376
3666
 
2377
3667
 
2378
3668
 
2379
3669
 
2380
3670
 
2381
3671
  # resource path
2382
- local_var_path = "/api/v2/quality/keywordsets".sub('{format}','json')
3672
+ local_var_path = "/api/v2/quality/publishedforms/evaluations".sub('{format}','json')
2383
3673
 
2384
3674
  # query parameters
2385
3675
  query_params = {}
2386
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
2387
3676
 
2388
3677
  # header parameters
2389
3678
  header_params = {}
@@ -2409,43 +3698,43 @@ module PureCloud
2409
3698
  :form_params => form_params,
2410
3699
  :body => post_body,
2411
3700
  :auth_names => auth_names,
2412
- :return_type => 'KeywordSet')
3701
+ :return_type => 'EvaluationForm')
2413
3702
  if @api_client.config.debugging
2414
- @api_client.config.logger.debug "API called: QualityApi#post_quality_keywordsets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3703
+ @api_client.config.logger.debug "API called: QualityApi#post_quality_publishedforms_evaluations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2415
3704
  end
2416
3705
  return data, status_code, headers
2417
3706
  end
2418
3707
 
2419
- # Publish an evaluation form.
3708
+ # Publish a survey form.
2420
3709
  #
2421
- # @param body Evaluation form
3710
+ # @param body Survey form
2422
3711
  # @param [Hash] opts the optional parameters
2423
- # @return [EvaluationForm]
2424
- def post_quality_publishedforms(body, opts = {})
2425
- data, _status_code, _headers = post_quality_publishedforms_with_http_info(body, opts)
3712
+ # @return [SurveyForm]
3713
+ def post_quality_publishedforms_surveys(body, opts = {})
3714
+ data, _status_code, _headers = post_quality_publishedforms_surveys_with_http_info(body, opts)
2426
3715
  return data
2427
3716
  end
2428
3717
 
2429
- # Publish an evaluation form.
3718
+ # Publish a survey form.
2430
3719
  #
2431
- # @param body Evaluation form
3720
+ # @param body Survey form
2432
3721
  # @param [Hash] opts the optional parameters
2433
- # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
2434
- def post_quality_publishedforms_with_http_info(body, opts = {})
3722
+ # @return [Array<(SurveyForm, Fixnum, Hash)>] SurveyForm data, response status code and response headers
3723
+ def post_quality_publishedforms_surveys_with_http_info(body, opts = {})
2435
3724
  if @api_client.config.debugging
2436
- @api_client.config.logger.debug "Calling API: QualityApi.post_quality_publishedforms ..."
3725
+ @api_client.config.logger.debug "Calling API: QualityApi.post_quality_publishedforms_surveys ..."
2437
3726
  end
2438
3727
 
2439
3728
 
2440
3729
  # verify the required parameter 'body' is set
2441
- fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_publishedforms" if body.nil?
3730
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.post_quality_publishedforms_surveys" if body.nil?
2442
3731
 
2443
3732
 
2444
3733
 
2445
3734
 
2446
3735
 
2447
3736
  # resource path
2448
- local_var_path = "/api/v2/quality/publishedforms".sub('{format}','json')
3737
+ local_var_path = "/api/v2/quality/publishedforms/surveys".sub('{format}','json')
2449
3738
 
2450
3739
  # query parameters
2451
3740
  query_params = {}
@@ -2474,9 +3763,9 @@ module PureCloud
2474
3763
  :form_params => form_params,
2475
3764
  :body => post_body,
2476
3765
  :auth_names => auth_names,
2477
- :return_type => 'EvaluationForm')
3766
+ :return_type => 'SurveyForm')
2478
3767
  if @api_client.config.debugging
2479
- @api_client.config.logger.debug "API called: QualityApi#post_quality_publishedforms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3768
+ @api_client.config.logger.debug "API called: QualityApi#post_quality_publishedforms_surveys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2480
3769
  end
2481
3770
  return data, status_code, headers
2482
3771
  end
@@ -2788,6 +4077,156 @@ module PureCloud
2788
4077
  return data, status_code, headers
2789
4078
  end
2790
4079
 
4080
+ # Update an evaluation form.
4081
+ #
4082
+ # @param form_id Form ID
4083
+ # @param body Evaluation form
4084
+ # @param [Hash] opts the optional parameters
4085
+ # @return [EvaluationForm]
4086
+ def put_quality_forms_evaluation(form_id, body, opts = {})
4087
+ data, _status_code, _headers = put_quality_forms_evaluation_with_http_info(form_id, body, opts)
4088
+ return data
4089
+ end
4090
+
4091
+ # Update an evaluation form.
4092
+ #
4093
+ # @param form_id Form ID
4094
+ # @param body Evaluation form
4095
+ # @param [Hash] opts the optional parameters
4096
+ # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
4097
+ def put_quality_forms_evaluation_with_http_info(form_id, body, opts = {})
4098
+ if @api_client.config.debugging
4099
+ @api_client.config.logger.debug "Calling API: QualityApi.put_quality_forms_evaluation ..."
4100
+ end
4101
+
4102
+
4103
+ # verify the required parameter 'form_id' is set
4104
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.put_quality_forms_evaluation" if form_id.nil?
4105
+
4106
+
4107
+
4108
+
4109
+
4110
+
4111
+ # verify the required parameter 'body' is set
4112
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.put_quality_forms_evaluation" if body.nil?
4113
+
4114
+
4115
+
4116
+
4117
+
4118
+ # resource path
4119
+ local_var_path = "/api/v2/quality/forms/evaluations/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
4120
+
4121
+ # query parameters
4122
+ query_params = {}
4123
+
4124
+ # header parameters
4125
+ header_params = {}
4126
+
4127
+ # HTTP header 'Accept' (if needed)
4128
+ local_header_accept = ['application/json']
4129
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
4130
+
4131
+ # HTTP header 'Content-Type'
4132
+ local_header_content_type = ['application/json']
4133
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
4134
+
4135
+ # form parameters
4136
+ form_params = {}
4137
+
4138
+ # http body (model)
4139
+ post_body = @api_client.object_to_http_body(body)
4140
+
4141
+ auth_names = ['PureCloud Auth']
4142
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4143
+ :header_params => header_params,
4144
+ :query_params => query_params,
4145
+ :form_params => form_params,
4146
+ :body => post_body,
4147
+ :auth_names => auth_names,
4148
+ :return_type => 'EvaluationForm')
4149
+ if @api_client.config.debugging
4150
+ @api_client.config.logger.debug "API called: QualityApi#put_quality_forms_evaluation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4151
+ end
4152
+ return data, status_code, headers
4153
+ end
4154
+
4155
+ # Update a survey form.
4156
+ #
4157
+ # @param form_id Form ID
4158
+ # @param body Survey form
4159
+ # @param [Hash] opts the optional parameters
4160
+ # @return [SurveyForm]
4161
+ def put_quality_forms_survey(form_id, body, opts = {})
4162
+ data, _status_code, _headers = put_quality_forms_survey_with_http_info(form_id, body, opts)
4163
+ return data
4164
+ end
4165
+
4166
+ # Update a survey form.
4167
+ #
4168
+ # @param form_id Form ID
4169
+ # @param body Survey form
4170
+ # @param [Hash] opts the optional parameters
4171
+ # @return [Array<(SurveyForm, Fixnum, Hash)>] SurveyForm data, response status code and response headers
4172
+ def put_quality_forms_survey_with_http_info(form_id, body, opts = {})
4173
+ if @api_client.config.debugging
4174
+ @api_client.config.logger.debug "Calling API: QualityApi.put_quality_forms_survey ..."
4175
+ end
4176
+
4177
+
4178
+ # verify the required parameter 'form_id' is set
4179
+ fail ArgumentError, "Missing the required parameter 'form_id' when calling QualityApi.put_quality_forms_survey" if form_id.nil?
4180
+
4181
+
4182
+
4183
+
4184
+
4185
+
4186
+ # verify the required parameter 'body' is set
4187
+ fail ArgumentError, "Missing the required parameter 'body' when calling QualityApi.put_quality_forms_survey" if body.nil?
4188
+
4189
+
4190
+
4191
+
4192
+
4193
+ # resource path
4194
+ local_var_path = "/api/v2/quality/forms/surveys/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
4195
+
4196
+ # query parameters
4197
+ query_params = {}
4198
+
4199
+ # header parameters
4200
+ header_params = {}
4201
+
4202
+ # HTTP header 'Accept' (if needed)
4203
+ local_header_accept = ['application/json']
4204
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
4205
+
4206
+ # HTTP header 'Content-Type'
4207
+ local_header_content_type = ['application/json']
4208
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
4209
+
4210
+ # form parameters
4211
+ form_params = {}
4212
+
4213
+ # http body (model)
4214
+ post_body = @api_client.object_to_http_body(body)
4215
+
4216
+ auth_names = ['PureCloud Auth']
4217
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4218
+ :header_params => header_params,
4219
+ :query_params => query_params,
4220
+ :form_params => form_params,
4221
+ :body => post_body,
4222
+ :auth_names => auth_names,
4223
+ :return_type => 'SurveyForm')
4224
+ if @api_client.config.debugging
4225
+ @api_client.config.logger.debug "API called: QualityApi#put_quality_forms_survey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4226
+ end
4227
+ return data, status_code, headers
4228
+ end
4229
+
2791
4230
  # Update a keywordSet to the specified keywordSet via PUT.
2792
4231
  #
2793
4232
  # @param keyword_set_id KeywordSet ID